This class implements matrices of bits of arbitrary dimensions. More...

Inheritance diagram for BitMatrix:

Collaboration diagram for BitMatrix:

Classes
class	IncompatibleDimensionException
	Runtime exception raised when the dimensions of the `BitMatrix` are not appropriate for the operation. More...

Public Member Functions
	BitMatrix (int r, int c)
	Creates a new `BitMatrix` with `r` rows and `c` columns filled with 0’s. More...

	BitMatrix (BitVector[] rows)
	Creates a new `BitMatrix` using the data in `rows`. More...

	BitMatrix (int[][] data, int r, int c)
	Creates a new `BitMatrix` with `r` rows and `c` columns using the data in `data`. More...

	BitMatrix (BitMatrix that)
	Copy constructor. More...

Object	clone ()
	Creates a copy of the `BitMatrix`. More...

boolean	equals (BitMatrix that)
	Verifies that `this` and `that` are strictly identical. More...

String	toString ()
	Creates a String containing all the data of the `BitMatrix`. More...

String	printData ()
	Creates a String containing all the data of the `BitMatrix`. More...

int	numRows ()
	Returns the number of rows of the `BitMatrix`. More...

int	numColumns ()
	Returns the number of columns of the `BitMatrix`. More...

boolean	getBool (int row, int column)
	Returns the value of the bit in the specified row and column. More...

void	setBool (int row, int column, boolean value)
	Changes the value of the bit in the specified row and column. More...

BitMatrix	transpose ()
	Returns the transposed matrix. More...

BitMatrix	not ()
	Returns the `BitMatrix` resulting from the application of the `not` operator on the original `BitMatrix`. More...

BitMatrix	and (BitMatrix that)
	Returns the `BitMatrix` resulting from the application of the `and` operator on the original `BitMatrix` and `that`. More...

BitMatrix	or (BitMatrix that)
	Returns the `BitMatrix` resulting from the application of the `or` operator on the original `BitMatrix` and `that`. More...

BitMatrix	xor (BitMatrix that)
	Returns the `BitMatrix` resulting from the application of the `xor` operator on the original `BitMatrix` and `that`. More...

BitVector	multiply (BitVector vect)
	Multiplies the column BitVector by a `BitMatrix` and returns the result. More...

int	multiply (int vect)
	Multiplies `vect`, seen as a column BitVector, by a `BitMatrix`. More...

BitMatrix	multiply (BitMatrix that)
	Multiplies two `BitMatrix`’s together. More...

BitMatrix	power (long p)
	Raises the `BitMatrix` to the power `p`. More...

BitMatrix	power2e (int e)
	Raises the `BitMatrix` to power \(2^{\mathtt{e}}\). More...

Package Attributes
int	c

Static Package Attributes
static final long	serialVersionUID = 2472769969919959608L

Detailed Description

This class implements matrices of bits of arbitrary dimensions.

Basic facilities for bits operations, multiplications and exponentiations are provided.

Constructor & Destructor Documentation

◆ BitMatrix() [1/4]

BitMatrix	(	int	r,
		int	c
	)

Creates a new BitMatrix with r rows and c columns filled with 0’s.

Parameters

r	the number of rows
c	the number of columns

◆ BitMatrix() [2/4]

BitMatrix ( BitVector [] rows )

Creates a new BitMatrix using the data in rows.

Each of the BitVector will be one of the rows of the BitMatrix.

Parameters

rows	the rows of the new `BitMatrix`

◆ BitMatrix() [3/4]

BitMatrix	(	int	data[][],
		int	r,
		int	c
	)

Creates a new BitMatrix with r rows and c columns using the data in data.

Note that the orders of the bits for the rows are using the same order than for the BitVector. This does mean that the first bit is the lowest order bit of the last int in the row and the last bit is the highest order bit of the first int int the row.

Parameters

data	the data of the new `BitMatrix`
r	the number of rows
c	the number of columns

◆ BitMatrix() [4/4]

BitMatrix ( BitMatrix that )

Copy constructor.

Parameters

that	the `BitMatrix` to copy

Member Function Documentation

◆ and()

BitMatrix and ( BitMatrix that )

Returns the BitMatrix resulting from the application of the and operator on the original BitMatrix and that.

Only bits which were at 1 in both BitMatrix are set at 1 in the result. All others are set to 0.

Parameters

that	the second operand of the `and` operator

Returns: the result of the and operator

Exceptions

IncompatibleDimensionException if the two BitMatrix are not of the same dimensions

◆ clone()

Object clone ( )

Creates a copy of the BitMatrix.

Returns: a deep copy of the BitMatrix

◆ equals()

boolean equals ( BitMatrix that )

Verifies that this and that are strictly identical.

They must both have the same dimensions and data.

Parameters

that	the `BitMatrix` to compare

Returns: if the two BitMatrix are identical

◆ getBool()

boolean getBool	(	int	row,
		int	column
	)

Returns the value of the bit in the specified row and column.

If the value is 1, return true. If it is 0, return false.

Parameters

row	the row of the selected bit
column	the column of the selected bit

Returns: the value of the bit as a boolean

Exceptions

IndexOutOfBoundsException if the selected bit would be outside the BitMatrix

◆ multiply() [1/3]

BitVector multiply ( BitVector vect )

Multiplies the column BitVector by a BitMatrix and returns the result.

The result is \(A \times v\), where \(A\) is the BitMatrix, and \(v\) is the BitVector.

Parameters

vect	the vector to multiply

Returns: the result of the multiplication

◆ multiply() [2/3]

int multiply ( int vect )

Multiplies vect, seen as a column BitVector, by a BitMatrix.

(See BitVector to see the conversion between int and BitVector.) The result is \(A \times v\), where \(A\) is the BitMatrix, and \(v\) is the BitVector.

Parameters

vect	the vector to multiply

Returns: the result of the multiplication, as an int

◆ multiply() [3/3]

BitMatrix multiply ( BitMatrix that )

Multiplies two BitMatrix’s together.

The result is \(A \times B\), where \(A\) is the this BitMatrix and \(B\) is the that BitMatrix.

Parameters

that	the other `BitMatrix` to multiply

Returns: the result of the multiplication

Exceptions

IncompatibleDimensionException if the number of columns of the first BitMatrix is not equal to the number of rows of the second BitMatrix

◆ not()

BitMatrix not ( )

Returns the BitMatrix resulting from the application of the not operator on the original BitMatrix.

The effect is to swap all the bits of the BitMatrix, turning all 0 into 1 and all 1 into 0.

Returns: the result of the not operator

◆ numColumns()

int numColumns ( )

Returns the number of columns of the BitMatrix.

Returns: the number of columns

◆ numRows()

int numRows ( )

Returns the number of rows of the BitMatrix.

Returns: the number of rows

◆ or()

BitMatrix or ( BitMatrix that )

Returns the BitMatrix resulting from the application of the or operator on the original BitMatrix and that.

Only bits which were at 0 in both BitMatrix are set at 0 in the result. All others are set to 1.

Parameters

that	the second operand of the `or` operator

Returns: the result of the or operator

Exceptions

IncompatibleDimensionException if the two BitMatrix are not of the same dimensions

◆ power()

BitMatrix power ( long p )

Raises the BitMatrix to the power p.

Parameters

p	the power up to which to raise the `BitMatrix`

Returns: the power of the BitMatrix

Exceptions

IncompatibleDimensionException	if the `BitMatrix` is not square
IllegalArgumentException	if `p` is negative

◆ power2e()

BitMatrix power2e ( int e )

Raises the BitMatrix to power \(2^{\mathtt{e}}\).

Parameters

e	the exponent of the power up to which to raise the `BitMatrix`

Returns: the power of the BitMatrix

Exceptions

IncompatibleDimensionException if the BitMatrix is not square

◆ printData()

String printData ( )

Creates a String containing all the data of the BitMatrix.

The data is displayed in the same format as are the int[][] in Java code. This allows the user to print the representation of a BitMatrix to be put, directly in the source code, in the constructor BitMatrix(int[][], int, int). The output is not designed to be human-readable.

Returns: the content of the BitMatrix

◆ setBool()

void setBool	(	int	row,
		int	column,
		boolean	value
	)

Changes the value of the bit in the specified row and column.

If value is true, changes it to 1. If value is false changes it to 0.

Parameters

row	the row of the selected bit
column	the column of the selected bit
value	the new value of the bit as a boolean

Exceptions

IndexOutOfBoundsException if the selected bit would be outside the BitMatrix

◆ toString()

String toString ( )

Creates a String containing all the data of the BitMatrix.

The result is displayed in a matrix form, with each row being put on a different line. Note that the bit at (0,0) is at the upper left of the matrix, while the bit at (0) in a BitVector is the least significant bit.

Returns: the content of the BitMatrix

◆ transpose()

BitMatrix transpose ( )

Returns the transposed matrix.

The rows and columns are interchanged.

Returns: the transposed matrix

◆ xor()

BitMatrix xor ( BitMatrix that )

Returns the BitMatrix resulting from the application of the xor operator on the original BitMatrix and that.

Only bits which were at 1 in only one of the two BitMatrix are set at 1 in the result. All others are set to 0.

Parameters

that	the second operand of the `xor` operator

Returns: the result of the xor operator

Exceptions

IncompatibleDimensionException if the two BitMatrix are not of the same dimensions

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

BitMatrix.java

Classes

Public Member Functions

Package Attributes

Static Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ BitMatrix() [1/4]

◆ BitMatrix() [2/4]

◆ BitMatrix() [3/4]

◆ BitMatrix() [4/4]

Member Function Documentation

◆ and()

◆ clone()

◆ equals()

◆ getBool()

◆ multiply() [1/3]

◆ multiply() [2/3]

◆ multiply() [3/3]

◆ not()

◆ numColumns()

◆ numRows()

◆ or()

◆ power()

◆ power2e()

◆ printData()

◆ setBool()

◆ toString()

◆ transpose()

◆ xor()