edu.ucla.sspace.matrix

Class DiagonalMatrix

java.lang.Object

edu.ucla.sspace.matrix.DiagonalMatrix

All Implemented Interfaces:

Matrix, SparseMatrix

public class DiagonalMatrix
extends Object
implements SparseMatrix

A special-case Matrix implementation for diagonal matrices. This class provides a memory efficient representation and additional bounds checking to ensure non-diagonal elements cannot be set.

Author:

Keith Stevens

Nested Class Summary

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

Matrix.Type

Constructor Summary

Constructors

Constructor and Description
DiagonalMatrix(double[] newValues) Creates a new DiagonalMatrix with newValues as the diagonal values.
DiagonalMatrix(int numValues) Creates a new DiagonalMatrix with numValues rows and columns.

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.
SparseDoubleVector	getColumnVector(int column) Returns the column as a sparse vector.
double[]	getRow(int row) Returns the entire row.
SparseDoubleVector	getRowVector(int row) Returns the row as a sparse vector.
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 vector) 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 vector) 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, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DiagonalMatrix

public DiagonalMatrix(int numValues)

Creates a new DiagonalMatrix with numValues rows and columns.

Parameters:

numValues - The number of rows, columns, and diagonals in this DiagonalMatrix.

DiagonalMatrix

public DiagonalMatrix(double[] newValues)

Creates a new DiagonalMatrix with newValues as the diagonal values.

Parameters:

newValues - The values to use as the diagonals of this Matrix.

Method Detail

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 SparseDoubleVector getColumnVector(int column)

Returns the column as a sparse vector. Whether updates to the vector are written through to the backing matrix is left open to the implementation.

Specified by:

getColumnVector in interface Matrix

Specified by:

getColumnVector in interface SparseMatrix

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 SparseDoubleVector getRowVector(int row)

Returns the row as a sparse vector. Whether updates to the vector are written through to the backing matrix is left open to the implementation.

Specified by:

getRowVector in interface Matrix

Specified by:

getRowVector in interface SparseMatrix

Parameters:

row - the index of row to return

Returns:

A SparseDoubleVector of the row's data

columns

public int columns()

Returns the number of columns in this Matrix.

Specified by:

columns in interface Matrix

Returns:

The number of columns in this Matrix.

set

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

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

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.

Throws:

IllegalArgumentException - if row != col

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. Note that any values are not on the diagonal are ignored.

Specified by:

setColumn in interface Matrix

Parameters:

column - The column to update.

values - The values to update into column.

setColumn

public void setColumn(int column,
             DoubleVector vector)

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. Note that any values are not on the diagonal are ignored.

Specified by:

setColumn in interface Matrix

Parameters:

column - The column to update.

vector - The values to update into column.

setRow

public 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. Note that any values are not on the diagonal are ignored.

Specified by:

setRow in interface Matrix

Parameters:

row - The row to update.

values - The values to update into row.

setRow

public void setRow(int row,
          DoubleVector vector)

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. Note that any values are not on the diagonal are ignored.

Specified by:

setRow in interface Matrix

Parameters:

row - The row to update.

vector - The values to update into row.

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.

rows

public int rows()

Returns the number of rows in this Matrix.

Specified by:

rows in interface Matrix

Returns:

The number of columns in this Matrix.