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.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 BitSet is intended to be shared between processes. To minimize locking constraints, it is implemented as a lock-free solution without support for resizing.

Field Summary

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

closedHere, DISABLE_DISCARD_WARNING, DISABLE_THREAD_SAFETY, STRICT_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)
LongValueBitSet(int maxNumberOfBits, Wire w)
LongValueBitSet(long maxNumberOfBits)
LongValueBitSet(long maxNumberOfBits, Wire w)

Method Summary

Modifier and Type	Method and Description
void	and(ChronicleBitSet set) Performs a logical AND of this target bit set with the argument bit set.
void	and(LongValueBitSet set)
void	andNot(ChronicleBitSet set) Clears all of the bits in this ChronicleBitSet whose corresponding bit is set in the specified ChronicleBitSet.
void	andNot(LongValueBitSet set)
int	cardinality() 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 object against the specified object.
void	flip(int bitIndex) Sets the bit at the specified index to the complement of its current value.
void	flip(int fromIndex, int toIndex) Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.
boolean	get(int bitIndex) Returns the value of the bit with the specified index.
long	getWord(int wordIndex)
int	getWordsInUse()
int	hashCode() Returns the hash code value for this bit set.
boolean	intersects(ChronicleBitSet set) Returns true if the specified ChronicleBitSet has any bits set to true that are also set to true in this ChronicleBitSet.
boolean	intersects(LongValueBitSet set)
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.
void	or(ChronicleBitSet set)
void	or(LongValueBitSet set) Performs a logical OR of this bit set with the bit set argument.
protected void	performClose()
int	previousClearBit(int fromIndex) Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index.
int	previousSetBit(int fromIndex) Returns the index of the nearest bit that is set to true that occurs on or before the specified 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 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)
void	set(net.openhft.chronicle.core.values.LongValue word, long param, net.openhft.chronicle.wire.LongValueBitSet.LongFunction function)
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.
IntStream	stream() Returns a stream of indices for which this ChronicleBitSet contains a bit in the set state.
byte[]	toByteArray() Returns a new byte array containing all the bits in this bit set.
String	toString() Returns a string representation of this bit set.
static BitSet	valueOf(byte[] bytes) Returns a new bit set containing all the bits in the 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)

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

assertCloseable, assertCloseablesClosed, clearUsedByThread, close, createdHere, disableCloseableTracing, disableThreadSafetyCheck, disableThreadSafetyCheck, enableCloseableTracing, gcAndWaitForCloseablesToClose, isClosed, isClosing, isInUserThread, referenceId, resetUsedByThread, 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

Constructor Detail

LongValueBitSet

public LongValueBitSet(int maxNumberOfBits)

LongValueBitSet

public LongValueBitSet(int maxNumberOfBits,
                       Wire w)

LongValueBitSet

public LongValueBitSet(long maxNumberOfBits)

LongValueBitSet

public LongValueBitSet(long maxNumberOfBits,
                       Wire w)

Method Detail

valueOf

public static BitSet valueOf(byte[] bytes)

Returns a new bit set containing all the bits in the given 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()

Specified by:

getWordsInUse in interface ChronicleBitSet

set

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

set

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

toByteArray

public byte[] toByteArray()

Returns a new byte array containing all the bits in this bit set.

flip

public void flip(int bitIndex)

Sets the bit at the specified index to the complement of its current value.

Specified by:

flip in interface ChronicleBitSet

flip

public void flip(int fromIndex,
                 int toIndex)

Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.

Specified by:

flip in interface ChronicleBitSet

set

public void set(int bitIndex)

Sets the bit at the specified index to true.

Specified by:

set in interface ChronicleBitSet

Parameters:

bitIndex - a bit index

set

public void set(int bitIndex,
                boolean value)

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

Specified by:

set in interface ChronicleBitSet

Parameters:

bitIndex - a bit index

value - a boolean value to set

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 bit index

Returns:

the value of the bit with the specified index

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

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. If no such bit exists then -1 is returned.

Specified by:

nextSetBit in interface ChronicleBitSet

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

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

previousSetBit

public int previousSetBit(int fromIndex)

Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index. If no such bit exists, or if -1 is given as the starting index, then -1 is returned.

previousClearBit

public int previousClearBit(int fromIndex)

Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index. If no such bit exists, or if -1 is given as the starting index, then -1 is returned.

intersects

public boolean intersects(ChronicleBitSet set)

Returns true if the specified ChronicleBitSet has any bits set to true that are also set to true in this ChronicleBitSet.

Specified by:

intersects in interface ChronicleBitSet

intersects

public boolean intersects(LongValueBitSet set)

cardinality

public int cardinality()

Returns the number of bits set to true in this ChronicleBitSet.

Specified by:

cardinality in interface ChronicleBitSet

and

public void and(ChronicleBitSet set)

Performs a logical AND of this target bit set with the argument bit set. This bit set is modified so that each bit in it has the value true if and only if it both initially had the value true and the corresponding bit in the bit set argument also had the value true.

Specified by:

and in interface ChronicleBitSet

and

public void and(LongValueBitSet set)

or

public void or(LongValueBitSet 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.

or

public void or(ChronicleBitSet set)

Specified by:

or in interface ChronicleBitSet

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

xor

public void xor(LongValueBitSet set)

andNot

public void andNot(ChronicleBitSet set)

Clears all of the bits in this ChronicleBitSet whose corresponding bit is set in the specified ChronicleBitSet.

Specified by:

andNot in interface ChronicleBitSet

andNot

public void andNot(LongValueBitSet set)

hashCode

public int hashCode()

Returns the hash code value for this bit set. The hash code depends only on which bits are set within this ChronicleBitSet.

Overrides:

hashCode in class Object

size

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

Specified by:

size in interface ChronicleBitSet

Returns:

the number of bits currently in this bit set

equals

public boolean equals(Object obj)

Compares this object against the specified object. The result is true if and only if the argument is not null and is a ChronicleBitSet object that has exactly the same set of bits set to true as this bit set. That is, for every nonnegative int index k,

Overrides:

equals in class Object

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