Data

Tools

Indexes

Applications

Experiments

Open Source Science

dstructs-fifo

First-in-first-out (FIFO) queue.

https://github.com/stdlib-js/dstructs-fifo

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
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (15.8%) to scientific vocabulary

Keywords

collection data data-structure data-structures fifo first-in first-out javascript node node-js nodejs queue stdlib structure
Last synced: 4 months ago · JSON representation ·

Repository

First-in-first-out (FIFO) queue.

Basic Info
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
collection data data-structure data-structures fifo first-in first-out javascript node node-js nodejs queue stdlib structure
Created 10 months ago · Last pushed 4 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

About stdlib...

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!

FIFO

NPM version Build Status Coverage Status <!-- dependencies -->

First-in-first-out (FIFO) queue.

## Installation ```bash npm install @stdlib/dstructs-fifo ``` 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 fifo = require( '@stdlib/dstructs-fifo' ); ``` #### fifo() Returns a new first-in-first-out (FIFO) queue instance. ```javascript var queue = fifo(); // returns ``` ##### queue.clear() Clears a queue. ```javascript var queue = fifo(); // returns // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Peek at the first value: var v = queue.first(); // returns 'foo' // Examine the queue length: var len = queue.length; // returns 2 // Clear all queue items: queue.clear(); // Peek at the first value: v = queue.first(); // returns undefined // Examine the queue length: len = queue.length; // returns 0 ``` ##### queue.first() Returns the "oldest" queue value (i.e., the value which is "first-out"). If the queue is currently empty, the returned value is `undefined`. ```javascript var queue = fifo(); // returns // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Peek at the first value: var v = queue.first(); // returns 'foo' ``` ##### queue.iterator() Returns an iterator for iterating over a queue. If an environment supports `Symbol.iterator`, the returned iterator is iterable. ```javascript var queue = fifo(); // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Create an iterator: var it = queue.iterator(); // Iterate over the queue... var v = it.next().value; // returns 'foo' v = it.next().value; // returns 'bar' var bool = it.next().done; // returns true ``` **Note**: in order to prevent confusion arising from queue mutation during iteration, a returned iterator **always** iterates over a queue "snapshot", which is defined as the list of queue elements at the time of `queue.iterator()` invocation. ##### queue.last() Returns the "newest" queue value (i.e., the value which is "last-out"). If the queue is currently empty, the returned value is `undefined`. ```javascript var queue = fifo(); // returns // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Peek at the last value: var v = queue.last(); // returns 'bar' ``` ##### queue.length Queue length. ```javascript var queue = fifo(); // Examine the initial queue length: var len = queue.length; // returns 0 // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Retrieve the current queue length: len = queue.length; // returns 2 ``` ##### queue.pop() Removes a value from the queue. If the queue is currently empty, the returned value is `undefined`. ```javascript var queue = fifo(); // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Remove the first value: var v = queue.pop(); // returns 'foo' // Add a new value to the queue: queue.push( 'beep' ); // Remove the "oldest" queue value: v = queue.pop(); // returns 'bar' ``` ##### queue.push( value ) Adds a value to the queue. ```javascript var queue = fifo(); // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Remove the first value: var v = queue.pop(); // returns 'foo' // Add a new value to the queue: queue.push( 'beep' ); // Remove the "oldest" queue value: v = queue.pop(); // returns 'bar' ``` ##### queue.toArray() Returns an array of queue values. ```javascript var queue = fifo(); // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Get an array of queue values: var vals = queue.toArray(); // returns [ 'foo', 'bar' ] ``` ##### queue.toJSON() Serializes a queue as JSON. ```javascript var queue = fifo(); // Add values to the queue: queue.push( 'foo' ).push( 'bar' ); // Serialize to JSON: var o = queue.toJSON(); // returns { 'type': 'fifo', 'data': [ 'foo', 'bar' ] } ``` **Note**: `JSON.stringify()` implicitly calls this method when stringifying a queue instance.
## Examples ```javascript var fifo = require( '@stdlib/dstructs-fifo' ); // Create a new FIFO queue: var queue = fifo(); // Add some values to the queue: queue.push( 'foo' ); queue.push( 'bar' ); queue.push( 'beep' ); queue.push( 'boop' ); // Peek at the first and last queue values: var v = queue.first(); // returns 'foo' v = queue.last(); // returns 'boop' // Inspect the queue length: var len = queue.length; // returns 4 // Remove the "oldest" queue value: v = queue.pop(); // returns 'foo' // Inspect the queue length: len = queue.length; // returns 3 // Iterate over the queue: var iter = queue.iterator(); var i; for ( i = 0; i < len; i++ ) { console.log( 'Queue value #%d: %s', i+1, iter.next().value ); } // Clear the queue: queue.clear(); // Inspect the queue length: len = queue.length; // returns 0 ```
* * * ## See Also - [`@stdlib/dstructs-stack`][@stdlib/dstructs/stack]: stack.
* * * ## 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

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
  • Member event: 1
  • Push event: 12
  • Create event: 6
Last Year
  • Member event: 1
  • Push event: 12
  • Create event: 6