data-structure-typed 1.21.4 → 1.32.0

package/dist/data-structures/linked-list/doubly-linked-list.js

@@ -1,87 +1,125 @@
 "use strict";
+var __values = (this && this.__values) || function(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function () {
+            if (o && i >= o.length) o = void 0;
+            return { value: o && o[i++], done: !o };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DoublyLinkedList = exports.DoublyLinkedListNode = void 0;
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-class DoublyLinkedListNode {
-    /**
-     * The constructor function initializes the value, next, and previous properties of an object.
-     * @param {T} val - The "val" parameter is the value that will be stored in the node. It can be of any data type, as it
-     * is defined as a generic type "T".
-     */
-    constructor(val) {
+var DoublyLinkedListNode = (function () {
+    function DoublyLinkedListNode(val) {
         this._val = val;
         this._next = null;
         this._prev = null;
     }
-    get val() {
-        return this._val;
-    }
-    set val(value) {
-        this._val = value;
-    }
-    get next() {
-        return this._next;
-    }
-    set next(value) {
-        this._next = value;
-    }
-    get prev() {
-        return this._prev;
-    }
-    set prev(value) {
-        this._prev = value;
-    }
-}
+    Object.defineProperty(DoublyLinkedListNode.prototype, "val", {
+        get: function () {
+            return this._val;
+        },
+        set: function (value) {
+            this._val = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DoublyLinkedListNode.prototype, "next", {
+        get: function () {
+            return this._next;
+        },
+        set: function (value) {
+            this._next = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DoublyLinkedListNode.prototype, "prev", {
+        get: function () {
+            return this._prev;
+        },
+        set: function (value) {
+            this._prev = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    return DoublyLinkedListNode;
+}());
 exports.DoublyLinkedListNode = DoublyLinkedListNode;
-class DoublyLinkedList {
-    /**
-     * The constructor initializes the linked list with an empty head, tail, and length.
-     */
-    constructor() {
+var DoublyLinkedList = (function () {
+    function DoublyLinkedList() {
         this._head = null;
         this._tail = null;
         this._length = 0;
     }
-    get head() {
-        return this._head;
-    }
-    set head(value) {
-        this._head = value;
-    }
-    get tail() {
-        return this._tail;
-    }
-    set tail(value) {
-        this._tail = value;
-    }
-    get length() {
-        return this._length;
-    }
-    /**
-     * The `fromArray` function creates a new instance of a DoublyLinkedList and populates it with the elements from the
-     * given array.
-     * @param {T[]} data - The `data` parameter is an array of elements of type `T`.
-     * @returns The `fromArray` function returns a DoublyLinkedList object.
-     */
-    static fromArray(data) {
-        const doublyLinkedList = new DoublyLinkedList();
-        for (const item of data) {
-            doublyLinkedList.push(item);
+    Object.defineProperty(DoublyLinkedList.prototype, "head", {
+        get: function () {
+            return this._head;
+        },
+        set: function (value) {
+            this._head = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DoublyLinkedList.prototype, "tail", {
+        get: function () {
+            return this._tail;
+        },
+        set: function (value) {
+            this._tail = value;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(DoublyLinkedList.prototype, "length", {
+        get: function () {
+            return this._length;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    DoublyLinkedList.fromArray = function (data) {
+        var e_1, _a;
+        var doublyLinkedList = new DoublyLinkedList();
+        try {
+            for (var data_1 = __values(data), data_1_1 = data_1.next(); !data_1_1.done; data_1_1 = data_1.next()) {
+                var item = data_1_1.value;
+                doublyLinkedList.push(item);
+            }
+        }
+        catch (e_1_1) { e_1 = { error: e_1_1 }; }
+        finally {
+            try {
+                if (data_1_1 && !data_1_1.done && (_a = data_1.return)) _a.call(data_1);
+            }
+            finally { if (e_1) throw e_1.error; }
         }
         return doublyLinkedList;
-    }
-    /**
-     * The push function adds a new node with the given value to the end of the doubly linked list.
-     * @param {T} val - The value to be added to the linked list.
-     */
-    push(val) {
-        const newNode = new DoublyLinkedListNode(val);
+    };
+    DoublyLinkedList.prototype.push = function (val) {
+        var newNode = new DoublyLinkedListNode(val);
         if (!this.head) {
             this.head = newNode;
             this.tail = newNode;
@@ -92,16 +130,11 @@ class DoublyLinkedList {
             this.tail = newNode;
         }
         this._length++;
-    }
-    /**
-     * The `pop()` function removes and returns the value of the last node in a doubly linked list.
-     * @returns The method is returning the value of the removed node (removedNode.val) if the list is not empty. If the
-     * list is empty, it returns null.
-     */
-    pop() {
+    };
+    DoublyLinkedList.prototype.pop = function () {
         if (!this.tail)
-            return null;
-        const removedNode = this.tail;
+            return undefined;
+        var removedNode = this.tail;
         if (this.head === this.tail) {
             this.head = null;
             this.tail = null;
@@ -112,16 +145,11 @@ class DoublyLinkedList {
         }
         this._length--;
         return removedNode.val;
-    }
-    /**
-     * The `shift()` function removes and returns the value of the first node in a doubly linked list.
-     * @returns The method `shift()` returns the value of the node that is removed from the beginning of the doubly linked
-     * list.
-     */
-    shift() {
+    };
+    DoublyLinkedList.prototype.shift = function () {
         if (!this.head)
-            return null;
-        const removedNode = this.head;
+            return undefined;
+        var removedNode = this.head;
         if (this.head === this.tail) {
             this.head = null;
             this.tail = null;
@@ -132,14 +160,9 @@ class DoublyLinkedList {
         }
         this._length--;
         return removedNode.val;
-    }
-    /**
-     * The unshift function adds a new node with the given value to the beginning of a doubly linked list.
-     * @param {T} val - The `val` parameter represents the value of the new node that will be added to the beginning of the
-     * doubly linked list.
-     */
-    unshift(val) {
-        const newNode = new DoublyLinkedListNode(val);
+    };
+    DoublyLinkedList.prototype.unshift = function (val) {
+        var newNode = new DoublyLinkedListNode(val);
         if (!this.head) {
             this.head = newNode;
             this.tail = newNode;
@@ -150,49 +173,27 @@ class DoublyLinkedList {
             this.head = newNode;
         }
         this._length++;
-    }
-    /**
-     * The `getAt` function returns the value at a specified index in a linked list, or null if the index is out of bounds.
-     * @param {number} index - The index parameter is a number that represents the position of the element we want to
-     * retrieve from the list.
-     * @returns The method is returning the value at the specified index in the linked list. If the index is out of bounds
-     * or the linked list is empty, it will return null.
-     */
-    getAt(index) {
+    };
+    DoublyLinkedList.prototype.getAt = function (index) {
         if (index < 0 || index >= this.length)
-            return null;
-        let current = this.head;
-        for (let i = 0; i < index; i++) {
+            return undefined;
+        var current = this.head;
+        for (var i = 0; i < index; i++) {
             current = current.next;
         }
         return current.val;
-    }
-    /**
-     * The function `getNodeAt` returns the node at a given index in a doubly linked list, or null if the index is out of
-     * range.
-     * @param {number} index - The `index` parameter is a number that represents the position of the node we want to
-     * retrieve from the doubly linked list. It indicates the zero-based index of the node we want to access.
-     * @returns The method `getNodeAt(index: number)` returns a `DoublyLinkedListNode<T>` object if the index is within the
-     * valid range of the linked list, otherwise it returns `null`.
-     */
-    getNodeAt(index) {
+    };
+    DoublyLinkedList.prototype.getNodeAt = function (index) {
         if (index < 0 || index >= this.length)
             return null;
-        let current = this.head;
-        for (let i = 0; i < index; i++) {
+        var current = this.head;
+        for (var i = 0; i < index; i++) {
             current = current.next;
         }
         return current;
-    }
-    /**
-     * The function `findNodeByValue` searches for a node with a specific value in a doubly linked list and returns the
-     * node if found, otherwise it returns null.
-     * @param {T} val - The `val` parameter is the value that we want to search for in the doubly linked list.
-     * @returns The function `findNodeByValue` returns a `DoublyLinkedListNode<T>` if a node with the specified value `val`
-     * is found in the linked list. If no such node is found, it returns `null`.
-     */
-    findNode(val) {
-        let current = this.head;
+    };
+    DoublyLinkedList.prototype.findNode = function (val) {
+        var current = this.head;
         while (current) {
             if (current.val === val) {
                 return current;
@@ -200,17 +201,8 @@ class DoublyLinkedList {
             current = current.next;
         }
         return null;
-    }
-    /**
-     * The `insert` function inserts a value at a specified index in a doubly linked list.
-     * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
-     * DoublyLinkedList. It is of type number.
-     * @param {T} val - The `val` parameter represents the value that you want to insert into the Doubly Linked List at the
-     * specified index.
-     * @returns The `insert` method returns a boolean value. It returns `true` if the insertion is successful, and `false`
-     * if the index is out of bounds.
-     */
-    insertAt(index, val) {
+    };
+    DoublyLinkedList.prototype.insertAt = function (index, val) {
         if (index < 0 || index > this.length)
             return false;
         if (index === 0) {
@@ -221,47 +213,33 @@ class DoublyLinkedList {
             this.push(val);
             return true;
         }
-        const newNode = new DoublyLinkedListNode(val);
-        const prevNode = this.getNodeAt(index - 1);
-        const nextNode = prevNode.next;
+        var newNode = new DoublyLinkedListNode(val);
+        var prevNode = this.getNodeAt(index - 1);
+        var nextNode = prevNode.next;
         newNode.prev = prevNode;
         newNode.next = nextNode;
         prevNode.next = newNode;
         nextNode.prev = newNode;
         this._length++;
         return true;
-    }
-    /**
-     * The `deleteAt` function removes an element at a specified index from a linked list and returns the removed element.
-     * @param {number} index - The index parameter represents the position of the element that needs to be deleted in the
-     * data structure. It is of type number.
-     * @returns The method `deleteAt` returns the value of the node that was deleted, or `null` if the index is out of
-     * bounds.
-     */
-    deleteAt(index) {
+    };
+    DoublyLinkedList.prototype.deleteAt = function (index) {
         if (index < 0 || index >= this.length)
-            return null;
+            return undefined;
         if (index === 0)
             return this.shift();
         if (index === this.length - 1)
             return this.pop();
-        const removedNode = this.getNodeAt(index);
-        const prevNode = removedNode.prev;
-        const nextNode = removedNode.next;
+        var removedNode = this.getNodeAt(index);
+        var prevNode = removedNode.prev;
+        var nextNode = removedNode.next;
         prevNode.next = nextNode;
         nextNode.prev = prevNode;
         this._length--;
         return removedNode.val;
-    }
-    /**
-     * The `delete` function removes a node from a doubly linked list based on either the node itself or its value.
-     * @param {T | DoublyLinkedListNode<T>} valOrNode - The `valOrNode` parameter can accept either a value of type `T` or
-     * a `DoublyLinkedListNode<T>` object.
-     * @returns The `delete` method returns a boolean value. It returns `true` if the value or node was successfully
-     * deleted from the doubly linked list, and `false` if the value or node was not found in the list.
-     */
-    delete(valOrNode) {
-        let node;
+    };
+    DoublyLinkedList.prototype.delete = function (valOrNode) {
+        var node;
         if (valOrNode instanceof DoublyLinkedListNode) {
             node = valOrNode;
         }
@@ -276,8 +254,8 @@ class DoublyLinkedList {
                 this.pop();
             }
             else {
-                const prevNode = node.prev;
-                const nextNode = node.next;
+                var prevNode = node.prev;
+                var nextNode = node.next;
                 prevNode.next = nextNode;
                 nextNode.prev = prevNode;
                 this._length--;
@@ -285,37 +263,23 @@ class DoublyLinkedList {
             return true;
         }
         return false;
-    }
-    /**
-     * The `toArray` function converts a linked list into an array.
-     * @returns The `toArray()` method is returning an array of type `T[]`.
-     */
-    toArray() {
-        const array = [];
-        let current = this.head;
+    };
+    DoublyLinkedList.prototype.toArray = function () {
+        var array = [];
+        var current = this.head;
         while (current) {
             array.push(current.val);
             current = current.next;
         }
         return array;
-    }
-    /**
-     * The `clear` function resets the linked list by setting the head, tail, and length to null and 0 respectively.
-     */
-    clear() {
+    };
+    DoublyLinkedList.prototype.clear = function () {
         this._head = null;
         this._tail = null;
         this._length = 0;
-    }
-    /**
-     * The `find` function iterates through a linked list and returns the first element that satisfies a given condition.
-     * @param callback - A function that takes a value of type T as its parameter and returns a boolean value. This
-     * function is used to determine whether a particular value in the linked list satisfies a certain condition.
-     * @returns The method `find` returns the first element in the linked list that satisfies the condition specified by
-     * the callback function. If no element satisfies the condition, it returns `null`.
-     */
-    find(callback) {
-        let current = this.head;
+    };
+    DoublyLinkedList.prototype.find = function (callback) {
+        var current = this.head;
         while (current) {
             if (callback(current.val)) {
                 return current.val;
@@ -323,17 +287,10 @@ class DoublyLinkedList {
             current = current.next;
         }
         return null;
-    }
-    /**
-     * The function returns the index of the first occurrence of a given value in a linked list.
-     * @param {T} val - The parameter `val` is of type `T`, which means it can be any data type. It represents the value
-     * that we are searching for in the linked list.
-     * @returns The method `indexOf` returns the index of the first occurrence of the specified value `val` in the linked
-     * list. If the value is not found, it returns -1.
-     */
-    indexOf(val) {
-        let index = 0;
-        let current = this.head;
+    };
+    DoublyLinkedList.prototype.indexOf = function (val) {
+        var index = 0;
+        var current = this.head;
         while (current) {
             if (current.val === val) {
                 return index;
@@ -342,17 +299,9 @@ class DoublyLinkedList {
             current = current.next;
         }
         return -1;
-    }
-    /**
-     * The `findLast` function iterates through a linked list from the last node to the first node and returns the last
-     * value that satisfies the given callback function, or null if no value satisfies the callback.
-     * @param callback - A function that takes a value of type T as its parameter and returns a boolean value. This
-     * function is used to determine whether a given value satisfies a certain condition.
-     * @returns The method `findLast` returns the last value in the linked list that satisfies the condition specified by
-     * the callback function. If no value satisfies the condition, it returns `null`.
-     */
-    findLast(callback) {
-        let current = this.tail;
+    };
+    DoublyLinkedList.prototype.findLast = function (callback) {
+        var current = this.tail;
         while (current) {
             if (callback(current.val)) {
                 return current.val;
@@ -360,74 +309,47 @@ class DoublyLinkedList {
             current = current.prev;
         }
         return null;
-    }
-    /**
-     * The `toArrayReverse` function converts a doubly linked list into an array in reverse order.
-     * @returns The `toArrayReverse()` function returns an array of type `T[]`.
-     */
-    toArrayReverse() {
-        const array = [];
-        let current = this.tail;
+    };
+    DoublyLinkedList.prototype.toArrayReverse = function () {
+        var array = [];
+        var current = this.tail;
         while (current) {
             array.push(current.val);
             current = current.prev;
         }
         return array;
-    }
-    /**
-     * The `reverse` function reverses the order of the elements in a doubly linked list.
-     */
-    reverse() {
-        let current = this.head;
-        [this.head, this.tail] = [this.tail, this.head];
+    };
+    DoublyLinkedList.prototype.reverse = function () {
+        var _a, _b;
+        var current = this.head;
+        _a = __read([this.tail, this.head], 2), this.head = _a[0], this.tail = _a[1];
         while (current) {
-            const next = current.next;
-            [current.prev, current.next] = [current.next, current.prev];
+            var next = current.next;
+            _b = __read([current.next, current.prev], 2), current.prev = _b[0], current.next = _b[1];
             current = next;
         }
-    }
-    /**
-     * The `forEach` function iterates over each element in a linked list and applies a callback function to each element.
-     * @param callback - The callback parameter is a function that takes two arguments: val and index. The val argument
-     * represents the value of the current node in the linked list, and the index argument represents the index of the
-     * current node in the linked list.
-     */
-    forEach(callback) {
-        let current = this.head;
-        let index = 0;
+    };
+    DoublyLinkedList.prototype.forEach = function (callback) {
+        var current = this.head;
+        var index = 0;
         while (current) {
             callback(current.val, index);
             current = current.next;
             index++;
         }
-    }
-    /**
-     * The `map` function takes a callback function and applies it to each element in the DoublyLinkedList, returning a new
-     * DoublyLinkedList with the transformed values.
-     * @param callback - The callback parameter is a function that takes a value of type T (the type of values stored in
-     * the original DoublyLinkedList) and returns a value of type U (the type of values that will be stored in the mapped
-     * DoublyLinkedList).
-     * @returns The `map` function is returning a new instance of `DoublyLinkedList<U>` that contains the mapped values.
-     */
-    map(callback) {
-        const mappedList = new DoublyLinkedList();
-        let current = this.head;
+    };
+    DoublyLinkedList.prototype.map = function (callback) {
+        var mappedList = new DoublyLinkedList();
+        var current = this.head;
         while (current) {
             mappedList.push(callback(current.val));
             current = current.next;
         }
         return mappedList;
-    }
-    /**
-     * The `filter` function iterates through a DoublyLinkedList and returns a new DoublyLinkedList containing only the
-     * elements that satisfy the given callback function.
-     * @param callback - The `callback` parameter is a function that takes a value of type `T` and returns a boolean value.
-     * It is used to determine whether a value should be included in the filtered list or not.
-     * @returns The filtered list, which is an instance of the DoublyLinkedList class.
-     */
-    filter(callback) {
-        const filteredList = new DoublyLinkedList();
-        let current = this.head;
+    };
+    DoublyLinkedList.prototype.filter = function (callback) {
+        var filteredList = new DoublyLinkedList();
+        var current = this.head;
         while (current) {
             if (callback(current.val)) {
                 filteredList.push(current.val);
@@ -435,37 +357,18 @@ class DoublyLinkedList {
             current = current.next;
         }
         return filteredList;
-    }
-    /**
-     * The `reduce` function iterates over a linked list and applies a callback function to each element, accumulating a
-     * single value.
-     * @param callback - The `callback` parameter is a function that takes two arguments: `accumulator` and `val`. It is
-     * used to perform a specific operation on each element of the linked list.
-     * @param {U} initialValue - The `initialValue` parameter is the initial value of the accumulator. It is the starting
-     * point for the reduction operation.
-     * @returns The `reduce` method is returning the final value of the accumulator after iterating through all the
-     * elements in the linked list.
-     */
-    reduce(callback, initialValue) {
-        let accumulator = initialValue;
-        let current = this.head;
+    };
+    DoublyLinkedList.prototype.reduce = function (callback, initialValue) {
+        var accumulator = initialValue;
+        var current = this.head;
         while (current) {
             accumulator = callback(accumulator, current.val);
             current = current.next;
         }
         return accumulator;
-    }
-    /**
-     * The `insertAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
-     * @param {T | DoublyLinkedListNode<T>} existingValueOrNode - The existing value or node in the doubly linked list
-     * after which the new value will be inserted. It can be either the value of the existing node or the existing node
-     * itself.
-     * @param {T} newValue - The value that you want to insert into the doubly linked list.
-     * @returns The method returns a boolean value. It returns true if the insertion is successful, and false if the
-     * existing value or node is not found in the doubly linked list.
-     */
-    insertAfter(existingValueOrNode, newValue) {
-        let existingNode;
+    };
+    DoublyLinkedList.prototype.insertAfter = function (existingValueOrNode, newValue) {
+        var existingNode;
         if (existingValueOrNode instanceof DoublyLinkedListNode) {
             existingNode = existingValueOrNode;
         }
@@ -473,7 +376,7 @@ class DoublyLinkedList {
             existingNode = this.findNode(existingValueOrNode);
         }
         if (existingNode) {
-            const newNode = new DoublyLinkedListNode(newValue);
+            var newNode = new DoublyLinkedListNode(newValue);
             newNode.next = existingNode.next;
             if (existingNode.next) {
                 existingNode.next.prev = newNode;
@@ -487,19 +390,9 @@ class DoublyLinkedList {
             return true;
         }
         return false;
-    }
-    /**
-     * The `insertBefore` function inserts a new value before an existing value or node in a doubly linked list.
-     * @param {T | DoublyLinkedListNode<T>} existingValueOrNode - The existing value or node in the doubly linked list
-     * before which the new value will be inserted. It can be either the value of the existing node or the existing node
-     * itself.
-     * @param {T} newValue - The `newValue` parameter represents the value that you want to insert into the doubly linked
-     * list.
-     * @returns The method returns a boolean value. It returns `true` if the insertion is successful, and `false` if the
-     * insertion fails.
-     */
-    insertBefore(existingValueOrNode, newValue) {
-        let existingNode;
+    };
+    DoublyLinkedList.prototype.insertBefore = function (existingValueOrNode, newValue) {
+        var existingNode;
         if (existingValueOrNode instanceof DoublyLinkedListNode) {
             existingNode = existingValueOrNode;
         }
@@ -507,7 +400,7 @@ class DoublyLinkedList {
             existingNode = this.findNode(existingValueOrNode);
         }
         if (existingNode) {
-            const newNode = new DoublyLinkedListNode(newValue);
+            var newNode = new DoublyLinkedListNode(newValue);
             newNode.prev = existingNode.prev;
             if (existingNode.prev) {
                 existingNode.prev.next = newNode;
@@ -521,6 +414,8 @@ class DoublyLinkedList {
             return true;
         }
         return false;
-    }
-}
+    };
+    return DoublyLinkedList;
+}());
 exports.DoublyLinkedList = DoublyLinkedList;
+//# sourceMappingURL=doubly-linked-list.js.map