Package ptolemy.data

Class BooleanMatrixToken

java.lang.Object

ptolemy.data.Token

ptolemy.data.MatrixToken

ptolemy.data.BooleanMatrixToken

public class BooleanMatrixToken
extends MatrixToken

A token that contains a 2-D boolean matrix.

Since:

Ptolemy II 0.2

Version:

$Id$

Author:

Yuhong Xiong, Steve Neuendorffer

Pt.AcceptedRating:

Yellow (cxh)

Pt.ProposedRating:

Green (neuendor)

Field Summary

Fields inherited from class ptolemy.data.MatrixToken

_nils, DO_COPY, DO_NOT_COPY

Fields inherited from class ptolemy.data.Token

NIL

Constructor Summary

Constructors

Constructor	Description
BooleanMatrixToken()	Construct an BooleanMatrixToken with a one by one matrix.
BooleanMatrixToken(boolean[][] value)	Construct a BooleanMatrixToken with the specified 2-D matrix.
BooleanMatrixToken(java.lang.String init)	Construct a BooleanMatrixToken from the specified string.
BooleanMatrixToken(Token[] tokens, int rows, int columns)	Construct an BooleanMatrixToken from the specified array of tokens.

Method Summary

Modifier and Type	Method	Description
protected boolean[][]	_createIdentity(int dim)	Return an new identity matrix with the specified dimension.
boolean[][]	booleanMatrix()	Return a copy of the contained 2-D matrix.
static BooleanMatrixToken	convert(Token token)	Convert the specified token into an instance of BooleanMatrixToken.
MatrixToken	crop(int rowStart, int colStart, int rowSpan, int colSpan)	Return a new matrix that is a sub-matrix of this matrix.
boolean	equals(java.lang.Object object)	Return true if the argument is an instance of BooleanMatrixToken of the same dimensions and the corresponding elements of the matrices are equal.
int	getColumnCount()	Return the number of columns in the matrix.
Token	getElementAsToken(int row, int column)	Return the element of the matrix at the specified row and column in a BooleanToken.
boolean	getElementAt(int row, int column)	Return the element of the contained matrix at the specified row and column.
Type	getElementType()	Return the Type of the tokens contained in this matrix token.
int	getRowCount()	Return the number of rows in the matrix.
Type	getType()	Return the type of this token.
int	hashCode()	Return a hash code value for this token.
MatrixToken	join(MatrixToken[][] matrices)	Join a matrix of matrices into a single matrix by tiling.
Token	one()	Return a new Token representing the left multiplicative identity.
Token	oneRight()	Return a new Token representing the right multiplicative identity.
MatrixToken[][]	split(int[] rows, int[] columns)	Split this matrix into multiple matrices.
Token	zero()	Return a new Token representing the additive identity.

Methods inherited from class ptolemy.data.MatrixToken

_add, _addElement, _divideElement, _elementIsNil, _isCloseTo, _isEqualTo, _moduloElement, _multiply, _multiplyElement, _subtract, _subtractElement, _subtractElementReverse, add, addReverse, arrayToMatrix, arrayToMatrix, arrayToMatrixReturnType, complexMatrix, create, createSequence, createSequenceReturnType, createTokenSequence, determineSequenceLength, divide, divideReverse, doubleMatrix, fixMatrix, intMatrix, isCloseTo, isEqualTo, longMatrix, matrixToArray, matrixToArrayReturnType, modulo, moduloReverse, multiply, multiplyReverse, subtract, subtractReverse, toArray, toArrayColumnMajor, toArrayReturnType, toString

Methods inherited from class ptolemy.data.Token

isCloseTo, isNil, notSupportedConversionMessage, notSupportedIncomparableConversionMessage, notSupportedIncomparableMessage, notSupportedMessage, notSupportedNullNilStringMessage, pow, zeroReturnType

Methods inherited from class java.lang.Object

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

Constructor Detail

BooleanMatrixToken

public BooleanMatrixToken()

Construct an BooleanMatrixToken with a one by one matrix. The only element in the matrix has value false.

BooleanMatrixToken

public BooleanMatrixToken(boolean[][] value)
                   throws IllegalActionException

Construct a BooleanMatrixToken with the specified 2-D matrix. This method makes a copy of the matrix and stores the copy, so changes on the specified matrix after this token is constructed will not affect the content of this token.

Parameters:

value - The 2-D boolean matrix.

Throws:

IllegalActionException - If the specified matrix is null.

BooleanMatrixToken

public BooleanMatrixToken(java.lang.String init)
                   throws IllegalActionException

Construct a BooleanMatrixToken from the specified string.

Parameters:

init - A string expression of a boolean matrix.

Throws:

IllegalActionException - If the string does not contain a parsable boolean matrix.

BooleanMatrixToken

public BooleanMatrixToken(Token[] tokens,
                          int rows,
                          int columns)
                   throws IllegalActionException

Construct an BooleanMatrixToken from the specified array of tokens. The tokens in the array must be scalar tokens convertible into integers.

Parameters:

tokens - The array of tokens, which must contains rows*columns BooleanTokens.

rows - The number of rows in the matrix to be created.

columns - The number of columns in the matrix to be created.

Throws:

IllegalActionException - If the array of tokens is null, or the length of the array is not correct, or if one of the elements of the array is null, or if one of the elements of the array cannot be losslessly converted to a boolean.

Method Detail

booleanMatrix

public boolean[][] booleanMatrix()

Return a copy of the contained 2-D matrix. It is safe for the caller to modify the returned matrix.

Overrides:

booleanMatrix in class MatrixToken

Returns:

A 2-D boolean matrix.

convert

public static BooleanMatrixToken convert(Token token)
                                  throws IllegalActionException

Convert the specified token into an instance of BooleanMatrixToken. This method does lossless conversion. If the argument is already an instance of BooleanMatrixToken, it is returned without any change. Otherwise, if the argument is below BooleanMatrixToken in the type hierarchy, it is converted to an instance of BooleanMatrixToken or one of the subclasses of BooleanMatrixToken and returned. If none of the above conditions are met, an exception is thrown.

Parameters:

token - The token to be converted to a BooleanMatrixToken.

Returns:

A BooleanMatrixToken

Throws:

IllegalActionException - If the conversion cannot be carried out.

crop

public MatrixToken crop(int rowStart,
                        int colStart,
                        int rowSpan,
                        int colSpan)
                 throws IllegalActionException

Return a new matrix that is a sub-matrix of this matrix.

Overrides:

crop in class MatrixToken

Parameters:

rowStart - The row to start on.

colStart - The column to start on.

rowSpan - The number of rows to copy.

colSpan - The number of columns to copy.

Returns:

a sub-matrix of this matrix.

Throws:

IllegalActionException - If the returned matrix is empty or if the specified parameters result in out of bounds accesses.

equals

public boolean equals(java.lang.Object object)

Return true if the argument is an instance of BooleanMatrixToken of the same dimensions and the corresponding elements of the matrices are equal.

Overrides:

equals in class java.lang.Object

Parameters:

object - An instance of Object.

Returns:

True if the argument is an instance of BooleanMatrixToken of the same dimensions and the corresponding elements of the matrices are equal.

getColumnCount

public int getColumnCount()

Return the number of columns in the matrix.

Specified by:

getColumnCount in class MatrixToken

Returns:

The number of columns in the matrix.

getElementAsToken

public Token getElementAsToken(int row,
                               int column)
                        throws java.lang.ArrayIndexOutOfBoundsException

Return the element of the matrix at the specified row and column in a BooleanToken.

Specified by:

getElementAsToken in class MatrixToken

Parameters:

row - The row index of the desired element.

column - The column index of the desired element.

Returns:

A BooleanToken containing the matrix element.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the specified row or column number is outside the range of the matrix.

getElementAt

public boolean getElementAt(int row,
                            int column)

Return the element of the contained matrix at the specified row and column.

Parameters:

row - The row index of the desired element.

column - The column index of the desired element.

Returns:

The boolean at the specified matrix entry.

Throws:

java.lang.ArrayIndexOutOfBoundsException - If the specified row or column number is outside the range of the matrix.

getElementType

public Type getElementType()

Return the Type of the tokens contained in this matrix token.

Specified by:

getElementType in class MatrixToken

Returns:

BaseType.INT.

getRowCount

public int getRowCount()

Return the number of rows in the matrix.

Specified by:

getRowCount in class MatrixToken

Returns:

The number of rows in the matrix.

getType

public Type getType()

Return the type of this token.

Overrides:

getType in class Token

Returns:

BaseType.BOOLEAN_MATRIX

hashCode

public int hashCode()

Return a hash code value for this token. This method returns the number of elements with value true in the contained matrix.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this token.

join

public MatrixToken join(MatrixToken[][] matrices)
                 throws IllegalActionException

Join a matrix of matrices into a single matrix by tiling. All matrices in the matrix must be of the same type, the same type as this matrix. But none of them needs to actually be this matrix. This base class simply throws an exception. Derived classes provide the implementation. The number of columns in the resulting matrix is the sum of the number of columns in the first row of the argument. The number of rows in the resulting matrix is the sum of the number of rows in the first column of the argument. The matrices are copied into the result starting at the position determined by the first row or column. If the matrices overlap, then while copying left to right, top-to-bottom, data will be overwritten. If there are gaps, the resulting matrix will be filled with zeros.

Overrides:

join in class MatrixToken

Parameters:

matrices - A two-dimensional array of matrix tokens.

Returns:

A new matrix token of the same type as the elements in the input matrix of matrix tokens.

Throws:

IllegalActionException - If the types of the matrices in the input are not all the same, or if tiling fails due to size incompatibilities, or if the input matrix has no tokens.

split

public MatrixToken[][] split(int[] rows,
                             int[] columns)

Split this matrix into multiple matrices. See the base class for documentation.

Overrides:

split in class MatrixToken

Parameters:

rows - The number of rows per submatrix.

columns - The number of columns per submatrix.

Returns:

An array of matrix tokens.

one

public Token one()

Return a new Token representing the left multiplicative identity. The returned token contains an identity matrix whose dimensions are the same as the number of rows of the matrix contained in this token.

Overrides:

one in class Token

Returns:

A new BooleanMatrixToken containing the left multiplicative identity.

oneRight

public Token oneRight()

Return a new Token representing the right multiplicative identity. The returned token contains an identity matrix whose dimensions are the same as the number of columns of the matrix contained in this token.

Overrides:

oneRight in class MatrixToken

Returns:

A new BooleanMatrixToken containing the right multiplicative identity.

zero

public Token zero()

Return a new Token representing the additive identity. The returned token contains a matrix whose elements are all zero, and the size of the matrix is the same as the matrix contained in this token.

Overrides:

zero in class Token

Returns:

A new IntMatrixToken containing the additive identity.

_createIdentity

protected boolean[][] _createIdentity(int dim)

Return an new identity matrix with the specified dimension. The matrix is square, so only one dimension specifier is needed.

Parameters:

dim - The dimension

Returns:

the identity matrix.