@blackglory/structures 0.6.10 → 0.9.0

package/README.md

@@ -209,13 +209,73 @@ class ObservableFiniteStateMachine<
 
 ### SparseSet
 ```ts
-class SparseSet {
+class SparseSet implements Iterable<number> {
   get [Symbol.toStringTag](): string
   get [Symbol.iterator](): IterableIterator<number>
 
+  has(value: number): boolean
+  add(value: number): void
+  delete(value: number): void
+}
+```
+
+### SparseMap
+```ts
+class SparseMap<T> {
+  get [Symbol.toStringTag](): string
+
+  entries(): Iterable<[key: number, value: T]>
+  keys(): Iterable<number>
+  values(): Iterable<T>
+
+  has(key: number): boolean
+  get(key: number): T | undefined
+  set(key: number, value: T): void
+  delete(key: number): void
+}
+```
+
+### TypedSparseSet
+```ts
+class TypedSparseSet<T extends UnsignedTypedArrayConstructor> {
+  get [Symbol.toStringTag](): string
+  get [Symbol.iterator](): IterableIterator<number>
+
+  constructor(
+    typedArrayConstructor: T
+  , options?: {
+      capacity?: number = 0
+      growthFactor?: number = 1.5
+    }
+  )
+
   add(value: number): void
   has(value: number): boolean
-  remove(value: number): void
+  delete(value: number): void
+}
+```
+
+### TypedSparseMap
+```ts
+class TypedSparseMap<T extends TypedArrayConstructor> {
+  get [Symbol.toStringTag](): string
+
+  constructor(
+    typedArrayConstructor: T
+  , options?: {
+      capacity?: number = 0
+      growthFactor?: number = 1.5
+    }
+  )
+
+  entries(): Iterable<[key: number, value: number]>
+  keys(): Iterable<number>
+  values(): Iterable<number>
+
+  has(key: number): boolean
+  get(key: number): T | undefined
+  set(key: number, value: number): void
+  delete(key: number): void
 }
 ```
 
@@ -234,10 +294,10 @@ class DynamicTypedArray<T extends TypedArrayConstructor> {
 
   constructor(
     typedArrayConstructor: T
-  , options: {
+  , options?: {
       capacity?: number = 0
       growthFactor?: number = 1.5
-    } = {}
+    }
   )
 
   set(index: number, value: number): void