gov.sandia.cognition.math.matrix.mtj

Class SparseMatrix

java.lang.Object

gov.sandia.cognition.util.AbstractCloneableSerializable

gov.sandia.cognition.math.AbstractRing<Matrix>

gov.sandia.cognition.math.matrix.AbstractMatrix

gov.sandia.cognition.math.matrix.mtj.AbstractMTJMatrix

gov.sandia.cognition.math.matrix.mtj.AbstractSparseMatrix

gov.sandia.cognition.math.matrix.mtj.SparseRowMatrix

gov.sandia.cognition.math.matrix.mtj.SparseMatrix

All Implemented Interfaces:

Matrix, Vectorizable, Ring<Matrix>, CloneableSerializable, java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<MatrixEntry>

@CodeReview(reviewer="Justin Basilico",
            date="2006-07-27",
            changesNeeded=true,
            comments="The readObject and writeObjects need to be implemented or removed if they are no longer needed.",
            response=@CodeReviewResponse(respondent="Kevin R. Dixon",date="2007-04-02",moreChangesNeeded=false,comments="Moved readObject and writeObject up the inheritance tree."))
public class SparseMatrix
extends SparseRowMatrix

A sparse matrix, represented as a collection of sparse row vectors. Generally, this is the fastest sparse matrix for premultiplying against a vector. Adding elements to this matrix is fast. The matrix will not automatically remove zeroed elements. Based on SparseRowMatrix.

Since:

1.0

Author:

Kevin R. Dixon

See Also:

Serialized Form

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SparseMatrix(int numRows, int numColumns) Creates a new empty instance of SparseMatrix.
protected	SparseMatrix(Matrix matrix) Converts the given matrix to a SparseMatrix.

Method Summary

Methods inherited from class gov.sandia.cognition.math.matrix.mtj.SparseRowMatrix

compact, getEntryCount, getInternalMatrix, getMatrixFactory, getRow, getSubMatrix, setRow, times, transpose

Methods inherited from class gov.sandia.cognition.math.matrix.mtj.AbstractSparseMatrix

getColumn, isSparse, pseudoInverse, setElement, solve, times, toString, toString

Methods inherited from class gov.sandia.cognition.math.matrix.mtj.AbstractMTJMatrix

clone, convertFromVector, convertToVector, dotTimesEquals, dotTimesEquals, equals, get, getElement, getNumColumns, getNumRows, getSubMatrixInto, identity, increment, inverse, isSquare, isSymmetric, iterator, logDeterminant, minusEquals, minusEquals, normFrobenius, normFrobeniusSquared, plusEquals, plusEquals, rank, scaledMinusEquals, scaledPlusEquals, scaledPlusEquals, scaleEquals, set, setInternalMatrix, solve, solve, solve, times, times, timesInto, timesInto, transposeInto, zero

Methods inherited from class gov.sandia.cognition.math.matrix.AbstractMatrix

assertMultiplicationDimensions, assertSameDimensions, checkMultiplicationDimensions, checkSameDimensions, decrement, decrement, dotDivide, dotDivideEquals, equals, equals, getColumnInto, getRowInto, hashCode, increment, isSymmetric, isZero, pseudoInverse, rank, setColumn, setRow, setSubMatrix, sumOfColumns, sumOfRows, toArray, trace, valuesAsList

Methods inherited from class gov.sandia.cognition.math.AbstractRing

dotTimes, isZero, minus, negative, negativeEquals, plus, scale, scaledMinus, scaledMinusEquals, scaledPlus

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface gov.sandia.cognition.math.Ring

dotTimes, isZero, minus, negative, negativeEquals, plus, scale, scaledMinus, scaledMinusEquals, scaledPlus

Constructor Detail

SparseMatrix

protected SparseMatrix(int numRows,
                       int numColumns)

Creates a new empty instance of SparseMatrix.

Parameters:

numRows - Number of rows in the matrix.

numColumns - Number of columns in the matrix.

SparseMatrix

protected SparseMatrix(Matrix matrix)

Converts the given matrix to a SparseMatrix.

Parameters:

matrix - Matrix to convert, will not be modified.