org.ejml.data

Class DMatrixSparseTriplet

java.lang.Object

org.ejml.data.DMatrixSparseTriplet

All Implemented Interfaces:

java.io.Serializable, DMatrix, DMatrixSparse, Matrix, MatrixSparse, ReshapeMatrix

public class DMatrixSparseTriplet
extends java.lang.Object
implements DMatrixSparse

TODO describe

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
int	numCols
int	numRows
int	nz_length
IGrowArray	nz_rowcol Storage for row and column coordinate for non-zero elements
DGrowArray	nz_value Storage for value of a non-zero element

Constructor Summary

Constructors

Constructor and Description
DMatrixSparseTriplet()
DMatrixSparseTriplet(DMatrixSparseTriplet orig)
DMatrixSparseTriplet(int numRows, int numCols, int initLength)

Method Summary

Modifier and Type	Method and Description
void	addItem(int row, int col, double value)
void	addItemCheck(int row, int col, double value)
<T extends Matrix> T	copy() Creates an exact copy of the matrix
<T extends Matrix> T	createLike() Creates a new matrix with the same shape as this matrix
double	get(int row, int col) Returns the value of value of the specified matrix element.
int	getLength()
int	getNonZeroLength() Returns the number of non-zero elements.
int	getNumCols() Returns the number of columns in this matrix.
int	getNumElements() Returns the number of elements in this matrix, which is the number of rows times the number of columns.
int	getNumRows() Returns the number of rows in this matrix.
MatrixType	getType() Returns the type of matrix
boolean	isAssigned(int row, int col) Is the specified element explicitly assigned a value
int	nz_index(int row, int col)
void	print() Prints the matrix to standard out using standard formatting.
void	print(java.lang.String format) Prints the matrix to standard out with the specified formatting.
void	printNonZero() Prints to standard out the non-zero elements only.
void	remove(int row, int col) If the specified element is non-zero it is removed from the structure
void	reset()
void	reshape(int numRows, int numCols) Changes the number of rows and columns in the matrix.
void	reshape(int numRows, int numCols, int arrayLength) Reshapes the matrix so that it can store a matrix with the specified dimensions and the number of non-zero elements.
void	set(int row, int col, double value) Sets the value of the specified matrix element.
void	set(Matrix original) Sets this matrix to be identical to the 'original' matrix passed in.
void	shrinkArrays() Reduces the size of internal data structures to their minimal size.
double	unsafe_get(int row, int col) Same as DMatrix.get(int, int) but does not perform bounds check on input parameters.
void	unsafe_set(int row, int col, double value) Same as DMatrix.set(int, int, double) but does not perform bounds check on input parameters.
void	zero() Sets all elements to zero by removing the sparse graph

Methods inherited from class java.lang.Object

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

Field Detail

nz_rowcol

public IGrowArray nz_rowcol

Storage for row and column coordinate for non-zero elements

nz_value

public DGrowArray nz_value

Storage for value of a non-zero element

nz_length

public int nz_length

numRows

public int numRows

numCols

public int numCols

Constructor Detail

DMatrixSparseTriplet

public DMatrixSparseTriplet()

DMatrixSparseTriplet

public DMatrixSparseTriplet(int numRows,
                            int numCols,
                            int initLength)

Parameters:

numRows - Number of rows in the matrix

numCols - Number of columns in the matrix

initLength - Initial maximum length of data array.

DMatrixSparseTriplet

public DMatrixSparseTriplet(DMatrixSparseTriplet orig)

Method Detail

reset

public void reset()

reshape

public void reshape(int numRows,
                    int numCols)

Description copied from interface: MatrixSparse

Changes the number of rows and columns in the matrix. The graph structure is flushed and the matrix will be empty/all zeros. Similar to MatrixSparse.reshape(int, int, int), but the storage for non-zero elements is not changed

Specified by:

reshape in interface MatrixSparse

Specified by:

reshape in interface ReshapeMatrix

Parameters:

numRows - number of rows

numCols - number of columns

reshape

public void reshape(int numRows,
                    int numCols,
                    int arrayLength)

Description copied from interface: MatrixSparse

Reshapes the matrix so that it can store a matrix with the specified dimensions and the number of non-zero elements. The reshaped matrix will be empty.

Specified by:

reshape in interface MatrixSparse

Parameters:

numRows - number of rows

numCols - number of columns

arrayLength - Array length for storing non-zero elements.

addItem

public void addItem(int row,
                    int col,
                    double value)

addItemCheck

public void addItemCheck(int row,
                         int col,
                         double value)

set

public void set(int row,
                int col,
                double value)

Description copied from interface: DMatrix

Sets the value of the specified matrix element.

Specified by:

set in interface DMatrix

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

value - The element's new value.

unsafe_set

public void unsafe_set(int row,
                       int col,
                       double value)

Description copied from interface: DMatrix

Same as DMatrix.set(int, int, double) but does not perform bounds check on input parameters. This results in about a 25% speed increase but potentially sacrifices stability and makes it more difficult to track down simple errors. It is not recommended that this function be used, except in highly optimized code where the bounds are implicitly being checked.

Specified by:

unsafe_set in interface DMatrix

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

value - The element's new value.

getNumElements

public int getNumElements()

Description copied from interface: DMatrix

Returns the number of elements in this matrix, which is the number of rows times the number of columns.

Specified by:

getNumElements in interface DMatrix

Returns:

Number of elements in this matrix.

get

public double get(int row,
                  int col)

Description copied from interface: DMatrix

Returns the value of value of the specified matrix element.

Specified by:

get in interface DMatrix

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

Returns:

The specified element's value.

unsafe_get

public double unsafe_get(int row,
                         int col)

Description copied from interface: DMatrix

Same as DMatrix.get(int, int) but does not perform bounds check on input parameters. This results in about a 25% speed increase but potentially sacrifices stability and makes it more difficult to track down simple errors. It is not recommended that this function be used, except in highly optimized code where the bounds are implicitly being checked.

Specified by:

unsafe_get in interface DMatrix

Parameters:

row - Matrix element's row index..

col - Matrix element's column index.

Returns:

The specified element's value.

nz_index

public int nz_index(int row,
                    int col)

getLength

public int getLength()

getNumRows

public int getNumRows()

Description copied from interface: Matrix

Returns the number of rows in this matrix.

Specified by:

getNumRows in interface Matrix

Returns:

Number of rows.

getNumCols

public int getNumCols()

Description copied from interface: Matrix

Returns the number of columns in this matrix.

Specified by:

getNumCols in interface Matrix

Returns:

Number of columns.

copy

public <T extends Matrix> T copy()

Description copied from interface: Matrix

Creates an exact copy of the matrix

Specified by:

copy in interface Matrix

createLike

public <T extends Matrix> T createLike()

Description copied from interface: Matrix

Creates a new matrix with the same shape as this matrix

Specified by:

createLike in interface Matrix

set

public void set(Matrix original)

Description copied from interface: Matrix

Sets this matrix to be identical to the 'original' matrix passed in.

Specified by:

set in interface Matrix

shrinkArrays

public void shrinkArrays()

Description copied from interface: MatrixSparse

Reduces the size of internal data structures to their minimal size. No information is lost but the arrays will change

Specified by:

shrinkArrays in interface MatrixSparse

remove

public void remove(int row,
                   int col)

Description copied from interface: MatrixSparse

If the specified element is non-zero it is removed from the structure

Specified by:

remove in interface MatrixSparse

Parameters:

row - the row

col - the column

isAssigned

public boolean isAssigned(int row,
                          int col)

Description copied from interface: MatrixSparse

Is the specified element explicitly assigned a value

Specified by:

isAssigned in interface MatrixSparse

Parameters:

row - the row

col - the column

Returns:

true if it has been assigned a value or false if not

zero

public void zero()

Description copied from interface: MatrixSparse

Sets all elements to zero by removing the sparse graph

Specified by:

zero in interface MatrixSparse

getNonZeroLength

public int getNonZeroLength()

Description copied from interface: MatrixSparse

Returns the number of non-zero elements.

Specified by:

getNonZeroLength in interface MatrixSparse

print

public void print()

Description copied from interface: Matrix

Prints the matrix to standard out using standard formatting. This is the same as calling print("%e")

Specified by:

print in interface Matrix

print

public void print(java.lang.String format)

Description copied from interface: Matrix

Prints the matrix to standard out with the specified formatting.

Specified by:

print in interface Matrix

Parameters:

format - printf style formatting for a float. E.g. "%f"

See Also:

Formatter

printNonZero

public void printNonZero()

Description copied from interface: MatrixSparse

Prints to standard out the non-zero elements only.

Specified by:

printNonZero in interface MatrixSparse

getType

public MatrixType getType()

Description copied from interface: Matrix

Returns the type of matrix

Specified by:

getType in interface Matrix