Simple bitfield interface for efficient bit storage access in O(1).
More...
|
| int | size () |
| | Returns the storage size in bit units, e.g. More...
|
| |
| void | clearField (final boolean bit) |
| | Set all bits of this bitfield to the given value bit. More...
|
| |
| int | get32 (final int lowBitnum, final int length) throws IndexOutOfBoundsException |
| | Returns length bits from this storage, starting with the lowest bit from the storage position lowBitnum. More...
|
| |
| void | put32 (final int lowBitnum, final int length, final int data) throws IndexOutOfBoundsException |
| | Puts length bits of given data into this storage, starting w/ the lowest bit to the storage position lowBitnum. More...
|
| |
| int | copy32 (final int srcLowBitnum, final int dstLowBitnum, final int length) throws IndexOutOfBoundsException |
| | Copies length bits at position srcLowBitnum to position dstLowBitnum and returning the bits. More...
|
| |
| boolean | get (final int bitnum) throws IndexOutOfBoundsException |
| | Return true if the bit at position bitnum is set, otherwise false. More...
|
| |
| boolean | put (final int bitnum, final boolean bit) throws IndexOutOfBoundsException |
| | Set or clear the bit at position bitnum according to bit and return the previous value. More...
|
| |
| void | set (final int bitnum) throws IndexOutOfBoundsException |
| | Set the bit at position bitnum according to bit. More...
|
| |
| void | clear (final int bitnum) throws IndexOutOfBoundsException |
| | Clear the bit at position bitnum according to bit. More...
|
| |
| boolean | copy (final int srcBitnum, final int dstBitnum) throws IndexOutOfBoundsException |
| | Copies the bit at position srcBitnum to position dstBitnum and returning true if the bit is set, otherwise false. More...
|
| |
| int | bitCount () |
| | Returns the number of one bits within this bitfield. More...
|
| |
Simple bitfield interface for efficient bit storage access in O(1).
- Since
- 2.3.2
Definition at line 36 of file Bitfield.java.
◆ bitCount()
| int com.jogamp.common.util.Bitfield.bitCount |
( |
| ) |
|
◆ clear()
| void com.jogamp.common.util.Bitfield.clear |
( |
final int |
bitnum | ) |
throws IndexOutOfBoundsException |
Clear the bit at position bitnum according to bit.
- Parameters
-
| bitnum | bit number, restricted to [0..size()-1]. |
- Exceptions
-
| IndexOutOfBoundsException | if bitnum is out of bounds |
◆ clearField()
| void com.jogamp.common.util.Bitfield.clearField |
( |
final boolean |
bit | ) |
|
Set all bits of this bitfield to the given value bit.
◆ copy()
| boolean com.jogamp.common.util.Bitfield.copy |
( |
final int |
srcBitnum, |
|
|
final int |
dstBitnum |
|
) |
| throws IndexOutOfBoundsException |
Copies the bit at position srcBitnum to position dstBitnum and returning true if the bit is set, otherwise false.
- Parameters
-
| srcBitnum | source bit number, restricted to [0..size()-1]. |
| dstBitnum | destination bit number, restricted to [0..size()-1]. |
- Exceptions
-
| IndexOutOfBoundsException | if bitnum is out of bounds |
◆ copy32()
| int com.jogamp.common.util.Bitfield.copy32 |
( |
final int |
srcLowBitnum, |
|
|
final int |
dstLowBitnum, |
|
|
final int |
length |
|
) |
| throws IndexOutOfBoundsException |
Copies length bits at position srcLowBitnum to position dstLowBitnum and returning the bits.
Implementation shall operate as if invoking get32(int, int) and then put32(int, int, int) sequentially.
- Parameters
-
| srcLowBitnum | source bit number, restricted to [0..size()-1]. |
| dstLowBitnum | destination bit number, restricted to [0..size()-1]. |
- Exceptions
-
| IndexOutOfBoundsException | if bitnum is out of bounds |
- See also
- get32(int, int)
-
put32(int, int, int)
◆ get()
| boolean com.jogamp.common.util.Bitfield.get |
( |
final int |
bitnum | ) |
throws IndexOutOfBoundsException |
Return true if the bit at position bitnum is set, otherwise false.
- Parameters
-
| bitnum | bit number, restricted to [0..size()-1]. |
- Exceptions
-
| IndexOutOfBoundsException | if bitnum is out of bounds |
◆ get32()
| int com.jogamp.common.util.Bitfield.get32 |
( |
final int |
lowBitnum, |
|
|
final int |
length |
|
) |
| throws IndexOutOfBoundsException |
Returns length bits from this storage, starting with the lowest bit from the storage position lowBitnum.
- Parameters
-
| lowBitnum | storage bit position of the lowest bit, restricted to [0..size()-length]. |
| length | number of bits to read, constrained to [0..32]. |
- Exceptions
-
| IndexOutOfBoundsException | if rightBitnum is out of bounds |
- See also
- put32(int, int, int)
◆ put()
| boolean com.jogamp.common.util.Bitfield.put |
( |
final int |
bitnum, |
|
|
final boolean |
bit |
|
) |
| throws IndexOutOfBoundsException |
Set or clear the bit at position bitnum according to bit and return the previous value.
- Parameters
-
| bitnum | bit number, restricted to [0..size()-1]. |
- Exceptions
-
| IndexOutOfBoundsException | if bitnum is out of bounds |
◆ put32()
| void com.jogamp.common.util.Bitfield.put32 |
( |
final int |
lowBitnum, |
|
|
final int |
length, |
|
|
final int |
data |
|
) |
| throws IndexOutOfBoundsException |
Puts length bits of given data into this storage, starting w/ the lowest bit to the storage position lowBitnum.
- Parameters
-
| lowBitnum | storage bit position of the lowest bit, restricted to [0..size()-length]. |
| length | number of bits to write, constrained to [0..32]. |
| data | the actual bits to be put into this storage |
- Exceptions
-
| IndexOutOfBoundsException | if rightBitnum is out of bounds |
- See also
- get32(int, int)
◆ set()
| void com.jogamp.common.util.Bitfield.set |
( |
final int |
bitnum | ) |
throws IndexOutOfBoundsException |
Set the bit at position bitnum according to bit.
- Parameters
-
| bitnum | bit number, restricted to [0..size()-1]. |
- Exceptions
-
| IndexOutOfBoundsException | if bitnum is out of bounds |
◆ size()
| int com.jogamp.common.util.Bitfield.size |
( |
| ) |
|
Returns the storage size in bit units, e.g.
32 bit for implementations using one int field.
◆ UNSIGNED_INT_MAX_VALUE
| final int com.jogamp.common.util.Bitfield.UNSIGNED_INT_MAX_VALUE = 0xffffffff |
|
static |
Maximum 32 bit Unsigned Integer Value: 0xffffffff == {@value}.
Definition at line 38 of file Bitfield.java.
The documentation for this interface was generated from the following file: