jaulib v1.3.0
Jau Support Library (C++, Java, ..)
|
Simple bitfield interface for efficient storage access in O(1). More...
Public Member Functions | |
Int32ArrayBitfield (final int storageBitSize) | |
int | size () |
Returns the storage size in bit units, e.g. More... | |
final void | clearField (final boolean bit) |
Set all bits of this bitfield to the given value bit . More... | |
final 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... | |
final 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... | |
final int | copy32 (final int srcBitnum, final int dstBitnum, final int length) throws IndexOutOfBoundsException |
Copies length bits at position srcLowBitnum to position dstLowBitnum and returning the bits. More... | |
final boolean | get (final int bitnum) throws IndexOutOfBoundsException |
Return true if the bit at position bitnum is set, otherwise false . More... | |
final 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... | |
final void | set (final int bitnum) throws IndexOutOfBoundsException |
Set the bit at position bitnum according to bit . More... | |
final void | clear (final int bitnum) throws IndexOutOfBoundsException |
Clear the bit at position bitnum according to bit . More... | |
final 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... | |
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 storage access in O(1).
Implementation uses a 32bit integer array for storage.
Definition at line 37 of file Int32ArrayBitfield.java.
jau.util.Int32ArrayBitfield.Int32ArrayBitfield | ( | final int | storageBitSize | ) |
storageBitSize |
Definition at line 45 of file Int32ArrayBitfield.java.
int jau.util.Int32ArrayBitfield.bitCount | ( | ) |
Returns the number of one bits within this bitfield.
Utilizes {#link Bitfield.Util#bitCount(int)
}.
Implements org.jau.util.Bitfield.
Definition at line 199 of file Int32ArrayBitfield.java.
final void jau.util.Int32ArrayBitfield.clear | ( | final int | bitnum | ) | throws IndexOutOfBoundsException |
Clear the bit at position bitnum
according to bit
.
bitnum | bit number, restricted to [0..size() -1]. |
IndexOutOfBoundsException | if bitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 168 of file Int32ArrayBitfield.java.
final void jau.util.Int32ArrayBitfield.clearField | ( | final boolean | bit | ) |
Set all bits of this bitfield to the given value bit
.
Implements org.jau.util.Bitfield.
Definition at line 57 of file Int32ArrayBitfield.java.
final boolean jau.util.Int32ArrayBitfield.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
.
srcBitnum | source bit number, restricted to [0..size() -1]. |
dstBitnum | destination bit number, restricted to [0..size() -1]. |
IndexOutOfBoundsException | if bitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 176 of file Int32ArrayBitfield.java.
final int jau.util.Int32ArrayBitfield.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.
srcLowBitnum | source bit number, restricted to [0..size() -1]. |
dstLowBitnum | destination bit number, restricted to [0..size() -1]. |
IndexOutOfBoundsException | if bitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 129 of file Int32ArrayBitfield.java.
final boolean jau.util.Int32ArrayBitfield.get | ( | final int | bitnum | ) | throws IndexOutOfBoundsException |
Return true
if the bit at position bitnum
is set, otherwise false
.
bitnum | bit number, restricted to [0..size() -1]. |
IndexOutOfBoundsException | if bitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 136 of file Int32ArrayBitfield.java.
final int jau.util.Int32ArrayBitfield.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
.
lowBitnum | storage bit position of the lowest bit, restricted to [0..size() -length ]. |
length | number of bits to read, constrained to [0..32]. |
IndexOutOfBoundsException | if rightBitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 76 of file Int32ArrayBitfield.java.
final boolean jau.util.Int32ArrayBitfield.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.
bitnum | bit number, restricted to [0..size() -1]. |
IndexOutOfBoundsException | if bitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 144 of file Int32ArrayBitfield.java.
final void jau.util.Int32ArrayBitfield.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
.
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 |
IndexOutOfBoundsException | if rightBitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 102 of file Int32ArrayBitfield.java.
final void jau.util.Int32ArrayBitfield.set | ( | final int | bitnum | ) | throws IndexOutOfBoundsException |
Set the bit at position bitnum
according to bit
.
bitnum | bit number, restricted to [0..size() -1]. |
IndexOutOfBoundsException | if bitnum is out of bounds |
Implements org.jau.util.Bitfield.
Definition at line 160 of file Int32ArrayBitfield.java.
int jau.util.Int32ArrayBitfield.size | ( | ) |
Returns the storage size in bit units, e.g.
32 bit for implementations using one int
field.
Implements org.jau.util.Bitfield.
Definition at line 52 of file Int32ArrayBitfield.java.