@blackglory/structures 0.8.0 → 0.10.1

package/README.md

@@ -209,44 +209,32 @@ class ObservableFiniteStateMachine<
 
 ### SparseSet
 ```ts
-class SparseSet<T extends UnsignedTypedArrayConstructor> {
+class SparseSet implements Iterable<number> {
   get [Symbol.toStringTag](): string
   get [Symbol.iterator](): IterableIterator<number>
 
-  constructor(
-    typedArrayConstructor: T
-  , options?: {
-      capacity?: number = 0
-      growthFactor?: number = 1.5
-    }
-  )
+  constructor(array?: number[])
+
+  values(): Iterable<number>
 
-  add(value: number): void
   has(value: number): boolean
+  add(value: number): void
   delete(value: number): void
 }
 ```
 
 ### SparseMap
 ```ts
-class SparseMap<T extends TypedArrayConstructor> {
+class SparseMap<T> {
   get [Symbol.toStringTag](): string
 
-  constructor(
-    typedArrayConstructor: T
-  , options?: {
-      capacity?: number = 0
-      growthFactor?: number = 1.5
-    }
-  )
-
-  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
 }
 ```
@@ -257,6 +245,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,
@@ -278,3 +267,52 @@ 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>
+
+  has(value: number): boolean
+  add(value: number): void
+  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
+}
+```
+
+### SortedSet
+```ts
+class SortedSet<T> {
+  get [Symbol.toStringTag](): string
+  [Symbol.iterator](): IterableIterator<T>
+
+  constructor(compare: (a: T, b: T) => number)
+
+  values(): Iterable<T>
+  has(value: T): boolean
+  add(value: T): void
+  delete(value: T): void
+}
+```