min-heap-typed 1.50.1 → 1.50.3

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

@@ -9,14 +9,48 @@ class SinglyLinkedListNode {
      * will be stored in the node of a linked list.
      */
     constructor(value) {
-        this.value = value;
-        this.next = undefined;
+        this._value = value;
+        this._next = undefined;
+    }
+    /**
+     * The function returns the value of a protected variable.
+     * @returns The value of the variable `_value` is being returned.
+     */
+    get value() {
+        return this._value;
+    }
+    /**
+     * The above function sets the value of a variable.
+     * @param {E} value - The parameter "value" is of type E, which means it can be any type.
+     */
+    set value(value) {
+        this._value = value;
+    }
+    /**
+     * The `next` function returns the next node in a singly linked list.
+     * @returns The `next` property is being returned. It can be either a `SinglyLinkedListNode<E>`
+     * object or `undefined`.
+     */
+    get next() {
+        return this._next;
+    }
+    /**
+     * The "next" property of a SinglyLinkedListNode is set to the provided value.
+     * @param {SinglyLinkedListNode<E> | undefined} value - The `value` parameter is of type
+     * `SinglyLinkedListNode<E> | undefined`. This means that it can accept either a
+     * `SinglyLinkedListNode` object or `undefined` as its value.
+     */
+    set next(value) {
+        this._next = value;
     }
 }
 exports.SinglyLinkedListNode = SinglyLinkedListNode;
 class SinglyLinkedList extends base_1.IterableElementBase {
     /**
-     * The constructor initializes the linked list with an empty head, tail, and length.
+     * The constructor initializes a new instance of a class with an optional iterable of elements.
+     * @param elements - The `elements` parameter is an optional iterable object that contains the
+     * initial elements to be added to the instance of the class. If no `elements` are provided, an empty
+     * array will be used as the default value.
      */
     constructor(elements = []) {
         super();
@@ -26,22 +60,36 @@ class SinglyLinkedList extends base_1.IterableElementBase {
                 this.push(el);
         }
     }
+    /**
+     * The `head` function returns the first node of a singly linked list.
+     * @returns The method is returning either a SinglyLinkedListNode object or undefined.
+     */
     get head() {
         return this._head;
     }
+    /**
+     * The `tail` function returns the last node of a singly linked list.
+     * @returns The method is returning either a SinglyLinkedListNode object or undefined.
+     */
     get tail() {
         return this._tail;
     }
+    /**
+     * The function returns the size of an object.
+     * @returns The size of the object, which is a number.
+     */
     get size() {
         return this._size;
     }
     /**
-     * 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)
+     * Space 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.
+     * 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.
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      *
      * The `fromArray` function creates a new SinglyLinkedList instance and populates it with the elements from the given
      * array.
@@ -56,12 +104,14 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return singlyLinkedList;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
+     * Constant time, as it involves basic pointer adjustments.
+     * 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.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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
@@ -81,12 +131,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return true;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * 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
@@ -96,12 +146,13 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return this.push(value);
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
+     * Linear time in the worst case, as it may need to traverse the list to find the last element.
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * The `pop()` function removes and returns the value of the last element in a linked list, updating the head and tail
      * pointers accordingly.
@@ -129,12 +180,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return value;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * The `pollLast()` function removes and returns the value of the last element in a linked list, updating the head and tail
      * pointers accordingly.
@@ -145,12 +196,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return this.pop();
     }
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -164,12 +215,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return removedNode.value;
     }
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * The `pollFirst()` 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.
@@ -178,12 +229,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return this.shift();
     }
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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
@@ -203,12 +254,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return true;
     }
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(1) - Constant time, as it involves adjusting pointers at the head.
-     * Space Complexity: O(1) - Constant space.
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      *
      * 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
@@ -218,20 +269,21 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return this.unshift(value);
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
+     * Linear time, where n is the index, as it may need to traverse the list to find the desired node.
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
-     * The function `getAt` returns the value at a specified index in a linked list, or undefined if the index is out of range.
+     * The function `at` returns the value at a specified index in a linked list, or undefined 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 | undefined` returns the value at the specified index in the linked list, or
+     * @returns The method `at(index: number): E | undefined` returns the value at the specified index in the linked list, or
      * `undefined` if the index is out of bounds.
      */
-    getAt(index) {
+    at(index) {
         if (index < 0 || index >= this.size)
             return undefined;
         let current = this.head;
@@ -241,12 +293,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return current.value;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * 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
@@ -262,12 +314,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return current;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * 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
@@ -293,12 +345,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return true;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * 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`
@@ -340,12 +392,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return false;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * The `addAt` 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
@@ -390,12 +442,14 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         this._size = 0;
     }
     /**
-     * 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)
+     * Space 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.
+     * 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.
+     * Time Complexity: O(n)
+     * 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[]`.
@@ -410,12 +464,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return array;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -436,36 +490,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return this;
     }
     /**
-     * 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.
-     * @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 `undefined`.
-     */
-    find(callback) {
-        let current = this.head;
-        while (current) {
-            if (callback(current.value)) {
-                return current.value;
-            }
-            current = current.next;
-        }
-        return undefined;
-    }
-    /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -485,12 +515,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return -1;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * The function finds a node in a singly linked list by its value and returns the node if found, otherwise returns
      * undefined.
@@ -509,12 +539,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return undefined;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * The `addBefore` 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
@@ -551,12 +581,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return false;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * The `addAfter` 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
@@ -586,12 +616,12 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return false;
     }
     /**
-     * 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)
+     * Space Complexity: O(1)
      */
     /**
-     * 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)
+     * Space Complexity: O(1)
      *
      * 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.
@@ -608,6 +638,22 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         }
         return count;
     }
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
+     * The `clone` function returns a new instance of the `SinglyLinkedList` class with the same values
+     * as the original list.
+     * @returns The `clone()` method is returning a new instance of the `SinglyLinkedList` class, which
+     * is a clone of the original list.
+     */
+    clone() {
+        return new SinglyLinkedList(this.values());
+    }
     /**
      * Time Complexity: O(n)
      * Space Complexity: O(n)
@@ -641,7 +687,7 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         return filteredList;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      */
     /**
@@ -667,6 +713,9 @@ class SinglyLinkedList extends base_1.IterableElementBase {
         }
         return mappedList;
     }
+    /**
+     * The function `_getIterator` returns an iterable iterator that yields the values of a linked list.
+     */
     *_getIterator() {
         let current = this.head;
         while (current) {