RanchiMall/fcoin
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

list: comments.

Browse Source
This commit is contained in:
Christopher Jeffrey 2016-12-17 02:01:35 -08:00
parent dcfc19408f
commit 7606667ea5
No known key found for this signature in database
GPG Key ID: 8962AB9DE6666BBD
1 changed files with 21 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
lib/utils/list.js
View File

@ -1,11 +1,20 @@
/*!
* list.js - double linked list for bcoin
* Copyright (c) 2014-2016, Christopher Jeffrey (MIT License).
* https://github.com/bcoin-org/bcoin
*/
'use strict'; 'use strict';
var assert = require('assert'); var assert = require('assert');
/** /**
* A linked list. * A double linked list.
* @exports List * @exports List
* @constructor * @constructor
* @property {ListItem|null} head
* @property {ListItem|null} tail
* @property {Number} size
*/ */
function List() { function List() {
@ -39,6 +48,7 @@ List.prototype.reset = function reset() {
/** /**
* Remove the first item in the list. * Remove the first item in the list.
* @returns {ListItem}
*/ */
List.prototype.shift = function shift() { List.prototype.shift = function shift() {
@ -54,8 +64,8 @@ List.prototype.shift = function shift() {
/** /**
* Prepend an item to the linked list (sets new head). * Prepend an item to the linked list (sets new head).
* @private
* @param {ListItem} * @param {ListItem}
* @returns {Boolean}
*/ */
List.prototype.unshift = function unshift(item) { List.prototype.unshift = function unshift(item) {
@ -64,8 +74,8 @@ List.prototype.unshift = function unshift(item) {
/** /**
* Append an item to the linked list (sets new tail). * Append an item to the linked list (sets new tail).
* @private
* @param {ListItem} * @param {ListItem}
* @returns {Boolean}
*/ */
List.prototype.push = function push(item) { List.prototype.push = function push(item) {
@ -74,6 +84,7 @@ List.prototype.push = function push(item) {
/** /**
* Remove the last item in the list. * Remove the last item in the list.
* @returns {ListItem}
*/ */
List.prototype.pop = function pop() { List.prototype.pop = function pop() {
@ -92,6 +103,7 @@ List.prototype.pop = function pop() {
* @private * @private
* @param {ListItem|null} ref * @param {ListItem|null} ref
* @param {ListItem} item * @param {ListItem} item
* @returns {Boolean}
*/ */
List.prototype.insert = function insert(ref, item) { List.prototype.insert = function insert(ref, item) {
@ -130,6 +142,7 @@ List.prototype.insert = function insert(ref, item) {
* Remove item from the linked list. * Remove item from the linked list.
* @private * @private
* @param {ListItem} * @param {ListItem}
* @returns {Boolean}
*/ */
List.prototype.remove = function remove(item) { List.prototype.remove = function remove(item) {
@ -164,8 +177,9 @@ List.prototype.remove = function remove(item) {
/** /**
* Slice the list to an array of items. * Slice the list to an array of items.
* @param {Number} total * Will remove the items sliced.
* @returns {Object[]} * @param {Number?} total
* @returns {ListItem[]}
*/ */
List.prototype.slice = function slice(total) { List.prototype.slice = function slice(total) {
@ -201,7 +215,7 @@ List.prototype.slice = function slice(total) {
/** /**
* Convert the list to an array of items. * Convert the list to an array of items.
* @returns {Object[]} * @returns {ListItem[]}
*/ */
List.prototype.toArray = function toArray() { List.prototype.toArray = function toArray() {
@ -215,7 +229,7 @@ List.prototype.toArray = function toArray() {
}; };
/** /**
* Represents an LRU item. * Represents an linked list item.
* @constructor * @constructor
* @private * @private
* @param {String} key * @param {String} key