data-structure-typed 2.5.2 → 2.5.3
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.
- package/CHANGELOG.md +3 -1
- package/MIGRATION.md +169 -0
- package/README.md +60 -6
- package/README_CN.md +551 -143
- package/SPECIFICATION.md +20 -14
- package/SPECIFICATION.zh-CN.md +20 -14
- package/dist/cjs/binary-tree.cjs +2417 -132
- package/dist/cjs/graph.cjs +248 -14
- package/dist/cjs/hash.cjs +62 -7
- package/dist/cjs/heap.cjs +103 -16
- package/dist/cjs/index.cjs +3046 -124
- package/dist/cjs/linked-list.cjs +219 -0
- package/dist/cjs/matrix.cjs +32 -0
- package/dist/cjs/priority-queue.cjs +101 -14
- package/dist/cjs/queue.cjs +215 -0
- package/dist/cjs/stack.cjs +44 -4
- package/dist/cjs/trie.cjs +44 -0
- package/dist/cjs-legacy/binary-tree.cjs +2406 -123
- package/dist/cjs-legacy/graph.cjs +248 -14
- package/dist/cjs-legacy/hash.cjs +62 -7
- package/dist/cjs-legacy/heap.cjs +103 -16
- package/dist/cjs-legacy/index.cjs +3105 -185
- package/dist/cjs-legacy/linked-list.cjs +219 -0
- package/dist/cjs-legacy/matrix.cjs +32 -0
- package/dist/cjs-legacy/priority-queue.cjs +101 -14
- package/dist/cjs-legacy/queue.cjs +215 -0
- package/dist/cjs-legacy/stack.cjs +44 -4
- package/dist/cjs-legacy/trie.cjs +44 -0
- package/dist/esm/binary-tree.mjs +2417 -132
- package/dist/esm/graph.mjs +248 -14
- package/dist/esm/hash.mjs +62 -7
- package/dist/esm/heap.mjs +103 -16
- package/dist/esm/index.mjs +3046 -124
- package/dist/esm/linked-list.mjs +219 -0
- package/dist/esm/matrix.mjs +32 -0
- package/dist/esm/priority-queue.mjs +101 -14
- package/dist/esm/queue.mjs +215 -0
- package/dist/esm/stack.mjs +44 -4
- package/dist/esm/trie.mjs +44 -0
- package/dist/esm-legacy/binary-tree.mjs +2406 -123
- package/dist/esm-legacy/graph.mjs +248 -14
- package/dist/esm-legacy/hash.mjs +62 -7
- package/dist/esm-legacy/heap.mjs +103 -16
- package/dist/esm-legacy/index.mjs +3105 -185
- package/dist/esm-legacy/linked-list.mjs +219 -0
- package/dist/esm-legacy/matrix.mjs +32 -0
- package/dist/esm-legacy/priority-queue.mjs +101 -14
- package/dist/esm-legacy/queue.mjs +215 -0
- package/dist/esm-legacy/stack.mjs +44 -4
- package/dist/esm-legacy/trie.mjs +44 -0
- package/dist/types/data-structures/binary-tree/avl-tree.d.ts +50 -2
- package/dist/types/data-structures/binary-tree/binary-indexed-tree.d.ts +56 -0
- package/dist/types/data-structures/binary-tree/binary-tree.d.ts +116 -15
- package/dist/types/data-structures/binary-tree/bst.d.ts +99 -3
- package/dist/types/data-structures/binary-tree/red-black-tree.d.ts +79 -8
- package/dist/types/data-structures/binary-tree/segment-tree.d.ts +24 -0
- package/dist/types/data-structures/binary-tree/tree-map.d.ts +520 -1
- package/dist/types/data-structures/binary-tree/tree-multi-map.d.ts +489 -1
- package/dist/types/data-structures/binary-tree/tree-multi-set.d.ts +393 -1
- package/dist/types/data-structures/binary-tree/tree-set.d.ts +500 -1
- package/dist/types/data-structures/graph/directed-graph.d.ts +40 -0
- package/dist/types/data-structures/graph/undirected-graph.d.ts +36 -0
- package/dist/types/data-structures/hash/hash-map.d.ts +51 -6
- package/dist/types/data-structures/heap/heap.d.ts +98 -12
- package/dist/types/data-structures/linked-list/doubly-linked-list.d.ts +75 -0
- package/dist/types/data-structures/linked-list/singly-linked-list.d.ts +61 -1
- package/dist/types/data-structures/linked-list/skip-linked-list.d.ts +72 -0
- package/dist/types/data-structures/matrix/matrix.d.ts +32 -0
- package/dist/types/data-structures/queue/deque.d.ts +82 -0
- package/dist/types/data-structures/queue/queue.d.ts +61 -0
- package/dist/types/data-structures/stack/stack.d.ts +42 -2
- package/dist/types/data-structures/trie/trie.d.ts +48 -0
- package/dist/types/interfaces/binary-tree.d.ts +2 -3
- package/dist/umd/data-structure-typed.js +3105 -185
- package/dist/umd/data-structure-typed.min.js +4 -4
- package/docs-site-docusaurus/docs/api/classes/AVLTree.md +188 -200
- package/docs-site-docusaurus/docs/api/classes/AVLTreeNode.md +11 -11
- package/docs-site-docusaurus/docs/api/classes/AbstractGraph.md +62 -62
- package/docs-site-docusaurus/docs/api/classes/BST.md +183 -195
- package/docs-site-docusaurus/docs/api/classes/BSTNode.md +13 -13
- package/docs-site-docusaurus/docs/api/classes/BinaryIndexedTree.md +15 -15
- package/docs-site-docusaurus/docs/api/classes/BinaryTree.md +143 -155
- package/docs-site-docusaurus/docs/api/classes/BinaryTreeNode.md +13 -13
- package/docs-site-docusaurus/docs/api/classes/Deque.md +99 -85
- package/docs-site-docusaurus/docs/api/classes/DirectedGraph.md +73 -73
- package/docs-site-docusaurus/docs/api/classes/DoublyLinkedList.md +100 -70
- package/docs-site-docusaurus/docs/api/classes/DoublyLinkedListNode.md +8 -8
- package/docs-site-docusaurus/docs/api/classes/FibonacciHeap.md +12 -12
- package/docs-site-docusaurus/docs/api/classes/FibonacciHeapNode.md +1 -1
- package/docs-site-docusaurus/docs/api/classes/HashMap.md +38 -38
- package/docs-site-docusaurus/docs/api/classes/Heap.md +96 -85
- package/docs-site-docusaurus/docs/api/classes/IterableElementBase.md +25 -25
- package/docs-site-docusaurus/docs/api/classes/IterableEntryBase.md +23 -23
- package/docs-site-docusaurus/docs/api/classes/LinearBase.md +48 -48
- package/docs-site-docusaurus/docs/api/classes/LinearLinkedBase.md +52 -52
- package/docs-site-docusaurus/docs/api/classes/LinkedHashMap.md +42 -42
- package/docs-site-docusaurus/docs/api/classes/LinkedListNode.md +6 -6
- package/docs-site-docusaurus/docs/api/classes/LinkedListQueue.md +74 -74
- package/docs-site-docusaurus/docs/api/classes/MapGraph.md +73 -73
- package/docs-site-docusaurus/docs/api/classes/Matrix.md +31 -31
- package/docs-site-docusaurus/docs/api/classes/MaxHeap.md +104 -89
- package/docs-site-docusaurus/docs/api/classes/MaxPriorityQueue.md +104 -89
- package/docs-site-docusaurus/docs/api/classes/MinHeap.md +104 -89
- package/docs-site-docusaurus/docs/api/classes/MinPriorityQueue.md +104 -89
- package/docs-site-docusaurus/docs/api/classes/Navigator.md +5 -5
- package/docs-site-docusaurus/docs/api/classes/PriorityQueue.md +103 -88
- package/docs-site-docusaurus/docs/api/classes/Queue.md +111 -59
- package/docs-site-docusaurus/docs/api/classes/RedBlackTree.md +200 -212
- package/docs-site-docusaurus/docs/api/classes/SegmentTree.md +10 -10
- package/docs-site-docusaurus/docs/api/classes/SinglyLinkedList.md +75 -75
- package/docs-site-docusaurus/docs/api/classes/SinglyLinkedListNode.md +6 -6
- package/docs-site-docusaurus/docs/api/classes/SkipList.md +37 -37
- package/docs-site-docusaurus/docs/api/classes/Stack.md +42 -42
- package/docs-site-docusaurus/docs/api/classes/TreeMap.md +107 -36
- package/docs-site-docusaurus/docs/api/classes/TreeMultiMap.md +43 -43
- package/docs-site-docusaurus/docs/api/classes/TreeSet.md +106 -35
- package/docs-site-docusaurus/docs/api/classes/Trie.md +43 -43
- package/docs-site-docusaurus/docs/api/classes/TrieNode.md +8 -8
- package/docs-site-docusaurus/docs/api/classes/UndirectedGraph.md +72 -72
- package/docs-site-docusaurus/docs/guide/architecture.md +75 -7
- package/docs-site-docusaurus/docs/guide/concepts.md +53 -34
- package/docs-site-docusaurus/docs/guide/faq.md +53 -0
- package/docs-site-docusaurus/docs/guide/guides.md +8 -9
- package/docs-site-docusaurus/docs/guide/integrations.md +74 -177
- package/docs-site-docusaurus/docs/guide/overview.md +131 -17
- package/docs-site-docusaurus/src/pages/index.tsx +4 -0
- package/docs-site-docusaurus/typedoc.json +1 -0
- package/package.json +7 -6
- package/src/data-structures/binary-tree/avl-tree.ts +52 -5
- package/src/data-structures/binary-tree/binary-indexed-tree.ts +56 -0
- package/src/data-structures/binary-tree/binary-tree.ts +167 -81
- package/src/data-structures/binary-tree/bst.ts +101 -7
- package/src/data-structures/binary-tree/red-black-tree.ts +82 -15
- package/src/data-structures/binary-tree/segment-tree.ts +24 -0
- package/src/data-structures/binary-tree/tree-map.ts +540 -3
- package/src/data-structures/binary-tree/tree-multi-map.ts +490 -2
- package/src/data-structures/binary-tree/tree-multi-set.ts +393 -1
- package/src/data-structures/binary-tree/tree-set.ts +520 -3
- package/src/data-structures/graph/directed-graph.ts +41 -1
- package/src/data-structures/graph/undirected-graph.ts +37 -1
- package/src/data-structures/hash/hash-map.ts +67 -12
- package/src/data-structures/heap/heap.ts +107 -19
- package/src/data-structures/linked-list/doubly-linked-list.ts +88 -0
- package/src/data-structures/linked-list/singly-linked-list.ts +61 -1
- package/src/data-structures/linked-list/skip-linked-list.ts +72 -0
- package/src/data-structures/matrix/matrix.ts +32 -0
- package/src/data-structures/queue/deque.ts +85 -0
- package/src/data-structures/queue/queue.ts +73 -0
- package/src/data-structures/stack/stack.ts +45 -5
- package/src/data-structures/trie/trie.ts +48 -0
- package/src/interfaces/binary-tree.ts +1 -9
- package/.vitepress/cache/deps_temp_51f5f1b0/chunk-7OIKW5WK.js +0 -12984
- package/.vitepress/cache/deps_temp_51f5f1b0/package.json +0 -3
- package/.vitepress/cache/deps_temp_51f5f1b0/vitepress___@vue_devtools-api.js +0 -4505
- package/.vitepress/cache/deps_temp_51f5f1b0/vitepress___@vueuse_core.js +0 -9731
- package/.vitepress/cache/deps_temp_51f5f1b0/vue.js +0 -347
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: IterableElementBase\<E, R\>
|
|
8
8
|
|
|
9
|
-
Defined in: [data-structures/base/iterable-element-base.ts:15](https://github.com/zrwusa/data-structure-typed/blob/
|
|
9
|
+
Defined in: [data-structures/base/iterable-element-base.ts:15](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L15)
|
|
10
10
|
|
|
11
11
|
Base class that makes a data structure iterable and provides common
|
|
12
12
|
element-wise utilities (e.g., map/filter/reduce/find).
|
|
@@ -51,7 +51,7 @@ The underlying "raw" element type used internally or by converters.
|
|
|
51
51
|
get toElementFn(): ((rawElement) => E) | undefined;
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Defined in: [data-structures/base/iterable-element-base.ts:48](https://github.com/zrwusa/data-structure-typed/blob/
|
|
54
|
+
Defined in: [data-structures/base/iterable-element-base.ts:48](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L48)
|
|
55
55
|
|
|
56
56
|
Exposes the current `toElementFn`, if configured.
|
|
57
57
|
|
|
@@ -73,7 +73,7 @@ The converter function or `undefined` when not set.
|
|
|
73
73
|
iterator: IterableIterator<E>;
|
|
74
74
|
```
|
|
75
75
|
|
|
76
|
-
Defined in: [data-structures/base/iterable-element-base.ts:61](https://github.com/zrwusa/data-structure-typed/blob/
|
|
76
|
+
Defined in: [data-structures/base/iterable-element-base.ts:61](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L61)
|
|
77
77
|
|
|
78
78
|
Returns an iterator over the structure's elements.
|
|
79
79
|
|
|
@@ -109,7 +109,7 @@ Iterable.[iterator]
|
|
|
109
109
|
abstract clear(): void;
|
|
110
110
|
```
|
|
111
111
|
|
|
112
|
-
Defined in: [data-structures/base/iterable-element-base.ts:289](https://github.com/zrwusa/data-structure-typed/blob/
|
|
112
|
+
Defined in: [data-structures/base/iterable-element-base.ts:289](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L289)
|
|
113
113
|
|
|
114
114
|
Removes all elements from the structure.
|
|
115
115
|
|
|
@@ -131,7 +131,7 @@ Expected Time O(1) or O(n) depending on the implementation; Space O(1).
|
|
|
131
131
|
abstract clone(): this;
|
|
132
132
|
```
|
|
133
133
|
|
|
134
|
-
Defined in: [data-structures/base/iterable-element-base.ts:298](https://github.com/zrwusa/data-structure-typed/blob/
|
|
134
|
+
Defined in: [data-structures/base/iterable-element-base.ts:298](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L298)
|
|
135
135
|
|
|
136
136
|
Creates a structural copy with the same element values and configuration.
|
|
137
137
|
|
|
@@ -153,7 +153,7 @@ Expected Time O(n) to copy elements; Space O(n).
|
|
|
153
153
|
every(predicate, thisArg?): boolean;
|
|
154
154
|
```
|
|
155
155
|
|
|
156
|
-
Defined in: [data-structures/base/iterable-element-base.ts:87](https://github.com/zrwusa/data-structure-typed/blob/
|
|
156
|
+
Defined in: [data-structures/base/iterable-element-base.ts:87](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L87)
|
|
157
157
|
|
|
158
158
|
Tests whether all elements satisfy the predicate.
|
|
159
159
|
|
|
@@ -189,7 +189,7 @@ Time O(n) in the worst case; may exit early when the first failure is found. Spa
|
|
|
189
189
|
abstract filter(predicate, thisArg?): this;
|
|
190
190
|
```
|
|
191
191
|
|
|
192
|
-
Defined in: [data-structures/base/iterable-element-base.ts:341](https://github.com/zrwusa/data-structure-typed/blob/
|
|
192
|
+
Defined in: [data-structures/base/iterable-element-base.ts:341](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L341)
|
|
193
193
|
|
|
194
194
|
Filters elements using the provided predicate and returns the same concrete structure type.
|
|
195
195
|
|
|
@@ -227,7 +227,7 @@ Time O(n), Space O(k) where `k` is the number of kept elements.
|
|
|
227
227
|
find<S>(predicate, thisArg?): S | undefined;
|
|
228
228
|
```
|
|
229
229
|
|
|
230
|
-
Defined in: [data-structures/base/iterable-element-base.ts:163](https://github.com/zrwusa/data-structure-typed/blob/
|
|
230
|
+
Defined in: [data-structures/base/iterable-element-base.ts:163](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L163)
|
|
231
231
|
|
|
232
232
|
Finds the first element that satisfies the predicate and returns it.
|
|
233
233
|
|
|
@@ -269,7 +269,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
|
|
|
269
269
|
find(predicate, thisArg?): E | undefined;
|
|
270
270
|
```
|
|
271
271
|
|
|
272
|
-
Defined in: [data-structures/base/iterable-element-base.ts:164](https://github.com/zrwusa/data-structure-typed/blob/
|
|
272
|
+
Defined in: [data-structures/base/iterable-element-base.ts:164](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L164)
|
|
273
273
|
|
|
274
274
|
Finds the first element that satisfies the predicate and returns it.
|
|
275
275
|
|
|
@@ -307,7 +307,7 @@ Time O(n) in the worst case; may exit early on the first match. Space O(1).
|
|
|
307
307
|
forEach(callbackfn, thisArg?): void;
|
|
308
308
|
```
|
|
309
309
|
|
|
310
|
-
Defined in: [data-structures/base/iterable-element-base.ts:133](https://github.com/zrwusa/data-structure-typed/blob/
|
|
310
|
+
Defined in: [data-structures/base/iterable-element-base.ts:133](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L133)
|
|
311
311
|
|
|
312
312
|
Invokes a callback for each element in iteration order.
|
|
313
313
|
|
|
@@ -343,7 +343,7 @@ Time O(n), Space O(1).
|
|
|
343
343
|
has(element): boolean;
|
|
344
344
|
```
|
|
345
345
|
|
|
346
|
-
Defined in: [data-structures/base/iterable-element-base.ts:189](https://github.com/zrwusa/data-structure-typed/blob/
|
|
346
|
+
Defined in: [data-structures/base/iterable-element-base.ts:189](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L189)
|
|
347
347
|
|
|
348
348
|
Checks whether a strictly-equal element exists in the structure.
|
|
349
349
|
|
|
@@ -373,7 +373,7 @@ Time O(n) in the worst case. Space O(1).
|
|
|
373
373
|
abstract isEmpty(): boolean;
|
|
374
374
|
```
|
|
375
375
|
|
|
376
|
-
Defined in: [data-structures/base/iterable-element-base.ts:280](https://github.com/zrwusa/data-structure-typed/blob/
|
|
376
|
+
Defined in: [data-structures/base/iterable-element-base.ts:280](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L280)
|
|
377
377
|
|
|
378
378
|
Indicates whether the structure currently contains no elements.
|
|
379
379
|
|
|
@@ -398,7 +398,7 @@ abstract map<EM, RM>(
|
|
|
398
398
|
thisArg?): IterableElementBase<EM, RM>;
|
|
399
399
|
```
|
|
400
400
|
|
|
401
|
-
Defined in: [data-structures/base/iterable-element-base.ts:313](https://github.com/zrwusa/data-structure-typed/blob/
|
|
401
|
+
Defined in: [data-structures/base/iterable-element-base.ts:313](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L313)
|
|
402
402
|
|
|
403
403
|
Maps each element to a new element and returns a new iterable structure.
|
|
404
404
|
|
|
@@ -454,7 +454,7 @@ Time O(n), Space O(n).
|
|
|
454
454
|
abstract mapSame(callback, thisArg?): this;
|
|
455
455
|
```
|
|
456
456
|
|
|
457
|
-
Defined in: [data-structures/base/iterable-element-base.ts:329](https://github.com/zrwusa/data-structure-typed/blob/
|
|
457
|
+
Defined in: [data-structures/base/iterable-element-base.ts:329](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L329)
|
|
458
458
|
|
|
459
459
|
Maps each element to the same element type and returns the same concrete structure type.
|
|
460
460
|
|
|
@@ -490,7 +490,7 @@ Time O(n), Space O(n).
|
|
|
490
490
|
print(): void;
|
|
491
491
|
```
|
|
492
492
|
|
|
493
|
-
Defined in: [data-structures/base/iterable-element-base.ts:269](https://github.com/zrwusa/data-structure-typed/blob/
|
|
493
|
+
Defined in: [data-structures/base/iterable-element-base.ts:269](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L269)
|
|
494
494
|
|
|
495
495
|
Prints `toVisual()` to the console. Intended for quick debugging.
|
|
496
496
|
|
|
@@ -544,7 +544,7 @@ Time O(n), Space O(1). Throws if called on an empty structure without `initialVa
|
|
|
544
544
|
reduce(callbackfn): E;
|
|
545
545
|
```
|
|
546
546
|
|
|
547
|
-
Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.com/zrwusa/data-structure-typed/blob/
|
|
547
|
+
Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L194)
|
|
548
548
|
|
|
549
549
|
##### Parameters
|
|
550
550
|
|
|
@@ -562,7 +562,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:194](https://github.c
|
|
|
562
562
|
reduce(callbackfn, initialValue): E;
|
|
563
563
|
```
|
|
564
564
|
|
|
565
|
-
Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/
|
|
565
|
+
Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L195)
|
|
566
566
|
|
|
567
567
|
##### Parameters
|
|
568
568
|
|
|
@@ -584,7 +584,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:195](https://github.c
|
|
|
584
584
|
reduce<U>(callbackfn, initialValue): U;
|
|
585
585
|
```
|
|
586
586
|
|
|
587
|
-
Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.com/zrwusa/data-structure-typed/blob/
|
|
587
|
+
Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L196)
|
|
588
588
|
|
|
589
589
|
##### Type Parameters
|
|
590
590
|
|
|
@@ -614,7 +614,7 @@ Defined in: [data-structures/base/iterable-element-base.ts:196](https://github.c
|
|
|
614
614
|
some(predicate, thisArg?): boolean;
|
|
615
615
|
```
|
|
616
616
|
|
|
617
|
-
Defined in: [data-structures/base/iterable-element-base.ts:110](https://github.com/zrwusa/data-structure-typed/blob/
|
|
617
|
+
Defined in: [data-structures/base/iterable-element-base.ts:110](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L110)
|
|
618
618
|
|
|
619
619
|
Tests whether at least one element satisfies the predicate.
|
|
620
620
|
|
|
@@ -650,7 +650,7 @@ Time O(n) in the worst case; may exit early on first success. Space O(1).
|
|
|
650
650
|
toArray(): E[];
|
|
651
651
|
```
|
|
652
652
|
|
|
653
|
-
Defined in: [data-structures/base/iterable-element-base.ts:246](https://github.com/zrwusa/data-structure-typed/blob/
|
|
653
|
+
Defined in: [data-structures/base/iterable-element-base.ts:246](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L246)
|
|
654
654
|
|
|
655
655
|
Materializes the elements into a new array.
|
|
656
656
|
|
|
@@ -672,7 +672,7 @@ Time O(n), Space O(n).
|
|
|
672
672
|
toVisual(): E[];
|
|
673
673
|
```
|
|
674
674
|
|
|
675
|
-
Defined in: [data-structures/base/iterable-element-base.ts:258](https://github.com/zrwusa/data-structure-typed/blob/
|
|
675
|
+
Defined in: [data-structures/base/iterable-element-base.ts:258](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L258)
|
|
676
676
|
|
|
677
677
|
Returns a representation of the structure suitable for quick visualization.
|
|
678
678
|
Defaults to an array of elements; subclasses may override to provide richer visuals.
|
|
@@ -695,7 +695,7 @@ Time O(n), Space O(n).
|
|
|
695
695
|
values(): IterableIterator<E>;
|
|
696
696
|
```
|
|
697
697
|
|
|
698
|
-
Defined in: [data-structures/base/iterable-element-base.ts:72](https://github.com/zrwusa/data-structure-typed/blob/
|
|
698
|
+
Defined in: [data-structures/base/iterable-element-base.ts:72](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L72)
|
|
699
699
|
|
|
700
700
|
Returns an iterator over the values (alias of the default iterator).
|
|
701
701
|
|
|
@@ -720,7 +720,7 @@ Creating the iterator is O(1); full iteration is Time O(n), Space O(1).
|
|
|
720
720
|
protected new IterableElementBase<E, R>(options?): IterableElementBase<E, R>;
|
|
721
721
|
```
|
|
722
722
|
|
|
723
|
-
Defined in: [data-structures/base/iterable-element-base.ts:25](https://github.com/zrwusa/data-structure-typed/blob/
|
|
723
|
+
Defined in: [data-structures/base/iterable-element-base.ts:25](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L25)
|
|
724
724
|
|
|
725
725
|
Create a new iterable base.
|
|
726
726
|
|
|
@@ -749,7 +749,7 @@ Time O(1), Space O(1).
|
|
|
749
749
|
protected optional _toElementFn?: (rawElement) => E;
|
|
750
750
|
```
|
|
751
751
|
|
|
752
|
-
Defined in: [data-structures/base/iterable-element-base.ts:39](https://github.com/zrwusa/data-structure-typed/blob/
|
|
752
|
+
Defined in: [data-structures/base/iterable-element-base.ts:39](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L39)
|
|
753
753
|
|
|
754
754
|
The converter used to transform a raw element (`R`) into a public element (`E`).
|
|
755
755
|
|
|
@@ -775,7 +775,7 @@ Time O(1), Space O(1).
|
|
|
775
775
|
abstract protected _getIterator(...args): IterableIterator<E>;
|
|
776
776
|
```
|
|
777
777
|
|
|
778
|
-
Defined in: [data-structures/base/iterable-element-base.ts:352](https://github.com/zrwusa/data-structure-typed/blob/
|
|
778
|
+
Defined in: [data-structures/base/iterable-element-base.ts:352](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-element-base.ts#L352)
|
|
779
779
|
|
|
780
780
|
Internal iterator factory used by the default iterator.
|
|
781
781
|
|
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
|
|
7
7
|
# Abstract Class: IterableEntryBase\<K, V\>
|
|
8
8
|
|
|
9
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:9](https://github.com/zrwusa/data-structure-typed/blob/
|
|
9
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:9](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L9)
|
|
10
10
|
|
|
11
11
|
Iterable view over key-value entries.
|
|
12
12
|
|
|
@@ -46,7 +46,7 @@ Value type.
|
|
|
46
46
|
get abstract size(): number;
|
|
47
47
|
```
|
|
48
48
|
|
|
49
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:15](https://github.com/zrwusa/data-structure-typed/blob/
|
|
49
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:15](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L15)
|
|
50
50
|
|
|
51
51
|
Total number of entries.
|
|
52
52
|
|
|
@@ -68,7 +68,7 @@ Entry count.
|
|
|
68
68
|
iterator: IterableIterator<[K, V]>;
|
|
69
69
|
```
|
|
70
70
|
|
|
71
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:22](https://github.com/zrwusa/data-structure-typed/blob/
|
|
71
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:22](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L22)
|
|
72
72
|
|
|
73
73
|
Default iterator yielding `[key, value]` entries.
|
|
74
74
|
|
|
@@ -96,7 +96,7 @@ Time O(n) to iterate, Space O(1)
|
|
|
96
96
|
abstract clear(): void;
|
|
97
97
|
```
|
|
98
98
|
|
|
99
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:218](https://github.com/zrwusa/data-structure-typed/blob/
|
|
99
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:218](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L218)
|
|
100
100
|
|
|
101
101
|
Remove all entries.
|
|
102
102
|
|
|
@@ -116,7 +116,7 @@ Time O(n) typical, Space O(1)
|
|
|
116
116
|
abstract clone(): this;
|
|
117
117
|
```
|
|
118
118
|
|
|
119
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:225](https://github.com/zrwusa/data-structure-typed/blob/
|
|
119
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:225](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L225)
|
|
120
120
|
|
|
121
121
|
Deep clone preserving the concrete subtype.
|
|
122
122
|
|
|
@@ -138,7 +138,7 @@ Time O(n) typical, Space O(n)
|
|
|
138
138
|
entries(): IterableIterator<[K, V | undefined]>;
|
|
139
139
|
```
|
|
140
140
|
|
|
141
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:31](https://github.com/zrwusa/data-structure-typed/blob/
|
|
141
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:31](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L31)
|
|
142
142
|
|
|
143
143
|
Iterate over `[key, value]` pairs (may yield `undefined` values).
|
|
144
144
|
|
|
@@ -160,7 +160,7 @@ Time O(n), Space O(1)
|
|
|
160
160
|
every(predicate, thisArg?): boolean;
|
|
161
161
|
```
|
|
162
162
|
|
|
163
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:66](https://github.com/zrwusa/data-structure-typed/blob/
|
|
163
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:66](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L66)
|
|
164
164
|
|
|
165
165
|
Test whether all entries satisfy the predicate.
|
|
166
166
|
|
|
@@ -196,7 +196,7 @@ Time O(n), Space O(1)
|
|
|
196
196
|
abstract filter(...args): this;
|
|
197
197
|
```
|
|
198
198
|
|
|
199
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:238](https://github.com/zrwusa/data-structure-typed/blob/
|
|
199
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:238](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L238)
|
|
200
200
|
|
|
201
201
|
Filter entries and return the same-species structure.
|
|
202
202
|
|
|
@@ -224,7 +224,7 @@ Time O(n), Space O(n)
|
|
|
224
224
|
find(callbackfn, thisArg?): [K, V] | undefined;
|
|
225
225
|
```
|
|
226
226
|
|
|
227
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:114](https://github.com/zrwusa/data-structure-typed/blob/
|
|
227
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:114](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L114)
|
|
228
228
|
|
|
229
229
|
Find the first entry that matches a predicate.
|
|
230
230
|
|
|
@@ -260,7 +260,7 @@ Time O(n), Space O(1)
|
|
|
260
260
|
forEach(callbackfn, thisArg?): void;
|
|
261
261
|
```
|
|
262
262
|
|
|
263
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:99](https://github.com/zrwusa/data-structure-typed/blob/
|
|
263
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:99](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L99)
|
|
264
264
|
|
|
265
265
|
Visit each entry, left-to-right.
|
|
266
266
|
|
|
@@ -294,7 +294,7 @@ Time O(n), Space O(1)
|
|
|
294
294
|
get(key): V | undefined;
|
|
295
295
|
```
|
|
296
296
|
|
|
297
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:156](https://github.com/zrwusa/data-structure-typed/blob/
|
|
297
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:156](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L156)
|
|
298
298
|
|
|
299
299
|
Get the value under a key.
|
|
300
300
|
|
|
@@ -324,7 +324,7 @@ Time O(n) generic, Space O(1)
|
|
|
324
324
|
has(key): boolean;
|
|
325
325
|
```
|
|
326
326
|
|
|
327
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:129](https://github.com/zrwusa/data-structure-typed/blob/
|
|
327
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:129](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L129)
|
|
328
328
|
|
|
329
329
|
Whether the given key exists.
|
|
330
330
|
|
|
@@ -354,7 +354,7 @@ Time O(n) generic, Space O(1)
|
|
|
354
354
|
hasValue(value): boolean;
|
|
355
355
|
```
|
|
356
356
|
|
|
357
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:143](https://github.com/zrwusa/data-structure-typed/blob/
|
|
357
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:143](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L143)
|
|
358
358
|
|
|
359
359
|
Whether there exists an entry with the given value.
|
|
360
360
|
|
|
@@ -384,7 +384,7 @@ Time O(n), Space O(1)
|
|
|
384
384
|
abstract isEmpty(): boolean;
|
|
385
385
|
```
|
|
386
386
|
|
|
387
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:212](https://github.com/zrwusa/data-structure-typed/blob/
|
|
387
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:212](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L212)
|
|
388
388
|
|
|
389
389
|
Whether there are no entries.
|
|
390
390
|
|
|
@@ -406,7 +406,7 @@ Time O(1) typical, Space O(1)
|
|
|
406
406
|
keys(): IterableIterator<K>;
|
|
407
407
|
```
|
|
408
408
|
|
|
409
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:42](https://github.com/zrwusa/data-structure-typed/blob/
|
|
409
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:42](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L42)
|
|
410
410
|
|
|
411
411
|
Iterate over keys only.
|
|
412
412
|
|
|
@@ -428,7 +428,7 @@ Time O(n), Space O(1)
|
|
|
428
428
|
abstract map(...args): unknown;
|
|
429
429
|
```
|
|
430
430
|
|
|
431
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:231](https://github.com/zrwusa/data-structure-typed/blob/
|
|
431
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:231](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L231)
|
|
432
432
|
|
|
433
433
|
Map entries using an implementation-specific strategy.
|
|
434
434
|
|
|
@@ -454,7 +454,7 @@ Time O(n), Space O(n)
|
|
|
454
454
|
print(): void;
|
|
455
455
|
```
|
|
456
456
|
|
|
457
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:203](https://github.com/zrwusa/data-structure-typed/blob/
|
|
457
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:203](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L203)
|
|
458
458
|
|
|
459
459
|
Print a human-friendly representation to the console.
|
|
460
460
|
|
|
@@ -474,7 +474,7 @@ Time O(n), Space O(n)
|
|
|
474
474
|
reduce<U>(callbackfn, initialValue): U;
|
|
475
475
|
```
|
|
476
476
|
|
|
477
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:171](https://github.com/zrwusa/data-structure-typed/blob/
|
|
477
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:171](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L171)
|
|
478
478
|
|
|
479
479
|
Reduce entries into a single accumulator.
|
|
480
480
|
|
|
@@ -516,7 +516,7 @@ Time O(n), Space O(1)
|
|
|
516
516
|
some(predicate, thisArg?): boolean;
|
|
517
517
|
```
|
|
518
518
|
|
|
519
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:83](https://github.com/zrwusa/data-structure-typed/blob/
|
|
519
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:83](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L83)
|
|
520
520
|
|
|
521
521
|
Test whether any entry satisfies the predicate.
|
|
522
522
|
|
|
@@ -552,7 +552,7 @@ Time O(n), Space O(1)
|
|
|
552
552
|
toArray(): [K, V][];
|
|
553
553
|
```
|
|
554
554
|
|
|
555
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:186](https://github.com/zrwusa/data-structure-typed/blob/
|
|
555
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:186](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L186)
|
|
556
556
|
|
|
557
557
|
Converts data structure to `[key, value]` pairs.
|
|
558
558
|
|
|
@@ -574,7 +574,7 @@ Time O(n), Space O(n)
|
|
|
574
574
|
toVisual(): string | [K, V][];
|
|
575
575
|
```
|
|
576
576
|
|
|
577
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/
|
|
577
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:195](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L195)
|
|
578
578
|
|
|
579
579
|
Visualize the iterable as an array of `[key, value]` pairs (or a custom string).
|
|
580
580
|
|
|
@@ -596,7 +596,7 @@ Time O(n), Space O(n)
|
|
|
596
596
|
values(): IterableIterator<V>;
|
|
597
597
|
```
|
|
598
598
|
|
|
599
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:53](https://github.com/zrwusa/data-structure-typed/blob/
|
|
599
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:53](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L53)
|
|
600
600
|
|
|
601
601
|
Iterate over values only.
|
|
602
602
|
|
|
@@ -621,7 +621,7 @@ Time O(n), Space O(1)
|
|
|
621
621
|
abstract protected _getIterator(...args): IterableIterator<[K, V]>;
|
|
622
622
|
```
|
|
623
623
|
|
|
624
|
-
Defined in: [data-structures/base/iterable-entry-base.ts:245](https://github.com/zrwusa/data-structure-typed/blob/
|
|
624
|
+
Defined in: [data-structures/base/iterable-entry-base.ts:245](https://github.com/zrwusa/data-structure-typed/blob/main/src/data-structures/base/iterable-entry-base.ts#L245)
|
|
625
625
|
|
|
626
626
|
Underlying iterator for the default iteration protocol.
|
|
627
627
|
|