net.openhft.chronicle.wire

Class LongArrayValueBitSet

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.wire.LongArrayValueBitSet

All Implemented Interfaces:

Closeable, AutoCloseable, net.openhft.chronicle.bytes.CommonMarshallable, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.Monitorable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.Resettable, net.openhft.chronicle.core.io.SingleThreadedChecked, ChronicleBitSet, Marshallable, ReadMarshallable, WriteMarshallable, WriteValue

public class LongArrayValueBitSet
extends net.openhft.chronicle.core.io.AbstractCloseable
implements Marshallable, ChronicleBitSet

A ChronicleBitSet backed by a LongArrayValues. The backing array can reside off-heap, allowing multiple processes to share the same state. All updates rely on compare‑and‑swap operations and therefore do not require explicit locks. Note: the capacity is fixed when the instance is created and cannot later be expanded.

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractCloseable

closedHere, DISABLE_DISCARD_WARNING, WARN_NS

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

BITS_PER_WORD

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

EMPTY

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

DISCARD

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Fields inherited from interface net.openhft.chronicle.core.io.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
LongArrayValueBitSet(long maxNumberOfBits) Create a bit set capable of holding maxNumberOfBits bits.
LongArrayValueBitSet(long maxNumberOfBits, Wire w) Create a bit set of maxNumberOfBits bits and immediately marshal its state to and from the provided Wire.

Method Summary

Modifier and Type	Method and Description
void	and(ChronicleBitSet set) Performs a bitwise AND operation between this ChronicleBitSet and the provided set.
void	andNot(ChronicleBitSet set) Clears all the bits in this ChronicleBitSet that are set in the specified ChronicleBitSet.
int	cardinality() Computes the number of bits that are currently set to true in this ChronicleBitSet.
void	clear() Sets all bits in this ChronicleBitSet to false.
void	clear(int bitIndex) Clears (sets to false) the bit specified by the index.
void	clear(int fromIndex, int toIndex) Clears (sets to false) the range of bits from the specified starting index (inclusive) to the ending index (exclusive).
void	copyFrom(ChronicleBitSet bitSet) Copies all bits from bitSet into this set.
boolean	equals(Object obj) Compares this ChronicleBitSet against the specified object.
void	flip(int bitIndex) Flips the bit at the specified index, turning it to its opposite value (0 to 1, or 1 to 0).
void	flip(int fromIndex, int toIndex) Flips the bits from a starting index to an ending index.
boolean	get(int bitIndex) Returns the value of the bit with the specified index.
long	getWord(int wordIndex) Return the value of the word at wordIndex or zero if beyond getWordsInUse().
int	getWordsInUse() Retrieves the number of words that are currently in use by this bit set.
int	hashCode() Returns the hash code for this ChronicleBitSet.
boolean	intersects(ChronicleBitSet set) Determines if there's any overlapping bit set to true between this ChronicleBitSet and the given ChronicleBitSet.
int	nextClearBit(int fromIndex) Retrieves the index of the first bit set to false that occurs on or after the specified starting index.
int	nextSetBit(int fromIndex) Finds and returns the index of the first bit that is set to true after the specified starting index.
int	nextSetBit(int fromIndex, int toIndex) Retrieves the index of the first bit set to true that occurs on or after the specified starting index and before the specified ending index.
void	or(ChronicleBitSet set) Performs a logical OR of this bit set with the bit set argument.
protected void	performClose()
int	previousClearBit(int fromIndex) Identifies the closest bit set to false that occurs on or before the given starting index.
int	previousSetBit(int fromIndex) Identifies the closest bit set to true that occurs on or before the given starting index.
void	readMarshallable(@NotNull WireIn wire) Reads the state of the Marshallable object from the given wire input.
void	set(int bitIndex) Sets the bit at the specified index to true.
void	set(int bitIndex, boolean value) Sets or clears the bit at the specified index based on the provided boolean value.
void	set(int fromIndex, int toIndex) Sets all bits in the specified range to true.
void	set(int wordIndex, long param, net.openhft.chronicle.wire.LongArrayValueBitSet.LongFunction function) Sets a specific word in this bit set using a provided function and parameter.
void	set(net.openhft.chronicle.core.values.LongValue word, long newValue) Sets a new value for a given word in this bit set.
void	setWord(int wordIndex, long bits) Store bits at the given wordIndex.
int	size() Returns the total number of bits that this ChronicleBitSet can represent.
IntStream	stream() Returns an ordered stream of indices for which this ChronicleBitSet contains a bit set to true.
byte[]	toByteArray() Converts the bits in this bit set to a byte array.
String	toString() Returns a string representation of this bit set.
static BitSet	valueOf(byte[] bytes) Constructs and returns a new BitSet using the bits from the provided byte array.
void	writeMarshallable(@NotNull WireOut wire) Writes the state of the Marshallable object to the given wire output.
void	xor(ChronicleBitSet set) Performs a logical XOR of this bit set with the bit set argument.

Methods inherited from class net.openhft.chronicle.core.io.AbstractCloseable

assertCloseable, assertCloseablesClosed, close, createdHere, disableCloseableTracing, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, shouldPerformCloseInBackground, shouldWaitForClosed, singleThreadedCheckDisabled, singleThreadedCheckDisabled, singleThreadedCheckReset, threadSafetyCheck, throwExceptionIfClosed, throwExceptionIfClosedInSetter, unmonitor, waitForCloseablesToClose, waitForClosed, warnAndCloseIfNotClosed

Methods inherited from class java.lang.Object

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

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

isEmpty, length, 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, reset, setField, setLongField, streamFromFile, streamFromFile

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

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

referenceName, temporary

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

unmonitor

Constructor Detail

LongArrayValueBitSet

public LongArrayValueBitSet(long maxNumberOfBits)

Create a bit set capable of holding maxNumberOfBits bits. The backing BinaryLongArrayReference is sized once during construction.

LongArrayValueBitSet

public LongArrayValueBitSet(long maxNumberOfBits,
                            Wire w)

Create a bit set of maxNumberOfBits bits and immediately marshal its state to and from the provided Wire. The words field is initialised using a BinaryLongArrayReference before marshalling occurs.

Method Detail

valueOf

public static BitSet valueOf(byte[] bytes)

Constructs and returns a new BitSet using the bits from the provided byte array.

Parameters:

bytes - The byte array to be used for constructing the BitSet.

Returns:

A new BitSet containing all bits from the given byte array.

getWord

public long getWord(int wordIndex)

Return the value of the word at wordIndex or zero if beyond getWordsInUse().

Specified by:

getWord in interface ChronicleBitSet

Parameters:

wordIndex - zero-based index of the word

Returns:

the word value or 0 if out of range

setWord

public void setWord(int wordIndex,
                    long bits)

Store bits at the given wordIndex. The backing LongArrayValues is expanded to the index if needed.

Specified by:

setWord in interface ChronicleBitSet

Parameters:

wordIndex - zero-based index of the word to modify

bits - the 64 bits to store

performClose

protected void performClose()

Specified by:

performClose in class net.openhft.chronicle.core.io.AbstractCloseable

getWordsInUse

public int getWordsInUse()

Retrieves the number of words that are currently in use by this bit set. This indicates the number of long values that are currently utilized to represent bits in the bit set.

Specified by:

getWordsInUse in interface ChronicleBitSet

Returns:

The number of words in use, converted to an integer.

set

public void set(int wordIndex,
                long param,
                net.openhft.chronicle.wire.LongArrayValueBitSet.LongFunction function)

Sets a specific word in this bit set using a provided function and parameter. This method is lock-free and uses CAS operations to safely update the word value.

Parameters:

wordIndex - The index of the word to set.

param - The parameter to pass to the function.

function - The function to compute the new word value based on the old value and the provided parameter.

set

public void set(net.openhft.chronicle.core.values.LongValue word,
                long newValue)

Sets a new value for a given word in this bit set. This method is lock-free and uses CAS operations to safely set the new word value.

Parameters:

word - The LongValue instance representing the word to set.

newValue - The new value to set for the word.

toByteArray

public byte[] toByteArray()

Converts the bits in this bit set to a byte array. This allows the bit set to be easily serialized or transferred.

Returns:

A byte array containing all the bits in this bit set.

flip

public void flip(int bitIndex)

Flips the bit at the specified index, turning it to its opposite value (0 to 1, or 1 to 0).

Specified by:

flip in interface ChronicleBitSet

Parameters:

bitIndex - The index of the bit to flip.

flip

public void flip(int fromIndex,
                 int toIndex)

Flips the bits from a starting index to an ending index. Each bit in the specified range will be turned to its opposite value.

Specified by:

flip in interface ChronicleBitSet

Parameters:

fromIndex - The starting index of the range, inclusive.

toIndex - The ending index of the range, exclusive.

set

public void set(int bitIndex)

Sets the bit at the specified index to true.

Specified by:

set in interface ChronicleBitSet

Parameters:

bitIndex - The index of the bit to be set.

set

public void set(int bitIndex,
                boolean value)

Sets or clears the bit at the specified index based on the provided boolean value.

Specified by:

set in interface ChronicleBitSet

Parameters:

bitIndex - The index of the bit to be modified.

value - If true, the bit will be set; if false, the bit will be cleared.

set

public void set(int fromIndex,
                int toIndex)

Sets all bits in the specified range to true.

Specified by:

set in interface ChronicleBitSet

Parameters:

fromIndex - The starting index of the range, inclusive.

toIndex - The ending index of the range, exclusive.

clear

public void clear(int bitIndex)

Clears (sets to false) the bit specified by the index. If the bit index is beyond the current words in use, the operation is ignored.

Specified by:

clear in interface ChronicleBitSet

Parameters:

bitIndex - The index of the bit to be cleared.

clear

public void clear(int fromIndex,
                  int toIndex)

Clears (sets to false) the range of bits from the specified starting index (inclusive) to the ending index (exclusive). The method adjusts ranges if necessary and ensures efficient clearing even for larger ranges.

Specified by:

clear in interface ChronicleBitSet

Parameters:

fromIndex - Starting index of the range (inclusive).

toIndex - Ending index of the range (exclusive).

clear

public void clear()

Sets all bits in this ChronicleBitSet to false. Post invocation, the ChronicleBitSet is effectively empty with no bits set to true.

Specified by:

clear in interface ChronicleBitSet

get

public 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.

Specified by:

get in interface ChronicleBitSet

Parameters:

bitIndex - the bit index

Returns:

the value of the bit with the specified index

Throws:

IndexOutOfBoundsException - if the specified index is negative

nextSetBit

public int nextSetBit(int fromIndex)

Finds and returns the index of the first bit that is set to true after the specified starting index. If no such bit exists then it returns -1.

Specified by:

nextSetBit in interface ChronicleBitSet

Parameters:

fromIndex - The index to start checking from (inclusive).

Returns:

Index of the next set bit, or -1 if there's no set bit found.

nextSetBit

public int nextSetBit(int fromIndex,
                      int toIndex)

Retrieves the index of the first bit set to true that occurs on or after the specified starting index and before the specified ending index. If no such bit exists within the specified range, it returns -1.

Specified by:

nextSetBit in interface ChronicleBitSet

Parameters:

fromIndex - The index to start checking from (inclusive).

toIndex - The index to stop checking at (exclusive).

Returns:

Index of the next set bit in the specified range, or -1 if there's no set bit found.

nextClearBit

public int nextClearBit(int fromIndex)

Retrieves the index of the first bit set to false that occurs on or after the specified starting index. If all bits are set to true after the specified index, it returns the length of this ChronicleBitSet.

Specified by:

nextClearBit in interface ChronicleBitSet

Parameters:

fromIndex - The index to start checking from (inclusive).

Returns:

Index of the next clear bit or the length of this ChronicleBitSet if no clear bit is found.

previousSetBit

public int previousSetBit(int fromIndex)

Identifies the closest bit set to true that occurs on or before the given starting index. If no such bit exists or if -1 is the starting index, the method returns -1.

Parameters:

fromIndex - The index to start the reverse search from (inclusive).

Returns:

Index of the previous set bit or -1 if no set bit is found.

previousClearBit

public int previousClearBit(int fromIndex)

Identifies the closest bit set to false that occurs on or before the given starting index. If no such bit exists or if -1 is the starting index, the method returns -1.

Parameters:

fromIndex - The index to start the reverse search from (inclusive).

Returns:

Index of the previous clear bit or -1 if no clear bit is found.

intersects

public boolean intersects(ChronicleBitSet set)

Determines if there's any overlapping bit set to true between this ChronicleBitSet and the given ChronicleBitSet.

Specified by:

intersects in interface ChronicleBitSet

Parameters:

set - The ChronicleBitSet to compare against.

Returns:

true if there's an intersecting bit set to true between the two sets, false otherwise.

cardinality

public int cardinality()

Computes the number of bits that are currently set to true in this ChronicleBitSet.

Specified by:

cardinality in interface ChronicleBitSet

Returns:

The count of bits set to true.

and

public void and(ChronicleBitSet set)

Performs a bitwise AND operation between this ChronicleBitSet and the provided set. After this operation, a bit will be set to true in this set only if it was already set to true and the corresponding bit in the provided set is true.

Specified by:

and in interface ChronicleBitSet

Parameters:

set - The ChronicleBitSet to perform the AND operation with.

or

public void or(ChronicleBitSet set)

Performs a logical OR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if it either already had the value true or the corresponding bit in the bit set argument has the value true.

Specified by:

or in interface ChronicleBitSet

Parameters:

set - other bit set

xor

public void xor(ChronicleBitSet set)

Performs a logical XOR of this bit set with the bit set argument. This bit set is modified so that a bit in it has the value true if and only if one of the following statements holds:

• The bit initially has the value true, and the corresponding bit in the argument has the value false.
• The bit initially has the value false, and the corresponding bit in the argument has the value true.

Specified by:

xor in interface ChronicleBitSet

Parameters:

set - other bit set

andNot

public void andNot(ChronicleBitSet set)

Clears all the bits in this ChronicleBitSet that are set in the specified ChronicleBitSet. In other words, for each bit set in the provided set, the corresponding bit in this set is cleared.

Specified by:

andNot in interface ChronicleBitSet

Parameters:

set - The ChronicleBitSet whose set bits will be used to clear the corresponding bits in this set.

hashCode

public int hashCode()

Returns the hash code for this ChronicleBitSet. The hash code is calculated based on the set bits in this bit set.

Overrides:

hashCode in class Object

Returns:

The hash code for this bit set.

size

public int size()

Returns the total number of bits that this ChronicleBitSet can represent. This includes both set and unset bits.

Specified by:

size in interface ChronicleBitSet

Returns:

The number of bits this bit set can represent.

equals

public boolean equals(Object obj)

Compares this ChronicleBitSet against the specified object. The result is true if the object is a ChronicleBitSet and has the exact same set of bits set to true as this bit set.

Overrides:

equals in class Object

Parameters:

obj - The object to compare with.

Returns:

true if the specified object is equivalent to this bit set, false otherwise.

toString

public String toString()

Returns a string representation of this bit set. For every index for which this ChronicleBitSet contains a bit in the set state, the decimal representation of that index is included in the result. Such indices are listed in order from lowest to highest, separated by ", " (a comma and a space) and surrounded by braces, resulting in the usual mathematical notation for a set of integers.

Overrides:

toString in class net.openhft.chronicle.core.io.AbstractCloseable

stream

public IntStream stream()

Returns an ordered stream of indices for which this ChronicleBitSet contains a bit set to true. The indices are returned in ascending order. The size of the stream corresponds to the number of bits set to true, which matches the value returned by the cardinality() method.

Returns:

An ordered IntStream of indices of bits set to true.

writeMarshallable

public void writeMarshallable(@NotNull
                              @NotNull WireOut wire)

Description copied from interface: Marshallable

Writes the state of the Marshallable object to the given wire output. The method obtains a WireMarshaller specific to the class of the current object and delegates the writing process to that marshaller.

The default implementation will write all values even if they are a default value. c.f. readMarshallable

Specified by:

writeMarshallable in interface Marshallable

Specified by:

writeMarshallable in interface WriteMarshallable

Parameters:

wire - The wire output destination.

readMarshallable

public void readMarshallable(@NotNull
                             @NotNull WireIn wire)
                      throws net.openhft.chronicle.core.io.IORuntimeException

Description copied from interface: Marshallable

Reads the state of the Marshallable object from the given wire input. The method obtains a WireMarshaller specific to the class of the current object and delegates the reading process to that marshaller.

The default implementation will use a default value for each field not present

Specified by:

readMarshallable in interface Marshallable

Specified by:

readMarshallable in interface ReadMarshallable

Parameters:

wire - The wire input source.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an IO error occurs during the read operation.

copyFrom

public void copyFrom(ChronicleBitSet bitSet)

Description copied from interface: ChronicleBitSet

Copies all bits from bitSet into this set.

Specified by:

copyFrom in interface ChronicleBitSet

Parameters:

bitSet - source bit set