data-structure-typed 2.5.3 → 2.6.0

package/docs-site-docusaurus/docs/api/classes/LinkedHashMap.md

@@ -344,7 +344,7 @@ Time O(N), Space O(1)
 clear(): void;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:1220](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1220)
+Defined in: [data-structures/hash/hash-map.ts:1221](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1221)
 
 Remove all entries.
 
@@ -368,7 +368,7 @@ Time O(n) typical, Space O(1)
 clone(): this;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:1226](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1226)
+Defined in: [data-structures/hash/hash-map.ts:1227](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1227)
 
 Deep clone preserving the concrete subtype.
 
@@ -391,10 +391,10 @@ Time O(n) typical, Space O(n)
 ### deleteAt()
 
 ```ts
-deleteAt(index): [K, V | undefined] | undefined;
+deleteAt(index): [K, V | undefined];
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:1203](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1203)
+Defined in: [data-structures/hash/hash-map.ts:1204](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1204)
 
 Delete the entry at a given index.
 
@@ -408,14 +408,18 @@ Zero-based index.
 
 #### Returns
 
-\[`K`, `V` \| `undefined`\] \| `undefined`
+\[`K`, `V` \| `undefined`\]
 
-The removed entry [key, value], or undefined if the index is out of range.
+The removed entry [key, value].
 
 #### Remarks
 
 Time O(N), Space O(1)
 
+#### Throws
+
+If index is out of bounds.
+
 ***
 
 ### deleteWhere()
@@ -520,7 +524,7 @@ Time O(n), Space O(1)
 filter(predicate, thisArg?): this;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:1231](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1231)
+Defined in: [data-structures/hash/hash-map.ts:1232](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1232)
 
 Filter entries and return the same-species structure.
 
@@ -736,7 +740,7 @@ Time O(n), Space O(1)
 isEmpty(): boolean;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:1212](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1212)
+Defined in: [data-structures/hash/hash-map.ts:1213](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1213)
 
 Whether there are no entries.
 
@@ -788,7 +792,7 @@ Time O(n), Space O(1)
 map<MK, MV>(callback, thisArg?): LinkedHashMap<MK, MV>;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:1250](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1250)
+Defined in: [data-structures/hash/hash-map.ts:1251](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1251)
 
 Map each entry to a new [key, value] pair and preserve order.
 
@@ -1087,7 +1091,7 @@ Time O(n), Space O(1)
 protected _getIterator(): IterableIterator<[K, V]>;
 ```
 
-Defined in: [data-structures/hash/hash-map.ts:1261](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1261)
+Defined in: [data-structures/hash/hash-map.ts:1262](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/hash/hash-map.ts#L1262)
 
 Underlying iterator for the default iteration protocol.
 

package/jest.integration.config.js

@@ -3,8 +3,7 @@ module.exports = {
   testEnvironment: 'node',
   testMatch: [
     '<rootDir>/test/integration/**/*.test.ts',
-    '<rootDir>/test/integration/**/*.test.js',
-    '<rootDir>/test/integration/**/*.test.mjs'
+    '<rootDir>/test/integration/**/*.test.js'
   ],
   transform: {
     '^.+\\.(ts|tsx)$': ['ts-jest', { tsconfig: 'tsconfig.test.json' }]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "data-structure-typed",
-  "version": "2.5.3",
+  "version": "2.6.0",
   "description": "Production-ready TypeScript data structures: Heap, Deque, Trie, Graph, Red-Black Tree, TreeMap, TreeSet, and more. Zero dependencies, type-safe, with getRank/getByRank/rangeByRank support.",
   "browser": "dist/umd/data-structure-typed.min.js",
   "umd:main": "dist/umd/data-structure-typed.min.js",
@@ -168,7 +168,8 @@
     "check:exist-latest": "sh scripts/check_exist_remotely.sh",
     "changelog": "auto-changelog",
     "coverage:badge": "istanbul-badges-readme",
-    "toc": "doctoc README.md"
+    "toc": "doctoc README.md",
+    "prepare": "husky"
   },
   "repository": {
     "type": "git",
@@ -194,11 +195,11 @@
     "@typescript-eslint/eslint-plugin": "^8.12.1",
     "@typescript-eslint/parser": "^8.12.1",
     "auto-changelog": "^2.5.0",
-    "avl-tree-typed": "^2.5.2",
+    "avl-tree-typed": "^2.5.3",
     "benchmark": "^2.1.4",
-    "binary-tree-typed": "^2.5.2",
-    "bst-typed": "^2.5.2",
-    "data-structure-typed": "^2.5.2",
+    "binary-tree-typed": "^2.5.3",
+    "bst-typed": "^2.5.3",
+    "data-structure-typed": "^2.5.3",
     "dependency-cruiser": "^16.5.0",
     "doctoc": "^2.2.1",
     "eslint": "^9.13.0",
@@ -207,7 +208,8 @@
     "eslint-import-resolver-typescript": "^3.6.3",
     "eslint-plugin-import": "^2.31.0",
     "fast-glob": "^3.3.2",
-    "heap-typed": "^2.5.2",
+    "heap-typed": "^2.5.3",
+    "husky": "^9.1.7",
     "istanbul-badges-readme": "^1.9.0",
     "jest": "^29.7.0",
     "js-sdsl": "^4.4.2",

package/src/data-structures/base/iterable-element-base.ts

@@ -191,6 +191,38 @@ export abstract class IterableElementBase<E, R> implements Iterable<E> {
     return false;
   }
 
+  /**
+   * Check whether a value exists (Array-compatible alias for `has`).
+   * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1).
+   * @param element - Element to search for (uses `===`).
+   * @returns `true` if found.
+   */
+  includes(element: E): boolean {
+    return this.has(element);
+  }
+
+  /**
+   * Return an iterator of `[index, value]` pairs (Array-compatible).
+   * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+   */
+  *entries(): IterableIterator<[number, E]> {
+    let index = 0;
+    for (const value of this) {
+      yield [index++, value];
+    }
+  }
+
+  /**
+   * Return an iterator of numeric indices (Array-compatible).
+   * @remarks Provided for familiarity when migrating from Array. Time O(n), Space O(1) per step.
+   */
+  *keys(): IterableIterator<number> {
+    let index = 0;
+    for (const _ of this) {
+      yield index++;
+    }
+  }
+
   reduce(callbackfn: ReduceElementCallback<E, R>): E;
   reduce(callbackfn: ReduceElementCallback<E, R>, initialValue: E): E;
   reduce<U>(callbackfn: ReduceElementCallback<E, R, U>, initialValue: U): U;

package/src/data-structures/base/linear-base.ts

@@ -327,6 +327,17 @@ export abstract class LinearBase<
    */
   abstract reverse(): this;
 
+  /**
+   * Return a new instance of the same type with elements in reverse order (non-mutating).
+   * @remarks Provided for familiarity when migrating from Array (ES2023 `toReversed`). Time O(n), Space O(n).
+   * @returns A new reversed instance.
+   */
+  toReversed(): this {
+    const cloned = this.clone();
+    cloned.reverse();
+    return cloned as this;
+  }
+
   /**
    * Append one element or node to the tail.
    * @param elementOrNode - Element or node.

package/src/data-structures/binary-tree/avl-tree.ts

@@ -494,6 +494,18 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    
    
    
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
+   
    
    
    
@@ -638,6 +650,15 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    
    
    
+   
+   
+   
+   
+   
+   
+   
+   
+   
    
    
    
@@ -736,6 +757,12 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    
    
    
+   
+   
+   
+   
+   
+   
    
    
    
@@ -888,6 +915,15 @@ export class AVLTree<K = any, V = any, R = any> extends BST<K, V, R> implements
    
    
    
+   
+   
+   
+   
+   
+   
+   
+   
+   
    
    
    

package/src/data-structures/binary-tree/binary-indexed-tree.ts

@@ -119,6 +119,12 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
+   
+   
+   
    
    
    
@@ -204,6 +210,12 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
+   
+   
+   
    
    
    
@@ -289,6 +301,12 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
+   
+   
+   
    
    
    
@@ -374,6 +392,12 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
+   
+   
+   
    
    
    
@@ -457,6 +481,12 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
+   
+   
+   
    
    
    
@@ -548,6 +578,12 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
+   
+   
+   
    
    
    
@@ -608,6 +644,9 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
    
    
    
@@ -681,6 +720,9 @@ export class BinaryIndexedTree implements Iterable<number> {
    
    
    
+   
+   
+   
    
    
    

package/src/data-structures/binary-tree/binary-tree.ts

@@ -596,6 +596,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -657,6 +660,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -780,6 +786,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -831,6 +840,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -908,6 +920,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1025,6 +1040,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1070,6 +1088,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1210,6 +1231,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1289,6 +1313,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1362,6 +1389,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1428,6 +1458,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1530,6 +1563,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1583,6 +1619,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1648,6 +1687,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1743,6 +1785,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -1812,6 +1857,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2122,6 +2170,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2214,6 +2265,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2365,6 +2419,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2469,6 +2526,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2591,6 +2651,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2757,6 +2820,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2814,6 +2880,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2875,6 +2944,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+   
    
    
    
@@ -2969,6 +3041,9 @@ export class BinaryTree<K = any, V = any, R = any>
    
    
    
+   
+   
+