@blackglory/structures 0.9.0 → 0.10.0

package/README.md

@@ -213,6 +213,8 @@ class SparseSet implements Iterable<number> {
   get [Symbol.toStringTag](): string
   get [Symbol.iterator](): IterableIterator<number>
 
+  values(): Iterable<number>
+
   has(value: number): boolean
   add(value: number): void
   delete(value: number): void
@@ -235,11 +237,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,6 +259,23 @@ class TypedSparseSet<T extends UnsignedTypedArrayConstructor> {
     }
   )
 
+  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>
+
   add(value: number): void
   has(value: number): boolean
   delete(value: number): void
@@ -260,17 +287,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
@@ -278,31 +299,3 @@ class TypedSparseMap<T extends TypedArrayConstructor> {
   delete(key: number): void
 }
 ```
-
-### DynamicTypedArray
-```ts
-class DynamicTypedArray<T extends TypedArrayConstructor> {
-  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>
-
-  constructor(
-    typedArrayConstructor: T
-  , options?: {
-      capacity?: number = 0
-      growthFactor?: number = 1.5
-    }
-  )
-
-  set(index: number, value: number): void
-  get(index: number): number | undefined
-  push(...values: number[]): void
-  pop(): number | undefined
-}
-```