@blackglory/structures 0.9.0 → 0.10.2

package/README.md

@@ -81,7 +81,7 @@ class HashSet<V, Hash = unknown> implements Iterable<V> {
   delete(value: V): boolean
   has(value: V): boolean
   clear(): void
-  values(): Iterable<V>
+  values(): IterableIterator<V>
 }
 ```
 
@@ -151,9 +151,9 @@ class Queue<T> {
 class TrieMap<K extends Iterable<T>, V, T = unknown> {
   get [Symbol.toStringTag](): string
 
-  keys(): Iterable<T[]>
-  values(): Iterable<V>
-  entries(): Iterable<[key: T[], value: V]>
+  keys(): IterableIterator<T[]>
+  values(): IterableIterator<V>
+  entries(): IterableIterator<[key: T[], value: V]>
 
   set(key: K, value: V): this
   has(key: K): boolean
@@ -213,6 +213,10 @@ class SparseSet implements Iterable<number> {
   get [Symbol.toStringTag](): string
   get [Symbol.iterator](): IterableIterator<number>
 
+  constructor(array?: number[])
+
+  values(): IterableIterator<number>
+
   has(value: number): boolean
   add(value: number): void
   delete(value: number): void
@@ -224,9 +228,9 @@ class SparseSet implements Iterable<number> {
 class SparseMap<T> {
   get [Symbol.toStringTag](): string
 
-  entries(): Iterable<[key: number, value: T]>
-  keys(): Iterable<number>
-  values(): Iterable<T>
+  entries(): IterableIterator<[key: number, value: T]>
+  keys(): IterableIterator<number>
+  values(): IterableIterator<T>
 
   has(key: number): boolean
   get(key: number): T | undefined
@@ -235,11 +239,19 @@ class SparseMap<T> {
 }
 ```
 
-### TypedSparseSet
+### DynamicTypedArray
 ```ts
-class TypedSparseSet<T extends UnsignedTypedArrayConstructor> {
+class DynamicTypedArray<T extends TypedArrayConstructor> {
   get [Symbol.toStringTag](): string
-  get [Symbol.iterator](): IterableIterator<number>
+  get capacity(): number
+  get length(): number
+  readonly growthFactor: number
+
+  /**
+   * Note that `DynamicTypedArray` cannot respond to any operations on the internal array,
+   * you must ensure that indexes accessed are less than the length of `DynamicTypedArray`.
+   */
+  get internalTypedArray(): TypedArrayOfConstructor<T>
 
   constructor(
     typedArrayConstructor: T
@@ -249,8 +261,25 @@ class TypedSparseSet<T extends UnsignedTypedArrayConstructor> {
     }
   )
 
-  add(value: number): void
+  set(index: number, value: number): void
+  get(index: number): number | undefined
+  push(...values: number[]): void
+  pop(): number | undefined
+}
+```
+
+### TypedSparseSet
+```ts
+class TypedSparseSet<T extends UnsignedTypedArrayConstructor> {
+  get [Symbol.toStringTag](): string
+  get [Symbol.iterator](): IterableIterator<number>
+
+  constructor(array: DynamicTypedArray<T>)
+
+  values(): IterableIterator<number>
+
   has(value: number): boolean
+  add(value: number): void
   delete(value: number): void
 }
 ```
@@ -260,17 +289,11 @@ class TypedSparseSet<T extends UnsignedTypedArrayConstructor> {
 class TypedSparseMap<T extends TypedArrayConstructor> {
   get [Symbol.toStringTag](): string
 
-  constructor(
-    typedArrayConstructor: T
-  , options?: {
-      capacity?: number = 0
-      growthFactor?: number = 1.5
-    }
-  )
+  constructor(array: DynamicTypedArray<T>)
 
-  entries(): Iterable<[key: number, value: number]>
-  keys(): Iterable<number>
-  values(): Iterable<number>
+  entries(): IterableIterator<[key: number, value: number]>
+  keys(): IterableIterator<number>
+  values(): IterableIterator<number>
 
   has(key: number): boolean
   get(key: number): T | undefined
@@ -279,30 +302,17 @@ class TypedSparseMap<T extends TypedArrayConstructor> {
 }
 ```
 
-### DynamicTypedArray
+### SortedSet
 ```ts
-class DynamicTypedArray<T extends TypedArrayConstructor> {
+class SortedSet<T> {
   get [Symbol.toStringTag](): string
-  get capacity(): number
-  get length(): number
-
-  /**
-   * Note that `DynamicTypedArray` cannot respond to any operations on the internal array,
-   * you must ensure that indexes accessed are less than the length of `DynamicTypedArray`.
-   */
-  get internalTypedArray(): TypedArrayOfConstructor<T>
+  [Symbol.iterator](): IterableIterator<T>
 
-  constructor(
-    typedArrayConstructor: T
-  , options?: {
-      capacity?: number = 0
-      growthFactor?: number = 1.5
-    }
-  )
+  constructor(compare: (a: T, b: T) => number)
 
-  set(index: number, value: number): void
-  get(index: number): number | undefined
-  push(...values: number[]): void
-  pop(): number | undefined
+  values(): IterableIterator<T>
+  has(value: T): boolean
+  add(value: T): void
+  delete(value: T): void
 }
 ```