data-structure-typed 2.6.1 → 2.6.2

package/dist/esm-legacy/stack.mjs

@@ -271,8 +271,8 @@ var _Stack = class _Stack extends IterableElementBase {
    */
   constructor(elements = [], options) {
     super(options);
-    __publicField(this, "_equals", /* @__PURE__ */ __name((a, b) => Object.is(a, b), "_equals"));
     __publicField(this, "_elements", []);
+    __publicField(this, "_equals", /* @__PURE__ */ __name((a, b) => Object.is(a, b), "_equals"));
     this.pushMany(elements);
   }
   /**
@@ -284,54 +284,14 @@ var _Stack = class _Stack extends IterableElementBase {
     return this._elements;
   }
   /**
-    * Get the number of stored elements.
-    * @remarks Time O(1), Space O(1)
-    * @returns Current size.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Get number of elements
-  *  const stack = new Stack<number>([1, 2, 3]);
-  *     console.log(stack.size); // 3;
-    */
+   * Get the number of stored elements.
+   * @remarks Time O(1), Space O(1)
+   * @returns Current size.
+   * @example
+   * // Get number of elements
+   *  const stack = new Stack<number>([1, 2, 3]);
+   *     console.log(stack.size); // 3;
+   */
   get size() {
     return this.elements.length;
   }
@@ -349,247 +309,79 @@ var _Stack = class _Stack extends IterableElementBase {
     return new this(elements, options);
   }
   /**
-    * Check whether the stack is empty.
-    * @remarks Time O(1), Space O(1)
-    * @returns True if size is 0.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Check if stack has elements
-  *  const stack = new Stack<number>();
-  *     console.log(stack.isEmpty()); // true;
-  *     stack.push(1);
-  *     console.log(stack.isEmpty()); // false;
-    */
+   * Check whether the stack is empty.
+   * @remarks Time O(1), Space O(1)
+   * @returns True if size is 0.
+   * @example
+   * // Check if stack has elements
+   *  const stack = new Stack<number>();
+   *     console.log(stack.isEmpty()); // true;
+   *     stack.push(1);
+   *     console.log(stack.isEmpty()); // false;
+   */
   isEmpty() {
     return this.elements.length === 0;
   }
   /**
-    * Get the top element without removing it.
-    * @remarks Time O(1), Space O(1)
-    * @returns Top element or undefined.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // View the top element without removing it
-  *  const stack = new Stack<string>(['a', 'b', 'c']);
-  *     console.log(stack.peek()); // 'c';
-  *     console.log(stack.size); // 3;
-    */
+   * Get the top element without removing it.
+   * @remarks Time O(1), Space O(1)
+   * @returns Top element or undefined.
+   * @example
+   * // View the top element without removing it
+   *  const stack = new Stack<string>(['a', 'b', 'c']);
+   *     console.log(stack.peek()); // 'c';
+   *     console.log(stack.size); // 3;
+   */
   peek() {
     return this.isEmpty() ? void 0 : this.elements[this.elements.length - 1];
   }
   /**
-    * Push one element onto the top.
-    * @remarks Time O(1), Space O(1)
-    * @param element - Element to push.
-    * @returns True when pushed.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // basic Stack creation and push operation
-  *  // Create a simple Stack with initial values
-  *     const stack = new Stack([1, 2, 3, 4, 5]);
-  *
-  *     // Verify the stack maintains insertion order (LIFO will be shown in pop)
-  *     console.log([...stack]); // [1, 2, 3, 4, 5];
-  *
-  *     // Check length
-  *     console.log(stack.size); // 5;
-  *
-  *     // Push a new element to the top
-  *     stack.push(6);
-  *     console.log(stack.size); // 6;
-    */
+   * Push one element onto the top.
+   * @remarks Time O(1), Space O(1)
+   * @param element - Element to push.
+   * @returns True when pushed.
+   * @example
+   * // basic Stack creation and push operation
+   *  // Create a simple Stack with initial values
+   *     const stack = new Stack([1, 2, 3, 4, 5]);
+   *
+   *     // Verify the stack maintains insertion order (LIFO will be shown in pop)
+   *     console.log([...stack]); // [1, 2, 3, 4, 5];
+   *
+   *     // Check length
+   *     console.log(stack.size); // 5;
+   *
+   *     // Push a new element to the top
+   *     stack.push(6);
+   *     console.log(stack.size); // 6;
+   */
   push(element) {
     this.elements.push(element);
     return true;
   }
   /**
-    * Pop and return the top element.
-    * @remarks Time O(1), Space O(1)
-    * @returns Removed element or undefined.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Stack pop operation (LIFO - Last In First Out)
-  *  const stack = new Stack<number>([10, 20, 30, 40, 50]);
-  *
-  *     // Peek at the top element without removing
-  *     const top = stack.peek();
-  *     console.log(top); // 50;
-  *
-  *     // Pop removes from the top (LIFO order)
-  *     const popped = stack.pop();
-  *     console.log(popped); // 50;
-  *
-  *     // Next pop gets the previous element
-  *     const next = stack.pop();
-  *     console.log(next); // 40;
-  *
-  *     // Verify length decreased
-  *     console.log(stack.size); // 3;
-    */
+   * Pop and return the top element.
+   * @remarks Time O(1), Space O(1)
+   * @returns Removed element or undefined.
+   * @example
+   * // Stack pop operation (LIFO - Last In First Out)
+   *  const stack = new Stack<number>([10, 20, 30, 40, 50]);
+   *
+   *     // Peek at the top element without removing
+   *     const top = stack.peek();
+   *     console.log(top); // 50;
+   *
+   *     // Pop removes from the top (LIFO order)
+   *     const popped = stack.pop();
+   *     console.log(popped); // 50;
+   *
+   *     // Next pop gets the previous element
+   *     const next = stack.pop();
+   *     console.log(next); // 40;
+   *
+   *     // Verify length decreased
+   *     console.log(stack.size); // 3;
+   */
   pop() {
     return this.isEmpty() ? void 0 : this.elements.pop();
   }
@@ -608,55 +400,16 @@ var _Stack = class _Stack extends IterableElementBase {
     return ans;
   }
   /**
-    * Delete the first occurrence of a specific element.
-    * @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 stack = new Stack<number>([1, 2, 3]);
-  *     stack.delete(2);
-  *     console.log(stack.toArray()); // [1, 3];
-    */
+   * Delete the first occurrence of a specific element.
+   * @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 stack = new Stack<number>([1, 2, 3]);
+   *     stack.delete(2);
+   *     console.log(stack.toArray()); // [1, 3];
+   */
   delete(element) {
     const idx = this._indexOfByEquals(element);
     return this.deleteAt(idx) !== void 0;
@@ -688,167 +441,47 @@ var _Stack = class _Stack extends IterableElementBase {
     return false;
   }
   /**
-    * Remove all elements and reset storage.
-    * @remarks Time O(1), Space O(1)
-    * @returns void
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Remove all elements
-  *  const stack = new Stack<number>([1, 2, 3]);
-  *     stack.clear();
-  *     console.log(stack.isEmpty()); // true;
-    */
+   * Remove all elements and reset storage.
+   * @remarks Time O(1), Space O(1)
+   * @returns void
+   * @example
+   * // Remove all elements
+   *  const stack = new Stack<number>([1, 2, 3]);
+   *     stack.clear();
+   *     console.log(stack.isEmpty()); // true;
+   */
   clear() {
     this._elements = [];
   }
   /**
-    * Deep clone this stack.
-    * @remarks Time O(N), Space O(N)
-    * @returns A new stack with the same content.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Create independent copy
-  *  const stack = new Stack<number>([1, 2, 3]);
-  *     const copy = stack.clone();
-  *     copy.pop();
-  *     console.log(stack.size); // 3;
-  *     console.log(copy.size); // 2;
-    */
+   * Deep clone this stack.
+   * @remarks Time O(N), Space O(N)
+   * @returns A new stack with the same content.
+   * @example
+   * // Create independent copy
+   *  const stack = new Stack<number>([1, 2, 3]);
+   *     const copy = stack.clone();
+   *     copy.pop();
+   *     console.log(stack.size); // 3;
+   *     console.log(copy.size); // 2;
+   */
   clone() {
     const out = this._createInstance({ toElementFn: this.toElementFn });
     for (const v of this) out.push(v);
     return out;
   }
   /**
-    * Filter elements into a new stack of the same class.
-    * @remarks Time O(N), Space O(N)
-    * @param predicate - Predicate (value, index, stack) → boolean to keep value.
-    * @param [thisArg] - Value for `this` inside the predicate.
-    * @returns A new stack with kept values.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Filter elements
-  *  const stack = new Stack<number>([1, 2, 3, 4, 5]);
-  *     const evens = stack.filter(x => x % 2 === 0);
-  *     console.log(evens.toArray()); // [2, 4];
-    */
+   * Filter elements into a new stack of the same class.
+   * @remarks Time O(N), Space O(N)
+   * @param predicate - Predicate (value, index, stack) → boolean to keep value.
+   * @param [thisArg] - Value for `this` inside the predicate.
+   * @returns A new stack with kept values.
+   * @example
+   * // Filter elements
+   *  const stack = new Stack<number>([1, 2, 3, 4, 5]);
+   *     const evens = stack.filter(x => x % 2 === 0);
+   *     console.log(evens.toArray()); // [2, 4];
+   */
   filter(predicate, thisArg) {
     const out = this._createInstance({ toElementFn: this.toElementFn });
     let index = 0;
@@ -875,59 +508,20 @@ var _Stack = class _Stack extends IterableElementBase {
     return out;
   }
   /**
-    * Map values into a new stack (possibly different element type).
-    * @remarks Time O(N), Space O(N)
-    * @template EM
-    * @template RM
-    * @param callback - Mapping function (value, index, stack) → newElement.
-    * @param [options] - Options for the output stack (e.g., toElementFn).
-    * @param [thisArg] - Value for `this` inside the callback.
-    * @returns A new Stack with mapped elements.
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
-     * @example
-  * // Transform elements
-  *  const stack = new Stack<number>([1, 2, 3]);
-  *     const doubled = stack.map(x => x * 2);
-  *     console.log(doubled.toArray()); // [2, 4, 6];
-    */
+   * Map values into a new stack (possibly different element type).
+   * @remarks Time O(N), Space O(N)
+   * @template EM
+   * @template RM
+   * @param callback - Mapping function (value, index, stack) → newElement.
+   * @param [options] - Options for the output stack (e.g., toElementFn).
+   * @param [thisArg] - Value for `this` inside the callback.
+   * @returns A new Stack with mapped elements.
+   * @example
+   * // Transform elements
+   *  const stack = new Stack<number>([1, 2, 3]);
+   *     const doubled = stack.map(x => x * 2);
+   *     console.log(doubled.toArray()); // [2, 4, 6];
+   */
   map(callback, options, thisArg) {
     const out = this._createLike([], { ...options != null ? options : {} });
     let index = 0;