xlinear

Class StaticUtils

java.lang.Object

xlinear.StaticUtils

public class StaticUtils
extends java.lang.Object

Static utilities, which, in contrast to those in MatrixOperations, are written without dispatch methods. This makes them marginally more efficient in some case compared to their MatrixOperations counterparts, but the latter is much more user friendly, especially in Xtend (but also in Java). For example, using the MatrixOperations implementation, one could just define the covariance of a Gaussian to be of type Matrix, and efficient operations for the sparse vs dense case will be picked at runtime. In contrast, with the statically linked methods in StaticUtils, one would have to have a Gaussian with SparseMatrix, and one with DenseMatrix.

Constructor Summary

Constructors

Constructor and Description
StaticUtils()

Method Summary

Modifier and Type	Method and Description
static DenseMatrix	add(DenseMatrix matrix1, DenseMatrix matrix2)
static DenseMatrix	add(SparseMatrix matrix2, DenseMatrix matrix1) Design note: Adding a sparse matrix to a dense matrix results in a dense matrix.
static SparseMatrix	add(SparseMatrix matrix1, SparseMatrix matrix2)
static void	addInPlace(DenseMatrix destination, DenseMatrix source)
static void	addInPlace(Matrix destination, SparseMatrix source)
static void	addInPlace(SparseMatrix destination, DenseMatrix source)
static void	checkBounds(Matrix m, int row, int col)
static void	checkMatrixIsSquare(Matrix matrix)
static void	checkMatrixMultiplicationDimensionsMatch(Matrix matrix1, Matrix matrix2)
static void	checkValidSlice(Matrix m, int row0Incl, int row1Excl, int col0Incl, int col1Excl)
static ColtSparseMatrix	convertToColtSparseMatrix(SparseMatrix model)
static CommonsDenseMatrix	convertToCommonsDenseMatrix(DenseMatrix model)
static DenseMatrix	copy(DenseMatrix model)
static SparseMatrix	copy(SparseMatrix model)
static DenseMatrix	createDenseMatrixByCopyingArrayContents(double[] data)
static DenseMatrix	createDenseMatrixByCopyingArrayContents(double[][] data)
static DenseMatrix	createEmptyDenseMatrix(int nRows, int nCols)
static SparseMatrix	createEmptySparseMatrix(int nRows, int nCols)
static SparseMatrix	createSparseMatrixByCopyingArrayContents(double[] data)
static SparseMatrix	createSparseMatrixByCopyingArrayContents(double[][] data)
static java.lang.RuntimeException	denseOrSparseException()
static void	forceVisitAllEntries(Matrix matrix, MatrixVisitorViewOnly visitor) Note: this is inefficient for sparse matrices.
static SparseMatrix	identity(int size)
static void	increment(Matrix m, int row, int col, double increment)
static DenseMatrix	multiply(DenseMatrix dense, SparseMatrix sparse)
static DenseMatrix	multiply(SparseMatrix sparse, DenseMatrix dense)
static java.lang.RuntimeException	notAScalarException()
static java.lang.RuntimeException	notAVectorException()
static java.lang.RuntimeException	notBothSparseAndDense()
static java.lang.RuntimeException	notSquare()
static java.lang.RuntimeException	notSymmetricPosDef()
static org.apache.commons.math3.exception.OutOfRangeException	outOfRangeException(int index, int max, boolean isRow)
static DenseMatrix	scale(DenseMatrix matrix, double scalar)
static SparseMatrix	scale(SparseMatrix matrix, double scalar)
static void	scaleInPlace(DenseMatrix matrix, double scalar)
static void	scaleInPlace(SparseMatrix matrix, double scalar)
static DenseMatrix	subtract(DenseMatrix matrix1, DenseMatrix matrix2)
static DenseMatrix	subtract(DenseMatrix matrix1, SparseMatrix matrix2)
static DenseMatrix	subtract(SparseMatrix matrix1, DenseMatrix matrix2)
static SparseMatrix	subtract(SparseMatrix matrix1, SparseMatrix matrix2)
static void	subtractInPlace(DenseMatrix matrix1, DenseMatrix matrix2)
static void	subtractInPlace(DenseMatrix matrix1, SparseMatrix matrix2)
static void	subtractInPlace(SparseMatrix matrix1, DenseMatrix matrix2)
static void	subtractInPlace(SparseMatrix matrix1, SparseMatrix matrix2)
static java.lang.String	toString(Matrix matrix) Human-readable multi-line tabulated string for the provided matrix.
static java.lang.String	toStringDimensions(Matrix matrix)
static void	visitSkippingSomeZeros(Matrix matrix, MatrixVisitorViewOnly visitor) Iterate over entries of the matrix, where zeros may or may not be skipped depending on the runtime type of the matrix (sparse vs dense)

Methods inherited from class java.lang.Object

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

Constructor Detail

StaticUtils

public StaticUtils()

Method Detail

createDenseMatrixByCopyingArrayContents

public static DenseMatrix createDenseMatrixByCopyingArrayContents(double[][] data)

createSparseMatrixByCopyingArrayContents

public static SparseMatrix createSparseMatrixByCopyingArrayContents(double[][] data)

createDenseMatrixByCopyingArrayContents

public static DenseMatrix createDenseMatrixByCopyingArrayContents(double[] data)

createSparseMatrixByCopyingArrayContents

public static SparseMatrix createSparseMatrixByCopyingArrayContents(double[] data)

createEmptyDenseMatrix

public static DenseMatrix createEmptyDenseMatrix(int nRows,
                                                 int nCols)

createEmptySparseMatrix

public static SparseMatrix createEmptySparseMatrix(int nRows,
                                                   int nCols)

copy

public static SparseMatrix copy(SparseMatrix model)

copy

public static DenseMatrix copy(DenseMatrix model)

convertToColtSparseMatrix

public static ColtSparseMatrix convertToColtSparseMatrix(SparseMatrix model)

convertToCommonsDenseMatrix

public static CommonsDenseMatrix convertToCommonsDenseMatrix(DenseMatrix model)

identity

public static SparseMatrix identity(int size)

toString

public static java.lang.String toString(Matrix matrix)

Human-readable multi-line tabulated string for the provided matrix. Since numbers are rounded and the method is not designed for efficiency, do not use to record matrices to file.

toStringDimensions

public static java.lang.String toStringDimensions(Matrix matrix)

visitSkippingSomeZeros

public static void visitSkippingSomeZeros(Matrix matrix,
                                          MatrixVisitorViewOnly visitor)

Iterate over entries of the matrix, where zeros may or may not be skipped depending on the runtime type of the matrix (sparse vs dense)

forceVisitAllEntries

public static void forceVisitAllEntries(Matrix matrix,
                                        MatrixVisitorViewOnly visitor)

Note: this is inefficient for sparse matrices. Used in cases where this would not be a bottleneck e.g. in toString

multiply

public static DenseMatrix multiply(SparseMatrix sparse,
                                   DenseMatrix dense)

multiply

public static DenseMatrix multiply(DenseMatrix dense,
                                   SparseMatrix sparse)

increment

public static void increment(Matrix m,
                             int row,
                             int col,
                             double increment)

add

public static DenseMatrix add(DenseMatrix matrix1,
                              DenseMatrix matrix2)

addInPlace

public static void addInPlace(DenseMatrix destination,
                              DenseMatrix source)

add

public static SparseMatrix add(SparseMatrix matrix1,
                               SparseMatrix matrix2)

add

public static DenseMatrix add(SparseMatrix matrix2,
                              DenseMatrix matrix1)

Design note: Adding a sparse matrix to a dense matrix results in a dense matrix. SparseMatrix's implementation is inefficient when the matrix is in fact dense, so we return a DenseMatrix.

addInPlace

public static void addInPlace(Matrix destination,
                              SparseMatrix source)

addInPlace

public static void addInPlace(SparseMatrix destination,
                              DenseMatrix source)

scaleInPlace

public static void scaleInPlace(SparseMatrix matrix,
                                double scalar)

scale

public static SparseMatrix scale(SparseMatrix matrix,
                                 double scalar)

scaleInPlace

public static void scaleInPlace(DenseMatrix matrix,
                                double scalar)

scale

public static DenseMatrix scale(DenseMatrix matrix,
                                double scalar)

subtractInPlace

public static void subtractInPlace(DenseMatrix matrix1,
                                   DenseMatrix matrix2)

subtractInPlace

public static void subtractInPlace(SparseMatrix matrix1,
                                   SparseMatrix matrix2)

subtractInPlace

public static void subtractInPlace(SparseMatrix matrix1,
                                   DenseMatrix matrix2)

subtractInPlace

public static void subtractInPlace(DenseMatrix matrix1,
                                   SparseMatrix matrix2)

subtract

public static DenseMatrix subtract(DenseMatrix matrix1,
                                   DenseMatrix matrix2)

subtract

public static SparseMatrix subtract(SparseMatrix matrix1,
                                    SparseMatrix matrix2)

subtract

public static DenseMatrix subtract(SparseMatrix matrix1,
                                   DenseMatrix matrix2)

subtract

public static DenseMatrix subtract(DenseMatrix matrix1,
                                   SparseMatrix matrix2)

checkValidSlice

public static void checkValidSlice(Matrix m,
                                   int row0Incl,
                                   int row1Excl,
                                   int col0Incl,
                                   int col1Excl)

checkBounds

public static void checkBounds(Matrix m,
                               int row,
                               int col)

outOfRangeException

public static org.apache.commons.math3.exception.OutOfRangeException outOfRangeException(int index,
                                                                                         int max,
                                                                                         boolean isRow)

checkMatrixMultiplicationDimensionsMatch

public static void checkMatrixMultiplicationDimensionsMatch(Matrix matrix1,
                                                            Matrix matrix2)

checkMatrixIsSquare

public static void checkMatrixIsSquare(Matrix matrix)

notAVectorException

public static java.lang.RuntimeException notAVectorException()

notAScalarException

public static java.lang.RuntimeException notAScalarException()

notSymmetricPosDef

public static java.lang.RuntimeException notSymmetricPosDef()

notSquare

public static java.lang.RuntimeException notSquare()

denseOrSparseException

public static java.lang.RuntimeException denseOrSparseException()

notBothSparseAndDense

public static java.lang.RuntimeException notBothSparseAndDense()