@stdlib/utils-doubly-linked-list

Doubly linked list.

https://github.com/stdlib-js/utils-doubly-linked-list

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 doubly javascript linked list node node-js nodejs queue sequence stdlib structure util utilities utility utils

Last synced: 4 months ago · JSON representation ·

Repository

Doubly linked list.

Basic Info

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

Statistics

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

Topics

collection data data-structure data-structures doubly javascript linked list node node-js nodejs queue sequence stdlib structure util utilities utility utils

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

Doubly Linked List

Doubly linked list constructor.

## Installation ```bash npm install @stdlib/utils-doubly-linked-list ``` 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 doublyLinkedList = require( '@stdlib/utils-doubly-linked-list' ); ``` #### doublyLinkedList() Returns a new doubly linked list instance. ```javascript var list = doublyLinkedList(); // returns ``` ##### list.clear() Clears a list. ```javascript var list = doublyLinkedList(); // returns // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Peek at the first value: var v = list.first().value; // returns 'foo' // Examine the list length: var len = list.length; // returns 2 // Clear all list items: list.clear(); // Peek at the first value: v = list.first(); // returns undefined // Examine the list length: len = list.length; // returns 0 ``` ##### list.first() Returns the first `node`. If the list is currently empty, the returned value is `undefined`. ```javascript var list = doublyLinkedList(); // returns // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Peek at the first value: var v = list.first().value; // returns 'foo' ``` ##### list.insert( node, value\[, location] ) Inserts a `value` into the list either before or after a provided list `node`. ```javascript var list = doublyLinkedList(); // returns // Add values to the list: list.push( 'foo' ).push( 'bar' ).push( 'beep' ); // Determine the list length: var len = list.length; // returns 3 // Get the second node: var node = list.first().next; // Insert a value after the second node: list.insert( node, 'boop' ); // Determine the list length: len = list.length; // returns 4 // Return a list of values: var values = list.toArray(); // returns [ 'foo', 'bar', 'boop', 'beep' ] ``` The method supports the following insertion locations: - `'before'`: insert a `value` into the list **before** a provided list `node`. - `'after'`: insert a `value` into the list **after** a provided list `node`. By default, the method inserts a `value` into the list **after** a provided list `node`. To insert a value **before** a provided list `node`, invoke the method with the `location` argument equal to `'before'`. ```javascript var list = doublyLinkedList(); // returns // Add values to the list: list.push( 'foo' ).push( 'bar' ).push( 'beep' ); // Determine the list length: var len = list.length; // returns 3 // Get the second node: var node = list.first().next; // Insert a value before the second node: list.insert( node, 'boop', 'before' ); // Determine the list length: len = list.length; // returns 4 // Return a list of values: var values = list.toArray(); // returns [ 'foo', 'boop', 'bar', 'beep' ] ``` ##### list.iterator( \[direction] ) Returns an iterator for iterating over a list. If an environment supports `Symbol.iterator`, the returned iterator is iterable. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Create an iterator: var it = list.iterator(); // Iterate over the list... var v = it.next().value; // returns 'foo' v = it.next().value; // returns 'bar' var bool = it.next().done; // returns true ``` The method supports the following iteration directions: - `'forward'`: iterate over a list from the first value until the last value. - `'reverse'`: iterate over a list from the last value until the first value. By default, the method returns an iterator which iterates over a list from the first value until the last value. To return an iterator which iterates in reverse order, invoke the method with the `direction` argument equal to `'reverse'`. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Create an iterator: var it = list.iterator( 'reverse' ); // Iterate over the list... 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 list mutation during iteration, a returned iterator **always** iterates over a list "snapshot", which is defined as the list of list elements at the time of `list.iterator()` invocation. ##### list.last() Returns the last `node`. If the list is currently empty, the returned value is `undefined`. ```javascript var list = doublyLinkedList(); // returns // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Peek at the last value: var v = list.last().value; // returns 'bar' ``` ##### list.length List length. ```javascript var list = doublyLinkedList(); // Examine the initial list length: var len = list.length; // returns 0 // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Retrieve the current list length: len = list.length; // returns 2 ``` ##### list.pop() Removes a value from the end of the list. If the list is currently empty, the returned value is `undefined`. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Remove the last value: var v = list.pop(); // returns 'bar' // Add a new value to the list: list.push( 'beep' ); // Remove the last value: v = list.pop(); // returns 'beep' ``` ##### list.push( value ) Adds a value to the end of the list. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Remove the last value: var v = list.pop(); // returns 'bar' // Add a new value to the list: list.push( 'beep' ); // Remove the last value: v = list.pop(); // returns 'beep' ``` ##### list.remove( node ) Removes a `node` from the list. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ).push( 'beep' ); // Determine the list length: var len = list.length; // returns 3 // Get the second node: var node = list.first().next; // Remove the second node: var v = list.remove( node ); // returns 'bar' // Determine the list length: len = list.length; // returns 2 ``` ##### list.shift() Removes a value from the beginning of the list. If the list is currently empty, the returned value is `undefined`. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Remove the first value: var v = list.shift(); // returns 'foo' // Add a new value to the list: list.push( 'beep' ); // Remove the first value: v = list.shift(); // returns 'bar' ``` ##### list.toArray() Returns an array of list values. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Get an array of list values: var vals = list.toArray(); // returns [ 'foo', 'bar' ] ``` ##### list.toJSON() Serializes a list as JSON. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ); // Serialize to JSON: var o = list.toJSON(); // returns { 'type': 'doubly-linked-list', 'data': [ 'foo', 'bar' ] } ``` **Note**: `JSON.stringify()` implicitly calls this method when stringifying a list instance. ##### list.unshift( value ) Adds a value to the beginning of the list. ```javascript var list = doublyLinkedList(); // Add values to the list: list.unshift( 'foo' ).unshift( 'bar' ); // Remove the last value: var v = list.pop(); // returns 'foo' // Add a new value to the list: list.unshift( 'beep' ); // Remove the last value: v = list.pop(); // returns 'bar' ```

## Notes - To manually traverse a list, use list node `next` and `prev` properties. ```javascript var list = doublyLinkedList(); // Add values to the list: list.push( 'foo' ).push( 'bar' ).push( 'beep' ).push( 'boop' ); // Get the first list node: var n = list.first(); // Walk the list forward... while ( n ) { console.log( n.value ); n = n.next; } // Get the last list node: n = list.last(); // Walk the list backward... while ( n ) { console.log( n.value ); n = n.prev; } ```

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

Last Year

Push event: 15

Committers

Last synced: almost 2 years ago

All Time

Total Commits: 48
Total Committers: 1
Avg Commits per committer: 48.0
Development Distribution Score (DDS): 0.0

Past Year

Commits: 15
Committers: 1
Avg Commits per committer: 15.0
Development Distribution Score (DDS): 0.0

Top Committers

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

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-doubly-linked-list

Doubly linked list.

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: 13.8%

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-has-own-property ^0.0.x development
@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/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-define-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-doubly-linked-list

Science Score: 44.0%

Keywords

Repository

Basic Info

Statistics

Topics

Metadata Files

README.md

Doubly Linked List

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-doubly-linked-list

Rankings

Maintainers (4)

Funding

Dependencies