min-heap-typed 1.42.8 → 1.43.0

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

@@ -29,6 +29,13 @@ export declare class DoublyLinkedList<E = any> {
     get length(): number;
     get size(): number;
     /**
+     * Time Complexity: O(n), where n is the length of the input array.
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n), where n is the length of the input array.
+     * Space Complexity: O(n)
+     *
      * The `fromArray` function creates a new instance of a DoublyLinkedList and populates it with the elements from the
      * given array.
      * @param {E[]} data - The `data` parameter is an array of elements of type `E`.
@@ -36,62 +43,139 @@ export declare class DoublyLinkedList<E = any> {
      */
     static fromArray<E>(data: E[]): DoublyLinkedList<E>;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The push function adds a new node with the given value to the end of the doubly linked list.
      * @param {E} value - The value to be added to the linked list.
      */
     push(value: E): void;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The addLast function adds a new node with the given value to the end of the doubly linked list.
      * @param {E} value - The value to be added to the linked list.
      */
     addLast(value: E): void;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * 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.value) if the list is not empty. If the
      * list is empty, it returns null.
      */
     pop(): E | undefined;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `popLast()` 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.value) if the list is not empty. If the
      * list is empty, it returns null.
      */
     popLast(): E | undefined;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * 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(): E | undefined;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `popFirst()` 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.
      */
     popFirst(): E | undefined;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The unshift function adds a new node with the given value to the beginning of a doubly linked list.
      * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
      * doubly linked list.
      */
     unshift(value: E): void;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The addFirst function adds a new node with the given value to the beginning of a doubly linked list.
      * @param {E} value - The `value` parameter represents the value of the new node that will be added to the beginning of the
      * doubly linked list.
      */
     addFirst(value: E): void;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The `getFirst` function returns the first node in a doubly linked list, or null if the list is empty.
      * @returns The method `getFirst()` returns the first node of the doubly linked list, or `null` if the list is empty.
      */
     getFirst(): E | undefined;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The `getLast` function returns the last node in a doubly linked list, or null if the list is empty.
      * @returns The method `getLast()` returns the last node of the doubly linked list, or `null` if the list is empty.
      */
     getLast(): E | undefined;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * 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.
@@ -100,6 +184,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     getAt(index: number): E | undefined;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * 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
@@ -109,6 +200,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     getNodeAt(index: number): DoublyLinkedListNode<E> | null;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * 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 {E} value - The `value` parameter is the value that we want to search for in the doubly linked list.
@@ -117,6 +215,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     getNode(value: E | null): DoublyLinkedListNode<E> | null;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * 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.
@@ -127,6 +232,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     insertAt(index: number, value: E): boolean;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The `insertBefore` function inserts a new value before an existing value or node in a doubly linked list.
      * @param {E | DoublyLinkedListNode<E>} 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
@@ -138,6 +250,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     insertBefore(existingValueOrNode: E | DoublyLinkedListNode<E>, newValue: E): boolean;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * 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.
@@ -146,6 +265,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     deleteAt(index: number): E | undefined;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The `delete` function removes a node from a doubly linked list based on either the node itself or its value.
      * @param {E | DoublyLinkedListNode<E>} valOrNode - The `valOrNode` parameter can accept either a value of type `E` or
      * a `DoublyLinkedListNode<E>` object.
@@ -154,6 +280,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     delete(valOrNode: E | DoublyLinkedListNode<E> | null): boolean;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     *
      * The `toArray` function converts a linked list into an array.
      * @returns The `toArray()` method is returning an array of type `E[]`.
      */
@@ -168,6 +301,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     clear(): void;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * 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.
@@ -176,6 +316,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     find(callback: (value: E) => boolean): E | null;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The function returns the index of the first occurrence of a given value in a linked list.
      * @param {E} value - The parameter `value` is of type `E`, which means it can be any data type. It represents the value
      * that we are searching for in the linked list.
@@ -184,6 +331,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     indexOf(value: E): number;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The `findBackward` 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 E as its parameter and returns a boolean value. This
@@ -193,15 +347,36 @@ export declare class DoublyLinkedList<E = any> {
      */
     findBackward(callback: (value: E) => boolean): E | null;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     *
      * The `toArrayBackward` function converts a doubly linked list into an array in reverse order.
      * @returns The `toArrayBackward()` function returns an array of type `E[]`.
      */
     toArrayBackward(): E[];
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The `reverse` function reverses the order of the elements in a doubly linked list.
      */
     reverse(): void;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * 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: value and index. The value argument
      * represents the value of the current node in the linked list, and the index argument represents the index of the
@@ -209,6 +384,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     forEach(callback: (value: E, index: number) => void): void;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     *
      * 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 E (the type of values stored in
@@ -218,6 +400,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     map<U>(callback: (value: E) => U): DoublyLinkedList<U>;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     *
      * 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 `E` and returns a boolean value.
@@ -226,6 +415,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     filter(callback: (value: E) => boolean): DoublyLinkedList<E>;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(n)
+     *
      * 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 `value`. It is
@@ -237,6 +433,13 @@ export declare class DoublyLinkedList<E = any> {
      */
     reduce<U>(callback: (accumulator: U, value: E) => U, initialValue: U): U;
     /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Space Complexity: O(1)
+     *
      * The `insertAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
      * @param {E | DoublyLinkedListNode<E>} 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