public class

SortedVIntList

extends DocIdSet
java.lang.Object
   ↳ org.apache.lucene.search.DocIdSet
     ↳ org.apache.lucene.util.SortedVIntList

Class Overview

Stores and iterate on sorted integers in compressed form in RAM.
The code for compressing the differences between ascending integers was borrowed from IndexInput and IndexOutput.

NOTE: this class assumes the stored integers are doc Ids (hence why it extends DocIdSet). Therefore its iterator() assumes NO_MORE_DOCS can be used as sentinel. If you intent to use this value, then make sure it's not used during search flow.

Summary

[Expand]
Inherited Fields
From class org.apache.lucene.search.DocIdSet
Public Constructors
SortedVIntList(int... sortedInts)
Create a SortedVIntList from all elements of an array of integers.
SortedVIntList(int[] sortedInts, int inputSize)
Create a SortedVIntList from an array of integers.
SortedVIntList(BitSet bits)
Create a SortedVIntList from a BitSet.
SortedVIntList(OpenBitSet bits)
Create a SortedVIntList from an OpenBitSet.
SortedVIntList(DocIdSetIterator docIdSetIterator)
Create a SortedVIntList.
Public Methods
int getByteSize()
boolean isCacheable()
This DocIdSet implementation is cacheable.
DocIdSetIterator iterator()
Provides a DocIdSetIterator to access the set.
int size()
[Expand]
Inherited Methods
From class org.apache.lucene.search.DocIdSet
From class java.lang.Object

Public Constructors

public SortedVIntList (int... sortedInts)

Create a SortedVIntList from all elements of an array of integers.

Parameters
sortedInts A sorted array of non negative integers.

public SortedVIntList (int[] sortedInts, int inputSize)

Create a SortedVIntList from an array of integers.

Parameters
sortedInts An array of sorted non negative integers.
inputSize The number of integers to be used from the array.

public SortedVIntList (BitSet bits)

Create a SortedVIntList from a BitSet.

Parameters
bits A bit set representing a set of integers.

public SortedVIntList (OpenBitSet bits)

Create a SortedVIntList from an OpenBitSet.

Parameters
bits A bit set representing a set of integers.

public SortedVIntList (DocIdSetIterator docIdSetIterator)

Create a SortedVIntList.

Parameters
docIdSetIterator An iterator providing document numbers as a set of integers. This DocIdSetIterator is iterated completely when this constructor is called and it must provide the integers in non decreasing order.
Throws
IOException

Public Methods

public int getByteSize ()

Returns
  • The size of the byte array storing the compressed sorted integers.

public boolean isCacheable ()

This DocIdSet implementation is cacheable.

public DocIdSetIterator iterator ()

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

Returns
  • An iterator over the sorted integers.

public int size ()

Returns
  • The total number of sorted integers.