min-heap-typed 1.50.1 → 1.50.3

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

@@ -9,9 +9,57 @@ class DoublyLinkedListNode {
      * is defined as a generic type "E".
      */
     constructor(value) {
-        this.value = value;
-        this.next = undefined;
-        this.prev = undefined;
+        this._value = value;
+        this._next = undefined;
+        this._prev = 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 doubly linked list.
+     * @returns The `next` property is being returned. It can be either a `DoublyLinkedListNode<E>`
+     * object or `undefined`.
+     */
+    get next() {
+        return this._next;
+    }
+    /**
+     * The "next" property of a DoublyLinkedListNode is set to the provided value.
+     * @param {DoublyLinkedListNode<E> | undefined} value - The `value` parameter is of type
+     * `DoublyLinkedListNode<E> | undefined`. This means that it can accept either a
+     * `DoublyLinkedListNode` object or `undefined` as its value.
+     */
+    set next(value) {
+        this._next = value;
+    }
+    /**
+     * The `prev` function returns the previous node in a doubly linked list.
+     * @returns The `prev` property of the `DoublyLinkedListNode` class is being returned. It can either
+     * be a `DoublyLinkedListNode` object or `undefined`.
+     */
+    get prev() {
+        return this._prev;
+    }
+    /**
+     * The function sets the previous node of a doubly linked list node.
+     * @param {DoublyLinkedListNode<E> | undefined} value - The `value` parameter is of type
+     * `DoublyLinkedListNode<E> | undefined`. This means that it can accept either a
+     * `DoublyLinkedListNode` object or `undefined` as its value.
+     */
+    set prev(value) {
+        this._prev = value;
     }
 }
 exports.DoublyLinkedListNode = DoublyLinkedListNode;
@@ -23,7 +71,10 @@ exports.DoublyLinkedListNode = DoublyLinkedListNode;
  */
 class DoublyLinkedList extends base_1.IterableElementBase {
     /**
-     * The constructor initializes the linked list with an empty head, tail, and size.
+     * The constructor initializes a linked list with optional elements.
+     * @param elements - The `elements` parameter is an optional iterable object that contains the
+     * initial elements to be added to the data structure. It defaults to an empty array if no elements
+     * are provided.
      */
     constructor(elements = []) {
         super();
@@ -36,21 +87,35 @@ class DoublyLinkedList extends base_1.IterableElementBase {
             }
         }
     }
+    /**
+     * The `head` function returns the first node of a doubly linked list.
+     * @returns The method `getHead()` returns either a `DoublyLinkedListNode<E>` object or `undefined`.
+     */
     get head() {
         return this._head;
     }
+    /**
+     * The `tail` function returns the last node of a doubly linked list.
+     * @returns The `get tail()` method is returning either a `DoublyLinkedListNode<E>` 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), where n is the size of the input array.
-     * Space Complexity: O(n)
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     * where n is the number of elements in the linked list.
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
      * The `get first` function returns the first node in a doubly linked list, or undefined if the list is empty.
@@ -65,7 +130,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      *
      * The `get last` function returns the last node in a doubly linked list, or undefined if the list is empty.
@@ -76,11 +141,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return (_a = this.tail) === null || _a === void 0 ? void 0 : _a.value;
     }
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n), where n is the size of the input array.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
      * The `fromArray` function creates a new instance of a DoublyLinkedList and populates it with the elements from the
@@ -89,11 +154,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
      * @returns The `fromArray` function returns a DoublyLinkedList object.
      */
     static fromArray(data) {
-        const doublyLinkedList = new DoublyLinkedList();
-        for (const item of data) {
-            doublyLinkedList.push(item);
-        }
-        return doublyLinkedList;
+        return new DoublyLinkedList(data);
     }
     /**
      * Time Complexity: O(1)
@@ -148,7 +209,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return removedNode.value;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
@@ -175,7 +236,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return removedNode.value;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
@@ -201,20 +262,20 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return true;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
-     * The `getAt` function returns the value at a specified index in a linked list, or undefined if the index is out of bounds.
+     * The `at` function returns the value at a specified index in a linked list, or undefined 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.
      * @returns The method is returning the value at the specified index in the linked list. If the index is out of bounds
      * or the linked list is empty, it will return undefined.
      */
-    getAt(index) {
+    at(index) {
         if (index < 0 || index >= this.size)
             return undefined;
         let current = this.head;
@@ -224,11 +285,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return current.value;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The function `getNodeAt` returns the node at a given index in a doubly linked list, or undefined if the index is out of
@@ -248,11 +309,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return current;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The function `findNodeByValue` searches for a node with a specific value in a doubly linked list and returns the
@@ -272,11 +333,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return undefined;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The `insert` function inserts a value at a specified index in a doubly linked list.
@@ -309,11 +370,12 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return true;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
+     * where n is the number of elements in the linked list.
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      *
      * The `addBefore` function inserts a new value before an existing value or node in a doubly linked list.
@@ -350,11 +412,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return false;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      *
      * The `addAfter` function inserts a new node with a given value after an existing node in a doubly linked list.
@@ -390,7 +452,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return false;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * 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.
@@ -419,7 +481,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return true;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1) or O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1) or O(n)
      * Space Complexity: O(1)
      *
      * The `delete` function removes a node from a doubly linked list based on either the node itself or its value.
@@ -455,10 +521,13 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return false;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function checks if a variable has a size greater than zero and returns a boolean value.
      * @returns A boolean value is being returned.
      */
@@ -466,10 +535,13 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return this.size === 0;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `clear` function resets the linked list by setting the head, tail, and size to undefined and 0 respectively.
      */
     clear() {
@@ -478,35 +550,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         this._size = 0;
     }
     /**
-     * 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.
-     * @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), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The function returns the index of the first occurrence of a given value in a linked list.
@@ -528,11 +576,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return -1;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(n)
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The `findBackward` function iterates through a linked list from the last node to the first node and returns the last
@@ -553,11 +601,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return undefined;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
-     * Space Complexity: O(n)
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(1)
      *
      * The `reverse` function reverses the order of the elements in a doubly linked list.
@@ -577,7 +625,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
      * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
      * The `toArray` function converts a linked list into an array.
@@ -593,11 +641,11 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return array;
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      */
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(n)
      * Space Complexity: O(n)
      *
      * The `toReversedArray` function converts a doubly linked list into an array in reverse order.
@@ -613,8 +661,24 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return array;
     }
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
+     *
+     * The `clone` function creates a new instance of the `DoublyLinkedList` class with the same values
+     * as the original list.
+     * @returns The `clone()` method is returning a new instance of the `DoublyLinkedList` class, which
+     * is a copy of the original list.
+     */
+    clone() {
+        return new DoublyLinkedList(this.values());
+    }
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
      * Time Complexity: O(n)
@@ -645,8 +709,8 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return filteredList;
     }
     /**
-     * Time Complexity: O(1)
-     * Space Complexity: O(1)
+     * Time Complexity: O(n)
+     * Space Complexity: O(n)
      */
     /**
      * Time Complexity: O(n)
@@ -704,7 +768,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return this.pop();
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**
@@ -719,7 +783,7 @@ class DoublyLinkedList extends base_1.IterableElementBase {
         return this.shift();
     }
     /**
-     * Time Complexity: O(n), where n is the number of elements in the linked list.
+     * Time Complexity: O(1)
      * Space Complexity: O(1)
      */
     /**