org.apache.lucene.util.packed
Class EliasFanoDocIdSet

java.lang.Object
  org.apache.lucene.search.DocIdSet
      org.apache.lucene.util.packed.EliasFanoDocIdSet

public class EliasFanoDocIdSet
extends DocIdSet

A DocIdSet in Elias-Fano encoding.

NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

Constructor Summary

EliasFanoDocIdSet(int numValues, int upperBound)

Method Summary

void	encodeFromDisi(DocIdSetIterator disi)
boolean	equals(Object other)
int	hashCode()
boolean	isCacheable() This DocIdSet implementation is cacheable.
DocIdSetIterator	iterator() Provides a DocIdSetIterator to access encoded document ids.

Methods inherited from class org.apache.lucene.search.DocIdSet

bits

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EliasFanoDocIdSet

public EliasFanoDocIdSet(int numValues,
                         int upperBound)

Method Detail

encodeFromDisi

public void encodeFromDisi(DocIdSetIterator disi)
                    throws IOException

Throws:

IOException

iterator

public DocIdSetIterator iterator()

Provides a DocIdSetIterator to access encoded document ids.

Specified by:

iterator in class DocIdSet

isCacheable

public boolean isCacheable()

This DocIdSet implementation is cacheable. @return true

Overrides:

isCacheable in class DocIdSet

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object