net.openhft.chronicle.wire

Interface ChronicleBitSet

All Superinterfaces:

AutoCloseable, Closeable, net.openhft.chronicle.bytes.CommonMarshallable, Marshallable, net.openhft.chronicle.core.io.QueryCloseable, ReadMarshallable, net.openhft.chronicle.core.io.Resettable, WriteMarshallable, WriteValue

All Known Implementing Classes:

LongArrayValueBitSet, LongValueBitSet

public interface ChronicleBitSet
extends Marshallable, net.openhft.chronicle.core.io.Closeable

Interface for a bit set that is both Marshallable and Closeable. Implementations may store state off-heap so that bits can be persisted or shared between processes. Examples include LongValueBitSet and LongArrayValueBitSet.

Field Summary

Fields

Modifier and Type	Field and Description
static long	BITS_PER_WORD The number of bits in a long word (64).

Fields inherited from interface net.openhft.chronicle.wire.WriteMarshallable

EMPTY

Fields inherited from interface net.openhft.chronicle.wire.ReadMarshallable

DISCARD

Method Summary

Modifier and Type	Method and Description
void	and(ChronicleBitSet bitSet) Performs a logical AND with the given set.
void	andNot(ChronicleBitSet bitSet) Clears the bits that are set in the given set from this set.
int	cardinality() Counts the number of bits set to true.
void	clear() Sets all the bits in this ChronicleBitSet to false.
void	clear(int bitIndex) Clears the bit at the given zero-based index.
void	clear(int fromIndex, int toIndex) Clears all bits in the range [fromIndex, toIndex).
void	copyFrom(ChronicleBitSet bitSet) Copies all bits from bitSet into this set.
void	flip(int index) Flips the state of the bit at index.
void	flip(int fromIndex, int toIndex) Toggles all bits in the range [fromIndex, toIndex).
boolean	get(int bitIndex) Returns the value of the bit at the given zero-based index.
long	getWord(int wordIndex) Fetches the word at wordIndex from the internal representation.
int	getWordsInUse() Returns the number of long words currently used to hold the bits.
boolean	intersects(ChronicleBitSet bitSet) Checks whether any bit is set in both this set and bitSet.
default boolean	isEmpty()
default int	length() Returns the "logical size" of this ChronicleBitSet: the index of the highest set bit in the ChronicleBitSet plus one.
int	nextClearBit(int index) Returns the index of the next clear bit at or after index.
int	nextSetBit(int fromIndex) Finds the next set bit at or after fromIndex.
int	nextSetBit(int fromIndex, int toIndex) Finds the index of the next set bit between fromIndex and toIndex inclusive.
void	or(ChronicleBitSet bitSet) Performs a logical OR with the given set.
void	set(int bitIndex) Sets the bit at the given zero-based index.
default void	set(int bitIndex, boolean value) Sets the bit at the given index to the provided value.
void	set(int fromIndex, int toIndex) Sets every bit in the range [fromIndex, toIndex) to true.
default void	set(int fromIndex, int toIndex, boolean value) Sets each bit in the range [fromIndex, toIndex) to the given value.
void	setWord(int wordIndex, long bits) Sets the word at wordIndex to bits.
int	size() Returns the number of bits of space actually in use by this ChronicleBitSet to represent bit values.
void	xor(ChronicleBitSet bitSet) Performs a logical XOR with the given set.

Methods inherited from interface net.openhft.chronicle.wire.Marshallable

$equals, $fieldInfoMap, $fieldInfos, $hashCode, $toString, className, copyTo, deepCopy, fromFile, fromFile, fromString, fromString, fromString, getField, getLongField, mergeToMap, readMarshallable, reset, setField, setLongField, streamFromFile, streamFromFile, writeMarshallable

Methods inherited from interface net.openhft.chronicle.wire.WriteMarshallable

binaryLengthLength, writeValue

Methods inherited from interface net.openhft.chronicle.wire.ReadMarshallable

unexpectedField

Methods inherited from interface net.openhft.chronicle.bytes.CommonMarshallable

usesSelfDescribingMessage

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

close, closeQuietly, closeQuietly

Methods inherited from interface net.openhft.chronicle.core.io.QueryCloseable

isClosed, isClosing

Field Detail

BITS_PER_WORD

static final long BITS_PER_WORD

The number of bits in a long word (64).

See Also:

Constant Field Values

Method Detail

size

int size()

Returns the number of bits of space actually in use by this ChronicleBitSet to represent bit values. The maximum element in the set is the size - 1st element.

Returns:

the current capacity of this bit set

set

void set(int bitIndex)

Sets the bit at the given zero-based index.

Parameters:

bitIndex - index of the bit to set

Throws:

IndexOutOfBoundsException - if bitIndex < 0

set

default void set(int bitIndex,
                 boolean value)

Sets the bit at the given index to the provided value.

Parameters:

bitIndex - zero-based index of the bit to modify

value - the value to store at that index

Throws:

IndexOutOfBoundsException - if bitIndex < 0

set

void set(int fromIndex,
         int toIndex)

Sets every bit in the range [fromIndex, toIndex) to true.

Parameters:

fromIndex - index of the first bit to set, zero-based

toIndex - index after the last bit to set

Throws:

IndexOutOfBoundsException - if an index is negative or the range is invalid

set

default void set(int fromIndex,
                 int toIndex,
                 boolean value)

Sets each bit in the range [fromIndex, toIndex) to the given value.

Parameters:

fromIndex - zero-based index of the first bit to modify

toIndex - index after the last bit to modify

value - value to store in the selected range

Throws:

IndexOutOfBoundsException - if an index is negative or the range is invalid

get

boolean get(int bitIndex)

Returns the value of the bit at the given zero-based index.

Parameters:

bitIndex - index of the bit to query

Returns:

true if the bit is set

Throws:

IndexOutOfBoundsException - if bitIndex < 0

clear

void clear(int bitIndex)

Clears the bit at the given zero-based index.

Parameters:

bitIndex - index of the bit to clear

Throws:

IndexOutOfBoundsException - if bitIndex < 0

nextSetBit

int nextSetBit(int fromIndex,
               int toIndex)

Finds the index of the next set bit between fromIndex and toIndex inclusive.

To iterate over the true bits in a ChronicleBitSet, use the following loop:

 
 for (int i = bs.nextSetBit(0); i >= 0; i = bs.nextSetBit(i+1,to)) {
     // operate on index i here
     if (i == Integer.MAX_VALUE) {
         break; // or (i+1) would overflow
     }
 }

Parameters:

fromIndex - zero-based index to begin searching (inclusive)

toIndex - maximum index to examine (inclusive)

Returns:

index of the next set bit or -1 if none is found

Throws:

IndexOutOfBoundsException - if an index is negative

nextSetBit

int nextSetBit(int fromIndex)

Finds the next set bit at or after fromIndex.

Parameters:

fromIndex - zero-based index to begin searching

Returns:

index of the next set bit or -1 if none is found

Throws:

IndexOutOfBoundsException - if fromIndex < 0

clear

void clear()

Sets all the bits in this ChronicleBitSet to false.

isEmpty

default boolean isEmpty()

length

default int length()

Returns the "logical size" of this ChronicleBitSet: the index of the highest set bit in the ChronicleBitSet plus one. Returns zero if the ChronicleBitSet contains no set bits.

Returns:

the logical size of this ChronicleBitSet

cardinality

int cardinality()

Counts the number of bits set to true.

Returns:

number of set bits

nextClearBit

int nextClearBit(int index)

Returns the index of the next clear bit at or after index.

Parameters:

index - zero-based starting position

Returns:

index of the next clear bit or -1 if none is found

Throws:

IndexOutOfBoundsException - if index < 0

flip

void flip(int index)

Flips the state of the bit at index.

Parameters:

index - zero-based index of the bit to flip

Throws:

IndexOutOfBoundsException - if index < 0

flip

void flip(int fromIndex,
          int toIndex)

Toggles all bits in the range [fromIndex, toIndex).

Parameters:

fromIndex - zero-based start of the range

toIndex - end of the range (exclusive)

Throws:

IndexOutOfBoundsException - if the range is invalid

clear

void clear(int fromIndex,
           int toIndex)

Clears all bits in the range [fromIndex, toIndex).

Parameters:

fromIndex - zero-based start of the range

toIndex - end of the range (exclusive)

Throws:

IndexOutOfBoundsException - if the range is invalid

getWordsInUse

int getWordsInUse()

Returns the number of long words currently used to hold the bits. Trailing zero words are not counted.

Returns:

number of words in use

getWord

long getWord(int wordIndex)

Fetches the word at wordIndex from the internal representation.

Parameters:

wordIndex - zero-based index of the word

Returns:

the word value or 0 if out of range

setWord

void setWord(int wordIndex,
             long bits)

Sets the word at wordIndex to bits. Implementations may extend the storage to accommodate the index.

Parameters:

wordIndex - zero-based index of the word to modify

bits - the 64 bits to store

andNot

void andNot(ChronicleBitSet bitSet)

Clears the bits that are set in the given set from this set.

Parameters:

bitSet - bit set defining the bits to clear

and

void and(ChronicleBitSet bitSet)

Performs a logical AND with the given set.

Parameters:

bitSet - other bit set

xor

void xor(ChronicleBitSet bitSet)

Performs a logical XOR with the given set.

Parameters:

bitSet - other bit set

or

void or(ChronicleBitSet bitSet)

Performs a logical OR with the given set.

Parameters:

bitSet - other bit set

intersects

boolean intersects(ChronicleBitSet bitSet)

Checks whether any bit is set in both this set and bitSet.

Parameters:

bitSet - other bit set

Returns:

true if the sets share a common set bit

copyFrom

void copyFrom(ChronicleBitSet bitSet)

Copies all bits from bitSet into this set.

Parameters:

bitSet - source bit set