avl-tree-typed 1.51.8 → 1.51.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/dist/data-structures/binary-tree/avl-tree-multi-map.d.ts +104 -66
  2. package/dist/data-structures/binary-tree/avl-tree-multi-map.js +119 -87
  3. package/dist/data-structures/binary-tree/avl-tree.d.ts +80 -60
  4. package/dist/data-structures/binary-tree/avl-tree.js +78 -59
  5. package/dist/data-structures/binary-tree/binary-tree.d.ts +316 -224
  6. package/dist/data-structures/binary-tree/binary-tree.js +471 -361
  7. package/dist/data-structures/binary-tree/bst.d.ts +198 -200
  8. package/dist/data-structures/binary-tree/bst.js +215 -249
  9. package/dist/data-structures/binary-tree/rb-tree.d.ts +71 -72
  10. package/dist/data-structures/binary-tree/rb-tree.js +107 -98
  11. package/dist/data-structures/binary-tree/tree-multi-map.d.ts +90 -73
  12. package/dist/data-structures/binary-tree/tree-multi-map.js +105 -93
  13. package/dist/data-structures/graph/abstract-graph.d.ts +10 -15
  14. package/dist/data-structures/graph/abstract-graph.js +10 -15
  15. package/dist/data-structures/hash/hash-map.d.ts +31 -38
  16. package/dist/data-structures/hash/hash-map.js +40 -55
  17. package/dist/data-structures/queue/deque.d.ts +2 -3
  18. package/dist/data-structures/queue/deque.js +2 -3
  19. package/dist/data-structures/trie/trie.d.ts +1 -1
  20. package/dist/data-structures/trie/trie.js +1 -1
  21. package/dist/interfaces/binary-tree.d.ts +6 -6
  22. package/dist/types/common.d.ts +1 -2
  23. package/dist/types/data-structures/binary-tree/avl-tree-multi-map.d.ts +2 -2
  24. package/dist/types/data-structures/binary-tree/avl-tree.d.ts +2 -2
  25. package/dist/types/data-structures/binary-tree/binary-tree.d.ts +5 -4
  26. package/dist/types/data-structures/binary-tree/bst.d.ts +4 -4
  27. package/dist/types/data-structures/binary-tree/rb-tree.d.ts +2 -2
  28. package/dist/types/data-structures/binary-tree/tree-multi-map.d.ts +3 -3
  29. package/dist/utils/utils.js +3 -5
  30. package/package.json +2 -2
  31. package/src/data-structures/binary-tree/avl-tree-multi-map.ts +142 -92
  32. package/src/data-structures/binary-tree/avl-tree.ts +94 -66
  33. package/src/data-structures/binary-tree/binary-tree.ts +530 -398
  34. package/src/data-structures/binary-tree/bst.ts +251 -270
  35. package/src/data-structures/binary-tree/rb-tree.ts +121 -100
  36. package/src/data-structures/binary-tree/tree-multi-map.ts +125 -99
  37. package/src/data-structures/graph/abstract-graph.ts +10 -10
  38. package/src/data-structures/hash/hash-map.ts +42 -49
  39. package/src/data-structures/queue/deque.ts +2 -2
  40. package/src/data-structures/queue/queue.ts +1 -1
  41. package/src/data-structures/trie/trie.ts +2 -2
  42. package/src/interfaces/binary-tree.ts +8 -7
  43. package/src/types/common.ts +1 -2
  44. package/src/types/data-structures/binary-tree/avl-tree-multi-map.ts +2 -2
  45. package/src/types/data-structures/binary-tree/avl-tree.ts +2 -2
  46. package/src/types/data-structures/binary-tree/binary-tree.ts +5 -4
  47. package/src/types/data-structures/binary-tree/bst.ts +4 -4
  48. package/src/types/data-structures/binary-tree/rb-tree.ts +2 -2
  49. package/src/types/data-structures/binary-tree/tree-multi-map.ts +3 -3
  50. package/src/utils/utils.ts +3 -3
@@ -1,9 +1,9 @@
1
1
  import { BST, BSTNode } from '../../../data-structures';
2
2
  import type { BinaryTreeOptions } from './binary-tree';
3
- import { Comparator } from "../../common";
4
- import { Comparable } from "../../utils";
3
+ import { Comparator } from '../../common';
4
+ import { Comparable } from '../../utils';
5
5
  export type BSTNodeNested<K extends Comparable, V> = BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, BSTNode<K, V, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
6
- export type BSTNested<K extends Comparable, V, N extends BSTNode<K, V, N>> = BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, BST<K, V, N, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
7
- export type BSTOptions<K> = BinaryTreeOptions & {
6
+ export type BSTNested<K extends Comparable, V, R, NODE extends BSTNode<K, V, NODE>> = BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, BST<K, V, R, NODE, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
7
+ export type BSTOptions<K, V, R> = BinaryTreeOptions<K, V, R> & {
8
8
  comparator?: Comparator<K>;
9
9
  };
@@ -3,5 +3,5 @@ import type { BSTOptions } from "./bst";
3
3
  import { Comparable } from "../../utils";
4
4
  export type RBTNColor = 'RED' | 'BLACK';
5
5
  export type RedBlackTreeNodeNested<K extends Comparable, V> = RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, RedBlackTreeNode<K, V, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
6
- export type RedBlackTreeNested<K extends Comparable, V, N extends RedBlackTreeNode<K, V, N>> = RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, RedBlackTree<K, V, N, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
7
- export type RBTreeOptions<K> = BSTOptions<K> & {};
6
+ export type RedBlackTreeNested<K extends Comparable, V, R, NODE extends RedBlackTreeNode<K, V, NODE>> = RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, RedBlackTree<K, V, R, NODE, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
7
+ export type RBTreeOptions<K, V, R> = BSTOptions<K, V, R> & {};
@@ -1,6 +1,6 @@
1
1
  import { TreeMultiMap, TreeMultiMapNode } from '../../../data-structures';
2
2
  import type { RBTreeOptions } from './rb-tree';
3
- import { Comparable } from "../../utils";
3
+ import { Comparable } from '../../utils';
4
4
  export type TreeMultiMapNodeNested<K extends Comparable, V> = TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, TreeMultiMapNode<K, V, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
5
- export type TreeMultiMapNested<K extends Comparable, V, N extends TreeMultiMapNode<K, V, N>> = TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, TreeMultiMap<K, V, N, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
6
- export type TreeMultiMapOptions<K> = RBTreeOptions<K> & {};
5
+ export type TreeMultiMapNested<K extends Comparable, V, R, NODE extends TreeMultiMapNode<K, V, NODE>> = TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, TreeMultiMap<K, V, R, NODE, any>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>;
6
+ export type TreeMultiMapOptions<K, V, R> = RBTreeOptions<K, V, R> & {};
@@ -95,7 +95,7 @@ exports.roundFixed = roundFixed;
95
95
  function isComparable(key) {
96
96
  const keyType = typeof key;
97
97
  if (keyType === 'number')
98
- return isNaN(key);
98
+ return !isNaN(key);
99
99
  if (keyType === 'string')
100
100
  return true;
101
101
  if (keyType === 'bigint')
@@ -111,10 +111,8 @@ function isComparable(key) {
111
111
  if (keyType === 'object') {
112
112
  if (key === null)
113
113
  return true;
114
- if (typeof key.valueOf === 'function')
115
- return isComparable(key.valueOf());
116
- if (typeof key.toString === 'function')
117
- return isComparable(key.toString());
114
+ // if (typeof key.valueOf === 'function') return isComparable(key.valueOf()); // This will keep recursing because every object has a valueOf method.
115
+ // if (typeof key.toString === 'function') return isComparable(key.toString()); // This will also keep recursing because every string type has a toString method.
118
116
  return false;
119
117
  }
120
118
  return false;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "avl-tree-typed",
3
- "version": "1.51.8",
3
+ "version": "1.51.9",
4
4
  "description": "AVLTree(Adelson-Velsky and Landis Tree). Javascript & Typescript Data Structure.",
5
5
  "main": "dist/index.js",
6
6
  "scripts": {
@@ -163,6 +163,6 @@
163
163
  "typescript": "^4.9.5"
164
164
  },
165
165
  "dependencies": {
166
- "data-structure-typed": "^1.51.8"
166
+ "data-structure-typed": "^1.51.9"
167
167
  }
168
168
  }
@@ -16,6 +16,7 @@ import type {
16
16
  IterationType,
17
17
  KeyOrNodeOrEntry
18
18
  } from '../../types';
19
+ import { BTNEntry } from '../../types';
19
20
  import { IBinaryTree } from '../../interfaces';
20
21
  import { AVLTree, AVLTreeNode } from './avl-tree';
21
22
 
@@ -65,19 +66,36 @@ export class AVLTreeMultiMapNode<
65
66
  export class AVLTreeMultiMap<
66
67
  K extends Comparable,
67
68
  V = any,
69
+ R = BTNEntry<K, V>,
68
70
  NODE extends AVLTreeMultiMapNode<K, V, NODE> = AVLTreeMultiMapNode<K, V, AVLTreeMultiMapNodeNested<K, V>>,
69
- TREE extends AVLTreeMultiMap<K, V, NODE, TREE> = AVLTreeMultiMap<K, V, NODE, AVLTreeMultiMapNested<K, V, NODE>>
71
+ TREE extends AVLTreeMultiMap<K, V, R, NODE, TREE> = AVLTreeMultiMap<
72
+ K,
73
+ V,
74
+ R,
75
+ NODE,
76
+ AVLTreeMultiMapNested<K, V, R, NODE>
77
+ >
70
78
  >
71
- extends AVLTree<K, V, NODE, TREE>
72
- implements IBinaryTree<K, V, NODE, TREE> {
73
- constructor(keysOrNodesOrEntries: Iterable<KeyOrNodeOrEntry<K, V, NODE>> = [], options?: AVLTreeMultiMapOptions<K>) {
79
+ extends AVLTree<K, V, R, NODE, TREE>
80
+ implements IBinaryTree<K, V, R, NODE, TREE> {
81
+ /**
82
+ * The constructor initializes a new AVLTreeMultiMap object with optional initial elements.
83
+ * @param keysOrNodesOrEntriesOrRawElements - The `keysOrNodesOrEntriesOrRawElements` parameter is an
84
+ * iterable object that can contain either keys, nodes, entries, or raw elements.
85
+ * @param [options] - The `options` parameter is an optional object that can be used to customize the
86
+ * behavior of the AVLTreeMultiMap. It can include properties such as `compareKeys` and
87
+ * `compareValues` functions to define custom comparison logic for keys and values, respectively.
88
+ */
89
+ constructor(
90
+ keysOrNodesOrEntriesOrRawElements: Iterable<R | KeyOrNodeOrEntry<K, V, NODE>> = [],
91
+ options?: AVLTreeMultiMapOptions<K, V, R>
92
+ ) {
74
93
  super([], options);
75
- if (keysOrNodesOrEntries) this.addMany(keysOrNodesOrEntries);
94
+ if (keysOrNodesOrEntriesOrRawElements) this.addMany(keysOrNodesOrEntriesOrRawElements);
76
95
  }
77
96
 
78
97
  protected _count = 0;
79
98
 
80
- // TODO the _count is not accurate after nodes count modified
81
99
  /**
82
100
  * The function calculates the sum of the count property of all nodes in a tree using depth-first
83
101
  * search.
@@ -107,20 +125,29 @@ export class AVLTreeMultiMap<
107
125
  }
108
126
 
109
127
  /**
110
- * The function creates a new BSTNode with the given key, value, and count.
111
- * @param {K} key - The key parameter is the unique identifier for the binary tree node. It is used to
112
- * distinguish one node from another in the tree.
113
- * @param {NODE} value - The `value` parameter represents the value that will be stored in the binary search tree node.
114
- * @param {number} [count] - The "count" parameter is an optional parameter of type number. It represents the number of
115
- * occurrences of the value in the binary search tree node. If not provided, the count will default to 1.
116
- * @returns A new instance of the BSTNode class with the specified key, value, and count (if provided).
128
+ * The function creates a new AVLTreeMultiMapNode with the specified key, value, and count.
129
+ * @param {K} key - The key parameter represents the key of the node being created. It is of type K,
130
+ * which is a generic type that can be replaced with any specific type when using the function.
131
+ * @param {V} [value] - The `value` parameter is an optional parameter that represents the value
132
+ * associated with the key in the node. It is of type `V`, which can be any data type.
133
+ * @param {number} [count] - The `count` parameter represents the number of occurrences of a
134
+ * key-value pair in the AVLTreeMultiMapNode. It is an optional parameter, so it can be omitted when
135
+ * calling the `createNode` method. If provided, it specifies the initial count for the node.
136
+ * @returns a new instance of the AVLTreeMultiMapNode class, casted as NODE.
117
137
  */
118
138
  override createNode(key: K, value?: V, count?: number): NODE {
119
139
  return new AVLTreeMultiMapNode(key, value, count) as NODE;
120
140
  }
121
141
 
122
- override createTree(options?: AVLTreeMultiMapOptions<K>): TREE {
123
- return new AVLTreeMultiMap<K, V, NODE, TREE>([], {
142
+ /**
143
+ * The function creates a new AVLTreeMultiMap object with the specified options and returns it.
144
+ * @param [options] - The `options` parameter is an optional object that contains additional
145
+ * configuration options for creating the AVLTreeMultiMap. It can have the following properties:
146
+ * @returns a new instance of the AVLTreeMultiMap class, with the specified options, as a TREE
147
+ * object.
148
+ */
149
+ override createTree(options?: AVLTreeMultiMapOptions<K, V, R>): TREE {
150
+ return new AVLTreeMultiMap<K, V, R, NODE, TREE>([], {
124
151
  iterationType: this.iterationType,
125
152
  comparator: this.comparator,
126
153
  ...options
@@ -128,49 +155,52 @@ export class AVLTreeMultiMap<
128
155
  }
129
156
 
130
157
  /**
131
- * The function `keyValueOrEntryToNode` converts an keyOrNodeOrEntry object into a node object.
132
- * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter is of type `KeyOrNodeOrEntry<K, V, NODE>`, which means it
133
- * can be one of the following:
134
- * @param {V} [value] - The `value` parameter is an optional argument that represents the value
135
- * associated with the node. It is of type `V`, which can be any data type. If no value is provided,
136
- * it defaults to `undefined`.
158
+ * The function checks if the input is an instance of AVLTreeMultiMapNode.
159
+ * @param {R | KeyOrNodeOrEntry<K, V, NODE>} keyOrNodeOrEntryOrRawElement - The parameter
160
+ * `keyOrNodeOrEntryOrRawElement` can be of type `R` or `KeyOrNodeOrEntry<K, V, NODE>`.
161
+ * @returns a boolean value indicating whether the input parameter `keyOrNodeOrEntryOrRawElement` is
162
+ * an instance of the `AVLTreeMultiMapNode` class.
163
+ */
164
+ override isNode(
165
+ keyOrNodeOrEntryOrRawElement: R | KeyOrNodeOrEntry<K, V, NODE>
166
+ ): keyOrNodeOrEntryOrRawElement is NODE {
167
+ return keyOrNodeOrEntryOrRawElement instanceof AVLTreeMultiMapNode;
168
+ }
169
+
170
+ /**
171
+ * The function `keyValueOrEntryOrRawElementToNode` converts a key, value, entry, or raw element into
172
+ * a node object.
173
+ * @param {R | KeyOrNodeOrEntry<K, V, NODE>} keyOrNodeOrEntryOrRawElement - The
174
+ * `keyOrNodeOrEntryOrRawElement` parameter can be of type `R` or `KeyOrNodeOrEntry<K, V, NODE>`.
175
+ * @param {V} [value] - The `value` parameter is an optional value that can be passed to the
176
+ * `override` function. It represents the value associated with the key in the data structure. If no
177
+ * value is provided, it will default to `undefined`.
137
178
  * @param [count=1] - The `count` parameter is an optional parameter that specifies the number of
138
- * times the value should be added to the node. If not provided, it defaults to 1.
139
- * @returns a node of type `NODE` or `undefined`.
179
+ * times the key-value pair should be added to the data structure. If not provided, it defaults to 1.
180
+ * @returns either a NODE object or undefined.
140
181
  */
141
- override keyValueOrEntryToNode(
142
- keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>,
182
+ override keyValueOrEntryOrRawElementToNode(
183
+ keyOrNodeOrEntryOrRawElement: R | KeyOrNodeOrEntry<K, V, NODE>,
143
184
  value?: V,
144
185
  count = 1
145
186
  ): NODE | undefined {
146
- let node: NODE | undefined;
147
- if (keyOrNodeOrEntry === undefined || keyOrNodeOrEntry === null) {
148
- return;
149
- } else if (this.isNode(keyOrNodeOrEntry)) {
150
- node = keyOrNodeOrEntry;
151
- } else if (this.isEntry(keyOrNodeOrEntry)) {
152
- const [key, value] = keyOrNodeOrEntry;
153
- if (key === undefined || key === null) {
154
- return;
155
- } else {
156
- node = this.createNode(key, value, count);
157
- }
158
- } else if (!this.isNode(keyOrNodeOrEntry)) {
159
- node = this.createNode(keyOrNodeOrEntry, value, count);
160
- } else {
161
- return;
187
+ if (keyOrNodeOrEntryOrRawElement === undefined || keyOrNodeOrEntryOrRawElement === null) return;
188
+ if (this.isNode(keyOrNodeOrEntryOrRawElement)) return keyOrNodeOrEntryOrRawElement;
189
+
190
+ if (this.toEntryFn) {
191
+ const [key, entryValue] = this.toEntryFn(keyOrNodeOrEntryOrRawElement as R);
192
+ if (key) return this.createNode(key, entryValue ?? value, count);
162
193
  }
163
- return node;
164
- }
165
194
 
166
- /**
167
- * The function checks if an keyOrNodeOrEntry is an instance of the AVLTreeMultiMapNode class.
168
- * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter is of type `KeyOrNodeOrEntry<K, V, NODE>`.
169
- * @returns a boolean value indicating whether the keyOrNodeOrEntry is an instance of the AVLTreeMultiMapNode
170
- * class.
171
- */
172
- override isNode(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>): keyOrNodeOrEntry is NODE {
173
- return keyOrNodeOrEntry instanceof AVLTreeMultiMapNode;
195
+ if (this.isEntry(keyOrNodeOrEntryOrRawElement)) {
196
+ const [key, value] = keyOrNodeOrEntryOrRawElement;
197
+ if (key === undefined || key === null) return;
198
+ else return this.createNode(key, value, count);
199
+ }
200
+
201
+ if (this.isKey(keyOrNodeOrEntryOrRawElement)) return this.createNode(keyOrNodeOrEntryOrRawElement, value, count);
202
+
203
+ return;
174
204
  }
175
205
 
176
206
  /**
@@ -182,20 +212,21 @@ export class AVLTreeMultiMap<
182
212
  * Time Complexity: O(log n)
183
213
  * Space Complexity: O(1)
184
214
  *
185
- * The function overrides the add method of a binary tree node and adds a new node to the tree.
186
- * @param keyOrNodeOrEntry - The `keyOrNodeOrEntry` parameter can be either a key, a node, or an
187
- * entry. It represents the key, node, or entry that you want to add to the binary tree.
215
+ * The function overrides the add method of a TypeScript class to add a new node to a data structure
216
+ * and update the count.
217
+ * @param {R | KeyOrNodeOrEntry<K, V, NODE>} keyOrNodeOrEntryOrRawElement - The
218
+ * `keyOrNodeOrEntryOrRawElement` parameter can accept a value of type `R`, which can be any type. It
219
+ * can also accept a value of type `KeyOrNodeOrEntry<K, V, NODE>`, which represents a key, node,
220
+ * entry, or raw element
188
221
  * @param {V} [value] - The `value` parameter represents the value associated with the key in the
189
- * binary tree node. It is an optional parameter, meaning it can be omitted when calling the `add`
190
- * method.
222
+ * data structure. It is an optional parameter, so it can be omitted if not needed.
191
223
  * @param [count=1] - The `count` parameter represents the number of times the key-value pair should
192
- * be added to the binary tree. By default, it is set to 1, meaning that the key-value pair will be
193
- * added once. However, you can specify a different value for `count` if you want to add
194
- * @returns The method is returning either the newly inserted node or `undefined` if the insertion
195
- * was not successful.
224
+ * be added to the data structure. By default, it is set to 1, meaning that the key-value pair will
225
+ * be added once. However, you can specify a different value for `count` if you want to add
226
+ * @returns a boolean value.
196
227
  */
197
- override add(keyOrNodeOrEntry: KeyOrNodeOrEntry<K, V, NODE>, value?: V, count = 1): boolean {
198
- const newNode = this.keyValueOrEntryToNode(keyOrNodeOrEntry, value, count);
228
+ override add(keyOrNodeOrEntryOrRawElement: R | KeyOrNodeOrEntry<K, V, NODE>, value?: V, count = 1): boolean {
229
+ const newNode = this.keyValueOrEntryOrRawElementToNode(keyOrNodeOrEntryOrRawElement, value, count);
199
230
  if (newNode === undefined) return false;
200
231
 
201
232
  const orgNodeCount = newNode?.count || 0;
@@ -215,19 +246,19 @@ export class AVLTreeMultiMap<
215
246
  * Time Complexity: O(log n)
216
247
  * Space Complexity: O(1)
217
248
  *
218
- * The `delete` function in TypeScript is used to remove a node from a binary tree, taking into
219
- * account the count of the node and balancing the tree if necessary.
220
- * @param identifier - The identifier is the value or key that is used to identify the node that
221
- * needs to be deleted from the binary tree. It can be of any type that is returned by the callback
249
+ * The `delete` function in a binary tree data structure deletes a node based on its identifier and
250
+ * returns the deleted node along with the parent node that needs to be balanced.
251
+ * @param identifier - The identifier parameter is the value used to identify the node that needs to
252
+ * be deleted from the binary tree. It can be of any type and is the return type of the callback
222
253
  * function.
223
- * @param {C} callback - The `callback` parameter is a function that is used to determine if a node
224
- * should be deleted. It is optional and defaults to a default callback function. The `callback`
225
- * function takes one parameter, which is the identifier of the node, and returns a value that is
226
- * used to identify the node to
254
+ * @param {C} callback - The `callback` parameter is a function that is used to determine the
255
+ * equality of nodes in the binary tree. It is optional and has a default value of
256
+ * `this._DEFAULT_CALLBACK`. The `callback` function takes a single argument, which is the identifier
257
+ * of a node, and returns a value that
227
258
  * @param [ignoreCount=false] - A boolean flag indicating whether to ignore the count of the node
228
259
  * being deleted. If set to true, the count of the node will not be considered and the node will be
229
- * deleted regardless of its count. If set to false (default), the count of the node will be
230
- * decremented by 1 and
260
+ * deleted regardless of its count. If set to false (default), the count of the node will be taken
261
+ * into account and the node
231
262
  * @returns an array of `BinaryTreeDeleteResult<NODE>`.
232
263
  */
233
264
  override delete<C extends BTNCallback<NODE>>(
@@ -300,7 +331,8 @@ export class AVLTreeMultiMap<
300
331
  * Time Complexity: O(1)
301
332
  * Space Complexity: O(1)
302
333
  *
303
- * The clear() function clears the contents of a data structure and sets the count to zero.
334
+ * The "clear" function overrides the parent class's "clear" function and also resets the count to
335
+ * zero.
304
336
  */
305
337
  override clear() {
306
338
  super.clear();
@@ -315,13 +347,14 @@ export class AVLTreeMultiMap<
315
347
  /**
316
348
  * Time Complexity: O(n log n)
317
349
  * Space Complexity: O(log n)
318
- *
319
350
  * The `perfectlyBalance` function takes a sorted array of nodes and builds a balanced binary search
320
351
  * tree using either a recursive or iterative approach.
321
- * @param iterationType - The `iterationType` parameter is an optional parameter that specifies the
322
- * type of iteration to use when building the balanced binary search tree. It can have two possible
323
- * values:
324
- * @returns a boolean value.
352
+ * @param {IterationType} iterationType - The `iterationType` parameter is an optional parameter that
353
+ * specifies the type of iteration to use when building the balanced binary search tree. It has a
354
+ * default value of `this.iterationType`, which means it will use the iteration type currently set in
355
+ * the object.
356
+ * @returns The function `perfectlyBalance` returns a boolean value. It returns `true` if the
357
+ * balancing operation is successful, and `false` if there are no nodes to balance.
325
358
  */
326
359
  override perfectlyBalance(iterationType: IterationType = this.iterationType): boolean {
327
360
  const sorted = this.dfs(node => node, 'IN'),
@@ -370,7 +403,7 @@ export class AVLTreeMultiMap<
370
403
  * Time complexity: O(n)
371
404
  * Space complexity: O(n)
372
405
  *
373
- * The `clone` function creates a deep copy of a tree object.
406
+ * The function overrides the clone method to create a deep copy of a tree object.
374
407
  * @returns The `clone()` method is returning a cloned instance of the `TREE` object.
375
408
  */
376
409
  override clone(): TREE {
@@ -380,17 +413,26 @@ export class AVLTreeMultiMap<
380
413
  }
381
414
 
382
415
  /**
383
- * The `_swapProperties` function swaps the key, value, count, and height properties between two nodes.
384
- * @param {K | NODE | undefined} srcNode - The `srcNode` parameter represents the source node from
385
- * which the values will be swapped. It can be of type `K`, `NODE`, or `undefined`.
386
- * @param {K | NODE | undefined} destNode - The `destNode` parameter represents the destination
387
- * node where the values from the source node will be swapped to.
388
- * @returns either the `destNode` object if both `srcNode` and `destNode` are defined, or `undefined`
389
- * if either `srcNode` or `destNode` is undefined.
416
+ * Time Complexity: O(1)
417
+ * Space Complexity: O(1)
418
+ */
419
+
420
+ /**
421
+ * Time Complexity: O(1)
422
+ * Space Complexity: O(1)
423
+ *
424
+ * The `_swapProperties` function swaps the properties (key, value, count, height) between two nodes
425
+ * in a binary search tree.
426
+ * @param {R | BSTNKeyOrNode<K, NODE>} srcNode - The `srcNode` parameter represents the source node
427
+ * that will be swapped with the `destNode`.
428
+ * @param {R | BSTNKeyOrNode<K, NODE>} destNode - The `destNode` parameter represents the destination
429
+ * node where the properties will be swapped with the source node.
430
+ * @returns The method is returning the `destNode` after swapping its properties with the `srcNode`.
431
+ * If either `srcNode` or `destNode` is undefined, it returns `undefined`.
390
432
  */
391
433
  protected override _swapProperties(
392
- srcNode: BSTNKeyOrNode<K, NODE>,
393
- destNode: BSTNKeyOrNode<K, NODE>
434
+ srcNode: R | BSTNKeyOrNode<K, NODE>,
435
+ destNode: R | BSTNKeyOrNode<K, NODE>
394
436
  ): NODE | undefined {
395
437
  srcNode = this.ensureNode(srcNode);
396
438
  destNode = this.ensureNode(destNode);
@@ -417,12 +459,20 @@ export class AVLTreeMultiMap<
417
459
  }
418
460
 
419
461
  /**
462
+ * Time Complexity: O(1)
463
+ * Space Complexity: O(1)
464
+ */
465
+
466
+ /**
467
+ * Time Complexity: O(1)
468
+ * Space Complexity: O(1)
469
+ *
420
470
  * The function replaces an old node with a new node and updates the count property of the new node.
421
- * @param {NODE} oldNode - The `oldNode` parameter is of type `NODE` and represents the node that
422
- * needs to be replaced in a data structure.
423
- * @param {NODE} newNode - The `newNode` parameter is an object of type `NODE`.
471
+ * @param {NODE} oldNode - The oldNode parameter represents the node that needs to be replaced in the
472
+ * data structure. It is of type NODE.
473
+ * @param {NODE} newNode - The `newNode` parameter is an instance of the `NODE` class.
424
474
  * @returns The method is returning the result of calling the `_replaceNode` method from the
425
- * superclass, after updating the `count` property of the `newNode` object.
475
+ * superclass, which is of type `NODE`.
426
476
  */
427
477
  protected override _replaceNode(oldNode: NODE, newNode: NODE): NODE {
428
478
  newNode.count = oldNode.count + newNode.count;