org.dishevelled.matrix

Class BitMatrix2D

java.lang.Object

org.dishevelled.matrix.BitMatrix2D

public final class BitMatrix2D
extends Object

Fixed size bit matrix in two dimensions, indexed by longs.

Author:

Michael Heuer

Constructor Summary

Constructors

Constructor and Description
BitMatrix2D(long rows, long columns) Create a new 2D bit matrix with the specified number of rows and columns.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BitMatrix2D

public BitMatrix2D(long rows,
           long columns)

Create a new 2D bit matrix with the specified number of rows and columns.

Parameters:

rows - number of rows, must be >= 0

columns - number of columns, must be >= 0

Throws:

IllegalArgumentException - if either rows or columns is negative

Method Detail

size

public long size()

Return the size of this 2D bit matrix.

Returns:

the size of this 2D bit matrix

rows

public long rows()

Return the number of rows in this 2D bit matrix.

Returns:

the number of rows in this 2D bit matrix

columns

public long columns()

Return the number of columns in this 2D bit matrix.

Returns:

the number of columns in this 2D bit matrix

cardinality

public long cardinality()

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

Returns:

the cardinality of this 2D bit matrix

isEmpty

public boolean isEmpty()

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

Returns:

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

clear

public void clear()

Clear all the values in this 2D bit matrix.

get

public boolean get(long row,
          long column)

Return the bit value at the specified row and column.

Parameters:

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

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

Returns:

the bit value at the specified row and column

Throws:

IndexOutOfBoundsException - if row or column is negative or if row or column is greater than or equal to rows() or columns(), respectively

getQuick

public boolean getQuick(long row,
               long column)

Return the bit value at the specified row and column without checking bounds.

Parameters:

row - row index

column - column index

Returns:

the bit value at the specified row and column

set

public void set(long row,
       long column,
       boolean value)

Set the bit value at the specified row and column to value.

Parameters:

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

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

value - value

Throws:

IndexOutOfBoundsException - if row or column is negative or if row or column is greater than or equal to rows() or columns(), respectively

setQuick

public void setQuick(long row,
            long column,
            boolean value)

Set the bit value at the specified row and column to value without checking bounds.

Parameters:

row - row index

column - column index

value - value

set

public void set(long row0,
       long column0,
       long row1,
       long column1,
       boolean value)

Set all of the bit values from (row0, column0), inclusive, to (row1, column1), exclusive, to the specified value.

Parameters:

row0 - first row, must be >= 0 and < rows()

column0 - first column, must be >= 0 and < columns()

row1 - second row, must be >= 0, <= rows() and >= row0

column1 - second column, must be >= 0, <= columns() and >= column0

value - value

Throws:

IllegalArgumentException - if either row1 or column1 are less than row0 or column0, respectively

IndexOutOfBoundsException - if any of row0, column0, row1, or column1 are negative or if either row0 or column0 are greater than or equal to rows() or columns(), respectively, or if either row1 or column1 are strictly greater than rows() or columns(), respectively

flip

public void flip(long row,
        long column)

Set the bit value at the specified row and column to the complement of its current bit value.

Parameters:

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

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

Throws:

IndexOutOfBoundsException - if row or column is negative or if row or column is greater than or equal to rows() or columns(), respectively

flipQuick

public void flipQuick(long row,
             long column)

Set the bit value at the specified row and column to the complement of its current bit value without checking bounds.

Parameters:

row - row index

column - column index

flip

public void flip(long row0,
        long column0,
        long row1,
        long column1)

Set all of the bit values from (row0, column0), inclusive, to (row1, column1), exclusive, to the complement of their current bit values.

Parameters:

row0 - first row, must be >= 0 and < rows()

column0 - first column, must be >= 0 and < columns()

row1 - second row, must be >= 0, <= rows() and >= row0

column1 - second column, must be >= 0, <= columns() and >= column0

Throws:

IllegalArgumentException - if either row1 or column1 are less than row0 or column0, respectively

IndexOutOfBoundsException - if any of row0, column0, row1, or column1 are negative or if either row0 or column0 are greater than or equal to rows() or columns(), respectively, or if either row1 or column1 are strictly greater than rows() or columns(), respectively

assign

public BitMatrix2D assign(boolean value)

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

Parameters:

value - value

Returns:

this 2D bit matrix, for convenience

intersects

public boolean intersects(BitMatrix2D other)

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

Parameters:

other - other 2D bit matrix, must not be null and must have the same dimensions as this 2D bit matrix

Returns:

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

and

public BitMatrix2D and(BitMatrix2D other)

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

Parameters:

other - other 2D bit matrix, must not be null and must have the same dimensions as this 2D bit matrix

Returns:

this 2D bit matrix, for convenience

andNot

public BitMatrix2D andNot(BitMatrix2D other)

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

Parameters:

other - other 2D bit matrix, must not be null and must have the same dimensions as this 2D bit matrix

Returns:

this 2D bit matrix, for convenience

or

public BitMatrix2D or(BitMatrix2D other)

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

Parameters:

other - other 2D bit matrix, must not be null and must have the same dimensions as this 2D bit matrix

Returns:

this 2D bit matrix, for convenience

xor

public BitMatrix2D xor(BitMatrix2D other)

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

Parameters:

other - other 2D bit matrix, must not be null and must have the same dimensions as this 2D bit matrix

Returns:

this 2D bit matrix, for convenience

forEach

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

Apply the specified procedure to each row and column in this 2D 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