cern.colt.matrix.tobject.impl
Class DiagonalObjectMatrix2D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix2D
              cern.colt.matrix.tobject.ObjectMatrix2D
                  cern.colt.matrix.tobject.impl.WrapperObjectMatrix2D
                      cern.colt.matrix.tobject.impl.DiagonalObjectMatrix2D

All Implemented Interfaces:

Serializable, Cloneable

public class DiagonalObjectMatrix2D
extends WrapperObjectMatrix2D

Diagonal 2-d matrix holding Object 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

Constructor Summary

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

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

Method Summary

ObjectMatrix2D	assign(Object value) Sets all cells to the state specified by value.
ObjectMatrix2D	assign(Object[] values) Sets all cells to the state specified by values.
ObjectMatrix2D	assign(Object[][] values) Sets all cells to the state specified by values.
ObjectMatrix2D	assign(ObjectFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).
ObjectMatrix2D	assign(ObjectMatrix2D source) Replaces all cell values of the receiver with the values of another matrix.
ObjectMatrix2D	assign(ObjectMatrix2D y, ObjectObjectFunction 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	diagonalIndex() Returns the index of the diagonal
int	diagonalLength() Returns the length of the diagonal
Object[]	elements() Returns the elements of this matrix.
boolean	equals(Object obj) Compares the specified Object with the receiver for equality.
ObjectMatrix2D	forEachNonZero(IntIntObjectFunction function) Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]).
Object	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
ObjectMatrix2D	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.
ObjectMatrix1D	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, Object value) Sets the matrix cell at coordinate [row,column] to the specified value.

Methods inherited from class cern.colt.matrix.tobject.impl.WrapperObjectMatrix2D

assign, vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewStrides

Methods inherited from class cern.colt.matrix.tobject.ObjectMatrix2D

aggregate, aggregate, aggregate, aggregate, assign, assign, assign, copy, equals, get, getNonZeros, like, set, toArray, toString, viewSelection, viewSorted

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

DiagonalObjectMatrix2D

public DiagonalObjectMatrix2D(Object[][] 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 .

DiagonalObjectMatrix2D

public DiagonalObjectMatrix2D(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 (Object)size > Integer.MAX_VALUE.

Method Detail

assign

public ObjectMatrix2D assign(ObjectFunction function)

Description copied from class: ObjectMatrix2D

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 ObjectMatrix2D

Parameters:

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

Returns:

this (for convenience only).

See Also:

DoubleFunctions

assign

public ObjectMatrix2D assign(Object value)

Description copied from class: ObjectMatrix2D

Sets all cells to the state specified by value.

Overrides:

assign in class ObjectMatrix2D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(Object[] values)

Description copied from class: ObjectMatrix2D

Sets all cells to the state specified by values. values is required to have the form values[row*column] and elements have to be stored in a row-wise order.

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

Overrides:

assign in class WrapperObjectMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(Object[][] values)

Description copied from class: ObjectMatrix2D

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.

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

Overrides:

assign in class ObjectMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(ObjectMatrix2D source)

Description copied from class: ObjectMatrix2D

Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of rows and columns. If both matrices share the same cells (as is the case if they are views derived from the same matrix) and intersect in an ambiguous way, then replaces as if using an intermediate auxiliary deep copy of other.

Overrides:

assign in class ObjectMatrix2D

Parameters:

source - the source matrix to copy from (may be identical to the receiver).

Returns:

this (for convenience only).

assign

public ObjectMatrix2D assign(ObjectMatrix2D y,
                             ObjectObjectFunction function)

Description copied from class: ObjectMatrix2D

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

Overrides:

assign in class WrapperObjectMatrix2D

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: ObjectMatrix2D

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

Overrides:

cardinality in class ObjectMatrix2D

elements

public Object[] elements()

Description copied from class: ObjectMatrix2D

Returns the elements of this matrix.

Overrides:

elements in class WrapperObjectMatrix2D

Returns:

the elements

equals

public boolean equals(Object obj)

Description copied from class: ObjectMatrix2D

Compares the specified Object with the receiver for equality. Equivalent to equals(otherObj,true).

Overrides:

equals in class WrapperObjectMatrix2D

Parameters:

obj - the Object to be compared for equality with the receiver.

Returns:

true if the specified Object is equal to the receiver.

forEachNonZero

public ObjectMatrix2D forEachNonZero(IntIntObjectFunction function)

Description copied from class: ObjectMatrix2D

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 ObjectMatrix2D

Parameters:

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

Returns:

this (for convenience only).

diagonalLength

public int diagonalLength()

Returns the length of the diagonal

Returns:

the length of the diagonal

diagonalIndex

public int diagonalIndex()

Returns the index of the diagonal

Returns:

the index of the diagonal

getQuick

public Object getQuick(int row,
                       int column)

Description copied from class: ObjectMatrix2D

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 WrapperObjectMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

like

public ObjectMatrix2D like(int rows,
                           int columns)

Description copied from class: ObjectMatrix2D

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 DenseObjectMatrix2D the new matrix must also be of type DenseObjectMatrix2D, if the receiver is an instance of type SparseObjectMatrix2D the new matrix must also be of type SparseObjectMatrix2D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Overrides:

like in class WrapperObjectMatrix2D

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 ObjectMatrix1D like1D(int size)

Description copied from class: ObjectMatrix2D

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 DenseObjectMatrix2D the new matrix must be of type DenseObjectMatrix1D, if the receiver is an instance of type SparseObjectMatrix2D the new matrix must be of type SparseObjectMatrix1D, etc.

Overrides:

like1D in class WrapperObjectMatrix2D

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,
                     Object value)

Description copied from class: ObjectMatrix2D

Sets the matrix cell at coordinate [row,column] to the specified value.

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 WrapperObjectMatrix2D

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.