min-heap-typed 1.42.8 → 1.43.0

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

@@ -27,6 +27,13 @@ export declare class SinglyLinkedList<E = any> {
     protected _length: number;
     get length(): number;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the input array, as it performs a loop to push each element into the linked list.
+     * Space Complexity: O(n) - Linear space, as it creates a new node for each element in the array.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the input array, as it performs a loop to push each element into the linked list.
+     * Space Complexity: O(n) - Linear space, as it creates a new node for each element in the array.
+     *
      * 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`.
@@ -34,18 +41,39 @@ export declare class SinglyLinkedList<E = any> {
      */
     static fromArray<E>(data: E[]): SinglyLinkedList<E>;
     /**
+     * Time Complexity: O(1) - Constant time, as it involves basic pointer adjustments.
+     * Space Complexity: O(1) - Constant space, as it only creates a new node.
+     */
+    /**
+     * Time Complexity: O(1) - Constant time, as it involves basic pointer adjustments.
+     * Space Complexity: O(1) - Constant space, as it only creates a new node.
+     *
      * The `push` function adds a new node with the given value to the end of a singly linked list.
      * @param {E} value - The "value" 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(value: E): void;
     /**
+     * Time Complexity: O(1) - Constant time, as it involves basic pointer adjustments.
+     * Space Complexity: O(1) - Constant space, as it only creates a new node.
+     */
+    /**
+     * Time Complexity: O(1) - Constant time, as it involves basic pointer adjustments.
+     * Space Complexity: O(1) - Constant space, as it only creates a new node.
+     *
      * The `push` function adds a new node with the given value to the end of a singly linked list.
      * @param {E} value - The "value" 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.
      */
     addLast(value: E): void;
     /**
+     * Time Complexity: O(n) - Linear time in the worst case, as it may need to traverse the list to find the last element.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time in the worst case, as it may need to traverse the list to find the last element.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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
@@ -53,6 +81,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     pop(): E | undefined;
     /**
+     * Time Complexity: O(n) - Linear time in the worst case, as it may need to traverse the list to find the last element.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time in the worst case, as it may need to traverse the list to find the last element.
+     * Space Complexity: O(1) - Constant space.
+     *
      * The `popLast()` 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
@@ -60,28 +95,63 @@ export declare class SinglyLinkedList<E = any> {
      */
     popLast(): E | undefined;
     /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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;
     /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     *
      * The `popFirst()` 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.
      */
     popFirst(): E | undefined;
     /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     *
      * The unshift function adds a new node with the given value to the beginning of a singly linked list.
      * @param {E} value - The parameter "value" represents the value of the new node that will be added to the beginning of the
      * linked list.
      */
     unshift(value: E): void;
     /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
+     * Space Complexity: O(1) - Constant space.
+     *
      * The addFirst function adds a new node with the given value to the beginning of a singly linked list.
      * @param {E} value - The parameter "value" represents the value of the new node that will be added to the beginning of the
      * linked list.
      */
     addFirst(value: E): void;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -90,6 +160,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     getAt(index: number): E | undefined;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -98,6 +175,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     getNodeAt(index: number): SinglyLinkedListNode<E> | null;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -106,6 +190,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     deleteAt(index: number): E | undefined;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -114,6 +205,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     delete(valueOrNode: E | SinglyLinkedListNode<E> | null | undefined): boolean;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the index, as it may need to traverse the list to find the desired node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -134,16 +232,37 @@ export declare class SinglyLinkedList<E = any> {
      */
     clear(): void;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to traverse the entire list to convert it to an array.
+     * Space Complexity: O(n) - Linear space, as it creates an array with the same length as the list.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to traverse the entire list to convert it to an array.
+     * Space Complexity: O(n) - Linear space, as it creates an array with the same length as the list.
+     *
      * The `toArray` function converts a linked list into an array.
      * @returns The `toArray()` method is returning an array of type `E[]`.
      */
     toArray(): E[];
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -152,6 +271,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     find(callback: (value: E) => boolean): E | null;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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
@@ -159,6 +285,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     indexOf(value: E): number;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -167,6 +300,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     getNode(value: E): SinglyLinkedListNode<E> | null;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -176,6 +316,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     insertBefore(existingValueOrNode: E | SinglyLinkedListNode<E>, newValue: E): boolean;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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.
@@ -185,12 +332,26 @@ export declare class SinglyLinkedList<E = any> {
      */
     insertAfter(existingValueOrNode: E | SinglyLinkedListNode<E>, newValue: E): boolean;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as it needs to reverse the pointers of each node.
+     * Space Complexity: O(1) - Constant space.
+     *
      * 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
@@ -198,6 +359,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     forEach(callback: (value: E, index: number) => void): void;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as they need to traverse the entire list to apply the callback or reduce the list.
+     * Space Complexity: O(n) - Linear space, as they create new nodes or arrays.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as they need to traverse the entire list to apply the callback or reduce the list.
+     * Space Complexity: O(n) - Linear space, as they create new nodes or arrays.
+     *
      * The `map` function takes a callback function and applies it to each element in the SinglyLinkedList, returning a new
      * SinglyLinkedList 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
@@ -207,6 +375,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     map<U>(callback: (value: E) => U): SinglyLinkedList<U>;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as they need to traverse the entire list to apply the callback or reduce the list.
+     * Space Complexity: O(n) - Linear space, as they create new nodes or arrays.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as they need to traverse the entire list to apply the callback or reduce the list.
+     * Space Complexity: O(n) - Linear space, as they create new nodes or arrays.
+     *
      * The `filter` function iterates through a SinglyLinkedList and returns a new SinglyLinkedList 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.
@@ -215,6 +390,13 @@ export declare class SinglyLinkedList<E = any> {
      */
     filter(callback: (value: E) => boolean): SinglyLinkedList<E>;
     /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as they need to traverse the entire list to apply the callback or reduce the list.
+     * Space Complexity: O(n) - Linear space, as they create new nodes or arrays.
+     */
+    /**
+     * Time Complexity: O(n) - Linear time, where n is the length of the list, as they need to traverse the entire list to apply the callback or reduce the list.
+     * Space Complexity: O(n) - Linear space, as they create new nodes or arrays.
+     *
      * 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