com.heirloomcomputing.epli.runtime

Class BitN

java.lang.Object

java.util.BitSet

com.heirloomcomputing.epli.runtime.BitN

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Comparable<java.lang.Object>

public final class BitN
extends java.util.BitSet
implements java.lang.Comparable<java.lang.Object>

BitN - immutable Java class implementation of the PL/I BIT(n) data type. The built-in type java.util.BitSet could have been used directly for this class if they handled "IBM EBCDIC bit" nomenclature instead of "Java ASCII bit" nomenclature. in java.util.BitSet the valueOf() parameter "new byte[]{0x7f}" is {0,1,2,3,4,5,6} (bits numbered from right to left) rather than {1,2,3,4,5,6,7} (bits numbered from left to right). So, this class could also be called BitSetRev, with the same methods as BitSet but with reverse-bit byte ordering. thus, we can extend java.util.BitSet, reinterpreting all the bit-numbering methods as reversing the bits but note that "super", the BitSet, is used to store and manipulate the bits

Author:

Heirloom Computing, Inc.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
BitN() constructor - construct a BIT(0), which is unusable for any purpose
BitN(BitN inBits) copy constructor of BIT(n).
BitN(java.util.BitSet set, int n) constructor - construct a BIT(n) from a BitSet (copy constructor not part of a BitSet)
BitN(byte[] bytes, int n) constructor - construct a BIT(n) from a long[] array converting the longs from little-endian to big-endian
BitN(int n) constructor - construct a BIT(n), with all bits set to '0'B
BitN(long[] longs, int n) constructor - construct a BIT(n) from a long[] array converting the longs from little-endian to big-endian
BitN(java.lang.String str, int n) constructor - construct a BIT(n) from a String assumed to be in BITCONSTANT form

Method Summary

Modifier and Type	Method and Description
int	cardinality() cardinality - Returns the number of bits set to true in this BitSet.
void	clear() clear - Sets all of the bits in this BitSet to false.
void	clear(int bitIndex) clear - Sets one of the bits in this BitSet to false.
void	clear(int fromBigEndianBit, int toBigEndianBit) clear - Sets a range of bits in this BitSet to false.
int	compareTo(java.lang.Object arg) compareTo - compare two BitN objects
void	flip(int bitIndex) flip - Sets the bit at the specified index to the complement of its current value.
void	flip(int fromBigEndianBit, int toBigEndianBit) flip - Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.
boolean	get(int bitIndex) get - Returns the value of the bit with the specified index.
BitN	get(int fromBigEndianBit, int toBigEndianBit) get - Returns a new BitSet composed of bits from this BitSet from fromIndex (inclusive) to toIndex (exclusive).
int	length() length - Returns the "logical size" of this BitSet: the index of the highest set bit in the BitSet plus one.
static void	main(java.lang.String[] args) main - unit test for Picture
int	nextClearBit(int fromIndex) nextClearBit - Returns the index of the first bit that is set to false that occurs on or after the specified starting index.
int	nextSetBit(int fromIndex) nextSetBit - Returns the index of the first bit that is set to true that occurs on or after the specified starting index.
int	previousClearBit(int fromIndex) previousClearBit - Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index.
int	previousSetBit(int fromIndex) previousSetBit - Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index.
void	set(int bitIndex) set - Sets one of the bits in this BitSet to true.
void	set(int fromBigEndianBit, int toBigEndianBit) set - Sets a range of bits in this BitSet to true.
void	set(int fromBigEndianBit, int toBigEndianBit, boolean value) set - Sets a range of bits in this BitSet to a value.
int	size() size - Returns the number of bits of space actually in use by this BitN to represent bit values.
java.lang.String	toString() toString - return a display representation of an PLI representation of the BIT(n)
static BitN	valueOf(byte[] bytes) valueOf - Returns a new bit set containing all the bits in the given byte array.
static BitN	valueOf(java.nio.ByteBuffer bb) valueOf - Returns a new bit set containing all the bits in the given byte buffer between its position and limit.
static BitN	valueOf(long[] longs) valueOf - Returns a new bit set containing all the bits in the given byte array.
static BitN	valueOf(java.nio.LongBuffer lb) valueOf - Returns a new bit set containing all the bits in the given byte buffer between its position and limit.

Methods inherited from class java.util.BitSet

and, andNot, clone, equals, hashCode, intersects, isEmpty, or, set, stream, toByteArray, toLongArray, xor

Methods inherited from class java.lang.Object

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

Constructor Detail

BitN

public BitN()

constructor - construct a BIT(0), which is unusable for any purpose

BitN

public BitN(int n)

constructor - construct a BIT(n), with all bits set to '0'B

Parameters:

n - - the size of this BIT(n)

BitN

public BitN(java.util.BitSet set,
            int n)

constructor - construct a BIT(n) from a BitSet (copy constructor not part of a BitSet)

Parameters:

set - - the BitSet from which to construct

n - - the number of bits to maintain in this BIT(n)

BitN

public BitN(long[] longs,
            int n)

constructor - construct a BIT(n) from a long[] array converting the longs from little-endian to big-endian

Parameters:

longs - - long[] containing little-endian values for the BitN

n - - the number of bits to maintain in this BIT(n)

BitN

public BitN(byte[] bytes,
            int n)

constructor - construct a BIT(n) from a long[] array converting the longs from little-endian to big-endian

Parameters:

bytes - - byte[] containing little-endian values for the BitN

n - - the number of bits to maintain in this BIT(n)

BitN

public BitN(java.lang.String str,
            int n)

constructor - construct a BIT(n) from a String assumed to be in BITCONSTANT form

Parameters:

str - - String containing '00_0 101'B

n - - the number of bits to maintain in this BIT(n)

BitN

public BitN(BitN inBits)

copy constructor of BIT(n).

Parameters:

inBits - - input BitN

Method Detail

cardinality

public int cardinality()

cardinality - Returns the number of bits set to true in this BitSet. return int - number of bits set to true

Overrides:

cardinality in class java.util.BitSet

clear

public void clear()

clear - Sets all of the bits in this BitSet to false.

Overrides:

clear in class java.util.BitSet

clear

public void clear(int bitIndex)

clear - Sets one of the bits in this BitSet to false.

Overrides:

clear in class java.util.BitSet

clear

public void clear(int fromBigEndianBit,
                  int toBigEndianBit)

clear - Sets a range of bits in this BitSet to false.

Overrides:

clear in class java.util.BitSet

compareTo

public int compareTo(java.lang.Object arg)

compareTo - compare two BitN objects

Specified by:

compareTo in interface java.lang.Comparable<java.lang.Object>

Parameters:

arg - - another BitN to compare with

Returns:

an int = 0 if compare equally; -1 if arg is less than this, +1 if arg is greater than this

flip

public void flip(int bitIndex)

flip - Sets the bit at the specified index to the complement of its current value.

Overrides:

flip in class java.util.BitSet

flip

public void flip(int fromBigEndianBit,
                 int toBigEndianBit)

flip - Sets each bit from the specified fromIndex (inclusive) to the specified toIndex (exclusive) to the complement of its current value.

Overrides:

flip in class java.util.BitSet

get

public boolean get(int bitIndex)

get - Returns the value of the bit with the specified index.

Overrides:

get in class java.util.BitSet

get

public BitN get(int fromBigEndianBit,
                int toBigEndianBit)

get - Returns a new BitSet composed of bits from this BitSet from fromIndex (inclusive) to toIndex (exclusive).

Overrides:

get in class java.util.BitSet

length

public int length()

length - Returns the "logical size" of this BitSet: the index of the highest set bit in the BitSet plus one.

Overrides:

length in class java.util.BitSet

nextClearBit

public int nextClearBit(int fromIndex)

nextClearBit - Returns the index of the first bit that is set to false that occurs on or after the specified starting index.

Overrides:

nextClearBit in class java.util.BitSet

Parameters:

fromIndex - - start looking at this index

nextSetBit

public int nextSetBit(int fromIndex)

nextSetBit - Returns the index of the first bit that is set to true that occurs on or after the specified starting index.

Overrides:

nextSetBit in class java.util.BitSet

Parameters:

fromIndex - - start looking at this index

previousClearBit

public int previousClearBit(int fromIndex)

previousClearBit - Returns the index of the nearest bit that is set to false that occurs on or before the specified starting index.

Overrides:

previousClearBit in class java.util.BitSet

Parameters:

fromIndex - - start looking at this index

previousSetBit

public int previousSetBit(int fromIndex)

previousSetBit - Returns the index of the nearest bit that is set to true that occurs on or before the specified starting index.

Overrides:

previousSetBit in class java.util.BitSet

Parameters:

fromIndex - - start looking at this index

set

public void set(int bitIndex)

set - Sets one of the bits in this BitSet to true.

Overrides:

set in class java.util.BitSet

set

public void set(int fromBigEndianBit,
                int toBigEndianBit)

set - Sets a range of bits in this BitSet to true.

Overrides:

set in class java.util.BitSet

set

public void set(int fromBigEndianBit,
                int toBigEndianBit,
                boolean value)

set - Sets a range of bits in this BitSet to a value.

Overrides:

set in class java.util.BitSet

size

public int size()

size - Returns the number of bits of space actually in use by this BitN to represent bit values.

Overrides:

size in class java.util.BitSet

toString

public java.lang.String toString()

toString - return a display representation of an PLI representation of the BIT(n)

Overrides:

toString in class java.util.BitSet

valueOf

public static BitN valueOf(byte[] bytes)

valueOf - Returns a new bit set containing all the bits in the given byte array.

Parameters:

bytes - - byte array to initialize

a - BitN representing the bits in byte[]

valueOf

public static BitN valueOf(java.nio.ByteBuffer bb)

valueOf - Returns a new bit set containing all the bits in the given byte buffer between its position and limit.

valueOf

public static BitN valueOf(long[] longs)

valueOf - Returns a new bit set containing all the bits in the given byte array.

Parameters:

longs - - long array to initialize

a - BitN representing the bits in byte[]

valueOf

public static BitN valueOf(java.nio.LongBuffer lb)

valueOf - Returns a new bit set containing all the bits in the given byte buffer between its position and limit.

main

public static void main(java.lang.String[] args)

main - unit test for Picture

Parameters:

args - - the real & imaginary part of operand "a" and "b", respectively