DenseDoubleMatrix2D (Parallel Colt 0.10.1

java.lang.Object
- cern.colt.PersistentObject
- - cern.colt.matrix.AbstractMatrix
  - - cern.colt.matrix.AbstractMatrix2D
    - - cern.colt.matrix.tdouble.DoubleMatrix2D
      - cern.colt.matrix.tdouble.impl.DenseDoubleMatrix2D

All Implemented Interfaces:

Serializable, Cloneable
```
public class DenseDoubleMatrix2D
extends DoubleMatrix2D
```
Dense 2-d matrix holding double elements. First see the package summary and javadoc tree view to get the broad picture.
Implementation:
Internally holds one single contigous one-dimensional array, addressed in row major. Note that this implementation is not synchronized.
Time complexity:
O(1) (i.e. constant time) for the basic operations get, getQuick, set, setQuick and size,
Cells are internally addressed in row-major. Applications demanding utmost speed can exploit this fact. Setting/getting values in a loop row-by-row is quicker than column-by-column. Thus
```
 for (int row = 0; row < rows; row++) {
     for (int column = 0; column < columns; column++) {
         matrix.setQuick(row, column, someValue);
     }
 }
 
```
is quicker than
```
 for (int column = 0; column < columns; column++) {
     for (int row = 0; row < rows; row++) {
         matrix.setQuick(row, column, someValue);
     }
 }
 
```
Version:

1.0, 09/24/99

Author:

wolfgang.hoschek@cern.ch, Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`DenseDoubleMatrix2D(double[][] values)` Constructs a matrix with a copy of the given values.
`DenseDoubleMatrix2D(int rows, int columns)` Constructs a matrix with a given number of rows and columns.
`DenseDoubleMatrix2D(int rows, int columns, double[] elements, int rowZero, int columnZero, int rowStride, int columnStride, boolean isView)` Constructs a matrix with the given parameters.
`DenseDoubleMatrix2D(MatrixVectorReader reader)` Constructs a matrix from MatrixVectorReader.

Method Summary

Methods
Modifier and Type	Method and Description
`double`	`aggregate(DoubleDoubleFunction aggr, DoubleFunction f)` Applies a function to each cell and aggregates the results.
`double`	`aggregate(DoubleDoubleFunction aggr, DoubleFunction f, DoubleProcedure cond)` Applies a function to each cell that satisfies a condition and aggregates the results.
`double`	`aggregate(DoubleDoubleFunction aggr, DoubleFunction f, IntArrayList rowList, IntArrayList columnList)` Applies a function to all cells with a given indexes and aggregates the results.
`double`	`aggregate(DoubleMatrix2D other, DoubleDoubleFunction aggr, DoubleDoubleFunction f)` Applies a function to each corresponding cell of two matrices and aggregates the results.
`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])`.
`DoubleMatrix2D`	`assign(DoubleMatrix2D y, DoubleDoubleFunction function, IntArrayList rowList, IntArrayList columnList)` Assigns the result of a function to all cells with a given indexes
`DoubleMatrix2D`	`assign(DoubleProcedure cond, double value)` Assigns a value to all cells that satisfy a condition.
`DoubleMatrix2D`	`assign(DoubleProcedure cond, DoubleFunction function)` Assigns the result of a function to all cells that satisfy a condition.
`DoubleMatrix2D`	`assign(float[] values)` Sets all cells to the state specified by `values`.
`int`	`cardinality()` Returns the number of cells having non-zero values; ignores tolerance.
`void`	`dct2(boolean scale)` Computes the 2D discrete cosine transform (DCT-II) of this matrix.
`void`	`dctColumns(boolean scale)` Computes the discrete cosine transform (DCT-II) of each column of this matrix.
`void`	`dctRows(boolean scale)` Computes the discrete cosine transform (DCT-II) of each row of this matrix.
`void`	`dht2()` Computes the 2D discrete Hartley transform (DHT) of this matrix.
`void`	`dhtColumns()` Computes the discrete Hartley transform (DHT) of each column of this matrix.
`void`	`dhtRows()` Computes the discrete Hartley transform (DHT) of each row of this matrix.
`void`	`dst2(boolean scale)` Computes the 2D discrete sine transform (DST-II) of this matrix.
`void`	`dstColumns(boolean scale)` Computes the discrete sine transform (DST-II) of each column of this matrix.
`void`	`dstRows(boolean scale)` Computes the discrete sine transform (DST-II) of each row of this matrix.
`double[]`	`elements()` Returns the elements of this matrix.
`void`	`fft2()` Computes the 2D discrete Fourier transform (DFT) of this matrix.
`DoubleMatrix2D`	`forEachNonZero(IntIntDoubleFunction function)` Assigns the result of a function to each non-zero cell; `x[row,col] = function(x[row,col])`.
`DenseColumnDoubleMatrix2D`	`getColumnMajor()` Returns a new matrix that has the same elements as this matrix, but they are addressed internally in column major.
`DenseDComplexMatrix2D`	`getFft2()` Returns new complex matrix which is the 2D discrete Fourier transform (DFT) of this matrix.
`DenseDComplexMatrix2D`	`getFftColumns()` Returns new complex matrix which is the discrete Fourier transform (DFT) of each column of this matrix.
`DenseDComplexMatrix2D`	`getFftRows()` Returns new complex matrix which is the discrete Fourier transform (DFT) of each row of this matrix.
`DenseDComplexMatrix2D`	`getIfft2(boolean scale)` Returns new complex matrix which is the 2D inverse of the discrete Fourier transform (IDFT) of this matrix.
`DenseDComplexMatrix2D`	`getIfftColumns(boolean scale)` Returns new complex matrix which is the inverse of the discrete Fourier transform (IDFT) of each column of this matrix.
`DenseDComplexMatrix2D`	`getIfftRows(boolean scale)` Returns new complex matrix which is the inverse of the discrete Fourier transform (IDFT) of each row of this matrix.
`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
`void`	`getNegativeValues(IntArrayList rowList, IntArrayList columnList, DoubleArrayList valueList)` Fills the coordinates and values of cells having negative values into the specified lists.
`void`	`getNonZeros(IntArrayList rowList, IntArrayList columnList, DoubleArrayList valueList)` Fills the coordinates and values of cells having non-zero values into the specified lists.
`void`	`getPositiveValues(IntArrayList rowList, IntArrayList columnList, DoubleArrayList valueList)` Fills the coordinates and values of cells having positive values into the specified lists.
`double`	`getQuick(int row, int column)` Returns the matrix cell value at coordinate `[row,column]`.
`void`	`idct2(boolean scale)` Computes the 2D inverse of the discrete cosine transform (DCT-III) of this matrix.
`void`	`idctColumns(boolean scale)` Computes the inverse of the discrete cosine transform (DCT-III) of each column of this matrix.
`void`	`idctRows(boolean scale)` Computes the inverse of the discrete cosine transform (DCT-III) of each row of this matrix.
`void`	`idht2(boolean scale)` Computes the 2D inverse of the discrete Hartley transform (IDHT) of this matrix.
`void`	`idhtColumns(boolean scale)` Computes the inverse of the discrete Hartley transform (IDHT) of each column of this matrix.
`void`	`idhtRows(boolean scale)` Computes the inverse of the discrete Hartley transform (IDHT) of each row of this matrix.
`void`	`idst2(boolean scale)` Computes the 2D inverse of the discrete sine transform (DST-III) of this matrix.
`void`	`idstColumns(boolean scale)` Computes the inverse of the discrete sine transform (DST-III) of each column of this matrix.
`void`	`idstRows(boolean scale)` Computes the inverse of the discrete sine transform (DST-III) of each row of this matrix.
`void`	`ifft2(boolean scale)` Computes the 2D inverse of the discrete Fourier transform (IDFT) of this matrix.
`long`	`index(int row, int column)` Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
`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.
`double[][]`	`toArray()` Constructs and returns a 2-dimensional array containing the cell values.
`DoubleMatrix1D`	`vectorize()` Returns a vector obtained by stacking the columns of the matrix on top of one another.
`void`	`zAssign8Neighbors(DoubleMatrix2D B, Double9Function function)` 8 neighbor stencil transformation.
`DoubleMatrix1D`	`zMult(DoubleMatrix1D y, DoubleMatrix1D z, double alpha, double beta, boolean transposeA)` Linear algebraic matrix-vector multiplication; `z = alpha * A * y + beta*z`.
`DoubleMatrix2D`	`zMult(DoubleMatrix2D B, DoubleMatrix2D C, double alpha, double beta, boolean transposeA, boolean transposeB)` Linear algebraic matrix-matrix multiplication; `C = alpha * A x B + beta*C`.
`double`	`zSum()` Returns the sum of all cells; `Sum( x[i,j] )`.

Methods inherited from class cern.colt.matrix.tdouble.DoubleMatrix2D
copy, equals, equals, get, like, normalize, set, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSelection, viewSorted, viewStrides, zMult, zMult

Methods inherited from class cern.colt.matrix.AbstractMatrix2D
checkShape, checkShape, columns, columnStride, 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
  - DenseDoubleMatrix2D
```
public DenseDoubleMatrix2D(double[][] values)
```
    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.
    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.
    
    Throws:
    
    IllegalArgumentException - if for any 1 <= row < values.length: values[row].length != values[row-1].length .
  - DenseDoubleMatrix2D
```
public DenseDoubleMatrix2D(int rows,
                   int columns)
```
    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.
    
    Throws:
    
    IllegalArgumentException - if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE .
  - DenseDoubleMatrix2D
```
public DenseDoubleMatrix2D(int rows,
                   int columns,
                   double[] elements,
                   int rowZero,
                   int columnZero,
                   int rowStride,
                   int columnStride,
                   boolean isView)
```
    Constructs a matrix with the given parameters.
    
    Parameters:
    rows - the number of rows the matrix shall have.
    columns - the number of columns the matrix shall have.
    elements - the cells.
    rowZero - the position of the first element.
    columnZero - the position of the first element.
    rowStride - the number of elements between two rows, i.e. index(i+1,j)-index(i,j).
    columnStride - the number of elements between two columns, i.e. index(i,j+1)-index(i,j).
    isView - if true then a matrix view is constructed
    
    Throws:
    
    IllegalArgumentException - if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE or flip's are illegal.
  - DenseDoubleMatrix2D
```
public DenseDoubleMatrix2D(MatrixVectorReader reader)
                    throws IOException
```
    Constructs a matrix from MatrixVectorReader.
    
    Parameters:
    reader - matrix reader
    
    Throws:
    
    IOException
- Method Detail
  - aggregate
```
public double aggregate(DoubleDoubleFunction aggr,
               DoubleFunction f)
```
    Description copied from class: DoubleMatrix2D
    Applies a function to each cell and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(row,column)) ) and terminators are a(1) == f(get(0,0)), a(0)==Double.NaN.
    Example:
```
         cern.jet.math.Functions F = cern.jet.math.Functions.functions;
         2 x 2 matrix
         0 1
         2 3
 
         // Sum( x[row,col]*x[row,col] ) 
         matrix.aggregate(F.plus,F.square);
         --> 14
 
 
```
    For further examples, see the package doc.
    Overrides:
    
    aggregate in class DoubleMatrix2D
    
    Parameters:
    aggr - an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell value.
    f - a function transforming the current cell value.
    
    Returns:
    the aggregated measure.
    See Also:
    DoubleFunctions
  - aggregate
```
public double aggregate(DoubleDoubleFunction aggr,
               DoubleFunction f,
               DoubleProcedure cond)
```
    Description copied from class: DoubleMatrix2D
    
    Applies a function to each cell that satisfies a condition and aggregates the results.
    
    Overrides:
    
    aggregate in class DoubleMatrix2D
    
    Parameters:
    aggr - an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell value.
    f - a function transforming the current cell value.
    cond - a condition.
    
    Returns:
    the aggregated measure.
    See Also:
    DoubleFunctions
  - aggregate
```
public double aggregate(DoubleDoubleFunction aggr,
               DoubleFunction f,
               IntArrayList rowList,
               IntArrayList columnList)
```
    Description copied from class: DoubleMatrix2D
    
    Applies a function to all cells with a given indexes and aggregates the results.
    
    Overrides:
    
    aggregate in class DoubleMatrix2D
    
    Parameters:
    aggr - an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell value.
    f - a function transforming the current cell value.
    rowList - row indexes.
    columnList - column indexes.
    
    Returns:
    the aggregated measure.
    See Also:
    DoubleFunctions
  - aggregate
```
public double aggregate(DoubleMatrix2D other,
               DoubleDoubleFunction aggr,
               DoubleDoubleFunction f)
```
    Description copied from class: DoubleMatrix2D
    Applies a function to each corresponding cell of two matrices and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(row,column),other.get(row,column)) ) and terminators are a(1) == f(get(0,0),other.get(0,0)), a(0)==Double.NaN.
    Example:
```
         cern.jet.math.Functions F = cern.jet.math.Functions.functions;
         x == 2 x 2 matrix
         0 1
         2 3
 
         y == 2 x 2 matrix
         0 1
         2 3
 
         // Sum( x[row,col] * y[row,col] ) 
         x.aggregate(y, F.plus, F.mult);
         --> 14
 
         // Sum( (x[row,col] + y[row,col])ˆ2 )
         x.aggregate(y, F.plus, F.chain(F.square,F.plus));
         --> 56
 
 
```
    For further examples, see the package doc.
    Overrides:
    
    aggregate in class DoubleMatrix2D
    
    aggr - an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell values.
    f - a function transforming the current cell values.
    
    Returns:
    the aggregated measure.
    See Also:
    DoubleFunctions
  - 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(DoubleProcedure cond,
                    DoubleFunction function)
```
    Description copied from class: DoubleMatrix2D
    
    Assigns the result of a function to all cells that satisfy a condition.
    
    Overrides:
    
    assign in class DoubleMatrix2D
    
    Parameters:
    cond - a condition.
    function - a function object.
    
    Returns:
    this (for convenience only).
    See Also:
    DoubleFunctions
  - assign
```
public DoubleMatrix2D assign(DoubleProcedure cond,
                    double value)
```
    Description copied from class: DoubleMatrix2D
    
    Assigns a value to all cells that satisfy a condition.
    
    Overrides:
    
    assign in class DoubleMatrix2D
    
    Parameters:
    cond - a condition.
    value - a value.
    
    Returns:
    this (for convenience only).
  - assign
```
public DoubleMatrix2D assign(double value)
```
    Description copied from class: DoubleMatrix2D
    
    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)
```
    Description copied from class: DoubleMatrix2D
    
    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 DoubleMatrix2D
    
    Parameters:
    values - the values to be filled into the cells.
    
    Returns:
    this (for convenience only).
  - assign
```
public DoubleMatrix2D assign(double[][] values)
```
    Description copied from class: DoubleMatrix2D
    
    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 DoubleMatrix2D
    
    Parameters:
    values - the values to be filled into the cells.
    
    Returns:
    this (for convenience only).
  - assign
```
public DoubleMatrix2D assign(DoubleMatrix2D source)
```
    Description copied from class: DoubleMatrix2D
    
    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 DoubleMatrix2D
    
    Parameters:
    source - the source matrix to copy from (may be identical to the receiver).
    
    Returns:
    this (for convenience only).
  - 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
  - assign
```
public DoubleMatrix2D assign(DoubleMatrix2D y,
                    DoubleDoubleFunction function,
                    IntArrayList rowList,
                    IntArrayList columnList)
```
    Description copied from class: DoubleMatrix2D
    
    Assigns the result of a function to all cells with a given indexes
    
    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,
    rowList - row indexes.
    columnList - column indexes.
    
    Returns:
    this (for convenience only).
    See Also:
    DoubleFunctions
  - assign
```
public DoubleMatrix2D assign(float[] values)
```
    Description copied from class: DoubleMatrix2D
    
    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 DoubleMatrix2D
    
    Parameters:
    values - the values to be filled into the cells.
    
    Returns:
    this (for convenience only).
  - 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
  - dct2
```
public void dct2(boolean scale)
```
    Computes the 2D discrete cosine transform (DCT-II) of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - dctColumns
```
public void dctColumns(boolean scale)
```
    Computes the discrete cosine transform (DCT-II) of each column of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - dctRows
```
public void dctRows(boolean scale)
```
    Computes the discrete cosine transform (DCT-II) of each row of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - dht2
```
public void dht2()
```
    Computes the 2D discrete Hartley transform (DHT) of this matrix.
  - dhtColumns
```
public void dhtColumns()
```
    Computes the discrete Hartley transform (DHT) of each column of this matrix.
  - dhtRows
```
public void dhtRows()
```
    Computes the discrete Hartley transform (DHT) of each row of this matrix.
  - dst2
```
public void dst2(boolean scale)
```
    Computes the 2D discrete sine transform (DST-II) of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - dstColumns
```
public void dstColumns(boolean scale)
```
    Computes the discrete sine transform (DST-II) of each column of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - dstRows
```
public void dstRows(boolean scale)
```
    Computes the discrete sine transform (DST-II) of each row of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - elements
```
public double[] elements()
```
    Description copied from class: DoubleMatrix2D
    
    Returns the elements of this matrix.
    
    Specified by:
    
    elements in class DoubleMatrix2D
    
    Returns:
    the elements
  - fft2
```
public void fft2()
```
    Computes the 2D discrete Fourier transform (DFT) of this matrix. The physical layout of the output data is as follows:
```
 this[k1][2*k2] = Re[k1][k2] = Re[rows-k1][columns-k2], 
 this[k1][2*k2+1] = Im[k1][k2] = -Im[rows-k1][columns-k2], 
       0<k1<rows, 0<k2<columns/2, 
 this[0][2*k2] = Re[0][k2] = Re[0][columns-k2], 
 this[0][2*k2+1] = Im[0][k2] = -Im[0][columns-k2], 
       0<k2<columns/2, 
 this[k1][0] = Re[k1][0] = Re[rows-k1][0], 
 this[k1][1] = Im[k1][0] = -Im[rows-k1][0], 
 this[rows-k1][1] = Re[k1][columns/2] = Re[rows-k1][columns/2], 
 this[rows-k1][0] = -Im[k1][columns/2] = Im[rows-k1][columns/2], 
       0<k1<rows/2, 
 this[0][0] = Re[0][0], 
 this[0][1] = Re[0][columns/2], 
 this[rows/2][0] = Re[rows/2][0], 
 this[rows/2][1] = Re[rows/2][columns/2]
 
```
    This method computes only half of the elements of the real transform. The other half satisfies the symmetry condition. If you want the full real forward transform, use getFft2. To get back the original data, use ifft2.
    Throws:
    
    IllegalArgumentException - if the row size or the column size of this matrix is not a power of 2 number.
  - 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).
  - getColumnMajor
```
public DenseColumnDoubleMatrix2D getColumnMajor()
```
    Returns a new matrix that has the same elements as this matrix, but they are addressed internally in column major. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.
    
    Returns:
    this matrix with elements addressed internally in column major
  - getFft2
```
public DenseDComplexMatrix2D getFft2()
```
    Returns new complex matrix which is the 2D discrete Fourier transform (DFT) of this matrix.
    
    Returns:
    the 2D discrete Fourier transform (DFT) of this matrix.
  - getFftColumns
```
public DenseDComplexMatrix2D getFftColumns()
```
    Returns new complex matrix which is the discrete Fourier transform (DFT) of each column of this matrix.
    
    Returns:
    the discrete Fourier transform (DFT) of each column of this matrix.
  - getFftRows
```
public DenseDComplexMatrix2D getFftRows()
```
    Returns new complex matrix which is the discrete Fourier transform (DFT) of each row of this matrix.
    
    Returns:
    the discrete Fourier transform (DFT) of each row of this matrix.
  - getIfft2
```
public DenseDComplexMatrix2D getIfft2(boolean scale)
```
    Returns new complex matrix which is the 2D inverse of the discrete Fourier transform (IDFT) of this matrix.
    
    Returns:
    the 2D inverse of the discrete Fourier transform (IDFT) of this matrix.
  - getIfftColumns
```
public DenseDComplexMatrix2D getIfftColumns(boolean scale)
```
    Returns new complex matrix which is the inverse of the discrete Fourier transform (IDFT) of each column of this matrix.
    
    Returns:
    the inverse of the discrete Fourier transform (IDFT) of each column of this matrix.
  - getIfftRows
```
public DenseDComplexMatrix2D getIfftRows(boolean scale)
```
    Returns new complex matrix which is the inverse of the discrete Fourier transform (IDFT) of each row of this matrix.
    
    Returns:
    the inverse of the discrete Fourier transform (IDFT) of each row of this matrix.
  - 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};
  - getNegativeValues
```
public void getNegativeValues(IntArrayList rowList,
                     IntArrayList columnList,
                     DoubleArrayList valueList)
```
    Description copied from class: DoubleMatrix2D
    
    Fills the coordinates and values of cells having negative values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.
    
    Overrides:
    
    getNegativeValues in class DoubleMatrix2D
    
    Parameters:
    rowList - the list to be filled with row indexes, can have any size.
    columnList - the list to be filled with column indexes, can have any size.
    valueList - the list to be filled with values, can have any size.
  - getNonZeros
```
public void getNonZeros(IntArrayList rowList,
               IntArrayList columnList,
               DoubleArrayList valueList)
```
    Description copied from class: DoubleMatrix2D
    Fills the coordinates and values of cells having non-zero values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.
    In general, fill order is unspecified. This implementation fills like for (row = 0..rows-1) for (column = 0..columns-1) do ... . However, subclasses are free to us any other order, even an order that may change over time as cell values are changed. (Of course, result lists indexes are guaranteed to correspond to the same cell).
    Example:
```
         2 x 3 matrix:
         0, 0, 8
         0, 7, 0
         -->
         rowList    = (0,1)
         columnList = (2,1)
         valueList  = (8,7)
 
 
```
    In other words, get(0,2)==8, get(1,1)==7.
    Overrides:
    
    getNonZeros in class DoubleMatrix2D
    
    Parameters:
    rowList - the list to be filled with row indexes, can have any size.
    columnList - the list to be filled with column indexes, can have any size.
    valueList - the list to be filled with values, can have any size.
  - getPositiveValues
```
public void getPositiveValues(IntArrayList rowList,
                     IntArrayList columnList,
                     DoubleArrayList valueList)
```
    Description copied from class: DoubleMatrix2D
    
    Fills the coordinates and values of cells having positive values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.
    
    Overrides:
    
    getPositiveValues in class DoubleMatrix2D
    
    Parameters:
    rowList - the list to be filled with row indexes, can have any size.
    columnList - the list to be filled with column indexes, can have any size.
    valueList - the list to be filled with values, can have any size.
  - getQuick
```
public double getQuick(int row,
              int column)
```
    Description copied from class: DoubleMatrix2D
    
    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().
    
    Specified by:
    
    getQuick in class DoubleMatrix2D
    
    Parameters:
    row - the index of the row-coordinate.
    column - the index of the column-coordinate.
    
    Returns:
    the value at the specified coordinate.
  - idct2
```
public void idct2(boolean scale)
```
    Computes the 2D inverse of the discrete cosine transform (DCT-III) of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idctColumns
```
public void idctColumns(boolean scale)
```
    Computes the inverse of the discrete cosine transform (DCT-III) of each column of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idctRows
```
public void idctRows(boolean scale)
```
    Computes the inverse of the discrete cosine transform (DCT-III) of each row of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idht2
```
public void idht2(boolean scale)
```
    Computes the 2D inverse of the discrete Hartley transform (IDHT) of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idhtColumns
```
public void idhtColumns(boolean scale)
```
    Computes the inverse of the discrete Hartley transform (IDHT) of each column of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idhtRows
```
public void idhtRows(boolean scale)
```
    Computes the inverse of the discrete Hartley transform (IDHT) of each row of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idst2
```
public void idst2(boolean scale)
```
    Computes the 2D inverse of the discrete sine transform (DST-III) of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idstColumns
```
public void idstColumns(boolean scale)
```
    Computes the inverse of the discrete sine transform (DST-III) of each column of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - idstRows
```
public void idstRows(boolean scale)
```
    Computes the inverse of the discrete sine transform (DST-III) of each row of this matrix.
    
    Parameters:
    scale - if true then scaling is performed
  - ifft2
```
public void ifft2(boolean scale)
```
    Computes the 2D inverse of the discrete Fourier transform (IDFT) of this matrix. The physical layout of the input data has to be as follows:
```
 this[k1][2*k2] = Re[k1][k2] = Re[rows-k1][columns-k2], 
 this[k1][2*k2+1] = Im[k1][k2] = -Im[rows-k1][columns-k2], 
       0<k1<rows, 0<k2<columns/2, 
 this[0][2*k2] = Re[0][k2] = Re[0][columns-k2], 
 this[0][2*k2+1] = Im[0][k2] = -Im[0][columns-k2], 
       0<k2<columns/2, 
 this[k1][0] = Re[k1][0] = Re[rows-k1][0], 
 this[k1][1] = Im[k1][0] = -Im[rows-k1][0], 
 this[rows-k1][1] = Re[k1][columns/2] = Re[rows-k1][columns/2], 
 this[rows-k1][0] = -Im[k1][columns/2] = Im[rows-k1][columns/2], 
       0<k1<rows/2, 
 this[0][0] = Re[0][0], 
 this[0][1] = Re[0][columns/2], 
 this[rows/2][0] = Re[rows/2][0], 
 this[rows/2][1] = Re[rows/2][columns/2]
 
```
    This method computes only half of the elements of the real transform. The other half satisfies the symmetry condition. If you want the full real inverse transform, use getIfft2.
    Parameters:
    scale - if true then scaling is performed
    
    Throws:
    
    IllegalArgumentException - if the row size or the column size of this matrix is not a power of 2 number.
  - index
```
public long index(int row,
         int column)
```
    Description copied from class: AbstractMatrix2D
    
    Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
    
    Overrides:
    
    index in class AbstractMatrix2D
    
    Parameters:
    row - the index of the row-coordinate.
    column - the index of the column-coordinate.
  - like
```
public DoubleMatrix2D like(int rows,
                  int columns)
```
    Description copied from class: DoubleMatrix2D
    
    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.
    
    Specified by:
    
    like in class DoubleMatrix2D
    
    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)
```
    Description copied from class: DoubleMatrix2D
    
    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.
    
    Specified by:
    
    like1D in class DoubleMatrix2D
    
    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)
```
    Description copied from class: DoubleMatrix2D
    
    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().
    
    Specified by:
    
    setQuick in class DoubleMatrix2D
    
    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.
  - toArray
```
public double[][] toArray()
```
    Description copied from class: DoubleMatrix2D
    
    Constructs and returns a 2-dimensional array containing the cell values. The returned array values has the form values[row][column] and has 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:
    
    toArray in class DoubleMatrix2D
    
    Returns:
    an array filled with the values of the cells.
  - vectorize
```
public DoubleMatrix1D vectorize()
```
    Description copied from class: DoubleMatrix2D
    
    Returns a vector obtained by stacking the columns of the matrix on top of one another.
    
    Specified by:
    
    vectorize in class DoubleMatrix2D
    
    Returns:
    a vector of columns of this matrix.
  - zAssign8Neighbors
```
public void zAssign8Neighbors(DoubleMatrix2D B,
                     Double9Function function)
```
    Description copied from class: DoubleMatrix2D
    8 neighbor stencil transformation. For efficient finite difference operations. Applies a function to a moving 3 x 3 window. Does nothing if rows() < 3 || columns() < 3.
```
         B[i,j] = function.apply(
            A[i-1,j-1], A[i-1,j], A[i-1,j+1],
            A[i,  j-1], A[i,  j], A[i,  j+1],
            A[i+1,j-1], A[i+1,j], A[i+1,j+1]
            )
 
         x x x -     - x x x     - - - - 
         x o x -     - x o x     - - - - 
         x x x -     - x x x ... - x x x 
         - - - -     - - - -     - x o x 
         - - - -     - - - -     - x x x
 
 
```
    Make sure that cells of this and B do not overlap. In case of overlapping views, behaviour is unspecified.
    Example:
```
 
 final double alpha = 0.25; final double beta = 0.75; // 8 neighbors
 cern.colt.function.Double9Function f = new
 cern.colt.function.Double9Function() {    public final
 double apply(       double a00, double a01,
 double a02,       double a10, double a11,
 double a12,       double a20, double a21,
 double a22) {
          return beta*a11 +
 alpha*(a00+a01+a02 + a10+a12 + a20+a21+a22);
       } }; A.zAssign8Neighbors(B,f); // 4
 neighbors cern.colt.function.Double9Function g = new
 cern.colt.function.Double9Function() {    public final
 double apply(       double a00, double a01,
 double a02,       double a10, double a11,
 double a12,       double a20, double a21,
 double a22) {       return beta*a11 +
 alpha*(a01+a10+a12+a21);    } C.zAssign8Neighbors(B,g); //
 fast, even though it doesn't look like it };
 
 
```
    Overrides:
    
    zAssign8Neighbors in class DoubleMatrix2D
    
    Parameters:
    B - the matrix to hold the results.
    function - the function to be applied to the 9 cells.
  - 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).
  - zMult
```
public DoubleMatrix2D zMult(DoubleMatrix2D B,
                   DoubleMatrix2D C,
                   double alpha,
                   double beta,
                   boolean transposeA,
                   boolean transposeB)
```
    Description copied from class: DoubleMatrix2D
    
    Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C. C[i,j] = alpha*Sum(A[i,k] * B[k,j]) + beta*C[i,j], k=0..n-1.
    Matrix shapes: A(m x n), B(n x p), C(m x p).
    Note: Matrix shape conformance is checked after potential transpositions.
    
    Overrides:
    
    zMult in class DoubleMatrix2D
    
    Parameters:
    B - the second source matrix.
    C - the matrix where results are to be stored. Set this parameter to null to indicate that a new result matrix shall be constructed.
    
    Returns:
    C (for convenience only).
  - zSum
```
public double zSum()
```
    Description copied from class: DoubleMatrix2D
    
    Returns the sum of all cells; Sum( x[i,j] ).
    
    Overrides:
    
    zSum in class DoubleMatrix2D
    
    Returns:
    the sum.

Class DenseDoubleMatrix2D

Constructor Summary

Method Summary

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

Methods inherited from class cern.colt.matrix.AbstractMatrix2D

Methods inherited from class cern.colt.matrix.AbstractMatrix

Methods inherited from class cern.colt.PersistentObject

Methods inherited from class java.lang.Object

Constructor Detail

DenseDoubleMatrix2D

DenseDoubleMatrix2D

DenseDoubleMatrix2D

DenseDoubleMatrix2D

Method Detail

aggregate

aggregate

aggregate

aggregate

assign

assign

assign

assign

assign

assign

assign

assign

assign

assign

cardinality

dct2

dctColumns

dctRows

dht2

dhtColumns

dhtRows

dst2

dstColumns

dstRows

elements

fft2

forEachNonZero

getColumnMajor

getFft2

getFftColumns

getFftRows

getIfft2

getIfftColumns

getIfftRows

getMaxLocation

getMinLocation

getNegativeValues

getNonZeros

getPositiveValues

getQuick

idct2

idctColumns

idctRows

idht2

idhtColumns

idhtRows

idst2

idstColumns

idstRows

ifft2

index

like

like1D

setQuick

toArray

vectorize

zAssign8Neighbors

zMult

zMult

zSum