Package io.github.jbellis.jvector.util

Class AtomicFixedBitSet

java.lang.Object

io.github.jbellis.jvector.util.BitSet

io.github.jbellis.jvector.util.AtomicFixedBitSet

All Implemented Interfaces:

Accountable, Bits

public class AtomicFixedBitSet
extends BitSet

A BitSet implementation that offers concurrent reads and writes through an AtomicLongArray as bit storage.

For now, only implements the minimum functionality required by BitSet (in contrast to the extra methods in FixedBitSet).

Nested Class Summary

Nested classes/interfaces inherited from interface io.github.jbellis.jvector.util.Bits

Bits.MatchAllBits, Bits.MatchNoBits

Field Summary

Fields inherited from interface io.github.jbellis.jvector.util.Bits

ALL, NONE

Constructor Summary

Constructors

Constructor	Description
AtomicFixedBitSet(int numBits)

Method Summary

Modifier and Type	Method	Description
int	approximateCardinality()	Return an approximation of the cardinality of this set.
int	cardinality()	Return the number of bits that are set.
void	clear()	Clear all the bits of the set.
void	clear(int i)	Clear the bit at i.
void	clear(int startIndex, int endIndex)	Clears a range of bits.
boolean	get(int i)	Returns the value of the bit with the specified index.
boolean	getAndSet(int i)	Set the bit at i, returning true if it was previously set.
int	length()	The number of bits in the set.
int	nextSetBit(int index)	Returns the index of the first set bit starting at the index specified.
int	prevSetBit(int index)	Returns the index of the last set bit before or on the index specified.
long	ramBytesUsed()
void	set(int i)	Set the bit at i.

Methods inherited from class io.github.jbellis.jvector.util.BitSet

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

AtomicFixedBitSet

public AtomicFixedBitSet(int numBits)

Method Details

length

public int length()

Description copied from class: BitSet

The number of bits in the set.

Specified by:

length in class BitSet

set

public void set(int i)

Description copied from class: BitSet

Set the bit at i.

Specified by:

set in class BitSet

get

public boolean get(int i)

Description copied from interface: Bits

Returns the value of the bit with the specified index.

Parameters:

i - index, should be non-negative. The result of passing negative or out of bounds values is undefined by this interface, just don't do it!

Returns:

true if the bit is set, false otherwise.

getAndSet

public boolean getAndSet(int i)

Description copied from class: BitSet

Set the bit at i, returning true if it was previously set.

Specified by:

getAndSet in class BitSet

clear

public void clear()

Description copied from class: BitSet

Clear all the bits of the set.

Depending on the implementation, this may be significantly faster than clear(0, length).

Overrides:

clear in class BitSet

clear

public void clear(int i)

Description copied from class: BitSet

Clear the bit at i.

Specified by:

clear in class BitSet

clear

public void clear(int startIndex,
 int endIndex)

Description copied from class: BitSet

Clears a range of bits.

Specified by:

clear in class BitSet

Parameters:

startIndex - lower index

endIndex - one-past the last bit to clear

cardinality

public int cardinality()

Description copied from class: BitSet

Return the number of bits that are set. NOTE: this method is likely to run in linear time

Specified by:

cardinality in class BitSet

approximateCardinality

public int approximateCardinality()

Description copied from class: BitSet

Return 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 returns BitSet.cardinality().

Specified by:

approximateCardinality in class BitSet

prevSetBit

public int prevSetBit(int index)

Description copied from class: BitSet

Returns 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:

prevSetBit in class BitSet

nextSetBit

public int nextSetBit(int index)

Description copied from class: BitSet

Returns the index of the first set bit starting at the index specified. DocIdSetIterator.NO_MORE_DOCS is returned if there are no more set bits.

Specified by:

nextSetBit in class BitSet

ramBytesUsed

public long ramBytesUsed()