data-structure-typed 2.6.1 → 2.6.2

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

@@ -74,7 +74,11 @@ import { LinearBase } from '../base/linear-base';
  *     console.log(dq.toArray()); // [10, 20, 30];
  */
 export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
-    protected _equals: (a: E, b: E) => boolean;
+    /**
+     * Counter for shift/pop operations since last compaction check.
+     * Only checks ratio every `_bucketSize` operations to minimize overhead.
+     */
+    protected _compactCounter: number;
     /**
      * Create a Deque and optionally bulk-insert elements.
      * @remarks Time O(N), Space O(N)
@@ -108,11 +112,6 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @param value - Ratio in [0,1]. 0 disables auto-compact.
      */
     set autoCompactRatio(value: number);
-    /**
-     * Counter for shift/pop operations since last compaction check.
-     * Only checks ratio every `_bucketSize` operations to minimize overhead.
-     */
-    protected _compactCounter: number;
     protected _bucketFirst: number;
     /**
      * Get the index of the first bucket in use.
@@ -163,140 +162,32 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      */
     get length(): number;
     /**
-     * Get the first element without removing it.
-     * @remarks Time O(1), Space O(1)
-     * @returns First element or undefined.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Deque peek at both ends
-   *  const deque = new Deque<number>([10, 20, 30, 40, 50]);
-   *
-   *     // Get first element without removing
-   *     const first = deque.at(0);
-   *     console.log(first); // 10;
-   *
-   *     // Get last element without removing
-   *     const last = deque.at(deque.length - 1);
-   *     console.log(last); // 50;
-   *
-   *     // Length unchanged
-   *     console.log(deque.length); // 5;
-     */
-    /**
-     * Peek at the front element without removing it (alias for `first`).
-     * @remarks Time O(1), Space O(1)
-     * @returns Front element or undefined.
+     * Deque peek at both ends
+     * @example
+     * // Deque peek at both ends
+     *  const deque = new Deque<number>([10, 20, 30, 40, 50]);
+     *
+     *     // Get first element without removing
+     *     const first = deque.at(0);
+     *     console.log(first); // 10;
+     *
+     *     // Get last element without removing
+     *     const last = deque.at(deque.length - 1);
+     *     console.log(last); // 50;
+     *
+     *     // Length unchanged
+     *     console.log(deque.length); // 5;
      */
-    peek(): E | undefined;
-    /**
-   * Deque peek at both ends
-  
-   
-   
-    * @example
- * // Deque peek at both ends
- *  const deque = new Deque<number>([10, 20, 30, 40, 50]);
- *
- *     // Get first element without removing
- *     const first = deque.at(0);
- *     console.log(first); // 10;
- *
- *     // Get last element without removing
- *     const last = deque.at(deque.length - 1);
- *     console.log(last); // 50;
- *
- *     // Length unchanged
- *     console.log(deque.length); // 5;
-   */
     get first(): E | undefined;
     /**
      * Get the last element without removing it.
      * @remarks Time O(1), Space O(1)
      * @returns Last element or undefined.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Peek at the back element
-   *  const dq = new Deque<string>(['a', 'b', 'c']);
-   *     console.log(dq.last); // 'c';
-   *     console.log(dq.first); // 'a';
+     * @example
+     * // Peek at the back element
+     *  const dq = new Deque<string>(['a', 'b', 'c']);
+     *     console.log(dq.last); // 'c';
+     *     console.log(dq.first); // 'a';
      */
     get last(): E | undefined;
     /**
@@ -310,177 +201,76 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @returns A new Deque populated from the array.
      */
     static fromArray<E, R = any>(this: new (elements?: IterableWithSizeOrLength<E> | IterableWithSizeOrLength<R>, options?: DequeOptions<E, R>) => any, data: E[], options?: DequeOptions<E, R>): any;
+    /**
+     * Get the first element without removing it.
+     * @remarks Time O(1), Space O(1)
+     * @returns First element or undefined.
+     * @example
+     * // Deque peek at both ends
+     *  const deque = new Deque<number>([10, 20, 30, 40, 50]);
+     *
+     *     // Get first element without removing
+     *     const first = deque.at(0);
+     *     console.log(first); // 10;
+     *
+     *     // Get last element without removing
+     *     const last = deque.at(deque.length - 1);
+     *     console.log(last); // 50;
+     *
+     *     // Length unchanged
+     *     console.log(deque.length); // 5;
+     */
+    /**
+     * Peek at the front element without removing it (alias for `first`).
+     * @remarks Time O(1), Space O(1)
+     * @returns Front element or undefined.
+     */
+    peek(): E | undefined;
     /**
      * Append one element at the back.
      * @remarks Time O(1) amortized, Space O(1)
      * @param element - Element to append.
      * @returns True when appended.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // basic Deque creation and push/pop operations
-   *  // Create a simple Deque with initial values
-   *     const deque = new Deque([1, 2, 3, 4, 5]);
-   *
-   *     // Verify the deque maintains insertion order
-   *     console.log([...deque]); // [1, 2, 3, 4, 5];
-   *
-   *     // Check length
-   *     console.log(deque.length); // 5;
-   *
-   *     // Push to the end
-   *     deque.push(6);
-   *     console.log(deque.length); // 6;
-   *
-   *     // Pop from the end
-   *     const last = deque.pop();
-   *     console.log(last); // 6;
+     * @example
+     * // basic Deque creation and push/pop operations
+     *  // Create a simple Deque with initial values
+     *     const deque = new Deque([1, 2, 3, 4, 5]);
+     *
+     *     // Verify the deque maintains insertion order
+     *     console.log([...deque]); // [1, 2, 3, 4, 5];
+     *
+     *     // Check length
+     *     console.log(deque.length); // 5;
+     *
+     *     // Push to the end
+     *     deque.push(6);
+     *     console.log(deque.length); // 6;
+     *
+     *     // Pop from the end
+     *     const last = deque.pop();
+     *     console.log(last); // 6;
      */
     push(element: E): boolean;
     /**
      * Remove and return the last element.
      * @remarks Time O(1), Space O(1)
      * @returns Removed element or undefined.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Remove from the back
-   *  const dq = new Deque<number>([1, 2, 3]);
-   *     console.log(dq.pop()); // 3;
-   *     console.log(dq.length); // 2;
+     * @example
+     * // Remove from the back
+     *  const dq = new Deque<number>([1, 2, 3]);
+     *     console.log(dq.pop()); // 3;
+     *     console.log(dq.length); // 2;
      */
     pop(): E | undefined;
     /**
      * Remove and return the first element.
      * @remarks Time O(1) amortized, Space O(1)
      * @returns Removed element or undefined.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Remove from the front
-   *  const dq = new Deque<number>([1, 2, 3]);
-   *     console.log(dq.shift()); // 1;
-   *     console.log(dq.length); // 2;
+     * @example
+     * // Remove from the front
+     *  const dq = new Deque<number>([1, 2, 3]);
+     *     console.log(dq.shift()); // 1;
+     *     console.log(dq.length); // 2;
      */
     shift(): E | undefined;
     /**
@@ -488,63 +278,21 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @remarks Time O(1) amortized, Space O(1)
      * @param element - Element to prepend.
      * @returns True when prepended.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Deque shift and unshift operations
-   *  const deque = new Deque<number>([20, 30, 40]);
-   *
-   *     // Unshift adds to the front
-   *     deque.unshift(10);
-   *     console.log([...deque]); // [10, 20, 30, 40];
-   *
-   *     // Shift removes from the front (O(1) complexity!)
-   *     const first = deque.shift();
-   *     console.log(first); // 10;
-   *
-   *     // Verify remaining elements
-   *     console.log([...deque]); // [20, 30, 40];
-   *     console.log(deque.length); // 3;
+     * @example
+     * // Deque shift and unshift operations
+     *  const deque = new Deque<number>([20, 30, 40]);
+     *
+     *     // Unshift adds to the front
+     *     deque.unshift(10);
+     *     console.log([...deque]); // [10, 20, 30, 40];
+     *
+     *     // Shift removes from the front (O(1) complexity!)
+     *     const first = deque.shift();
+     *     console.log(first); // 10;
+     *
+     *     // Verify remaining elements
+     *     console.log([...deque]); // [20, 30, 40];
+     *     console.log(deque.length); // 3;
      */
     unshift(element: E): boolean;
     /**
@@ -565,101 +313,21 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * Check whether the deque is empty.
      * @remarks Time O(1), Space O(1)
      * @returns True if length is 0.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Check if empty
-   *  const dq = new Deque();
-   *     console.log(dq.isEmpty()); // true;
+     * @example
+     * // Check if empty
+     *  const dq = new Deque();
+     *     console.log(dq.isEmpty()); // true;
      */
     isEmpty(): boolean;
     /**
      * Remove all elements and reset structure.
      * @remarks Time O(1), Space O(1)
      * @returns void
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Remove all elements
-   *  const dq = new Deque<number>([1, 2, 3]);
-   *     dq.clear();
-   *     console.log(dq.length); // 0;
+     * @example
+     * // Remove all elements
+     *  const dq = new Deque<number>([1, 2, 3]);
+     *     dq.clear();
+     *     console.log(dq.length); // 0;
      */
     clear(): void;
     /**
@@ -667,50 +335,11 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @remarks Time O(1), Space O(1)
      * @param pos - Zero-based position from the front.
      * @returns Element or undefined.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Access by index
-   *  const dq = new Deque<string>(['a', 'b', 'c']);
-   *     console.log(dq.at(0)); // 'a';
-   *     console.log(dq.at(2)); // 'c';
+     * @example
+     * // Access by index
+     *  const dq = new Deque<string>(['a', 'b', 'c']);
+     *     console.log(dq.at(0)); // 'a';
+     *     console.log(dq.at(2)); // 'c';
      */
     at(pos: number): E | undefined;
     /**
@@ -767,50 +396,11 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @remarks Time O(N), Space O(1)
      * @param element - Element to remove (using the configured equality).
      * @returns True if an element was removed.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Remove element
-   *  const dq = new Deque<number>([1, 2, 3]);
-   *     dq.delete(2);
-   *     console.log(dq.length); // 2;
+     * @example
+     * // Remove element
+     *  const dq = new Deque<number>([1, 2, 3]);
+     *     dq.delete(2);
+     *     console.log(dq.length); // 2;
      */
     delete(element: E): boolean;
     /**
@@ -831,74 +421,35 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * Reverse the deque by reversing buckets and pointers.
      * @remarks Time O(N), Space O(N)
      * @returns This deque.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Deque for...of iteration and reverse
-   *  const deque = new Deque<string>(['A', 'B', 'C', 'D']);
-   *
-   *     // Iterate forward
-   *     const forward: string[] = [];
-   *     for (const item of deque) {
-   *       forward.push(item);
-   *     }
-   *     console.log(forward); // ['A', 'B', 'C', 'D'];
-   *
-   *     // Reverse the deque
-   *     deque.reverse();
-   *     const backward: string[] = [];
-   *     for (const item of deque) {
-   *       backward.push(item);
-   *     }
-   *     console.log(backward); // ['D', 'C', 'B', 'A'];
+     * @example
+     * // Deque for...of iteration and reverse
+     *  const deque = new Deque<string>(['A', 'B', 'C', 'D']);
+     *
+     *     // Iterate forward
+     *     const forward: string[] = [];
+     *     for (const item of deque) {
+     *       forward.push(item);
+     *     }
+     *     console.log(forward); // ['A', 'B', 'C', 'D'];
+     *
+     *     // Reverse the deque
+     *     deque.reverse();
+     *     const backward: string[] = [];
+     *     for (const item of deque) {
+     *       backward.push(item);
+     *     }
+     *     console.log(backward); // ['D', 'C', 'B', 'A'];
      */
     /**
      * Find the last value matching a predicate (scans back-to-front).
      * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1).
      * @param predicate - Function called with (value, index, deque).
      * @returns Matching value or undefined.
-      * @example
-   * // Find last matching value
-   *  const d = new Deque([1, 2, 3, 4, 5]);
-   *     console.log(d.findLast(v => v > 2)); // 5;
-   *     console.log(d.findLast(v => v % 2 === 0)); // 4;
+     * @example
+     * // Find last matching value
+     *  const d = new Deque([1, 2, 3, 4, 5]);
+     *     console.log(d.findLast(v => v > 2)); // 5;
+     *     console.log(d.findLast(v => v % 2 === 0)); // 4;
      */
     findLast(predicate: (value: E, index: number, deque: this) => boolean): E | undefined;
     /**
@@ -906,36 +457,34 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1).
      * @param predicate - Function called with (value, index, deque).
      * @returns Matching index, or -1 if not found.
-      * @example
-   * // Find last matching index
-   *  const d = new Deque([10, 20, 30, 20, 10]);
-   *     console.log(d.findLastIndex(v => v === 20)); // 3;
-   *     console.log(d.findLastIndex(v => v === 10)); // 4;
+     * @example
+     * // Find last matching index
+     *  const d = new Deque([10, 20, 30, 20, 10]);
+     *     console.log(d.findLastIndex(v => v === 20)); // 3;
+     *     console.log(d.findLastIndex(v => v === 10)); // 4;
      */
     findLastIndex(predicate: (value: E, index: number, deque: this) => boolean): number;
     /**
-   * Deque for...of iteration and reverse
-  
-   
-    * @example
- * // Deque for...of iteration and reverse
- *  const deque = new Deque<string>(['A', 'B', 'C', 'D']);
- *
- *     // Iterate forward
- *     const forward: string[] = [];
- *     for (const item of deque) {
- *       forward.push(item);
- *     }
- *     console.log(forward); // ['A', 'B', 'C', 'D'];
- *
- *     // Reverse the deque
- *     deque.reverse();
- *     const backward: string[] = [];
- *     for (const item of deque) {
- *       backward.push(item);
- *     }
- *     console.log(backward); // ['D', 'C', 'B', 'A'];
-   */
+     * Deque for...of iteration and reverse
+     * @example
+     * // Deque for...of iteration and reverse
+     *  const deque = new Deque<string>(['A', 'B', 'C', 'D']);
+     *
+     *     // Iterate forward
+     *     const forward: string[] = [];
+     *     for (const item of deque) {
+     *       forward.push(item);
+     *     }
+     *     console.log(forward); // ['A', 'B', 'C', 'D'];
+     *
+     *     // Reverse the deque
+     *     deque.reverse();
+     *     const backward: string[] = [];
+     *     for (const item of deque) {
+     *       backward.push(item);
+     *     }
+     *     console.log(backward); // ['D', 'C', 'B', 'A'];
+     */
     reverse(): this;
     /**
      * Deduplicate consecutive equal elements in-place.
@@ -943,17 +492,6 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @returns This deque.
      */
     unique(): this;
-    /**
-     * Trim unused buckets to fit exactly the active range.
-     * @remarks Time O(N), Space O(1)
-     * @returns void
-     */
-    /**
-     * (Protected) Trigger auto-compaction if space utilization drops below threshold.
-     * Only checks every `_bucketSize` operations to minimize hot-path overhead.
-     * Uses element-based ratio: `elements / (bucketCount * bucketSize)`.
-     */
-    protected _autoCompact(): void;
     /**
      * Compact the deque by removing unused buckets.
      * @remarks Time O(N), Space O(1)
@@ -963,52 +501,13 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * Compact the deque by removing unused buckets.
      * @remarks Time O(N), Space O(1)
      * @returns True if compaction was performed (bucket count reduced).
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Reclaim memory
-   *  const dq = new Deque<number>([1, 2, 3, 4, 5]);
-   *     dq.shift();
-   *     dq.shift();
-   *     dq.compact();
-   *     console.log(dq.length); // 3;
+     * @example
+     * // Reclaim memory
+     *  const dq = new Deque<number>([1, 2, 3, 4, 5]);
+     *     dq.shift();
+     *     dq.shift();
+     *     dq.compact();
+     *     console.log(dq.length); // 3;
      */
     compact(): boolean;
     shrinkToFit(): void;
@@ -1016,53 +515,13 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * Deep clone this deque, preserving options.
      * @remarks Time O(N), Space O(N)
      * @returns A new deque with the same content and options.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Create independent copy
-   *  const dq = new Deque<number>([1, 2, 3]);
-   *     const copy = dq.clone();
-   *     copy.pop();
-   *     console.log(dq.length); // 3;
-   *     console.log(copy.length); // 2;
+     * @example
+     * // Create independent copy
+     *  const dq = new Deque<number>([1, 2, 3]);
+     *     const copy = dq.clone();
+     *     copy.pop();
+     *     console.log(dq.length); // 3;
+     *     console.log(copy.length); // 2;
      */
     clone(): this;
     /**
@@ -1071,51 +530,11 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @param predicate - Predicate (value, index, deque) → boolean to keep element.
      * @param [thisArg] - Value for `this` inside the predicate.
      * @returns A new deque with kept elements.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Filter elements
-   *  const dq = new Deque<number>([1, 2, 3, 4]);
-   *     const result = dq.filter(x => x > 2);
-   *     console.log(result.length); // 2;
+     * @example
+     * // Filter elements
+     *  const dq = new Deque<number>([1, 2, 3, 4]);
+     *     const result = dq.filter(x => x > 2);
+     *     console.log(result.length); // 2;
      */
     filter(predicate: ElementCallback<E, R, boolean>, thisArg?: unknown): this;
     /**
@@ -1135,52 +554,25 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @param [options] - Options for the output deque (e.g., bucketSize, toElementFn, maxLen).
      * @param [thisArg] - Value for `this` inside the callback.
      * @returns A new Deque with mapped elements.
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-     
-      * @example
-   * // Transform elements
-   *  const dq = new Deque<number>([1, 2, 3]);
-   *     const result = dq.map(x => x * 10);
-   *     console.log(result.toArray()); // [10, 20, 30];
+     * @example
+     * // Transform elements
+     *  const dq = new Deque<number>([1, 2, 3]);
+     *     const result = dq.map(x => x * 10);
+     *     console.log(result.toArray()); // [10, 20, 30];
      */
     map<EM, RM>(callback: ElementCallback<E, R, EM>, options?: IterableElementBaseOptions<EM, RM>, thisArg?: unknown): Deque<EM, RM>;
+    protected _equals: (a: E, b: E) => boolean;
+    /**
+     * Trim unused buckets to fit exactly the active range.
+     * @remarks Time O(N), Space O(1)
+     * @returns void
+     */
+    /**
+     * (Protected) Trigger auto-compaction if space utilization drops below threshold.
+     * Only checks every `_bucketSize` operations to minimize hot-path overhead.
+     * Uses element-based ratio: `elements / (bucketCount * bucketSize)`.
+     */
+    protected _autoCompact(): void;
     /**
      * (Protected) Set the internal bucket size.
      * @remarks Time O(1), Space O(1)