Package org.apache.lucene.util
Class SparseFixedBitSet
java.lang.Object
org.apache.lucene.util.BitSet
org.apache.lucene.util.SparseFixedBitSet
- All Implemented Interfaces:
Accountable,Bits
A bit set that only stores longs that have at least one bit which is set. The way it works is
that the space of bits is divided into blocks of 4096 bits, which is 64 longs. Then for each
block, we have:
- a long[] which stores the non-zero longs for that block
- a long so that bit
ibeing set means that thei-thlong of the block is non-null, and its offset in the array of longs is the number of one bits on the right of thei-thbit.
- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.apache.lucene.util.Bits
Bits.MatchAllBits, Bits.MatchNoBits -
Field Summary
Fields inherited from interface org.apache.lucene.util.Accountable
NULL_ACCOUNTABLEFields inherited from interface org.apache.lucene.util.Bits
EMPTY_ARRAY -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionintReturn an approximation of the cardinality of this set.intReturn the number of bits that are set.voidclear()Clear all the bits of the set.voidclear(int i) Clear the bit at indexi.voidclear(int from, int to) Clears a range of bits.booleanget(int i) Returns the value of the bit with the specifiedindex.booleangetAndSet(int i) Set the bit ati, returningtrueif it was previously set.intlength()Returns the number of bits in this setintnextSetBit(int i) Returns the index of the first set bit starting at the index specified.intnextSetBit(int start, int upperBound) Returns the index of the first set bit from start (inclusive) until end (exclusive).voidor(DocIdSetIterator it) Does in-place OR of the bits provided by the iterator.intprevSetBit(int i) Returns the index of the last set bit before or on the index specified.longReturn the memory usage of this object in bytes.voidset(int i) Set the bit at indexi.toString()Methods inherited from class org.apache.lucene.util.BitSet
checkUnpositioned, ofMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.lucene.util.Accountable
getChildResources
-
Constructor Details
-
SparseFixedBitSet
public SparseFixedBitSet(int length)
-
-
Method Details
-
clear
public void clear()Description copied from class:BitSetClear all the bits of the set.Depending on the implementation, this may be significantly faster than clear(0, length).
-
length
public int length()Description copied from interface:BitsReturns the number of bits in this set -
cardinality
public int cardinality()Description copied from class:BitSetReturn the number of bits that are set. NOTE: this method is likely to run in linear time- Specified by:
cardinalityin classBitSet
-
approximateCardinality
public int approximateCardinality()Description copied from class:BitSetReturn an approximation of the cardinality of this set. Some implementations may trade accuracy for speed if they have the ability to estimate the cardinality of the set without iterating over all the data. The default implementation returnsBitSet.cardinality().- Specified by:
approximateCardinalityin classBitSet
-
get
public boolean get(int i) Description copied from interface:BitsReturns the value of the bit with the specifiedindex.- Parameters:
i- index, should be non-negative and <Bits.length(). The result of passing negative or out of bounds values is undefined by this interface, just don't do it!- Returns:
trueif the bit is set,falseotherwise.
-
getAndSet
public boolean getAndSet(int i) Description copied from class:BitSetSet the bit ati, returningtrueif it was previously set. -
set
public void set(int i) Set the bit at indexi. -
clear
public void clear(int i) Clear the bit at indexi. -
clear
public void clear(int from, int to) Description copied from class:BitSetClears a range of bits. -
nextSetBit
public int nextSetBit(int i) Description copied from class:BitSetReturns the index of the first set bit starting at the index specified.DocIdSetIterator.NO_MORE_DOCSis returned if there are no more set bits.- Overrides:
nextSetBitin classBitSet
-
nextSetBit
public int nextSetBit(int start, int upperBound) Description copied from class:BitSetReturns the index of the first set bit from start (inclusive) until end (exclusive).DocIdSetIterator.NO_MORE_DOCSis returned if there are no more set bits.- Specified by:
nextSetBitin classBitSet
-
prevSetBit
public int prevSetBit(int i) Description copied from class:BitSetReturns the index of the last set bit before or on the index specified. -1 is returned if there are no more set bits.- Specified by:
prevSetBitin classBitSet
-
or
Description copied from class:BitSetDoes in-place OR of the bits provided by the iterator. The state of the iterator after this operation terminates is undefined.- Overrides:
orin classBitSet- Throws:
IOException
-
ramBytesUsed
public long ramBytesUsed()Description copied from interface:AccountableReturn the memory usage of this object in bytes. Negative values are illegal. -
toString
-