tree-multimap-typed 2.4.3 → 2.4.5

package/dist/types/common/error.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Centralized error message templates.
+ * Keep using native Error/TypeError/RangeError — this only standardizes messages.
+ */
+export declare const ERR: {
+    readonly indexOutOfRange: (index: number, min: number, max: number, ctx?: string) => string;
+    readonly invalidIndex: (ctx?: string) => string;
+    readonly invalidArgument: (reason: string, ctx?: string) => string;
+    readonly comparatorRequired: (ctx?: string) => string;
+    readonly invalidKey: (reason: string, ctx?: string) => string;
+    readonly notAFunction: (name: string, ctx?: string) => string;
+    readonly invalidEntry: (ctx?: string) => string;
+    readonly invalidNaN: (ctx?: string) => string;
+    readonly invalidDate: (ctx?: string) => string;
+    readonly reduceEmpty: (ctx?: string) => string;
+    readonly callbackReturnType: (expected: string, got: string, ctx?: string) => string;
+    readonly invalidOperation: (reason: string, ctx?: string) => string;
+    readonly matrixDimensionMismatch: (op: string) => string;
+    readonly matrixSingular: () => string;
+    readonly matrixNotSquare: () => string;
+    readonly matrixNotRectangular: () => string;
+    readonly matrixRowMismatch: (expected: number, got: number) => string;
+};

package/dist/types/common/index.d.ts

@@ -1,3 +1,4 @@
+export { ERR } from './error';
 export declare enum DFSOperation {
     VISIT = 0,
     PROCESS = 1

package/dist/types/data-structures/base/iterable-element-base.d.ts

@@ -27,7 +27,7 @@ export declare abstract class IterableElementBase<E, R> implements Iterable<E> {
      * @remarks
      * Time O(1), Space O(1).
      */
-    protected _toElementFn?: (rawElement: R) => E;
+    protected readonly _toElementFn?: (rawElement: R) => E;
     /**
      * Exposes the current `toElementFn`, if configured.
      *

package/dist/types/data-structures/binary-tree/binary-tree.d.ts

@@ -275,7 +275,7 @@ export declare class BinaryTree<K = any, V = any, R = any> extends IterableEntry
      * @param [options] - Configuration options for the tree.
      */
     constructor(keysNodesEntriesOrRaws?: Iterable<K | BinaryTreeNode<K, V> | [K | null | undefined, V | undefined] | null | undefined | R>, options?: BinaryTreeOptions<K, V, R>);
-    protected _isMapMode: boolean;
+    protected readonly _isMapMode: boolean;
     /**
      * Gets whether the tree is in Map mode.
      * @remarks In Map mode (default), values are stored in an external Map, and nodes only hold keys. If false, values are stored directly on the nodes. Time O(1)
@@ -283,7 +283,7 @@ export declare class BinaryTree<K = any, V = any, R = any> extends IterableEntry
      * @returns True if in Map mode, false otherwise.
      */
     get isMapMode(): boolean;
-    protected _isDuplicate: boolean;
+    protected readonly _isDuplicate: boolean;
     /**
      * Gets whether the tree allows duplicate keys.
      * @remarks Time O(1)
@@ -315,7 +315,7 @@ export declare class BinaryTree<K = any, V = any, R = any> extends IterableEntry
      * @returns The size of the tree.
      */
     get size(): number;
-    protected _NIL: BinaryTreeNode<K, V>;
+    protected readonly _NIL: BinaryTreeNode<K, V>;
     /**
      * Gets the sentinel NIL node (used in self-balancing trees like Red-Black Tree).
      * @remarks Time O(1)
@@ -323,7 +323,7 @@ export declare class BinaryTree<K = any, V = any, R = any> extends IterableEntry
      * @returns The NIL node.
      */
     get NIL(): BinaryTreeNode<K, V>;
-    protected _toEntryFn?: ToEntryFn<K, V, R>;
+    protected readonly _toEntryFn?: ToEntryFn<K, V, R>;
     /**
      * Gets the function used to convert raw data objects (R) into [key, value] entries.
      * @remarks Time O(1)
@@ -682,7 +682,7 @@ export declare class BinaryTree<K = any, V = any, R = any> extends IterableEntry
      * @param node - The node.
      * @returns The node's key or undefined.
      */
-    protected _DEFAULT_NODE_CALLBACK: (node: BinaryTreeNode<K, V> | null | undefined) => K | undefined;
+    protected readonly _DEFAULT_NODE_CALLBACK: NodeCallback<BinaryTreeNode<K, V> | null | undefined, K | undefined>;
     /**
      * (Protected) Snapshots the current tree's configuration options.
      * @remarks Time O(1)
@@ -735,6 +735,16 @@ export declare class BinaryTree<K = any, V = any, R = any> extends IterableEntry
      * @returns Layout information for this subtree.
      */
     protected _displayAux(node: BinaryTreeNode<K, V> | null | undefined, options: BinaryTreePrintOptions): NodeDisplayLayout;
+    protected static _buildNodeDisplay(line: string, width: number, left: NodeDisplayLayout, right: NodeDisplayLayout): NodeDisplayLayout;
+    /**
+     * Check if a node is a display leaf (empty, null, undefined, NIL, or real leaf).
+     */
+    protected _isDisplayLeaf(node: BinaryTreeNode<K, V> | null | undefined, options: BinaryTreePrintOptions): boolean;
+    protected _hasDisplayableChild(child: BinaryTreeNode<K, V> | null | undefined, options: BinaryTreePrintOptions): boolean;
+    /**
+     * Resolve a display leaf node to its layout.
+     */
+    protected _resolveDisplayLeaf(node: BinaryTreeNode<K, V> | null | undefined, options: BinaryTreePrintOptions, emptyDisplayLayout: NodeDisplayLayout): NodeDisplayLayout;
     /**
      * (Protected) Swaps the key/value properties of two nodes.
      * @remarks Time O(1)

package/dist/types/data-structures/binary-tree/bst.d.ts

@@ -294,7 +294,7 @@ export declare class BST<K = any, V = any, R = any> extends BinaryTree<K, V, R>
   
      * @remarks Time O(1) Space O(1)
      */
-    protected _comparator: Comparator<K>;
+    protected readonly _comparator: Comparator<K>;
     /**
      * Gets the comparator function used by the tree.
      * @remarks Time O(1)

package/dist/types/data-structures/binary-tree/red-black-tree.d.ts

@@ -5,7 +5,7 @@
  * @copyright Copyright (c) 2022 Pablo Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import type { BinaryTreeDeleteResult, BTNRep, CRUD, EntryCallback, FamilyPosition, NodePredicate, RBTNColor, RedBlackTreeOptions } from '../../types';
+import type { BinaryTreeDeleteResult, BTNRep, CRUD, EntryCallback, FamilyPosition, NodePredicate, RBTNColor, IterationType, RedBlackTreeOptions } from '../../types';
 import { BST } from './bst';
 import { IBinaryTree } from '../../interfaces';
 export declare class RedBlackTreeNode<K = any, V = any> {
@@ -375,6 +375,12 @@ export declare class RedBlackTree<K = any, V = any, R = any> extends BST<K, V, R
      * @param [thisArg] - See parameter type for details.
      * @returns A new RedBlackTree with mapped entries.
      */
+    /**
+     * Red-Black trees are self-balancing — `perfectlyBalance` rebuilds via
+     * sorted bulk insert, which naturally produces a balanced RBT.
+     * @remarks Time O(N), Space O(N)
+     */
+    perfectlyBalance(iterationType?: IterationType): boolean;
     map<MK = K, MV = V, MR = any>(callback: EntryCallback<K, V | undefined, [MK, MV]>, options?: Partial<RedBlackTreeOptions<MK, MV, MR>>, thisArg?: unknown): RedBlackTree<MK, MV, MR>;
     /**
      * (Internal) Create an empty instance of the same concrete tree type.

package/dist/types/data-structures/graph/abstract-graph.d.ts

@@ -337,4 +337,48 @@ export declare abstract class AbstractGraph<V = any, E = any, VO extends Abstrac
      * @remarks Time O(1), Space O(1)
      */
     protected _getVertexKey(vertexOrKey: VO | VertexKey): VertexKey;
+    /**
+     * The edge connector string used in visual output.
+     * Override in subclasses (e.g., '--' for undirected, '->' for directed).
+     */
+    protected get _edgeConnector(): string;
+    /**
+     * Generate a text-based visual representation of the graph.
+     *
+     * **Adjacency list format:**
+     * ```
+     * Graph (5 vertices, 6 edges):
+     * A -> B (1), C (2)
+     * B -> D (3)
+     * C -> (no outgoing edges)
+     * D -> A (1)
+     * E (isolated)
+     * ```
+     *
+     * @param options - Optional display settings.
+     * @param options.showWeight - Whether to show edge weights (default: true).
+     * @returns The visual string.
+     */
+    toVisual(options?: {
+        showWeight?: boolean;
+    }): string;
+    /**
+     * Generate DOT language representation for Graphviz.
+     *
+     * @param options - Optional display settings.
+     * @param options.name - Graph name (default: 'G').
+     * @param options.showWeight - Whether to label edges with weight (default: true).
+     * @returns DOT format string.
+     */
+    toDot(options?: {
+        name?: string;
+        showWeight?: boolean;
+    }): string;
+    /**
+     * Print the graph to console.
+     * @param options - Display settings passed to `toVisual`.
+     */
+    print(options?: {
+        showWeight?: boolean;
+    }): void;
 }

package/dist/types/data-structures/graph/directed-graph.d.ts

@@ -157,6 +157,7 @@ export declare class DirectedGraph<V = any, E = any, VO extends DirectedVertex<V
      * @remarks Time O(1), Space O(1)
      */
     constructor(options?: Partial<GraphOptions<V>>);
+    protected get _edgeConnector(): string;
     protected _outEdgeMap: Map<VO, EO[]>;
     get outEdgeMap(): Map<VO, EO[]>;
     set outEdgeMap(v: Map<VO, EO[]>);
@@ -170,7 +171,7 @@ export declare class DirectedGraph<V = any, E = any, VO extends DirectedVertex<V
      * @returns DirectedGraph with all keys added.
      * @remarks Time O(V), Space O(V)
      */
-    static fromKeys<K extends VertexKey>(keys: Iterable<K>): DirectedGraph<K, any, DirectedVertex<K>, DirectedEdge<any>>;
+    static fromKeys<K extends VertexKey>(keys: Iterable<K>): DirectedGraph<K, undefined, DirectedVertex<K>, DirectedEdge<undefined>>;
     /**
      * Construct a directed graph from `[key, value]` entries.
      * @template V - Vertex value type.
@@ -178,7 +179,7 @@ export declare class DirectedGraph<V = any, E = any, VO extends DirectedVertex<V
      * @returns DirectedGraph with all vertices added.
      * @remarks Time O(V), Space O(V)
      */
-    static fromEntries<V>(entries: Iterable<[VertexKey, V]>): DirectedGraph<V, any, DirectedVertex<V>, DirectedEdge<any>>;
+    static fromEntries<V>(entries: Iterable<[VertexKey, V]>): DirectedGraph<V, undefined, DirectedVertex<V>, DirectedEdge<undefined>>;
     /**
      * Create a directed vertex instance. Does not insert into the graph.
      * @param key - Vertex identifier.

package/dist/types/data-structures/graph/undirected-graph.d.ts

@@ -200,7 +200,7 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      * @returns UndirectedGraph with all keys added.
      * @remarks Time O(V), Space O(V)
      */
-    static fromKeys<K extends VertexKey>(keys: Iterable<K>): UndirectedGraph<K, any, UndirectedVertex<K>, UndirectedEdge<any>>;
+    static fromKeys<K extends VertexKey>(keys: Iterable<K>): UndirectedGraph<K, undefined, UndirectedVertex<K>, UndirectedEdge<undefined>>;
     /**
      * Construct an undirected graph from `[key, value]` entries.
      * @template V - Vertex value type.
@@ -208,7 +208,7 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
      * @returns UndirectedGraph with all vertices added.
      * @remarks Time O(V), Space O(V)
      */
-    static fromEntries<V>(entries: Iterable<[VertexKey, V]>): UndirectedGraph<V, any, UndirectedVertex<V>, UndirectedEdge<any>>;
+    static fromEntries<V>(entries: Iterable<[VertexKey, V]>): UndirectedGraph<V, undefined, UndirectedVertex<V>, UndirectedEdge<undefined>>;
     /**
      * Create an undirected vertex instance. Does not insert into the graph.
      * @param key - Vertex identifier.
@@ -313,6 +313,20 @@ export declare class UndirectedGraph<V = any, E = any, VO extends UndirectedVert
         bridges: EO[];
         cutVertices: VO[];
     };
+    /**
+     * Find biconnected components using edge-stack Tarjan variant.
+     * A biconnected component is a maximal biconnected subgraph.
+     * @returns Array of edge arrays, each representing a biconnected component.
+     * @remarks Time O(V + E), Space O(V + E)
+     */
+    getBiconnectedComponents(): EO[][];
+    /**
+     * Detect whether the graph contains a cycle.
+     * Uses DFS with parent tracking.
+     * @returns `true` if a cycle exists, `false` otherwise.
+     * @remarks Time O(V + E), Space O(V)
+     */
+    hasCycle(): boolean;
     /**
      * Get bridges discovered by `tarjan()`.
      * @returns Array of edges that are bridges.

package/dist/types/data-structures/hash/hash-map.d.ts

@@ -175,7 +175,7 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @returns Map of object→value.
      */
     get objMap(): Map<object, V>;
-    protected _toEntryFn?: (rawElement: R) => [K, V];
+    protected readonly _toEntryFn?: (rawElement: R) => [K, V];
     /**
      * Get the raw→entry converter function if present.
      * @remarks Time O(1), Space O(1)
@@ -346,7 +346,7 @@ export declare class LinkedHashMap<K = any, V = any, R = [K, V]> extends Iterabl
      * @returns Tail node or sentinel.
      */
     get tail(): HashMapLinkedNode<K, V | undefined>;
-    protected _toEntryFn?: (rawElement: R) => [K, V];
+    protected readonly _toEntryFn?: (rawElement: R) => [K, V];
     get toEntryFn(): ((rawElement: R) => [K, V]) | undefined;
     protected _size: number;
     get size(): number;

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

@@ -414,12 +414,8 @@ export declare class Heap<E = any, R = any> extends IterableElementBase<E, R> {
      * @returns A new heap with mapped elements.
      */
     mapSame(callback: ElementCallback<E, R, E>, thisArg?: unknown): this;
-    protected _DEFAULT_COMPARATOR: (a: E, b: E) => number;
-    protected _comparator: Comparator<E>; /**
-     * Get the comparator used to order elements.
-     * @remarks Time O(1), Space O(1)
-     * @returns Comparator function.
-     */
+    protected readonly _DEFAULT_COMPARATOR: Comparator<E>;
+    protected readonly _comparator: Comparator<E>;
     /**
      * Get the comparator used to order elements.
      * @remarks Time O(1), Space O(1)
@@ -501,7 +497,7 @@ export declare class FibonacciHeap<E> {
      * @returns Min node or undefined.
      */
     get min(): FibonacciHeapNode<E> | undefined;
-    protected _comparator: Comparator<E>;
+    protected readonly _comparator: Comparator<E>;
     get comparator(): Comparator<E>;
     clear(): void;
     add(element: E): boolean;

package/dist/types/data-structures/queue/deque.d.ts

@@ -143,7 +143,10 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @param [options] - Options such as bucketSize, toElementFn, and maxLen.
      * @returns New Deque instance.
      */
-    constructor(elements?: IterableWithSizeOrLength<E> | IterableWithSizeOrLength<R>, options?: DequeOptions<E, R>);
+    constructor(elements?: IterableWithSizeOrLength<E>, options?: DequeOptions<E, R>);
+    constructor(elements: IterableWithSizeOrLength<R>, options: DequeOptions<E, R> & {
+        toElementFn: (rawElement: R) => E;
+    });
     protected _bucketSize: number;
     /**
      * Get the current bucket size.
@@ -151,6 +154,26 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @returns Bucket capacity per bucket.
      */
     get bucketSize(): number;
+    protected _autoCompactRatio: number;
+    /**
+     * Get the auto-compaction ratio.
+     * When `elements / (bucketCount * bucketSize)` drops below this ratio after
+     * enough shift/pop operations, the deque auto-compacts.
+     * @remarks Time O(1), Space O(1)
+     * @returns Current ratio threshold. 0 means auto-compact is disabled.
+     */
+    get autoCompactRatio(): number;
+    /**
+     * Set the auto-compaction ratio.
+     * @remarks Time O(1), Space O(1)
+     * @param value - Ratio in [0,1]. 0 disables auto-compact.
+     */
+    set autoCompactRatio(value: number);
+    /**
+     * Counter for shift/pop operations since last compaction check.
+     * Only checks ratio every `_bucketSize` operations to minimize overhead.
+     */
+    protected _compactCounter: number;
     protected _bucketFirst: number;
     /**
      * Get the index of the first bucket in use.
@@ -369,6 +392,23 @@ export declare class Deque<E = any, R = any> extends LinearBase<E, R> {
      * @remarks Time O(N), Space O(1)
      * @returns void
      */
+    /**
+     * (Protected) Trigger auto-compaction if space utilization drops below threshold.
+     * Only checks every `_bucketSize` operations to minimize hot-path overhead.
+     * Uses element-based ratio: `elements / (bucketCount * bucketSize)`.
+     */
+    protected _autoCompact(): void;
+    /**
+     * 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).
+     */
+    compact(): boolean;
     shrinkToFit(): void;
     /**
      * Deep clone this deque, preserving options.

package/dist/types/types/data-structures/binary-tree/avl-tree.d.ts

@@ -1,2 +1,2 @@
 import { BSTOptions } from './bst';
-export type AVLTreeOptions<K, V, R> = BSTOptions<K, V, R> & {};
+export type AVLTreeOptions<K, V, R> = BSTOptions<K, V, R>;

package/dist/types/types/data-structures/binary-tree/red-black-tree.d.ts

@@ -1,3 +1,3 @@
 import type { BSTOptions } from './bst';
 export type RBTNColor = 'RED' | 'BLACK';
-export type RedBlackTreeOptions<K, V, R> = BSTOptions<K, V, R> & {};
+export type RedBlackTreeOptions<K, V, R> = BSTOptions<K, V, R>;

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

@@ -1,2 +1,2 @@
 import { LinearBaseOptions } from '../base';
-export type DoublyLinkedListOptions<E, R> = LinearBaseOptions<E, R> & {};
+export type DoublyLinkedListOptions<E, R> = LinearBaseOptions<E, R>;

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

@@ -1,2 +1,2 @@
 import { LinearBaseOptions } from '../base';
-export type SinglyLinkedListOptions<E, R> = LinearBaseOptions<E, R> & {};
+export type SinglyLinkedListOptions<E, R> = LinearBaseOptions<E, R>;

package/dist/types/types/data-structures/priority-queue/priority-queue.d.ts

@@ -1,2 +1,2 @@
 import { HeapOptions } from '../heap';
-export type PriorityQueueOptions<E, R> = HeapOptions<E, R> & {};
+export type PriorityQueueOptions<E, R> = HeapOptions<E, R>;

package/dist/types/types/data-structures/queue/deque.d.ts

@@ -1,4 +1,10 @@
 import { LinearBaseOptions } from '../base';
 export type DequeOptions<E, R> = {
     bucketSize?: number;
+    /**
+     * When the ratio of used buckets to total buckets falls below this threshold
+     * after a shift/pop, auto-compact is triggered. Set to 0 to disable.
+     * Default: 0.5 (compact when less than half the buckets are in use).
+     */
+    autoCompactRatio?: number;
 } & LinearBaseOptions<E, R>;

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

@@ -1,2 +1,2 @@
 import { IterableElementBaseOptions } from '../base';
-export type StackOptions<E, R> = IterableElementBaseOptions<E, R> & {};
+export type StackOptions<E, R> = IterableElementBaseOptions<E, R>;