Package org.chocosolver.memory.structure
Class OneWordS64BitSet
- java.lang.Object
-
- org.chocosolver.memory.structure.OneWordS64BitSet
-
- All Implemented Interfaces:
IStateBitSet
public class OneWordS64BitSet extends Object implements IStateBitSet
-
-
Constructor Summary
Constructors Constructor Description OneWordS64BitSet(IEnvironment environment, int nbits)Creates a bit set whose initial size is large enough to explicitly represent bits with indices in the range0throughnbits-1.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description intcardinality()Returns the number of bits set to true in thisBitSet.voidclear()Sets all of the bits in this BitSet tofalse.voidclear(int bitIndex)Sets the bit specified by the index tofalse.voidclear(int fromIndex, int toIndex)Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) tofalse.booleanequals(Object obj)booleanget(int bitIndex)Returns the value of the bit with the specified index.inthashCode()booleanisEmpty()Returns true if thisBitSetcontains no bits that are set totrue.intlength()Returns the "logical size" of thisBitSet: the index of the highest set bit in theBitSetplus one.intnextClearBit(int fromIndex)Returns the index of the first bit that is set tofalsethat occurs on or after the specified starting index.intnextSetBit(int fromIndex)Returns the index of the first bit that is set totruethat occurs on or after the specified starting index.intprevClearBit(int fromIndex)Returns the index of the nearest bit that is set tofalsethat occurs on or before the specified starting index.intprevSetBit(int fromIndex)Returns the index of the nearest bit that is set totruethat occurs on or before the specified starting index.voidset(int bitIndex)Sets the bit at the specified index totrue.voidset(int bitIndex, boolean value)Sets the bit at the specified index to the specified value.voidset(int fromIndex, int toIndex)Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) totrue.intsize()Returns the number of bits of space actually in use by thisBitSetto represent bit values.StringtoString()
-
-
-
Constructor Detail
-
OneWordS64BitSet
public OneWordS64BitSet(IEnvironment environment, int nbits)
Creates a bit set whose initial size is large enough to explicitly represent bits with indices in the range0throughnbits-1. All bits are initiallyfalse.- Parameters:
environment- backtrackable environmentnbits- the initial size of the bit set.- Throws:
NegativeArraySizeException- if the specified initial size is negative.
-
-
Method Detail
-
set
public void set(int bitIndex)
Sets the bit at the specified index totrue.- Specified by:
setin interfaceIStateBitSet- Parameters:
bitIndex- a bit index.- Throws:
IndexOutOfBoundsException- if the specified index is negative.- Since:
- JDK1.0
-
set
public void set(int bitIndex, boolean value)Sets the bit at the specified index to the specified value.- Specified by:
setin interfaceIStateBitSet- Parameters:
bitIndex- a bit index.value- a boolean value to set.- Throws:
IndexOutOfBoundsException- if the specified index is negative.- Since:
- 1.4
-
set
public void set(int fromIndex, int toIndex)Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) totrue.- Specified by:
setin interfaceIStateBitSet- 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 toIndex is negative, or fromIndex is larger than toIndex.- Since:
- 1.4
-
clear
public void clear(int bitIndex)
Sets the bit specified by the index tofalse.- Specified by:
clearin interfaceIStateBitSet- Parameters:
bitIndex- the index of the bit to be cleared.- Throws:
IndexOutOfBoundsException- if the specified index is negative.- Since:
- JDK1.0
-
clear
public void clear(int fromIndex, int toIndex)Sets the bits from the specified fromIndex (inclusive) to the specified toIndex (exclusive) tofalse.- Specified by:
clearin interfaceIStateBitSet- 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 toIndex is negative, or fromIndex is larger than toIndex.- Since:
- 1.4
-
clear
public void clear()
Sets all of the bits in this BitSet tofalse.- Specified by:
clearin interfaceIStateBitSet- Since:
- 1.4
-
get
public final boolean get(int bitIndex)
Returns the value of the bit with the specified index. The value istrueif the bit with the indexbitIndexis currently set in thisBitSet; otherwise, the result isfalse.- Specified by:
getin interfaceIStateBitSet- Parameters:
bitIndex- the bit index.- Returns:
- the value of the bit with the specified index.
- Throws:
IndexOutOfBoundsException- if the specified index is negative.
-
nextSetBit
public int nextSetBit(int fromIndex)
Returns the index of the first bit that is set totruethat occurs on or after the specified starting index. If no such bit exists then-1is returned.To iterate over the
truebits in aBitSet, use the following loop:for (int i = bs.nextSetBit(0); i >= 0; i = bs.nextSetBit(i+1)) { // operate on index i here }- Specified by:
nextSetBitin interfaceIStateBitSet- Parameters:
fromIndex- the index to start checking from (inclusive)- Returns:
- the index of the next set bit, or
-1if there is no such bit - Throws:
IndexOutOfBoundsException- if the specified index is negative- Since:
- 1.4
-
nextClearBit
public int nextClearBit(int fromIndex)
Returns the index of the first bit that is set tofalsethat occurs on or after the specified starting index.- Specified by:
nextClearBitin interfaceIStateBitSet- Parameters:
fromIndex- the index to start checking from (inclusive)- Returns:
- the index of the next clear bit
- Throws:
IndexOutOfBoundsException- if the specified index is negative- Since:
- 1.4
-
prevSetBit
public int prevSetBit(int fromIndex)
Returns the index of the nearest bit that is set totruethat occurs on or before the specified starting index. If no such bit exists, or if-1is given as the starting index, then-1is returned.To iterate over the
truebits in aBitSet, use the following loop:for (int i = bs.length(); (i = bs.previousSetBit(i-1)) >= 0; ) { // operate on index i here }- Specified by:
prevSetBitin interfaceIStateBitSet- Parameters:
fromIndex- the index to start checking from (inclusive)- Returns:
- the index of the previous set bit, or
-1if there is no such bit - Throws:
IndexOutOfBoundsException- if the specified index is less than-1- Since:
- 1.7
-
prevClearBit
public int prevClearBit(int fromIndex)
Returns the index of the nearest bit that is set tofalsethat occurs on or before the specified starting index. If no such bit exists, or if-1is given as the starting index, then-1is returned.- Specified by:
prevClearBitin interfaceIStateBitSet- Parameters:
fromIndex- the index to start checking from (inclusive)- Returns:
- the index of the previous clear bit, or
-1if there is no such bit - Throws:
IndexOutOfBoundsException- if the specified index is less than-1- Since:
- 1.7
-
length
public int length()
Returns the "logical size" of thisBitSet: the index of the highest set bit in theBitSetplus one. Returns zero if theBitSetcontains no set bits.- Returns:
- the logical size of this
BitSet. - Since:
- 1.2
-
isEmpty
public boolean isEmpty()
Returns true if thisBitSetcontains no bits that are set totrue.- Specified by:
isEmptyin interfaceIStateBitSet- Returns:
- boolean indicating whether this
BitSetis empty. - Since:
- 1.4
-
cardinality
public int cardinality()
Returns the number of bits set to true in thisBitSet.- Specified by:
cardinalityin interfaceIStateBitSet- Returns:
- the number of bits set to true in this
BitSet. - Since:
- 1.4
-
size
public int size()
Returns the number of bits of space actually in use by thisBitSetto represent bit values. The maximum element in the set is the size - 1st element.- Specified by:
sizein interfaceIStateBitSet- Returns:
- the number of bits currently in this bit set.
-
-