Progeneric.Ptl.Bitsets

Class BitInt32

java.lang.Object

Progeneric.Ptl.Bitsets.BitInt32

All Implemented Interfaces:

java.lang.Comparable<BitInt32>, IEquatable<BitInt32>

public class BitInt32
extends java.lang.Object
implements IEquatable<BitInt32>, java.lang.Comparable<BitInt32>

Manages a compact array of 32 bit values and provides constant-time access to each bit. Boolean value true indicates that the bit is on (1) and false indicates that the bit is off (0). The 32 bits in a BitInt32 are indexed by integer values from 0 to 31, where 0 indexes the first bit position (LSB) and 31 indexes the final bit (MSB) position.

Field Summary

Fields

Modifier and Type	Field and Description
static int	Log2Size Returns the Log2(Size).
static int	Size Returns the number of bits.

Constructor Summary

Constructors

Constructor and Description
BitInt32() Initializes a new instance of the BitInt32 with all bits set to false.
BitInt32(BitInt32 x) Initializes a new instance of the BitInt32 structure using the supplied BitInt32 value.
BitInt32(boolean value) Initializes a new instance of the BitInt32 with all bits set to the specified bit value.
BitInt32(int value) Initializes a new instance of the BitInt32 with the specified Int32 value.
BitInt32(java.lang.String item) Initializes a new instance of the BitInt32 structure using the supplied String value.

Method Summary

Methods

Modifier and Type	Method and Description
int	Allocate(int startWith) Locates the position of the first occurrence of a 0 bit and sets this bit to 1.
boolean	Any() Tests whether any bit is set to 1.
boolean	Any(boolean value) Tests whether any bit is set to the specified value.
boolean	Any(int first, int last) Tests whether any bit is set to 1 in the specified range.
boolean	Any(int first, int last, boolean value) Tests whether any bit is set to the specified value in the specified range.
void	AssignAnd(BitInt32 x) Performs the bitwise AND operation and assigns the result to the current instance.
void	AssignOr(BitInt32 x) Performs the bitwise OR operation and assigns the result to the current instance.
void	AssignXor(BitInt32 x) Performs the bitwise eXclusive OR operation and assigns the result to the current instance.
static BitInt32	BitwiseAnd(BitInt32 x, BitInt32 y) Performs the bitwise AND operation.
static BitInt32	BitwiseOr(BitInt32 x, BitInt32 y) Performs the bitwise OR operation.
static BitInt32	BitwiseXor(BitInt32 x, BitInt32 y) Performs the bitwise eXclusive OR operation.
int	compareTo(BitInt32 other) Compares this instance to a specified BitInt32 and returns an indication of their relative values.
int	Count(boolean value) Returns the number of bits with a specified value.
int	Count(int first, int last, boolean value) Counts the number of bits with a specified value in the specified range.
static boolean	Equal(BitInt32 x, BitInt32 y) Performs a logical comparison of the two BitInt32 parameters to determine if they are equal.
boolean	equals(BitInt32 other) Tests whether this instance is equal to a specified BitInt32.
boolean	Equals(BitInt32 other) Tests whether this instance is equal to a specified BitInt32.
boolean	equals(java.lang.Object obj) Tests whether this instance is equal to a specified object.
int	FindFirst(boolean value) Locates the position of the first occurrence of a bit that has a specified value.
int	FindFirst(int startWith, boolean value) Locates the position of the first occurrence of a bit that has a specified value.
int	FindFirst(int first, int last, boolean value) Locates the position of the first occurrence of a bit that has a specified value in the specified range.
int	FindLast(boolean value) Locates the position of the last occurrence of a bit that has a specified value.
int	FindLast(int startWith, boolean value) Locates the position of the last occurrence of a bit that has a specified value.
int	FindLast(int first, int last, boolean value) Locates the position of the last occurrence of a bit that has a specified value in the specified range.
void	Flip() Toggles the value of every bit.
void	Flip(int pos) Toggles the value of the bit at a specified position.
void	Flip(int first, int last) Toggles the value of every bit the range [first, last).
static BitInt32	FromInt32(int convertFrom) Explicit conversion from Int32 to BitInt32.
boolean	Get(int pos) Gets the value of the bit at a specified position.
static boolean	GreaterThan(BitInt32 x, BitInt32 y) Tests whether the value of a specified BitInt32 structure is greater than another value of BitInt32 structure.
static boolean	GreaterThanOrEqual(BitInt32 x, BitInt32 y) Tests whether the value of a specified BitInt32 structure is greater than or equal to another value of BitInt32 structure.
int	hashCode() Returns the hash code for this instance.
static BitInt32	LeftShift(BitInt32 x, int count) Shifts the bits in a BitInt32 to the left a specified number of positions and returns the result.
void	LeftShift(int count) Shifts the bits in the current instance to the left a specified number of positions.
static boolean	LessThan(BitInt32 x, BitInt32 y) Tests whether the value of a specified BitInt32 structure is less than another value of BitInt32 structure.
static boolean	LessThanOrEqual(BitInt32 x, BitInt32 y) Tests whether the value of a specified BitInt32 structure is less than or equal to another value of BitInt32 structure.
static BitInt32	MaxValue() Represents the largest possible value of BitInt32 (all bits set to 1).
static BitInt32	MinValue() Represents the smallest possible value of BitInt32 (all bits set to 0).
boolean	None() Tests if none of the bits have been set to 1.
boolean	None(boolean value) Tests if none of the bits have been set to the specified value.
boolean	None(int first, int last) Tests if none of the bits have been set to 1 in the specified range.
boolean	None(int first, int last, boolean value) Tests if none of the bits have been set to the specified value in the specified range.
static boolean	NotEqual(BitInt32 x, BitInt32 y) Performs a logical comparison of the two BitInt32 parameters to determine if they are equal.
static BitInt32	OnesComplement(BitInt32 x) Inverts all the bits in a target BitInt32 and returns the result.
static BitInt32	Parse(java.lang.String item) Converts the String representation of an array of bits to its BitInt32 equivalent.
void	Reset() Sets every bit to 0.
void	Reset(int pos) Sets the bit at a specified position to 0.
void	Reset(int first, int last) Sets every bit to 0 in the range [first, last).
static BitInt32	RightShift(BitInt32 x, int count) Shifts the bits in a BitInt32 to the right a specified number of positions and returns the result.
void	RightShift(int count) Shifts the bits in the current instance to the right a specified number of positions.
void	Set() Sets every bit to 1.
void	Set(int pos) Sets the bit at a specified position to 1.
void	Set(int first, int last) Sets every bit to 1 in the range [first, last).
void	SetValue(int value) Sets the signed value of the BitInt32.
static int	ToInt32(BitInt32 convertFrom) Explicit conversion from BitInt32 to Int32.
java.lang.String	toString() Converts the bit values to their equivalent String representation.
int	Value() Gets the signed value of the BitInt32.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

Size

public static final int Size

Returns the number of bits. This field is constant.

See Also:

Constant Field Values

Log2Size

public static final int Log2Size

Returns the Log2(Size). This field is constant.

See Also:

Constant Field Values

Constructor Detail

BitInt32

public BitInt32()

Initializes a new instance of the BitInt32 with all bits set to false.

BitInt32

public BitInt32(boolean value)

Initializes a new instance of the BitInt32 with all bits set to the specified bit value.

Parameters:

value - The value of the bits in the new BitInt32.

BitInt32

public BitInt32(int value)

Initializes a new instance of the BitInt32 with the specified Int32 value.

Parameters:

value - The value of the Int32 in the new BitInt32.

BitInt32

public BitInt32(java.lang.String item)

Initializes a new instance of the BitInt32 structure using the supplied String value.

Parameters:

item - The String to be converted.

Throws:

java.lang.RuntimeException - If the String does not contain a parsable int.

BitInt32

public BitInt32(BitInt32 x)

Initializes a new instance of the BitInt32 structure using the supplied BitInt32 value.

Parameters:

x - The BitInt32 to be copied.

Method Detail

Value

public int Value()

Gets the signed value of the BitInt32.

Returns:

The signed value of the BitInt32.

SetValue

public void SetValue(int value)

Sets the signed value of the BitInt32.

Parameters:

value - The signed value of the BitInt32.

MinValue

public static BitInt32 MinValue()

Represents the smallest possible value of BitInt32 (all bits set to 0).

Returns:

The smallest possible value of BitInt32.

MaxValue

public static BitInt32 MaxValue()

Represents the largest possible value of BitInt32 (all bits set to 1).

Returns:

The largest possible value of BitInt32.

Get

public boolean Get(int pos)

Gets the value of the bit at a specified position.

Parameters:

pos - The position of the bit to be tested for its value.

Returns:

True if the bit specified by the argument position is set to 1; otherwise, false.

Throws:

java.lang.RuntimeException - Thrown when the specified position is out of [0, Size - 1] range.

Set

public void Set()

Sets every bit to 1.

Set

public void Set(int pos)

Sets the bit at a specified position to 1.

Parameters:

pos - The position of the bit to be set to 1.

Throws:

java.lang.RuntimeException - Thrown when the specified position is out of [0, Size - 1] range.

Set

public void Set(int first,
       int last)

Sets every bit to 1 in the range [first, last).

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1].

Reset

public void Reset()

Sets every bit to 0.

Reset

public void Reset(int pos)

Sets the bit at a specified position to 0.

Parameters:

pos - The position of the bit to be set to 0.

Throws:

java.lang.RuntimeException - Thrown when the specified position is out of [0, Size - 1] range.

Reset

public void Reset(int first,
         int last)

Sets every bit to 0 in the range [first, last).

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1] range.

Flip

public void Flip()

Toggles the value of every bit.

Flip

public void Flip(int pos)

Toggles the value of the bit at a specified position.

Parameters:

pos - The position of the bit to be toggled.

Throws:

java.lang.RuntimeException - Thrown when the specified position is out of [0, Size - 1] range.

Flip

public void Flip(int first,
        int last)

Toggles the value of every bit the range [first, last).

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1] range.

Count

public int Count(boolean value)

Returns the number of bits with a specified value.

Parameters:

value - The bit value to be counted.

Returns:

The number of bits with the value specified in the argument.

Count

public int Count(int first,
        int last,
        boolean value)

Counts the number of bits with a specified value in the specified range.

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

value - The bit value to be counted.

Returns:

The number of bits in the specified range with the specified value.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1] range

Any

public boolean Any()

Tests whether any bit is set to 1.

Returns:

True if any bit in the bitset is set to 1; false if all the bits are 0.

Any

public boolean Any(boolean value)

Tests whether any bit is set to the specified value.

Parameters:

value - The value to be tested.

Returns:

True if any bit in the bitset is set to the specified value; false if all the bits are different than the specified value.

Any

public boolean Any(int first,
          int last)

Tests whether any bit is set to 1 in the specified range.

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

Returns:

True if any bit in the bitset is set to 1 in the specified range; false if all the bits are 0 in the specified range.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1] range.

Any

public boolean Any(int first,
          int last,
          boolean value)

Tests whether any bit is set to the specified value in the specified range.

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

value - The value to be tested.

Returns:

True if any bit in the bitset is set to the specified value in the specified range; false if all the bits in the specified range are different than the specified value.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1] range.

None

public boolean None()

Tests if none of the bits have been set to 1.

Returns:

True if none of the bits in the bitset have been set to 1; false if at least one bit has been set to 1.

None

public boolean None(boolean value)

Tests if none of the bits have been set to the specified value.

Parameters:

value - The value to be tested.

Returns:

True if none of the bits in the bitset have been set to the specified value; false if at least one bit has been set to the specified value.

None

public boolean None(int first,
           int last)

Tests if none of the bits have been set to 1 in the specified range.

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

Returns:

True if none of the bits in the bitset have been set to 1 in the specified range; false if at least one bit has been set to 1 in the specified range.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1] range.

None

public boolean None(int first,
           int last,
           boolean value)

Tests if none of the bits have been set to the specified value in the specified range.

Parameters:

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

value - The value to be tested.

Returns:

True if none of the bits in the bitset have been set to the specified value in the specified range; false if at least one bit has been set to the specified value in the specified range.

Throws:

java.lang.RuntimeException - Thrown when first is out of [0, Size - 1] range.

FindFirst

public int FindFirst(boolean value)

Locates the position of the first occurrence of a bit that has a specified value.

Parameters:

value - The value to be searched for.

Returns:

An integer indicating the first occurrence of the specified bit. If no such value exists, the return value is Size.

FindFirst

public int FindFirst(int startWith,
            boolean value)

Locates the position of the first occurrence of a bit that has a specified value.

Parameters:

startWith - Index of the position where the search is to begin.

value - The value to be searched for.

Returns:

An integer indicating the first occurrence of the specified bit. If no such value exists, the return value is Size.

Throws:

java.lang.RuntimeException - Thrown when the specified position is out of [0, Size - 1] range.

FindFirst

public int FindFirst(int first,
            int last,
            boolean value)

Locates the position of the first occurrence of a bit that has a specified value in the specified range.

Parameters:

value - The value to be searched for.

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

Returns:

An integer indicating the first occurrence of the specified bit in the specified range. If no such value exists, the return value is last.

Throws:

java.lang.RuntimeException - Thrown when first or last is out of [0, Size - 1] range.

FindLast

public int FindLast(boolean value)

Locates the position of the last occurrence of a bit that has a specified value.

Parameters:

value - The value to be searched for.

Returns:

An integer indicating the last occurrence of the specified bit. If no such value exists, the return value is Size.

FindLast

public int FindLast(int startWith,
           boolean value)

Locates the position of the last occurrence of a bit that has a specified value.

Parameters:

startWith - Index of the position where the search is to begin.

value - The value to be searched for.

Returns:

An integer indicating the last occurrence of the specified bit. If no such value exists, the return value is Size.

Throws:

java.lang.RuntimeException - Thrown when the specified position is out of [0, Size - 1] range.

FindLast

public int FindLast(int first,
           int last,
           boolean value)

Locates the position of the last occurrence of a bit that has a specified value in the specified range.

Parameters:

value - The value to be searched for.

first - Position of the first bit in the range.

last - Position that is one past the final bit in the range.

Returns:

An integer indicating the last occurrence of the specified bit in the specified range. If no such value exists, the return value is last.

Throws:

java.lang.RuntimeException - Thrown when first or last is out of [0, Size - 1] range.

toString

public java.lang.String toString()

Converts the bit values to their equivalent String representation.

Remarks: The first character in the String represents the first MSB set to one and the last character in the String represents the LSB.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of the bit values of this instance.

Parse

public static BitInt32 Parse(java.lang.String item)

Converts the String representation of an array of bits to its BitInt32 equivalent.

Remarks: The first character in the String represents the first MSB set to one and the last character in the String represents the LSB.

Parameters:

item - A String containing an array of bits to convert.

Returns:

A BitInt32 equivalent to the array of bits contained in item.

Throws:

java.lang.RuntimeException - If the String does not contain a parsable BitInt32.

equals

public boolean equals(java.lang.Object obj)

Tests whether this instance is equal to a specified object.

Overrides:

equals in class java.lang.Object

Parameters:

obj - An object to compare with this instance.

Returns:

True if obj is an instance of BitInt32 and equals the value of this instance; otherwise, false.

hashCode

public int hashCode()

Returns the hash code for this instance.

Overrides:

hashCode in class java.lang.Object

Returns:

A 32-bit signed integer hash code.

equals

public boolean equals(BitInt32 other)

Tests whether this instance is equal to a specified BitInt32.

Parameters:

other - A BitInt32 to compare with this instance.

Returns:

True if the specified BitInt32 equals the value of this instance; otherwise, false.

Equals

public boolean Equals(BitInt32 other)

Tests whether this instance is equal to a specified BitInt32.

Specified by:

Equals in interface IEquatable<BitInt32>

Parameters:

other - A BitInt32 to compare with this instance.

Returns:

True if the specified BitInt32 equals the value of this instance; otherwise, false.

compareTo

public int compareTo(BitInt32 other)

Compares this instance to a specified BitInt32 and returns an indication of their relative values.

Specified by:

compareTo in interface java.lang.Comparable<BitInt32>

Parameters:

other - An object to compare, or a null reference.

Returns:

Equal

public static boolean Equal(BitInt32 x,
            BitInt32 y)

Performs a logical comparison of the two BitInt32 parameters to determine if they are equal.

Parameters:

x - The left operand in the equality to be tested.

y - The right operand in the equality to be tested.

Returns:

True if x and y are equal; otherwise, false.

NotEqual

public static boolean NotEqual(BitInt32 x,
               BitInt32 y)

Performs a logical comparison of the two BitInt32 parameters to determine if they are equal.

Parameters:

x - The left operand in the equality to be tested.

y - The right operand in the equality to be tested.

Returns:

True if x and y are not equal; otherwise, false.

LessThan

public static boolean LessThan(BitInt32 x,
               BitInt32 y)

Tests whether the value of a specified BitInt32 structure is less than another value of BitInt32 structure.

Parameters:

x - The left operand in the inequality to be tested.

y - The right operand in the inequality to be tested.

Returns:

True if x is less than y; otherwise, false.

GreaterThan

public static boolean GreaterThan(BitInt32 x,
                  BitInt32 y)

Tests whether the value of a specified BitInt32 structure is greater than another value of BitInt32 structure.

Parameters:

x - The left operand in the inequality to be tested.

y - The right operand in the inequality to be tested.

Returns:

True if x is greater than y; otherwise, false.

LessThanOrEqual

public static boolean LessThanOrEqual(BitInt32 x,
                      BitInt32 y)

Tests whether the value of a specified BitInt32 structure is less than or equal to another value of BitInt32 structure.

Parameters:

x - The left operand in the inequality to be tested.

y - The right operand in the inequality to be tested.

Returns:

True if x is less than or equal to y; otherwise, false.

GreaterThanOrEqual

public static boolean GreaterThanOrEqual(BitInt32 x,
                         BitInt32 y)

Tests whether the value of a specified BitInt32 structure is greater than or equal to another value of BitInt32 structure.

Parameters:

x - The left operand in the inequality to be tested.

y - The right operand in the inequality to be tested.

Returns:

True if x is greater than or equal to y; otherwise, false.

BitwiseAnd

public static BitInt32 BitwiseAnd(BitInt32 x,
                  BitInt32 y)

Performs the bitwise AND operation.

Parameters:

x - The left operand in the bitwise AND operation.

y - The right operand in the bitwise AND operation.

Returns:

The bitwise AND of the values of x and y.

AssignAnd

public void AssignAnd(BitInt32 x)

Performs the bitwise AND operation and assigns the result to the current instance.

Parameters:

x - The right operand in the bitwise AND operation.

BitwiseOr

public static BitInt32 BitwiseOr(BitInt32 x,
                 BitInt32 y)

Performs the bitwise OR operation.

Parameters:

x - The left operand in the bitwise OR operation.

y - The right operand in the bitwise OR operation.

Returns:

The bitwise OR of the values of x and y.

AssignOr

public void AssignOr(BitInt32 x)

Performs the bitwise OR operation and assigns the result to the current instance.

Parameters:

x - The right operand in the bitwise OR operation.

BitwiseXor

public static BitInt32 BitwiseXor(BitInt32 x,
                  BitInt32 y)

Performs the bitwise eXclusive OR operation.

Parameters:

x - The left operand in the bitwise eXclusive OR operation.

y - The right operand in the bitwise eXclusive OR operation.

Returns:

The bitwise eXclusive OR of the values of x and y.

AssignXor

public void AssignXor(BitInt32 x)

Performs the bitwise eXclusive OR operation and assigns the result to the current instance.

Parameters:

x - The right operand in the bitwise eXclusive OR operation.

OnesComplement

public static BitInt32 OnesComplement(BitInt32 x)

Inverts all the bits in a target BitInt32 and returns the result.

Parameters:

x - The operand in the bitwise complement operation.

Returns:

The bitwise complement of the value of x.

LeftShift

public static BitInt32 LeftShift(BitInt32 x,
                 int count)

Shifts the bits in a BitInt32 to the left a specified number of positions and returns the result.

Parameters:

x - A BitInt32 object whose bit values are to be shifted.

count - The number of positions to the left the bits are to be shifted.

Returns:

A new BitInt32 where the bits have been shifted to the left the required number of positions relative to the targeted BitInt32.

LeftShift

public void LeftShift(int count)

Shifts the bits in the current instance to the left a specified number of positions.

Parameters:

count - The number of positions to the left the bits are to be shifted.

RightShift

public static BitInt32 RightShift(BitInt32 x,
                  int count)

Shifts the bits in a BitInt32 to the right a specified number of positions and returns the result.

Parameters:

x - A BitInt32 object whose bit values are to be shifted.

count - The number of positions to the right the bits are to be shifted.

Returns:

A new BitInt32 where the bits have been shifted to the right the required number of positions relative to the targeted BitInt32.

RightShift

public void RightShift(int count)

Shifts the bits in the current instance to the right a specified number of positions.

Parameters:

count - The number of positions to the right the bits are to be shifted.

FromInt32

public static BitInt32 FromInt32(int convertFrom)

Explicit conversion from Int32 to BitInt32.

Parameters:

convertFrom - The Int32 value to be converted.

Returns:

A new BitInt32 converted from a specified Int32 value.

ToInt32

public static int ToInt32(BitInt32 convertFrom)

Explicit conversion from BitInt32 to Int32.

Parameters:

convertFrom - The BitInt32 value to be converted.

Returns:

A new Int32 converted from a specified BitInt32 value.

Allocate

public int Allocate(int startWith)

Locates the position of the first occurrence of a 0 bit and sets this bit to 1.

Parameters:

startWith - Index of the position where the allocate is to begin.

Returns:

An integer indicating the position of the allocated bit. If no such value exists, the return value is Size.

Throws:

java.lang.RuntimeException - Thrown when the specified position is out of [0, Size - 1] range.