min-heap-typed 1.42.8 → 1.43.0

package/src/data-structures/queue/deque.ts

@@ -50,6 +50,14 @@ export class ObjectDeque<E = 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.
@@ -67,6 +75,14 @@ export class ObjectDeque<E = number> {
   }
 
   /**
+   * 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.
    */
@@ -83,6 +99,14 @@ export class ObjectDeque<E = number> {
   }
 
   /**
+   * 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.
    */
@@ -96,6 +120,14 @@ export class ObjectDeque<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 in an array-like data structure if it exists.
    * @returns The element at the first position of the `_nodes` array.
    */
@@ -104,6 +136,14 @@ export class ObjectDeque<E = number> {
   }
 
   /**
+   * 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.
    */
@@ -118,6 +158,14 @@ export class ObjectDeque<E = number> {
   }
 
   /**
+   * 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.
    */
@@ -126,6 +174,14 @@ export class ObjectDeque<E = number> {
   }
 
   /**
+   * 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.
@@ -159,10 +215,14 @@ export class ArrayDeque<E> {
   }
 
   /**
-   * 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.
@@ -172,6 +232,14 @@ export class ArrayDeque<E> {
   }
 
   /**
+   * 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.
    */
@@ -180,6 +248,14 @@ export class ArrayDeque<E> {
   }
 
   /**
+   * 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.
@@ -189,10 +265,14 @@ export class ArrayDeque<E> {
   }
 
   /**
-   * 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
@@ -203,6 +283,14 @@ export class ArrayDeque<E> {
   }
 
   /**
+   * 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`.
@@ -212,6 +300,14 @@ export class ArrayDeque<E> {
   }
 
   /**
+   * 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.
    */
@@ -220,10 +316,14 @@ export class ArrayDeque<E> {
   }
 
   /**
-   * 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.
@@ -235,6 +335,14 @@ export class ArrayDeque<E> {
   }
 
   /**
+   * 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.
@@ -247,6 +355,14 @@ export class ArrayDeque<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
@@ -261,6 +377,14 @@ export class ArrayDeque<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/src/data-structures/queue/queue.ts

@@ -84,6 +84,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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.
@@ -94,6 +102,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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.
@@ -114,6 +130,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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`.
@@ -123,6 +147,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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`.
@@ -132,6 +164,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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`.
@@ -141,6 +181,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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`.
@@ -150,6 +198,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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.
    */
@@ -158,6 +214,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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.
    */
@@ -165,11 +229,30 @@ export class Queue<E = any> {
     return this.shift();
   }
 
+  /**
+   * 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 {
     return this.nodes[index];
   }
 
   /**
+   * 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.
    */
@@ -178,6 +261,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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.
    */
@@ -194,6 +285,14 @@ export class Queue<E = any> {
   }
 
   /**
+   * 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.
    */

package/src/data-structures/stack/stack.ts

@@ -21,6 +21,14 @@ export class Stack<E = any> {
   }
 
   /**
+   * Time Complexity: O(n), where n is the number of elements in the input array. Similar to the constructor, it requires iterating through each element.
+   * Space Complexity: O(n), as it creates a new stack with the elements from the input array.
+   */
+
+  /**
+   * Time Complexity: O(n), where n is the number of elements in the input array. Similar to the constructor, it requires iterating through each element.
+   * Space Complexity: O(n), as it creates a new stack with the elements from the input array.
+   *
    * The function "fromArray" creates a new Stack object from an array of elements.
    * @param {E[]} elements - The `elements` parameter is an array of elements of type `E`.
    * @returns {Stack} The method is returning a new instance of the Stack class, initialized with the elements from the input
@@ -47,6 +55,14 @@ export class Stack<E = any> {
   }
 
   /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   */
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   *
    * The `peek` function returns the last element of an array, or null if the array is empty.
    * @returns The `peek()` function returns the last element of the `_elements` array, or `null` if the array is empty.
    */
@@ -57,6 +73,14 @@ export class Stack<E = any> {
   }
 
   /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   */
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   *
    * The push function adds an element to the stack and returns the updated stack.
    * @param {E} element - The parameter "element" is of type E, which means it can be any data type.
    * @returns The `push` method is returning the updated `Stack<E>` object.
@@ -67,6 +91,14 @@ export class Stack<E = any> {
   }
 
   /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   */
+
+  /**
+   * Time Complexity: O(1), as it only involves accessing the last element of the array.
+   * Space Complexity: O(1), as it does not use any additional space.
+   *
    * The `pop` function removes and returns the last element from an array, or returns null if the array is empty.
    * @returns The `pop()` method is returning the last element of the array `_elements` if the array is not empty. If the
    * array is empty, it returns `null`.
@@ -78,6 +110,14 @@ export class Stack<E = any> {
   }
 
   /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   */
+
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
    * The toArray function returns a copy of the elements in an array.
    * @returns An array of type E.
    */
@@ -93,6 +133,14 @@ export class Stack<E = any> {
   }
 
   /**
+   * Time Complexity: O(n), where n is the number of elements in the stack, as it creates a new stack and copies all elements into it.
+   * Space Complexity: O(n), as it creates a new stack.
+   */
+
+  /**
+   * Time Complexity: O(n), where n is the number of elements in the stack, as it creates a new stack and copies all elements into it.
+   * Space Complexity: O(n), as it creates a new stack.
+   *
    * The `clone()` function returns a new `Stack` object with the same elements as the original stack.
    * @returns The `clone()` method is returning a new `Stack` object with a copy of the `_elements` array.
    */

package/src/data-structures/trie/trie.ts

@@ -49,6 +49,14 @@ export class Trie {
   }
 
   /**
+   * Time Complexity: O(M), where M is the length of the word being added.
+   * Space Complexity: O(M) - Each character in the word adds a TrieNode.
+   */
+
+  /**
+   * Time Complexity: O(M), where M is the length of the word being added.
+   * Space Complexity: O(M) - Each character in the word adds a TrieNode.
+   *
    * Add a word to the Trie structure.
    * @param {string} word - The word to add.
    * @returns {boolean} True if the word was successfully added.
@@ -69,6 +77,14 @@ export class Trie {
   }
 
   /**
+   * Time Complexity: O(M), where M is the length of the input word.
+   * Space Complexity: O(1) - Constant space.
+   */
+
+  /**
+   * Time Complexity: O(M), where M is the length of the input word.
+   * Space Complexity: O(1) - Constant space.
+   *
    * Check if the Trie contains a given word.
    * @param {string} word - The word to check for.
    * @returns {boolean} True if the word is present in the Trie.
@@ -85,6 +101,14 @@ export class Trie {
   }
 
   /**
+   * Time Complexity: O(M), where M is the length of the word being deleted.
+   * Space Complexity: O(M) - Due to the recursive DFS approach.
+   */
+
+  /**
+   * Time Complexity: O(M), where M is the length of the word being deleted.
+   * Space Complexity: O(M) - Due to the recursive DFS approach.
+   *
    * Remove a word from the Trie structure.
    * @param{string} word - The word to delete.
    * @returns {boolean} True if the word was successfully removed.
@@ -122,6 +146,16 @@ export class Trie {
     return isDeleted;
   }
 
+  /**
+   * Time Complexity: O(N), where N is the total number of nodes in the trie.
+   * Space Complexity: O(1) - Constant space.
+   */
+
+  /**
+   * Time Complexity: O(N), where N is the total number of nodes in the trie.
+   * Space Complexity: O(1) - Constant space.
+   *
+   */
   getHeight() {
     const beginRoot = this.root;
     let maxDepth = 0;
@@ -142,8 +176,15 @@ export class Trie {
     return maxDepth;
   }
 
-  // --- start additional methods ---
   /**
+   * Time Complexity: O(M), where M is the length of the input prefix.
+   * Space Complexity: O(1) - Constant space.
+   */
+
+  /**
+   * Time Complexity: O(M), where M is the length of the input prefix.
+   * Space Complexity: O(1) - Constant space.
+   *
    * Check if a given input string has an absolute prefix in the Trie, meaning it's not a complete word.
    * @param {string} input - The input string to check.
    * @returns {boolean} True if it's an absolute prefix in the Trie.
@@ -160,6 +201,14 @@ export class Trie {
   }
 
   /**
+   * Time Complexity: O(M), where M is the length of the input prefix.
+   * Space Complexity: O(1) - Constant space.
+   */
+
+  /**
+   * Time Complexity: O(M), where M is the length of the input prefix.
+   * Space Complexity: O(1) - Constant space.
+   *
    * Check if a given input string is a prefix of any existing word in the Trie, whether as an absolute prefix or a complete word.
    * @param {string} input - The input string representing the prefix to check.
    * @returns {boolean} True if it's a prefix in the Trie.
@@ -176,6 +225,14 @@ export class Trie {
   }
 
   /**
+   * Time Complexity: O(N), where N is the total number of nodes in the trie.
+   * Space Complexity: O(M), where M is the length of the input prefix.
+   */
+
+  /**
+   * Time Complexity: O(N), where N is the total number of nodes in the trie.
+   * Space Complexity: O(M), where M is the length of the input prefix.
+   *
    * Check if the input string is a common prefix in the Trie, meaning it's a prefix shared by all words in the Trie.
    * @param {string} input - The input string representing the common prefix to check for.
    * @returns {boolean} True if it's a common prefix in the Trie.
@@ -195,6 +252,14 @@ export class Trie {
   }
 
   /**
+   * Time Complexity: O(N), where N is the total number of nodes in the trie.
+   * Space Complexity: O(M), where M is the length of the longest common prefix.
+   */
+
+  /**
+   * Time Complexity: O(N), where N is the total number of nodes in the trie.
+   * Space Complexity: O(M), where M is the length of the longest common prefix.
+   *
    * Get the longest common prefix among all the words stored in the Trie.
    * @returns {string} The longest common prefix found in the Trie.
    */
@@ -211,6 +276,14 @@ export class Trie {
   }
 
   /**
+   * Time Complexity: O(K * L), where K is the number of words retrieved, and L is the average length of the words.
+   * Space Complexity: O(K * L) - The space required for the output array.
+   */
+
+  /**
+   * Time Complexity: O(K * L), where K is the number of words retrieved, and L is the average length of the words.
+   * Space Complexity: O(K * L) - The space required for the output array.
+   *
    * The `getAll` function returns an array of all words in a Trie data structure that start with a given prefix.
    * @param {string} prefix - The `prefix` parameter is a string that represents the prefix that we want to search for in the
    * trie. It is an optional parameter, so if no prefix is provided, it will default to an empty string.
@@ -251,12 +324,22 @@ export class Trie {
     return words;
   }
 
+  /**
+   * Time Complexity: O(M), where M is the length of the input string.
+   * Space Complexity: O(1) - Constant space.
+   */
+
+  /**
+   * Time Complexity: O(M), where M is the length of the input string.
+   * Space Complexity: O(1) - Constant space.
+   *
+   * @param str
+   * @protected
+   */
   protected _caseProcess(str: string) {
     if (!this._caseSensitive) {
       str = str.toLowerCase(); // Convert str to lowercase if case-insensitive
     }
     return str;
   }
-
-  // --- end additional methods ---
-}
+}