sbrt.kernel.math.algebra
Interface DoubleMatrix<R,C>

Type Parameters:
R - the row type.
C - the column type.
All Superinterfaces:
Matrix<R,C,java.lang.Double>
All Known Subinterfaces:
DoubleMatrixBuilder<R,C>, SmdMatrix<R,C>, SparseDoubleMatrix<R,C>
All Known Implementing Classes:
AbstractMdMatrix, AbstractSmdMatrix, DoubleMatrixWrap, HashMatrix, RowOrTreeMatrix, SparseDoubleMatrixWrap, TreeMatrix

public interface DoubleMatrix<R,C>
extends Matrix<R,C,java.lang.Double>

This interface is used to represent matrices whose elements are strictly double precision numbers.

Author:
This interface was written and documented by Jeremiah Wright while in the Wagner lab.

Method Summary
 DoubleMatrix<R,C> getColumn(java.lang.Object columnIndex)
          Returns the column corresponding to the provided column index.
 java.lang.Double getElement(java.lang.Object rowIndex, java.lang.Object columnIndex)
          Returns the element of this matrix at the provided row and column indices.
 DoubleMatrix<R,C> getRow(java.lang.Object rowIndex)
          Returns the row corresponding to the provided row index.
 java.util.List<LinearComb<C>> toLinearCombs()
          Returns this matrix as a list of linear combinations.
 
Methods inherited from interface sbrt.kernel.math.algebra.Matrix
columns, equals, getColumnIndices, getRowIndices, hashCode, isColumnIndex, isEmpty, isRowIndex, rows, toString
 

Method Detail

getElement

java.lang.Double getElement(java.lang.Object rowIndex,
                            java.lang.Object columnIndex)
Returns the element of this matrix at the provided row and column indices.

Specified by:
getElement in interface Matrix<R,C,java.lang.Double>
Parameters:
rowIndex - the row index.
columnIndex - the column index.
Returns:
the element of this matrix at the provided row and column indices.

getRow

DoubleMatrix<R,C> getRow(java.lang.Object rowIndex)
Returns the row corresponding to the provided row index. A row is itself a 1 x n matrix, where n is the number of columns in this matrix.

Specified by:
getRow in interface Matrix<R,C,java.lang.Double>
Parameters:
rowIndex - the index of the row to be returned.
Returns:
the row corresponding to the provided row index.

getColumn

DoubleMatrix<R,C> getColumn(java.lang.Object columnIndex)
Returns the column corresponding to the provided column index. A column is itself an m x 1 matrix, where m is the number of rows in this matrix.

Specified by:
getColumn in interface Matrix<R,C,java.lang.Double>
Parameters:
columnIndex - the index of the column to be returned.
Returns:
the column corresponding to the provided column index.

toLinearCombs

java.util.List<LinearComb<C>> toLinearCombs()
Returns this matrix as a list of linear combinations. In other words, this method returns the product of this matrix with a column vector of the column indices of this matrix.

Returns:
this matrix as a list of linear combinations.