binary-tree-typed 2.4.4 → 2.5.0

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

@@ -19,83 +19,6 @@ import { IterableEntryBase } from '../base';
  * If you try to insert another entry with the same key, the new one will replace the old entry.
  * 4. Unordered Collection: HashMap does not guarantee the order of entries, and the order may change over time.
  * @example
- * // should maintain insertion order
- *  const linkedHashMap = new LinkedHashMap<number, string>();
- *     linkedHashMap.set(1, 'A');
- *     linkedHashMap.set(2, 'B');
- *     linkedHashMap.set(3, 'C');
- *
- *     const result = Array.from(linkedHashMap);
- *     console.log(result); // [
- *  //      [1, 'A'],
- *  //      [2, 'B'],
- *  //      [3, 'C']
- *  //    ];
- * @example
- * // basic HashMap creation and set operation
- *  // Create a simple HashMap with key-value pairs
- *     const map = new HashMap<number, string>([
- *       [1, 'one'],
- *       [2, 'two'],
- *       [3, 'three']
- *     ]);
- *
- *     // Verify size
- *     console.log(map.size); // 3;
- *
- *     // Set a new key-value pair
- *     map.set(4, 'four');
- *     console.log(map.size); // 4;
- *
- *     // Verify entries
- *     console.log([...map.entries()]); // length: 4;
- * @example
- * // HashMap get and has operations
- *  const map = new HashMap<string, number>([
- *       ['apple', 1],
- *       ['banana', 2],
- *       ['cherry', 3]
- *     ]);
- *
- *     // Check if key exists
- *     console.log(map.has('apple')); // true;
- *     console.log(map.has('date')); // false;
- *
- *     // Get value by key
- *     console.log(map.get('banana')); // 2;
- *     console.log(map.get('grape')); // undefined;
- *
- *     // Get all keys and values
- *     const keys = [...map.keys()];
- *     const values = [...map.values()];
- *     console.log(keys); // contains 'apple';
- *     console.log(values); // contains 3;
- * @example
- * // HashMap iteration and filter operations
- *  const map = new HashMap<number, string>([
- *       [1, 'Alice'],
- *       [2, 'Bob'],
- *       [3, 'Charlie'],
- *       [4, 'Diana'],
- *       [5, 'Eve']
- *     ]);
- *
- *     // Iterate through entries
- *     const entries: [number, string][] = [];
- *     for (const [key, value] of map) {
- *       entries.push([key, value]);
- *     }
- *     console.log(entries); // length: 5;
- *
- *     // Filter operation (for iteration with collection methods)
- *     const filtered = [...map].filter(([key]) => key > 2);
- *     console.log(filtered.length); // 3;
- *
- *     // Map operation
- *     const values = [...map.values()].map(v => v.length);
- *     console.log(values); // contains 3; // 'Bob', 'Eve'
- *     console.log(values); // contains 7;
- * @example
  * // HashMap for user session caching O(1) performance
  *  interface UserSession {
  *       userId: number;
@@ -147,6 +70,19 @@ import { IterableEntryBase } from '../base';
  *     // Get all active sessions
  *     const activeCount = [...sessionCache.values()].length;
  *     console.log(activeCount); // 2;
+ * @example
+ * // Aggregate values
+ *  const counts = new HashMap<string, number>([['a', 5], ['b', 3], ['c', 8]]);
+ *
+ *     const total = counts.reduce((sum, v) => sum + (v ?? 0), 0);
+ *     console.log(total); // 16;
+ * @example
+ * // Iterate over entries
+ *  const map = new HashMap<string, number>([['x', 1], ['y', 2]]);
+ *     const keys: string[] = [];
+ *
+ *     map.forEach((v, k) => keys.push(k));
+ *     console.log(keys.sort()); // ['x', 'y'];
  */
 export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntryBase<K, V> {
     /**
@@ -200,12 +136,39 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * Check whether the map is empty.
      * @remarks Time O(1), Space O(1)
      * @returns True if size is 0.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // Check if empty
+   *  const map = new HashMap();
+   *     console.log(map.isEmpty()); // true;
      */
     isEmpty(): boolean;
     /**
      * Remove all entries and reset counters.
      * @remarks Time O(N), Space O(1)
      * @returns void
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // Remove all entries
+   *  const map = new HashMap<string, number>([['a', 1], ['b', 2]]);
+   *     map.clear();
+   *     console.log(map.isEmpty()); // true;
      */
     clear(): void;
     /**
@@ -220,6 +183,46 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @param key - Key.
      * @param value - Value.
      * @returns True when the operation succeeds.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // basic HashMap creation and set operation
+   *  // Create a simple HashMap with key-value pairs
+   *     const map = new HashMap<number, string>([
+   *       [1, 'one'],
+   *       [2, 'two'],
+   *       [3, 'three']
+   *     ]);
+   *
+   *     // Verify size
+   *     console.log(map.size); // 3;
+   *
+   *     // Set a new key-value pair
+   *     map.set(4, 'four');
+   *     console.log(map.size); // 4;
+   *
+   *     // Verify entries
+   *     console.log([...map.entries()]); // length: 4;
      */
     set(key: K, value: V): boolean;
     /**
@@ -227,6 +230,20 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @remarks Time O(N), Space O(N)
      * @param entryOrRawElements - Iterable of entries or raw elements to insert.
      * @returns Array of per-entry results.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // Add multiple entries
+   *  const map = new HashMap<string, number>();
+   *     map.setMany([['a', 1], ['b', 2], ['c', 3]]);
+   *     console.log(map.size); // 3;
      */
     setMany(entryOrRawElements: Iterable<R | [K, V]>): boolean[];
     /**
@@ -234,6 +251,38 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @remarks Time O(1), Space O(1)
      * @param key - Key to look up.
      * @returns Value or undefined.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // HashMap get and has operations
+   *  const map = new HashMap<string, number>([
+   *       ['apple', 1],
+   *       ['banana', 2],
+   *       ['cherry', 3]
+   *     ]);
+   *
+   *     // Check if key exists
+   *     console.log(map.has('apple')); // true;
+   *     console.log(map.has('date')); // false;
+   *
+   *     // Get value by key
+   *     console.log(map.get('banana')); // 2;
+   *     console.log(map.get('grape')); // undefined;
+   *
+   *     // Get all keys and values
+   *     const keys = [...map.keys()];
+   *     const values = [...map.values()];
+   *     console.log(keys); // contains 'apple';
+   *     console.log(values); // contains 3;
      */
     get(key: K): V | undefined;
     /**
@@ -241,6 +290,23 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @remarks Time O(1), Space O(1)
      * @param key - Key to test.
      * @returns True if present.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // Check key existence
+   *  const map = new HashMap<string, number>([['a', 1], ['b', 2]]);
+   *
+   *     console.log(map.has('a')); // true;
+   *     console.log(map.has('z')); // false;
      */
     has(key: K): boolean;
     /**
@@ -248,6 +314,24 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @remarks Time O(1), Space O(1)
      * @param key - Key to delete.
      * @returns True if the key was found and removed.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // Remove entries by key
+   *  const map = new HashMap<string, number>([['x', 10], ['y', 20], ['z', 30]]);
+   *
+   *     console.log(map.delete('y')); // true;
+   *     console.log(map.has('y')); // false;
+   *     console.log(map.size); // 2;
      */
     delete(key: K): boolean;
     /**
@@ -261,6 +345,21 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * Deep clone this map, preserving hashing behavior.
      * @remarks Time O(N), Space O(N)
      * @returns A new map with the same content.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // Create independent copy
+   *  const map = new HashMap<string, number>([['a', 1]]);
+   *     const copy = map.clone();
+   *     copy.set('a', 99);
+   *     console.log(map.get('a')); // 1;
      */
     clone(): this;
     /**
@@ -270,6 +369,24 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @param callbackfn - Mapping function (key, value, index, map) → newValue.
      * @param [thisArg] - Value for `this` inside the callback.
      * @returns A new map with transformed values.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // Transform all values
+   *  const prices = new HashMap<string, number>([['apple', 1], ['banana', 2]]);
+   *
+   *     const doubled = prices.map(v => (v ?? 0) * 2);
+   *     console.log(doubled.get('apple')); // 2;
+   *     console.log(doubled.get('banana')); // 4;
      */
     map<VM>(callbackfn: EntryCallback<K, V, VM>, thisArg?: any): any;
     /**
@@ -278,6 +395,42 @@ export declare class HashMap<K = any, V = any, R = [K, V]> extends IterableEntry
      * @param predicate - Predicate (key, value, index, map) → boolean.
      * @param [thisArg] - Value for `this` inside the predicate.
      * @returns A new map containing entries that satisfied the predicate.
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+     
+      * @example
+   * // HashMap iteration and filter operations
+   *  const map = new HashMap<number, string>([
+   *       [1, 'Alice'],
+   *       [2, 'Bob'],
+   *       [3, 'Charlie'],
+   *       [4, 'Diana'],
+   *       [5, 'Eve']
+   *     ]);
+   *
+   *     // Iterate through entries
+   *     const entries: [number, string][] = [];
+   *     for (const [key, value] of map) {
+   *       entries.push([key, value]);
+   *     }
+   *     console.log(entries); // length: 5;
+   *
+   *     // Filter operation (for iteration with collection methods)
+   *     const filtered = [...map].filter(([key]) => key > 2);
+   *     console.log(filtered.length); // 3;
+   *
+   *     // Map operation
+   *     const values = [...map.values()].map(v => v.length);
+   *     console.log(values); // contains 3; // 'Bob', 'Eve'
+   *     console.log(values); // contains 7;
      */
     filter(predicate: EntryCallback<K, V, boolean>, thisArg?: any): any;
     /**