edu.ucla.sspace.matrix

Class AbstractMatrix

java.lang.Object

edu.ucla.sspace.matrix.AbstractMatrix

All Implemented Interfaces:

Matrix

Direct Known Subclasses:

SemanticSpaceMatrix, SparseHashMatrix, SparseSymmetricMatrix, SymmetricMatrix

public abstract class AbstractMatrix
extends Object
implements Matrix

An abstract Matrix class that provides common implementations for generic matrix operations. This class assumes that all subclasses are row-based and will therefore call getRowVector for all operations. At a minimum subclasses must define the following three operations to be an immutable matrix:

• getRowVector
• rows()
• columns()

To support modification, implementations need only define

• set

Nested Class Summary

Nested classes/interfaces inherited from interface edu.ucla.sspace.matrix.Matrix

Matrix.Type

Constructor Summary

Constructors

Constructor and Description
AbstractMatrix()

Method Summary

Methods

Modifier and Type	Method and Description
abstract int	columns() Returns the number of columns in this Matrix.
boolean	equals(Object o) Returns if the object is a Matrix with the same dimensions as whose values are equivalent.
double	get(int row, int col) Returns the value of the Matrix at the provided row and column.
double[]	getColumn(int column) Returns the entire column.
DoubleVector	getColumnVector(int column) Returns the column as a vector.
double[]	getRow(int row) Returns the entire row.
abstract DoubleVector	getRowVector(int row) Returns a DoubleVector for an entire row.
int	hashCode() Returns the sum of all rows hash codes.
abstract int	rows() Returns the number of rows in this Matrix.
void	set(int row, int col, double val) Throws an UnsupportedOperationException if called (matrix is unmodifiable).
void	setColumn(int column, double[] values) Sets the values for the column of this Matrix using the provided array.
void	setColumn(int column, DoubleVector values) Sets the values for the column of this Matrix using the provided DoubleVector.
void	setRow(int row, double[] columns) Sets the values for the row of this Matrix using the provided array.
void	setRow(int row, DoubleVector values) Sets the values for the row of this Matrix using the provided DoubleVector.
double[][]	toDenseArray() Converts the Matrix to a two dimensional array.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractMatrix

public AbstractMatrix()

Method Detail

columns

public abstract int columns()

Returns the number of columns in this Matrix.

Specified by:

columns in interface Matrix

Returns:

The number of columns in this Matrix.

equals

public boolean equals(Object o)

Returns if the object is a Matrix with the same dimensions as whose values are equivalent. Value equivalence is computed using Vector equality on the row vectors of each matrix.

Overrides:

equals in class Object

get

public double get(int row,
         int col)

Returns the value of the Matrix at the provided row and column.

Specified by:

get in interface Matrix

Parameters:

row - The row values of the cell to return.

col - The column value of the cell to return.

Returns:

The value at the cell specified by row and col.

getColumn

public double[] getColumn(int column)

Returns the entire column.

Specified by:

getColumn in interface Matrix

Parameters:

column - The column to return an array for.

Returns:

A double array representing the column at column.

getColumnVector

public DoubleVector getColumnVector(int column)

Returns the column as a vector. Whether updates to the vector are written through to the backing matrix is left open to the specific implementation. Implementations that maintain their data in a sparse format are encouraged to return a SparseVector instance.

Specified by:

getColumnVector in interface Matrix

Parameters:

column - The column to return a DoubleVector for.

Returns:

A DoubleVector representing the column at column.

getRow

public double[] getRow(int row)

Returns the entire row.

Specified by:

getRow in interface Matrix

Parameters:

row - The row to return an array for.

Returns:

A double array representing the row at row.

getRowVector

public abstract DoubleVector getRowVector(int row)

Returns a DoubleVector for an entire row. Implementations should return an approriately typed DoubleVector. Whether updates to the vector are written through to the backing matrix is left open to the specific implementation. Implementations that maintain their data in a sparse format are encouraged to return a SparseVector instance.

Specified by:

getRowVector in interface Matrix

Parameters:

row - the index of the row to return.

Returns:

A DoubleVector representing the row at row.

hashCode

public int hashCode()

Returns the sum of all rows hash codes.

Overrides:

hashCode in class Object

rows

public abstract int rows()

Returns the number of rows in this Matrix.

Specified by:

rows in interface Matrix

Returns:

The number of columns in this Matrix.

set

public void set(int row,
       int col,
       double val)

Throws an UnsupportedOperationException if called (matrix is unmodifiable).

Specified by:

set in interface Matrix

Parameters:

row - The row of the cell to update.

col - The column of the cell to update.

val - The new value of the specified cell.

setColumn

public void setColumn(int column,
             double[] values)

Sets the values for the column of this Matrix using the provided array. Note that the array itself is not made internal to the instance itself.

Specified by:

setColumn in interface Matrix

Parameters:

column - The column to update.

values - The values to update into column.

Throws:

IllegalArgumentException - if the length of values is not equal to the number of rows

setColumn

public void setColumn(int column,
             DoubleVector values)

Sets the values for the column of this Matrix using the provided DoubleVector. Note that the DoubleVector itself is not made internal to the instance itself.

Specified by:

setColumn in interface Matrix

Parameters:

column - The column to update.

values - The values to update into column.

Throws:

IllegalArgumentException - if the length of values is not equal to the number of rows

setRow

public void setRow(int row,
          double[] columns)

Sets the values for the row of this Matrix using the provided array. Note that the array itself is not made internal to the instance itself.

Specified by:

setRow in interface Matrix

Parameters:

row - The row to update.

columns - The values to update into row.

Throws:

IllegalArgumentException - if the length of columns is not equal to the number of columns

setRow

public void setRow(int row,
          DoubleVector values)

Sets the values for the row of this Matrix using the provided DoubleVector. Note that the DoubleVector itself is not made internal to the instance itself.

Specified by:

setRow in interface Matrix

Parameters:

row - The row to update.

values - The values to update into row.

Throws:

IllegalArgumentException - if the length of columns is not equal to the number of columns

toDenseArray

public double[][] toDenseArray()

Converts the Matrix to a two dimensional array. Note that for large matrices, this may exhaust all available memory.

Specified by:

toDenseArray in interface Matrix

Returns:

A double array version of this Matrix.