gov.sandia.cognition.math.matrix.custom

Class CustomDiagonalMatrixFactory

java.lang.Object

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

gov.sandia.cognition.math.matrix.custom.CustomDiagonalMatrixFactory

All Implemented Interfaces:

java.io.Serializable

public class CustomDiagonalMatrixFactory
extends MatrixFactory<DiagonalMatrix>

Factory for diagonal matrices.

Since:

4.0.0

Author:

Jeremy D. Wendt

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static CustomDiagonalMatrixFactory	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
CustomDiagonalMatrixFactory()

Method Summary

Modifier and Type	Method and Description
DiagonalMatrix	copyMatrix(Matrix m) Creates a deep copy new Matrix given another, argument is unchanged
DiagonalMatrix	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 CustomDiagonalMatrixFactory INSTANCE

An instance of this class.

Constructor Detail

CustomDiagonalMatrixFactory

public CustomDiagonalMatrixFactory()

Method Detail

copyMatrix

public final DiagonalMatrix copyMatrix(Matrix m)

Creates a deep copy new Matrix given another, argument is unchanged

Specified by:

copyMatrix in class MatrixFactory<DiagonalMatrix>

Parameters:

m - Matrix to copy

Returns:

Deep copy of the given Matrix

Throws:

java.lang.IllegalArgumentException - if the input matrix isn't square (because diagonal matrices must be) or if the input matrix has non-zero entries on the diagonal.

createMatrix

public final DiagonalMatrix createMatrix(int numRows,
                                         int numColumns)

Creates an empty Matrix of the specified dimensions, all elements must be all zeros!

Specified by:

createMatrix in class MatrixFactory<DiagonalMatrix>

Parameters:

numRows - number of rows in the Matrix

numColumns - number of columns in the Matrix

Returns:

All-zero empty Matrix of the specified dimensions

Throws:

java.lang.IllegalArgumentException - if the input dimensions are not square (because diagonal matrices must be)