data-structure-typed 1.21.4 → 1.32.0

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

@@ -0,0 +1,521 @@
+/**
+ * data-structure-typed
+ *
+ * @author Tyler Zeng
+ * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @license MIT License
+ */
+export 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) {
+        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;
+    }
+}
+export class DoublyLinkedList {
+    /**
+     * The constructor initializes the linked list with an empty head, tail, and length.
+     */
+    constructor() {
+        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);
+        }
+        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);
+        if (!this.head) {
+            this.head = newNode;
+            this.tail = newNode;
+        }
+        else {
+            newNode.prev = this.tail;
+            this.tail.next = newNode;
+            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() {
+        if (!this.tail)
+            return undefined;
+        const removedNode = this.tail;
+        if (this.head === this.tail) {
+            this.head = null;
+            this.tail = null;
+        }
+        else {
+            this.tail = removedNode.prev;
+            this.tail.next = null;
+        }
+        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() {
+        if (!this.head)
+            return undefined;
+        const removedNode = this.head;
+        if (this.head === this.tail) {
+            this.head = null;
+            this.tail = null;
+        }
+        else {
+            this.head = removedNode.next;
+            this.head.prev = null;
+        }
+        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);
+        if (!this.head) {
+            this.head = newNode;
+            this.tail = newNode;
+        }
+        else {
+            newNode.next = this.head;
+            this.head.prev = newNode;
+            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) {
+        if (index < 0 || index >= this.length)
+            return undefined;
+        let current = this.head;
+        for (let 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) {
+        if (index < 0 || index >= this.length)
+            return null;
+        let current = this.head;
+        for (let 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;
+        while (current) {
+            if (current.val === val) {
+                return current;
+            }
+            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) {
+        if (index < 0 || index > this.length)
+            return false;
+        if (index === 0) {
+            this.unshift(val);
+            return true;
+        }
+        if (index === this.length) {
+            this.push(val);
+            return true;
+        }
+        const newNode = new DoublyLinkedListNode(val);
+        const prevNode = this.getNodeAt(index - 1);
+        const 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) {
+        if (index < 0 || index >= this.length)
+            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;
+        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;
+        if (valOrNode instanceof DoublyLinkedListNode) {
+            node = valOrNode;
+        }
+        else {
+            node = this.findNode(valOrNode);
+        }
+        if (node) {
+            if (node === this.head) {
+                this.shift();
+            }
+            else if (node === this.tail) {
+                this.pop();
+            }
+            else {
+                const prevNode = node.prev;
+                const nextNode = node.next;
+                prevNode.next = nextNode;
+                nextNode.prev = prevNode;
+                this._length--;
+            }
+            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;
+        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() {
+        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;
+        while (current) {
+            if (callback(current.val)) {
+                return current.val;
+            }
+            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;
+        while (current) {
+            if (current.val === val) {
+                return index;
+            }
+            index++;
+            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;
+        while (current) {
+            if (callback(current.val)) {
+                return current.val;
+            }
+            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;
+        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];
+        while (current) {
+            const next = current.next;
+            [current.prev, current.next] = [current.next, current.prev];
+            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;
+        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;
+        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;
+        while (current) {
+            if (callback(current.val)) {
+                filteredList.push(current.val);
+            }
+            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;
+        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;
+        if (existingValueOrNode instanceof DoublyLinkedListNode) {
+            existingNode = existingValueOrNode;
+        }
+        else {
+            existingNode = this.findNode(existingValueOrNode);
+        }
+        if (existingNode) {
+            const newNode = new DoublyLinkedListNode(newValue);
+            newNode.next = existingNode.next;
+            if (existingNode.next) {
+                existingNode.next.prev = newNode;
+            }
+            newNode.prev = existingNode;
+            existingNode.next = newNode;
+            if (existingNode === this.tail) {
+                this.tail = newNode;
+            }
+            this._length++;
+            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;
+        if (existingValueOrNode instanceof DoublyLinkedListNode) {
+            existingNode = existingValueOrNode;
+        }
+        else {
+            existingNode = this.findNode(existingValueOrNode);
+        }
+        if (existingNode) {
+            const newNode = new DoublyLinkedListNode(newValue);
+            newNode.prev = existingNode.prev;
+            if (existingNode.prev) {
+                existingNode.prev.next = newNode;
+            }
+            newNode.next = existingNode;
+            existingNode.prev = newNode;
+            if (existingNode === this.head) {
+                this.head = newNode;
+            }
+            this._length++;
+            return true;
+        }
+        return false;
+    }
+}

package/lib/data-structures/linked-list/index.js

@@ -0,0 +1,3 @@
+export * from './singly-linked-list';
+export * from './doubly-linked-list';
+export * from './skip-linked-list';

package/{dist → lib}/data-structures/linked-list/singly-linked-list.d.ts

@@ -19,7 +19,7 @@ export declare class SinglyLinkedListNode<T = number> {
     get next(): SinglyLinkedListNode<T> | null;
     set next(value: SinglyLinkedListNode<T> | null);
 }
-export declare class SinglyLinkedList<T = number> {
+export declare class SinglyLinkedList<T = any> {
     /**
      * The constructor initializes the linked list with an empty head, tail, and length.
      */
@@ -52,12 +52,12 @@ export declare class SinglyLinkedList<T = number> {
      * @returns The method `pop()` returns the value of the node that is being removed from the end of the linked list. If
      * the linked list is empty, it returns `null`.
      */
-    pop(): T | null;
+    pop(): T | undefined;
     /**
      * The `shift()` function removes and returns the value of the first node in a linked list.
      * @returns The value of the node that is being removed from the beginning of the linked list.
      */
-    shift(): T | null;
+    shift(): T | undefined;
     /**
      * The unshift function adds a new node with the given value to the beginning of a singly linked list.
      * @param {T} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
@@ -71,7 +71,7 @@ export declare class SinglyLinkedList<T = number> {
      * @returns The method `getAt(index: number): T | null` returns the value at the specified index in the linked list, or
      * `null` if the index is out of bounds.
      */
-    getAt(index: number): T | null;
+    getAt(index: number): T | undefined;
     /**
      * The function `getNodeAt` returns the node at a given index in a singly linked list.
      * @param {number} index - The `index` parameter is a number that represents the position of the node we want to
@@ -87,7 +87,7 @@ export declare class SinglyLinkedList<T = 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: number): T | null;
+    deleteAt(index: number): T | undefined;
     delete(valueOrNode: T): boolean;
     delete(valueOrNode: SinglyLinkedListNode<T>): boolean;
     /**
@@ -153,4 +153,5 @@ export declare class SinglyLinkedList<T = number> {
      * @returns The count of occurrences of the given value in the linked list.
      */
     countOccurrences(value: T): number;
+    [Symbol.iterator](): Generator<T, void, unknown>;
 }