@stdlib/dstructs-doubly-linked-list 0.1.0

package/dist/index.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../lib/node.js", "../lib/main.js", "../lib/index.js"],
+  "sourcesContent": ["/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MODULES //\n\nvar defineProperty = require( '@stdlib/utils-define-property' );\n\n\n// MAIN //\n\n/**\n* List node constructor.\n*\n* @private\n* @constructor\n* @param {*} value - node value\n* @returns {Node} Node instance\n*\n* @example\n* var node = new Node( 'foo' );\n* // returns <Node>\n*/\nfunction Node( value ) { // eslint-disable-line stdlib/no-redeclare\n\t// Why getters? Because some of the list APIs will return the list \"node\", not the value. In which case, the node API is no longer private and we have to guard against users mucking about (deleting, updating, etc) with property values (in particular, the `next` and `prev` properties).\n\tdefineProperty( this, 'next', {\n\t\t'configurable': false,\n\t\t'enumerable': true,\n\t\t'get': function get() { // eslint-disable-line no-restricted-syntax\n\t\t\treturn this._next;\n\t\t}\n\t});\n\tdefineProperty( this, 'prev', {\n\t\t'configurable': false,\n\t\t'enumerable': true,\n\t\t'get': function get() { // eslint-disable-line no-restricted-syntax\n\t\t\treturn this._prev;\n\t\t}\n\t});\n\tthis.value = value;\n\n\tdefineProperty( this, '_next', {\n\t\t'configurable': false,\n\t\t'enumerable': false,\n\t\t'writable': true,\n\t\t'value': null\n\t});\n\tdefineProperty( this, '_prev', {\n\t\t'configurable': false,\n\t\t'enumerable': false,\n\t\t'writable': true,\n\t\t'value': null\n\t});\n\n\treturn this;\n}\n\n\n// EXPORTS //\n\nmodule.exports = Node;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable no-restricted-syntax, no-invalid-this */\n\n'use strict';\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar setReadOnlyAccessor = require( '@stdlib/utils-define-nonenumerable-read-only-accessor' );\nvar iteratorSymbol = require( '@stdlib/symbol-iterator' );\nvar format = require( '@stdlib/string-format' );\nvar Node = require( './node.js' ); // eslint-disable-line stdlib/no-redeclare\n\n\n// MAIN //\n\n/**\n* Doubly linked list constructor.\n*\n* @constructor\n* @returns {DoublyLinkedList} linked list instance\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Remove the last value:\n* var v = list.pop();\n* // returns 'bar'\n*\n* // Add a new value to the list:\n* list.push( 'beep' );\n*\n* // Remove the first value:\n* v = list.shift();\n* // returns 'foo'\n*/\nfunction DoublyLinkedList() {\n\tif ( !(this instanceof DoublyLinkedList) ) {\n\t\treturn new DoublyLinkedList();\n\t}\n\tthis._length = 0;\n\tthis._first = null;\n\tthis._last = null;\n\treturn this;\n}\n\n/**\n* Clears the list.\n*\n* @name clear\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {DoublyLinkedList} list instance\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Peek at the first value:\n* var v = list.first().value;\n* // returns 'foo'\n*\n* // Examine the list length:\n* var len = list.length;\n* // returns 2\n*\n* // Clear all list items:\n* list.clear();\n*\n* // Peek at the first value:\n* v = list.first();\n* // returns undefined\n*\n* // Examine the list length:\n* len = list.length;\n* // returns 0\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'clear', function clear() {\n\tthis._length = 0;\n\tthis._first = null;\n\tthis._last = null;\n\treturn this;\n});\n\n/**\n* Returns the first list node.\n*\n* @name first\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {(Node|void)} list node\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Peek at the first value:\n* var v = list.first().value;\n* // returns 'foo'\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'first', function first() {\n\tif ( this._length ) {\n\t\treturn this._first;\n\t}\n});\n\n/**\n* Inserts a value into the list either before or after a provided list node.\n*\n* @name insert\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @param {Node} node - node after which to insert the value\n* @param {*} value - value to insert\n* @param {string} [location='after'] - location\n* @throws {Error} must provide a node belonging to the list\n* @throws {Error} must provide a recognized location\n* @returns {DoublyLinkedList} list instance\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' ).push( 'beep' );\n*\n* // Determine the list length:\n* var len = list.length;\n* // returns 3\n*\n* // Get the second node:\n* var node = list.first().next;\n*\n* // Insert a value after the second node:\n* list.insert( node, 'boop' );\n*\n* // Determine the list length:\n* len = list.length;\n* // returns 4\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'insert', function insert( node, value, location ) {\n\t/* eslint-disable no-underscore-dangle */\n\tvar loc;\n\tvar n;\n\tif ( arguments.length > 2 ) {\n\t\tloc = location;\n\t\tif ( loc !== 'before' && loc !== 'after' ) {\n\t\t\tthrow new Error( format( 'invalid argument. Third argument must be a recognized location. Value: `%s`.', loc ) );\n\t\t}\n\t} else {\n\t\tloc = 'after';\n\t}\n\t// Case: insert after last node (equivalent to `push()`)\n\tif ( loc === 'after' && node === this._last ) {\n\t\treturn this.push( value );\n\t}\n\t// Case: insert before first node (equivalent to `unshift()`)\n\tif ( loc === 'before' && node === this._first ) {\n\t\treturn this.unshift( value );\n\t}\n\t// Unfortunately, we need to check whether we have been provided a node belonging to our list by walking the list. If we don't, we could erroneously increment the list length. This means our runtime goes from the theoretical O(1) to O(N).\n\tn = this._first;\n\twhile ( n !== this._last && n !== node ) {\n\t\tn = n._next;\n\t}\n\t// Check if we iterated through the entire list:\n\tif ( n === this._last && n !== node ) {\n\t\tthrow new Error( 'invalid argument. The list does not contain the provided list node.' );\n\t}\n\t// Create a new list node:\n\tn = new Node( value );\n\n\t// Update pointers...\n\tif ( loc === 'after' ) {\n\t\tnode._next._prev = n;\n\t\tn._next = node._next;\n\n\t\tnode._next = n;\n\t\tn._prev = node;\n\t} else {\n\t\tnode._prev._next = n;\n\t\tn._prev = node._prev;\n\n\t\tnode._prev = n;\n\t\tn._next = node;\n\t}\n\t// Increment the list length:\n\tthis._length += 1;\n\n\treturn this;\n\n\t/* eslint-enable no-underscore-dangle */\n});\n\n/**\n* Returns an iterator for iterating over a list.\n*\n* ## Notes\n*\n* -   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 elements at the time of this method's invocation.\n*\n* @name iterator\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @param {string} [direction=\"forward\"] - iteration direction\n* @throws {Error} must provide a recognized iteration direction\n* @returns {Iterator} iterator\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Create an iterator:\n* var it = list.iterator();\n*\n* // Iterate over the list...\n* var v = it.next().value;\n* // returns 'foo'\n*\n* v = it.next().value;\n* // returns 'bar'\n*\n* var bool = it.next().done;\n* // returns true\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'iterator', function iterator( direction ) {\n\tvar values;\n\tvar iter;\n\tvar self;\n\tvar FLG;\n\tvar dir;\n\tvar inc;\n\tvar i;\n\tif ( arguments.length ) {\n\t\tdir = direction;\n\t\tif ( dir !== 'forward' && dir !== 'reverse' ) {\n\t\t\tthrow new Error( format( 'invalid argument. Must provide a recognized iteration direction. Value: `%s`.', dir ) );\n\t\t}\n\t} else {\n\t\tdir = 'forward';\n\t}\n\tself = this;\n\n\t// Initialize the iteration index:\n\tif ( dir === 'forward' ) {\n\t\ti = -1;\n\t\tinc = 1;\n\t} else {\n\t\ti = this._length;\n\t\tinc = -1;\n\t}\n\t// Create a copy of list values (necessary in order to \"snapshot\" the list; otherwise, values could come and go between calls to `next`):\n\tvalues = this.toArray();\n\n\t// Create an iterator protocol-compliant object:\n\titer = {};\n\tsetReadOnly( iter, 'next', next );\n\tsetReadOnly( iter, 'return', end );\n\tif ( iteratorSymbol ) {\n\t\tsetReadOnly( iter, iteratorSymbol, factory );\n\t}\n\treturn iter;\n\n\t/**\n\t* Returns an iterator protocol-compliant object containing the next iterated value.\n\t*\n\t* @private\n\t* @returns {Object} iterator protocol-compliant object\n\t*/\n\tfunction next() {\n\t\ti += inc;\n\t\tif ( FLG || i < 0 || i >= values.length ) {\n\t\t\treturn {\n\t\t\t\t'done': true\n\t\t\t};\n\t\t}\n\t\treturn {\n\t\t\t'value': values[ i ],\n\t\t\t'done': false\n\t\t};\n\t}\n\n\t/**\n\t* Finishes an iterator.\n\t*\n\t* @private\n\t* @param {*} [value] - value to return\n\t* @returns {Object} iterator protocol-compliant object\n\t*/\n\tfunction end( value ) {\n\t\tFLG = true;\n\t\tif ( arguments.length ) {\n\t\t\treturn {\n\t\t\t\t'value': value,\n\t\t\t\t'done': true\n\t\t\t};\n\t\t}\n\t\treturn {\n\t\t\t'done': true\n\t\t};\n\t}\n\n\t/**\n\t* Returns a new iterator.\n\t*\n\t* @private\n\t* @returns {Iterator} iterator\n\t*/\n\tfunction factory() {\n\t\treturn self.iterator();\n\t}\n});\n\n/**\n* Returns the last node.\n*\n* @name last\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {(Node|void)} list node\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Peek at the last value:\n* var v = list.last().value;\n* // returns 'bar'\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'last', function last() {\n\tif ( this._length ) {\n\t\treturn this._last;\n\t}\n});\n\n/**\n* List length.\n*\n* @name length\n* @memberof DoublyLinkedList.prototype\n* @type {NonNegativeInteger}\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Examine the initial list length:\n* var len = list.length;\n* // returns 0\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Retrieve the current list length:\n* len = list.length;\n* // returns 2\n*/\nsetReadOnlyAccessor( DoublyLinkedList.prototype, 'length', function get() {\n\treturn this._length;\n});\n\n/**\n* Removes a value from the end of the list.\n*\n* @name pop\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {(*|void)} removed value\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Remove the last value:\n* var v = list.pop();\n* // returns 'bar'\n*\n* // Add a new value to the list:\n* list.push( 'beep' );\n*\n* // Remove the last value:\n* v = list.pop();\n* // returns 'beep'\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'pop', function pop() {\n\t/* eslint-disable no-underscore-dangle */\n\tvar value;\n\tif ( this._length ) {\n\t\t// Retrieve the last value:\n\t\tvalue = this._last.value;\n\n\t\t// Check whether we have a new \"tail\" or whether we have emptied the list...\n\t\tif ( this._last._prev ) {\n\t\t\tthis._last = this._last._prev;\n\t\t\tthis._last._next = null;\n\t\t} else {\n\t\t\t// List is empty:\n\t\t\tthis._first = null;\n\t\t\tthis._last = null;\n\t\t}\n\t\t// Decrement the list length:\n\t\tthis._length -= 1;\n\t}\n\treturn value;\n\n\t/* eslint-enable no-underscore-dangle */\n});\n\n/**\n* Adds a value to the end of the list.\n*\n* @name push\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {DoublyLinkedList} list instance\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Remove the last value:\n* var v = list.pop();\n* // returns 'bar'\n*\n* // Add a new value to the list:\n* list.push( 'beep' );\n*\n* // Remove the last value:\n* v = list.pop();\n* // returns 'beep'\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'push', function push( value ) {\n\tvar node;\n\n\t// Create a new list node:\n\tnode = new Node( value );\n\n\t// Check whether the list is currently empty...\n\tif ( this._length === 0 ) {\n\t\t// This is the only list node, making it both the first and last node:\n\t\tthis._first = node;\n\t\tthis._last = node;\n\t} else {\n\t\t// Link the new node to the previous last node:\n\t\tnode._prev = this._last; // eslint-disable-line no-underscore-dangle\n\n\t\t// Link the previous last node to the new node:\n\t\tthis._last._next = node; // eslint-disable-line no-underscore-dangle\n\n\t\t// Update the pointer for the last node:\n\t\tthis._last = node;\n\t}\n\t// Increment the list length:\n\tthis._length += 1;\n\n\treturn this;\n});\n\n/**\n* Removes a list node from the list.\n*\n* @name remove\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @param {Node} node - node to remove\n* @throws {Error} must provide a node belonging to the list\n* @returns {(*|void)} removed value\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' ).push( 'beep' );\n*\n* // Determine the list length:\n* var len = list.length;\n* // returns 3\n*\n* // Get the second node:\n* var node = list.first().next;\n*\n* // Remove the second node:\n* var v = list.remove( node );\n* // returns 'bar'\n*\n* // Determine the list length:\n* len = list.length;\n* // returns 2\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'remove', function remove( node ) {\n\t/* eslint-disable no-underscore-dangle */\n\tvar value;\n\tvar n;\n\n\t// Case: first node (equivalent to `shift()`)\n\tif ( node === this._first ) {\n\t\treturn this.shift();\n\t}\n\t// Case: last node (equivalent to `pop()`)\n\tif ( node === this._last ) {\n\t\treturn this.pop();\n\t}\n\t// Retrieve the node value:\n\tvalue = node.value;\n\n\t// Unfortunately, we need to check whether we have been provided a node belonging to our list by walking the list. If we don't, we could erroneously decrement the list length. This means our runtime goes from the theoretical O(1) to O(N).\n\tn = this._first;\n\twhile ( n !== this._last && n !== node ) {\n\t\tn = n._next;\n\t}\n\t// Check if we iterated through the entire list:\n\tif ( n === this._last ) {\n\t\tthrow new Error( 'invalid argument. The list does not contain the provided list node.' );\n\t}\n\t// Update pointers:\n\tnode._prev._next = node._next;\n\tnode._next._prev = node._prev;\n\n\t// Decrement the list length:\n\tthis._length -= 1;\n\n\treturn value;\n\n\t/* eslint-enable no-underscore-dangle */\n});\n\n/**\n* Removes a value from the beginning of the list.\n*\n* @name shift\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {(*|void)} removed value\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Remove the first value:\n* var v = list.shift();\n* // returns 'foo'\n*\n* // Add a new value to the list:\n* list.push( 'beep' );\n*\n* // Remove the first value:\n* v = list.shift();\n* // returns 'bar'\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'shift', function shift() {\n\t/* eslint-disable no-underscore-dangle */\n\tvar value;\n\tif ( this._length ) {\n\t\t// Retrieve the first value:\n\t\tvalue = this._first.value;\n\n\t\t// Check whether we have a new \"head\" or whether we have emptied the list...\n\t\tif ( this._first._next ) {\n\t\t\tthis._first = this._first._next;\n\t\t\tthis._first._prev = null;\n\t\t} else {\n\t\t\t// List is empty:\n\t\t\tthis._first = null;\n\t\t\tthis._last = null;\n\t\t}\n\t\t// Decrement the list length:\n\t\tthis._length -= 1;\n\t}\n\treturn value;\n\n\t/* eslint-enable no-underscore-dangle */\n});\n\n/**\n* Returns an array of list values.\n*\n* @name toArray\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {Array} list values\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Get an array of list values:\n* var vals = list.toArray();\n* // returns [ 'foo', 'bar' ]\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'toArray', function toArray() {\n\tvar node;\n\tvar out;\n\tvar i;\n\n\tout = [];\n\tnode = this._first;\n\tfor ( i = 0; i < this._length; i++ ) {\n\t\tout.push( node.value );\n\t\tnode = node.next;\n\t}\n\treturn out;\n});\n\n/**\n* Serializes a list as JSON.\n*\n* ## Notes\n*\n* -   `JSON.stringify()` implicitly calls this method when stringifying a `DoublyLinkedList` instance.\n*\n* @name toJSON\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {Object} serialized list\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Serialize to JSON:\n* var o = list.toJSON();\n* // returns { 'type': 'doubly-linked-list', 'data': [ 'foo', 'bar' ] }\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'toJSON', function toJSON() {\n\tvar out = {};\n\tout.type = 'doubly-linked-list';\n\tout.data = this.toArray();\n\treturn out;\n});\n\n/**\n* Adds a value to the beginning of the list.\n*\n* @name unshift\n* @memberof DoublyLinkedList.prototype\n* @type {Function}\n* @returns {DoublyLinkedList} list instance\n*\n* @example\n* var list = new DoublyLinkedList();\n*\n* // Add values to the beginning of the list:\n* list.unshift( 'foo' ).unshift( 'bar' );\n*\n* // Remove the last value:\n* var v = list.pop();\n* // returns 'foo'\n*\n* // Add a new value to the beginning of the list:\n* list.unshift( 'beep' );\n*\n* // Remove the last value:\n* v = list.pop();\n* // returns 'bar'\n*/\nsetReadOnly( DoublyLinkedList.prototype, 'unshift', function unshift( value ) {\n\tvar node;\n\n\t// Create a new list node:\n\tnode = new Node( value );\n\n\t// Check whether the list is currently empty...\n\tif ( this._length === 0 ) {\n\t\t// This is the only list node, making it both the first and last node:\n\t\tthis._first = node;\n\t\tthis._last = node;\n\t} else {\n\t\t// Link the new node to the previous first node:\n\t\tnode._next = this._first; // eslint-disable-line no-underscore-dangle\n\n\t\t// Link the previous first node to the new node:\n\t\tthis._first._prev = node; // eslint-disable-line no-underscore-dangle\n\n\t\t// Update the pointer for the first node:\n\t\tthis._first = node;\n\t}\n\t// Increment the list length:\n\tthis._length += 1;\n\n\treturn this;\n});\n\n\n// EXPORTS //\n\nmodule.exports = DoublyLinkedList;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2018 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n*    http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Doubly linked list.\n*\n* @module @stdlib/dstructs-doubly-linked-list\n*\n* @example\n* var doublyLinkedList = require( '@stdlib/dstructs-doubly-linked-list' );\n*\n* var list = doublyLinkedList();\n*\n* // Add values to the list:\n* list.push( 'foo' ).push( 'bar' );\n*\n* // Remove the last value:\n* var v = list.pop();\n* // returns 'bar'\n*\n* // Add a new value to the list:\n* list.push( 'beep' );\n*\n* // Remove the first list value:\n* v = list.shift();\n* // returns 'foo'\n*/\n\n// MODULES //\n\nvar main = require( './main.js' );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"],
+  "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAiB,QAAS,+BAAgC,EAiB9D,SAASC,EAAMC,EAAQ,CAEtB,OAAAF,EAAgB,KAAM,OAAQ,CAC7B,aAAgB,GAChB,WAAc,GACd,IAAO,UAAe,CACrB,OAAO,KAAK,KACb,CACD,CAAC,EACDA,EAAgB,KAAM,OAAQ,CAC7B,aAAgB,GAChB,WAAc,GACd,IAAO,UAAe,CACrB,OAAO,KAAK,KACb,CACD,CAAC,EACD,KAAK,MAAQE,EAEbF,EAAgB,KAAM,QAAS,CAC9B,aAAgB,GAChB,WAAc,GACd,SAAY,GACZ,MAAS,IACV,CAAC,EACDA,EAAgB,KAAM,QAAS,CAC9B,aAAgB,GAChB,WAAc,GACd,SAAY,GACZ,MAAS,IACV,CAAC,EAEM,IACR,CAKAD,EAAO,QAAUE,IC5EjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAwBA,IAAIC,EAAc,QAAS,uDAAwD,EAC/EC,EAAsB,QAAS,uDAAwD,EACvFC,EAAiB,QAAS,yBAA0B,EACpDC,EAAS,QAAS,uBAAwB,EAC1CC,EAAO,IA4BX,SAASC,GAAmB,CAC3B,OAAO,gBAAgBA,GAGvB,KAAK,QAAU,EACf,KAAK,OAAS,KACd,KAAK,MAAQ,KACN,MALC,IAAIA,CAMb,CAmCAL,EAAaK,EAAiB,UAAW,QAAS,UAAiB,CAClE,YAAK,QAAU,EACf,KAAK,OAAS,KACd,KAAK,MAAQ,KACN,IACR,CAAC,EAoBDL,EAAaK,EAAiB,UAAW,QAAS,UAAiB,CAClE,GAAK,KAAK,QACT,OAAO,KAAK,MAEd,CAAC,EAmCDL,EAAaK,EAAiB,UAAW,SAAU,SAAiBC,EAAMC,EAAOC,EAAW,CAE3F,IAAIC,EACAC,EACJ,GAAK,UAAU,OAAS,GAEvB,GADAD,EAAMD,EACDC,IAAQ,UAAYA,IAAQ,QAChC,MAAM,IAAI,MAAON,EAAQ,+EAAgFM,CAAI,CAAE,OAGhHA,EAAM,QAGP,GAAKA,IAAQ,SAAWH,IAAS,KAAK,MACrC,OAAO,KAAK,KAAMC,CAAM,EAGzB,GAAKE,IAAQ,UAAYH,IAAS,KAAK,OACtC,OAAO,KAAK,QAASC,CAAM,EAI5B,IADAG,EAAI,KAAK,OACDA,IAAM,KAAK,OAASA,IAAMJ,GACjCI,EAAIA,EAAE,MAGP,GAAKA,IAAM,KAAK,OAASA,IAAMJ,EAC9B,MAAM,IAAI,MAAO,qEAAsE,EAGxF,OAAAI,EAAI,IAAIN,EAAMG,CAAM,EAGfE,IAAQ,SACZH,EAAK,MAAM,MAAQI,EACnBA,EAAE,MAAQJ,EAAK,MAEfA,EAAK,MAAQI,EACbA,EAAE,MAAQJ,IAEVA,EAAK,MAAM,MAAQI,EACnBA,EAAE,MAAQJ,EAAK,MAEfA,EAAK,MAAQI,EACbA,EAAE,MAAQJ,GAGX,KAAK,SAAW,EAET,IAGR,CAAC,EAmCDN,EAAaK,EAAiB,UAAW,WAAY,SAAmBM,EAAY,CACnF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACJ,GAAK,UAAU,QAEd,GADAF,EAAML,EACDK,IAAQ,WAAaA,IAAQ,UACjC,MAAM,IAAI,MAAOb,EAAQ,gFAAiFa,CAAI,CAAE,OAGjHA,EAAM,UAEP,OAAAF,EAAO,KAGFE,IAAQ,WACZE,EAAI,GACJD,EAAM,IAENC,EAAI,KAAK,QACTD,EAAM,IAGPL,EAAS,KAAK,QAAQ,EAGtBC,EAAO,CAAC,EACRb,EAAaa,EAAM,OAAQM,CAAK,EAChCnB,EAAaa,EAAM,SAAUO,CAAI,EAC5BlB,GACJF,EAAaa,EAAMX,EAAgBmB,CAAQ,EAErCR,EAQP,SAASM,GAAO,CAEf,OADAD,GAAKD,EACAF,GAAOG,EAAI,GAAKA,GAAKN,EAAO,OACzB,CACN,KAAQ,EACT,EAEM,CACN,MAASA,EAAQM,CAAE,EACnB,KAAQ,EACT,CACD,CASA,SAASE,EAAKb,EAAQ,CAErB,OADAQ,EAAM,GACD,UAAU,OACP,CACN,MAASR,EACT,KAAQ,EACT,EAEM,CACN,KAAQ,EACT,CACD,CAQA,SAASc,GAAU,CAClB,OAAOP,EAAK,SAAS,CACtB,CACD,CAAC,EAoBDd,EAAaK,EAAiB,UAAW,OAAQ,UAAgB,CAChE,GAAK,KAAK,QACT,OAAO,KAAK,KAEd,CAAC,EAuBDJ,EAAqBI,EAAiB,UAAW,SAAU,UAAe,CACzE,OAAO,KAAK,OACb,CAAC,EA2BDL,EAAaK,EAAiB,UAAW,MAAO,UAAe,CAE9D,IAAIE,EACJ,OAAK,KAAK,UAETA,EAAQ,KAAK,MAAM,MAGd,KAAK,MAAM,OACf,KAAK,MAAQ,KAAK,MAAM,MACxB,KAAK,MAAM,MAAQ,OAGnB,KAAK,OAAS,KACd,KAAK,MAAQ,MAGd,KAAK,SAAW,GAEVA,CAGR,CAAC,EA2BDP,EAAaK,EAAiB,UAAW,OAAQ,SAAeE,EAAQ,CACvE,IAAID,EAGJ,OAAAA,EAAO,IAAIF,EAAMG,CAAM,EAGlB,KAAK,UAAY,GAErB,KAAK,OAASD,EACd,KAAK,MAAQA,IAGbA,EAAK,MAAQ,KAAK,MAGlB,KAAK,MAAM,MAAQA,EAGnB,KAAK,MAAQA,GAGd,KAAK,SAAW,EAET,IACR,CAAC,EAiCDN,EAAaK,EAAiB,UAAW,SAAU,SAAiBC,EAAO,CAE1E,IAAIC,EACAG,EAGJ,GAAKJ,IAAS,KAAK,OAClB,OAAO,KAAK,MAAM,EAGnB,GAAKA,IAAS,KAAK,MAClB,OAAO,KAAK,IAAI,EAOjB,IAJAC,EAAQD,EAAK,MAGbI,EAAI,KAAK,OACDA,IAAM,KAAK,OAASA,IAAMJ,GACjCI,EAAIA,EAAE,MAGP,GAAKA,IAAM,KAAK,MACf,MAAM,IAAI,MAAO,qEAAsE,EAGxF,OAAAJ,EAAK,MAAM,MAAQA,EAAK,MACxBA,EAAK,MAAM,MAAQA,EAAK,MAGxB,KAAK,SAAW,EAETC,CAGR,CAAC,EA2BDP,EAAaK,EAAiB,UAAW,QAAS,UAAiB,CAElE,IAAIE,EACJ,OAAK,KAAK,UAETA,EAAQ,KAAK,OAAO,MAGf,KAAK,OAAO,OAChB,KAAK,OAAS,KAAK,OAAO,MAC1B,KAAK,OAAO,MAAQ,OAGpB,KAAK,OAAS,KACd,KAAK,MAAQ,MAGd,KAAK,SAAW,GAEVA,CAGR,CAAC,EAoBDP,EAAaK,EAAiB,UAAW,UAAW,UAAmB,CACtE,IAAIC,EACAgB,EACA,EAIJ,IAFAA,EAAM,CAAC,EACPhB,EAAO,KAAK,OACN,EAAI,EAAG,EAAI,KAAK,QAAS,IAC9BgB,EAAI,KAAMhB,EAAK,KAAM,EACrBA,EAAOA,EAAK,KAEb,OAAOgB,CACR,CAAC,EAwBDtB,EAAaK,EAAiB,UAAW,SAAU,UAAkB,CACpE,IAAIiB,EAAM,CAAC,EACX,OAAAA,EAAI,KAAO,qBACXA,EAAI,KAAO,KAAK,QAAQ,EACjBA,CACR,CAAC,EA2BDtB,EAAaK,EAAiB,UAAW,UAAW,SAAkBE,EAAQ,CAC7E,IAAID,EAGJ,OAAAA,EAAO,IAAIF,EAAMG,CAAM,EAGlB,KAAK,UAAY,GAErB,KAAK,OAASD,EACd,KAAK,MAAQA,IAGbA,EAAK,MAAQ,KAAK,OAGlB,KAAK,OAAO,MAAQA,EAGpB,KAAK,OAASA,GAGf,KAAK,SAAW,EAET,IACR,CAAC,EAKDP,EAAO,QAAUM,IClqBjB,IAAIkB,EAAO,IAKX,OAAO,QAAUA",
+  "names": ["require_node", "__commonJSMin", "exports", "module", "defineProperty", "Node", "value", "require_main", "__commonJSMin", "exports", "module", "setReadOnly", "setReadOnlyAccessor", "iteratorSymbol", "format", "Node", "DoublyLinkedList", "node", "value", "location", "loc", "n", "direction", "values", "iter", "self", "FLG", "dir", "inc", "i", "next", "end", "factory", "out", "main"]
+}

package/docs/types/index.d.ts

@@ -0,0 +1,412 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2021 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 4.1
+
+/* eslint-disable max-classes-per-file */
+
+/// <reference types="@stdlib/types"/>
+
+import { IterableIterator } from '@stdlib/types/iter';
+
+/**
+* List node.
+*/
+declare class Node {
+	/**
+	* List node constructor.
+	*
+	* @param value - node value
+	* @returns Node instance
+	*
+	* @example
+	* var node = new Node( 'foo' );
+	* // returns <Node>
+	*/
+	constructor( value: any );
+
+	/**
+	* Node value.
+	*/
+	value: any;
+
+	/**
+	* Next node in the list.
+	*/
+	readonly next: Node;
+
+	/**
+	* Previous node in the list.
+	*/
+	readonly prev: Node;
+
+	/**
+	* Private field pointing to the next node.
+	*/
+	private readonly _next: Node;
+
+	/**
+	* Private field pointing to the previous node.
+	*/
+	private readonly _prev: Node;
+}
+
+/**
+* Doubly linked list.
+*/
+declare class DoublyLinkedList {
+	/**
+	* Doubly linked list constructor.
+	*
+	* @returns linked list instance
+	*
+	* @example
+	* var list = new 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 first value:
+	* v = list.shift();
+	* // returns 'foo'
+	*/
+	constructor();
+
+	/**
+	* Clears the list.
+	*
+	* @returns list instance
+	*
+	* @example
+	* var list = new 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 0
+	*/
+	clear(): DoublyLinkedList;
+
+	/**
+	* Returns the first list node.
+	*
+	* @returns list node
+	*
+	* @example
+	* var list = new DoublyLinkedList();
+	*
+	* // Add values to the list:
+	* list.push( 'foo' ).push( 'bar' );
+	*
+	* // Peek at the first value:
+	* var v = list.first().value;
+	* // returns 'foo'
+	*/
+	first(): Node | void;
+
+	/**
+	* Inserts a value into the list either before or after a provided list node.
+	*
+	* @param node - node after which to insert the value
+	* @param value - value to insert
+	* @param location - location (default: 'after')
+	* @throws must provide a node belonging to the list
+	* @throws must provide a recognized location
+	* @returns list instance
+	*
+	* @example
+	* var list = new 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
+	*/
+	insert( node: Node, value: unknown, location?: 'before' | 'after' ): DoublyLinkedList;
+
+	/**
+	* Returns an iterator for iterating over a list.
+	*
+	* ## Notes
+	*
+	* -   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 elements at the time of this method's invocation.
+	*
+	* @param direction - iteration direction (default: 'forward')
+	* @throws must provide a recognized iteration direction
+	* @returns iterator
+	*
+	* @example
+	* var list = new 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
+	*/
+	iterator( direction?: 'forward' | 'reverse' ): IterableIterator;
+
+	/**
+	* Returns the last node.
+	*
+	* @returns list node
+	*
+	* @example
+	* var list = new DoublyLinkedList();
+	*
+	* // Add values to the list:
+	* list.push( 'foo' ).push( 'bar' );
+	*
+	* // Peek at the last value:
+	* var v = list.last().value;
+	* // returns 'bar'
+	*/
+	last(): Node | void;
+
+	/**
+	* List length.
+	*
+	* @example
+	* var list = new 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
+	*/
+	readonly length: number;
+
+	/**
+	* Removes a value from the end of the list.
+	*
+	* @example
+	* var list = new 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'
+	*/
+	pop(): any;
+
+	/**
+	* Adds a value to the end of the list.
+	*
+	* @returns list instance
+	*
+	* @example
+	* var list = new 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'
+	*/
+	push(): DoublyLinkedList;
+
+	/**
+	* Removes a list node from the list.
+	*
+	* @param node - node to remove
+	* @throws must provide a node belonging to the list
+	* @returns removed value
+	*
+	* @example
+	* var list = new 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
+	*/
+	remove( node: Node ): any;
+
+	/**
+	* Removes a value from the beginning of the list.
+	*
+	* @returns removed value
+	*
+	* @example
+	* var list = new 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'
+	*/
+	shift(): any;
+
+	/**
+	* Returns an array of list values.
+	*
+	* @returns list values
+	*
+	* @example
+	* var list = new DoublyLinkedList();
+	*
+	* // Add values to the list:
+	* list.push( 'foo' ).push( 'bar' );
+	*
+	* // Get an array of list values:
+	* var vals = list.toArray();
+	* // returns [ 'foo', 'bar' ]
+	*/
+	toArray(): Array<any>;
+
+	/**
+	* Serializes a list as JSON.
+	*
+	* ## Notes
+	*
+	* -   `JSON.stringify()` implicitly calls this method when stringifying a `DoublyLinkedList` instance.
+	*
+	* @returns serialized list
+	*
+	* @example
+	* var list = new 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' ] }
+	*/
+	toJSON(): any;
+
+	/**
+	* Adds a value to the beginning of the list.
+	*
+	* @returns list instance
+	*
+	* @example
+	* var list = new DoublyLinkedList();
+	*
+	* // Add values to the beginning of the list:
+	* list.unshift( 'foo' ).unshift( 'bar' );
+	*
+	* // Remove the last value:
+	* var v = list.pop();
+	* // returns 'foo'
+	*
+	* // Add a new value to the beginning of the list:
+	* list.unshift( 'beep' );
+	*
+	* // Remove the last value:
+	* v = list.pop();
+	* // returns 'bar'
+	*/
+	unshift(): DoublyLinkedList;
+}
+
+
+// EXPORTS //
+
+export = DoublyLinkedList;

package/lib/index.js

@@ -0,0 +1,53 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+'use strict';
+
+/**
+* Doubly linked list.
+*
+* @module @stdlib/dstructs-doubly-linked-list
+*
+* @example
+* var doublyLinkedList = require( '@stdlib/dstructs-doubly-linked-list' );
+*
+* 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 first list value:
+* v = list.shift();
+* // returns 'foo'
+*/
+
+// MODULES //
+
+var main = require( './main.js' );
+
+
+// EXPORTS //
+
+module.exports = main;