net.openhft.chronicle.wire

Class LongValueBitSet

java.lang.Object

net.openhft.chronicle.core.io.AbstractCloseable

net.openhft.chronicle.wire.LongValueBitSet

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 LongValueBitSet
extends net.openhft.chronicle.core.io.AbstractCloseable
implements Marshallable, ChronicleBitSet

A ChronicleBitSet implementation backed by an array of LongValues. The backing words may reside in off-heap memory so the bit set can be shared between processes. Operations are performed using compare-and-swap loops rather than explicit locks. Note: the capacity is fixed on construction and cannot be expanded later.

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
LongValueBitSet(int maxNumberOfBits) Creates a bit set sized for maxNumberOfBits bits.
LongValueBitSet(int maxNumberOfBits, Wire w) Creates a bit set sized for maxNumberOfBits bits and immediately binds the backing array to the supplied Wire for serialisation.
LongValueBitSet(long maxNumberOfBits) Creates a bit set sized for maxNumberOfBits bits.
LongValueBitSet(long maxNumberOfBits, Wire w) Creates a bit set sized for maxNumberOfBits bits and binds its storage to a Wire for marshalling.

Method Summary

Modifier and Type	Method and Description
void	and(ChronicleBitSet set) Performs a logical AND operation between this ChronicleBitSet and the specified ChronicleBitSet.
void	and(LongValueBitSet set) Performs a logical AND operation between this ChronicleBitSet and the specified LongValueBitSet.
void	andNot(ChronicleBitSet set) Clears all the bits in this ChronicleBitSet where the corresponding bit is set in the specified ChronicleBitSet.
void	andNot(LongValueBitSet set) Clears all the bits in this ChronicleBitSet where the corresponding bit is set in the specified LongValueBitSet.
int	cardinality() Counts the bits set to true.
void	clear() Sets all of 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) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to false.
void	copyFrom(ChronicleBitSet bitSet) Copies the contents of bitSet into this instance.
boolean	equals(Object obj) Compares this ChronicleBitSet object against the specified object.
void	flip(int bitIndex) Atomically toggles the bit at bitIndex.
void	flip(int fromIndex, int toIndex) Atomically flips bits in the range [fromIndex, toIndex).
boolean	get(int bitIndex) Returns the value of the bit with the specified index.
long	getWord(int wordIndex) Returns the raw word at wordIndex.
int	getWordsInUse() Returns the number of LongValue words available in the backing array.
int	hashCode() Computes the hash code for this ChronicleBitSet.
boolean	intersects(ChronicleBitSet set) Checks if the current ChronicleBitSet has any common set bits with the specified ChronicleBitSet.
boolean	intersects(LongValueBitSet set) Checks if the current ChronicleBitSet intersects with the provided LongValueBitSet.
int	nextClearBit(int fromIndex) Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
int	nextSetBit(int fromIndex) Returns the index of the first bit that is set to true that occurs on or after the specified starting index.
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 but before the toIndex.
void	or(ChronicleBitSet set) Executes a logical OR operation between this ChronicleBitSet and the provided ChronicleBitSet.
void	or(LongValueBitSet set) Performs a logical OR operation between this ChronicleBitSet and the provided LongValueBitSet.
protected void	performClose()
int	previousClearBit(int fromIndex) This method searches for the closest bit set to false from the specified starting index moving backwards.
int	previousSetBit(int fromIndex) This method searches for the closest bit set to true from the specified starting index moving backwards.
void	readMarshallable(@NotNull WireIn wire) Deserialises the backing words from wire.
void	set(int bitIndex) Atomically sets the bit at bitIndex.
void	set(int bitIndex, boolean value) Sets the bit at bitIndex to value.
void	set(int fromIndex, int toIndex) Atomically sets all bits in the range [fromIndex, toIndex) to true.
void	set(int fromIndex, int toIndex, boolean value) Atomically sets all bits in the range to value.
void	set(net.openhft.chronicle.core.values.LongValue word, long newValue) Atomically sets word to newValue.
void	set(net.openhft.chronicle.core.values.LongValue word, long param, net.openhft.chronicle.wire.LongValueBitSet.LongFunction function) Atomically updates word using a compare‑and‑swap loop.
void	setWord(int wordIndex, long bits) Sets the raw word at wordIndex to bits.
int	size() Retrieves the number of bits that are actually being used by this ChronicleBitSet to represent bit values.
IntStream	stream() Returns a stream of indices for which this ChronicleBitSet contains a bit in the set state.
byte[]	toByteArray() Returns a little‑endian byte array representing this set.
String	toString() Returns a string representation of this bit set.
static BitSet	valueOf(byte[] bytes) Creates a new BitSet from a given byte array.
void	writeMarshallable(@NotNull WireOut wire) Serialises the backing words to wire.
void	xor(ChronicleBitSet set) Performs a logical XOR of this bit set with the bit set argument.
void	xor(LongValueBitSet set) Performs a logical XOR operation between this ChronicleBitSet and the specified LongValueBitSet.

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

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

LongValueBitSet

public LongValueBitSet(int maxNumberOfBits)

Creates a bit set sized for maxNumberOfBits bits. The backing array is allocated but not bound to any Wire.

Parameters:

maxNumberOfBits - maximum number of bits this set can hold

LongValueBitSet

public LongValueBitSet(int maxNumberOfBits,
                       Wire w)

Creates a bit set sized for maxNumberOfBits bits and immediately binds the backing array to the supplied Wire for serialisation.

Parameters:

maxNumberOfBits - maximum number of bits this set can hold

w - wire used to marshal the initial state

LongValueBitSet

public LongValueBitSet(long maxNumberOfBits)

Creates a bit set sized for maxNumberOfBits bits.

Parameters:

maxNumberOfBits - maximum number of bits this set can hold

LongValueBitSet

public LongValueBitSet(long maxNumberOfBits,
                       Wire w)

Creates a bit set sized for maxNumberOfBits bits and binds its storage to a Wire for marshalling.

Parameters:

maxNumberOfBits - maximum number of bits this set can hold

w - wire used to marshal the initial state

Method Detail

valueOf

public static BitSet valueOf(byte[] bytes)

Creates a new BitSet from a given byte array.

Parameters:

bytes - The byte array containing the bits.

Returns:

A BitSet containing the bits from the byte array.

getWord

public long getWord(int wordIndex)

Returns the raw word at wordIndex. If the index is beyond the backing array the value 0 is returned.

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)

Sets the raw word at wordIndex to bits. The array is not expanded; expandTo(int) will throw if the index is beyond the configured capacity.

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

Returns the number of LongValue words available in the backing array. This is the fixed capacity rather than a logical size.

Specified by:

getWordsInUse in interface ChronicleBitSet

Returns:

number of words in use

set

public void set(net.openhft.chronicle.core.values.LongValue word,
                long param,
                net.openhft.chronicle.wire.LongValueBitSet.LongFunction function)

Atomically updates word using a compare‑and‑swap loop. The function computes a new value from the current one and param. The pauser() is used between failed CAS attempts to reduce contention.

set

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

Atomically sets word to newValue. A CAS loop is used with pauser() invoked between attempts when contention occurs.

toByteArray

public byte[] toByteArray()

Returns a little‑endian byte array representing this set. Each word is written in sequence.

flip

public void flip(int bitIndex)

Atomically toggles the bit at bitIndex.

Specified by:

flip in interface ChronicleBitSet

Parameters:

bitIndex - zero-based index of the bit to flip

flip

public void flip(int fromIndex,
                 int toIndex)

Atomically flips bits in the range [fromIndex, toIndex).

Specified by:

flip in interface ChronicleBitSet

Parameters:

fromIndex - zero-based start of the range

toIndex - end of the range (exclusive)

set

public void set(int bitIndex)

Atomically sets the bit at bitIndex.

Specified by:

set in interface ChronicleBitSet

Parameters:

bitIndex - index of the bit to set

set

public void set(int bitIndex,
                boolean value)

Sets the bit at bitIndex to value.

Specified by:

set in interface ChronicleBitSet

Parameters:

bitIndex - zero-based index of the bit to modify

value - the value to store at that index

set

public void set(int fromIndex,
                int toIndex)

Atomically sets all bits in the range [fromIndex, toIndex) to true.

Specified by:

set in interface ChronicleBitSet

Parameters:

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

toIndex - index after the last bit to set

set

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

Atomically sets all bits in the range to value.

Specified by:

set in interface ChronicleBitSet

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

clear

public void clear(int bitIndex)

Sets the bit specified by the index to false.

Specified by:

clear in interface ChronicleBitSet

Parameters:

bitIndex - index of the bit to clear

clear

public void clear(int fromIndex,
                  int toIndex)

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

Specified by:

clear in interface ChronicleBitSet

Parameters:

fromIndex - zero-based start of the range

toIndex - end of the range (exclusive)

clear

public void clear()

Sets all of the bits in this ChronicleBitSet to false.

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 index of the bit to check

Returns:

true if the bit at the specified index is set, false otherwise

nextSetBit

public int nextSetBit(int fromIndex)

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.

Specified by:

nextSetBit in interface ChronicleBitSet

Parameters:

fromIndex - the index to start checking from

Returns:

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

nextSetBit

public 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 but before the toIndex. If no such bit exists then -1 is returned.

Specified by:

nextSetBit in interface ChronicleBitSet

Parameters:

fromIndex - the index to start checking from

toIndex - the index to stop checking (exclusive)

Returns:

the index of the next set bit within the specified range, or -1 if no such bit is found

nextClearBit

public int nextClearBit(int fromIndex)

Returns the index of the first bit that is set to false that occurs on or after the specified starting index.

Specified by:

nextClearBit in interface ChronicleBitSet

Parameters:

fromIndex - the index to start checking from

Returns:

the index of the next unset bit, or the total length if all bits are set

previousSetBit

public int previousSetBit(int fromIndex)

This method searches for the closest bit set to true from the specified starting index moving backwards. If the bit at the specified starting index is set to true, it will return the index itself. If no such bit exists before the given index, or if -1 is the specified index, then -1 is returned.

Parameters:

fromIndex - The starting index to begin the search. The search moves towards the index 0 from this point.

Returns:

The index of the nearest set bit (with value true) before the specified starting index, or -1 if none exists.

Throws:

IndexOutOfBoundsException - if fromIndex is less than -1

previousClearBit

public int previousClearBit(int fromIndex)

This method searches for the closest bit set to false from the specified starting index moving backwards. If the bit at the specified starting index is set to false, it will return the index itself. If no such unset bit exists before the given index, or if -1 is the specified index, then -1 is returned.

Parameters:

fromIndex - The starting index to begin the search. The search moves towards the index 0 from this point.

Returns:

The index of the nearest unset bit (with value false) before the specified starting index, or -1 if none exists.

Throws:

IndexOutOfBoundsException - if fromIndex is less than -1

intersects

public boolean intersects(ChronicleBitSet set)

Checks if the current ChronicleBitSet has any common set bits with the specified ChronicleBitSet. If any bits set to true in the provided set are also set to true in this set, then the method returns true.

Specified by:

intersects in interface ChronicleBitSet

Parameters:

set - The ChronicleBitSet to compare with the current instance.

Returns:

true if there's an intersection, otherwise false.

intersects

public boolean intersects(LongValueBitSet set)

Checks if the current ChronicleBitSet intersects with the provided LongValueBitSet. This method is an overloaded version of the intersects method, designed to work specifically with LongValueBitSet.

Parameters:

set - The LongValueBitSet to compare with the current instance.

Returns:

true if there's an intersection, otherwise false.

cardinality

public int cardinality()

Counts the bits set to true. Each word is read with LongValue.getVolatileValue() for visibility.

Specified by:

cardinality in interface ChronicleBitSet

Returns:

number of set bits

and

public void and(ChronicleBitSet set)

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

Specified by:

and in interface ChronicleBitSet

Parameters:

set - The ChronicleBitSet to perform the logical AND operation with.

and

public void and(LongValueBitSet set)

Performs a logical AND operation between this ChronicleBitSet and the specified LongValueBitSet. This is an overloaded version of the method that accepts ChronicleBitSet, designed to work with LongValueBitSet. The logic of the operation is handled by the base method.

Parameters:

set - The LongValueBitSet to perform the logical AND operation with.

or

public void or(LongValueBitSet set)

Performs a logical OR operation between this ChronicleBitSet and the provided LongValueBitSet. This overloaded version casts the provided set to its base type ChronicleBitSet before performing the operation.

Parameters:

set - The LongValueBitSet to perform the logical OR operation with.

or

public void or(ChronicleBitSet set)

Executes a logical OR operation between this ChronicleBitSet and the provided ChronicleBitSet. Each bit in this set will be set to true if it was originally true or the corresponding bit in the provided set is true.

Specified by:

or in interface ChronicleBitSet

Parameters:

set - The ChronicleBitSet to perform the logical OR operation with.

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 - The ChronicleBitSet to perform the logical XOR operation with.

xor

public void xor(LongValueBitSet set)

Performs a logical XOR operation between this ChronicleBitSet and the specified LongValueBitSet. This is an overloaded version of the method that accepts ChronicleBitSet, designed to work with LongValueBitSet. The logic of the operation is handled by the base method.

Parameters:

set - The LongValueBitSet to perform the logical XOR operation with.

andNot

public void andNot(ChronicleBitSet set)

Clears all the bits in this ChronicleBitSet where the corresponding bit is set in the specified ChronicleBitSet. Effectively performs a logical AND NOT operation on this bit set with the given set.

Specified by:

andNot in interface ChronicleBitSet

Parameters:

set - The ChronicleBitSet to use for clearing matching bits.

andNot

public void andNot(LongValueBitSet set)

Clears all the bits in this ChronicleBitSet where the corresponding bit is set in the specified LongValueBitSet. This is an overloaded version designed to work with LongValueBitSet.

Parameters:

set - The LongValueBitSet to use for clearing matching bits.

hashCode

public int hashCode()

Computes the hash code for this ChronicleBitSet. The hash code is calculated based on the bit values that are set.

Overrides:

hashCode in class Object

Returns:

The computed hash code.

size

public int size()

Retrieves the number of bits that are actually being used by this ChronicleBitSet to represent bit values. Essentially, this is the highest set bit plus one.

Specified by:

size in interface ChronicleBitSet

Returns:

The number of bits of space in use.

equals

public boolean equals(Object obj)

Compares this ChronicleBitSet object against the specified object. The result is true if and only if:

• The provided object is not null.
• The provided object is an instance of ChronicleBitSet.
• Both ChronicleBitSet objects have the exact same set of bits set to true.

In essence, for every non-negative int index k, the bits of both ChronicleBitSet objects at index k should be identical.

Overrides:

equals in class Object

Parameters:

obj - The object to compare with.

Returns:

true if the objects are the same; 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 a stream of indices for which this ChronicleBitSet contains a bit in the set state. The indices are returned in order, from lowest to highest. The size of the stream is the number of bits in the set state, equal to the value returned by the cardinality() method.

writeMarshallable

public void writeMarshallable(@NotNull
                              @NotNull WireOut wire)

Serialises the backing words to wire.

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

Deserialises the backing words from wire.

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)

Copies the contents of bitSet into this instance.

Specified by:

copyFrom in interface ChronicleBitSet

Parameters:

bitSet - source bit set