edu.ucla.sspace.util

Class SemanticSpaceMatrix

java.lang.Object

edu.ucla.sspace.matrix.AbstractMatrix

edu.ucla.sspace.util.SemanticSpaceMatrix

All Implemented Interfaces:

Matrix

public class SemanticSpaceMatrix
extends AbstractMatrix

A Matrix implementation whose data is backed by a SemanticSpace. This class provides a bridge between numerical operations that use the space's data and the results of the algorithm itself.

Nested Class Summary

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

Matrix.Type

Constructor Summary

Constructors

Constructor and Description
SemanticSpaceMatrix(SemanticSpace sspace) Creates a Matrix whose data is backed by the provided SemanticSpace.

Method Summary

Methods

Modifier and Type	Method and Description
int	columns() Returns the number of columns in this Matrix.
Integer	getRowIndex(String term) Returns the row to which the provided term is mapped or null if the term is not mapped to any 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) Throws an UnsupportedOperationException if called (matrix is unmodifiable).
void	setColumn(int column, DoubleVector values) Sets the values for the column of this Matrix using the provided DoubleVector.
void	setRow(int row, DoubleVector values) Sets the values for the row of this Matrix using the provided DoubleVector.

Methods inherited from class edu.ucla.sspace.matrix.AbstractMatrix

equals, get, getColumn, getColumnVector, getRow, hashCode, setColumn, setRow, toDenseArray

Methods inherited from class java.lang.Object

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

Constructor Detail

SemanticSpaceMatrix

public SemanticSpaceMatrix(SemanticSpace sspace)

Creates a Matrix whose data is backed by the provided SemanticSpace. The rows of this matrix are not guaranteed to be mapped to any specific ordering of the words in the SemanticSpace. Further, once this matrix is created, the underlying semantic space should not be modified in such a way as to add new rows or to change the vector length.

Method Detail

getRowIndex

public Integer getRowIndex(String term)

Returns the row to which the provided term is mapped or null if the term is not mapped to any row.

getRowVector

public 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

Specified by:

getRowVector in class AbstractMatrix

Parameters:

row - the index of the row to return.

Returns:

A DoubleVector representing the row at row.

columns

public int columns()

Returns the number of columns in this Matrix.

Specified by:

columns in interface Matrix

Specified by:

columns in class AbstractMatrix

Returns:

The number of columns in this Matrix.

rows

public int rows()

Returns the number of rows in this Matrix.

Specified by:

rows in interface Matrix

Specified by:

rows in class AbstractMatrix

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

Overrides:

set in class AbstractMatrix

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,
             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

Overrides:

setColumn in class AbstractMatrix

Parameters:

column - The column to update.

values - The values to update into column.

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

Overrides:

setRow in class AbstractMatrix

Parameters:

row - The row to update.

values - The values to update into row.