data-structure-typed 1.50.2 → 1.50.4

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

@@ -15,12 +15,6 @@ import { IterableElementBase } from '../base';
  * 5. Performance jitter: Deque may experience performance jitter, but DoublyLinkedList will not
  */
 export declare class Deque<E> extends IterableElementBase<E> {
-    protected _bucketFirst: number;
-    protected _firstInBucket: number;
-    protected _bucketLast: number;
-    protected _lastInBucket: number;
-    protected _bucketCount: number;
-    protected readonly _bucketSize: number;
     /**
      * 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
@@ -33,16 +27,48 @@ export declare class Deque<E> extends IterableElementBase<E> {
      * or is not a number
      */
     constructor(elements?: IterableWithSizeOrLength<E>, options?: DequeOptions);
+    protected _bucketSize: number;
     /**
      * The bucketSize function returns the size of the bucket.
      *
      * @return The size of the bucket
      */
     get bucketSize(): number;
+    protected _bucketFirst: number;
+    /**
+     * The function returns the value of the protected variable `_bucketFirst`.
+     * @returns The value of the `_bucketFirst` property.
+     */
+    get bucketFirst(): number;
+    protected _firstInBucket: number;
+    /**
+     * 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;
+    protected _bucketLast: number;
+    /**
+     * The function returns the value of the protected variable `_bucketLast`.
+     * @returns The value of the `_bucketLast` property, which is a number.
+     */
+    get bucketLast(): number;
+    protected _lastInBucket: number;
+    /**
+     * 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;
+    protected _bucketCount: number;
+    /**
+     * The function returns the number of buckets.
+     * @returns The number of buckets.
+     */
+    get bucketCount(): number;
     protected _buckets: E[][];
     /**
      * The buckets function returns the buckets property of the object.
-     *
      * @return The buckets property
      */
     get buckets(): E[][];
@@ -120,11 +146,25 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     shift(): E | undefined;
     /**
-     * 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;
     /**
+     * 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.
      */
@@ -204,14 +244,33 @@ export declare class Deque<E> extends IterableElementBase<E> {
      * @returns The method is returning the updated size of the data structure.
      */
     cut(pos: number, isCutSelf?: boolean): Deque<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?: boolean): Deque<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.
@@ -378,8 +437,8 @@ export declare class Deque<E> extends IterableElementBase<E> {
      * Space Complexity: O(n) - Due to potential resizing.
      */
     /**
-     * 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
@@ -387,20 +446,25 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     addLast(element: E): boolean;
     /**
-     * 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.
      */
     pollLast(): E | undefined;
     /**
-     * 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
@@ -408,8 +472,13 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     addFirst(element: E): boolean;
     /**
-     * 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
@@ -417,6 +486,11 @@ export declare class Deque<E> extends IterableElementBase<E> {
      */
     pollFirst(): E | undefined;
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     * /
+  
+     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
      *

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

@@ -8,12 +8,6 @@ import { calcMinUnitsRequired, rangeCheck } from '../../utils';
  * 5. Performance jitter: Deque may experience performance jitter, but DoublyLinkedList will not
  */
 export class Deque extends IterableElementBase {
-    _bucketFirst = 0;
-    _firstInBucket = 0;
-    _bucketLast = 0;
-    _lastInBucket = 0;
-    _bucketCount = 0;
-    _bucketSize = 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
@@ -56,6 +50,7 @@ export class Deque extends IterableElementBase {
             this.push(element);
         }
     }
+    _bucketSize = 1 << 12;
     /**
      * The bucketSize function returns the size of the bucket.
      *
@@ -64,10 +59,51 @@ export class Deque extends IterableElementBase {
     get bucketSize() {
         return this._bucketSize;
     }
+    _bucketFirst = 0;
+    /**
+     * The function returns the value of the protected variable `_bucketFirst`.
+     * @returns The value of the `_bucketFirst` property.
+     */
+    get bucketFirst() {
+        return this._bucketFirst;
+    }
+    _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() {
+        return this._firstInBucket;
+    }
+    _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() {
+        return this._bucketLast;
+    }
+    _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() {
+        return this._lastInBucket;
+    }
+    _bucketCount = 0;
+    /**
+     * The function returns the number of buckets.
+     * @returns The number of buckets.
+     */
+    get bucketCount() {
+        return this._bucketCount;
+    }
     _buckets = [];
     /**
      * The buckets function returns the buckets property of the object.
-     *
      * @return The buckets property
      */
     get buckets() {
@@ -233,13 +269,27 @@ export class Deque extends IterableElementBase {
         return element;
     }
     /**
-     * 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() {
         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.
      */
@@ -387,6 +437,25 @@ export class Deque extends IterableElementBase {
             return newDeque;
         }
     }
+    /**
+     * 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, isCutSelf = false) {
         if (isCutSelf) {
             if (pos < 0) {
@@ -409,11 +478,11 @@ export class Deque extends IterableElementBase {
     }
     /**
      * 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.
@@ -700,8 +769,8 @@ export class Deque extends IterableElementBase {
      * Space Complexity: O(n) - Due to potential resizing.
      */
     /**
-     * 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
@@ -711,12 +780,12 @@ export class Deque extends IterableElementBase {
         return this.push(element);
     }
     /**
-     * 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.
@@ -725,8 +794,13 @@ export class Deque extends IterableElementBase {
         return this.pop();
     }
     /**
-     * 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
@@ -736,8 +810,13 @@ export class Deque extends IterableElementBase {
         return this.unshift(element);
     }
     /**
-     * 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
@@ -747,6 +826,11 @@ export class Deque extends IterableElementBase {
         return this.shift();
     }
     /**
+     * Time Complexity: O(n)
+     * Space Complexity: O(1)
+     * /
+  
+     /**
      * Time Complexity: O(n)
      * Space Complexity: O(1)
      *

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

@@ -32,7 +32,7 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
     protected _offset: number;
     /**
      * 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;
     /**
@@ -41,8 +41,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     get size(): number;
     /**
-     * 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
@@ -50,12 +54,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     get first(): E | undefined;
     /**
-     * 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
@@ -63,10 +67,13 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     get last(): E | undefined;
     /**
-     * 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
@@ -76,12 +83,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     static fromArray<E>(elements: E[]): Queue<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.
@@ -89,12 +96,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     push(element: E): boolean;
     /**
-     * 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.
@@ -114,12 +121,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     deleteAt(index: number): boolean;
     /**
-     * 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
@@ -127,12 +134,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     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)
+     * 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
@@ -140,65 +147,72 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      */
     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)
+     * 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.
      */
     enqueue(value: E): boolean;
     /**
-     * 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.
      */
     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)
+     * 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
      */
     at(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)
+     * 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.
      */
     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)
+     * 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.
      */
     toArray(): 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;
@@ -259,6 +273,12 @@ export declare class Queue<E = any> extends IterableElementBase<E> {
      * Time Complexity: O(n)
      * 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>;
 }
 /**