Doubly linked list.
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!
[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url]
Doubly linked list constructor.
bash
npm install @stdlib/utils-doubly-linked-listscript tag without installation and bundlers, use the [ES Module][es-module] available on the [esm][esm-url] branch (see [README][esm-readme]).deno][deno-url] branch (see [README][deno-readme] for usage intructions).umd][umd-url] branch (see [README][umd-readme]).javascript
var doublyLinkedList = require( '@stdlib/utils-doubly-linked-list' );javascript
var list = doublyLinkedList();
// returns <DoublyLinkedList>javascript
var list = doublyLinkedList();
// returns <DoublyLinkedList>
// 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 0node. If the list is currently empty, the returned value is undefined.javascript
var list = doublyLinkedList();
// returns <DoublyLinkedList>
// Add values to the list:
list.push( 'foo' ).push( 'bar' );
// Peek at the first value:
var v = list.first().value;
// returns 'foo'value into the list either before or after a provided list node.javascript
var list = doublyLinkedList();
// returns <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;
// 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' ]'before': insert a value into the list before a provided list node.'after': insert a value into the list after a provided list node.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 <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;
// 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' ]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'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.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 truelist.iterator() invocation.node. If the list is currently empty, the returned value is undefined.javascript
var list = doublyLinkedList();
// returns <DoublyLinkedList>
// Add values to the list:
list.push( 'foo' ).push( 'bar' );
// Peek at the last value:
var v = list.last().value;
// returns 'bar'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 2undefined.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'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'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 2undefined.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'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' ]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' ] }JSON.stringify() implicitly calls this method when stringifying a list instance.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'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;
}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
