max-priority-queue-typed 2.5.2 → 2.6.0

package/dist/types/data-structures/trie/trie.d.ts

@@ -245,6 +245,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -299,6 +306,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -348,6 +362,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -393,6 +414,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -437,6 +465,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -484,6 +519,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -556,6 +598,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -611,6 +660,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -660,6 +716,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -709,6 +772,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -755,6 +825,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -796,6 +873,13 @@ export declare class Trie<R = any> extends IterableElementBase<string, R> {
    
    
    
+   
+   
+   
+   
+   
+   
+   
    
    
    

package/dist/types/interfaces/binary-tree.d.ts

@@ -1,5 +1,5 @@
 import { BinaryTreeNode } from '../data-structures';
-import type { BinaryTreeDeleteResult, BinaryTreeOptions, BTNRep, DFSOrderPattern, EntryCallback, IterationType, NodeCallback, NodePredicate, OptNodeOrNull, ReduceEntryCallback, ToEntryFn } from '../types';
+import type { BinaryTreeOptions, BTNRep, DFSOrderPattern, EntryCallback, IterationType, NodeCallback, NodePredicate, OptNodeOrNull, ReduceEntryCallback, ToEntryFn } from '../types';
 /**
  * Public, implementation-agnostic binary tree API.
  * K = key, V = value, R = raw/record used with toEntryFn (optional).
@@ -19,7 +19,7 @@ export interface IBinaryTree<K = any, V = any, R = any> {
     add(keyOrNodeOrEntryOrRawElement: BTNRep<K, V, BinaryTreeNode<K, V>>, value?: V, count?: number): boolean;
     set(keyOrNodeOrEntryOrRawElement: BTNRep<K, V, BinaryTreeNode<K, V>>, value?: V, count?: number): boolean;
     addMany(keysNodesEntriesOrRaws: Iterable<K | BinaryTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | R>, values?: Iterable<V | undefined>): boolean[];
-    delete(keyNodeEntryRawOrPredicate: BTNRep<K, V, BinaryTreeNode<K, V>> | NodePredicate<BinaryTreeNode<K, V> | null>): BinaryTreeDeleteResult<BinaryTreeNode<K, V>>[];
+    delete(keyNodeEntryRawOrPredicate: BTNRep<K, V, BinaryTreeNode<K, V>> | NodePredicate<BinaryTreeNode<K, V> | null>): boolean;
     clear(): void;
     isEmpty(): boolean;
     get(keyNodeEntryOrPredicate: K | BinaryTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, startNode?: K | BinaryTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined, iterationType?: IterationType): V | undefined;
@@ -56,5 +56,4 @@ export interface IBinaryTree<K = any, V = any, R = any> {
     filter(predicate: EntryCallback<K, V | undefined, boolean>, thisArg?: unknown): this;
     map<MK = K, MV = V, MR = any>(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: Partial<BinaryTreeOptions<MK, MV, MR>>, thisArg?: unknown): IBinaryTree<MK, MV, MR>;
     merge(anotherTree: IBinaryTree<K, V, R>): void;
-    refill(keysNodesEntriesOrRaws: Iterable<K | BinaryTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | R>, values?: Iterable<V | undefined>): void;
 }

package/dist/umd/max-priority-queue-typed.js

@@ -234,6 +234,35 @@ var maxPriorityQueueTyped = (() => {
       for (const ele of this) if (ele === element) return true;
       return false;
     }
+    /**
+     * Check whether a value exists (Array-compatible alias for `has`).
+     * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1).
+     * @param element - Element to search for (uses `===`).
+     * @returns `true` if found.
+     */
+    includes(element) {
+      return this.has(element);
+    }
+    /**
+     * Return an iterator of `[index, value]` pairs (Array-compatible).
+     * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+     */
+    *entries() {
+      let index = 0;
+      for (const value of this) {
+        yield [index++, value];
+      }
+    }
+    /**
+     * Return an iterator of numeric indices (Array-compatible).
+     * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+     */
+    *keys() {
+      let index = 0;
+      for (const _ of this) {
+        yield index++;
+      }
+    }
     /**
      * Reduces all elements to a single accumulated value.
      *
@@ -372,6 +401,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -429,7 +465,7 @@ var maxPriorityQueueTyped = (() => {
     }
     /**
       * Insert an element.
-      * @remarks Time O(1) amortized, Space O(1)
+      * @remarks Time O(log N) amortized, Space O(1)
       * @param element - Element to insert.
       * @returns True.
       
@@ -459,6 +495,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -516,6 +559,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -580,6 +630,40 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+       * @example
+    * // Heap with custom comparator (MaxHeap behavior)
+    *  interface Task {
+    *       id: number;
+    *       priority: number;
+    *       name: string;
+    *     }
+    *
+    *     // Custom comparator for max heap behavior (higher priority first)
+    *     const tasks: Task[] = [
+    *       { id: 1, priority: 5, name: 'Email' },
+    *       { id: 2, priority: 3, name: 'Chat' },
+    *       { id: 3, priority: 8, name: 'Alert' }
+    *     ];
+    *
+    *     const maxHeap = new Heap(tasks, {
+    *       comparator: (a: Task, b: Task) => b.priority - a.priority
+    *     });
+    *
+    *     console.log(maxHeap.size); // 3;
+    *
+    *     // Peek returns highest priority task
+    *     const topTask = maxHeap.peek();
+    *     console.log(topTask?.priority); // 8;
+    *     console.log(topTask?.name); // 'Alert';
+      */
+    /**
+      * @deprecated Use `pop` instead. Will be removed in a future major version.
       
       
       
@@ -610,6 +694,14 @@ var maxPriorityQueueTyped = (() => {
     *     console.log(topTask?.name); // 'Alert';
       */
     poll() {
+      return this.pop();
+    }
+    /**
+     * Remove and return the top element (min or max depending on comparator).
+     * @remarks Time O(log N) amortized, Space O(1)
+     * @returns The removed top element, or undefined if empty.
+     */
+    pop() {
       if (this.elements.length === 0) return;
       const value = this.elements[0];
       const last = this.elements.pop();
@@ -650,6 +742,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -750,6 +849,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -797,6 +903,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -814,16 +927,6 @@ var maxPriorityQueueTyped = (() => {
     clear() {
       this._elements = [];
     }
-    /**
-     * Replace the backing array and rebuild the heap.
-     * @remarks Time O(N), Space O(N)
-     * @param elements - Iterable used to refill the heap.
-     * @returns Array of per-node results from fixing steps.
-     */
-    refill(elements) {
-      this._elements = Array.from(elements);
-      return this.fix();
-    }
     /**
       * Check if an equal element exists in the heap.
       * @remarks Time O(N), Space O(1)
@@ -847,6 +950,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -894,6 +1004,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -918,7 +1035,7 @@ var maxPriorityQueueTyped = (() => {
       }
       if (index < 0) return false;
       if (index === 0) {
-        this.poll();
+        this.pop();
       } else if (index === this.elements.length - 1) {
         this.elements.pop();
       } else {
@@ -928,13 +1045,19 @@ var maxPriorityQueueTyped = (() => {
       }
       return true;
     }
+    /**
+     * @deprecated Use `deleteWhere` instead. Will be removed in a future major version.
+     */
+    deleteBy(predicate) {
+      return this.deleteWhere(predicate);
+    }
     /**
      * Delete the first element that matches a predicate.
      * @remarks Time O(N), Space O(1)
      * @param predicate - Function (element, index, heap) → boolean.
      * @returns True if an element was removed.
      */
-    deleteBy(predicate) {
+    deleteWhere(predicate) {
       let idx = -1;
       for (let i = 0; i < this.elements.length; i++) {
         if (predicate(this.elements[i], i, this)) {
@@ -944,7 +1067,7 @@ var maxPriorityQueueTyped = (() => {
       }
       if (idx < 0) return false;
       if (idx === 0) {
-        this.poll();
+        this.pop();
       } else if (idx === this.elements.length - 1) {
         this.elements.pop();
       } else {
@@ -987,6 +1110,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1067,6 +1197,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1120,6 +1257,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1172,6 +1316,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1231,6 +1382,13 @@ var maxPriorityQueueTyped = (() => {
       
       
       
+      
+      
+      
+      
+      
+      
+      
       
       
       
@@ -1412,7 +1570,7 @@ var maxPriorityQueueTyped = (() => {
      * Push an element into the root list.
      * @remarks Time O(1) amortized, Space O(1)
      * @param element - Element to insert.
-     * @returns This heap.
+     * @returns True when the element is added.
      */
     push(element) {
       const node = this.createNode(element);
@@ -1421,7 +1579,7 @@ var maxPriorityQueueTyped = (() => {
       this.mergeWithRoot(node);
       if (!this.min || this.comparator(node.element, this.min.element) <= 0) this._min = node;
       this._size++;
-      return this;
+      return true;
     }
     peek() {
       return this.min ? this.min.element : void 0;