data-structure-typed 1.15.2 → 1.17.0

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

@@ -5,290 +5,175 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-export declare class SinglyLinkedListNode<NodeVal = any> {
-    constructor(val: NodeVal, prev?: SinglyLinkedListNode<NodeVal> | null, next?: SinglyLinkedListNode<NodeVal> | null, list?: SinglyLinkedList<NodeVal> | null);
-    protected _val: NodeVal;
-    get val(): NodeVal;
-    set val(value: NodeVal);
-    protected _prev: SinglyLinkedListNode<NodeVal> | null;
-    get prev(): SinglyLinkedListNode<NodeVal> | null;
-    set prev(value: SinglyLinkedListNode<NodeVal> | null);
-    protected _next: SinglyLinkedListNode<NodeVal> | null;
-    get next(): SinglyLinkedListNode<NodeVal> | null;
-    set next(value: SinglyLinkedListNode<NodeVal> | null);
-    protected _list: SinglyLinkedList<NodeVal> | null;
-    get list(): SinglyLinkedList<NodeVal> | null;
-    set list(value: SinglyLinkedList<NodeVal> | null);
-    get index(): number | undefined;
-    /**
-     * The `insertBefore` function inserts a new node with the given value before the current node in a singly linked list.
-     * @param {NodeVal} val - The parameter "val" is of type "NodeVal". It represents the value of the node that you want
-     * to insert before the current node.
-     * @returns The method is returning a SinglyLinkedList<NodeVal>.
-     */
-    insertBefore(val: NodeVal): SinglyLinkedList<NodeVal>;
-    /**
-     * The function inserts a new node with the given value after the current node in a singly linked list.
-     * @param {NodeVal} val - The parameter `val` is the value of the node that you want to insert after the current node.
-     * @returns The method is returning a SinglyLinkedList<NodeVal>.
-     */
-    insertAfter(val: NodeVal): SinglyLinkedList<NodeVal>;
-    /**
-     * The `remove()` function removes a node from a singly linked list.
-     * @returns The remove() method is returning a SinglyLinkedListNode<NodeVal> object.
-     */
-    remove(): SinglyLinkedListNode<NodeVal>;
+export declare class SinglyLinkedListNode<T = number> {
+    /**
+     * The constructor function initializes an instance of a class with a given value and sets the next property to null.
+     * @param {T} val - The "val" parameter is of type T, 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: T);
+    private _val;
+    get val(): T;
+    set val(value: T);
+    private _next;
+    get next(): SinglyLinkedListNode<T> | null;
+    set next(value: SinglyLinkedListNode<T> | null);
 }
-export declare class SinglyLinkedList<NodeVal = any> {
-    /**
-     * The constructor initializes a linked list with the given arguments as nodes.
-     * @param {NodeVal[]} args - args is a rest parameter that allows the constructor to accept an arbitrary number of
-     * arguments of type NodeVal.
-     */
-    constructor(...args: NodeVal[]);
-    protected _head: SinglyLinkedListNode<NodeVal> | null;
-    get head(): SinglyLinkedListNode<NodeVal> | null;
-    set head(value: SinglyLinkedListNode<NodeVal> | null);
-    protected _tail: SinglyLinkedListNode<NodeVal> | null;
-    get tail(): SinglyLinkedListNode<NodeVal> | null;
-    set tail(value: SinglyLinkedListNode<NodeVal> | null);
-    protected _size: number;
-    get size(): number;
-    set size(value: number);
-    /**
-     * The `from` function in TypeScript creates a new SinglyLinkedList instance from an iterable object.
-     * @param iterable - The `iterable` parameter is an object that can be iterated over, such as an array or a string. It
-     * contains a collection of elements of type `T`.
-     * @returns The method is returning a new instance of the SinglyLinkedList class.
-     */
-    static from<T>(iterable: Iterable<T>): SinglyLinkedList<T>;
-    /**
-     * The `get` function returns the value of a node at a given index in a data structure.
-     * @param {number} index - The index parameter is a number that represents the position of the node in the data
-     * structure.
-     * @returns The method is returning the value of the node at the specified index if the node exists, otherwise it
-     * returns undefined.
-     */
-    get(index: number): NodeVal | undefined;
-    /**
-     * The function `getNode` 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.
-     * @returns a SinglyLinkedListNode<NodeVal> object or undefined.
-     */
-    getNode(index: number): SinglyLinkedListNode<NodeVal> | undefined;
+export declare class SinglyLinkedList<T> {
     /**
-     * The function `findNodeIndex` searches for a node in a singly linked list that satisfies a given condition and
-     * returns its index and the node itself.
-     * @param callbackFn - The callbackFn parameter is a function that takes three arguments: data, index, and list. It is
-     * used to determine whether a node in the singly linked list matches a certain condition. The function should return a
-     * boolean value indicating whether the condition is met for the given node.
-     * @returns The function `findNodeIndex` returns an object with two properties: `node` and `index`. The `node` property
-     * contains the node that matches the condition specified in the `callbackFn` function, and the `index` property
-     * contains the index of that node in the linked list. If no node matches the condition, the function returns
-     * `undefined`.
+     * The constructor initializes the linked list with an empty head, tail, and length.
      */
-    findNodeIndex(callbackFn: (data: NodeVal, index: number, list: SinglyLinkedList<NodeVal>) => boolean): ({
-        node: SinglyLinkedListNode<NodeVal>;
-        index: number;
-    }) | undefined;
+    constructor();
+    private _head;
+    get head(): SinglyLinkedListNode<T> | null;
+    set head(value: SinglyLinkedListNode<T> | null);
+    private _tail;
+    get tail(): SinglyLinkedListNode<T> | null;
+    set tail(value: SinglyLinkedListNode<T> | null);
+    private _length;
+    get length(): number;
+    protected set length(value: number);
     /**
-     * The findNode function searches for a node in a singly linked list based on a given callback function.
-     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It returns a boolean
-     * value indicating whether the current node matches the desired criteria.
-     * @returns The function `findNode` returns a `SinglyLinkedListNode<NodeVal>` if a node satisfying the condition
-     * specified by the `callbackFn` is found in the linked list. If no such node is found, it returns `undefined`.
+     * The `fromArray` function creates a new SinglyLinkedList instance 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 `SinglyLinkedList` object.
      */
-    findNode(callbackFn: (data: NodeVal, index: number, list: SinglyLinkedList<NodeVal>) => boolean): SinglyLinkedListNode<NodeVal> | undefined;
+    static fromArray<T>(data: T[]): SinglyLinkedList<T>;
+    getLength(): number;
     /**
-     * The `find` function in TypeScript searches for a node in a singly linked list based on a given callback function and
-     * returns the value of the found node.
-     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It returns a boolean
-     * value indicating whether the condition is met for a particular node in the linked list.
-     * @returns The method `find` returns the `NodeVal` value of the first node in the linked list that satisfies the
-     * condition specified by the `callbackFn` function. If no node satisfies the condition, it returns `undefined`.
+     * The `push` function adds a new node with the given data to the end of a singly linked list.
+     * @param {T} data - The "data" parameter represents the value that you want to add to the linked list. It can be of
+     * any type (T) as specified in the generic type declaration of the class or function.
      */
-    find(callbackFn: (data: NodeVal, index: number, list: SinglyLinkedList<NodeVal>) => boolean): NodeVal | undefined;
+    push(data: T): void;
     /**
-     * The findIndex function returns the index of the first node in a singly linked list that satisfies a given condition,
-     * or -1 if no such node is found.
-     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It returns a boolean
-     * value indicating whether the condition is met for a particular node in the singly linked list.
-     * @returns The method `findIndex` returns a number.
+     * 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`.
      */
-    findIndex(callbackFn: (data: NodeVal, index: number, list: SinglyLinkedList<NodeVal>) => boolean): number;
-    append(...args: NodeVal[]): SinglyLinkedList<NodeVal>;
+    pop(): T | null;
     /**
-     * The push function appends multiple NodeVal objects to a data structure and returns the new size of the data
-     * structure.
-     * @param {NodeVal[]} args - args is a rest parameter of type NodeVal[]. It allows the function to accept any number
-     * of arguments of type NodeVal.
-     * @returns The size of the data structure after the nodes are appended.
+     * 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.
      */
-    push(...args: NodeVal[]): number;
+    shift(): T | null;
     /**
-     * The `prepend` function adds new nodes to the beginning of a singly linked list.
-     * @param {NodeVal[]} args - An array of NodeVal objects.
-     * @returns The `prepend` method is returning the updated `SinglyLinkedList` object.
-     */
-    prepend(...args: NodeVal[]): SinglyLinkedList<NodeVal>;
-    /**
-     * The `insertAt` function inserts a value at a specified index in a singly linked list.
-     * @param {number} index - The index parameter is a number that represents the position at which the new node should be
-     * inserted in the linked list.
-     * @param {NodeVal} val - The `val` parameter represents the value of the node that you want to insert into the linked
-     * list.
-     * @returns The method `insertAt` returns the updated `SinglyLinkedList` object.
-     */
-    insertAt(index: number, val: NodeVal): SinglyLinkedList<NodeVal>;
-    /**
-     * The removeNode function removes a node from a singly linked list and updates the head, tail, and size properties
-     * accordingly.
-     * @param node - The `node` parameter is of type `SinglyLinkedListNode<NodeVal>`, which represents a node in a singly
+     * 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
      * linked list.
-     * @returns the removed node.
      */
-    removeNode(node: SinglyLinkedListNode<NodeVal>): SinglyLinkedListNode<NodeVal>;
+    unshift(val: T): void;
     /**
-     * The `removeAt` function removes a node at a specified index from a singly linked list.
-     * @param {number} index - The index parameter is a number that represents the position of the node to be removed in
-     * the singly linked list.
-     * @returns The method `removeAt` returns a `SinglyLinkedListNode<NodeVal>` if the node at the specified index is
-     * found and removed successfully. If the node is not found, it returns `undefined`.
+     * 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): T | null` returns the value at the specified index in the linked list, or
+     * `null` if the index is out of bounds.
      */
-    removeAt(index: number): SinglyLinkedListNode<NodeVal> | undefined;
+    getAt(index: number): T | null;
     /**
-     * The `insertBefore` function inserts a new node with a given value before a specified reference node in a singly
-     * linked list.
-     * @param referenceNode - The referenceNode parameter is the node in the linked list before which the new node will be
-     * inserted.
-     * @param {NodeVal} val - The value of the new node that will be inserted before the reference node.
-     * @returns The method is returning the updated SinglyLinkedList object.
+     * 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<T>` object if the node at the
+     * specified index exists, or `null` if the index is out of bounds.
      */
-    insertBefore(referenceNode: SinglyLinkedListNode<NodeVal>, val: NodeVal): SinglyLinkedList<NodeVal>;
+    getNodeAt(index: number): SinglyLinkedListNode<T> | null;
     /**
-     * The `sort` function uses the quicksort algorithm to sort the elements of a singly linked list based on a provided
-     * comparison function.
-     * @param start - The `start` parameter is the starting node of the sublist that needs to be sorted.
-     * @param end - The `end` parameter is a reference to the last node in the linked list. It is used as the pivot element
-     * for the quicksort algorithm.
-     * @returns The `sort` method is returning the sorted `SinglyLinkedList` object.
+     * 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.
      */
-    sort(compare: (a: NodeVal, b: NodeVal) => boolean): SinglyLinkedList<NodeVal>;
+    deleteAt(index: number): T | null;
     /**
-     * The `insertAfter` function inserts a new node with a given value after a specified reference node in a singly linked
+     * The `delete` function removes a specified value from a linked list and returns true if the value was found and
+     * removed, otherwise it returns false.
+     * @param {T} value - The value parameter represents the value of the node that needs to be deleted from the linked
      * list.
-     * @param referenceNode - The referenceNode parameter is the node after which the new node will be inserted.
-     * @param {NodeVal} val - The value of the new node that will be inserted after the reference node.
-     * @returns The `insertAfter` method is returning the updated `SinglyLinkedList` object.
+     * @returns The `delete` method returns a boolean value. It returns `true` if the value was successfully deleted from
+     * the linked list, and `false` if the value was not found in the linked list.
      */
-    insertAfter(referenceNode: SinglyLinkedListNode<NodeVal>, val: NodeVal): SinglyLinkedList<NodeVal>;
+    delete(value: T): boolean;
     /**
-     * The `shift()` function removes and returns the first element from a linked list.
-     * @returns The `shift()` method is returning a value of type `NodeVal` or `undefined`.
+     * The `insert` 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 {T} 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.
      */
-    shift(): NodeVal | undefined;
+    insert(index: number, val: T): boolean;
     /**
-     * The `pop()` function removes and returns the last element from a linked list.
-     * @returns The `pop()` method is returning a value of type `NodeVal` or `undefined`.
-     */
-    pop(): NodeVal | undefined;
-    /**
-     * The merge function merges two singly linked lists by updating the next and prev pointers, as well as the head, tail,
-     * and size properties.
-     * @param list - The parameter "list" is a SinglyLinkedList object that contains nodes with data of type NodeVal.
-     */
-    merge(list: SinglyLinkedList<NodeVal>): void;
-    /**
-     * The clear() function resets the linked list by setting the head and tail to null and the size to 0.
-     * @returns The "this" object is being returned.
-     */
-    clear(): this;
-    /**
-     * The `slice` function returns a new SinglyLinkedList containing a portion of the original list, starting from the
-     * specified index and ending at the optional end index.
-     * @param {number} start - The `start` parameter is a number that represents the index at which to start slicing the
-     * linked list.
-     * @param {number} [end] - The `end` parameter is an optional number that specifies the index at which to end the
-     * slicing. If no value is provided for `end`, or if the provided value is less than the `start` index, the slicing
-     * will continue until the end of the list.
-     * @returns a new SinglyLinkedList containing the sliced elements from the original list.
+     * 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.
      */
-    slice(start: number, end?: number): SinglyLinkedList<NodeVal | {}>;
+    isEmpty(): boolean;
     /**
-     * The reverse() function reverses the order of nodes in a singly linked list.
-     * @returns The reverse() method is returning the reversed SinglyLinkedList.
+     * The `clear` function resets the linked list by setting the head, tail, and length to null and 0 respectively.
      */
-    reverse(): SinglyLinkedList<NodeVal>;
+    clear(): void;
     /**
-     * The `forEach` function iterates over a singly linked list and applies a callback function to each node, either in
-     * forward or reverse order.
-     * @param callbackFn - A callback function that will be called for each element in the linked list. It takes three
-     * parameters:
-     * @param [reverse=false] - A boolean value indicating whether to iterate over the linked list in reverse order. If set
-     * to true, the iteration will start from the tail of the linked list and move towards the head. If set to false
-     * (default), the iteration will start from the head and move towards the tail.
+     * The `toArray` function converts a linked list into an array.
+     * @returns The `toArray()` method is returning an array of type `T[]`.
      */
-    forEach(callbackFn: (data: any, index: number, list: SinglyLinkedList<NodeVal>) => any, reverse?: boolean): void;
+    toArray(): T[];
     /**
-     * The map function takes a callback function and applies it to each element in the linked list, returning a new linked
-     * list with the results.
-     * @param callbackFn - A callback function that will be applied to each element in the linked list. It takes three
-     * parameters:
-     * @param [reverse=false] - The `reverse` parameter is a boolean value that determines whether the mapping should be
-     * done in reverse order or not. If `reverse` is set to `true`, the mapping will be done in reverse order. If `reverse`
-     * is set to `false` or not provided, the mapping will be
-     * @returns The `map` function is returning a new `SinglyLinkedList` object.
+     * 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.
      */
-    map(callbackFn: (data: any, index: number, list: SinglyLinkedList<NodeVal>) => any, reverse?: boolean): SinglyLinkedList<NodeVal | {}>;
+    reverse(): void;
     /**
-     * The `filter` function filters the elements of a singly linked list based on a given callback function.
-     * @param callbackFn - A callback function that takes three parameters: data, index, and list. It should return a
-     * boolean value indicating whether the current element should be included in the filtered list or not.
-     * @param [reverse=false] - The `reverse` parameter is a boolean value that determines whether the filtered list should
-     * be reversed or not. If `reverse` is set to `true`, the filtered list will be in reverse order. If `reverse` is set
-     * to `false` or not provided, the filtered list will be in
-     * @returns The `filter` method is returning a new `SinglyLinkedList` object.
+     * 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`.
      */
-    filter(callbackFn: (data: NodeVal, index: number, list: SinglyLinkedList<NodeVal>) => boolean, reverse?: boolean): SinglyLinkedList<NodeVal | {}>;
+    find(callback: (val: T) => boolean): T | null;
     /**
-     * The `reduce` function iterates over a singly linked list and applies a callback function to each element,
-     * accumulating a single value.
-     * @param callbackFn - A callback function that will be called for each element in the linked list. It takes four
-     * parameters:
-     * @param {any} [start] - The `start` parameter is an optional initial value for the accumulator. If provided, the
-     * `reduce` function will start accumulating from this value. If not provided, the `reduce` function will use the value
-     * of the first element in the linked list as the initial value.
-     * @param [reverse=false] - A boolean value indicating whether to iterate over the linked list in reverse order. If set
-     * to true, the iteration will start from the tail of the linked list and move towards the head. If set to false
-     * (default), the iteration will start from the head and move towards the tail.
-     * @returns The `reduce` method returns the accumulated value after applying the callback function to each element in
-     * the linked list.
+     * The `indexOf` function returns the index of the first occurrence of a given value in a linked list.
+     * @param {T} 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.
      */
-    reduce(callbackFn: (accumulator: any, currentNode: NodeVal, index: number, list: SinglyLinkedList<NodeVal>) => any, start?: any, reverse?: boolean): any;
+    indexOf(value: T): number;
     /**
-     * The toArray() function converts a NodeVal object into an array of NodeVal objects.
-     * @returns An array of NodeVal objects.
+     * The function finds a node in a singly linked list by its value and returns the node if found, otherwise returns
+     * null.
+     * @param {T} value - The value parameter is the value that we want to search for in the linked list.
+     * @returns a `SinglyLinkedListNode<T>` 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`.
      */
-    toArray(): NodeVal[];
+    findNode(value: T): SinglyLinkedListNode<T> | null;
     /**
-     * The `toString` function takes an optional separator and returns a string representation of an array, with each
-     * element separated by the specified separator.
-     * @param [separator= ] - The separator parameter is a string that specifies the character(s) to be used as a separator
-     * between each element in the array when converting it to a string. By default, the separator is set to a space
-     * character (' ').
-     * @returns The toString method is being returned as a string.
+     * The `insertBefore` function inserts a new value before an existing value in a singly linked list.
+     * @param {T} existingValue - The existing value is the value that already exists in the linked list and before which
+     * we want to insert a new value.
+     * @param {T} newValue - The `newValue` parameter represents the value that you want to insert into the linked list.
+     * @returns The `insertBefore` function returns a boolean value. It returns `true` if the `newValue` is successfully
+     * inserted before the first occurrence of `existingValue` in the linked list. It returns `false` if the
+     * `existingValue` is not found in the linked list.
      */
-    toString(separator?: string): string;
+    insertBefore(existingValue: T, newValue: T): boolean;
     /**
-     * The function is an iterator that returns the values of each node in a linked list.
+     * The function inserts a new value after an existing value in a singly linked list.
+     * @param {T} existingValue - The existing value is the value of the node after which we want to insert the new value.
+     * @param {T} newValue - The `newValue` parameter represents the value that you want to insert into the linked list
+     * after the node with the `existingValue`.
+     * @returns The method is returning a boolean value. It returns true if the insertion is successful and false if the
+     * existing value is not found in the linked list.
      */
-    [Symbol.iterator](): IterableIterator<NodeVal>;
+    insertAfter(existingValue: T, newValue: T): boolean;
     /**
-     * The function removes a node from either end of a singly linked list and returns its value.
-     * @param {SinglyLinkedListNode<NodeVal> | null} node - The `node` parameter is a reference to a node in a singly
-     * linked list. It can be either a `SinglyLinkedListNode` object or `null`.
-     * @returns The value of the removed node if the node is not null, otherwise undefined.
+     * The function counts the number of occurrences of a given value in a linked list.
+     * @param {T} 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.
      */
-    protected removeFromAnyEnd(node: SinglyLinkedListNode<NodeVal> | null): NodeVal | undefined;
+    countOccurrences(value: T): number;
 }