🎨 improve: add new type IReadonlyCollection

Author: guanghechen

Diff for: packages/queue/src/circular.ts

@@ -53,7 +53,7 @@ export class CircularQueue<T = unknown> implements ICircularQueue<T> {
       : () => {}
   }
 
-  public *[Symbol.iterator](): Iterator<T> {
+  public *[Symbol.iterator](): IterableIterator<T> {
     const { _elements, _size, _start, _capacity } = this
     if (_size == 0) return
 

Diff for: packages/queue/src/priority.ts

@@ -20,7 +20,7 @@ export class PriorityQueue<T> implements IPriorityQueue<T> {
     this._compare = props.compare
   }
 
-  public *[Symbol.iterator](): Iterator<T> {
+  public *[Symbol.iterator](): IterableIterator<T> {
     const { _elements, _size } = this
     for (let i = 1; i <= _size; ++i) yield _elements[i]
   }

Diff for: packages/trie/src/trie-unsafe.ts

@@ -27,38 +27,34 @@ export class UnsafeTrie<E extends unknown[] | string, V> implements ITrie<E, V>
     this._wordCount = 0
   }
 
-  public get size(): Readonly<number> {
+  public get size(): number {
     return this._wordCount
   }
 
-  public *[Symbol.iterator](): Iterator<V, number> {
-    let height = 0
-    const uStack: number[] = [0]
+  public *[Symbol.iterator](): IterableIterator<V> {
+    const vStack: number[] = [0]
     const iStack: number[] = [0]
     const { _SIGMA_SIZE, _ch, _values } = this
 
-    while (height >= 0) {
-      const o = uStack[height]
+    for (let h = 0; h >= 0; ) {
+      const o = vStack[h]
       const nodes = _ch[o]
-      let i = iStack[height]
+      let i = iStack[h]
       while (i < _SIGMA_SIZE && nodes[i] === 0) ++i
 
       if (i < _SIGMA_SIZE) {
         const u = nodes[i]
         const v = _values[u]
         if (v !== undefined) yield v
 
-        iStack[height] = i + 1
-        ++height
-        uStack[height] = u
-        iStack[height] = 0
+        iStack[h] = i + 1
+        ++h
+        vStack[h] = u
+        iStack[h] = 0
       } else {
-        --height
+        --h
       }
     }
-
-    // Maximal height of the trie.
-    return uStack.length
   }
 
   public clear(): void {
@@ -103,10 +99,9 @@ export class UnsafeTrie<E extends unknown[] | string, V> implements ITrie<E, V>
   }
 
   public delete(element: Readonly<E>, start = 0, end: number = element.length): boolean {
-    const { _ch, _values, _idx } = this
-    let i = start
     let u = 0
-    for (; i < end; ++i) {
+    const { _ch, _values, _idx } = this
+    for (let i = start; i < end; ++i) {
       const c: number = _idx(element[i])
       const v: number = _ch[u][c]
       if (v === 0) return false
@@ -172,7 +167,7 @@ export class UnsafeTrie<E extends unknown[] | string, V> implements ITrie<E, V>
     element: Readonly<E>,
     start = 0,
     end: number = element.length,
-  ): Iterable<ITrieNodeData<V>> {
+  ): IterableIterator<ITrieNodeData<V>> {
     if (start >= end) {
       const val = this._values[0]
       if (val !== undefined) yield { end: start, val }

Diff for: packages/trie/src/trie.ts

@@ -11,17 +11,12 @@ export class Trie<E extends unknown[] | string, V> extends UnsafeTrie<E, V> impl
   ): this {
     if (start < 0) start = 0
     if (end > element.length) end = element.length
-
-    if (start >= end) super.set(element, value, 0, 0)
-    else super.set(element, value, start, end)
-    return this
+    return super.set(element, value, start, end)
   }
 
   public override delete(element: Readonly<E>, start = 0, end: number = element.length): boolean {
     if (start < 0) start = 0
     if (end > element.length) end = element.length
-
-    if (start >= end) return super.delete(element, 0, 0)
     return super.delete(element, start, end)
   }
 
@@ -32,8 +27,6 @@ export class Trie<E extends unknown[] | string, V> extends UnsafeTrie<E, V> impl
   ): V | undefined {
     if (start < 0) start = 0
     if (end > element.length) end = element.length
-
-    if (start >= end) return super.get(element, 0, 0)
     return super.get(element, start, end)
   }
 
@@ -65,7 +58,7 @@ export class Trie<E extends unknown[] | string, V> extends UnsafeTrie<E, V> impl
     element: Readonly<E>,
     start = 0,
     end: number = element.length,
-  ): Iterable<ITrieNodeData<V>> {
+  ): IterableIterator<ITrieNodeData<V>> {
     if (start < 0) start = 0
     if (end > element.length) end = element.length
     return super.findAll(element, start, end)

Diff for: packages/types/src/collection.ts

@@ -1,9 +1,17 @@
-export interface ICollection<T> extends Iterable<T> {
+export interface IReadonlyCollection<T> {
   /**
    * Count the element in the collection.
    * @getter
    */
   readonly size: number
+
+  /**
+   * Iterable.
+   */
+  [Symbol.iterator](): IterableIterator<T>
+}
+
+export interface ICollection<T> extends IReadonlyCollection<T> {
   /**
    * Release memory.
    */