ReusableBitSet (OpenHFT/Chronicle-Algorithms 1.15.0 API)

java.lang.Object
- net.openhft.chronicle.algo.bitset.ReusableBitSet

All Implemented Interfaces:: BitSet

public class ReusableBitSet
extends Object
implements BitSet

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class ReusableBitSet.Bits

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ReusableBitSet.Bits`

Field Summary

Fields
Modifier and Type Field and Description

protected Access access

protected BitSetFrame frame

protected Object handle

protected long offset
- Fields inherited from interface net.openhft.chronicle.algo.bitset.BitSet
  NOT_FOUND

Fields
Modifier and Type	Field and Description
`protected Access`	`access`
`protected BitSetFrame`	`frame`
`protected Object`	`handle`
`protected long`	`offset`

Constructor Summary

Constructors
Constructor and Description

ReusableBitSet(BitSetFrame frame, Access<T> access, T handle, long offset)

Constructors
Constructor and Description
`ReusableBitSet(BitSetFrame frame, Access<T> access, T handle, long offset)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`boolean`	`isRangeClear(long fromIndex, long toIndex)`
`boolean`	`isRangeSet(long fromIndex, long toIndex)`
`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.
`<T> ReusableBitSet`	`reuse(BitSetFrame frame, Access<T> access, T handle, long offset)`
`void`	`set(long bitIndex)` Sets the bit at the specified index to `true`.
`void`	`setAll()` Sets all bits, `bs.setAll()` is equivalent of `bs.set(0, bs.size()`.
`ReusableBitSet.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`.
`void`	`setOffset(long offset)`
`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`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.algo.bitset.BitSet
isClear, isSet, set, setRange

- Field Detail
  - frame
```
protected BitSetFrame frame
```
  - access
```
protected Access access
```
  - handle
```
protected Object handle
```
  - offset
```
protected long offset
```
- Constructor Detail
  - ReusableBitSet
```
public ReusableBitSet(BitSetFrame frame,
                      Access<T> access,
                      T handle,
                      long offset)
```
- Method Detail
  - reuse
```
public final <T> ReusableBitSet reuse(BitSetFrame frame,
                                      Access<T> access,
                                      T handle,
                                      long offset)
```
  - setOffset
```
public void setOffset(long offset)
```
  - flip
```
public void flip(long bitIndex)
```
    Description copied from interface: BitSet
    
    Sets the bit at the specified index to the complement of its current value.
    
    Specified by:
    
    flip in interface BitSet
    
    Parameters:
    
    bitIndex - the index of the bit to flip
  - flipRange
```
public void flipRange(long fromIndex,
                      long toIndex)
```
    Description copied from interface: BitSet
    
    Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.
    
    Specified by:
    
    flipRange in interface BitSet
    
    Parameters:
    
    fromIndex - index of the first bit to flip
    
    toIndex - index after the last bit to flip
  - set
```
public void set(long bitIndex)
```
    Description copied from interface: BitSet
    
    Sets the bit at the specified index to true.
    
    Specified by:
    
    set in interface BitSet
    
    Parameters:
    
    bitIndex - a bit index
  - setIfClear
```
public boolean setIfClear(long bitIndex)
```
    Description copied from interface: BitSet
    
    Sets the bit at the specified index to true.
    
    Specified by:
    
    setIfClear in interface BitSet
    
    Parameters:
    
    bitIndex - a bit index
    
    Returns:
    
    true if the bit was zeroOut, or false if the bit was already set.
  - clearIfSet
```
public boolean clearIfSet(long bitIndex)
```
    Description copied from interface: BitSet
    
    Clears the bit at the specified index (sets it to false).
    
    Specified by:
    
    clearIfSet in interface BitSet
    
    Parameters:
    
    bitIndex - a bit index
    
    Returns:
    
    the previous value of the bit at the specified index
  - setRange
```
public void setRange(long fromIndex,
                     long toIndex)
```
    Description copied from interface: BitSet
    
    Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to true.
    
    Specified by:
    
    setRange in interface BitSet
    
    Parameters:
    
    fromIndex - index of the first bit to be set
    
    toIndex - index after the last bit to be set
  - isRangeSet
```
public boolean isRangeSet(long fromIndex,
                          long toIndex)
```
    Specified by:
    
    isRangeSet in interface BitSet
  - setAll
```
public void setAll()
```
    Description copied from interface: BitSet
    
    Sets all bits, bs.setAll() is equivalent of bs.set(0, bs.size().
    
    Specified by:
    
    setAll in interface BitSet
  - clear
```
public void clear(long bitIndex)
```
    Description copied from interface: BitSet
    
    Sets the bit specified by the index to false.
    
    Specified by:
    
    clear in interface BitSet
    
    Parameters:
    
    bitIndex - the index of the bit to be cleared
  - clearRange
```
public void clearRange(long fromIndex,
                       long toIndex)
```
    Description copied from interface: BitSet
    
    Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to false.
    
    Specified by:
    
    clearRange in interface BitSet
    
    Parameters:
    
    fromIndex - index of the first bit to be cleared
    
    toIndex - index after the last bit to be cleared
  - isRangeClear
```
public boolean isRangeClear(long fromIndex,
                            long toIndex)
```
    Specified by:
    
    isRangeClear in interface BitSet
  - clearAll
```
public void clearAll()
```
    Description copied from interface: BitSet
    
    Sets all of the bits in this BitSet to false.
    
    Specified by:
    
    clearAll in interface BitSet
  - get
```
public boolean get(long bitIndex)
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    get in interface BitSet
    
    Parameters:
    
    bitIndex - the bit index
    
    Returns:
    
    the value of the bit with the specified index
  - nextSetBit
```
public long nextSetBit(long fromIndex)
```
    Description copied from interface: BitSet
    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)) {
 &nbsp;&nbsp;&nbsp;&nbsp;// operate on index i here
 }
```
    Specified by:
    
    nextSetBit in interface BitSet
    
    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:
    
    BitSet.clearNextSetBit(long)
  - nextClearBit
```
public long nextClearBit(long fromIndex)
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    nextClearBit in interface BitSet
    
    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:
    
    BitSet.setNextClearBit(long)
  - previousSetBit
```
public long previousSetBit(long fromIndex)
```
    Description copied from interface: BitSet
    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
 }
```
    Specified by:
    
    previousSetBit in interface BitSet
    
    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:
    
    BitSet.clearPreviousSetBit(long)
  - previousClearBit
```
public long previousClearBit(long fromIndex)
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    previousClearBit in interface BitSet
    
    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:
    
    BitSet.setPreviousClearBit(long)
  - logicalSize
```
public long logicalSize()
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    logicalSize in interface BitSet
    
    Returns:
    
    the number of bits in this bit set
  - cardinality
```
public long cardinality()
```
    Description copied from interface: BitSet
    
    Returns the number of bits set to true in this DirectBitSet.
    
    Specified by:
    
    cardinality in interface BitSet
    
    Returns:
    
    the number of bits set to true in this DirectBitSet
  - setNextClearBit
```
public long setNextClearBit(long fromIndex)
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    setNextClearBit in interface BitSet
    
    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:
    
    BitSet.nextClearBit(long)
  - clearNextSetBit
```
public long clearNextSetBit(long fromIndex)
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    clearNextSetBit in interface BitSet
    
    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:
    
    BitSet.nextSetBit(long)
  - setPreviousClearBit
```
public long setPreviousClearBit(long fromIndex)
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    setPreviousClearBit in interface BitSet
    
    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:
    
    BitSet.previousClearBit(long)
  - clearPreviousSetBit
```
public long clearPreviousSetBit(long fromIndex)
```
    Description copied from interface: BitSet
    
    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.
    
    Specified by:
    
    clearPreviousSetBit in interface BitSet
    
    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:
    
    BitSet.previousSetBit(long)
  - setNextNContinuousClearBits
```
public long setNextNContinuousClearBits(long fromIndex,
                                        int numberOfBits)
```
    Description copied from interface: BitSet
    
    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).
    
    Specified by:
    
    setNextNContinuousClearBits in interface BitSet
    
    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
  - clearNextNContinuousSetBits
```
public long clearNextNContinuousSetBits(long fromIndex,
                                        int numberOfBits)
```
    Description copied from interface: BitSet
    
    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).
    
    Specified by:
    
    clearNextNContinuousSetBits in interface BitSet
    
    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
  - setPreviousNContinuousClearBits
```
public long setPreviousNContinuousClearBits(long fromIndex,
                                            int numberOfBits)
```
    Description copied from interface: BitSet
    
    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).
    
    Specified by:
    
    setPreviousNContinuousClearBits in interface BitSet
    
    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
  - clearPreviousNContinuousSetBits
```
public long clearPreviousNContinuousSetBits(long fromIndex,
                                            int numberOfBits)
```
    Description copied from interface: BitSet
    
    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).
    
    Specified by:
    
    clearPreviousNContinuousSetBits in interface BitSet
    
    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
  - setBits
```
public ReusableBitSet.Bits setBits()
```
    Description copied from interface: BitSet
    
    Returns an iteration of set bits in direct order (from 0 to the end of the bit set).
    
    Specified by:
    
    setBits in interface BitSet
    
    Returns:
    
    an iteration of set bits in direct order

Class ReusableBitSet

Nested Class Summary

Field Summary

Fields inherited from interface net.openhft.chronicle.algo.bitset.BitSet

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface net.openhft.chronicle.algo.bitset.BitSet

Field Detail

frame

access

handle

offset

Constructor Detail

ReusableBitSet

Method Detail

reuse

setOffset

flip

flipRange

set

setIfClear

clearIfSet

setRange

isRangeSet

setAll

clear

clearRange

isRangeClear

clearAll

get

nextSetBit

nextClearBit

previousSetBit

previousClearBit

logicalSize

cardinality

setNextClearBit

clearNextSetBit

setPreviousClearBit

clearPreviousSetBit

setNextNContinuousClearBits

clearNextNContinuousSetBits

setPreviousNContinuousClearBits

clearPreviousNContinuousSetBits

setBits