data-structure-typed 1.35.0 → 1.36.0

package/lib/data-structures/heap/heap.js

@@ -1,152 +1,230 @@
-export class HeapItem {
+/**
+ * data-structure-typed
+ *
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
+ * @license MIT License
+ */
+export class Heap {
+    constructor(comparator) {
+        this.nodes = [];
+        this.comparator = comparator;
+    }
     /**
-     * The constructor function initializes an instance of a class with a priority and a value.
-     * @param {number} priority - The `priority` parameter is a number that represents the priority of the value. It is
-     * optional and has a default value of `NaN`.
-     * @param {V | null} [val=null] - The `val` parameter is of type `V | null`, which means it can accept a value of type
-     * `V` or `null`.
+     * Insert an element into the heap and maintain the heap properties.
+     * @param value - The element to be inserted.
      */
-    constructor(priority = Number.MAX_SAFE_INTEGER, val = null) {
-        this._val = val;
-        this._priority = priority;
-    }
-    get priority() {
-        return this._priority;
-    }
-    set priority(value) {
-        this._priority = value;
-    }
-    get val() {
-        return this._val;
-    }
-    set val(value) {
-        this._val = value;
+    add(value) {
+        this.nodes.push(value);
+        this.bubbleUp(this.nodes.length - 1);
+        return this;
     }
-}
-export class Heap {
     /**
-     * The function is a constructor for a class that initializes a priority callback function based on the
-     * options provided.
-     * @param [options] - An optional object that contains configuration options for the Heap.
+     * Remove and return the top element (smallest or largest element) from the heap.
+     * @returns The top element or null if the heap is empty.
      */
-    constructor(options) {
-        if (options) {
-            const { priorityExtractor } = options;
-            if (priorityExtractor !== undefined && typeof priorityExtractor !== 'function') {
-                throw new Error('.constructor expects a valid priority function');
-            }
-            this._priorityExtractor = priorityExtractor || (el => +el);
+    poll() {
+        if (this.nodes.length === 0) {
+            return null;
         }
-        else {
-            this._priorityExtractor = el => +el;
+        if (this.nodes.length === 1) {
+            return this.nodes.pop();
         }
+        const topValue = this.nodes[0];
+        this.nodes[0] = this.nodes.pop();
+        this.sinkDown(0);
+        return topValue;
     }
-    get pq() {
-        return this._pq;
+    /**
+     * Float operation to maintain heap properties after adding an element.
+     * @param index - The index of the newly added element.
+     */
+    bubbleUp(index) {
+        const element = this.nodes[index];
+        while (index > 0) {
+            const parentIndex = Math.floor((index - 1) / 2);
+            const parent = this.nodes[parentIndex];
+            if (this.comparator(element, parent) < 0) {
+                this.nodes[index] = parent;
+                this.nodes[parentIndex] = element;
+                index = parentIndex;
+            }
+            else {
+                break;
+            }
+        }
     }
-    get priorityExtractor() {
-        return this._priorityExtractor;
+    /**
+     * Sinking operation to maintain heap properties after removing the top element.
+     * @param index - The index from which to start sinking.
+     */
+    sinkDown(index) {
+        const leftChildIndex = 2 * index + 1;
+        const rightChildIndex = 2 * index + 2;
+        const length = this.nodes.length;
+        let targetIndex = index;
+        if (leftChildIndex < length && this.comparator(this.nodes[leftChildIndex], this.nodes[targetIndex]) < 0) {
+            targetIndex = leftChildIndex;
+        }
+        if (rightChildIndex < length && this.comparator(this.nodes[rightChildIndex], this.nodes[targetIndex]) < 0) {
+            targetIndex = rightChildIndex;
+        }
+        if (targetIndex !== index) {
+            const temp = this.nodes[index];
+            this.nodes[index] = this.nodes[targetIndex];
+            this.nodes[targetIndex] = temp;
+            this.sinkDown(targetIndex);
+        }
     }
     /**
-     * The function returns the size of a priority queue.
-     * @returns The size of the priority queue.
+     * Fix the entire heap to maintain heap properties.
      */
-    get size() {
-        return this._pq.size;
+    fix() {
+        for (let i = Math.floor(this.size / 2); i >= 0; i--)
+            this.sinkDown(i);
     }
     /**
-     * The function checks if a priority queue is empty.
-     * @returns {boolean} A boolean value indicating whether the size of the priority queue is less than 1.
+     * Peek at the top element of the heap without removing it.
+     * @returns The top element or null if the heap is empty.
      */
-    isEmpty() {
-        return this._pq.size < 1;
+    peek() {
+        if (this.nodes.length === 0) {
+            return null;
+        }
+        return this.nodes[0];
     }
     /**
-     * The `peek` function returns the top item in the priority queue without removing it.
-     * @returns The `peek()` method is returning either a `HeapItem<V>` object or `null`.Returns an val with the highest priority in the queue
+     * Get the size (number of elements) of the heap.
      */
-    peek(isItem) {
-        isItem = isItem !== null && isItem !== void 0 ? isItem : false;
-        const peeked = this._pq.peek();
-        return isItem ? peeked : peeked === null || peeked === void 0 ? void 0 : peeked.val;
+    get size() {
+        return this.nodes.length;
     }
     /**
-     * The `peekLast` function returns the last item in the heap.
-     * @returns The method `peekLast()` returns either a `HeapItem<V>` object or `null`.Returns an val with the lowest priority in the queue
+     * Get the last element in the heap, which is not necessarily a leaf node.
+     * @returns The last element or null if the heap is empty.
      */
-    peekLast(isItem) {
-        isItem = isItem !== null && isItem !== void 0 ? isItem : false;
-        const leafItem = this._pq.leaf();
-        return isItem ? leafItem : leafItem === null || leafItem === void 0 ? void 0 : leafItem.val;
+    leaf() {
+        var _a;
+        return (_a = this.nodes[this.size - 1]) !== null && _a !== void 0 ? _a : null;
     }
     /**
-     * The `add` function adds an val to a priority queue with an optional priority value.
-     * @param {V} val - The `val` parameter represents the value that you want to add to the heap. It can be of any
-     * type.
-     * @param {number} [priority] - The `priority` parameter is an optional number that represents the priority of the
-     * val being added to the heap. If the `val` parameter is a number, then the `priority` parameter is set to
-     * the value of `val`. If the `val` parameter is not a number, then the
-     * @returns The `add` method returns the instance of the `Heap` class.
-     * @throws {Error} if priority is not a valid number
+     * Check if the heap is empty.
+     * @returns True if the heap is empty, otherwise false.
      */
-    add(priority, val) {
-        val = val === undefined ? priority : val;
-        this._pq.add(new HeapItem(priority, val));
-        return this;
+    isEmpty() {
+        return this.size === 0;
+    }
+    clear() {
+        this.nodes = [];
+    }
+    refill(nodes) {
+        this.nodes = nodes;
+        this.fix();
     }
     /**
-     * The `poll` function returns the top item from a priority queue or null if the queue is empty.Removes and returns an val with the highest priority in the queue
-     * @returns either a HeapItem<V> object or null.
+     * Use a comparison function to check whether a binary heap contains a specific element.
+     * @param value - the element to check.
+     * @returns Returns true if the specified element is contained; otherwise, returns false.
      */
-    poll(isItem) {
-        isItem = isItem !== null && isItem !== void 0 ? isItem : false;
-        const top = this._pq.poll();
-        if (!top) {
-            return null;
-        }
-        return isItem ? top : top.val;
+    has(value) {
+        return this.nodes.includes(value);
     }
     /**
-     * The function checks if a given node or value exists in the priority queue.
-     * @param {V | HeapItem<V>} node - The parameter `node` can be of type `V` or `HeapItem<V>`.
-     * @returns a boolean value.
+     * Use a comparison function to find the index of an element in the heap.
+     * @param value - the element to find.
+     * @param index - the index currently being searched.
+     * @returns The index of the element, or -1 if not found.
      */
-    has(node) {
-        if (node instanceof HeapItem) {
-            return this.pq.getNodes().includes(node);
+    findIndex(value, index) {
+        if (index >= this.size) {
+            return -1;
+        }
+        const compareResult = this.comparator(value, this.nodes[index]);
+        if (compareResult === 0) {
+            return index; // Element found
+        }
+        else if (compareResult < 0) {
+            // The element should be in the left subtree
+            return this.findIndex(value, 2 * index + 1);
         }
         else {
-            return (this.pq.getNodes().findIndex(item => {
-                return item.val === node;
-            }) !== -1);
+            // The element should be in the right subtree
+            return this.findIndex(value, 2 * index + 2);
         }
     }
     /**
-     * The `toArray` function returns an array of `HeapItem<V>` objects.
-     * @returns An array of HeapItem<V> objects.Returns a sorted list of vals
+     * Depth-first search (DFS) method, different traversal orders can be selected。
+     * @param order - Traversal order parameter: 'in' (in-order), 'pre' (pre-order) or 'post' (post-order).
+     * @returns An array containing elements traversed in the specified order.
      */
-    toArray(isItem) {
-        isItem = isItem !== null && isItem !== void 0 ? isItem : false;
-        const itemArray = this._pq.toArray();
-        return isItem ? itemArray : itemArray.map(item => item.val);
+    dfs(order) {
+        const result = [];
+        // Auxiliary recursive function, traverses the binary heap according to the traversal order
+        const dfsHelper = (index) => {
+            if (index < this.size) {
+                if (order === 'in') {
+                    dfsHelper(2 * index + 1);
+                    result.push(this.nodes[index]);
+                    dfsHelper(2 * index + 2);
+                }
+                else if (order === 'pre') {
+                    result.push(this.nodes[index]);
+                    dfsHelper(2 * index + 1);
+                    dfsHelper(2 * index + 2);
+                }
+                else if (order === 'post') {
+                    dfsHelper(2 * index + 1);
+                    dfsHelper(2 * index + 2);
+                    result.push(this.nodes[index]);
+                }
+            }
+        };
+        dfsHelper(0); // Traverse starting from the root node
+        return result;
     }
     /**
-     * The function sorts the elements in the priority queue and returns either the sorted items or their values depending
-     * on the value of the isItem parameter.
-     * @param {boolean} [isItem] - The `isItem` parameter is a boolean flag that indicates whether the sorted result should
-     * be an array of `HeapItem<V>` objects or an array of the values (`V`) of those objects. If `isItem` is `true`, the
-     * sorted result will be an array of `HeapItem
-     * @returns an array of either `HeapItem<V>`, `null`, `V`, or `undefined` values.
+     * Convert the heap to an array.
+     * @returns An array containing the elements of the heap.
      */
-    sort(isItem) {
-        isItem = isItem !== null && isItem !== void 0 ? isItem : false;
-        const sorted = this._pq.sort();
-        return isItem ? sorted : sorted.map(item => item.val);
+    toArray() {
+        return [...this.nodes];
+    }
+    getNodes() {
+        return this.nodes;
     }
     /**
-     * The clear function clears the priority queue.
+     * Clone the heap, creating a new heap with the same elements.
+     * @returns A new Heap instance containing the same elements.
      */
-    clear() {
-        this._pq.clear();
+    clone() {
+        const clonedHeap = new Heap(this.comparator);
+        clonedHeap.nodes = [...this.nodes];
+        return clonedHeap;
+    }
+    /**
+     * Sort the elements in the heap and return them as an array.
+     * @returns An array containing the elements sorted in ascending order.
+     */
+    sort() {
+        const visitedNode = [];
+        const cloned = this.clone();
+        while (cloned.size !== 0) {
+            const top = cloned.poll();
+            if (top)
+                visitedNode.push(top);
+        }
+        return visitedNode;
+    }
+    /**
+     * Static method that creates a binary heap from an array of nodes and a comparison function.
+     * @param nodes
+     * @param comparator - Comparison function.
+     * @returns A new Heap instance.
+     */
+    static heapify(nodes, comparator) {
+        const binaryHeap = new Heap(comparator);
+        binaryHeap.nodes = [...nodes];
+        binaryHeap.fix(); // Fix heap properties
+        return binaryHeap;
     }
 }

package/lib/data-structures/heap/max-heap.d.ts

@@ -1,23 +1,12 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
-import { Heap, HeapItem } from './heap';
-import { PriorityQueue } from '../priority-queue';
-import type { HeapOptions } from '../../types';
-/**
- * @class MaxHeap
- * @extends Heap
- */
-export declare class MaxHeap<V = any> extends Heap<V> {
-    protected _pq: PriorityQueue<HeapItem<V>>;
-    /**
-     * The constructor initializes a PriorityQueue with a custom comparator function.
-     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
-     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
-     */
-    constructor(options?: HeapOptions<V>);
+import { Heap } from './heap';
+import type { CompareFunction } from '../../types';
+export declare class MaxHeap<T = any> extends Heap<T> {
+    constructor(comparator?: CompareFunction<T>);
 }

package/lib/data-structures/heap/max-heap.js

@@ -1,26 +1,20 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
 import { Heap } from './heap';
-import { PriorityQueue } from '../priority-queue';
-/**
- * @class MaxHeap
- * @extends Heap
- */
 export class MaxHeap extends Heap {
-    /**
-     * The constructor initializes a PriorityQueue with a custom comparator function.
-     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
-     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
-     */
-    constructor(options) {
-        super(options);
-        this._pq = new PriorityQueue({
-            comparator: (a, b) => b.priority - a.priority
-        });
+    constructor(comparator = (a, b) => {
+        if (!(typeof a === 'number' && typeof b === 'number')) {
+            throw new Error('The a, b params of compare function must be number');
+        }
+        else {
+            return b - a;
+        }
+    }) {
+        super(comparator);
     }
 }

package/lib/data-structures/heap/min-heap.d.ts

@@ -1,24 +1,12 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
-import { Heap, HeapItem } from './heap';
-import { PriorityQueue } from '../priority-queue';
-import type { HeapOptions } from '../../types';
-/**
- * @class MinHeap
- * @extends Heap
- */
-export declare class MinHeap<V = any> extends Heap<V> {
-    protected _pq: PriorityQueue<HeapItem<V>>;
-    /**
-     * The constructor initializes a PriorityQueue with a comparator function that compares the priority of two HeapItem
-     * objects.
-     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
-     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
-     */
-    constructor(options?: HeapOptions<V>);
+import { Heap } from './heap';
+import type { CompareFunction } from '../../types';
+export declare class MinHeap<T = any> extends Heap<T> {
+    constructor(comparator?: CompareFunction<T>);
 }

package/lib/data-structures/heap/min-heap.js

@@ -1,27 +1,20 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
 import { Heap } from './heap';
-import { PriorityQueue } from '../priority-queue';
-/**
- * @class MinHeap
- * @extends Heap
- */
 export class MinHeap extends Heap {
-    /**
-     * The constructor initializes a PriorityQueue with a comparator function that compares the priority of two HeapItem
-     * objects.
-     * @param [options] - The `options` parameter is an optional object that can be passed to the constructor. It is of
-     * type `HeapOptions<V>`, which is a generic type that represents the options for the heap.
-     */
-    constructor(options) {
-        super(options);
-        this._pq = new PriorityQueue({
-            comparator: (a, b) => a.priority - b.priority
-        });
+    constructor(comparator = (a, b) => {
+        if (!(typeof a === 'number' && typeof b === 'number')) {
+            throw new Error('The a, b params of compare function must be number');
+        }
+        else {
+            return a - b;
+        }
+    }) {
+        super(comparator);
     }
 }

package/lib/data-structures/priority-queue/max-priority-queue.d.ts

@@ -1,15 +1,12 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
 import { PriorityQueue } from './priority-queue';
-import type { PriorityQueueOptions } from '../../types';
-export declare class MaxPriorityQueue<E = any> extends PriorityQueue<E> {
-    constructor(options?: Omit<PriorityQueueOptions<number>, 'comparator'>);
-    constructor(options: PriorityQueueOptions<E>);
-    static heapify<E extends number>(options?: Omit<PriorityQueueOptions<E>, 'comparator'>): MaxPriorityQueue<E>;
-    static heapify<E>(options: PriorityQueueOptions<E>): MaxPriorityQueue<E>;
+import type { CompareFunction } from '../../types';
+export declare class MaxPriorityQueue<T = any> extends PriorityQueue<T> {
+    constructor(compare?: CompareFunction<T>);
 }

package/lib/data-structures/priority-queue/max-priority-queue.js

@@ -1,39 +1,20 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
 import { PriorityQueue } from './priority-queue';
 export class MaxPriorityQueue extends PriorityQueue {
-    /**
-     * The constructor initializes a priority queue with an optional comparator function.
-     * @param [options] - The `options` parameter is an optional object that can contain various properties to configure
-     * the priority queue.
-     */
-    constructor(options) {
-        super(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
-                ? options.comparator
-                : (a, b) => {
-                    const aKey = a, bKey = b;
-                    return bKey - aKey;
-                } }));
-    }
-    /**
-     * The function `heapify` creates a max priority queue from the given options and returns it.
-     * @param options - The `options` parameter is an object that contains configuration options for creating a priority
-     * queue. It can have the following properties:
-     * @returns a MaxPriorityQueue object.
-     */
-    static heapify(options) {
-        const maxPQ = new MaxPriorityQueue(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
-                ? options.comparator
-                : (a, b) => {
-                    const aKey = a, bKey = b;
-                    return bKey - aKey;
-                } }));
-        maxPQ._fix();
-        return maxPQ;
+    constructor(compare = (a, b) => {
+        if (!(typeof a === 'number' && typeof b === 'number')) {
+            throw new Error('The a, b params of compare function must be number');
+        }
+        else {
+            return b - a;
+        }
+    }) {
+        super(compare);
     }
 }

package/lib/data-structures/priority-queue/min-priority-queue.d.ts

@@ -1,15 +1,12 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
 import { PriorityQueue } from './priority-queue';
-import type { PriorityQueueOptions } from '../../types';
-export declare class MinPriorityQueue<E = any> extends PriorityQueue<E> {
-    constructor(options?: Omit<PriorityQueueOptions<number>, 'comparator'>);
-    constructor(options: PriorityQueueOptions<E>);
-    static heapify<E extends number>(options?: Omit<PriorityQueueOptions<E>, 'comparator'>): MinPriorityQueue<E>;
-    static heapify<E>(options: PriorityQueueOptions<E>): MinPriorityQueue<E>;
+import type { CompareFunction } from '../../types';
+export declare class MinPriorityQueue<T = any> extends PriorityQueue<T> {
+    constructor(compare?: CompareFunction<T>);
 }

package/lib/data-structures/priority-queue/min-priority-queue.js

@@ -1,40 +1,20 @@
 /**
  * data-structure-typed
  *
- * @author Tyler Zeng
- * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
+ * @author Kirk Qi
+ * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
 import { PriorityQueue } from './priority-queue';
 export class MinPriorityQueue extends PriorityQueue {
-    /**
-     * The constructor initializes a priority queue with an optional comparator function.
-     * @param [options] - The `options` parameter is an optional object that can contain various configuration options for
-     * the `PriorityQueue` constructor.
-     */
-    constructor(options) {
-        super(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
-                ? options.comparator
-                : (a, b) => {
-                    const aKey = a, bKey = b;
-                    return aKey - bKey;
-                } }));
-    }
-    /**
-     * The function `heapify` creates a new MinPriorityQueue instance and sets the comparator function based on the options
-     * provided, and then fixes the heap structure of the queue.
-     * @param options - The `options` parameter is an object that contains configuration options for creating a priority
-     * queue. It can have the following properties:
-     * @returns a MinPriorityQueue object.
-     */
-    static heapify(options) {
-        const minPQ = new MinPriorityQueue(Object.assign(Object.assign({}, options), { comparator: (options === null || options === void 0 ? void 0 : options.comparator)
-                ? options.comparator
-                : (a, b) => {
-                    const aKey = a, bKey = b;
-                    return aKey - bKey;
-                } }));
-        minPQ._fix();
-        return minPQ;
+    constructor(compare = (a, b) => {
+        if (!(typeof a === 'number' && typeof b === 'number')) {
+            throw new Error('The a, b params of compare function must be number');
+        }
+        else {
+            return a - b;
+        }
+    }) {
+        super(compare);
     }
 }