net.openhft.chronicle.algo.bitset

Interface BitSetFrame

All Known Implementing Classes:

ConcurrentFlatBitSetFrame, SingleThreadedFlatBitSetFrame

public interface BitSetFrame

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BitSetFrame.Bits An iteration of bits in a bit set.

Field Summary

Fields

Modifier and Type	Field and Description
static long	NOT_FOUND Returned if no entry is found

Method Summary

Modifier and Type	Method and Description
BitSetAlgorithm	algorithm()
<T> long	cardinality(Access<T> access, T handle, long offset) Returns the number of bits set to true in the bit set.
<T> void	clear(Access<T> access, T handle, long offset, long bitIndex) Sets the bit specified by the index to false.
<T> void	clearAll(Access<T> access, T handle, long offset) Equivalent to clearRange(0, logicalSize()).
<T> boolean	clearIfSet(Access<T> access, T handle, long offset, long bitIndex) Clears the bit at the specified index (sets it to false).
<T> long	clearNextNContinuousSetBits(Access<T> access, T handle, long offset, long fromIndex, int numberOfBits) Finds the next numberOfBits consecutive bits set to true, starting from the specified fromIndex.
<T> long	clearNextSetBit(Access<T> access, T handle, long offset, long fromIndex) Finds and clears the first bit that is set to true that occurs on or after the specified starting index.
<T> long	clearPreviousNContinuousSetBits(Access<T> access, T handle, long offset, long fromIndex, int numberOfBits) Finds the previous numberOfBits consecutive bits set to true, starting from the specified fromIndex.
<T> long	clearPreviousSetBit(Access<T> access, T handle, long offset, long fromIndex) Finds and clears the nearest bit that is set to true that occurs on or before the specified starting index.
<T> void	clearRange(Access<T> access, T handle, long offset, long fromIndex, long toIndex) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to false.
<T> void	flip(Access<T> access, T handle, long offset, long bitIndex) Sets the bit at the specified index to the complement of its current value.
<T> void	flipRange(Access<T> access, T handle, long offset, long fromIndex, long toIndex) Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.
<T> boolean	get(Access<T> access, T handle, long offset, long bitIndex) Returns the value of the bit with the specified index.
default <T> boolean	isClear(Access<T> access, T handle, long offset, long bitIndex) Synonym of !get(long).
<T> boolean	isRangeClear(Access<T> access, T handle, long offset, long fromIndex, long toIndex) Checks if each bit from the specified fromIndex (inclusive) to the specified exclusiveToIndex is set to false.
<T> boolean	isRangeSet(Access<T> access, T handle, long offset, long fromIndex, long toIndex) Checks if each bit from the specified fromIndex (inclusive) to the specified exclusiveToIndex is set to true.
default <T> boolean	isSet(Access<T> access, T handle, long offset, long bitIndex) Synonym of #get).
long	logicalSize() Number of bits in this frame.
<T> long	nextClearBit(Access<T> access, T handle, long offset, long fromIndex) Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
<T> long	nextSetBit(Access<T> access, T handle, long offset, long fromIndex) Returns the index of the first bit that is set to true that occurs on or after the specified starting index.
<T> long	previousClearBit(Access<T> access, T handle, long offset, long fromIndex) Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index.
<T> long	previousSetBit(Access<T> access, T handle, long offset, long fromIndex) Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index.
<T> void	set(Access<T> access, T handle, long offset, long bitIndex) Sets the bit at the specified index to true.
default <T> void	set(Access<T> access, T handle, long offset, long bitIndex, boolean value) Sets the bit at the specified index to the specified value.
<T> void	setAll(Access<T> access, T handle, long offset) Equivalent to setRange(0, logicalSize()).
BitSetFrame.Bits	setBits() Returns an iteration of set bits in direct order (from 0 to the end of the bit set).
<T> boolean	setIfClear(Access<T> access, T handle, long offset, long bitIndex) Sets the bit at the specified index to true.
<T> long	setNextClearBit(Access<T> access, T handle, long offset, long fromIndex) Finds and sets to true the first bit that is set to false that occurs on or after the specified starting index.
<T> long	setNextNContinuousClearBits(Access<T> access, T handle, long offset, long fromIndex, int numberOfBits) Finds the next numberOfBits consecutive bits set to false, starting from the specified fromIndex.
<T> long	setPreviousClearBit(Access<T> access, T handle, long offset, long fromIndex) Finds and sets to true the nearest bit that is set to false that occurs on or before the specified starting index.
<T> long	setPreviousNContinuousClearBits(Access<T> access, T handle, long offset, long fromIndex, int numberOfBits) Finds the previous numberOfBits consecutive bits set to false, starting from the specified fromIndex.
<T> void	setRange(Access<T> access, T handle, long offset, long fromIndex, long toIndex) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to true.
default <T> void	setRange(Access<T> access, T handle, long offset, long fromIndex, long toIndex, boolean value) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the specified value.
long	sizeInBytes() Number of bytes taken by this frame.

Field Detail

NOT_FOUND

static final long NOT_FOUND

Returned if no entry is found

See Also:

Constant Field Values

Method Detail

flip

<T> void flip(Access<T> access,
              T handle,
              long offset,
              long bitIndex)

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

Parameters:

bitIndex - the index of the bit to flip

flipRange

<T> void flipRange(Access<T> access,
                   T handle,
                   long offset,
                   long fromIndex,
                   long toIndex)

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

Parameters:

fromIndex - index of the first bit to flip

toIndex - index after the last bit to flip

set

<T> void set(Access<T> access,
             T handle,
             long offset,
             long bitIndex)

Sets the bit at the specified index to true.

Parameters:

bitIndex - the bit index

setIfClear

<T> boolean setIfClear(Access<T> access,
                       T handle,
                       long offset,
                       long bitIndex)

Sets the bit at the specified index to true.

Parameters:

bitIndex - the bit index

Returns:

true if the bit was zeroOut, or false if the bit was already set

clearIfSet

<T> boolean clearIfSet(Access<T> access,
                       T handle,
                       long offset,
                       long bitIndex)

Clears the bit at the specified index (sets it to false).

Parameters:

bitIndex - a bit index

Returns:

the previous value of the bit at the specified index

set

default <T> void set(Access<T> access,
                     T handle,
                     long offset,
                     long bitIndex,
                     boolean value)

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

Parameters:

bitIndex - the bit index

value - the boolean value to set

setRange

<T> void setRange(Access<T> access,
                  T handle,
                  long offset,
                  long fromIndex,
                  long toIndex)

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

Parameters:

fromIndex - index of the first bit to be set

toIndex - index after the last bit to be set

setAll

<T> void setAll(Access<T> access,
                T handle,
                long offset)

Equivalent to setRange(0, logicalSize()).

setRange

default <T> void setRange(Access<T> access,
                          T handle,
                          long offset,
                          long fromIndex,
                          long 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

clear

<T> void clear(Access<T> access,
               T handle,
               long offset,
               long bitIndex)

Sets the bit specified by the index to false.

Parameters:

bitIndex - the index of the bit to be cleared

clearRange

<T> void clearRange(Access<T> access,
                    T handle,
                    long offset,
                    long fromIndex,
                    long toIndex)

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

Parameters:

fromIndex - index of the first bit to be cleared

toIndex - index after the last bit to be cleared

clearAll

<T> void clearAll(Access<T> access,
                  T handle,
                  long offset)

Equivalent to clearRange(0, logicalSize()).

get

<T> boolean get(Access<T> access,
                T handle,
                long offset,
                long 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 DirectBitSet; otherwise, the result is false.

Parameters:

bitIndex - the bit index

Returns:

the value of the bit with the specified index

isSet

default <T> boolean isSet(Access<T> access,
                          T handle,
                          long offset,
                          long bitIndex)

Synonym of #get).

Parameters:

bitIndex - the bit index

Returns:

the value of the bit with the specified index

isRangeSet

<T> boolean isRangeSet(Access<T> access,
                       T handle,
                       long offset,
                       long fromIndex,
                       long toIndex)

Checks if each bit from the specified fromIndex (inclusive) to the specified exclusiveToIndex is set to true.

Parameters:

fromIndex - index of the first bit to check

toIndex - index after the last bit to check

Returns:

true if all bits in the specified range are set to true, false otherwise

isClear

default <T> boolean isClear(Access<T> access,
                            T handle,
                            long offset,
                            long bitIndex)

Synonym of !get(long).

Parameters:

bitIndex - the bit index

Returns:

true is the bit at the specified index is clear in this bit set; if the bit is set to true then returns false

isRangeClear

<T> boolean isRangeClear(Access<T> access,
                         T handle,
                         long offset,
                         long fromIndex,
                         long toIndex)

Checks if each bit from the specified fromIndex (inclusive) to the specified exclusiveToIndex is set to false.

Parameters:

fromIndex - index of the first bit to check

toIndex - index after the last bit to check

Returns:

true if all bits in the specified range are set to false, false otherwise

nextSetBit

<T> long nextSetBit(Access<T> access,
                    T handle,
                    long offset,
                    long 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.

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

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

See Also:

clearNextSetBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

nextClearBit

<T> long nextClearBit(Access<T> access,
                      T handle,
                      long offset,
                      long fromIndex)

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

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

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

See Also:

setNextClearBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

previousSetBit

<T> long previousSetBit(Access<T> access,
                        T handle,
                        long offset,
                        long 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.

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

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

See Also:

clearPreviousSetBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

previousClearBit

<T> long previousClearBit(Access<T> access,
                          T handle,
                          long offset,
                          long 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.

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

the index of the previous zeroOut bit, or -1 if there is no such bit

See Also:

setPreviousClearBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

logicalSize

long logicalSize()

Number of bits in this frame. The index of the last bit in the set eligible to be set or zeroOut is logicalSize() - 1.

Returns:

the number of bits in this bit set

sizeInBytes

long sizeInBytes()

Number of bytes taken by this frame.

cardinality

<T> long cardinality(Access<T> access,
                     T handle,
                     long offset)

Returns the number of bits set to true in the bit set.

setNextClearBit

<T> long setNextClearBit(Access<T> access,
                         T handle,
                         long offset,
                         long fromIndex)

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

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

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

See Also:

nextClearBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

clearNextSetBit

<T> long clearNextSetBit(Access<T> access,
                         T handle,
                         long offset,
                         long fromIndex)

Finds and clears 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.

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

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

See Also:

nextSetBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

setPreviousClearBit

<T> long setPreviousClearBit(Access<T> access,
                             T handle,
                             long offset,
                             long fromIndex)

Finds and sets to true 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.

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

the index of the previous zeroOut bit, or -1 if there is no such bit

See Also:

previousClearBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

clearPreviousSetBit

<T> long clearPreviousSetBit(Access<T> access,
                             T handle,
                             long offset,
                             long fromIndex)

Finds and clears 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.

Parameters:

fromIndex - the index to start checking from (inclusive)

Returns:

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

See Also:

previousSetBit(net.openhft.chronicle.algo.bytes.Access<T>, T, long, long)

setNextNContinuousClearBits

<T> long setNextNContinuousClearBits(Access<T> access,
                                     T handle,
                                     long offset,
                                     long fromIndex,
                                     int numberOfBits)

Finds the next numberOfBits consecutive bits set to false, starting from the specified fromIndex. Then all bits of the found range are set to true. The first index of the found block is returned. If there is no such range of clear bits, -1 is returned.

fromIndex could be the first index of the found range, thus setNextNContinuousClearBits(i, 1) is exact equivalent of setNextClearBit(i).

Parameters:

fromIndex - the index to start checking from (inclusive)

numberOfBits - how many continuous clear bits to search and set

Returns:

the index of the first bit in the found range of clear bits, or -1 if there is no such range

Throws:

IndexOutOfBoundsException - if fromIndex is negative

IllegalArgumentException - if numberOfBits <= 0

clearNextNContinuousSetBits

<T> long clearNextNContinuousSetBits(Access<T> access,
                                     T handle,
                                     long offset,
                                     long fromIndex,
                                     int numberOfBits)

Finds the next numberOfBits consecutive bits set to true, starting from the specified fromIndex. Then all bits of the found range are set to false. The first index of the found block is returned. If there is no such range of true bits, -1 is returned.

fromIndex could be the first index of the found range, thus clearNextNContinuousSetBits(i, 1) is exact equivalent of clearNextSetBit(i).

Parameters:

fromIndex - the index to start checking from (inclusive)

numberOfBits - how many continuous set bits to search and clear

Returns:

the index of the first bit in the found range of true bits, or -1 if there is no such range

Throws:

IndexOutOfBoundsException - if fromIndex is negative

IllegalArgumentException - if numberOfBits <= 0

setPreviousNContinuousClearBits

<T> long setPreviousNContinuousClearBits(Access<T> access,
                                         T handle,
                                         long offset,
                                         long fromIndex,
                                         int numberOfBits)

Finds the previous numberOfBits consecutive bits set to false, starting from the specified fromIndex. Then all bits of the found range are set to true. The first index of the found block is returned. If there is no such range of clear bits, or if -1 is given as the starting index, -1 is returned.

fromIndex could be the last index of the found range, thus setPreviousNContinuousClearBits(i, 1) is exact equivalent of setPreviousClearBit(i).

Parameters:

fromIndex - the index to start checking from (inclusive)

numberOfBits - how many continuous clear bits to search and set

Returns:

the index of the first bit in the found range of clear bits, or -1 if there is no such range

Throws:

IndexOutOfBoundsException - if fromIndex is less than -1

IllegalArgumentException - if numberOfBits <= 0

clearPreviousNContinuousSetBits

<T> long clearPreviousNContinuousSetBits(Access<T> access,
                                         T handle,
                                         long offset,
                                         long fromIndex,
                                         int numberOfBits)

Finds the previous numberOfBits consecutive bits set to true, starting from the specified fromIndex. Then all bits of the found range are set to false. The first index of the found block is returned. If there is no such range of true bits, or if -1 is given as the starting index, -1 is returned.

fromIndex could be the last index of the found range, thus clearPreviousNContinuousSetBits(i, 1) is exact equivalent of clearPreviousSetBit(i).

Parameters:

fromIndex - the index to start checking from (inclusive)

numberOfBits - how many continuous set bits to search and clear

Returns:

the index of the first bit in the found range of true bits, or -1 if there is no such range

Throws:

IndexOutOfBoundsException - if fromIndex is less than -1

IllegalArgumentException - if numberOfBits <= 0

setBits

BitSetFrame.Bits setBits()

Returns an iteration of set bits in direct order (from 0 to the end of the bit set).

Returns:

an iteration of set bits in direct order

algorithm

BitSetAlgorithm algorithm()