Simple bitfield interface for efficient storage access in O(1). More...

Inheritance diagram for jau.util.Int32Bitfield:

Collaboration diagram for jau.util.Int32Bitfield:

Public Member Functions
	Int32Bitfield ()

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

Detailed Description

Simple bitfield interface for efficient storage access in O(1).

Implementation uses one 32bit integer field for storage.

Definition at line 37 of file Int32Bitfield.java.

Constructor & Destructor Documentation

◆ Int32Bitfield()

jau.util.Int32Bitfield.Int32Bitfield ( )

Definition at line 42 of file Int32Bitfield.java.

Member Function Documentation

◆ bitCount()

int jau.util.Int32Bitfield.bitCount ( )

Returns the number of one bits within this bitfield.

Utilizes {#link Bitfield.Util#bitCount(int)}.

Implements org.jau.util.Bitfield.

Definition at line 159 of file Int32Bitfield.java.

Here is the call graph for this function:

◆ clear()

final void jau.util.Int32Bitfield.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

Implements org.jau.util.Bitfield.

Definition at line 137 of file Int32Bitfield.java.

◆ clearField()

final void jau.util.Int32Bitfield.clearField ( final boolean bit )

Set all bits of this bitfield to the given value bit.

Implements org.jau.util.Bitfield.

Definition at line 52 of file Int32Bitfield.java.

◆ copy()

final boolean jau.util.Int32Bitfield.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

Implements org.jau.util.Bitfield.

Definition at line 143 of file Int32Bitfield.java.

◆ copy32()

final int jau.util.Int32Bitfield.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)

Implements org.jau.util.Bitfield.

Definition at line 105 of file Int32Bitfield.java.

Here is the call graph for this function:

◆ get()

final boolean jau.util.Int32Bitfield.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

Implements org.jau.util.Bitfield.

Definition at line 112 of file Int32Bitfield.java.

◆ get32()

final int jau.util.Int32Bitfield.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)

Implements org.jau.util.Bitfield.

Definition at line 67 of file Int32Bitfield.java.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ put()

final boolean jau.util.Int32Bitfield.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

Implements org.jau.util.Bitfield.

Definition at line 117 of file Int32Bitfield.java.

◆ put32()

final void jau.util.Int32Bitfield.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)

Implements org.jau.util.Bitfield.

Definition at line 85 of file Int32Bitfield.java.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ set()

final void jau.util.Int32Bitfield.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

Implements org.jau.util.Bitfield.

Definition at line 131 of file Int32Bitfield.java.

◆ size()

int jau.util.Int32Bitfield.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 47 of file Int32Bitfield.java.

The documentation for this class was generated from the following file:

java_base/jau/util/Int32Bitfield.java

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Int32Bitfield()

Member Function Documentation

◆ bitCount()

◆ clear()

◆ clearField()

◆ copy()

◆ copy32()

◆ get()

◆ get32()

◆ put()

◆ put32()

◆ set()

◆ size()