gov.sandia.cognition.math.matrix.custom

Class CustomSparseMatrixFactory

java.lang.Object

gov.sandia.cognition.math.matrix.MatrixFactory<SparseMatrix>

gov.sandia.cognition.math.matrix.custom.CustomSparseMatrixFactory

All Implemented Interfaces:

java.io.Serializable

public class CustomSparseMatrixFactory
extends MatrixFactory<SparseMatrix>

Factory for Sparse Matrices.

Since:

4.0.0

Author:

Jeremy D. Wendt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CustomSparseMatrixFactory	INSTANCE An instance of this class.

Fields inherited from class gov.sandia.cognition.math.matrix.MatrixFactory

DEFAULT_DENSE_INSTANCE, DEFAULT_DIAGONAL_INSTANCE, DEFAULT_SPARSE_INSTANCE

Constructor Summary

Constructors

Constructor and Description
CustomSparseMatrixFactory()

Method Summary

Modifier and Type	Method and Description
SparseMatrix	copyMatrix(Matrix m) Creates a deep copy new Matrix given another, argument is unchanged
SparseMatrix	createMatrix(int numRows, int numColumns) Creates an empty Matrix of the specified dimensions, all elements must be all zeros!

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

copyArray, copyColumnVectors, copyColumnVectors, copyRowVectors, copyRowVectors, createDiagonal, createGaussianRandom, createIdentity, createIdentity, createMatrix, createUniformRandom, createUniformRandom, getDefault, getDenseDefault, getDiagonalDefault, getSparseDefault

Methods inherited from class java.lang.Object

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

Field Detail

INSTANCE

public static CustomSparseMatrixFactory INSTANCE

An instance of this class.

Constructor Detail

CustomSparseMatrixFactory

public CustomSparseMatrixFactory()

Method Detail

copyMatrix

public final SparseMatrix copyMatrix(Matrix m)

Creates a deep copy new Matrix given another, argument is unchanged NOTE: Returned matrix is Yale format if m is Diagonal, Dense, or Sparse in Yale format. Is sparse row if m is Sparse and in sparse row format.

Specified by:

copyMatrix in class MatrixFactory<SparseMatrix>

Parameters:

m - Matrix to copy

Returns:

Deep copy of the given Matrix

createMatrix

public final SparseMatrix createMatrix(int numRows,
                                       int numColumns)

Creates an empty Matrix of the specified dimensions, all elements must be all zeros! NOTE: Returned matrix is sparse row format.

Specified by:

createMatrix in class MatrixFactory<SparseMatrix>

Parameters:

numRows - number of rows in the Matrix

numColumns - number of columns in the Matrix

Returns:

All-zero empty Matrix of the specified dimensions