cern.colt.matrix.tdouble.impl
Class DiagonalDoubleMatrix2D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix2D
              cern.colt.matrix.tdouble.DoubleMatrix2D
                  cern.colt.matrix.tdouble.impl.WrapperDoubleMatrix2D
                      cern.colt.matrix.tdouble.impl.DiagonalDoubleMatrix2D

All Implemented Interfaces:

Serializable, Cloneable

public class DiagonalDoubleMatrix2D
extends WrapperDoubleMatrix2D

Diagonal 2-d matrix holding double elements. First see the package summary and javadoc tree view to get the broad picture.

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Field Summary

Fields inherited from class cern.colt.PersistentObject

serialVersionUID

Constructor Summary

DiagonalDoubleMatrix2D(double[][] values, int dindex)
Constructs a matrix with a copy of the given values.

DiagonalDoubleMatrix2D(int rows, int columns, int dindex)
Constructs a matrix with a given number of rows and columns.

Method Summary

DoubleMatrix2D	assign(double value) Sets all cells to the state specified by value.
DoubleMatrix2D	assign(double[] values) Sets all cells to the state specified by values.
DoubleMatrix2D	assign(double[][] values) Sets all cells to the state specified by values.
DoubleMatrix2D	assign(DoubleFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).
DoubleMatrix2D	assign(DoubleMatrix2D source) Replaces all cell values of the receiver with the values of another matrix.
DoubleMatrix2D	assign(DoubleMatrix2D y, DoubleDoubleFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).
int	cardinality() Returns the number of cells having non-zero values; ignores tolerance.
int	dindex()
int	dlength()
double[]	elements() Returns the elements of this matrix.
boolean	equals(double value) Returns whether all cells are equal to the given value.
boolean	equals(Object obj) Compares this object against the specified object.
DoubleMatrix2D	forEachNonZero(IntIntDoubleFunction function) Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]).
double[]	getMaxLocation() Return the maximum value of this matrix together with its location
double[]	getMinLocation() Return the minimum value of this matrix together with its location
double	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
DoubleMatrix2D	like(int rows, int columns) Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns.
DoubleMatrix1D	like1D(int size) Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
void	setQuick(int row, int column, double value) Sets the matrix cell at coordinate [row,column] to the specified value.
DoubleMatrix1D	zMult(DoubleMatrix1D y, DoubleMatrix1D z, double alpha, double beta, boolean transposeA) Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z.

Methods inherited from class cern.colt.matrix.tdouble.impl.WrapperDoubleMatrix2D

setNcolumns, setNrows, vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewStrides

Methods inherited from class cern.colt.matrix.tdouble.DoubleMatrix2D

aggregate, aggregate, aggregate, aggregate, assign, assign, assign, assign, copy, get, getNegativeValues, getNonZeros, getPositiveValues, like, normalize, set, toArray, toString, viewSelection, viewSelection, viewSorted, zAssign8Neighbors, zMult, zMult, zMult, zSum

Methods inherited from class cern.colt.matrix.AbstractMatrix2D

checkShape, checkShape, columns, columnStride, index, rows, rowStride, size, toStringShort

Methods inherited from class cern.colt.matrix.AbstractMatrix

ensureCapacity, isView, trimToSize

Methods inherited from class cern.colt.PersistentObject

clone

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DiagonalDoubleMatrix2D

public DiagonalDoubleMatrix2D(double[][] values,
                              int dindex)

Constructs a matrix with a copy of the given values. values is required to have the form values[row][column] and have exactly the same number of columns in every row. Only the values on the main diagonal, i.e. values[i][i] are used.

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Parameters:

values - The values to be filled into the new matrix.

dindex - index of the diagonal.

Throws:

IllegalArgumentException - if for any 1 <= row < values.length: values[row].length != values[row-1].length || index < -rows+1 || index > columns - 1 .

DiagonalDoubleMatrix2D

public DiagonalDoubleMatrix2D(int rows,
                              int columns,
                              int dindex)

Constructs a matrix with a given number of rows and columns. All entries are initially 0.

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

dindex - index of the diagonal.

Throws:

IllegalArgumentException - if size<0 (double)size > Integer.MAX_VALUE.

Method Detail

assign

public DoubleMatrix2D assign(DoubleFunction function)

Description copied from class: DoubleMatrix2D

Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).

Example:

         matrix = 2 x 2 matrix 
         0.5 1.5      
         2.5 3.5
 
         // change each cell to its sine
         matrix.assign(cern.jet.math.Functions.sin);
         -->
         2 x 2 matrix
         0.479426  0.997495 
         0.598472 -0.350783
 
 

For further examples, see the package doc.

Overrides:

assign in class DoubleMatrix2D

Parameters:

function - a function object taking as argument the current cell's value.

Returns:

this (for convenience only).

See Also:

DoubleFunctions

assign

public DoubleMatrix2D assign(double value)

Sets all cells to the state specified by value.

Overrides:

assign in class DoubleMatrix2D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public DoubleMatrix2D assign(double[] values)

Sets all cells to the state specified by values. values is required to have length equal to the length of the diagonal defined in the constructor.

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Overrides:

assign in class DoubleMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if values.length != rows().

assign

public DoubleMatrix2D assign(double[][] values)

Sets all cells to the state specified by values. values is required to have the form values[row][column] and have exactly the same number of rows and columns as the receiver. Only the values on the diagonal specified in the constructor are used.

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Overrides:

assign in class DoubleMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if values.length != rows() || for any 0 <= row < rows(): values[row].length != columns() .

assign

public DoubleMatrix2D assign(DoubleMatrix2D source)

Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of rows and columns. and the source matrix has to be an instance of DiagonalDoubleMatrix2D.

Overrides:

assign in class DoubleMatrix2D

Parameters:

source - the source matrix to copy from (has to be an instance of DiagonalDoubleMatrix2D).

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if columns() != source.columns() || rows() != source.rows()

assign

public DoubleMatrix2D assign(DoubleMatrix2D y,
                             DoubleDoubleFunction function)

Description copied from class: DoubleMatrix2D

Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).

Example:

         // assign x[row,col] = x[row,col]<sup>y[row,col]</sup>
         m1 = 2 x 2 matrix 
         0 1 
         2 3
 
         m2 = 2 x 2 matrix 
         0 2 
         4 6
 
         m1.assign(m2, cern.jet.math.Functions.pow);
         -->
         m1 == 2 x 2 matrix
         1   1 
         16 729
 
 

For further examples, see the package doc.

Overrides:

assign in class DoubleMatrix2D

Parameters:

y - the secondary matrix to operate on.

function - a function object taking as first argument the current cell's value of this, and as second argument the current cell's value of y,

Returns:

this (for convenience only).

See Also:

DoubleFunctions

cardinality

public int cardinality()

Description copied from class: DoubleMatrix2D

Returns the number of cells having non-zero values; ignores tolerance.

Overrides:

cardinality in class DoubleMatrix2D

Returns:

cardinality

elements

public double[] elements()

Description copied from class: DoubleMatrix2D

Returns the elements of this matrix.

Overrides:

elements in class WrapperDoubleMatrix2D

Returns:

the elements

equals

public boolean equals(double value)

Description copied from class: DoubleMatrix2D

Returns whether all cells are equal to the given value.

Overrides:

equals in class WrapperDoubleMatrix2D

Parameters:

value - the value to test against.

Returns:

true if all cells are equal to the given value, false otherwise.

equals

public boolean equals(Object obj)

Description copied from class: DoubleMatrix2D

Compares this object against the specified object. The result is true if and only if the argument is not null and is at least a DoubleMatrix2D object that has the same number of columns and rows as the receiver and has exactly the same values at the same coordinates.

Overrides:

equals in class WrapperDoubleMatrix2D

Parameters:

obj - the object to compare with.

Returns:

true if the objects are the same; false otherwise.

forEachNonZero

public DoubleMatrix2D forEachNonZero(IntIntDoubleFunction function)

Description copied from class: DoubleMatrix2D

Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]). Use this method for fast special-purpose iteration. If you want to modify another matrix instead of this (i.e. work in read-only mode), simply return the input value unchanged. Parameters to function are as follows: first==row, second==column, third==nonZeroValue.

Overrides:

forEachNonZero in class DoubleMatrix2D

Parameters:

function - a function object taking as argument the current non-zero cell's row, column and value.

Returns:

this (for convenience only).

dlength

public int dlength()

dindex

public int dindex()

getMaxLocation

public double[] getMaxLocation()

Description copied from class: DoubleMatrix2D

Return the maximum value of this matrix together with its location

Overrides:

getMaxLocation in class DoubleMatrix2D

Returns:

maximum_value, row_location, column_location };

getMinLocation

public double[] getMinLocation()

Description copied from class: DoubleMatrix2D

Return the minimum value of this matrix together with its location

Overrides:

getMinLocation in class DoubleMatrix2D

Returns:

minimum_value, row_location, column_location};

getQuick

public double getQuick(int row,
                       int column)

Returns the matrix cell value at coordinate [row,column].

Provided with invalid parameters this method may return invalid objects without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): 0 <= column < columns() && 0 <= row < rows().

Overrides:

getQuick in class WrapperDoubleMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

like

public DoubleMatrix2D like(int rows,
                           int columns)

Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns. For example, if the receiver is an instance of type DenseDoubleMatrix2D the new matrix must also be of type DenseDoubleMatrix2D, if the receiver is an instance of type SparseDoubleMatrix2D the new matrix must also be of type SparseDoubleMatrix2D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Overrides:

like in class WrapperDoubleMatrix2D

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

Returns:

a new empty matrix of the same dynamic type.

like1D

public DoubleMatrix1D like1D(int size)

Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver. For example, if the receiver is an instance of type DenseDoubleMatrix2D the new matrix must be of type DenseDoubleMatrix1D, if the receiver is an instance of type SparseDoubleMatrix2D the new matrix must be of type SparseDoubleMatrix1D, etc.

Overrides:

like1D in class WrapperDoubleMatrix2D

Parameters:

size - the number of cells the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

setQuick

public void setQuick(int row,
                     int column,
                     double value)

Sets the matrix cell at coordinate [row,column] to the specified value. The value is assigned only if row == column;

Provided with invalid parameters this method may access illegal indexes without throwing any exception. You should only use this method when you are absolutely sure that the coordinate is within bounds. Precondition (unchecked): 0 <= column < columns() && 0 <= row < rows().

Overrides:

setQuick in class WrapperDoubleMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

value - the value to be filled into the specified cell.

zMult

public DoubleMatrix1D zMult(DoubleMatrix1D y,
                            DoubleMatrix1D z,
                            double alpha,
                            double beta,
                            boolean transposeA)

Description copied from class: DoubleMatrix2D

Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z. z[i] = alpha*Sum(A[i,j] * y[j]) + beta*z[i], i=0..A.rows()-1, j=0..y.size()-1 . Where A == this.
Note: Matrix shape conformance is checked after potential transpositions.

Overrides:

zMult in class DoubleMatrix2D

Parameters:

y - the source vector.

z - the vector where results are to be stored. Set this parameter to null to indicate that a new result vector shall be constructed.

Returns:

z (for convenience only).