net.openhft.chronicle.algo.bitset

Interface BitSet

All Known Implementing Classes:

ReusableBitSet

public interface BitSet

Most notable logical difference of this interface with java.util.BitSet is that DirectBitSet has a rigid logicalSize(), attempts to get(long), set(long) or clear(long) bits at indices exceeding the size cause IndexOutOfBoundsException. There is also a setAll() method to set all bits within the size. java.util.BitSet doesn't have such rigid capacity.

See Also:

BitSet

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	BitSet.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
long	cardinality() Returns the number of bits set to true in this DirectBitSet.
void	clear(long bitIndex) Sets the bit specified by the index to false.
void	clearAll() Sets all of the bits in this BitSet to false.
boolean	clearIfSet(long bitIndex) Clears the bit at the specified index (sets it to false).
long	clearNextNContinuousSetBits(long fromIndex, int numberOfBits) Finds the next numberOfBits consecutive bits set to true, starting from the specified fromIndex.
long	clearNextSetBit(long fromIndex) Finds and clears the first bit that is set to true that occurs on or after the specified starting index.
long	clearPreviousNContinuousSetBits(long fromIndex, int numberOfBits) Finds the previous numberOfBits consecutive bits set to true, starting from the specified fromIndex.
long	clearPreviousSetBit(long fromIndex) Finds and clears the nearest bit that is set to true that occurs on or before the specified starting index.
void	clearRange(long fromIndex, long toIndex) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to false.
void	flip(long bitIndex) Sets the bit at the specified index to the complement of its current value.
void	flipRange(long fromIndex, long toIndex) Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.
boolean	get(long bitIndex) Returns the value of the bit with the specified index.
default boolean	isClear(long bitIndex) Synonym of !get(long).
boolean	isRangeClear(long fromIndex, long toIndex)
boolean	isRangeSet(long fromIndex, long toIndex)
default boolean	isSet(long bitIndex) Synonym of get(long).
long	logicalSize() Returns the number of bits of space actually in use by this BitSet to represent bit values.
long	nextClearBit(long fromIndex) Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
long	nextSetBit(long fromIndex) Returns the index of the first bit that is set to true that occurs on or after the specified starting index.
long	previousClearBit(long fromIndex) Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index.
long	previousSetBit(long fromIndex) Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index.
void	set(long bitIndex) Sets the bit at the specified index to true.
default void	set(long bitIndex, boolean value) Sets the bit at the specified index to the specified value.
void	setAll() Sets all bits, bs.setAll() is equivalent of bs.set(0, bs.size().
BitSet.Bits	setBits() Returns an iteration of set bits in direct order (from 0 to the end of the bit set).
boolean	setIfClear(long bitIndex) Sets the bit at the specified index to true.
long	setNextClearBit(long fromIndex) Finds and sets to true the first bit that is set to false that occurs on or after the specified starting index.
long	setNextNContinuousClearBits(long fromIndex, int numberOfBits) Finds the next numberOfBits consecutive bits set to false, starting from the specified fromIndex.
long	setPreviousClearBit(long fromIndex) Finds and sets to true the nearest bit that is set to false that occurs on or before the specified starting index.
long	setPreviousNContinuousClearBits(long fromIndex, int numberOfBits) Finds the previous numberOfBits consecutive bits set to false, starting from the specified fromIndex.
void	setRange(long fromIndex, long toIndex) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to true.
default void	setRange(long fromIndex, long toIndex, boolean value) Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the specified value.

Field Detail

NOT_FOUND

static final long NOT_FOUND

Returned if no entry is found

See Also:

Constant Field Values

Method Detail

flip

void flip(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

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

flipRange

void flipRange(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

Throws:

IndexOutOfBoundsException - if fromIndex is negative, or fromIndex is larger than toIndex, or toIndex is larger or equal to size()

set

void set(long bitIndex)

Sets the bit at the specified index to true.

Parameters:

bitIndex - a bit index

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

setIfClear

boolean setIfClear(long bitIndex)

Sets the bit at the specified index to true.

Parameters:

bitIndex - a bit index

Returns:

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

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

clearIfSet

boolean clearIfSet(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

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

set

default void set(long bitIndex,
                 boolean value)

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

Parameters:

bitIndex - a bit index

value - a boolean value to set

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

setRange

void setRange(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

Throws:

IndexOutOfBoundsException - if fromIndex is negative, or fromIndex is larger than toIndex, or toIndex is larger or equal to size()

isRangeSet

boolean isRangeSet(long fromIndex,
                   long toIndex)

setAll

void setAll()

Sets all bits, bs.setAll() is equivalent of bs.set(0, bs.size().

setRange

default void setRange(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

Throws:

IndexOutOfBoundsException - if fromIndex is negative, or fromIndex is larger than toIndex, or toIndex is larger or equal to size()

clear

void clear(long bitIndex)

Sets the bit specified by the index to false.

Parameters:

bitIndex - the index of the bit to be cleared

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

clearRange

void clearRange(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

Throws:

IndexOutOfBoundsException - if fromIndex is negative, or fromIndex is larger than toIndex, or toIndex is larger or equal to size()

isRangeClear

boolean isRangeClear(long fromIndex,
                     long toIndex)

clearAll

void clearAll()

Sets all of the bits in this BitSet to false.

get

boolean get(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

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

isSet

default boolean isSet(long bitIndex)

Synonym of get(long).

Parameters:

bitIndex - the bit index

Returns:

the value of the bit with the specified index

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

isClear

default boolean isClear(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

Throws:

IndexOutOfBoundsException - if the index is out of range (index < 0 || index >= size())

nextSetBit

long nextSetBit(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.

To iterate over the true bits in a DirectBitSet, use the following loop:

 
 for (int i = bs.nextSetBit(0); i >= 0; i = bs.nextSetBit(i+1)) {
     // operate on index i here
 }

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

Throws:

IndexOutOfBoundsException - if the specified index is negative

See Also:

clearNextSetBit(long)

nextClearBit

long nextClearBit(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

Throws:

IndexOutOfBoundsException - if the specified index is negative

See Also:

setNextClearBit(long)

previousSetBit

long previousSetBit(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.

To iterate over the true bits in a DirectBitSet, use the following loop:

 
 for (int i = bs.size(); (i = bs.previousSetBit(i-1)) >= 0; ) {
 // operate on index i here
 }

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

Throws:

IndexOutOfBoundsException - if the specified index is less than -1

See Also:

clearPreviousSetBit(long)

previousClearBit

long previousClearBit(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

Throws:

IndexOutOfBoundsException - if the specified index is less than -1

See Also:

setPreviousClearBit(long)

logicalSize

long logicalSize()

Returns the number of bits of space actually in use by this BitSet to represent bit values. The index of the last bit in the set eligible to be set or zeroOut is size() - 1.

Returns:

the number of bits in this bit set

cardinality

long cardinality()

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

Returns:

the number of bits set to true in this DirectBitSet

setNextClearBit

long setNextClearBit(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

Throws:

IndexOutOfBoundsException - if the specified index is negative

See Also:

nextClearBit(long)

clearNextSetBit

long clearNextSetBit(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

Throws:

IndexOutOfBoundsException - if the specified index is negative

See Also:

nextSetBit(long)

setPreviousClearBit

long setPreviousClearBit(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

Throws:

IndexOutOfBoundsException - if the specified index is less than -1

See Also:

previousClearBit(long)

clearPreviousSetBit

long clearPreviousSetBit(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

Throws:

IndexOutOfBoundsException - if the specified index is less than -1

See Also:

previousSetBit(long)

setNextNContinuousClearBits

long setNextNContinuousClearBits(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

long clearNextNContinuousSetBits(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

long setPreviousNContinuousClearBits(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

long clearPreviousNContinuousSetBits(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

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