min-heap-typed 1.50.2 → 1.50.3

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

@@ -17,13 +17,6 @@ import { calcMinUnitsRequired, rangeCheck } from '../../utils';
  * 5. Performance jitter: Deque may experience performance jitter, but DoublyLinkedList will not
  */
 export class Deque<E> extends IterableElementBase<E> {
-  protected _bucketFirst = 0;
-  protected _firstInBucket = 0;
-  protected _bucketLast = 0;
-  protected _lastInBucket = 0;
-  protected _bucketCount = 0;
-  protected readonly _bucketSize: number = 1 << 12;
-
   /**
    * The constructor initializes a Deque object with an optional iterable of elements and options.
    * @param elements - An iterable object (such as an array or a Set) that contains the initial
@@ -65,6 +58,8 @@ export class Deque<E> extends IterableElementBase<E> {
     }
   }
 
+  protected _bucketSize: number = 1 << 12;
+
   /**
    * The bucketSize function returns the size of the bucket.
    *
@@ -74,11 +69,62 @@ export class Deque<E> extends IterableElementBase<E> {
     return this._bucketSize;
   }
 
+  protected _bucketFirst = 0;
+
+  /**
+   * The function returns the value of the protected variable `_bucketFirst`.
+   * @returns The value of the `_bucketFirst` property.
+   */
+  get bucketFirst(): number {
+    return this._bucketFirst;
+  }
+
+  protected _firstInBucket = 0;
+
+  /**
+   * The function returns the value of the protected variable _firstInBucket.
+   * @returns The method is returning the value of the variable `_firstInBucket`, which is of type
+   * `number`.
+   */
+  get firstInBucket(): number {
+    return this._firstInBucket;
+  }
+
+  protected _bucketLast = 0;
+
+  /**
+   * The function returns the value of the protected variable `_bucketLast`.
+   * @returns The value of the `_bucketLast` property, which is a number.
+   */
+  get bucketLast(): number {
+    return this._bucketLast;
+  }
+
+  protected _lastInBucket = 0;
+
+  /**
+   * The function returns the value of the protected variable _lastInBucket.
+   * @returns The method is returning the value of the variable `_lastInBucket`, which is of type
+   * `number`.
+   */
+  get lastInBucket(): number {
+    return this._lastInBucket;
+  }
+
+  protected _bucketCount = 0;
+
+  /**
+   * The function returns the number of buckets.
+   * @returns The number of buckets.
+   */
+  get bucketCount(): number {
+    return this._bucketCount;
+  }
+
   protected _buckets: E[][] = [];
 
   /**
    * The buckets function returns the buckets property of the object.
-   *
    * @return The buckets property
    */
   get buckets() {
@@ -243,15 +289,30 @@ export class Deque<E> extends IterableElementBase<E> {
   }
 
   /**
-   * Time Complexity: O(1) - Removes the last element.
-   * Space Complexity: O(1) - Operates in-place.
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    */
 
+  /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   *
+   * The function checks if the size of an object is equal to zero and returns a boolean value.
+   * @returns A boolean value indicating whether the size of the object is 0 or not.
+   */
   isEmpty(): boolean {
     return this.size === 0;
   }
 
   /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   */
+
+  /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   *
    * The clear() function resets the state of the object by initializing all variables to their default
    * values.
    */
@@ -405,6 +466,26 @@ export class Deque<E> extends IterableElementBase<E> {
     }
   }
 
+  /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1) or O(n)
+   */
+
+  /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1) or O(n)
+   *
+   * The `cutRest` function cuts the elements from a specified position in a deque and returns a new
+   * deque with the cut elements.
+   * @param {number} pos - The `pos` parameter represents the position from which to cut the Deque. It
+   * is a number that indicates the index of the element in the Deque where the cut should start.
+   * @param [isCutSelf=false] - isCutSelf is a boolean parameter that determines whether the original
+   * Deque should be modified or a new Deque should be created. If isCutSelf is true, the original
+   * Deque will be modified by cutting off elements starting from the specified position. If isCutSelf
+   * is false, a new De
+   * @returns The function `cutRest` returns either the modified original deque (`this`) or a new deque
+   * (`newDeque`) depending on the value of the `isCutSelf` parameter.
+   */
   cutRest(pos: number, isCutSelf = false): Deque<E> {
     if (isCutSelf) {
       if (pos < 0) {
@@ -429,12 +510,12 @@ export class Deque<E> extends IterableElementBase<E> {
 
   /**
    * Time Complexity: O(n)
-   * Space Complexity: O(1)
+   * Space Complexity: O(1) or O(n)
    */
 
   /**
    * Time Complexity: O(n)
-   * Space Complexity: O(1)
+   * Space Complexity: O(1) or O(n)
    *
    * The `deleteAt` function removes an element at a specified position in an array-like data
    * structure.
@@ -736,8 +817,8 @@ export class Deque<E> extends IterableElementBase<E> {
    */
 
   /**
-   * Time Complexity: O(1)
-   * Space Complexity: O(n) - In worst case, resizing doubles the array size.
+   * Time Complexity: Amortized O(1) - Similar to push, resizing leads to O(n).
+   * Space Complexity: O(n) - Due to potential resizing.
    *
    * The addLast function adds an element to the end of an array.
    * @param {E} element - The element parameter represents the element that you want to add to the end of the
@@ -748,13 +829,13 @@ export class Deque<E> extends IterableElementBase<E> {
   }
 
   /**
-   * Time Complexity: O(1) - Removes the first element.
-   * Space Complexity: O(1) - In-place operation.
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    */
 
   /**
-   * Time Complexity: O(1) - Removes the last element.
-   * Space Complexity: O(1) - Operates in-place.
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    *
    * The function "pollLast" removes and returns the last element of an array.
    * @returns The last element of the array is being returned.
@@ -764,8 +845,13 @@ export class Deque<E> extends IterableElementBase<E> {
   }
 
   /**
-   * Time Complexity: O(1).
-   * Space Complexity: O(n) - Due to potential resizing.
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   * /
+
+   /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    *
    * The "addFirst" function adds an element to the beginning of an array.
    * @param {E} element - The parameter "element" represents the element that you want to add to the
@@ -776,8 +862,13 @@ export class Deque<E> extends IterableElementBase<E> {
   }
 
   /**
-   * Time Complexity: O(1) - Removes the first element.
-   * Space Complexity: O(1) - In-place operation.
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   * /
+
+   /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    *
    * The function "pollFirst" removes and returns the first element of an array.
    * @returns The method `pollFirst()` is returning the first element of the array after removing it
@@ -788,6 +879,11 @@ export class Deque<E> extends IterableElementBase<E> {
   }
 
   /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(1)
+   * /
+
+   /**
    * Time Complexity: O(n)
    * Space Complexity: O(1)
    *

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

@@ -44,7 +44,7 @@ export class Queue<E = any> extends IterableElementBase<E> {
 
   /**
    * The offset function returns the offset of the current page.
-   * @return The value of the private variable _offset
+   * @return The value of the protected variable _offset
    */
   get offset(): number {
     return this._offset;
@@ -59,8 +59,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
+   */
+
+  /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    *
    * The `first` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
    * @returns The `get first()` method returns the first element of the data structure, represented by the `_elements` array at
@@ -71,13 +76,13 @@ export class Queue<E = any> extends IterableElementBase<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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * The `last` function returns the last element in an array-like data structure, or undefined if the structure is empty.
    * @returns The method `get last()` returns the last element of the `_elements` array if the array is not empty. If the
@@ -88,11 +93,14 @@ export class Queue<E = any> extends IterableElementBase<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)
+   * Space Complexity: O(n)
    */
 
   /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
    * The function "fromArray" creates a new Queue object from an array of elements.Creates a queue from an existing array.
    * @public
    * @static
@@ -105,13 +113,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * 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.
@@ -123,13 +131,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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(1)
+   * Space Complexity: O(1)
    *
    * The `shift` function removes and returns the first element in the queue, and adjusts the internal data structure if
    * necessary to optimize performance.
@@ -171,13 +179,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * The `peek` function returns the first element of the array `_elements` if it exists, otherwise it returns `undefined`.
    * @returns The `peek()` method returns the first element of the data structure, represented by the `_elements` array at
@@ -188,13 +196,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * The `peekLast` function returns the last element in an array-like data structure, or undefined if the structure is empty.
    * @returns The method `peekLast()` returns the last element of the `_elements` array if the array is not empty. If the
@@ -205,13 +213,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * 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.
@@ -221,13 +229,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * Time Complexity: O(n) - same as shift().
-   * Space Complexity: O(1) - same as shift().
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    */
 
   /**
-   * Time Complexity: O(n) - same as shift().
-   * Space Complexity: O(1) - same as shift().
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
    *
    * The `dequeue` function removes and returns the first element from a queue, or returns undefined if the queue is empty.
    * @returns The method is returning a value of type E or undefined.
@@ -237,13 +245,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * @param index
    */
@@ -252,13 +260,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * 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.
@@ -268,13 +276,13 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(n)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(n)
    *
    * The toArray() function returns an array of elements from the current offset to the end of the _elements array.
    * @returns An array of type E is being returned.
@@ -284,6 +292,14 @@ export class Queue<E = any> extends IterableElementBase<E> {
   }
 
   /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   */
+
+  /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   *
    * The clear function resets the elements array and offset to their initial values.
    */
   clear(): void {
@@ -345,6 +361,7 @@ export class Queue<E = any> extends IterableElementBase<E> {
    * Time Complexity: O(n)
    * Space Complexity: O(n)
    */
+
   /**
    * Time Complexity: O(n)
    * Space Complexity: O(n)
@@ -374,6 +391,12 @@ export class Queue<E = any> extends IterableElementBase<E> {
    * Space Complexity: O(n)
    */
 
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
+   * The function `_getIterator` returns an iterable iterator for the elements in the class.
+   */
   protected* _getIterator(): IterableIterator<E> {
     for (const item of this.elements) {
       yield item;

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

@@ -40,11 +40,6 @@ export class Stack<E = any> extends IterableElementBase<E> {
     return this._elements;
   }
 
-  /**
-   * 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 size() function returns the number of elements in an array.
    * @returns The size of the elements array.
@@ -54,8 +49,13 @@ export class Stack<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(n)
+   */
+
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
    *
    * 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`.
@@ -75,13 +75,13 @@ export class Stack<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * The `peek` function returns the last element of an array, or undefined if the array is empty.
    * @returns The `peek()` function returns the last element of the `_elements` array, or `undefined` if the array is empty.
@@ -93,13 +93,13 @@ export class Stack<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * 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.
@@ -111,13 +111,13 @@ export class Stack<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(1)
    *
    * The `pop` function removes and returns the last element from an array, or returns undefined 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
@@ -166,6 +166,14 @@ export class Stack<E = any> extends IterableElementBase<E> {
   }
 
   /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   */
+
+  /**
+   * Time Complexity: O(1)
+   * Space Complexity: O(1)
+   *
    * The clear function clears the elements array.
    */
   clear(): void {
@@ -173,13 +181,13 @@ export class Stack<E = any> extends IterableElementBase<E> {
   }
 
   /**
-   * 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)
+   * Space Complexity: O(n)
    */
 
   /**
-   * 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)
+   * Space Complexity: O(n)
    *
    * 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.
@@ -250,6 +258,14 @@ export class Stack<E = any> extends IterableElementBase<E> {
   }
 
   /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   */
+
+  /**
+   * Time Complexity: O(n)
+   * Space Complexity: O(n)
+   *
    * Custom iterator for the Stack class.
    * @returns An iterator object.
    */