Skip to content

Commit b814441

Browse files
authored
Update config.md
1 parent 29b081c commit b814441

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

docs/config.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Creates a new QuickSet instance with default settings (the top-k [`window`](#qui
77
let config = {
88

99
mode: "minsum" || "winsum",
10-
slot: 0, // top-k window off by default (0 .. 16)
10+
slot: 0, // top-k window off by default (0 .. 64)
1111

1212
span: 512, // max expected integer range (0 .. 2^28)
1313
clip: 0, // min expected integer range (0 .. 2^28)
@@ -48,9 +48,9 @@ Threshold for integers to qualify for a top-k position.
4848
- Lower frequency bound per integer (exclusive).
4949
- Defaults to `1`.
5050

51-
###### `slot: 0 .. 16`
51+
###### `slot: 0 .. 64`
5252
Amount of slots to keep track of the top-k most frequent integers in a set.
53-
- Values between `0` and `16` set the top-k `window` size.
53+
- Values between `0` and `64` set the top-k `window` size.
5454
- Defaults to `0`.
5555

5656
###### `fifo: true || false`
@@ -62,21 +62,21 @@ Whether to eject old values from the top-k window in case of ties (*first-in fir
6262
Besides the configured options and methods, [`QuickSet`](#new-quickset-config) returns an object with two visible and one hidden backing array and some additional properties describing the internal state.
6363
While each array can be read without issue (for instance, to execute some logic when a specific integer reaches a certain top-k position or when its frequency exceeds a certain threshold), modifying them can lead to unwanted behaviour.
6464
- The hidden [`bits`](#setbits-uintarray) array acts as a backing array to track all integer frequencies in a set.
65-
- The visible arrays, [`rank`](#setrank-uintarray) and [`stat`](#setstat-uintarray) provide the top-k [`window`](#slot-0--16) of most frequent integers (rank) and values (stat) present in a set.
65+
- The visible arrays, [`rank`](#setrank-uintarray) and [`stat`](#setstat-uintarray) provide the top-k [`window`](#slot-0--64) of most frequent integers (rank) and values (stat) present in a set.
6666

6767
###### `set.bits: [UintArray]`
6868
This non-enumerable property contains the backing array (Typed) that stores all integers present in the set as well as their values.
6969

7070
###### `set.rank: [UintArray]`
7171
This enumerable property displays the top-k window of ranked integers (Typed).
72-
The window size is determined from [`slot`](#slot-0--16).
72+
The window size is determined from [`slot`](#slot-0--64).
7373

7474
###### `set.stat: [UintArray]`
7575
This enumerable property displays the values associated with each ranked integer (Typed).
7676
Same length as [`rank`](#setrank-uintarray).
7777

7878
###### `set.last: Uint`
79-
A constant parameter for accessing the last item in the top-k window defined by [`slot`](#slot-0--16).
79+
A constant parameter for accessing the last item in the top-k window defined by [`slot`](#slot-0--64).
8080

8181
###### `set.tmin: Uint`
8282
A variable parameter displaying the minimum value in the top-k window, lower bounded by [`freq`](#freq-0--2--32).
@@ -661,9 +661,9 @@ let set = new QuickSet({
661661

662662
### Resizing
663663

664-
#### `.resize( 0 .. 16 )`
664+
#### `.resize( 0 .. 64 )`
665665
Method for resizing the top-k [`window`](#quickset-class) to a desired amount of slots.
666-
Keeps the set [`rank`](#setrank-uintarray) and [`stat`](#setstat-uintarray) data intact and pads with zeroes when increasing the [`slot`](#slot-0--16) parameter and drops data when decreased.
666+
Keeps the set [`rank`](#setrank-uintarray) and [`stat`](#setstat-uintarray) data intact and pads with zeroes when increasing the [`slot`](#slot-0--64) parameter and drops data when decreased.
667667

668668
``` js
669669

@@ -689,9 +689,9 @@ let set = new QuickSet({
689689

690690
### Disposal
691691

692-
#### `.clear( true || 0 .. 16 )`
692+
#### `.clear( true || 0 .. 64 )`
693693
Method for clearing the [Typed backing array](#setbits-uintarray) (`.clear(null)`) and optionally wiping the [top-k window](#quickset-class) (`.clear(true)`).
694-
During clearing operations, the top-k window can be resized as desired between 1 and 16 slots (`.clear(1..16)`).
694+
During clearing operations, the top-k window can be resized as desired between 1 and 64 slots (`.clear(1..64)`).
695695
This is useful for resetting and reusing a set between runs without constructing a `new QuickSet`.
696696

697697
``` js
@@ -737,4 +737,4 @@ let set = new QuickSet({
737737
// set.rank = [ 0,1,2,3,4,6 ];
738738
// set.stat = [ 1,3,1,2,1,1 ];
739739

740-
```
740+
```

0 commit comments

Comments
 (0)