org.openimaj.math.matrix

Class DiagonalMatrix

java.lang.Object

ch.akuhn.matrix.Matrix

org.openimaj.math.matrix.DiagonalMatrix

public class DiagonalMatrix
extends Matrix

Author:

Sina Samangooei (ss@ecs.soton.ac.uk)

Constructor Summary

Constructors

Constructor and Description
DiagonalMatrix(double[][] arr) Diagonal version of the matrix handed
DiagonalMatrix(int rowcol) New empty matrix with 0s down the diagonals
DiagonalMatrix(int rowcol, double val) New empty matrix with val down the diagonals
DiagonalMatrix(Matrix mat)

Method Summary

Modifier and Type	Method and Description
int	columnCount() Get the number of columns
static DiagonalMatrix	fill(int rowcol, double d)
double	get(int row, int column)
double[]	getVals()
Vector	mult(Vector x) Returns y = Ax.
Matrix	newInstance(int rows, int cols)
static DiagonalMatrix	ones(int rowcol)
double	put(int row, int column, double value) Set the value at the given row/column
int	rowCount()
Vector	transposeMultiply(Vector x) Returns y = (A^T)x.
Vector	transposeNonTransposeMultiply(Vector x) Returns y = (A^T)Ax.
int	used()
static DiagonalMatrix	zeros(int rowcol)

Methods inherited from class ch.akuhn.matrix.Matrix

add, asArray, asColumnMajorArray, column, columns, dense, density, elementCount, from, getHistogram, indexOf, isSquare, max, mean, min, newInstance, row, rows, rowwiseMean, sparse, storeSparseOn, storeSparseOn, toString, unwrap

Methods inherited from class java.lang.Object

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

Constructor Detail

DiagonalMatrix

public DiagonalMatrix(int rowcol)

New empty matrix with 0s down the diagonals

Parameters:

rowcol -

DiagonalMatrix

public DiagonalMatrix(int rowcol,
                      double val)

New empty matrix with val down the diagonals

Parameters:

rowcol -

val -

DiagonalMatrix

public DiagonalMatrix(double[][] arr)

Diagonal version of the matrix handed

Parameters:

arr -

DiagonalMatrix

public DiagonalMatrix(Matrix mat)

Parameters:

mat -

Method Detail

mult

public Vector mult(Vector x)

Description copied from class: Matrix

Returns y = Ax.

Overrides:

mult in class Matrix

Returns:

the result

transposeMultiply

public Vector transposeMultiply(Vector x)

Description copied from class: Matrix

Returns y = (A^T)x.

Overrides:

transposeMultiply in class Matrix

Returns:

the result

transposeNonTransposeMultiply

public Vector transposeNonTransposeMultiply(Vector x)

Description copied from class: Matrix

Returns y = (A^T)Ax.

Useful for doing singular decomposition using ARPACK's dsaupd routine.

Overrides:

transposeNonTransposeMultiply in class Matrix

Returns:

the result

columnCount

public int columnCount()

Description copied from class: Matrix

Get the number of columns

Specified by:

columnCount in class Matrix

Returns:

the number of columns

get

public double get(int row,
                  int column)

Specified by:

get in class Matrix

Returns:

the value at the given row and column

put

public double put(int row,
                  int column,
                  double value)

Description copied from class: Matrix

Set the value at the given row/column

Specified by:

put in class Matrix

Returns:

the value being set

rowCount

public int rowCount()

Specified by:

rowCount in class Matrix

Returns:

the number of rows

used

public int used()

Specified by:

used in class Matrix

Returns:

the number of non-zero elements

zeros

public static DiagonalMatrix zeros(int rowcol)

Parameters:

rowcol -

Returns:

a matrix of ones in the diagonal

ones

public static DiagonalMatrix ones(int rowcol)

Parameters:

rowcol -

Returns:

a matrix of ones in the diagonal

fill

public static DiagonalMatrix fill(int rowcol,
                                  double d)

Parameters:

rowcol -

d -

Returns:

a matrix with d in the diagonal

getVals

public double[] getVals()

Returns:

the diagonals

newInstance

public Matrix newInstance(int rows,
                          int cols)

Specified by:

newInstance in class Matrix

Returns:

an empty instance of this matrix type