data-structure-typed 2.5.3 → 2.6.1

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

@@ -5,7 +5,6 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-
 import type { ElementCallback, LinearBaseOptions, QueueOptions } from '../../types';
 import { SinglyLinkedList } from '../linked-list';
 import { LinearBase } from '../base/linear-base';
@@ -96,7 +95,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param [options] - Options such as toElementFn, maxLen, and autoCompactRatio.
    * @returns New Queue instance.
    */
-
   constructor(elements: Iterable<E> | Iterable<R> = [], options?: QueueOptions<E, R>) {
     super(options);
     if (options) {
@@ -113,7 +111,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(1), Space O(1)
    * @returns Backing array of elements.
    */
-
   get elements(): E[] {
     return this._elements;
   }
@@ -125,7 +122,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(1), Space O(1)
    * @returns Zero-based offset.
    */
-
   get offset(): number {
     return this._offset;
   }
@@ -137,7 +133,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(1), Space O(1)
    * @returns Auto-compaction ratio in (0,1].
    */
-
   get autoCompactRatio(): number {
     return this._autoCompactRatio;
   }
@@ -148,7 +143,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param value - New ratio; compacts when offset/size exceeds this value.
    * @returns void
    */
-
   set autoCompactRatio(value: number) {
     this._autoCompactRatio = value;
   }
@@ -157,54 +151,14 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * Get the number of elements currently in the queue.
    * @remarks Time O(1), Space O(1)
    * @returns Current length.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Track queue length
- *  const q = new Queue<number>();
- *     console.log(q.length); // 0;
- *     q.push(1);
- *     q.push(2);
- *     console.log(q.length); // 2;
+   * @example
+   * // Track queue length
+   *  const q = new Queue<number>();
+   *     console.log(q.length); // 0;
+   *     q.push(1);
+   *     q.push(2);
+   *     console.log(q.length); // 2;
    */
-
   get length(): number {
     return this.elements.length - this._offset;
   }
@@ -213,71 +167,21 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * Get the first element (front) without removing it.
    * @remarks Time O(1), Space O(1)
    * @returns Front element or undefined.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // View the front element
- *  const q = new Queue<string>(['first', 'second', 'third']);
- *     console.log(q.first); // 'first';
- *     console.log(q.length); // 3;
+   * @example
+   * // View the front element
+   *  const q = new Queue<string>(['first', 'second', 'third']);
+   *     console.log(q.first); // 'first';
+   *     console.log(q.length); // 3;
    */
-
   get first(): E | undefined {
     return this.length > 0 ? this.elements[this._offset] : undefined;
   }
 
-  /**
-   * 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 {
-    return this.first;
-  }
-
   /**
    * Get the last element (back) without removing it.
    * @remarks Time O(1), Space O(1)
    * @returns Back element or undefined.
    */
-
   get last(): E | undefined {
     return this.length > 0 ? this.elements[this.elements.length - 1] : undefined;
   }
@@ -289,74 +193,42 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param elements - Array of elements to enqueue in order.
    * @returns A new queue populated from the array.
    */
-
   static fromArray<E>(elements: E[]): Queue<E> {
     return new Queue(elements);
   }
 
+  /**
+   * 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 {
+    return this.first;
+  }
+
   /**
    * Check whether the queue is empty.
    * @remarks Time O(1), Space O(1)
    * @returns True if length is 0.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Queue for...of iteration and isEmpty check
- *  const queue = new Queue<string>(['A', 'B', 'C', 'D']);
- *
- *     const elements: string[] = [];
- *     for (const item of queue) {
- *       elements.push(item);
- *     }
- *
- *     // Verify all elements are iterated in order
- *     console.log(elements); // ['A', 'B', 'C', 'D'];
- *
- *     // Process all elements
- *     while (queue.length > 0) {
- *       queue.shift();
- *     }
- *
- *     console.log(queue.length); // 0;
+   * @example
+   * // Queue for...of iteration and isEmpty check
+   *  const queue = new Queue<string>(['A', 'B', 'C', 'D']);
+   *
+   *     const elements: string[] = [];
+   *     for (const item of queue) {
+   *       elements.push(item);
+   *     }
+   *
+   *     // Verify all elements are iterated in order
+   *     console.log(elements); // ['A', 'B', 'C', 'D'];
+   *
+   *     // Process all elements
+   *     while (queue.length > 0) {
+   *       queue.shift();
+   *     }
+   *
+   *     console.log(queue.length); // 0;
    */
-
   isEmpty(): boolean {
     return this.length === 0;
   }
@@ -366,57 +238,17 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(1), Space O(1)
    * @param element - Element to enqueue.
    * @returns True on success.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // basic Queue creation and push operation
- *  // Create a simple Queue with initial values
- *     const queue = new Queue([1, 2, 3, 4, 5]);
- *
- *     // Verify the queue maintains insertion order
- *     console.log([...queue]); // [1, 2, 3, 4, 5];
- *
- *     // Check length
- *     console.log(queue.length); // 5;
+   * @example
+   * // basic Queue creation and push operation
+   *  // Create a simple Queue with initial values
+   *     const queue = new Queue([1, 2, 3, 4, 5]);
+   *
+   *     // Verify the queue maintains insertion order
+   *     console.log([...queue]); // [1, 2, 3, 4, 5];
+   *
+   *     // Check length
+   *     console.log(queue.length); // 5;
    */
-
   push(element: E): boolean {
     this.elements.push(element);
     if (this._maxLen > 0 && this.length > this._maxLen) this.shift();
@@ -429,7 +261,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param elements - Iterable of elements (or raw records if toElementFn is set).
    * @returns Array of per-element success flags.
    */
-
   pushMany(elements: Iterable<E> | Iterable<R>): boolean[] {
     const ans: boolean[] = [];
     for (const el of elements) {
@@ -443,61 +274,21 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * Dequeue one element from the front (amortized via offset).
    * @remarks Time O(1) amortized, Space O(1)
    * @returns Removed element or undefined.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Queue shift and peek operations
- *  const queue = new Queue<number>([10, 20, 30, 40]);
- *
- *     // Peek at the front element without removing it
- *     console.log(queue.first); // 10;
- *
- *     // Remove and get the first element (FIFO)
- *     const first = queue.shift();
- *     console.log(first); // 10;
- *
- *     // Verify remaining elements and length decreased
- *     console.log([...queue]); // [20, 30, 40];
- *     console.log(queue.length); // 3;
+   * @example
+   * // Queue shift and peek operations
+   *  const queue = new Queue<number>([10, 20, 30, 40]);
+   *
+   *     // Peek at the front element without removing it
+   *     console.log(queue.first); // 10;
+   *
+   *     // Remove and get the first element (FIFO)
+   *     const first = queue.shift();
+   *     console.log(first); // 10;
+   *
+   *     // Verify remaining elements and length decreased
+   *     console.log([...queue]); // [20, 30, 40];
+   *     console.log(queue.length); // 3;
    */
-
   shift(): E | undefined {
     if (this.length === 0) return undefined;
     const first = this.first;
@@ -511,49 +302,12 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(N), Space O(1)
    * @param element - Element to remove (strict equality via Object.is).
    * @returns True if an element was removed.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Remove specific element
- *  const q = new Queue<number>([1, 2, 3, 2]);
- *     q.delete(2);
- *     console.log(q.length); // 3;
+   * @example
+   * // Remove specific element
+   *  const q = new Queue<number>([1, 2, 3, 2]);
+   *     q.delete(2);
+   *     console.log(q.length); // 3;
    */
-
   delete(element: E): boolean {
     for (let i = this._offset; i < this.elements.length; i++) {
       if (Object.is(this.elements[i], element)) {
@@ -569,49 +323,12 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(1), Space O(1)
    * @param index - Zero-based index from the front.
    * @returns Element or undefined.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Access element by index
- *  const q = new Queue<string>(['a', 'b', 'c']);
- *     console.log(q.at(0)); // 'a';
- *     console.log(q.at(2)); // 'c';
+   * @example
+   * // Access element by index
+   *  const q = new Queue<string>(['a', 'b', 'c']);
+   *     console.log(q.at(0)); // 'a';
+   *     console.log(q.at(2)); // 'c';
    */
-
   at(index: number): E | undefined {
     if (index < 0 || index >= this.length) return undefined;
     return this._elements[this._offset + index];
@@ -623,7 +340,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param index - Zero-based index from the front.
    * @returns Removed element or undefined.
    */
-
   deleteAt(index: number): E | undefined {
     if (index < 0 || index >= this.length) return undefined;
     const gi = this._offset + index;
@@ -638,7 +354,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param newElement - Element to insert.
    * @returns True if inserted.
    */
-
   addAt(index: number, newElement: E): boolean {
     if (index < 0 || index > this.length) return false;
     this._elements.splice(this._offset + index, 0, newElement);
@@ -652,7 +367,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param newElement - New element to set.
    * @returns True if updated.
    */
-
   setAt(index: number, newElement: E): boolean {
     if (index < 0 || index >= this.length) return false;
     this._elements[this._offset + index] = newElement;
@@ -680,7 +394,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(N), Space O(N)
    * @returns This queue.
    */
-
   reverse(): this {
     this._elements = this.elements.slice(this._offset).reverse();
     this._offset = 0;
@@ -691,50 +404,12 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * Remove all elements and reset offset.
    * @remarks Time O(1), Space O(1)
    * @returns void
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Remove all elements
- *  const q = new Queue<number>([1, 2, 3]);
- *     q.clear();
- *     console.log(q.length); // 0;
+   * @example
+   * // Remove all elements
+   *  const q = new Queue<number>([1, 2, 3]);
+   *     q.clear();
+   *     console.log(q.length); // 0;
    */
-
   clear(): void {
     this._elements = [];
     this._offset = 0;
@@ -744,51 +419,14 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * Compact storage by discarding consumed head elements.
    * @remarks Time O(N), Space O(N)
    * @returns True when compaction performed.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Reclaim unused memory
- *  const q = new Queue<number>([1, 2, 3, 4, 5]);
- *     q.shift();
- *     q.shift();
- *     q.compact();
- *     console.log(q.length); // 3;
+   * @example
+   * // Reclaim unused memory
+   *  const q = new Queue<number>([1, 2, 3, 4, 5]);
+   *     q.shift();
+   *     q.shift();
+   *     q.compact();
+   *     console.log(q.length); // 3;
    */
-
   compact(): boolean {
     this._elements = this.elements.slice(this._offset);
     this._offset = 0;
@@ -803,20 +441,15 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param [items] - Elements to insert after `start`.
    * @returns A new queue containing the removed elements (typed as `this`).
    */
-
   override splice(start: number, deleteCount: number = 0, ...items: E[]): this {
     start = Math.max(0, Math.min(start, this.length));
     deleteCount = Math.max(0, Math.min(deleteCount, this.length - start));
-
     const gi = this._offset + start;
     const removedArray = this._elements.splice(gi, deleteCount, ...items);
-
     if (this.elements.length > 0 && this.offset / this.elements.length > this.autoCompactRatio) this.compact();
-
     const removed = this._createInstance({ toElementFn: this.toElementFn, maxLen: this._maxLen });
     removed._setAutoCompactRatio(this._autoCompactRatio);
     removed.pushMany(removedArray);
-
     return removed as unknown as this;
   }
 
@@ -824,52 +457,14 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * Deep clone this queue and its parameters.
    * @remarks Time O(N), Space O(N)
    * @returns A new queue with the same content and options.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Create independent copy
- *  const q = new Queue<number>([1, 2, 3]);
- *     const copy = q.clone();
- *     copy.shift();
- *     console.log(q.length); // 3;
- *     console.log(copy.length); // 2;
+   * @example
+   * // Create independent copy
+   *  const q = new Queue<number>([1, 2, 3]);
+   *     const copy = q.clone();
+   *     copy.shift();
+   *     console.log(q.length); // 3;
+   *     console.log(copy.length); // 2;
    */
-
   clone(): this {
     const out = this._createInstance({ toElementFn: this.toElementFn, maxLen: this._maxLen });
     out._setAutoCompactRatio(this._autoCompactRatio);
@@ -883,50 +478,12 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param predicate - Predicate (element, index, queue) → boolean to keep element.
    * @param [thisArg] - Value for `this` inside the predicate.
    * @returns A new queue with kept elements.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Filter elements
- *  const q = new Queue<number>([1, 2, 3, 4, 5]);
- *     const evens = q.filter(x => x % 2 === 0);
- *     console.log(evens.length); // 2;
+   * @example
+   * // Filter elements
+   *  const q = new Queue<number>([1, 2, 3, 4, 5]);
+   *     const evens = q.filter(x => x % 2 === 0);
+   *     console.log(evens.length); // 2;
    */
-
   filter(predicate: ElementCallback<E, R, boolean>, thisArg?: unknown): this {
     const out = this._createInstance({ toElementFn: this.toElementFn, maxLen: this._maxLen });
     out._setAutoCompactRatio(this._autoCompactRatio);
@@ -947,49 +504,12 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param [options] - Options for the output queue (e.g., toElementFn, maxLen, autoCompactRatio).
    * @param [thisArg] - Value for `this` inside the callback.
    * @returns A new Queue with mapped elements.
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-   
-    * @example
- * // Transform elements
- *  const q = new Queue<number>([1, 2, 3]);
- *     const doubled = q.map(x => x * 2);
- *     console.log(doubled.toArray()); // [2, 4, 6];
+   * @example
+   * // Transform elements
+   *  const q = new Queue<number>([1, 2, 3]);
+   *     const doubled = q.map(x => x * 2);
+   *     console.log(doubled.toArray()); // [2, 4, 6];
    */
-
   map<EM, RM>(callback: ElementCallback<E, R, EM>, options?: QueueOptions<EM, RM>, thisArg?: unknown): Queue<EM, RM> {
     const out = new (this.constructor as new (
       elements?: Iterable<EM> | Iterable<RM>,
@@ -1012,7 +532,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param [thisArg] - Value for `this` inside the callback.
    * @returns A new queue with mapped elements (same element type).
    */
-
   mapSame(callback: ElementCallback<E, R, E>, thisArg?: unknown): this {
     const Ctor = this.constructor as new (
       elements?: Iterable<E> | Iterable<R>,
@@ -1038,7 +557,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param value - New ratio to assign.
    * @returns void
    */
-
   protected _setAutoCompactRatio(value: number): void {
     this._autoCompactRatio = value;
   }
@@ -1048,7 +566,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(N), Space O(1)
    * @returns Iterator of E.
    */
-
   protected *_getIterator(): IterableIterator<E> {
     for (let i = this._offset; i < this.elements.length; i++) yield this.elements[i];
   }
@@ -1058,7 +575,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @remarks Time O(N), Space O(1)
    * @returns Iterator of E.
    */
-
   protected *_getReverseIterator(): IterableIterator<E> {
     for (let i = this.length - 1; i >= 0; i--) {
       const cur = this.at(i);
@@ -1072,7 +588,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param [options] - Options forwarded to the constructor.
    * @returns An empty like-kind queue instance.
    */
-
   protected override _createInstance(options?: LinearBaseOptions<E, R>): this {
     const Ctor = this.constructor as new (elements?: Iterable<E> | Iterable<R>, options?: QueueOptions<E, R>) => this;
     return new Ctor([], options as QueueOptions<E, R> | undefined);
@@ -1087,7 +602,6 @@ export class Queue<E = any, R = any> extends LinearBase<E, R> {
    * @param [options] - Options forwarded to the constructor.
    * @returns A like-kind Queue instance.
    */
-
   protected _createLike<EM = E, RM = R>(
     elements: Iterable<EM> | Iterable<RM> = [],
     options?: QueueOptions<EM, RM>
@@ -1113,7 +627,6 @@ export class LinkedListQueue<E = any, R = any> extends SinglyLinkedList<E, R> {
    * @remarks Time O(N), Space O(N)
    * @returns A new queue with the same sequence of elements.
    */
-
   override clone(): this {
     const out = this._createInstance({ toElementFn: this.toElementFn, maxLen: this._maxLen });
     for (const v of this) out.push(v);