data-structure-typed 2.5.1 → 2.5.3

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

@@ -9,7 +9,7 @@ import type { Comparator, DFSOrderPattern, ElementCallback, HeapOptions } from '
 import { IterableElementBase } from '../base';
 /**
  * Binary heap with pluggable comparator; supports fast insertion and removal of the top element.
- * @remarks Time O(1), Space O(1)
+ * @remarks Typical operations: O(log N) insert/remove, O(1) peek. Space O(N).
  * @template E
  * @template R
  * 1. Complete Binary Tree: Heaps are typically complete binary trees, meaning every level is fully filled except possibly for the last level, which has nodes as far left as possible.
@@ -187,6 +187,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -236,7 +244,7 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
     static heapify<EE = any, RR = any>(elements: Iterable<EE>, options: HeapOptions<EE, RR>): Heap<EE, RR>;
     /**
      * 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.
      
@@ -261,6 +269,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -311,6 +327,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -355,6 +379,13 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -363,6 +394,34 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+      * @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.
       * @example
    * // Heap with custom comparator (MaxHeap behavior)
    *  interface Task {
@@ -390,6 +449,12 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    *     console.log(topTask?.name); // 'Alert';
      */
     poll(): E | undefined;
+    /**
+     * 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(): E | undefined;
     /**
      * Get the current top element without removing it.
      * @remarks Time O(1), Space O(1)
@@ -416,6 +481,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -510,6 +583,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -551,6 +632,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -567,13 +656,6 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    *     console.log(heap.isEmpty()); // true;
      */
     clear(): void;
-    /**
-     * 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: Iterable<E>): boolean[];
     /**
      * Check if an equal element exists in the heap.
      * @remarks Time O(N), Space O(1)
@@ -592,6 +674,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -632,6 +722,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -648,13 +746,17 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
    *     console.log(heap.toArray().includes(4)); // false;
      */
     delete(element: E): boolean;
+    /**
+     * @deprecated Use `deleteWhere` instead. Will be removed in a future major version.
+     */
+    deleteBy(predicate: (element: E, index: number, heap: this) => boolean): boolean;
     /**
      * 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: (element: E, index: number, heap: this) => boolean): boolean;
+    deleteWhere(predicate: (element: E, index: number, heap: this) => boolean): boolean;
     /**
      * Set the equality comparator used by has/delete operations.
      * @remarks Time O(1), Space O(1)
@@ -680,6 +782,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -728,6 +838,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -768,6 +886,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -812,6 +938,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -856,6 +990,14 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -973,9 +1115,9 @@ export declare class FibonacciHeap<E> {
      * 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: E): this;
+    push(element: E): boolean;
     peek(): E | undefined;
     /**
      * Collect nodes from a circular doubly linked list starting at head.

package/dist/types/data-structures/linked-list/doubly-linked-list.d.ts

@@ -207,6 +207,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -259,6 +267,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -311,6 +327,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -354,6 +378,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -411,6 +443,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -451,6 +491,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -498,6 +546,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -562,6 +618,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -602,6 +666,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -642,6 +714,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -680,6 +760,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -720,6 +808,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -760,6 +856,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -803,6 +907,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -819,6 +931,13 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
    *     console.log([...list]); // [3, 2, 1];
      */
     reverse(): this;
+    /**
+     * Delete the first element that satisfies a predicate.
+     * @remarks Time O(N), Space O(1)
+     * @param predicate - Function (value, index, list) → boolean to decide deletion.
+     * @returns True if a match was removed.
+     */
+    deleteWhere(predicate: (value: E, index: number, list: this) => boolean): boolean;
     /**
      * Set the equality comparator used to compare values.
      * @remarks Time O(1), Space O(1)
@@ -850,6 +969,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -895,6 +1022,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+     
      
      
      
@@ -950,6 +1085,14 @@ export declare class DoublyLinkedList<E = any, R = any> extends LinearLinkedBase
      
      
      
+     
+     
+     
+     
+     
+     
+     
+