Class MultiIndexSetCursorOr

An index cursor that allows multiple index ranges from the same buffer to be or'd together.

This is useful for aggregating sets of items in a union operation.

Implements

IIndexSetCursor

Index

Accessors

Methods

addRange free step allocate

Accessors

high

get high(): number
Get the current high 27 bits, as a regular number with the lower 5 bits padded to zero.

Returns number
The high bits.
Implementation of IIndexSetCursor.high
- Defined in indexing/multi_index_set_cursor_or.ts:36

low

get low(): number
Get a set of up to 32 low bits, in one-hot format or'd together, so that each bit index represents a 5 bit bottom part corresponding to the top 27

Returns number
The high bits.
Implementation of IIndexSetCursor.low
- Defined in indexing/multi_index_set_cursor_or.ts:46

Methods

addRange

addRange(from: number, to: number): void
Add a range from the multi-set buffer to the cursor.
Parameters
- from: number
  The start of the range.
- to: number
  The end of the range (not inclusive)
Returns void
- Defined in indexing/multi_index_set_cursor_or.ts:135

free

free(): void
Free this back to the pool.

Returns void
Implementation of IIndexSetCursor.free
- Defined in indexing/multi_index_set_cursor_or.ts:160

step

step(): boolean
Step this cursor to the next high (and matching set of lows)

Returns boolean
True if this is not at the end of the sequence, false otherwise.
Implementation of IIndexSetCursor.step
- Defined in indexing/multi_index_set_cursor_or.ts:56

`Static`allocate

allocate(buffer: Uint32Array): MultiIndexSetCursorOr
Allocate a MultiIndexSetCursorOr, re-using freed ones in the pool.
Parameters
- buffer: Uint32Array
Returns MultiIndexSetCursorOr
The allocated cursor.
- Defined in indexing/multi_index_set_cursor_or.ts:114