data-structure-typed 1.42.8 → 1.43.0

package/dist/mjs/src/data-structures/queue/deque.d.ts

@@ -25,37 +25,86 @@ export declare class ObjectDeque<E = number> {
     protected _size: number;
     get size(): number;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The "addFirst" function adds a value to the beginning of an array-like data structure.
      * @param {E} value - The `value` parameter represents the value that you want to add to the beginning of the data
      * structure.
      */
     addFirst(value: E): void;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The addLast function adds a value to the end of an array-like data structure.
      * @param {E} value - The `value` parameter represents the value that you want to add to the end of the data structure.
      */
     addLast(value: E): void;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `popFirst()` removes and returns the first element in a data structure.
      * @returns The value of the first element in the data structure.
      */
     popFirst(): E | undefined;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getFirst` function returns the first element in an array-like data structure if it exists.
      * @returns The element at the first position of the `_nodes` array.
      */
     getFirst(): 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 last element in a data structure.
      * @returns The value that was removed from the data structure.
      */
     popLast(): E | undefined;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getLast()` function returns the last element in an array-like data structure.
      * @returns The last element in the array "_nodes" is being returned.
      */
     getLast(): E | undefined;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The get function returns the element at the specified index in an array-like data structure.
      * @param {number} index - The index parameter is a number that represents the position of the element you want to
      * retrieve from the array.
@@ -74,29 +123,51 @@ export declare class ArrayDeque<E> {
     get nodes(): E[];
     get size(): number;
     /**
-     * O(n) time complexity of adding at the beginning and the end
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "addLast" adds a value to the end of an array.
      * @param {E} value - The value parameter represents the value that you want to add to the end of the array.
      * @returns The return value is the new length of the array after the value has been added.
      */
     addLast(value: E): number;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "popLast" returns and removes the last element from an array, or returns null if the array is empty.
      * @returns The method `popLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
     popLast(): E | null;
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The `popFirst` function removes and returns the first element from an array, or returns null if the array is empty.
      * @returns The `popFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
      * empty.
      */
     popFirst(): E | null;
     /**
-     * O(n) time complexity of adding at the beginning and the end
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The function "addFirst" adds a value to the beginning of an array.
      * @param {E} value - The value parameter represents the value that you want to add to the beginning of the array.
      * @returns The return value of the `addFirst` function is the new length of the array `_nodes` after adding the
@@ -104,20 +175,38 @@ export declare class ArrayDeque<E> {
      */
     addFirst(value: E): number;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getFirst` function returns the first element of an array or null if the array is empty.
      * @returns The function `getFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
      * empty, it will return `null`.
      */
     getFirst(): E | null;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getLast` function returns the last element of an array or null if the array is empty.
      * @returns The method `getLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
     getLast(): E | null;
     /**
-     * O(1) time complexity of obtaining the value
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The get function returns the element at the specified index in an array, 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 you want to
      * retrieve from the array.
@@ -126,6 +215,13 @@ export declare class ArrayDeque<E> {
      */
     get(index: number): E | null;
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The set function assigns a value to a specific index in an array.
      * @param {number} index - The index parameter is a number that represents the position of the element in the array
      * that you want to set a new value for.
@@ -135,6 +231,13 @@ export declare class ArrayDeque<E> {
      */
     set(index: number, value: E): E;
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The insert function adds a value at a specified index in an array.
      * @param {number} index - The index parameter specifies the position at which the value should be inserted in the
      * array. It is a number that represents the index of the array where the value should be inserted. The index starts
@@ -146,6 +249,13 @@ export declare class ArrayDeque<E> {
      */
     insert(index: number, value: E): E[];
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The delete function removes an element from an array at a specified index.
      * @param {number} index - The index parameter specifies the position of the element to be removed from the array. It
      * is a number that represents the index of the element to be removed.

package/dist/mjs/src/data-structures/queue/deque.js

@@ -43,6 +43,13 @@ class ObjectDeque {
         return this._size;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The "addFirst" function adds a value to the beginning of an array-like data structure.
      * @param {E} value - The `value` parameter represents the value that you want to add to the beginning of the data
      * structure.
@@ -60,6 +67,13 @@ class ObjectDeque {
         this._size++;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The addLast function adds a value to the end of an array-like data structure.
      * @param {E} value - The `value` parameter represents the value that you want to add to the end of the data structure.
      */
@@ -76,6 +90,13 @@ class ObjectDeque {
         this._size++;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function `popFirst()` removes and returns the first element in a data structure.
      * @returns The value of the first element in the data structure.
      */
@@ -89,6 +110,13 @@ class ObjectDeque {
         return value;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getFirst` function returns the first element in an array-like data structure if it exists.
      * @returns The element at the first position of the `_nodes` array.
      */
@@ -97,6 +125,13 @@ class ObjectDeque {
             return this.nodes[this.first];
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `popLast()` function removes and returns the last element in a data structure.
      * @returns The value that was removed from the data structure.
      */
@@ -110,6 +145,13 @@ class ObjectDeque {
         return value;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getLast()` function returns the last element in an array-like data structure.
      * @returns The last element in the array "_nodes" is being returned.
      */
@@ -118,6 +160,13 @@ class ObjectDeque {
             return this.nodes[this.last];
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The get function returns the element at the specified index in an array-like data structure.
      * @param {number} index - The index parameter is a number that represents the position of the element you want to
      * retrieve from the array.
@@ -147,9 +196,13 @@ class ArrayDeque {
         return this.nodes.length;
     }
     /**
-     * O(n) time complexity of adding at the beginning and the end
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "addLast" adds a value to the end of an array.
      * @param {E} value - The value parameter represents the value that you want to add to the end of the array.
      * @returns The return value is the new length of the array after the value has been added.
@@ -158,6 +211,13 @@ class ArrayDeque {
         return this.nodes.push(value);
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The function "popLast" returns and removes the last element from an array, or returns null if the array is empty.
      * @returns The method `popLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
@@ -165,6 +225,13 @@ class ArrayDeque {
         return this.nodes.pop() ?? null;
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The `popFirst` function removes and returns the first element from an array, or returns null if the array is empty.
      * @returns The `popFirst()` function returns the first element of the `_nodes` array, or `null` if the array is
      * empty.
@@ -173,9 +240,13 @@ class ArrayDeque {
         return this.nodes.shift() ?? null;
     }
     /**
-     * O(n) time complexity of adding at the beginning and the end
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The function "addFirst" adds a value to the beginning of an array.
      * @param {E} value - The value parameter represents the value that you want to add to the beginning of the array.
      * @returns The return value of the `addFirst` function is the new length of the array `_nodes` after adding the
@@ -185,6 +256,13 @@ class ArrayDeque {
         return this.nodes.unshift(value);
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getFirst` function returns the first element of an array or null if the array is empty.
      * @returns The function `getFirst()` is returning the first element (`E`) of the `_nodes` array. If the array is
      * empty, it will return `null`.
@@ -193,6 +271,13 @@ class ArrayDeque {
         return this.nodes[0] ?? null;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The `getLast` function returns the last element of an array or null if the array is empty.
      * @returns The method `getLast()` returns the last element of the `_nodes` array, or `null` if the array is empty.
      */
@@ -200,9 +285,13 @@ class ArrayDeque {
         return this.nodes[this.nodes.length - 1] ?? null;
     }
     /**
-     * O(1) time complexity of obtaining the value
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
      */
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The get function returns the element at the specified index in an array, 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 you want to
      * retrieve from the array.
@@ -213,6 +302,13 @@ class ArrayDeque {
         return this.nodes[index] ?? null;
     }
     /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(1)
+     * Space Complexity: O(1)
+     *
      * The set function assigns a value to a specific index in an array.
      * @param {number} index - The index parameter is a number that represents the position of the element in the array
      * that you want to set a new value for.
@@ -224,6 +320,13 @@ class ArrayDeque {
         return (this.nodes[index] = value);
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The insert function adds a value at a specified index in an array.
      * @param {number} index - The index parameter specifies the position at which the value should be inserted in the
      * array. It is a number that represents the index of the array where the value should be inserted. The index starts
@@ -237,6 +340,13 @@ class ArrayDeque {
         return this.nodes.splice(index, 0, value);
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     */
+    /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     *
      * The delete function removes an element from an array at a specified index.
      * @param {number} index - The index parameter specifies the position of the element to be removed from the array. It
      * is a number that represents the index of the element to be removed.

package/dist/mjs/src/data-structures/queue/queue.d.ts

@@ -53,58 +53,138 @@ export declare class Queue<E = any> {
      */
     static fromArray<E>(elements: E[]): Queue<E>;
     /**
+     * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it adds an element to the end of the array.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The push function adds an element to the end of the queue and returns the updated queue.Adds an element at the back of the queue.
      * @param {E} element - The `element` parameter represents the element that you want to add to the queue.
      * @returns The `add` method is returning a `Queue<E>` object.
      */
     push(element: E): Queue<E>;
     /**
+     * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(n) - where n is the number of elements in the queue. In the worst case, it may need to shift all elements to update the offset.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The `shift` function removes and returns the first element in the queue, and adjusts the internal data structure if
      * necessary to optimize performance.
      * @returns The function `shift()` returns either the first element in the queue or `null` if the queue is empty.
      */
     shift(): E | undefined;
     /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The `getFirst` function returns the first element of the array `_nodes` if it exists, otherwise it returns `null`.
      * @returns The `getFirst()` method returns the first element of the data structure, represented by the `_nodes` array at
      * the `_offset` index. If the data structure is empty (size is 0), it returns `null`.
      */
     getFirst(): E | undefined;
     /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The `peek` function returns the first element of the array `_nodes` if it exists, otherwise it returns `null`.
      * @returns The `peek()` method returns the first element of the data structure, represented by the `_nodes` array at
      * the `_offset` index. If the data structure is empty (size is 0), it returns `null`.
      */
     peek(): E | undefined;
     /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The `getLast` function returns the last element in an array-like data structure, or null if the structure is empty.
      * @returns The method `getLast()` returns the last element of the `_nodes` array if the array is not empty. If the
      * array is empty, it returns `null`.
      */
     getLast(): E | undefined;
     /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The `peekLast` function returns the last element in an array-like data structure, or null if the structure is empty.
      * @returns The method `peekLast()` returns the last element of the `_nodes` array if the array is not empty. If the
      * array is empty, it returns `null`.
      */
     peekLast(): E | undefined;
     /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the current offset.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The enqueue function adds a value to the end of a queue.
      * @param {E} value - The value parameter represents the value that you want to add to the queue.
      */
     enqueue(value: E): void;
     /**
+     * Time Complexity: O(n) - same as shift().
+     * Space Complexity: O(1) - same as shift().
+     */
+    /**
+     * Time Complexity: O(n) - same as shift().
+     * Space Complexity: O(1) - same as shift().
+     *
      * The `dequeue` function removes and returns the first element from a queue, or returns null if the queue is empty.
      * @returns The method is returning a value of type E or null.
      */
     dequeue(): E | undefined;
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+     * Space Complexity: O(1) - no additional space is used.
+     *
+     * @param index
+     */
     getAt(index: number): E | undefined;
     /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+     * Space Complexity: O(1) - no additional space is used.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it retrieves the value at the specified index.
+     * Space Complexity: O(1) - no additional space is used.
+     *
      * The function checks if a data structure is empty by comparing its size to zero.
      * @returns {boolean} A boolean value indicating whether the size of the object is 0 or not.
      */
     isEmpty(): boolean;
     /**
+     * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
+     * Space Complexity: O(n) - where n is the number of elements in the queue.
+     */
+    /**
+     * Time Complexity: O(1) - constant time as it returns a shallow copy of the internal array.
+     * Space Complexity: O(n) - where n is the number of elements in the queue.
+     *
      * The toArray() function returns an array of elements from the current offset to the end of the _nodes array.
      * @returns An array of type E is being returned.
      */
@@ -114,6 +194,13 @@ export declare class Queue<E = any> {
      */
     clear(): void;
     /**
+     * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
+     * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+     */
+    /**
+     * Time Complexity: O(n) - where n is the number of elements in the queue. It creates a shallow copy of the internal array.
+     * Space Complexity: O(n) - the space required is proportional to the number of elements in the queue.
+     *
      * The `clone()` function returns a new Queue object with the same elements as the original Queue.
      * @returns The `clone()` method is returning a new instance of the `Queue` class.
      */