deque-typed 2.4.5 → 2.5.0

package/dist/esm/index.mjs

@@ -9,55 +9,6 @@ var rangeCheck = /* @__PURE__ */ __name((index, min, max, message) => {
 }, "rangeCheck");
 var calcMinUnitsRequired = /* @__PURE__ */ __name((totalQuantity, unitSize) => Math.floor((totalQuantity + unitSize - 1) / unitSize), "calcMinUnitsRequired");
 
-// src/common/error.ts
-var ERR = {
-  // Range / index
-  indexOutOfRange: /* @__PURE__ */ __name((index, min, max, ctx) => `${ctx ? ctx + ": " : ""}Index ${index} is out of range [${min}, ${max}].`, "indexOutOfRange"),
-  invalidIndex: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Index must be an integer.`, "invalidIndex"),
-  // Type / argument
-  invalidArgument: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidArgument"),
-  comparatorRequired: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Comparator is required for non-number/non-string/non-Date keys.`, "comparatorRequired"),
-  invalidKey: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidKey"),
-  notAFunction: /* @__PURE__ */ __name((name, ctx) => `${ctx ? ctx + ": " : ""}${name} must be a function.`, "notAFunction"),
-  invalidEntry: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Each entry must be a [key, value] tuple.`, "invalidEntry"),
-  invalidNaN: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}NaN is not a valid key.`, "invalidNaN"),
-  invalidDate: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Invalid Date key.`, "invalidDate"),
-  reduceEmpty: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Reduce of empty structure with no initial value.`, "reduceEmpty"),
-  callbackReturnType: /* @__PURE__ */ __name((expected, got, ctx) => `${ctx ? ctx + ": " : ""}Callback must return ${expected}; got ${got}.`, "callbackReturnType"),
-  // State / operation
-  invalidOperation: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidOperation"),
-  // Matrix
-  matrixDimensionMismatch: /* @__PURE__ */ __name((op) => `Matrix: Dimensions must be compatible for ${op}.`, "matrixDimensionMismatch"),
-  matrixSingular: /* @__PURE__ */ __name(() => "Matrix: Singular matrix, inverse does not exist.", "matrixSingular"),
-  matrixNotSquare: /* @__PURE__ */ __name(() => "Matrix: Must be square for inversion.", "matrixNotSquare"),
-  matrixNotRectangular: /* @__PURE__ */ __name(() => "Matrix: Must be rectangular for transposition.", "matrixNotRectangular"),
-  matrixRowMismatch: /* @__PURE__ */ __name((expected, got) => `Matrix: Expected row length ${expected}, but got ${got}.`, "matrixRowMismatch")
-};
-
-// src/common/index.ts
-var DFSOperation = /* @__PURE__ */ ((DFSOperation2) => {
-  DFSOperation2[DFSOperation2["VISIT"] = 0] = "VISIT";
-  DFSOperation2[DFSOperation2["PROCESS"] = 1] = "PROCESS";
-  return DFSOperation2;
-})(DFSOperation || {});
-var Range = class {
-  constructor(low, high, includeLow = true, includeHigh = true) {
-    this.low = low;
-    this.high = high;
-    this.includeLow = includeLow;
-    this.includeHigh = includeHigh;
-  }
-  static {
-    __name(this, "Range");
-  }
-  // Determine whether a key is within the range
-  isInRange(key, comparator) {
-    const lowCheck = this.includeLow ? comparator(key, this.low) >= 0 : comparator(key, this.low) > 0;
-    const highCheck = this.includeHigh ? comparator(key, this.high) <= 0 : comparator(key, this.high) < 0;
-    return lowCheck && highCheck;
-  }
-};
-
 // src/data-structures/base/iterable-element-base.ts
 var IterableElementBase = class {
   static {
@@ -76,7 +27,7 @@ var IterableElementBase = class {
     if (options) {
       const { toElementFn } = options;
       if (typeof toElementFn === "function") this._toElementFn = toElementFn;
-      else if (toElementFn) throw new TypeError(ERR.notAFunction("toElementFn"));
+      else if (toElementFn) throw new TypeError("toElementFn must be a function type");
     }
   }
   /**
@@ -239,7 +190,7 @@ var IterableElementBase = class {
       acc = initialValue;
     } else {
       const first = iter.next();
-      if (first.done) throw new TypeError(ERR.reduceEmpty());
+      if (first.done) throw new TypeError("Reduce of empty structure with no initial value");
       acc = first.value;
       index = 1;
     }
@@ -599,19 +550,60 @@ var Deque = class extends LinearBase {
     return this._length;
   }
   /**
-   * Get the first element without removing it.
-   * @remarks Time O(1), Space O(1)
-   * @returns First element or undefined.
-   */
+    * 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;
+    */
   get first() {
     if (this._length === 0) return;
     return this._buckets[this._bucketFirst][this._firstInBucket];
   }
   /**
-   * Get the last element without removing it.
-   * @remarks Time O(1), Space O(1)
-   * @returns Last element or 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';
+    */
   get last() {
     if (this._length === 0) return;
     return this._buckets[this._bucketLast][this._lastInBucket];
@@ -630,11 +622,40 @@ var Deque = class extends LinearBase {
     return new this(data, options);
   }
   /**
-   * Append one element at the back.
-   * @remarks Time O(1) amortized, Space O(1)
-   * @param element - Element to append.
-   * @returns True when appended.
-   */
+    * 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;
+    */
   push(element) {
     if (this._length) {
       if (this._lastInBucket < this._bucketSize - 1) {
@@ -654,10 +675,26 @@ var Deque = class extends LinearBase {
     return true;
   }
   /**
-   * Remove and return the last element.
-   * @remarks Time O(1), Space O(1)
-   * @returns Removed element or undefined.
-   */
+    * 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;
+    */
   pop() {
     if (this._length === 0) return;
     const element = this._buckets[this._bucketLast][this._lastInBucket];
@@ -677,10 +714,26 @@ var Deque = class extends LinearBase {
     return element;
   }
   /**
-   * Remove and return the first element.
-   * @remarks Time O(1) amortized, Space O(1)
-   * @returns Removed element or 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;
+    */
   shift() {
     if (this._length === 0) return;
     const element = this._buckets[this._bucketFirst][this._firstInBucket];
@@ -700,11 +753,37 @@ var Deque = class extends LinearBase {
     return element;
   }
   /**
-   * Prepend one element at the front.
-   * @remarks Time O(1) amortized, Space O(1)
-   * @param element - Element to prepend.
-   * @returns True when prepended.
-   */
+    * Prepend one element at the front.
+    * @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;
+    */
   unshift(element) {
     if (this._length) {
       if (this._firstInBucket > 0) {
@@ -758,18 +837,45 @@ var Deque = class extends LinearBase {
     return ans;
   }
   /**
-   * Check whether the deque is empty.
-   * @remarks Time O(1), Space O(1)
-   * @returns True if length is 0.
-   */
+    * 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;
+    */
   isEmpty() {
     return this._length === 0;
   }
   /**
-   * Remove all elements and reset structure.
-   * @remarks Time O(1), Space O(1)
-   * @returns void
-   */
+    * 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;
+    */
   clear() {
     this._buckets = [new Array(this._bucketSize)];
     this._bucketCount = 1;
@@ -777,11 +883,24 @@ var Deque = class extends LinearBase {
     this._firstInBucket = this._lastInBucket = this._bucketSize >> 1;
   }
   /**
-   * Get the element at a given position.
-   * @remarks Time O(1), Space O(1)
-   * @param pos - Zero-based position from the front.
-   * @returns Element or undefined.
-   */
+    * Get the element at a given position.
+    * @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';
+    */
   at(pos) {
     if (pos < 0 || pos >= this._length) return void 0;
     const { bucketIndex, indexInBucket } = this._getBucketAndPosition(pos);
@@ -940,11 +1059,24 @@ var Deque = class extends LinearBase {
     }
   }
   /**
-   * Delete the first occurrence of a value.
-   * @remarks Time O(N), Space O(1)
-   * @param element - Element to remove (using the configured equality).
-   * @returns True if an element was removed.
-   */
+    * Delete the first occurrence of a value.
+    * @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;
+    */
   delete(element) {
     const size = this._length;
     if (size === 0) return false;
@@ -988,10 +1120,39 @@ var Deque = class extends LinearBase {
     return this;
   }
   /**
-   * Reverse the deque by reversing buckets and pointers.
-   * @remarks Time O(N), Space O(N)
-   * @returns This deque.
-   */
+    * 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'];
+    */
   reverse() {
     this._buckets.reverse().forEach(function(bucket) {
       bucket.reverse();
@@ -1050,10 +1211,25 @@ var Deque = class extends LinearBase {
    * @returns True if compaction was performed (bucket count reduced).
    */
   /**
-   * Compact the deque by removing unused buckets.
-   * @remarks Time O(N), Space O(1)
-   * @returns True if compaction was performed (bucket count reduced).
-   */
+    * 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;
+    */
   compact() {
     const before = this._bucketCount;
     this.shrinkToFit();
@@ -1081,10 +1257,26 @@ var Deque = class extends LinearBase {
     this._compactCounter = 0;
   }
   /**
-   * Deep clone this deque, preserving options.
-   * @remarks Time O(N), Space O(N)
-   * @returns A new deque with the same content and options.
-   */
+    * 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;
+    */
   clone() {
     return this._createLike(this, {
       bucketSize: this.bucketSize,
@@ -1093,12 +1285,26 @@ var Deque = class extends LinearBase {
     });
   }
   /**
-   * Filter elements into a new deque of the same class.
-   * @remarks Time O(N), Space O(N)
-   * @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.
-   */
+    * Filter elements into a new deque of the same class.
+    * @remarks Time O(N), Space O(N)
+    * @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;
+    */
   filter(predicate, thisArg) {
     const out = this._createInstance({ toElementFn: this.toElementFn, maxLen: this._maxLen });
     out._setBucketSize(this._bucketSize);
@@ -1127,15 +1333,28 @@ var Deque = class extends LinearBase {
     return out;
   }
   /**
-   * Map elements into a new deque (possibly different element type).
-   * @remarks Time O(N), Space O(N)
-   * @template EM
-   * @template RM
-   * @param callback - Mapping function (value, index, deque) → newElement.
-   * @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.
-   */
+    * Map elements into a new deque (possibly different element type).
+    * @remarks Time O(N), Space O(N)
+    * @template EM
+    * @template RM
+    * @param callback - Mapping function (value, index, deque) → newElement.
+    * @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];
+    */
   map(callback, options, thisArg) {
     const out = this._createLike([], {
       ...options ?? {},
@@ -1258,6 +1477,55 @@ var Deque = class extends LinearBase {
     }
   }
 };
+
+// src/common/error.ts
+var ERR = {
+  // Range / index
+  indexOutOfRange: /* @__PURE__ */ __name((index, min, max, ctx) => `${ctx ? ctx + ": " : ""}Index ${index} is out of range [${min}, ${max}].`, "indexOutOfRange"),
+  invalidIndex: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Index must be an integer.`, "invalidIndex"),
+  // Type / argument
+  invalidArgument: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidArgument"),
+  comparatorRequired: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Comparator is required for non-number/non-string/non-Date keys.`, "comparatorRequired"),
+  invalidKey: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidKey"),
+  notAFunction: /* @__PURE__ */ __name((name, ctx) => `${ctx ? ctx + ": " : ""}${name} must be a function.`, "notAFunction"),
+  invalidEntry: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Each entry must be a [key, value] tuple.`, "invalidEntry"),
+  invalidNaN: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}NaN is not a valid key.`, "invalidNaN"),
+  invalidDate: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Invalid Date key.`, "invalidDate"),
+  reduceEmpty: /* @__PURE__ */ __name((ctx) => `${ctx ? ctx + ": " : ""}Reduce of empty structure with no initial value.`, "reduceEmpty"),
+  callbackReturnType: /* @__PURE__ */ __name((expected, got, ctx) => `${ctx ? ctx + ": " : ""}Callback must return ${expected}; got ${got}.`, "callbackReturnType"),
+  // State / operation
+  invalidOperation: /* @__PURE__ */ __name((reason, ctx) => `${ctx ? ctx + ": " : ""}${reason}`, "invalidOperation"),
+  // Matrix
+  matrixDimensionMismatch: /* @__PURE__ */ __name((op) => `Matrix: Dimensions must be compatible for ${op}.`, "matrixDimensionMismatch"),
+  matrixSingular: /* @__PURE__ */ __name(() => "Matrix: Singular matrix, inverse does not exist.", "matrixSingular"),
+  matrixNotSquare: /* @__PURE__ */ __name(() => "Matrix: Must be square for inversion.", "matrixNotSquare"),
+  matrixNotRectangular: /* @__PURE__ */ __name(() => "Matrix: Must be rectangular for transposition.", "matrixNotRectangular"),
+  matrixRowMismatch: /* @__PURE__ */ __name((expected, got) => `Matrix: Expected row length ${expected}, but got ${got}.`, "matrixRowMismatch")
+};
+
+// src/common/index.ts
+var DFSOperation = /* @__PURE__ */ ((DFSOperation2) => {
+  DFSOperation2[DFSOperation2["VISIT"] = 0] = "VISIT";
+  DFSOperation2[DFSOperation2["PROCESS"] = 1] = "PROCESS";
+  return DFSOperation2;
+})(DFSOperation || {});
+var Range = class {
+  constructor(low, high, includeLow = true, includeHigh = true) {
+    this.low = low;
+    this.high = high;
+    this.includeLow = includeLow;
+    this.includeHigh = includeHigh;
+  }
+  static {
+    __name(this, "Range");
+  }
+  // Determine whether a key is within the range
+  isInRange(key, comparator) {
+    const lowCheck = this.includeLow ? comparator(key, this.low) >= 0 : comparator(key, this.low) > 0;
+    const highCheck = this.includeHigh ? comparator(key, this.high) <= 0 : comparator(key, this.high) < 0;
+    return lowCheck && highCheck;
+  }
+};
 /**
  * data-structure-typed
  *