Class RoaringBitmap32Iterator

Iterator for RoaringBitmap32.

WARNING: Is not allowed to change the bitmap while iterating. The iterator may throw exception if the bitmap is changed during the iteration.

Export

RoaringBitmap32Iterator

Implements

Implements

IterableIterator<number>

Index

Constructors

Properties

isReverseIterator default

Methods

[dispose] [iterator] dispose next return

Constructors

constructor

new RoaringBitmap32Iterator(
roaringBitmap32?: ReadonlyRoaringBitmap32,
reverse?: boolean,
): RoaringBitmap32Iterator
Creates a new iterator able to iterate a RoaringBitmap32.
Parameters
- OptionalroaringBitmap32: ReadonlyRoaringBitmap32
  The roaring bitmap to iterate. If null or undefined, an empty iterator is created.
- Optionalreverse: boolean
Returns RoaringBitmap32Iterator
Memberof
RoaringBitmap32Iterator
- Defined in index.d.ts:2410
new RoaringBitmap32Iterator(
roaringBitmap32: ReadonlyRoaringBitmap32,
bufferSize: number,
): RoaringBitmap32Iterator
Creates a new iterator able to iterate a RoaringBitmap32.

It allocates a small temporary buffer of the given size for speedup.
Parameters
- roaringBitmap32: ReadonlyRoaringBitmap32
  The roaring bitmap to iterate
- bufferSize: number
  Buffer size to allocate, must be an integer greater than 0
Returns RoaringBitmap32Iterator
Memberof
RoaringBitmap32Iterator
- Defined in index.d.ts:2421
new RoaringBitmap32Iterator(
roaringBitmap32: ReadonlyRoaringBitmap32,
buffer: Uint32Array,
): RoaringBitmap32Iterator
Creates a new iterator able to iterate a RoaringBitmap32 using the given temporary buffer.
Parameters
- roaringBitmap32: ReadonlyRoaringBitmap32
- buffer: Uint32Array
  The roaring bitmap to iterate
Returns RoaringBitmap32Iterator
Memberof
RoaringBitmap32Iterator The reusable temporary buffer. Length must be greater than 0.
- Defined in index.d.ts:2430

Properties

`Readonly`isReverseIterator

isReverseIterator: boolean

`Static` `Readonly`default

default: typeof RoaringBitmap32Iterator

Methods

[dispose]

"[dispose]"(): IteratorResult<number>
Resource-management hook so RoaringBitmap32Iterator participates in the Symbol.dispose protocol.

Returns IteratorResult<number>
- Defined in index.d.ts:2463

[iterator]

"[iterator]"(): this
Returns this.

Returns this
The same instance.

Memberof
RoaringBitmap32Iterator
Implementation of IterableIterator.[iterator]
- Defined in index.d.ts:2438

dispose

dispose(value?: number): IteratorResult<number>
Disposes this iterator so it can be used with the Symbol.dispose protocol.
Parameters
- Optionalvalue: number
Returns IteratorResult<number>
- Defined in index.d.ts:2458

next

next(): IteratorResult<number>
Returns the next element in the iterator.

For performance reasons, this function returns always the same instance.

Returns IteratorResult<number>
The next result.

Memberof
RoaringBitmap32Iterator
Implementation of IterableIterator.next
- Defined in index.d.ts:2448

return

return(value?: number): IteratorResult<number>
Stops the iteration early and releases the underlying buffer.
Parameters
- Optionalvalue: number
Returns IteratorResult<number>
Implementation of IterableIterator.return
- Defined in index.d.ts:2453