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

This is the LongValueBitSet class extending AbstractCloseable. This class represents a BitSet designed to be shared across processes without requiring locks. It has been implemented as a lock-free solution and does not support resizing.

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) Constructor that initializes a LongValueBitSet with a maximum number of bits provided as an integer.
LongValueBitSet(int maxNumberOfBits, Wire w) Constructor that initializes a LongValueBitSet with a maximum number of bits provided as an integer and associates it with a Wire.
LongValueBitSet(long maxNumberOfBits) Constructor that initializes a LongValueBitSet with a maximum number of bits provided as a long.
LongValueBitSet(long maxNumberOfBits, Wire w) Constructor that initializes a LongValueBitSet with a maximum number of bits provided as a long and associates it with a Wire.

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() Calculates and returns the number of bits set to true in this ChronicleBitSet.
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)
boolean	equals(Object obj) Compares this ChronicleBitSet object against the specified object.
void	flip(int bitIndex) Flips the bit at the specified index, toggling it from its current value.
void	flip(int fromIndex, int toIndex) Flips a range of bits, toggling them from their current value.
boolean	get(int bitIndex) Returns the value of the bit with the specified index.
long	getWord(int wordIndex)
int	getWordsInUse() Fetches the number of words currently in use in this BitSet.
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) 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 the bit at the specified index to the specified value.
void	set(int fromIndex, int toIndex) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to true.
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	set(net.openhft.chronicle.core.values.LongValue word, long newValue) Atomically sets the value of a LongValue object to a new value.
void	set(net.openhft.chronicle.core.values.LongValue word, long param, net.openhft.chronicle.wire.LongValueBitSet.LongFunction function) Atomically sets the value of a LongValue object based on a provided function and parameter.
void	setWord(int wordIndex, long 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() Converts the bit set to a byte array representation.
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) 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.
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, 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)

Constructor that initializes a LongValueBitSet with a maximum number of bits provided as an integer.

Parameters:

maxNumberOfBits - The maximum number of bits this BitSet can accommodate.

LongValueBitSet

public LongValueBitSet(int maxNumberOfBits,
                       Wire w)

Constructor that initializes a LongValueBitSet with a maximum number of bits provided as an integer and associates it with a Wire.

Parameters:

maxNumberOfBits - The maximum number of bits this BitSet can accommodate.

w - The Wire associated with this BitSet.

LongValueBitSet

public LongValueBitSet(long maxNumberOfBits)

Constructor that initializes a LongValueBitSet with a maximum number of bits provided as a long.

Parameters:

maxNumberOfBits - The maximum number of bits this BitSet can accommodate.

LongValueBitSet

public LongValueBitSet(long maxNumberOfBits,
                       Wire w)

Constructor that initializes a LongValueBitSet with a maximum number of bits provided as a long and associates it with a Wire.

Parameters:

maxNumberOfBits - The maximum number of bits this BitSet can accommodate.

w - The Wire associated with this BitSet.

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)

Specified by:

getWord in interface ChronicleBitSet

setWord

public void setWord(int wordIndex,
                    long bits)

Specified by:

setWord in interface ChronicleBitSet

performClose

protected void performClose()

Specified by:

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

getWordsInUse

public int getWordsInUse()

Fetches the number of words currently in use in this BitSet.

Specified by:

getWordsInUse in interface ChronicleBitSet

Returns:

The 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 sets the value of a LongValue object based on a provided function and parameter. It uses a pausing strategy to deal with contention.

Parameters:

word - The LongValue object whose value needs to be set.

param - The parameter to pass to the function.

function - A function that takes the old value of the word and the provided parameter to produce a new value.

set

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

Atomically sets the value of a LongValue object to a new value. It uses a pausing strategy to handle contention during the set operation.

Parameters:

word - The LongValue object whose value needs to be set.

newValue - The new value to be set.

toByteArray

public byte[] toByteArray()

Converts the bit set to a byte array representation. It serializes the bits into bytes in little-endian order.

Returns:

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

flip

public void flip(int bitIndex)

Flips the bit at the specified index, toggling it from its current value. If the bit is currently set to 0, it will become 1, and vice versa.

Specified by:

flip in interface ChronicleBitSet

Parameters:

bitIndex - The index of the bit to flip.

flip

public void flip(int fromIndex,
                 int toIndex)

Flips a range of bits, toggling them from their current value. If a bit within the range is currently set to 0, it will become 1, and vice versa.

Specified by:

flip in interface ChronicleBitSet

Parameters:

fromIndex - Index of the first bit to flip (inclusive).

toIndex - Index of the last bit to flip (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 to true.

set

public void set(int bitIndex,
                boolean value)

Sets the bit at the specified index to the specified value. If the value is true, the bit is set to 1, otherwise it is set to 0.

Specified by:

set in interface ChronicleBitSet

Parameters:

bitIndex - The index of the bit to be modified.

value - The new value for the specified bit.

set

public void set(int fromIndex,
                int toIndex)

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

Specified by:

set in interface ChronicleBitSet

set

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

Specified by:

set in interface ChronicleBitSet

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

clear

public void clear(int bitIndex)

Sets the bit specified by the index to false.

Specified by:

clear in interface ChronicleBitSet

Parameters:

bitIndex - the index of the bit to be cleared

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

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

Calculates and returns the number of bits set to true in this ChronicleBitSet.

Specified by:

cardinality in interface ChronicleBitSet

Returns:

The number of bits currently set to true.

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)

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)

Specified by:

copyFrom in interface ChronicleBitSet