@blackglory/structures 0.7.0 → 0.10.0

package/README.md

@@ -209,12 +209,14 @@ class ObservableFiniteStateMachine<
 
 ### SparseSet
 ```ts
-class SparseSet {
+class SparseSet implements Iterable<number> {
   get [Symbol.toStringTag](): string
   get [Symbol.iterator](): IterableIterator<number>
 
-  add(value: number): void
+  values(): Iterable<number>
+
   has(value: number): boolean
+  add(value: number): void
   delete(value: number): void
 }
 ```
@@ -224,13 +226,13 @@ class SparseSet {
 class SparseMap<T> {
   get [Symbol.toStringTag](): string
 
-  entries(): Iterable<[key: number, value: number]>
+  entries(): Iterable<[key: number, value: T]>
   keys(): Iterable<number>
-  values(): Iterable<number>
+  values(): Iterable<T>
 
   has(key: number): boolean
   get(key: number): T | undefined
-  set(key: number, value: number): void
+  set(key: number, value: T): void
   delete(key: number): void
 }
 ```
@@ -241,6 +243,7 @@ class DynamicTypedArray<T extends TypedArrayConstructor> {
   get [Symbol.toStringTag](): string
   get capacity(): number
   get length(): number
+  readonly growthFactor: number
 
   /**
    * Note that `DynamicTypedArray` cannot respond to any operations on the internal array,
@@ -250,10 +253,10 @@ class DynamicTypedArray<T extends TypedArrayConstructor> {
 
   constructor(
     typedArrayConstructor: T
-  , options: {
+  , options?: {
       capacity?: number = 0
       growthFactor?: number = 1.5
-    } = {}
+    }
   )
 
   set(index: number, value: number): void
@@ -262,3 +265,37 @@ class DynamicTypedArray<T extends TypedArrayConstructor> {
   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>
+
+  add(value: number): void
+  has(value: number): boolean
+  delete(value: number): void
+}
+```
+
+### TypedSparseMap
+```ts
+class TypedSparseMap<T extends TypedArrayConstructor> {
+  get [Symbol.toStringTag](): string
+
+  constructor(array: DynamicTypedArray<T>)
+
+  entries(): IterableIterator<[key: number, value: number]>
+  keys(): IterableIterator<number>
+  values(): IterableIterator<number>
+
+  has(key: number): boolean
+  get(key: number): T | undefined
+  set(key: number, value: number): void
+  delete(key: number): void
+}
+```