edu.ucla.sspace.matrix

Interface Matrix

All Known Subinterfaces:

AtomicMatrix, SparseMatrix

All Known Implementing Classes:

AbstractMatrix, ArrayMatrix, AtomicGrowingMatrix, AtomicGrowingSparseHashMatrix, AtomicGrowingSparseMatrix, CellMaskedMatrix, CellMaskedSparseMatrix, DiagonalMatrix, GrowingSparseMatrix, OnDiskMatrix, RowMaskedMatrix, RowScaledMatrix, RowScaledSparseMatrix, SemanticSpaceMatrix, SparseHashMatrix, SparseOnDiskMatrix, SparseRowMaskedMatrix, SparseSymmetricMatrix, SymmetricMatrix, SynchronizedMatrix, SynchronizedSparseMatrix, TransposedMatrix, YaleSparseMatrix

public interface Matrix

An interface specification for interacting with Matrix objects.

Author:

David Jurgens

See Also:

MatrixIO, Matrix.Type

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Matrix.Type The type of Matrix instance.

Method Summary

Methods

Modifier and Type	Method and Description
int	columns() Returns the number of columns in this Matrix.
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.
DoubleVector	getRowVector(int row) Returns a DoubleVector for an entire row.
int	rows() Returns the number of rows in this Matrix.
void	set(int row, int col, double val) Sets the location at the row and column to the provided value.
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[] values) 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.

Method Detail

get

double get(int row,
         int col)

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

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

double[] getColumn(int column)

Returns the entire column.

Parameters:

column - The column to return an array for.

Returns:

A double array representing the column at column.

getColumnVector

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.

Parameters:

column - The column to return a DoubleVector for.

Returns:

A DoubleVector representing the column at column.

getRow

double[] getRow(int row)

Returns the entire row.

Parameters:

row - The row to return an array for.

Returns:

A double array representing the row at row.

getRowVector

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.

Parameters:

row - the index of the row to return.

Returns:

A DoubleVector representing the row at row.

columns

int columns()

Returns the number of columns in this Matrix.

Returns:

The number of columns in this Matrix.

toDenseArray

double[][] toDenseArray()

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

Returns:

A double array version of this Matrix.

rows

int rows()

Returns the number of rows in this Matrix.

Returns:

The number of columns in this Matrix.

set

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

Sets the location at the row and column to the provided value.

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

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.

Parameters:

column - The column to update.

values - The values to update into column.

setColumn

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.

Parameters:

column - The column to update.

values - The values to update into column.

setRow

void setRow(int row,
          double[] values)

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.

Parameters:

row - The row to update.

values - The values to update into row.

setRow

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.

Parameters:

row - The row to update.

values - The values to update into row.