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>

Constructors

Properties

Accessors

Methods

Constructors

  • Creates a new iterator able to iterate a RoaringBitmap32.

    Parameters

    • Optional roaringBitmap32: ReadonlyRoaringBitmap32

      The roaring bitmap to iterate. If null or undefined, an empty iterator is created.

    • Optional reverse: boolean

    Returns RoaringBitmap32Iterator

    Memberof

    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

  • Creates a new iterator able to iterate a RoaringBitmap32 using the given temporary buffer.

    Parameters

    Returns RoaringBitmap32Iterator

    Memberof

    RoaringBitmap32Iterator The reusable temporary buffer. Length must be greater than 0.

Properties

default: typeof RoaringBitmap32Iterator

Accessors

Methods

  • Returns this.

    Returns this

    The same instance.

    Memberof

    RoaringBitmap32Iterator

  • Returns the next element in the iterator.

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

    Returns IteratorResult<number, any>

    The next result.

    Memberof

    RoaringBitmap32Iterator

Generated using TypeDoc