@stdlib/utils-circular-buffer

Circular buffer.

https://github.com/stdlib-js/utils-circular-buffer

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (15.8%) to scientific vocabulary

Keywords

buffer circular collection cyclic data data-structure data-structures first-in-first-out javascript node node-js nodejs queue ring stdlib structure util utilities utility utils

Last synced: 4 months ago · JSON representation ·

Repository

Circular buffer.

Basic Info

Host: GitHub
Owner: stdlib-js
License: apache-2.0
Language: JavaScript
Default Branch: main
Homepage: https://github.com/stdlib-js/stdlib
Size: 1.13 MB

Statistics

Stars: 1
Watchers: 3
Forks: 0
Open Issues: 0
Releases: 0

Topics

buffer circular collection cyclic data data-structure data-structures first-in-first-out javascript node node-js nodejs queue ring stdlib structure util utilities utility utils

Created over 4 years ago · Last pushed 11 months ago

Metadata Files

Readme Changelog Contributing License Code of conduct Citation Security

We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.

The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.

When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.

To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!

Circular Buffer

Circular buffer constructor.

## Installation ```bash npm install @stdlib/utils-circular-buffer ``` Alternatively, - To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]). - If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions). - For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]). The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships. To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.

## Usage ```javascript var circularBuffer = require( '@stdlib/utils-circular-buffer' ); ``` #### circularBuffer( buffer ) Returns a new circular buffer instance. ```javascript var buf = circularBuffer( 3 ); // returns ``` The `buffer` argument may either be a integer which specifies the buffer size or an array-like object to use as the underlying buffer. ```javascript var Float64Array = require( '@stdlib/array-float64' ); // Use a typed array as the underlying buffer: var buf = circularBuffer( new Float64Array( 3 ) ); // returns ``` ##### circularBuffer.prototype.clear() Clears a buffer. ```javascript var buf = circularBuffer( 3 ); // returns // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); buf.push( 'beep' ); // Get the number of elements currently in the buffer: var n = buf.count; // returns 3 // Clear all buffer items: buf.clear(); // Get the number of elements in the buffer: n = buf.count; // returns 0 ``` ##### circularBuffer.prototype.count Read-only property which returns the number of elements currently in the buffer. ```javascript var buf = circularBuffer( 3 ); // returns // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); // Determine how many elements are in the buffer: var n = buf.count; // returns 2 ``` ##### circularBuffer.prototype.full Read-only property which returns a `boolean` indicating if a buffer is full. ```javascript var buf = circularBuffer( 3 ); // returns // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); // Determine if the buffer is full: var bool = buf.full; // returns false // Add another value to the buffer: buf.push( 'beep' ); // Determine if the buffer is full: bool = buf.full; // returns true ``` ##### circularBuffer.prototype.iterator( \[niters] ) Returns an iterator for iterating over a buffer. If an environment supports `Symbol.iterator`, the returned iterator is iterable. ```javascript var buf = circularBuffer( 2 ); // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); buf.push( 'beep' ); buf.push( 'boop' ); // Create an iterator: var it = buf.iterator(); // Iterate over the buffer... var v = it.next().value; // returns 'beep' v = it.next().value; // returns 'boop' v = it.next().value; // returns 'beep' v = it.next().value; // returns 'boop' v = it.next().value; // returns 'beep' ``` By default, provided a buffer is **full**, the method returns an infinite iterator. To limit the number of iterations, provide an `niters` argument. ```javascript var buf = circularBuffer( 2 ); // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); buf.push( 'beep' ); buf.push( 'boop' ); // Create an iterator: var it = buf.iterator( buf.length ); // Iterate over the buffer... var v = it.next().value; // returns 'beep' v = it.next().value; // returns 'boop' var bool = it.next().done; // returns true ``` A returned iterator does **not** iterate over partially full circular buffers. ```javascript var buf = circularBuffer( 5 ); // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); // Create an iterator: var it = buf.iterator(); // Determine if the buffer is full: var bool = buf.full; // returns false // Iterate over the buffer... bool = it.next().done; // returns true ``` If iterating over a partially full circular buffer is necessary, use `buf.toArray()` and iterate over the returned array. ##### circularBuffer.prototype.length Read-only property returning the buffer length (i.e., capacity). ```javascript var buf = circularBuffer( [ 0, 0, 0 ] ); // Get the buffer length: var len = buf.length; // returns 3 ``` ##### circularBuffer.prototype.push( value ) Adds a value to the buffer. ```javascript var buf = circularBuffer( 3 ); // Fill the buffer... var v = buf.push( 'foo' ); // returns undefined v = buf.push( 'bar' ); // returns undefined v = buf.push( 'beep' ); // returns undefined // Now that the buffer is full, each push will cause a value to be removed: v = buf.push( 'boop' ); // returns 'foo' ``` When a circular buffer is empty or partially full, this method returns `undefined`. Once a circular buffer is **full**, the method returns removed values. ##### circularBuffer.prototype.toArray() Returns an array of buffer values. ```javascript var buf = circularBuffer( 3 ); // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); buf.push( 'beep' ); buf.push( 'boop' ); // Get an array of buffer values: var vals = buf.toArray(); // returns [ 'bar', 'beep', 'boop' ] ``` ##### circularBuffer.prototype.toJSON() Serializes a circular buffer as JSON. ```javascript var buf = circularBuffer( 3 ); // Add values to the buffer: buf.push( 'foo' ); buf.push( 'bar' ); buf.push( 'beep' ); buf.push( 'boop' ); // Serialize to JSON: var o = buf.toJSON(); // returns { 'type': 'circular-buffer', 'length': 3, 'data': [ 'bar', 'beep', 'boop' ] } ``` **Note**: `JSON.stringify()` implicitly calls this method when stringifying a circular buffer instance.

## Notes - The constructor supports array-like object `buffer` arguments which use getter and setter accessors for element access (e.g., [`Complex64Array`][@stdlib/array/complex64], [`Complex128Array`][@stdlib/array/complex128], etc).

## Examples ```javascript var circularBuffer = require( '@stdlib/utils-circular-buffer' ); // Create a circular buffer capable of holding 5 elements: var buf = circularBuffer( 5 ); console.log( 'Buffer length: %s', buf.length ); // Continuously add values to the buffer... var v; var i; for ( i = 0; i < 100; i++ ) { v = buf.push( i ); console.log( 'Count: %d. Added value: %s. Removed value: %s.', buf.count, i, ( v === void 0 ) ? '(none)' : v ); } ```

* * * ## Notice This package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more. For more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib]. #### Community [![Chat][chat-image]][chat-url] --- ## License See [LICENSE][stdlib-license]. ## Copyright Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors].

Owner

Name: stdlib
Login: stdlib-js
Kind: organization

Website: https://stdlib.io
Twitter: stdlibjs
Repositories: 3,692
Profile: https://github.com/stdlib-js

Standard library for JavaScript.

Citation (CITATION.cff)

cff-version: 1.2.0
title: stdlib
message: >-
  If you use this software, please cite it using the
  metadata from this file.

type: software

authors:
  - name: The Stdlib Authors
    url: https://github.com/stdlib-js/stdlib/graphs/contributors

repository-code: https://github.com/stdlib-js/stdlib
url: https://stdlib.io

abstract: |
  Standard library for JavaScript and Node.js.

keywords:
  - JavaScript
  - Node.js
  - TypeScript
  - standard library
  - scientific computing
  - numerical computing
  - statistical computing

license: Apache-2.0 AND BSL-1.0

date-released: 2016

GitHub Events

Total

Push event: 10

Last Year

Push event: 10

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 42
Total Committers: 1
Avg Commits per committer: 42.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 8
Committers: 1
Avg Commits per committer: 8.0
Development Distribution Score (DDS): 0.0

Top Committers

Name	Email	Commits
stdlib-bot	n**y@s**o	42

Committer Domains (Top 20 + Academic)

stdlib.io: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time

Total issues: 0
Total pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Total issue authors: 0
Total pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 0
Pull requests: 0
Average time to close issues: N/A
Average time to close pull requests: N/A
Issue authors: 0
Pull request authors: 0
Average comments per issue: 0
Average comments per pull request: 0
Merged pull requests: 0
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

Total packages: 1
Total downloads:
- npm 1,438 last-month

Total dependent packages: 4
Total dependent repositories: 1
Total versions: 10
Total maintainers: 4

npmjs.org: @stdlib/utils-circular-buffer

Circular buffer.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.1
published almost 2 years ago

Versions: 10
Dependent Packages: 4
Dependent Repositories: 1
Downloads: 1,438 Last month

Rankings

Dependent packages count: 4.5%

Dependent repos count: 10.3%

Average: 13.6%

Forks count: 15.4%

Stargazers count: 16.7%

Downloads: 21.3%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

type: opencollective
url: https://opencollective.com/stdlib

Last synced: 4 months ago

Dependencies

.github/workflows/benchmark.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/cancel.yml actions

styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/close_pull_requests.yml actions

superbrothers/close-pull-request v3 composite

.github/workflows/examples.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/npm_downloads.yml actions

actions/checkout v3 composite
actions/setup-node v3 composite
actions/upload-artifact v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/productionize.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
stdlib-js/bundle-action main composite
stdlib-js/transform-errors-action main composite

.github/workflows/publish.yml actions

JS-DevTools/npm-publish v1 composite
act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
styfle/cancel-workflow-action 0.11.0 composite

.github/workflows/test.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

.github/workflows/test_bundles.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
denoland/setup-deno v1 composite

.github/workflows/test_coverage.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite
codecov/codecov-action v3 composite
distributhor/workflow-webhook v3 composite

.github/workflows/test_install.yml actions

act10ns/slack v1 composite
actions/checkout v3 composite
actions/setup-node v3 composite

package.json npm

@stdlib/array-complex128 ^0.0.x development
@stdlib/assert-instance-of ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/complex-float64 ^0.0.x development
@stdlib/complex-imag ^0.0.x development
@stdlib/complex-real ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-min 2.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@stdlib/array-base-arraylike2object ^0.0.x
@stdlib/assert-is-collection ^0.0.x
@stdlib/assert-is-nonnegative-integer ^0.0.x
@stdlib/assert-is-positive-integer ^0.0.x
@stdlib/constants-float64-max ^0.0.x
@stdlib/string-format ^0.0.x
@stdlib/symbol-iterator ^0.0.x
@stdlib/types ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-accessor ^0.0.x
@stdlib/utils-define-nonenumerable-read-only-property ^0.0.x

@stdlib/utils-circular-buffer

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Circular Buffer

Owner

Citation (CITATION.cff)

GitHub Events

Total

Last Year

Committers

All Time

Past Year

Top Committers

Committer Domains (Top 20 + Academic)

Issues and Pull Requests

All Time

Past Year

Top Authors

Issue Authors

Pull Request Authors

Top Labels

Issue Labels

Pull Request Labels

Packages

npmjs.org: @stdlib/utils-circular-buffer

Rankings

Maintainers (4)

Funding

Dependencies