directed-graph-typed 2.4.5 → 2.5.0

package/dist/cjs-legacy/index.cjs

@@ -277,7 +277,7 @@ var _IterableElementBase = class _IterableElementBase {
     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");
     }
   }
   /**
@@ -433,7 +433,7 @@ var _IterableElementBase = class _IterableElementBase {
       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;
     }
@@ -514,10 +514,30 @@ var _Heap = class _Heap extends IterableElementBase {
     return this._elements;
   }
   /**
-   * Get the number of elements.
-   * @remarks Time O(1), Space O(1)
-   * @returns Heap size.
-   */
+    * Get the number of elements.
+    * @remarks Time O(1), Space O(1)
+    * @returns Heap size.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Track heap capacity
+  *  const heap = new Heap<number>();
+  *     console.log(heap.size); // 0;
+  *     heap.add(10);
+  *     heap.add(20);
+  *     console.log(heap.size); // 2;
+  *     heap.poll();
+  *     console.log(heap.size); // 1;
+    */
   get size() {
     return this.elements.length;
   }
@@ -556,21 +576,61 @@ var _Heap = class _Heap extends IterableElementBase {
     return new _Heap(elements, options);
   }
   /**
-   * Insert an element.
-   * @remarks Time O(1) amortized, Space O(1)
-   * @param element - Element to insert.
-   * @returns True.
-   */
+    * Insert an element.
+    * @remarks Time O(1) amortized, Space O(1)
+    * @param element - Element to insert.
+    * @returns True.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // basic Heap creation and add operation
+  *  // Create a min heap (default)
+  *     const minHeap = new Heap([5, 3, 7, 1, 9, 2]);
+  *
+  *     // Verify size
+  *     console.log(minHeap.size); // 6;
+  *
+  *     // Add new element
+  *     minHeap.add(4);
+  *     console.log(minHeap.size); // 7;
+  *
+  *     // Min heap property: smallest element at root
+  *     const min = minHeap.peek();
+  *     console.log(min); // 1;
+    */
   add(element) {
     this._elements.push(element);
     return this._bubbleUp(this.elements.length - 1);
   }
   /**
-   * Insert many elements from an iterable.
-   * @remarks Time O(N log N), Space O(1)
-   * @param elements - Iterable of elements or raw values.
-   * @returns Array of per-element success flags.
-   */
+    * Insert many elements from an iterable.
+    * @remarks Time O(N log N), Space O(1)
+    * @param elements - Iterable of elements or raw values.
+    * @returns Array of per-element success flags.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Add multiple elements
+  *  const heap = new Heap<number>([], { comparator: (a, b) => a - b });
+  *     heap.addMany([5, 3, 7, 1]);
+  *     console.log(heap.peek()); // 1;
+  *     console.log(heap.size); // 4;
+    */
   addMany(elements) {
     const flags = [];
     for (const el of elements) {
@@ -585,10 +645,46 @@ var _Heap = class _Heap extends IterableElementBase {
     return flags;
   }
   /**
-   * Remove and return the top element.
-   * @remarks Time O(log N), Space O(1)
-   * @returns Top element or undefined.
-   */
+    * Remove and return the top element.
+    * @remarks Time O(log N), Space O(1)
+    * @returns Top element or undefined.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @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';
+    */
   poll() {
     if (this.elements.length === 0) return;
     const value = this.elements[0];
@@ -600,26 +696,125 @@ var _Heap = class _Heap extends IterableElementBase {
     return value;
   }
   /**
-   * Get the current top element without removing it.
-   * @remarks Time O(1), Space O(1)
-   * @returns Top element or undefined.
-   */
+    * Get the current top element without removing it.
+    * @remarks Time O(1), Space O(1)
+    * @returns Top element or undefined.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Heap for event processing with priority
+  *  interface Event {
+  *       id: number;
+  *       type: 'critical' | 'warning' | 'info';
+  *       timestamp: number;
+  *       message: string;
+  *     }
+  *
+  *     // Custom priority: critical > warning > info
+  *     const priorityMap = { critical: 3, warning: 2, info: 1 };
+  *
+  *     const eventHeap = new Heap<Event>([], {
+  *       comparator: (a: Event, b: Event) => {
+  *         const priorityA = priorityMap[a.type];
+  *         const priorityB = priorityMap[b.type];
+  *         return priorityB - priorityA; // Higher priority first
+  *       }
+  *     });
+  *
+  *     // Add events in random order
+  *     eventHeap.add({ id: 1, type: 'info', timestamp: 100, message: 'User logged in' });
+  *     eventHeap.add({ id: 2, type: 'critical', timestamp: 101, message: 'Server down' });
+  *     eventHeap.add({ id: 3, type: 'warning', timestamp: 102, message: 'High memory' });
+  *     eventHeap.add({ id: 4, type: 'info', timestamp: 103, message: 'Cache cleared' });
+  *     eventHeap.add({ id: 5, type: 'critical', timestamp: 104, message: 'Database error' });
+  *
+  *     console.log(eventHeap.size); // 5;
+  *
+  *     // Process events by priority (critical first)
+  *     const processedOrder: Event[] = [];
+  *     while (eventHeap.size > 0) {
+  *       const event = eventHeap.poll();
+  *       if (event) {
+  *         processedOrder.push(event);
+  *       }
+  *     }
+  *
+  *     // Verify critical events came first
+  *     console.log(processedOrder[0].type); // 'critical';
+  *     console.log(processedOrder[1].type); // 'critical';
+  *     console.log(processedOrder[2].type); // 'warning';
+  *     console.log(processedOrder[3].type); // 'info';
+  *     console.log(processedOrder[4].type); // 'info';
+  *
+  *     // Verify O(log n) operations
+  *     const newHeap = new Heap<number>([5, 3, 7, 1]);
+  *
+  *     // Add - O(log n)
+  *     newHeap.add(2);
+  *     console.log(newHeap.size); // 5;
+  *
+  *     // Poll - O(log n)
+  *     const removed = newHeap.poll();
+  *     console.log(removed); // 1;
+  *
+  *     // Peek - O(1)
+  *     const top = newHeap.peek();
+  *     console.log(top); // 2;
+    */
   peek() {
     return this.elements[0];
   }
   /**
-   * Check whether the heap is empty.
-   * @remarks Time O(1), Space O(1)
-   * @returns True if size is 0.
-   */
+    * Check whether the heap is empty.
+    * @remarks Time O(1), Space O(1)
+    * @returns True if size is 0.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Check if heap is empty
+  *  const heap = new Heap<number>([], { comparator: (a, b) => a - b });
+  *     console.log(heap.isEmpty()); // true;
+  *     heap.add(1);
+  *     console.log(heap.isEmpty()); // false;
+    */
   isEmpty() {
     return this.size === 0;
   }
   /**
-   * Remove all elements.
-   * @remarks Time O(1), Space O(1)
-   * @returns void
-   */
+    * Remove all elements.
+    * @remarks Time O(1), Space O(1)
+    * @returns void
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Remove all elements
+  *  const heap = new Heap<number>([1, 2, 3], { comparator: (a, b) => a - b });
+  *     heap.clear();
+  *     console.log(heap.isEmpty()); // true;
+    */
   clear() {
     this._elements = [];
   }
@@ -634,21 +829,41 @@ var _Heap = class _Heap extends IterableElementBase {
     return this.fix();
   }
   /**
-   * Check if an equal element exists in the heap.
-   * @remarks Time O(N), Space O(1)
-   * @param element - Element to search for.
-   * @returns True if found.
-   */
+    * Check if an equal element exists in the heap.
+    * @remarks Time O(N), Space O(1)
+    * @param element - Element to search for.
+    * @returns True if found.
+    
+    
+     * @example
+  * // Check element existence
+  *  const heap = new Heap<number>([3, 1, 2], { comparator: (a, b) => a - b });
+  *     console.log(heap.has(1)); // true;
+  *     console.log(heap.has(99)); // false;
+    */
   has(element) {
     for (const el of this.elements) if (this._equals(el, element)) return true;
     return false;
   }
   /**
-   * Delete one occurrence of an element.
-   * @remarks Time O(N), Space O(1)
-   * @param element - Element to delete.
-   * @returns True if an element was removed.
-   */
+    * Delete one occurrence of an element.
+    * @remarks Time O(N), Space O(1)
+    * @param element - Element to delete.
+    * @returns True if an element was removed.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Remove specific element
+  *  const heap = new Heap<number>([3, 1, 4, 1, 5], { comparator: (a, b) => a - b });
+  *     heap.delete(4);
+  *     console.log(heap.toArray().includes(4)); // false;
+    */
   delete(element) {
     let index = -1;
     for (let i = 0; i < this.elements.length; i++) {
@@ -706,11 +921,18 @@ var _Heap = class _Heap extends IterableElementBase {
     return this;
   }
   /**
-   * Traverse the binary heap as a complete binary tree and collect elements.
-   * @remarks Time O(N), Space O(H)
-   * @param [order] - Traversal order: 'PRE' | 'IN' | 'POST'.
-   * @returns Array of visited elements.
-   */
+    * Traverse the binary heap as a complete binary tree and collect elements.
+    * @remarks Time O(N), Space O(H)
+    * @param [order] - Traversal order: 'PRE' | 'IN' | 'POST'.
+    * @returns Array of visited elements.
+    
+    
+     * @example
+  * // Depth-first traversal
+  *  const heap = new Heap<number>([3, 1, 2], { comparator: (a, b) => a - b });
+  *     const result = heap.dfs('IN');
+  *     console.log(result.length); // 3;
+    */
   dfs(order = "PRE") {
     const result = [];
     const _dfs = /* @__PURE__ */ __name((index) => {
@@ -747,10 +969,26 @@ var _Heap = class _Heap extends IterableElementBase {
     return results;
   }
   /**
-   * Return all elements in ascending order by repeatedly polling.
-   * @remarks Time O(N log N), Space O(N)
-   * @returns Sorted array of elements.
-   */
+    * Return all elements in ascending order by repeatedly polling.
+    * @remarks Time O(N log N), Space O(N)
+    * @returns Sorted array of elements.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Sort elements using heap
+  *  const heap = new Heap<number>([5, 1, 3, 2, 4]);
+  *     const sorted = heap.sort();
+  *     console.log(sorted); // [1, 2, 3, 4, 5];
+    */
   sort() {
     const visited = [];
     const cloned = this._createInstance();
@@ -762,22 +1000,52 @@ var _Heap = class _Heap extends IterableElementBase {
     return visited;
   }
   /**
-   * Deep clone this heap.
-   * @remarks Time O(N), Space O(N)
-   * @returns A new heap with the same elements.
-   */
+    * Deep clone this heap.
+    * @remarks Time O(N), Space O(N)
+    * @returns A new heap with the same elements.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Create independent copy
+  *  const heap = new Heap<number>([3, 1, 4], { comparator: (a, b) => a - b });
+  *     const copy = heap.clone();
+  *     copy.poll();
+  *     console.log(heap.size); // 3;
+  *     console.log(copy.size); // 2;
+    */
   clone() {
     const next = this._createInstance();
     for (const x of this.elements) next.add(x);
     return next;
   }
   /**
-   * Filter elements into a new heap of the same class.
-   * @remarks Time O(N log N), Space O(N)
-   * @param callback - Predicate (element, index, heap) → boolean to keep element.
-   * @param [thisArg] - Value for `this` inside the callback.
-   * @returns A new heap with the kept elements.
-   */
+    * Filter elements into a new heap of the same class.
+    * @remarks Time O(N log N), Space O(N)
+    * @param callback - Predicate (element, index, heap) → boolean to keep element.
+    * @param [thisArg] - Value for `this` inside the callback.
+    * @returns A new heap with the kept elements.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Filter elements
+  *  const heap = new Heap<number>([1, 2, 3, 4, 5], { comparator: (a, b) => a - b });
+  *     const evens = heap.filter(x => x % 2 === 0);
+  *     console.log(evens.size); // 2;
+    */
   filter(callback, thisArg) {
     const out = this._createInstance();
     let i = 0;
@@ -791,15 +1059,28 @@ var _Heap = class _Heap extends IterableElementBase {
     return out;
   }
   /**
-   * Map elements into a new heap of possibly different element type.
-   * @remarks Time O(N log N), Space O(N)
-   * @template EM
-   * @template RM
-   * @param callback - Mapping function (element, index, heap) → newElement.
-   * @param options - Options for the output heap, including comparator for EM.
-   * @param [thisArg] - Value for `this` inside the callback.
-   * @returns A new heap with mapped elements.
-   */
+    * Map elements into a new heap of possibly different element type.
+    * @remarks Time O(N log N), Space O(N)
+    * @template EM
+    * @template RM
+    * @param callback - Mapping function (element, index, heap) → newElement.
+    * @param options - Options for the output heap, including comparator for EM.
+    * @param [thisArg] - Value for `this` inside the callback.
+    * @returns A new heap with mapped elements.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Transform elements
+  *  const heap = new Heap<number>([1, 2, 3], { comparator: (a, b) => a - b });
+  *     const doubled = heap.map(x => x * 2, { comparator: (a, b) => a - b });
+  *     console.log(doubled.peek()); // 2;
+    */
   map(callback, options, thisArg) {
     const { comparator, toElementFn, ...rest } = options != null ? options : {};
     if (!comparator) throw new TypeError(ERR.comparatorRequired("Heap.map"));
@@ -1151,18 +1432,52 @@ var _Queue = class _Queue extends LinearBase {
     this._autoCompactRatio = value;
   }
   /**
-   * Get the number of elements currently in the queue.
-   * @remarks Time O(1), Space O(1)
-   * @returns Current length.
-   */
+    * Get the number of elements currently in the queue.
+    * @remarks Time O(1), Space O(1)
+    * @returns Current length.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Track queue length
+  *  const q = new Queue<number>();
+  *     console.log(q.length); // 0;
+  *     q.push(1);
+  *     q.push(2);
+  *     console.log(q.length); // 2;
+    */
   get length() {
     return this.elements.length - this._offset;
   }
   /**
-   * Get the first element (front) without removing it.
-   * @remarks Time O(1), Space O(1)
-   * @returns Front element or undefined.
-   */
+    * Get the first element (front) without removing it.
+    * @remarks Time O(1), Space O(1)
+    * @returns Front element or undefined.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // View the front element
+  *  const q = new Queue<string>(['first', 'second', 'third']);
+  *     console.log(q.first); // 'first';
+  *     console.log(q.length); // 3;
+    */
   get first() {
     return this.length > 0 ? this.elements[this._offset] : void 0;
   }
@@ -1185,19 +1500,69 @@ var _Queue = class _Queue extends LinearBase {
     return new _Queue(elements);
   }
   /**
-   * Check whether the queue is empty.
-   * @remarks Time O(1), Space O(1)
-   * @returns True if length is 0.
-   */
+    * Check whether the queue is empty.
+    * @remarks Time O(1), Space O(1)
+    * @returns True if length is 0.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Queue for...of iteration and isEmpty check
+  *  const queue = new Queue<string>(['A', 'B', 'C', 'D']);
+  *
+  *     const elements: string[] = [];
+  *     for (const item of queue) {
+  *       elements.push(item);
+  *     }
+  *
+  *     // Verify all elements are iterated in order
+  *     console.log(elements); // ['A', 'B', 'C', 'D'];
+  *
+  *     // Process all elements
+  *     while (queue.length > 0) {
+  *       queue.shift();
+  *     }
+  *
+  *     console.log(queue.length); // 0;
+    */
   isEmpty() {
     return this.length === 0;
   }
   /**
-   * Enqueue one element at the back.
-   * @remarks Time O(1), Space O(1)
-   * @param element - Element to enqueue.
-   * @returns True on success.
-   */
+    * Enqueue one element at the back.
+    * @remarks Time O(1), Space O(1)
+    * @param element - Element to enqueue.
+    * @returns True on success.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // basic Queue creation and push operation
+  *  // Create a simple Queue with initial values
+  *     const queue = new Queue([1, 2, 3, 4, 5]);
+  *
+  *     // Verify the queue maintains insertion order
+  *     console.log([...queue]); // [1, 2, 3, 4, 5];
+  *
+  *     // Check length
+  *     console.log(queue.length); // 5;
+    */
   push(element) {
     this.elements.push(element);
     if (this._maxLen > 0 && this.length > this._maxLen) this.shift();
@@ -1218,10 +1583,35 @@ var _Queue = class _Queue extends LinearBase {
     return ans;
   }
   /**
-   * Dequeue one element from the front (amortized via offset).
-   * @remarks Time O(1) amortized, Space O(1)
-   * @returns Removed element or undefined.
-   */
+    * Dequeue one element from the front (amortized via offset).
+    * @remarks Time O(1) amortized, Space O(1)
+    * @returns Removed element or undefined.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Queue shift and peek operations
+  *  const queue = new Queue<number>([10, 20, 30, 40]);
+  *
+  *     // Peek at the front element without removing it
+  *     console.log(queue.first); // 10;
+  *
+  *     // Remove and get the first element (FIFO)
+  *     const first = queue.shift();
+  *     console.log(first); // 10;
+  *
+  *     // Verify remaining elements and length decreased
+  *     console.log([...queue]); // [20, 30, 40];
+  *     console.log(queue.length); // 3;
+    */
   shift() {
     if (this.length === 0) return void 0;
     const first = this.first;
@@ -1230,11 +1620,24 @@ var _Queue = class _Queue extends LinearBase {
     return first;
   }
   /**
-   * Delete the first occurrence of a specific element.
-   * @remarks Time O(N), Space O(1)
-   * @param element - Element to remove (strict equality via Object.is).
-   * @returns True if an element was removed.
-   */
+    * Delete the first occurrence of a specific element.
+    * @remarks Time O(N), Space O(1)
+    * @param element - Element to remove (strict equality via Object.is).
+    * @returns True if an element was removed.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Remove specific element
+  *  const q = new Queue<number>([1, 2, 3, 2]);
+  *     q.delete(2);
+  *     console.log(q.length); // 3;
+    */
   delete(element) {
     for (let i = this._offset; i < this.elements.length; i++) {
       if (Object.is(this.elements[i], element)) {
@@ -1245,11 +1648,24 @@ var _Queue = class _Queue extends LinearBase {
     return false;
   }
   /**
-   * Get the element at a given logical index.
-   * @remarks Time O(1), Space O(1)
-   * @param index - Zero-based index from the front.
-   * @returns Element or undefined.
-   */
+    * Get the element at a given logical index.
+    * @remarks Time O(1), Space O(1)
+    * @param index - Zero-based index from the front.
+    * @returns Element or undefined.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Access element by index
+  *  const q = new Queue<string>(['a', 'b', 'c']);
+  *     console.log(q.at(0)); // 'a';
+  *     console.log(q.at(2)); // 'c';
+    */
   at(index) {
     if (index < 0 || index >= this.length) return void 0;
     return this._elements[this._offset + index];
@@ -1301,19 +1717,48 @@ var _Queue = class _Queue extends LinearBase {
     return this;
   }
   /**
-   * Remove all elements and reset offset.
-   * @remarks Time O(1), Space O(1)
-   * @returns void
-   */
+    * Remove all elements and reset offset.
+    * @remarks Time O(1), Space O(1)
+    * @returns void
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Remove all elements
+  *  const q = new Queue<number>([1, 2, 3]);
+  *     q.clear();
+  *     console.log(q.length); // 0;
+    */
   clear() {
     this._elements = [];
     this._offset = 0;
   }
   /**
-   * Compact storage by discarding consumed head elements.
-   * @remarks Time O(N), Space O(N)
-   * @returns True when compaction performed.
-   */
+    * Compact storage by discarding consumed head elements.
+    * @remarks Time O(N), Space O(N)
+    * @returns True when compaction performed.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Reclaim unused memory
+  *  const q = new Queue<number>([1, 2, 3, 4, 5]);
+  *     q.shift();
+  *     q.shift();
+  *     q.compact();
+  *     console.log(q.length); // 3;
+    */
   compact() {
     this._elements = this.elements.slice(this._offset);
     this._offset = 0;
@@ -1339,10 +1784,26 @@ var _Queue = class _Queue extends LinearBase {
     return removed;
   }
   /**
-   * Deep clone this queue and its parameters.
-   * @remarks Time O(N), Space O(N)
-   * @returns A new queue with the same content and options.
-   */
+    * Deep clone this queue and its parameters.
+    * @remarks Time O(N), Space O(N)
+    * @returns A new queue with the same content and options.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Create independent copy
+  *  const q = new Queue<number>([1, 2, 3]);
+  *     const copy = q.clone();
+  *     copy.shift();
+  *     console.log(q.length); // 3;
+  *     console.log(copy.length); // 2;
+    */
   clone() {
     const out = this._createInstance({ toElementFn: this.toElementFn, maxLen: this._maxLen });
     out._setAutoCompactRatio(this._autoCompactRatio);
@@ -1350,12 +1811,26 @@ var _Queue = class _Queue extends LinearBase {
     return out;
   }
   /**
-   * Filter elements into a new queue of the same class.
-   * @remarks Time O(N), Space O(N)
-   * @param predicate - Predicate (element, index, queue) → boolean to keep element.
-   * @param [thisArg] - Value for `this` inside the predicate.
-   * @returns A new queue with kept elements.
-   */
+    * Filter elements into a new queue of the same class.
+    * @remarks Time O(N), Space O(N)
+    * @param predicate - Predicate (element, index, queue) → boolean to keep element.
+    * @param [thisArg] - Value for `this` inside the predicate.
+    * @returns A new queue with kept elements.
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Filter elements
+  *  const q = new Queue<number>([1, 2, 3, 4, 5]);
+  *     const evens = q.filter(x => x % 2 === 0);
+  *     console.log(evens.length); // 2;
+    */
   filter(predicate, thisArg) {
     const out = this._createInstance({ toElementFn: this.toElementFn, maxLen: this._maxLen });
     out._setAutoCompactRatio(this._autoCompactRatio);
@@ -1367,15 +1842,28 @@ var _Queue = class _Queue extends LinearBase {
     return out;
   }
   /**
-   * Map each element to a new element in a possibly different-typed queue.
-   * @remarks Time O(N), Space O(N)
-   * @template EM
-   * @template RM
-   * @param callback - Mapping function (element, index, queue) → newElement.
-   * @param [options] - Options for the output queue (e.g., toElementFn, maxLen, autoCompactRatio).
-   * @param [thisArg] - Value for `this` inside the callback.
-   * @returns A new Queue with mapped elements.
-   */
+    * Map each element to a new element in a possibly different-typed queue.
+    * @remarks Time O(N), Space O(N)
+    * @template EM
+    * @template RM
+    * @param callback - Mapping function (element, index, queue) → newElement.
+    * @param [options] - Options for the output queue (e.g., toElementFn, maxLen, autoCompactRatio).
+    * @param [thisArg] - Value for `this` inside the callback.
+    * @returns A new Queue with mapped elements.
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Transform elements
+  *  const q = new Queue<number>([1, 2, 3]);
+  *     const doubled = q.map(x => x * 2);
+  *     console.log(doubled.toArray()); // [2, 4, 6];
+    */
   map(callback, options, thisArg) {
     var _a, _b;
     const out = new this.constructor([], {
@@ -2475,12 +2963,28 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     return new DirectedEdge(src, dest, (_a = weight != null ? weight : this.options.defaultEdgeWeight) != null ? _a : 1, value);
   }
   /**
-   * Get the unique edge from `src` to `dest`, if present.
-   * @param srcOrKey - Source vertex or key.
-   * @param destOrKey - Destination vertex or key.
-   * @returns Edge instance or `undefined`.
-   * @remarks Time O(1) avg, Space O(1)
-   */
+    * Get the unique edge from `src` to `dest`, if present.
+    * @param srcOrKey - Source vertex or key.
+    * @param destOrKey - Destination vertex or key.
+    * @returns Edge instance or `undefined`.
+    * @remarks Time O(1) avg, Space O(1)
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Get edge between vertices
+  *  const g = new DirectedGraph();
+  *     g.addVertex('A');
+  *     g.addVertex('B');
+  *     g.addEdge('A', 'B', 5);
+  *     const edge = g.getEdge('A', 'B');
+  *     console.log(edge?.weight); // 5;
+    */
   getEdge(srcOrKey, destOrKey) {
     let edgeMap = [];
     if (srcOrKey !== void 0 && destOrKey !== void 0) {
@@ -2520,12 +3024,48 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     return removed;
   }
   /**
-   * Delete an edge by instance or by `(srcKey, destKey)`.
-   * @param edgeOrSrcVertexKey - Edge instance or source vertex/key.
-   * @param destVertexKey - Optional destination vertex/key when deleting by pair.
-   * @returns Removed edge or `undefined`.
-   * @remarks Time O(1) avg, Space O(1)
-   */
+    * Delete an edge by instance or by `(srcKey, destKey)`.
+    * @param edgeOrSrcVertexKey - Edge instance or source vertex/key.
+    * @param destVertexKey - Optional destination vertex/key when deleting by pair.
+    * @returns Removed edge or `undefined`.
+    * @remarks Time O(1) avg, Space O(1)
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // DirectedGraph deleteEdge and vertex operations
+  *  const graph = new DirectedGraph<string>();
+  *
+  *     // Build a small graph
+  *     graph.addVertex('X');
+  *     graph.addVertex('Y');
+  *     graph.addVertex('Z');
+  *     graph.addEdge('X', 'Y', 1);
+  *     graph.addEdge('Y', 'Z', 2);
+  *
+  *     // Delete an edge
+  *     graph.deleteEdgeSrcToDest('X', 'Y');
+  *     console.log(graph.hasEdge('X', 'Y')); // false;
+  *
+  *     // Edge in other direction should not exist
+  *     console.log(graph.hasEdge('Y', 'X')); // false;
+  *
+  *     // Other edges should remain
+  *     console.log(graph.hasEdge('Y', 'Z')); // true;
+  *
+  *     // Delete a vertex
+  *     graph.deleteVertex('Y');
+  *     console.log(graph.hasVertex('Y')); // false;
+  *     console.log(graph.size); // 2;
+    */
   deleteEdge(edgeOrSrcVertexKey, destVertexKey) {
     let removed = void 0;
     let src, dest;
@@ -2552,6 +3092,26 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     }
     return removed;
   }
+  /**
+    * Remove a vertex
+   
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Remove a vertex
+  *  const g = new DirectedGraph();
+  *     g.addVertex('A');
+  *     g.addVertex('B');
+  *     g.addEdge('A', 'B');
+  *     g.deleteVertex('A');
+  *     console.log(g.hasVertex('A')); // false;
+  *     console.log(g.hasEdge('A', 'B')); // false;
+    */
   deleteVertex(vertexOrKey) {
     let vertexKey;
     let vertex;
@@ -2583,11 +3143,28 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     return removed;
   }
   /**
-   * Incoming edges of a vertex.
-   * @param vertexOrKey - Vertex or key.
-   * @returns Array of incoming edges.
-   * @remarks Time O(deg_in), Space O(deg_in)
-   */
+    * Incoming edges of a vertex.
+    * @param vertexOrKey - Vertex or key.
+    * @returns Array of incoming edges.
+    * @remarks Time O(deg_in), Space O(deg_in)
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Get incoming edges
+  *  const g = new DirectedGraph();
+  *     g.addVertex('A');
+  *     g.addVertex('B');
+  *     g.addVertex('C');
+  *     g.addEdge('A', 'C');
+  *     g.addEdge('B', 'C');
+  *     console.log(g.incomingEdgesOf('C').length); // 2;
+    */
   incomingEdgesOf(vertexOrKey) {
     const target = this._getVertex(vertexOrKey);
     if (target) {
@@ -2596,11 +3173,28 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     return [];
   }
   /**
-   * Outgoing edges of a vertex.
-   * @param vertexOrKey - Vertex or key.
-   * @returns Array of outgoing edges.
-   * @remarks Time O(deg_out), Space O(deg_out)
-   */
+    * Outgoing edges of a vertex.
+    * @param vertexOrKey - Vertex or key.
+    * @returns Array of outgoing edges.
+    * @remarks Time O(deg_out), Space O(deg_out)
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Get outgoing edges
+  *  const g = new DirectedGraph();
+  *     g.addVertex('A');
+  *     g.addVertex('B');
+  *     g.addVertex('C');
+  *     g.addEdge('A', 'B');
+  *     g.addEdge('A', 'C');
+  *     console.log(g.outgoingEdgesOf('A').length); // 2;
+    */
   outgoingEdgesOf(vertexOrKey) {
     const target = this._getVertex(vertexOrKey);
     if (target) {
@@ -2659,11 +3253,44 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     return destinations;
   }
   /**
-   * Topological sort if DAG; returns `undefined` if a cycle exists.
-   * @param propertyName - `'key'` to map to keys; `'vertex'` to keep instances.
-   * @returns Array of keys/vertices, or `undefined` when cycle is found.
-   * @remarks Time O(V + E), Space O(V)
-   */
+    * Topological sort if DAG; returns `undefined` if a cycle exists.
+    * @param propertyName - `'key'` to map to keys; `'vertex'` to keep instances.
+    * @returns Array of keys/vertices, or `undefined` when cycle is found.
+    * @remarks Time O(V + E), Space O(V)
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // DirectedGraph topologicalSort for task scheduling
+  *  const graph = new DirectedGraph<string>();
+  *
+  *     // Build a DAG (Directed Acyclic Graph) for task dependencies
+  *     graph.addVertex('Design');
+  *     graph.addVertex('Implement');
+  *     graph.addVertex('Test');
+  *     graph.addVertex('Deploy');
+  *
+  *     // Add dependency edges
+  *     graph.addEdge('Design', 'Implement', 1); // Design must come before Implement
+  *     graph.addEdge('Implement', 'Test', 1); // Implement must come before Test
+  *     graph.addEdge('Test', 'Deploy', 1); // Test must come before Deploy
+  *
+  *     // Topological sort gives valid execution order
+  *     const executionOrder = graph.topologicalSort();
+  *     console.log(executionOrder); // defined;
+  *     console.log(executionOrder); // ['Design', 'Implement', 'Test', 'Deploy'];
+  *
+  *     // All vertices should be included
+  *     console.log(executionOrder?.length); // 4;
+    */
   topologicalSort(propertyName) {
     propertyName = propertyName != null ? propertyName : "key";
     const statusMap = /* @__PURE__ */ new Map();
@@ -2695,6 +3322,24 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     if (propertyName === "key") sorted = sorted.map((vertex) => vertex instanceof DirectedVertex ? vertex.key : vertex);
     return sorted.reverse();
   }
+  /**
+    * Get all edges
+   
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Get all edges
+  *  const g = new DirectedGraph();
+  *     g.addVertex('A');
+  *     g.addVertex('B');
+  *     g.addEdge('A', 'B', 3);
+  *     console.log(g.edgeSet().length); // 1;
+    */
   edgeSet() {
     let edgeMap = [];
     this._outEdgeMap.forEach((outEdges) => {
@@ -2702,6 +3347,28 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     });
     return edgeMap;
   }
+  /**
+    * Get outgoing neighbors
+   
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Get outgoing neighbors
+  *  const g = new DirectedGraph();
+  *     g.addVertex('A');
+  *     g.addVertex('B');
+  *     g.addVertex('C');
+  *     g.addEdge('A', 'B');
+  *     g.addEdge('A', 'C');
+  *     const neighbors = g.getNeighbors('A');
+  *     console.log(neighbors.map(v => v.key).sort()); // ['B', 'C'];
+    */
   getNeighbors(vertexOrKey) {
     const neighbors = [];
     const vertex = this._getVertex(vertexOrKey);
@@ -2759,10 +3426,31 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     return super.clone();
   }
   /**
-   * Tarjan's algorithm for strongly connected components.
-   * @returns `{ dfnMap, lowMap, SCCs }`.
-   * @remarks Time O(V + E), Space O(V + E)
-   */
+    * Tarjan's algorithm for strongly connected components.
+    * @returns `{ dfnMap, lowMap, SCCs }`.
+    * @remarks Time O(V + E), Space O(V + E)
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Find strongly connected components
+  *  const g = new DirectedGraph();
+  *     g.addVertex('A');
+  *     g.addVertex('B');
+  *     g.addVertex('C');
+  *     g.addEdge('A', 'B');
+  *     g.addEdge('B', 'C');
+  *     g.addEdge('C', 'A');
+  *     const { SCCs } = g.tarjan();
+  *     // A→B→C→A forms one SCC with 3 members
+  *     const sccArrays = [...SCCs.values()];
+  *     console.log(sccArrays.some(scc => scc.length === 3)); // true;
+    */
   tarjan() {
     const dfnMap = /* @__PURE__ */ new Map();
     const lowMap = /* @__PURE__ */ new Map();
@@ -2820,10 +3508,29 @@ var _DirectedGraph = class _DirectedGraph extends AbstractGraph {
     return this.tarjan().lowMap;
   }
   /**
-   * Strongly connected components computed by `tarjan()`.
-   * @returns Map from SCC id to vertices.
-   * @remarks Time O(#SCC + V), Space O(V)
-   */
+    * Strongly connected components computed by `tarjan()`.
+    * @returns Map from SCC id to vertices.
+    * @remarks Time O(#SCC + V), Space O(V)
+    
+    
+    
+    
+    
+    
+    
+    
+     * @example
+  * // Get strongly connected components
+  *  const g = new DirectedGraph();
+  *     g.addVertex(1);
+  *     g.addVertex(2);
+  *     g.addVertex(3);
+  *     g.addEdge(1, 2);
+  *     g.addEdge(2, 3);
+  *     g.addEdge(3, 1);
+  *     const sccs = g.getSCCs(); // Map<number, VO[]>
+  *     console.log(sccs.size); // >= 1;
+    */
   getSCCs() {
     return this.tarjan().SCCs;
   }