data-structure-typed 1.40.0-rc → 1.41.0

package/lib/data-structures/linked-list/singly-linked-list.d.ts

@@ -1,157 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export declare class SinglyLinkedListNode<E = any> {
-    /**
-     * The constructor function initializes an instance of a class with a given value and sets the next property to null.
-     * @param {E} val - The "val" parameter is of type E, which means it can be any data type. It represents the value that
-     * will be stored in the node of a linked list.
-     */
-    constructor(val: E);
-    private _val;
-    get val(): E;
-    set val(value: E);
-    private _next;
-    get next(): SinglyLinkedListNode<E> | null;
-    set next(value: SinglyLinkedListNode<E> | null);
-}
-export declare class SinglyLinkedList<E = any> {
-    /**
-     * The constructor initializes the linked list with an empty head, tail, and length.
-     */
-    constructor();
-    private _head;
-    get head(): SinglyLinkedListNode<E> | null;
-    set head(value: SinglyLinkedListNode<E> | null);
-    private _tail;
-    get tail(): SinglyLinkedListNode<E> | null;
-    set tail(value: SinglyLinkedListNode<E> | null);
-    private _length;
-    get length(): number;
-    /**
-     * The `fromArray` function creates a new SinglyLinkedList instance and populates it with the elements from the given
-     * array.
-     * @param {E[]} data - The `data` parameter is an array of elements of type `E`.
-     * @returns The `fromArray` function returns a `SinglyLinkedList` object.
-     */
-    static fromArray<E>(data: E[]): SinglyLinkedList<E>;
-    getLength(): number;
-    /**
-     * The `push` function adds a new node with the given data to the end of a singly linked list.
-     * @param {E} data - The "data" parameter represents the value that you want to add to the linked list. It can be of
-     * any type (E) as specified in the generic type declaration of the class or function.
-     */
-    push(data: E): void;
-    /**
-     * The `pop()` function removes and returns the value of the last element in a linked list, updating the head and tail
-     * pointers accordingly.
-     * @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(): E | 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(): E | undefined;
-    /**
-     * The unshift function adds a new node with the given value to the beginning of a singly linked list.
-     * @param {E} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
-     * linked list.
-     */
-    unshift(val: E): void;
-    /**
-     * The function `getAt` returns the value at a specified index in a 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 element we want to
-     * retrieve from the list.
-     * @returns The method `getAt(index: number): E | null` returns the value at the specified index in the linked list, or
-     * `null` if the index is out of bounds.
-     */
-    getAt(index: number): E | 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
-     * retrieve from the linked list. It indicates the zero-based index of the node we want to access.
-     * @returns The method `getNodeAt(index: number)` returns a `SinglyLinkedListNode<E>` object if the node at the
-     * specified index exists, or `null` if the index is out of bounds.
-     */
-    getNodeAt(index: number): SinglyLinkedListNode<E> | null;
-    /**
-     * 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: number): E | undefined;
-    delete(valueOrNode: E): boolean;
-    delete(valueOrNode: SinglyLinkedListNode<E>): boolean;
-    /**
-     * The `insertAt` function inserts a value at a specified index in a singly linked list.
-     * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
-     * linked list. It is of type number.
-     * @param {E} val - The `val` parameter represents the value that you want to insert into the 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: number, val: E): boolean;
-    /**
-     * The function checks if the length of a data structure is equal to zero and returns a boolean value indicating
-     * whether it is empty or not.
-     * @returns A boolean value indicating whether the length of the object is equal to 0.
-     */
-    isEmpty(): boolean;
-    /**
-     * The `clear` function resets the linked list by setting the head, tail, and length to null and 0 respectively.
-     */
-    clear(): void;
-    /**
-     * The `toArray` function converts a linked list into an array.
-     * @returns The `toArray()` method is returning an array of type `E[]`.
-     */
-    toArray(): E[];
-    /**
-     * The `reverse` function reverses the order of the nodes in a singly linked list.
-     * @returns The reverse() method does not return anything. It has a return type of void.
-     */
-    reverse(): void;
-    /**
-     * 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 E 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: (val: E) => boolean): E | null;
-    /**
-     * The `indexOf` function returns the index of the first occurrence of a given value in a linked list.
-     * @param {E} value - The value parameter is the value that you want to find the index of in the linked list.
-     * @returns The method is returning the index of the first occurrence of the specified value in the linked list. If the
-     * value is not found, it returns -1.
-     */
-    indexOf(value: E): number;
-    /**
-     * The function finds a node in a singly linked list by its value and returns the node if found, otherwise returns
-     * null.
-     * @param {E} value - The value parameter is the value that we want to search for in the linked list.
-     * @returns a `SinglyLinkedListNode<E>` if a node with the specified value is found in the linked list. If no node with
-     * the specified value is found, the function returns `null`.
-     */
-    findNode(value: E): SinglyLinkedListNode<E> | null;
-    insertBefore(existingValue: E, newValue: E): boolean;
-    insertBefore(existingValue: SinglyLinkedListNode<E>, newValue: E): boolean;
-    insertAfter(existingValueOrNode: E, newValue: E): boolean;
-    insertAfter(existingValueOrNode: SinglyLinkedListNode<E>, newValue: E): boolean;
-    /**
-     * The function counts the number of occurrences of a given value in a linked list.
-     * @param {E} value - The value parameter is the value that you want to count the occurrences of in the linked list.
-     * @returns The count of occurrences of the given value in the linked list.
-     */
-    countOccurrences(value: E): number;
-    [Symbol.iterator](): Generator<E, void, unknown>;
-}

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

@@ -1,443 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export class SinglyLinkedListNode {
-    /**
-     * The constructor function initializes an instance of a class with a given value and sets the next property to null.
-     * @param {E} val - The "val" parameter is of type E, which means it can be any data type. It represents the value that
-     * will be stored in the node of a linked list.
-     */
-    constructor(val) {
-        this._val = val;
-        this._next = null;
-    }
-    get val() {
-        return this._val;
-    }
-    set val(value) {
-        this._val = value;
-    }
-    get next() {
-        return this._next;
-    }
-    set next(value) {
-        this._next = value;
-    }
-}
-export class SinglyLinkedList {
-    /**
-     * 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 SinglyLinkedList instance and populates it with the elements from the given
-     * array.
-     * @param {E[]} data - The `data` parameter is an array of elements of type `E`.
-     * @returns The `fromArray` function returns a `SinglyLinkedList` object.
-     */
-    static fromArray(data) {
-        const singlyLinkedList = new SinglyLinkedList();
-        for (const item of data) {
-            singlyLinkedList.push(item);
-        }
-        return singlyLinkedList;
-    }
-    getLength() {
-        return this._length;
-    }
-    /**
-     * The `push` function adds a new node with the given data to the end of a singly linked list.
-     * @param {E} data - The "data" parameter represents the value that you want to add to the linked list. It can be of
-     * any type (E) as specified in the generic type declaration of the class or function.
-     */
-    push(data) {
-        const newNode = new SinglyLinkedListNode(data);
-        if (!this.head) {
-            this.head = newNode;
-            this.tail = newNode;
-        }
-        else {
-            this.tail.next = newNode;
-            this.tail = newNode;
-        }
-        this._length++;
-    }
-    /**
-     * The `pop()` function removes and returns the value of the last element in a linked list, updating the head and tail
-     * pointers accordingly.
-     * @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() {
-        if (!this.head)
-            return undefined;
-        if (this.head === this.tail) {
-            const val = this.head.val;
-            this.head = null;
-            this.tail = null;
-            this._length--;
-            return val;
-        }
-        let current = this.head;
-        while (current.next !== this.tail) {
-            current = current.next;
-        }
-        const val = this.tail.val;
-        current.next = null;
-        this.tail = current;
-        this._length--;
-        return val;
-    }
-    /**
-     * 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() {
-        if (!this.head)
-            return undefined;
-        const removedNode = this.head;
-        this.head = this.head.next;
-        this._length--;
-        return removedNode.val;
-    }
-    /**
-     * The unshift function adds a new node with the given value to the beginning of a singly linked list.
-     * @param {E} val - The parameter "val" represents the value of the new node that will be added to the beginning of the
-     * linked list.
-     */
-    unshift(val) {
-        const newNode = new SinglyLinkedListNode(val);
-        if (!this.head) {
-            this.head = newNode;
-            this.tail = newNode;
-        }
-        else {
-            newNode.next = this.head;
-            this.head = newNode;
-        }
-        this._length++;
-    }
-    /**
-     * The function `getAt` returns the value at a specified index in a 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 element we want to
-     * retrieve from the list.
-     * @returns The method `getAt(index: number): E | null` returns the value at the specified index in the linked list, or
-     * `null` if the index is out of bounds.
-     */
-    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 singly linked list.
-     * @param {number} index - The `index` parameter is a number that represents the position of the node we want to
-     * retrieve from the linked list. It indicates the zero-based index of the node we want to access.
-     * @returns The method `getNodeAt(index: number)` returns a `SinglyLinkedListNode<E>` object if the node at the
-     * specified index exists, or `null` if the index is out of bounds.
-     */
-    getNodeAt(index) {
-        let current = this.head;
-        for (let i = 0; i < index; i++) {
-            current = current.next;
-        }
-        return current;
-    }
-    /**
-     * 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 prevNode = this.getNodeAt(index - 1);
-        const removedNode = prevNode.next;
-        prevNode.next = removedNode.next;
-        this._length--;
-        return removedNode.val;
-    }
-    /**
-     * The delete function removes a node with a specific value from a singly linked list.
-     * @param {E | SinglyLinkedListNode<E>} valueOrNode - The `valueOrNode` parameter can accept either a value of type `E`
-     * or a `SinglyLinkedListNode<E>` object.
-     * @returns The `delete` method returns a boolean value. It returns `true` if the value or node is found and
-     * successfully deleted from the linked list, and `false` if the value or node is not found in the linked list.
-     */
-    delete(valueOrNode) {
-        let value;
-        if (valueOrNode instanceof SinglyLinkedListNode) {
-            value = valueOrNode.val;
-        }
-        else {
-            value = valueOrNode;
-        }
-        let current = this.head, prev = null;
-        while (current) {
-            if (current.val === value) {
-                if (prev === null) {
-                    this.head = current.next;
-                    if (current === this.tail) {
-                        this.tail = null;
-                    }
-                }
-                else {
-                    prev.next = current.next;
-                    if (current === this.tail) {
-                        this.tail = prev;
-                    }
-                }
-                this._length--;
-                return true;
-            }
-            prev = current;
-            current = current.next;
-        }
-        return false;
-    }
-    /**
-     * The `insertAt` function inserts a value at a specified index in a singly linked list.
-     * @param {number} index - The index parameter represents the position at which the new value should be inserted in the
-     * linked list. It is of type number.
-     * @param {E} val - The `val` parameter represents the value that you want to insert into the 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 SinglyLinkedListNode(val);
-        const prevNode = this.getNodeAt(index - 1);
-        newNode.next = prevNode.next;
-        prevNode.next = newNode;
-        this._length++;
-        return true;
-    }
-    /**
-     * The function checks if the length of a data structure is equal to zero and returns a boolean value indicating
-     * whether it is empty or not.
-     * @returns A boolean value indicating whether the length of the object is equal to 0.
-     */
-    isEmpty() {
-        return this.length === 0;
-    }
-    /**
-     * 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 `toArray` function converts a linked list into an array.
-     * @returns The `toArray()` method is returning an array of type `E[]`.
-     */
-    toArray() {
-        const array = [];
-        let current = this.head;
-        while (current) {
-            array.push(current.val);
-            current = current.next;
-        }
-        return array;
-    }
-    /**
-     * The `reverse` function reverses the order of the nodes in a singly linked list.
-     * @returns The reverse() method does not return anything. It has a return type of void.
-     */
-    reverse() {
-        if (!this.head || this.head === this.tail)
-            return;
-        let prev = null;
-        let current = this.head;
-        let next = null;
-        while (current) {
-            next = current.next;
-            current.next = prev;
-            prev = current;
-            current = next;
-        }
-        [this.head, this.tail] = [this.tail, this.head];
-    }
-    /**
-     * 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 E 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 `indexOf` function returns the index of the first occurrence of a given value in a linked list.
-     * @param {E} value - The value parameter is the value that you want to find the index of in the linked list.
-     * @returns The method is returning the index of the first occurrence of the specified value in the linked list. If the
-     * value is not found, it returns -1.
-     */
-    indexOf(value) {
-        let index = 0;
-        let current = this.head;
-        while (current) {
-            if (current.val === value) {
-                return index;
-            }
-            index++;
-            current = current.next;
-        }
-        return -1;
-    }
-    /**
-     * The function finds a node in a singly linked list by its value and returns the node if found, otherwise returns
-     * null.
-     * @param {E} value - The value parameter is the value that we want to search for in the linked list.
-     * @returns a `SinglyLinkedListNode<E>` if a node with the specified value is found in the linked list. If no node with
-     * the specified value is found, the function returns `null`.
-     */
-    findNode(value) {
-        let current = this.head;
-        while (current) {
-            if (current.val === value) {
-                return current;
-            }
-            current = current.next;
-        }
-        return null;
-    }
-    /**
-     * The `insertBefore` function inserts a new value before an existing value in a singly linked list.
-     * @param {E | SinglyLinkedListNode<E>} existingValueOrNode - The existing value or node that you want to insert the
-     * new value before. It can be either the value itself or a node containing the value in the linked list.
-     * @param {E} newValue - The `newValue` parameter represents the value that you want to insert into the linked list.
-     * @returns The method `insertBefore` returns a boolean value. It returns `true` if the new value was successfully
-     * inserted before the existing value, and `false` otherwise.
-     */
-    insertBefore(existingValueOrNode, newValue) {
-        if (!this.head)
-            return false;
-        let existingValue;
-        if (existingValueOrNode instanceof SinglyLinkedListNode) {
-            existingValue = existingValueOrNode.val;
-        }
-        else {
-            existingValue = existingValueOrNode;
-        }
-        if (this.head.val === existingValue) {
-            this.unshift(newValue);
-            return true;
-        }
-        let current = this.head;
-        while (current.next) {
-            if (current.next.val === existingValue) {
-                const newNode = new SinglyLinkedListNode(newValue);
-                newNode.next = current.next;
-                current.next = newNode;
-                this._length++;
-                return true;
-            }
-            current = current.next;
-        }
-        return false;
-    }
-    /**
-     * The `insertAfter` function inserts a new node with a given value after an existing node in a singly linked list.
-     * @param {E | SinglyLinkedListNode<E>} existingValueOrNode - The existing value or node in the 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 {E} newValue - The value that you want to insert into the linked list after the existing value or node.
-     * @returns The method returns a boolean value. It returns true if the new value was successfully inserted after the
-     * existing value or node, and false if the existing value or node was not found in the linked list.
-     */
-    insertAfter(existingValueOrNode, newValue) {
-        let existingNode;
-        if (existingValueOrNode instanceof SinglyLinkedListNode) {
-            existingNode = existingValueOrNode;
-        }
-        else {
-            existingNode = this.findNode(existingValueOrNode);
-        }
-        if (existingNode) {
-            const newNode = new SinglyLinkedListNode(newValue);
-            newNode.next = existingNode.next;
-            existingNode.next = newNode;
-            if (existingNode === this.tail) {
-                this.tail = newNode;
-            }
-            this._length++;
-            return true;
-        }
-        return false;
-    }
-    /**
-     * The function counts the number of occurrences of a given value in a linked list.
-     * @param {E} value - The value parameter is the value that you want to count the occurrences of in the linked list.
-     * @returns The count of occurrences of the given value in the linked list.
-     */
-    countOccurrences(value) {
-        let count = 0;
-        let current = this.head;
-        while (current) {
-            if (current.val === value) {
-                count++;
-            }
-            current = current.next;
-        }
-        return count;
-    }
-    *[Symbol.iterator]() {
-        let current = this.head;
-        while (current) {
-            yield current.val;
-            current = current.next;
-        }
-    }
-}

package/lib/data-structures/linked-list/skip-linked-list.d.ts

@@ -1,61 +0,0 @@
-/**
- * data-structure-typed
- *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
- * @license MIT License
- */
-export declare class SkipListNode<K, V> {
-    key: K;
-    value: V;
-    forward: SkipListNode<K, V>[];
-    constructor(key: K, value: V, level: number);
-}
-export declare class SkipList<K, V> {
-    get probability(): number;
-    set probability(value: number);
-    get maxLevel(): number;
-    set maxLevel(value: number);
-    get level(): number;
-    set level(value: number);
-    get head(): SkipListNode<K, V>;
-    set head(value: SkipListNode<K, V>);
-    private _head;
-    private _level;
-    private _maxLevel;
-    private _probability;
-    /**
-     * The constructor initializes a SkipList with a specified maximum level and probability.
-     * @param [maxLevel=16] - The `maxLevel` parameter represents the maximum level that a skip list can have. It determines
-     * the maximum number of levels that can be created in the skip list.
-     * @param [probability=0.5] - The probability parameter represents the probability of a node being promoted to a higher
-     * level in the skip list. It is used to determine the height of each node in the skip list.
-     */
-    constructor(maxLevel?: number, probability?: number);
-    /**
-     * The function "randomLevel" generates a random level based on a given probability and maximum level.
-     * @returns the level, which is a number.
-     */
-    private randomLevel;
-    /**
-     * The add function adds a new node with a given key and value to a Skip List data structure.
-     * @param {K} key - The key parameter represents the key of the node that needs to be added to the skip list.
-     * @param {V} value - The "value" parameter represents the value associated with the key that is being added to the Skip
-     * List.
-     */
-    add(key: K, value: V): void;
-    /**
-     * The function `get` retrieves the value associated with a given key from a skip list data structure.
-     * @param {K} key - The `key` parameter is the key of the element that we want to retrieve from the data structure.
-     * @returns The method `get(key: K)` returns the value associated with the given key if it exists in the data structure,
-     * otherwise it returns `undefined`.
-     */
-    get(key: K): V | undefined;
-    /**
-     * The `remove` function removes a node with a specific key from a Skip List data structure.
-     * @param {K} key - The key parameter represents the key of the node that needs to be removed from the skip list.
-     * @returns The `remove` method returns a boolean value. It returns `true` if the key was successfully removed from the
-     * skip list, and `false` if the key was not found in the skip list.
-     */
-    remove(key: K): boolean;
-}