org.apache.mahout.math.matrix.impl
Class DenseDoubleMatrix2D

java.lang.Object
  extended by org.apache.mahout.math.matrix.impl.AbstractMatrix
      extended by org.apache.mahout.math.matrix.impl.AbstractMatrix2D
          extended by org.apache.mahout.math.matrix.DoubleMatrix2D
              extended by org.apache.mahout.math.matrix.impl.DenseDoubleMatrix2D
All Implemented Interfaces:
Cloneable

Deprecated. until unit tests are in place. Until this time, this class/interface is unsupported.

@Deprecated
public final class DenseDoubleMatrix2D
extends DoubleMatrix2D


Field Summary
 
Fields inherited from class org.apache.mahout.math.matrix.impl.AbstractMatrix2D
columns, columnStride, columnZero, rows, rowStride, rowZero
 
Fields inherited from class org.apache.mahout.math.matrix.impl.AbstractMatrix
isNoView
 
Constructor Summary
DenseDoubleMatrix2D(double[][] values)
          Deprecated. Constructs a matrix with a copy of the given values.
DenseDoubleMatrix2D(int rows, int columns)
          Deprecated. Constructs a matrix with a given number of rows and columns.
 
Method Summary
 DoubleMatrix2D assign(double value)
          Deprecated. Sets all cells to the state specified by value.
 void assign(double[][] values)
          Deprecated. Sets all cells to the state specified by values.
 void assign(DoubleFunction function)
          Deprecated. Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).
 DoubleMatrix2D assign(DoubleMatrix2D source)
          Deprecated. Replaces all cell values of the receiver with the values of another matrix.
 DoubleMatrix2D assign(DoubleMatrix2D y, DoubleDoubleFunction function)
          Deprecated. Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).
 double getQuick(int row, int column)
          Deprecated. Returns the matrix cell value at coordinate [row,column].
protected  boolean haveSharedCellsRaw(DoubleMatrix2D other)
          Deprecated. Returns true if both matrices share common cells.
static DoubleMatrix2D identity(int rowsAndColumns)
          Deprecated. Constructs an identity matrix (having ones on the diagonal and zeros elsewhere).
protected  int index(int row, int column)
          Deprecated. Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
 DoubleMatrix2D like(int rows, int columns)
          Deprecated. 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)
          Deprecated. Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
protected  DoubleMatrix1D like1D(int size, int zero, int stride)
          Deprecated. Construct and returns a new 1-d matrix of the corresponding dynamic type, sharing the same cells.
 void setQuick(int row, int column, double value)
          Deprecated. Sets the matrix cell at coordinate [row,column] to the specified value.
protected  DoubleMatrix2D viewSelectionLike(int[] rowOffsets, int[] columnOffsets)
          Deprecated. Construct and returns a new selection view.
 DoubleMatrix1D zMult(DoubleMatrix1D y, DoubleMatrix1D z, double alpha, double beta, boolean transposeA)
          Deprecated. 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)
          Deprecated. Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C.
 double zSum()
          Deprecated. Returns the sum of all cells; Sum( x[i,j] ).
 
Methods inherited from class org.apache.mahout.math.matrix.DoubleMatrix2D
aggregate, aggregate, cardinality, copy, equals, equals, forEachNonZero, get, getContent, haveSharedCells, like, set, toArray, view, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection
 
Methods inherited from class org.apache.mahout.math.matrix.impl.AbstractMatrix2D
checkBox, checkColumn, checkColumnIndexes, checkRow, checkRowIndexes, checkShape, columnOffset, columnRank, columns, rowOffset, rowRank, rows, setUp, setUp, size, vColumnFlip, vDice, vPart, vRowFlip
 
Methods inherited from class org.apache.mahout.math.matrix.impl.AbstractMatrix
ensureCapacity
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DenseDoubleMatrix2D

public DenseDoubleMatrix2D(double[][] values)
Deprecated. 
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)
Deprecated. 
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.
Method Detail

identity

public static DoubleMatrix2D identity(int rowsAndColumns)
Deprecated. 
Constructs an identity matrix (having ones on the diagonal and zeros elsewhere).


assign

public void assign(double[][] values)
Deprecated. 
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.
Throws:
IllegalArgumentException - if values.length != rows() || for any 0 <= row < rows(): values[row].length != columns().

assign

public DoubleMatrix2D assign(double value)
Deprecated. 
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 void assign(DoubleFunction function)
Deprecated. 
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(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.
See Also:
Functions

assign

public DoubleMatrix2D assign(DoubleMatrix2D source)
Deprecated. 
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).
Throws:
IllegalArgumentException - if columns() != source.columns() || rows() != source.rows()

assign

public DoubleMatrix2D assign(DoubleMatrix2D y,
                             DoubleDoubleFunction function)
Deprecated. 
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]y[row,col]
 m1 = 2 x 2 matrix
 0 1
 2 3

 m2 = 2 x 2 matrix
 0 2
 4 6

 m1.assign(m2, org.apache.mahout.math.function.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).
Throws:
IllegalArgumentException - if columns() != other.columns() || rows() != other.rows()
See Also:
Functions

getQuick

public double getQuick(int row,
                       int column)
Deprecated. 
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.

haveSharedCellsRaw

protected boolean haveSharedCellsRaw(DoubleMatrix2D other)
Deprecated. 
Returns true if both matrices share common cells. More formally, returns true if other != null and at least one of the following conditions is met

Overrides:
haveSharedCellsRaw in class DoubleMatrix2D

index

protected int index(int row,
                    int column)
Deprecated. 
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)
Deprecated. 
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)
Deprecated. 
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.

like1D

protected DoubleMatrix1D like1D(int size,
                                int zero,
                                int stride)
Deprecated. 
Construct and returns a new 1-d matrix of the corresponding dynamic type, sharing the same cells. 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.
zero - the index of the first element.
stride - the number of indexes between any two elements, i.e. index(i+1)-index(i).
Returns:
a new matrix of the corresponding dynamic type.

setQuick

public void setQuick(int row,
                     int column,
                     double value)
Deprecated. 
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.

viewSelectionLike

protected DoubleMatrix2D viewSelectionLike(int[] rowOffsets,
                                           int[] columnOffsets)
Deprecated. 
Construct and returns a new selection view.

Specified by:
viewSelectionLike in class DoubleMatrix2D
Parameters:
rowOffsets - the offsets of the visible elements.
columnOffsets - the offsets of the visible elements.
Returns:
a new view.

zMult

public DoubleMatrix1D zMult(DoubleMatrix1D y,
                            DoubleMatrix1D z,
                            double alpha,
                            double beta,
                            boolean transposeA)
Deprecated. 
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)
Deprecated. 
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()
Deprecated. 
Returns the sum of all cells; Sum( x[i,j] ).

Overrides:
zSum in class DoubleMatrix2D
Returns:
the sum.


Copyright © 2008-2012 The Apache Software Foundation. All Rights Reserved.