@stdlib/utils-stack

Stack.

https://github.com/stdlib-js/utils-stack

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

collection data data-structure data-structures first-out javascript last-in lifo node node-js nodejs stack stdlib structure util utilities utility utils

Last synced: 4 months ago · JSON representation ·

Repository

Stack.

Basic Info

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

Statistics

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

Topics

collection data data-structure data-structures first-out javascript last-in lifo node node-js nodejs stack stdlib structure util utilities utility utils

Created over 4 years ago · Last pushed about 1 year 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!

Stack

Stack data structure.

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

## Notes - A stack is also known as a Last-In-First-Out (LIFO) queue.

## Examples ```javascript var Stack = require( '@stdlib/utils-stack' ); var stack; var iter; var len; var v; var i; // Create a new stack: stack = new Stack(); // Add some values to the stack: stack.push( 'foo' ); stack.push( 'bar' ); stack.push( 'beep' ); stack.push( 'boop' ); // Peek at the top and bottom stack values: v = stack.first(); // returns 'boop' v = stack.last(); // returns 'foo' // Inspect the stack length: len = stack.length; // returns 4 // Remove the top value: v = stack.pop(); // returns 'boop' // Inspect the stack length: len = stack.length; // returns 3 // Iterate over the stack: iter = stack.iterator(); for ( i = 0; i < len; i++ ) { console.log( 'Stack value #%d: %s', i+1, iter.next().value ); } // Clear the stack: stack.clear(); // Inspect the stack length: len = stack.length; // returns 0 ```

* * * ## 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-2024. 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: 9

Last Year

Push event: 9

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 47
Total Committers: 1
Avg Commits per committer: 47.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 14
Committers: 1
Avg Commits per committer: 14.0
Development Distribution Score (DDS): 0.0

Top Committers

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

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 6 last-month

Total dependent packages: 2
Total dependent repositories: 0
Total versions: 12
Total maintainers: 4

npmjs.org: @stdlib/utils-stack

Stack.

Homepage: https://stdlib.io
License: Apache-2.0
Latest release: 0.2.2
published over 1 year ago

Versions: 12
Dependent Packages: 2
Dependent Repositories: 0
Downloads: 6 Last month

Rankings

Dependent packages count: 9.5%

Downloads: 14.0%

Average: 16.6%

Stargazers count: 16.8%

Forks count: 17.4%

Dependent repos count: 25.3%

Maintainers (4)

planeshifter rreusser stdlib-bot kgryte

Funding

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

Last synced: 4 months ago

Dependencies

package.json npm

@stdlib/assert-instance-of ^0.0.x development
@stdlib/bench ^0.0.x development
@stdlib/random-base-randu ^0.0.x development
istanbul ^0.4.1 development
proxyquire ^2.0.0 development
tap-spec 5.x.x development
tape git+https://github.com/kgryte/tape.git#fix/globby development
@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

.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

@stdlib/utils-stack

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Stack

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-stack

Rankings

Maintainers (4)

Funding

Dependencies