org.dishevelled.matrix

Class BitMatrix1D

java.lang.Object

org.dishevelled.matrix.BitMatrix1D

public final class BitMatrix1D
extends Object

Fixed size bit matrix in one dimension, indexed by longs.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
BitMatrix1D(long size) Create a new 1D bit matrix of the specified size.

Method Summary

Methods

Modifier and Type	Method and Description
BitMatrix1D	and(BitMatrix1D other) Perform a logical AND of this 1D bit matrix and the specified 1D bit matrix.
BitMatrix1D	andNot(BitMatrix1D other) Clear all of the bits in this 1D bit matrix whose corresponding bit is set in the specified 1D bit matrix.
BitMatrix1D	assign(boolean value) Assign all values in this 1D bit matrix to value.
long	cardinality() Return the cardinality of this 1D bit matrix, the number of bits set to true.
void	clear() Clear all the values in this 1D bit matrix.
boolean	equals(Object o)
void	flip(long index) Set the bit value at the specified index to the complement of its current bit value.
void	flip(long index0, long index1) Set all of the bit values from index0, inclusive, to index1, exclusive, to the complement of their current bit values.
void	flipQuick(long index) Set the bit value at the specified index to the complement of its current bit value without checking bounds.
void	forEach(boolean value, UnaryProcedure<Long> procedure) Apply the specified procedure to each index in this 1D bit matrix with a bit equal to the specified value.
boolean	get(long index) Return the bit value at the specified index.
boolean	getQuick(long index) Return the bit value at the specified index without checking bounds.
int	hashCode()
boolean	intersects(BitMatrix1D other) Return true if the specified 1D bit matrix has any bits set to true that are also set to true in this 1D bit matrix.
boolean	isEmpty() Return true if the cardinality of this 1D bit matrix is zero.
BitMatrix1D	or(BitMatrix1D other) Perform a logical OR of this 1D bit matrix and the specified 1D bit matrix.
void	set(long index, boolean value) Set the bit value at the specified index to value.
void	set(long index0, long index1, boolean value) Set all of the bit values from index0, inclusive, to index1, exclusive, to the specified value.
void	setQuick(long index, boolean value) Set the bit value at the specified index to value without checking bounds.
long	size() Return the size of this 1D bit matrix.
BitMatrix1D	xor(BitMatrix1D other) Perform a logical XOR of this 1D bit matrix and the specified 1D bit matrix.

Methods inherited from class java.lang.Object

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

Constructor Detail

BitMatrix1D

public BitMatrix1D(long size)

Create a new 1D bit matrix of the specified size.

Parameters:

size - size, must be >= 0

Throws:

IllegalArgumentException - if size is negative

Method Detail

size

public long size()

Return the size of this 1D bit matrix.

Returns:

the size of this 1D bit matrix

cardinality

public long cardinality()

Return the cardinality of this 1D bit matrix, the number of bits set to true.

Returns:

the cardinality of this 1D bit matrix

isEmpty

public boolean isEmpty()

Return true if the cardinality of this 1D bit matrix is zero.

Returns:

true if the cardinality of this 1D bit matrix is zero

clear

public void clear()

Clear all the values in this 1D bit matrix.

get

public boolean get(long index)

Return the bit value at the specified index.

Parameters:

index - index, must be >= 0 and < size()

Returns:

the bit value at the specified index

Throws:

IndexOutOfBoundsException - if index is negative or if index is greater than or equal to size()

getQuick

public boolean getQuick(long index)

Return the bit value at the specified index without checking bounds.

Parameters:

index - index

Returns:

the bit value at the specified index

set

public void set(long index,
       boolean value)

Set the bit value at the specified index to value.

Parameters:

index - index, must be >= 0 and < size()

value - value

Throws:

IndexOutOfBoundsException - if index is negative or if index is greater than or equal to size()

setQuick

public void setQuick(long index,
            boolean value)

Set the bit value at the specified index to value without checking bounds.

Parameters:

index - index

value - value

set

public void set(long index0,
       long index1,
       boolean value)

Set all of the bit values from index0, inclusive, to index1, exclusive, to the specified value.

Parameters:

index0 - first index, must be >= 0 and < size()

index1 - second index, must be >= 0, <= size() and >= index0

value - value

Throws:

IllegalArgumentException - if index1 is less than index0

IndexOutOfBoundsException - if either index0 or index1 are negative or if index0 is greater than or equal to size() or if index1 is strictly greater than size()

flip

public void flip(long index)

Set the bit value at the specified index to the complement of its current bit value.

Parameters:

index - index, must be >= 0 and < size()

Throws:

IndexOutOfBoundsException - if index is negative or if index is greater than or equal to size()

flipQuick

public void flipQuick(long index)

Set the bit value at the specified index to the complement of its current bit value without checking bounds.

Parameters:

index - index

flip

public void flip(long index0,
        long index1)

Set all of the bit values from index0, inclusive, to index1, exclusive, to the complement of their current bit values.

Parameters:

index0 - first index, must be >= 0 and < size()

index1 - second index, must be >= 0, <= size() and >= index0

Throws:

IllegalArgumentException - if index1 is less than index0

IndexOutOfBoundsException - if either index0 or index1 are negative or if index0 is greater than or equal to size() or if index1 is strictly greater than size()

assign

public BitMatrix1D assign(boolean value)

Assign all values in this 1D bit matrix to value.

Parameters:

value - value

Returns:

this 1D bit matrix, for convenience

intersects

public boolean intersects(BitMatrix1D other)

Return true if the specified 1D bit matrix has any bits set to true that are also set to true in this 1D bit matrix.

Parameters:

other - other 1D bit matrix, must not be null and must be the same size as this 1D bit matrix

Returns:

true if the specified 1D bit matrix has any bits set to true that are also set to true in this 1D bit matrix

Throws:

IllegalArgumentException - if other is null or if other is not the same size as this

and

public BitMatrix1D and(BitMatrix1D other)

Perform a logical AND of this 1D bit matrix and the specified 1D bit matrix.

Parameters:

other - other 1D bit matrix, must not be null and must be the same size as this 1D bit matrix

Returns:

this 1D bit matrix, for convenience

Throws:

IllegalArgumentException - if other is null or if other is not the same size as this

andNot

public BitMatrix1D andNot(BitMatrix1D other)

Clear all of the bits in this 1D bit matrix whose corresponding bit is set in the specified 1D bit matrix.

Parameters:

other - other 1D bit matrix, must not be null and must be the same size as this 1D bit matrix

Returns:

this 1D bit matrix, for convenience

Throws:

IllegalArgumentException - if other is null or if other is not the same size as this

or

public BitMatrix1D or(BitMatrix1D other)

Perform a logical OR of this 1D bit matrix and the specified 1D bit matrix.

Parameters:

other - other 1D bit matrix, must not be null and must be the same size as this 1D bit matrix

Returns:

this 1D bit matrix, for convenience

Throws:

IllegalArgumentException - if other is null or if other is not the same size as this

xor

public BitMatrix1D xor(BitMatrix1D other)

Perform a logical XOR of this 1D bit matrix and the specified 1D bit matrix.

Parameters:

other - other 1D bit matrix, must not be null and must be the same size as this 1D bit matrix

Returns:

this 1D bit matrix, for convenience

Throws:

IllegalArgumentException - if other is null or if other is not the same size as this

forEach

public void forEach(boolean value,
           UnaryProcedure<Long> procedure)

Apply the specified procedure to each index in this 1D bit matrix with a bit equal to the specified value.

Parameters:

value - value

procedure - procedure, must not be null

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object