data-structure-typed 1.46.3 → 1.46.4

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

@@ -5,21 +5,21 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import { HashMapLinkedNode, IterableWithSizeOrLength } from '../../types';
+import { HashMapLinkedNode, HashMapOptions } from '../../types';
 export declare class HashMap<K = any, V = any> {
-    readonly OBJ_KEY_INDEX: symbol;
-    protected _nodes: HashMapLinkedNode<K, V>[];
-    protected _orgMap: Record<string, HashMapLinkedNode<K, V>>;
-    protected _head: HashMapLinkedNode<K, V>;
-    protected _tail: HashMapLinkedNode<K, V>;
-    protected readonly _sentinel: HashMapLinkedNode<K, V>;
+    protected _noObjMap: Record<string, HashMapLinkedNode<K, V | undefined>>;
+    protected _objMap: WeakMap<WeakKey, HashMapLinkedNode<K, V | undefined>>;
+    protected _head: HashMapLinkedNode<K, V | undefined>;
+    protected _tail: HashMapLinkedNode<K, V | undefined>;
+    protected readonly _sentinel: HashMapLinkedNode<K, V | undefined>;
+    protected _hashFn: (key: K) => string;
+    protected _objHashFn: (key: K) => WeakKey;
     /**
-     * The constructor initializes a HashMap object with an optional initial set of key-value pairs.
-     * @param {Iterable<[K, V]>} elements - The `hashMap` parameter is an optional parameter of type `HashMapOptions<[K,
-     * V]>`. It is an array of key-value pairs, where each pair is represented as an array `[K, V]`. The
-     * `K` represents the type of the key and `V` represents the
+     * The constructor initializes a HashMapLinkedNode with an optional iterable of key-value pairs.
+     * @param options - The `options` parameter is an object that contains the `elements` property. The
+     * `elements` property is an iterable that contains key-value pairs represented as arrays `[K, V]`.
      */
-    constructor(elements?: IterableWithSizeOrLength<[K, V]>);
+    constructor(options?: HashMapOptions<K, V>);
     protected _size: number;
     get size(): number;
     /**
@@ -43,12 +43,12 @@ export declare class HashMap<K = any, V = any> {
     /**
      * The `begin()` function in TypeScript iterates over a linked list and yields key-value pairs.
      */
-    begin(): Generator<(K | V)[], void, unknown>;
+    begin(): Generator<(K | V | undefined)[], void, unknown>;
     /**
      * The function `reverseBegin()` iterates over a linked list in reverse order, yielding each node's
      * key and value.
      */
-    reverseBegin(): Generator<(K | V)[], void, unknown>;
+    reverseBegin(): Generator<(K | V | undefined)[], void, unknown>;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -59,10 +59,9 @@ export declare class HashMap<K = any, V = any> {
      * type, but typically it is a string or symbol.
      * @param {V} [value] - The `value` parameter is an optional parameter of type `V`. It represents the
      * value associated with the key being set in the data structure.
-     * @param {boolean} isObjectKey - A boolean flag indicating whether the key is an object key or not.
      * @returns the size of the data structure after the key-value pair has been set.
      */
-    set(key: K, value?: V, isObjectKey?: boolean): number;
+    set(key: K, value?: V): number;
     /**
      * Time Complexity: O(1)
      * Space Complexity: O(1)
@@ -71,15 +70,12 @@ export declare class HashMap<K = any, V = any> {
      * key directly or by using an index stored in the key object.
      * @param {K} key - The `key` parameter is the key used to retrieve a value from the map. It can be
      * of any type, but typically it is a string or symbol.
-     * @param {boolean} isObjectKey - The `isObjectKey` parameter is a boolean flag that indicates
-     * whether the `key` parameter is an object key or not. If `isObjectKey` is `true`, it means that
-     * `key` is an object key. If `isObjectKey` is `false`, it means that `key`
      * @returns The value associated with the given key is being returned. If the key is an object key,
      * the value is retrieved from the `_nodes` array using the index stored in the `OBJ_KEY_INDEX`
-     * property of the key. If the key is a string key, the value is retrieved from the `_orgMap` object
+     * property of the key. If the key is a string key, the value is retrieved from the `_noObjMap` object
      * using the key itself. If the key is not found, `undefined` is
      */
-    get(key: K, isObjectKey?: boolean): V | undefined;
+    get(key: K): V | undefined;
     /**
      * Time Complexity: O(n), where n is the index.
      * Space Complexity: O(1)
@@ -99,13 +95,10 @@ export declare class HashMap<K = any, V = any> {
      * The `delete` function removes a key-value pair from a map-like data structure.
      * @param {K} key - The `key` parameter is the key that you want to delete from the data structure.
      * It can be of any type, but typically it is a string or an object.
-     * @param {boolean} isObjectKey - The `isObjectKey` parameter is a boolean flag that indicates
-     * whether the `key` parameter is an object key or not. If `isObjectKey` is `true`, it means that the
-     * `key` parameter is an object key. If `isObjectKey` is `false`, it means that the
      * @returns a boolean value. It returns `true` if the deletion was successful, and `false` if the key
      * was not found.
      */
-    delete(key: K, isObjectKey?: boolean): boolean;
+    delete(key: K): boolean;
     /**
      * Time Complexity: O(n), where n is the index.
      * Space Complexity: O(1)
@@ -142,6 +135,9 @@ export declare class HashMap<K = any, V = any> {
      * HashMap. It takes three arguments:
      */
     forEach(callback: (element: [K, V], index: number, hashMap: HashMap<K, V>) => void): void;
+    filter(predicate: (element: [K, V], map: HashMap<K, V>) => boolean): HashMap<K, V>;
+    map<NV>(callback: (element: [K, V], map: HashMap<K, V>) => NV): HashMap<K, NV>;
+    reduce<A>(callback: (accumulator: A, element: [K, V], map: HashMap<K, V>) => A, initialValue: A): A;
     /**
      * Time Complexity: O(n), where n is the number of elements in the HashMap.
      * Space Complexity: O(1)
@@ -159,5 +155,5 @@ export declare class HashMap<K = any, V = any> {
      * represents a node in a linked list. It contains a key-value pair and references to the previous
      * and next nodes in the list.
      */
-    protected _deleteNode(node: HashMapLinkedNode<K, V>): void;
+    protected _deleteNode(node: HashMapLinkedNode<K, V | undefined>): void;
 }

package/dist/mjs/data-structures/hash/hash-map.js

@@ -5,26 +5,34 @@
  * @copyright Copyright (c) 2022 Tyler Zeng <zrwusa@gmail.com>
  * @license MIT License
  */
-import { isObjOrFunc, rangeCheck } from '../../utils';
+import { isWeakKey, rangeCheck } from '../../utils';
 export class HashMap {
-    OBJ_KEY_INDEX = Symbol('OBJ_KEY_INDEX');
-    _nodes = [];
-    _orgMap = {};
+    _noObjMap = {};
+    _objMap = new WeakMap();
     _head;
     _tail;
     _sentinel;
+    _hashFn;
+    _objHashFn;
     /**
-     * The constructor initializes a HashMap object with an optional initial set of key-value pairs.
-     * @param {Iterable<[K, V]>} elements - The `hashMap` parameter is an optional parameter of type `HashMapOptions<[K,
-     * V]>`. It is an array of key-value pairs, where each pair is represented as an array `[K, V]`. The
-     * `K` represents the type of the key and `V` represents the
+     * The constructor initializes a HashMapLinkedNode with an optional iterable of key-value pairs.
+     * @param options - The `options` parameter is an object that contains the `elements` property. The
+     * `elements` property is an iterable that contains key-value pairs represented as arrays `[K, V]`.
      */
-    constructor(elements = []) {
-        Object.setPrototypeOf(this._orgMap, null);
+    constructor(options = {
+        elements: [],
+        hashFn: (key) => String(key),
+        objHashFn: (key) => key
+    }) {
         this._sentinel = {};
         this._sentinel.prev = this._sentinel.next = this._head = this._tail = this._sentinel;
-        for (const el of elements) {
-            this.set(el[0], el[1]);
+        const { elements, hashFn, objHashFn } = options;
+        this._hashFn = hashFn;
+        this._objHashFn = objHashFn;
+        if (elements) {
+            for (const el of elements) {
+                this.set(el[0], el[1]);
+            }
         }
     }
     _size = 0;
@@ -88,52 +96,52 @@ export class HashMap {
      * type, but typically it is a string or symbol.
      * @param {V} [value] - The `value` parameter is an optional parameter of type `V`. It represents the
      * value associated with the key being set in the data structure.
-     * @param {boolean} isObjectKey - A boolean flag indicating whether the key is an object key or not.
      * @returns the size of the data structure after the key-value pair has been set.
      */
-    set(key, value, isObjectKey = isObjOrFunc(key)) {
-        let newTail;
-        if (isObjectKey) {
-            const index = key[this.OBJ_KEY_INDEX];
-            if (index !== undefined) {
-                this._nodes[index].value = value;
-                return this._size;
+    set(key, value) {
+        let node;
+        if (isWeakKey(key)) {
+            // const hash = this._objHashFn(key);
+            const hash = key;
+            node = this._objMap.get(hash);
+            if (node) {
+                // If the node already exists, update its value
+                node.value = value;
+            }
+            else {
+                // Create new node
+                node = { key: hash, value, prev: this._tail, next: this._sentinel };
+                // Add new nodes to _objMap and linked list
+                this._objMap.set(hash, node);
             }
-            Object.defineProperty(key, this.OBJ_KEY_INDEX, {
-                value: this._nodes.length,
-                configurable: true
-            });
-            newTail = {
-                key: key,
-                value: value,
-                prev: this._tail,
-                next: this._sentinel
-            };
-            this._nodes.push(newTail);
         }
         else {
-            const node = this._orgMap[key];
+            const hash = this._hashFn(key);
+            // Non-object keys are handled in the same way as the original implementation
+            node = this._noObjMap[hash];
             if (node) {
                 node.value = value;
-                return this._size;
             }
-            this._orgMap[key] = newTail = {
-                key: key,
-                value: value,
-                prev: this._tail,
-                next: this._sentinel
-            };
+            else {
+                this._noObjMap[hash] = node = {
+                    key,
+                    value,
+                    prev: this._tail,
+                    next: this._sentinel
+                };
+            }
         }
         if (this._size === 0) {
-            this._head = newTail;
-            this._sentinel.next = newTail;
+            this._head = node;
+            this._sentinel.next = node;
         }
         else {
-            this._tail.next = newTail;
+            this._tail.next = node;
         }
-        this._tail = newTail;
-        this._sentinel.prev = newTail;
-        return ++this._size;
+        this._tail = node;
+        this._sentinel.prev = node;
+        this._size++;
+        return this._size;
     }
     /**
      * Time Complexity: O(1)
@@ -143,21 +151,22 @@ export class HashMap {
      * key directly or by using an index stored in the key object.
      * @param {K} key - The `key` parameter is the key used to retrieve a value from the map. It can be
      * of any type, but typically it is a string or symbol.
-     * @param {boolean} isObjectKey - The `isObjectKey` parameter is a boolean flag that indicates
-     * whether the `key` parameter is an object key or not. If `isObjectKey` is `true`, it means that
-     * `key` is an object key. If `isObjectKey` is `false`, it means that `key`
      * @returns The value associated with the given key is being returned. If the key is an object key,
      * the value is retrieved from the `_nodes` array using the index stored in the `OBJ_KEY_INDEX`
-     * property of the key. If the key is a string key, the value is retrieved from the `_orgMap` object
+     * property of the key. If the key is a string key, the value is retrieved from the `_noObjMap` object
      * using the key itself. If the key is not found, `undefined` is
      */
-    get(key, isObjectKey = isObjOrFunc(key)) {
-        if (isObjectKey) {
-            const index = key[this.OBJ_KEY_INDEX];
-            return index !== undefined ? this._nodes[index].value : undefined;
+    get(key) {
+        if (isWeakKey(key)) {
+            const hash = this._objHashFn(key);
+            const node = this._objMap.get(hash);
+            return node ? node.value : undefined;
+        }
+        else {
+            const hash = this._hashFn(key);
+            const node = this._noObjMap[hash];
+            return node ? node.value : undefined;
         }
-        const node = this._orgMap[key];
-        return node ? node.value : undefined;
     }
     /**
      * Time Complexity: O(n), where n is the index.
@@ -185,28 +194,32 @@ export class HashMap {
      * The `delete` function removes a key-value pair from a map-like data structure.
      * @param {K} key - The `key` parameter is the key that you want to delete from the data structure.
      * It can be of any type, but typically it is a string or an object.
-     * @param {boolean} isObjectKey - The `isObjectKey` parameter is a boolean flag that indicates
-     * whether the `key` parameter is an object key or not. If `isObjectKey` is `true`, it means that the
-     * `key` parameter is an object key. If `isObjectKey` is `false`, it means that the
      * @returns a boolean value. It returns `true` if the deletion was successful, and `false` if the key
      * was not found.
      */
-    delete(key, isObjectKey = isObjOrFunc(key)) {
+    delete(key) {
         let node;
-        if (isObjectKey) {
-            const index = key[this.OBJ_KEY_INDEX];
-            if (index === undefined)
-                return false;
-            delete key[this.OBJ_KEY_INDEX];
-            node = this._nodes[index];
-            delete this._nodes[index];
+        if (isWeakKey(key)) {
+            const hash = this._objHashFn(key);
+            // Get nodes from WeakMap
+            node = this._objMap.get(hash);
+            if (!node) {
+                return false; // If the node does not exist, return false
+            }
+            // Remove nodes from WeakMap
+            this._objMap.delete(hash);
         }
         else {
-            node = this._orgMap[key];
-            if (node === undefined)
-                return false;
-            delete this._orgMap[key];
+            const hash = this._hashFn(key);
+            // Get nodes from noObjMap
+            node = this._noObjMap[hash];
+            if (!node) {
+                return false; // If the node does not exist, return false
+            }
+            // Remove nodes from orgMap
+            delete this._noObjMap[hash];
         }
+        // Remove node from doubly linked list
         this._deleteNode(node);
         return true;
     }
@@ -246,13 +259,7 @@ export class HashMap {
      * The `clear` function clears all the elements in a data structure and resets its properties.
      */
     clear() {
-        // const OBJ_KEY_INDEX = this.OBJ_KEY_INDEX;
-        // this._nodes.forEach(el => {
-        //   delete (<Record<symbol, number>><unknown>el.key)[OBJ_KEY_INDEX];
-        // });
-        this._nodes = [];
-        this._orgMap = {};
-        Object.setPrototypeOf(this._orgMap, null);
+        this._noObjMap = {};
         this._size = 0;
         this._head = this._tail = this._sentinel.prev = this._sentinel.next = this._sentinel;
     }
@@ -273,6 +280,30 @@ export class HashMap {
             node = node.next;
         }
     }
+    filter(predicate) {
+        const filteredMap = new HashMap();
+        for (const [key, value] of this) {
+            if (predicate([key, value], this)) {
+                filteredMap.set(key, value);
+            }
+        }
+        return filteredMap;
+    }
+    map(callback) {
+        const mappedMap = new HashMap();
+        for (const [key, value] of this) {
+            const newValue = callback([key, value], this);
+            mappedMap.set(key, newValue);
+        }
+        return mappedMap;
+    }
+    reduce(callback, initialValue) {
+        let accumulator = initialValue;
+        for (const element of this) {
+            accumulator = callback(accumulator, element, this);
+        }
+        return accumulator;
+    }
     /**
      * Time Complexity: O(n), where n is the number of elements in the HashMap.
      * Space Complexity: O(1)

package/dist/mjs/data-structures/hash/index.d.ts

@@ -1,6 +1,2 @@
 export * from './hash-table';
-export * from './coordinate-map';
-export * from './coordinate-set';
-export * from './tree-map';
-export * from './tree-set';
 export * from './hash-map';

package/dist/mjs/data-structures/hash/index.js

@@ -1,6 +1,2 @@
 export * from './hash-table';
-export * from './coordinate-map';
-export * from './coordinate-set';
-export * from './tree-map';
-export * from './tree-set';
 export * from './hash-map';

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

@@ -4,3 +4,8 @@ export type HashMapLinkedNode<K, V> = {
     next: HashMapLinkedNode<K, V>;
     prev: HashMapLinkedNode<K, V>;
 };
+export type HashMapOptions<K, V> = {
+    elements: Iterable<[K, V]>;
+    hashFn: (key: K) => string;
+    objHashFn: (key: K) => WeakKey;
+};

package/dist/mjs/types/data-structures/hash/index.d.ts

@@ -1,7 +1,3 @@
-export * from './coordinate-map';
-export * from './coordinate-set';
 export * from './hash-map';
 export * from './hash-table';
-export * from './tree-map';
-export * from './tree-set';
 export type HashFunction<K> = (key: K) => number;

package/dist/mjs/types/data-structures/hash/index.js

@@ -1,6 +1,2 @@
-export * from './coordinate-map';
-export * from './coordinate-set';
 export * from './hash-map';
 export * from './hash-table';
-export * from './tree-map';
-export * from './tree-set';

package/dist/mjs/utils/utils.d.ts

@@ -20,5 +20,5 @@ export declare const trampolineAsync: (fn: TrlAsyncFn) => ((...args: [...Paramet
 export declare const getMSB: (value: number) => number;
 export declare const rangeCheck: (index: number, min: number, max: number, message?: string) => void;
 export declare const throwRangeError: (message?: string) => void;
-export declare const isObjOrFunc: (input: unknown) => input is Record<string, unknown> | ((...args: any[]) => any);
+export declare const isWeakKey: (input: unknown) => input is WeakKey;
 export declare const calcMinUnitsRequired: (totalQuantity: number, unitSize: number) => number;

package/dist/mjs/utils/utils.js

@@ -59,7 +59,7 @@ export const rangeCheck = (index, min, max, message = 'Index out of bounds.') =>
 export const throwRangeError = (message = 'The value is off-limits.') => {
     throw new RangeError(message);
 };
-export const isObjOrFunc = (input) => {
+export const isWeakKey = (input) => {
     const inputType = typeof input;
     return (inputType === 'object' && input !== null) || inputType === 'function';
 };