data-structure-typed 1.37.9 → 1.38.1

package/lib/data-structures/hash/hash-table.js

@@ -13,113 +13,32 @@ export class HashTableNode {
     }
 }
 export class HashTable {
-    get hashFn() {
-        return this._hashFn;
-    }
-    set hashFn(value) {
-        this._hashFn = value;
-    }
-    get buckets() {
-        return this._buckets;
-    }
-    set buckets(value) {
-        this._buckets = value;
-    }
-    get capacity() {
-        return this._capacity;
-    }
-    set capacity(value) {
-        this._capacity = value;
-    }
     constructor(capacity = HashTable.DEFAULT_CAPACITY, hashFn) {
         this._hashFn = hashFn || this._defaultHashFn;
         this._capacity = Math.max(capacity, HashTable.DEFAULT_CAPACITY);
         this._size = 0;
         this._buckets = new Array(this._capacity).fill(null);
     }
-    /**
-     * The function `_defaultHashFn` calculates the hash value of a given key and returns the remainder when divided by the
-     * capacity of the data structure.
-     * @param {K} key - The `key` parameter is the input value that needs to be hashed. It can be of any type, but in this
-     * code snippet, it is checked whether the key is a string or an object. If it is a string, the `_murmurStringHashFn`
-     * function is used to
-     * @returns the hash value of the key modulo the capacity of the data structure.
-     */
-    _defaultHashFn(key) {
-        // Can be replaced with other hash functions as needed
-        const hashValue = typeof key === 'string' ? this._murmurStringHashFn(key) : this._objectHash(key);
-        return hashValue % this._capacity;
+    get capacity() {
+        return this._capacity;
     }
-    /**
-     * The `_multiplicativeStringHashFn` function calculates a hash value for a given string key using the multiplicative
-     * string hash function.
-     * @param {K} key - The `key` parameter is the input value for which we want to calculate the hash. It can be of any
-     * type, as it is generic (`K`). The function converts the `key` to a string using the `String()` function.
-     * @returns a number, which is the result of the multiplicative string hash function applied to the input key.
-     */
-    _multiplicativeStringHashFn(key) {
-        const keyString = String(key);
-        let hash = 0;
-        for (let i = 0; i < keyString.length; i++) {
-            const charCode = keyString.charCodeAt(i);
-            // Some constants for adjusting the hash function
-            const A = 0.618033988749895;
-            const M = 1 << 30; // 2^30
-            hash = (hash * A + charCode) % M;
-        }
-        return Math.abs(hash); // Take absolute value to ensure non-negative numbers
+    set capacity(value) {
+        this._capacity = value;
     }
-    /**
-     * The function `_murmurStringHashFn` calculates a hash value for a given string key using the MurmurHash algorithm.
-     * @param {K} key - The `key` parameter is the input value for which you want to calculate the hash. It can be of any
-     * type, but it will be converted to a string using the `String()` function before calculating the hash.
-     * @returns a number, which is the hash value calculated for the given key.
-     */
-    _murmurStringHashFn(key) {
-        const keyString = String(key);
-        const seed = 0;
-        let hash = seed;
-        for (let i = 0; i < keyString.length; i++) {
-            const char = keyString.charCodeAt(i);
-            hash = (hash ^ char) * 0x5bd1e995;
-            hash = (hash ^ (hash >>> 15)) * 0x27d4eb2d;
-            hash = hash ^ (hash >>> 15);
-        }
-        return Math.abs(hash);
+    get size() {
+        return this._size;
     }
-    /**
-     * The _hash function takes a key and returns a number.
-     * @param {K} key - The parameter "key" is of type K, which represents the type of the key that will be hashed.
-     * @returns The hash function is returning a number.
-     */
-    _hash(key) {
-        return this.hashFn(key);
+    get buckets() {
+        return this._buckets;
     }
-    /**
-     * The function calculates a hash value for a given string using the djb2 algorithm.
-     * @param {string} key - The `key` parameter in the `stringHash` function is a string value that represents the input for
-     * which we want to calculate the hash value.
-     * @returns a number, which is the hash value of the input string.
-     */
-    _stringHash(key) {
-        let hash = 0;
-        for (let i = 0; i < key.length; i++) {
-            hash = (hash * 31 + key.charCodeAt(i)) & 0xffffffff;
-        }
-        return hash;
+    set buckets(value) {
+        this._buckets = value;
     }
-    /**
-     * The function `_objectHash` takes a key and returns a hash value, using a custom hash function for objects.
-     * @param {K} key - The parameter "key" is of type "K", which means it can be any type. It could be a string, number,
-     * boolean, object, or any other type of value. The purpose of the objectHash function is to generate a hash value for
-     * the key, which can be used for
-     * @returns a number, which is the hash value of the key.
-     */
-    _objectHash(key) {
-        // If the key is an object, you can write a custom hash function
-        // For example, convert the object's properties to a string and use string hashing
-        // This is just an example; you should write a specific object hash function as needed
-        return this._stringHash(JSON.stringify(key));
+    get hashFn() {
+        return this._hashFn;
+    }
+    set hashFn(value) {
+        this._hashFn = value;
     }
     /**
      * The set function adds a key-value pair to the hash table, handling collisions and resizing if necessary.
@@ -204,6 +123,90 @@ export class HashTable {
             currentNode = currentNode.next;
         }
     }
+    /**
+     * The function `_defaultHashFn` calculates the hash value of a given key and returns the remainder when divided by the
+     * capacity of the data structure.
+     * @param {K} key - The `key` parameter is the input value that needs to be hashed. It can be of any type, but in this
+     * code snippet, it is checked whether the key is a string or an object. If it is a string, the `_murmurStringHashFn`
+     * function is used to
+     * @returns the hash value of the key modulo the capacity of the data structure.
+     */
+    _defaultHashFn(key) {
+        // Can be replaced with other hash functions as needed
+        const hashValue = typeof key === 'string' ? this._murmurStringHashFn(key) : this._objectHash(key);
+        return hashValue % this._capacity;
+    }
+    /**
+     * The `_multiplicativeStringHashFn` function calculates a hash value for a given string key using the multiplicative
+     * string hash function.
+     * @param {K} key - The `key` parameter is the input value for which we want to calculate the hash. It can be of any
+     * type, as it is generic (`K`). The function converts the `key` to a string using the `String()` function.
+     * @returns a number, which is the result of the multiplicative string hash function applied to the input key.
+     */
+    _multiplicativeStringHashFn(key) {
+        const keyString = String(key);
+        let hash = 0;
+        for (let i = 0; i < keyString.length; i++) {
+            const charCode = keyString.charCodeAt(i);
+            // Some constants for adjusting the hash function
+            const A = 0.618033988749895;
+            const M = 1 << 30; // 2^30
+            hash = (hash * A + charCode) % M;
+        }
+        return Math.abs(hash); // Take absolute value to ensure non-negative numbers
+    }
+    /**
+     * The function `_murmurStringHashFn` calculates a hash value for a given string key using the MurmurHash algorithm.
+     * @param {K} key - The `key` parameter is the input value for which you want to calculate the hash. It can be of any
+     * type, but it will be converted to a string using the `String()` function before calculating the hash.
+     * @returns a number, which is the hash value calculated for the given key.
+     */
+    _murmurStringHashFn(key) {
+        const keyString = String(key);
+        const seed = 0;
+        let hash = seed;
+        for (let i = 0; i < keyString.length; i++) {
+            const char = keyString.charCodeAt(i);
+            hash = (hash ^ char) * 0x5bd1e995;
+            hash = (hash ^ (hash >>> 15)) * 0x27d4eb2d;
+            hash = hash ^ (hash >>> 15);
+        }
+        return Math.abs(hash);
+    }
+    /**
+     * The _hash function takes a key and returns a number.
+     * @param {K} key - The parameter "key" is of type K, which represents the type of the key that will be hashed.
+     * @returns The hash function is returning a number.
+     */
+    _hash(key) {
+        return this.hashFn(key);
+    }
+    /**
+     * The function calculates a hash value for a given string using the djb2 algorithm.
+     * @param {string} key - The `key` parameter in the `stringHash` function is a string value that represents the input for
+     * which we want to calculate the hash value.
+     * @returns a number, which is the hash value of the input string.
+     */
+    _stringHash(key) {
+        let hash = 0;
+        for (let i = 0; i < key.length; i++) {
+            hash = (hash * 31 + key.charCodeAt(i)) & 0xffffffff;
+        }
+        return hash;
+    }
+    /**
+     * The function `_objectHash` takes a key and returns a hash value, using a custom hash function for objects.
+     * @param {K} key - The parameter "key" is of type "K", which means it can be any type. It could be a string, number,
+     * boolean, object, or any other type of value. The purpose of the objectHash function is to generate a hash value for
+     * the key, which can be used for
+     * @returns a number, which is the hash value of the key.
+     */
+    _objectHash(key) {
+        // If the key is an object, you can write a custom hash function
+        // For example, convert the object's properties to a string and use string hashing
+        // This is just an example; you should write a specific object hash function as needed
+        return this._stringHash(JSON.stringify(key));
+    }
     /**
      * The `expand` function increases the capacity of a hash table by creating a new array of buckets with double the
      * capacity and rehashing all the existing key-value pairs into the new buckets.
@@ -232,9 +235,6 @@ export class HashTable {
         this._buckets = newBuckets;
         this._capacity = newCapacity;
     }
-    get size() {
-        return this._size;
-    }
 }
 HashTable.DEFAULT_CAPACITY = 16;
 HashTable.LOAD_FACTOR = 0.75;

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

@@ -4,12 +4,27 @@
  * @copyright Copyright (c) 2022 Kirk Qi <qilinaus@gmail.com>
  * @license MIT License
  */
-import type { Comparator } from '../../types';
-import { DFSOrderPattern } from '../../types';
+import type { Comparator, DFSOrderPattern } from '../../types';
 export declare class Heap<E> {
     protected nodes: E[];
     protected readonly comparator: Comparator<E>;
     constructor(comparator: Comparator<E>);
+    /**
+     * Get the size (number of elements) of the heap.
+     */
+    get size(): number;
+    /**
+     * Get the last element in the heap, which is not necessarily a leaf node.
+     * @returns The last element or undefined if the heap is empty.
+     */
+    get leaf(): E | undefined;
+    /**
+     * 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<E>(nodes: E[], comparator: Comparator<E>): Heap<E>;
     /**
      * Insert an element into the heap and maintain the heap properties.
      * @param element - The element to be inserted.
@@ -30,34 +45,11 @@ export declare class Heap<E> {
      * @returns The top element or undefined if the heap is empty.
      */
     pop(): E | undefined;
-    /**
-     * Float operation to maintain heap properties after adding an element.
-     * @param index - The index of the newly added element.
-     */
-    protected bubbleUp(index: number): void;
-    /**
-     * Sinking operation to maintain heap properties after removing the top element.
-     * @param index - The index from which to start sinking.
-     */
-    protected sinkDown(index: number): void;
-    /**
-     * Fix the entire heap to maintain heap properties.
-     */
-    protected fix(): void;
     /**
      * Peek at the top element of the heap without removing it.
      * @returns The top element or undefined if the heap is empty.
      */
     peek(): E | undefined;
-    /**
-     * Get the size (number of elements) of the heap.
-     */
-    get size(): number;
-    /**
-     * Get the last element in the heap, which is not necessarily a leaf node.
-     * @returns The last element or undefined if the heap is empty.
-     */
-    get leaf(): E | undefined;
     /**
      * Check if the heap is empty.
      * @returns True if the heap is empty, otherwise false.
@@ -101,12 +93,19 @@ export declare class Heap<E> {
      */
     sort(): E[];
     /**
-     * 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.
+     * Float operation to maintain heap properties after adding an element.
+     * @param index - The index of the newly added element.
      */
-    static heapify<E>(nodes: E[], comparator: Comparator<E>): Heap<E>;
+    protected bubbleUp(index: number): void;
+    /**
+     * Sinking operation to maintain heap properties after removing the top element.
+     * @param index - The index from which to start sinking.
+     */
+    protected sinkDown(index: number): void;
+    /**
+     * Fix the entire heap to maintain heap properties.
+     */
+    protected fix(): void;
 }
 export declare class FibonacciHeapNode<E> {
     element: E;
@@ -120,33 +119,15 @@ export declare class FibonacciHeapNode<E> {
 }
 export declare class FibonacciHeap<E> {
     root?: FibonacciHeapNode<E>;
-    protected min?: FibonacciHeapNode<E>;
     size: number;
+    protected min?: FibonacciHeapNode<E>;
     protected readonly comparator: Comparator<E>;
     constructor(comparator?: Comparator<E>);
-    /**
-     * Default comparator function used by the heap.
-     * @param {E} a
-     * @param {E} b
-     * @protected
-     */
-    protected defaultComparator(a: E, b: E): number;
     /**
      * Get the size (number of elements) of the heap.
      * @returns {number} The size of the heap.  Returns 0 if the heap is empty. Returns -1 if the heap is invalid.
      */
     clear(): void;
-    /**
-     * Create a new node.
-     * @param element
-     * @protected
-     */
-    protected createNode(element: E): FibonacciHeapNode<E>;
-    /**
-     * Merge the given node with the root list.
-     * @param node - The node to be merged.
-     */
-    protected mergeWithRoot(node: FibonacciHeapNode<E>): void;
     /**
      * O(1) time operation.
      * Insert an element into the heap and maintain the heap properties.
@@ -176,13 +157,6 @@ export declare class FibonacciHeap<E> {
      * @returns FibonacciHeapNode<E>[] - An array containing the nodes of the linked list.
      */
     consumeLinkedList(head?: FibonacciHeapNode<E>): FibonacciHeapNode<E>[];
-    /**
-     * O(log n) time operation.
-     * Remove and return the top element (smallest or largest element) from the heap.
-     * @param node - The node to be removed.
-     * @protected
-     */
-    protected removeFromRoot(node: FibonacciHeapNode<E>): void;
     /**
      * O(log n) time operation.
      * Remove and return the top element (smallest or largest element) from the heap.
@@ -193,33 +167,58 @@ export declare class FibonacciHeap<E> {
     /**
      * O(log n) time operation.
      * Remove and return the top element (smallest or largest element) from the heap.
-     * @param y
-     * @param x
-     * @protected
+     * @returns The top element or undefined if the heap is empty.
      */
-    protected link(y: FibonacciHeapNode<E>, x: FibonacciHeapNode<E>): void;
+    poll(): E | undefined;
     /**
      * O(log n) time operation.
      * Remove and return the top element (smallest or largest element) from the heap.
+     * @returns The top element or undefined if the heap is empty.
+     */
+    pop(): E | undefined;
+    /**
+     * O(log n) time operation.
+     * merge two heaps. The heap that is merged will be cleared. The heap that is merged into will remain.
+     * @param heapToMerge
+     */
+    merge(heapToMerge: FibonacciHeap<E>): void;
+    /**
+     * Default comparator function used by the heap.
+     * @param {E} a
+     * @param {E} b
      * @protected
      */
-    protected consolidate(): void;
+    protected defaultComparator(a: E, b: E): number;
+    /**
+     * Create a new node.
+     * @param element
+     * @protected
+     */
+    protected createNode(element: E): FibonacciHeapNode<E>;
+    /**
+     * Merge the given node with the root list.
+     * @param node - The node to be merged.
+     */
+    protected mergeWithRoot(node: FibonacciHeapNode<E>): void;
     /**
      * O(log n) time operation.
      * Remove and return the top element (smallest or largest element) from the heap.
-     * @returns The top element or undefined if the heap is empty.
+     * @param node - The node to be removed.
+     * @protected
      */
-    poll(): E | undefined;
+    protected removeFromRoot(node: FibonacciHeapNode<E>): void;
     /**
      * O(log n) time operation.
      * Remove and return the top element (smallest or largest element) from the heap.
-     * @returns The top element or undefined if the heap is empty.
+     * @param y
+     * @param x
+     * @protected
      */
-    pop(): E | undefined;
+    protected link(y: FibonacciHeapNode<E>, x: FibonacciHeapNode<E>): void;
     /**
      * O(log n) time operation.
-     * merge two heaps. The heap that is merged will be cleared. The heap that is merged into will remain.
-     * @param heapToMerge
+     * Remove and return the top element (smallest or largest element) from the heap.
+     * @protected
      */
-    merge(heapToMerge: FibonacciHeap<E>): void;
+    protected consolidate(): void;
 }