Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

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

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

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

Last synced: about 13 hours ago
JSON representation

Doubly linked list.

Awesome Lists containing this project

README 

          



  

    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!



# Doubly Linked List



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> 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

```



* * *



## See Also



-   [`@stdlib/utils-linked-list`][@stdlib/utils/linked-list]: linked list.

-   [`@stdlib/utils-stack`][@stdlib/utils/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-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/utils-doubly-linked-list.svg

[npm-url]: https://npmjs.org/package/@stdlib/utils-doubly-linked-list



[test-image]: https://github.com/stdlib-js/utils-doubly-linked-list/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/utils-doubly-linked-list/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/utils-doubly-linked-list/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/utils-doubly-linked-list?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/utils-doubly-linked-list/tree/deno

[deno-readme]: https://github.com/stdlib-js/utils-doubly-linked-list/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/utils-doubly-linked-list/tree/umd

[umd-readme]: https://github.com/stdlib-js/utils-doubly-linked-list/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/utils-doubly-linked-list/tree/esm

[esm-readme]: https://github.com/stdlib-js/utils-doubly-linked-list/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/utils-doubly-linked-list/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/utils-doubly-linked-list/main/LICENSE



[@stdlib/utils/linked-list]: https://github.com/stdlib-js/utils-linked-list



[@stdlib/utils/stack]: https://github.com/stdlib-js/utils-stack