core/org.gnit.lucenekmp.util/RoaringDocIdSet

RoaringDocIdSet

class RoaringDocIdSet : DocIdSet

DocIdSet implementation inspired from http://roaringbitmap.org/

The space is divided into blocks of 2^16 bits and each block is encoded independently. In each block, if less than 2^12 bits are set, then documents are simply stored in a short[]. If more than 2^16-2^12 bits are set, then the inverse of the set is encoded in a simple short[]. Otherwise a FixedBitSet is used.

Types

class Builder(maxDoc: Int)

A builder of RoaringDocIdSets.

object Companion

Properties

open val childResources: MutableCollection<Accountable>

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

Functions

fun cardinality(): Int

Return the exact number of documents that are contained in this set.

open override fun iterator(): DocIdSetIterator

Provides a DocIdSetIterator to access the set. This implementation can return null if there are no docs that match.

open override fun ramBytesUsed(): Long

Return the memory usage of this object in bytes. Negative values are illegal.

open override fun toString(): String