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

Field Summary

Fields

Modifier and Type	Field and Description
static long	BITS_PER_WORD

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)
void	andNot(ChronicleBitSet bitSet)
int	cardinality()
void	clear() Sets all the bits in this ChronicleBitSet to false.
void	clear(int bitIndex) Sets the bit specified by the index to false.
void	clear(int fromIndex, int toIndex)
void	copyFrom(ChronicleBitSet bitSet)
void	flip(int index)
void	flip(int fromIndex, int toIndex)
boolean	get(int bitIndex) Returns the value of the bit with the specified index.
long	getWord(int wordIndex)
int	getWordsInUse()
boolean	intersects(ChronicleBitSet 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)
int	nextSetBit(int fromIndex)
int	nextSetBit(int fromIndex, int toIndex) Returns the index of the first bit that is set to true that occurs on or after the specified starting index.
void	or(ChronicleBitSet bitSet)
void	set(int bitIndex) Sets the bit at the specified index to true.
default void	set(int bitIndex, boolean value) Sets the bit at the specified index to the specified value.
void	set(int fromIndex, int toIndex)
default void	set(int fromIndex, int toIndex, boolean value) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the specified value.
void	setWord(int wordIndex, long bits)
int	size() Returns the number of bits of space actually in use by this ChronicleBitSet to represent bit values.
void	xor(ChronicleBitSet bitSet)

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

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 number of bits currently in this bit set

set

void set(int bitIndex)

Sets the bit at the specified index to true.

Parameters:

bitIndex - a bit index

Throws:

IndexOutOfBoundsException - if the specified index is negative

set

default void set(int bitIndex,
                 boolean value)

Sets the bit at the specified index to the specified value.

Parameters:

bitIndex - a bit index

value - a boolean value to set

Throws:

IndexOutOfBoundsException - if the specified index is negative

set

void set(int fromIndex,
         int toIndex)

set

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

Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the specified value.

Parameters:

fromIndex - index of the first bit to be set

toIndex - index after the last bit to be set

value - value to set the selected bits to

Throws:

IndexOutOfBoundsException - if fromIndex is negative, or toIndex is negative, or fromIndex is larger than toIndex

get

boolean get(int bitIndex)

Returns the value of the bit with the specified index. The value is true if the bit with the index bitIndex is currently set in this ChronicleBitSet; otherwise, the result is false.

Parameters:

bitIndex - the bit index

Returns:

the value of the bit with the specified index

Throws:

IndexOutOfBoundsException - if the specified index is negative

clear

void clear(int bitIndex)

Sets the bit specified by the index to false.

Parameters:

bitIndex - the index of the bit to be cleared

Throws:

IndexOutOfBoundsException - if the specified index is negative

nextSetBit

int nextSetBit(int fromIndex,
               int toIndex)

Returns the index of the first bit that is set to true that occurs on or after the specified starting index. If no such bit exists then -1 is returned.

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 - the index to start checking from (inclusive)

toIndex - (inclusive) returns -1 if a bit is not found before this value

Returns:

the index of the next set bit, or -1 if there is no such bit

Throws:

IndexOutOfBoundsException - if the specified index is negative

nextSetBit

int nextSetBit(int fromIndex)

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()

nextClearBit

int nextClearBit(int index)

flip

void flip(int index)

flip

void flip(int fromIndex,
          int toIndex)

clear

void clear(int fromIndex,
           int toIndex)

getWordsInUse

int getWordsInUse()

getWord

long getWord(int wordIndex)

setWord

void setWord(int wordIndex,
             long bits)

andNot

void andNot(ChronicleBitSet bitSet)

and

void and(ChronicleBitSet bitSet)

xor

void xor(ChronicleBitSet bitSet)

or

void or(ChronicleBitSet bitSet)

intersects

boolean intersects(ChronicleBitSet bitSet)

copyFrom

void copyFrom(ChronicleBitSet bitSet)