cern.colt.matrix.tlong.impl

Class DenseLongMatrix2D

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.AbstractMatrix

cern.colt.matrix.AbstractMatrix2D

cern.colt.matrix.tlong.LongMatrix2D

cern.colt.matrix.tlong.impl.DenseLongMatrix2D

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DenseLongMatrix2D
extends LongMatrix2D

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

Implementation:

Longernally holds one single contigous one-dimensional array, addressed in row major. Note that this implementation is not synchronized.

Memory requirements:

memory [bytes] = 8*rows()*columns(). Thus, a 1000*1000 matrix uses 8 MB.

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);
     }
 }
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DenseLongMatrix2D(int rows, int columns) Constructs a matrix with a given number of rows and columns.
DenseLongMatrix2D(int rows, int columns, long[] elements, int rowZero, int columnZero, int rowStride, int columnStride, boolean isView) Constructs a view with the given parameters.
DenseLongMatrix2D(long[][] values) Constructs a matrix with a copy of the given values.

Method Summary

Modifier and Type	Method and Description
long	aggregate(LongLongFunction aggr, LongFunction f) Applies a function to each cell and aggregates the results.
long	aggregate(LongLongFunction aggr, LongFunction f, IntArrayList rowList, IntArrayList columnList) Applies a function to all cells with a given indexes and aggregates the results.
long	aggregate(LongLongFunction aggr, LongFunction f, LongProcedure cond) Applies a function to each cell that satisfies a condition and aggregates the results.
long	aggregate(LongMatrix2D other, LongLongFunction aggr, LongLongFunction f) Applies a function to each corresponding cell of two matrices and aggregates the results.
LongMatrix2D	assign(int[] values) Sets all cells to the state specified by values.
LongMatrix2D	assign(long value) Sets all cells to the state specified by value.
LongMatrix2D	assign(long[] values) Sets all cells to the state specified by values.
LongMatrix2D	assign(long[][] values) Sets all cells to the state specified by values.
LongMatrix2D	assign(LongFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col]).
LongMatrix2D	assign(LongMatrix2D source) Replaces all cell values of the receiver with the values of another matrix.
LongMatrix2D	assign(LongMatrix2D y, LongLongFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).
LongMatrix2D	assign(LongMatrix2D y, LongLongFunction function, IntArrayList rowList, IntArrayList columnList) Assigns the result of a function to all cells with a given indexes
LongMatrix2D	assign(LongProcedure cond, long value) Assigns a value to all cells that satisfy a condition.
LongMatrix2D	assign(LongProcedure cond, LongFunction function) Assigns the result of a function to all cells that satisfy a condition.
int	cardinality() Returns the number of cells having non-zero values; ignores tolerance.
long[]	elements() Returns the elements of this matrix.
LongMatrix2D	forEachNonZero(IntIntLongFunction function) Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]).
long[]	getMaxLocation() Return the maximum value of this matrix together with its location
long[]	getMinLocation() Return the minimum value of this matrix together with its location
void	getNegativeValues(IntArrayList rowList, IntArrayList columnList, LongArrayList valueList) Fills the coordinates and values of cells having negative values into the specified lists.
void	getNonZeros(IntArrayList rowList, IntArrayList columnList, LongArrayList valueList) Fills the coordinates and values of cells having non-zero values into the specified lists.
void	getPositiveValues(IntArrayList rowList, IntArrayList columnList, LongArrayList valueList) Fills the coordinates and values of cells having positive values into the specified lists.
long	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
long	index(int row, int column) Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
LongMatrix2D	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.
LongMatrix1D	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, long value) Sets the matrix cell at coordinate [row,column] to the specified value.
long[][]	toArray() Constructs and returns a 2-dimensional array containing the cell values.
LongMatrix1D	vectorize() Returns a vector obtained by stacking the columns of the matrix on top of one another.
LongMatrix1D	zMult(LongMatrix1D y, LongMatrix1D z, long alpha, long beta, boolean transposeA) Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z.
LongMatrix2D	zMult(LongMatrix2D B, LongMatrix2D C, long alpha, long beta, boolean transposeA, boolean transposeB) Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C.
long	zSum() Returns the sum of all cells; Sum( x[i,j] ).

Methods inherited from class cern.colt.matrix.tlong.LongMatrix2D

copy, equals, equals, get, like, 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

DenseLongMatrix2D

public DenseLongMatrix2D(long[][] 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:

java.lang.IllegalArgumentException - if for any 1 <= row < values.length: values[row].length != values[row-1].length .

DenseLongMatrix2D

public DenseLongMatrix2D(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:

java.lang.IllegalArgumentException - if rows<0 || columns<0 || (int)columns*rows > Long.MAX_VALUE .

DenseLongMatrix2D

public DenseLongMatrix2D(int rows,
                         int columns,
                         long[] elements,
                         int rowZero,
                         int columnZero,
                         int rowStride,
                         int columnStride,
                         boolean isView)

Constructs a view 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:

java.lang.IllegalArgumentException - if rows<0 || columns<0 || (int)columns*rows > Long.MAX_VALUE or flip's are illegal.

Method Detail

aggregate

public long aggregate(LongLongFunction aggr,
                      LongFunction f)

Description copied from class: LongMatrix2D

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)==Long.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 LongMatrix2D

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:

LongFunctions

aggregate

public long aggregate(LongLongFunction aggr,
                      LongFunction f,
                      LongProcedure cond)

Description copied from class: LongMatrix2D

Applies a function to each cell that satisfies a condition and aggregates the results.

Overrides:

aggregate in class LongMatrix2D

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:

LongFunctions

aggregate

public long aggregate(LongLongFunction aggr,
                      LongFunction f,
                      IntArrayList rowList,
                      IntArrayList columnList)

Description copied from class: LongMatrix2D

Applies a function to all cells with a given indexes and aggregates the results.

Overrides:

aggregate in class LongMatrix2D

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:

LongFunctions

aggregate

public long aggregate(LongMatrix2D other,
                      LongLongFunction aggr,
                      LongLongFunction f)

Description copied from class: LongMatrix2D

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)==Long.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 LongMatrix2D

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:

LongFunctions

assign

public LongMatrix2D assign(LongFunction function)

Description copied from class: LongMatrix2D

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 LongMatrix2D

Parameters:

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

Returns:

this (for convenience only).

See Also:

LongFunctions

assign

public LongMatrix2D assign(LongProcedure cond,
                           LongFunction function)

Description copied from class: LongMatrix2D

Assigns the result of a function to all cells that satisfy a condition.

Overrides:

assign in class LongMatrix2D

Parameters:

cond - a condition.

function - a function object.

Returns:

this (for convenience only).

See Also:

LongFunctions

assign

public LongMatrix2D assign(LongProcedure cond,
                           long value)

Description copied from class: LongMatrix2D

Assigns a value to all cells that satisfy a condition.

Overrides:

assign in class LongMatrix2D

Parameters:

cond - a condition.

value - a value.

Returns:

this (for convenience only).

assign

public LongMatrix2D assign(long value)

Description copied from class: LongMatrix2D

Sets all cells to the state specified by value.

Overrides:

assign in class LongMatrix2D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

assign

public LongMatrix2D assign(long[] values)

Description copied from class: LongMatrix2D

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 LongMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public LongMatrix2D assign(int[] values)

Description copied from class: LongMatrix2D

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 LongMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public LongMatrix2D assign(long[][] values)

Description copied from class: LongMatrix2D

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 LongMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

assign

public LongMatrix2D assign(LongMatrix2D source)

Description copied from class: LongMatrix2D

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 LongMatrix2D

Parameters:

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

Returns:

this (for convenience only).

assign

public LongMatrix2D assign(LongMatrix2D y,
                           LongLongFunction function)

Description copied from class: LongMatrix2D

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 LongMatrix2D

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:

LongFunctions

assign

public LongMatrix2D assign(LongMatrix2D y,
                           LongLongFunction function,
                           IntArrayList rowList,
                           IntArrayList columnList)

Description copied from class: LongMatrix2D

Assigns the result of a function to all cells with a given indexes

Overrides:

assign in class LongMatrix2D

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:

LongFunctions

cardinality

public int cardinality()

Description copied from class: LongMatrix2D

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

Overrides:

cardinality in class LongMatrix2D

Returns:

cardinality

elements

public long[] elements()

Description copied from class: LongMatrix2D

Returns the elements of this matrix.

Specified by:

elements in class LongMatrix2D

Returns:

the elements

forEachNonZero

public LongMatrix2D forEachNonZero(IntIntLongFunction function)

Description copied from class: LongMatrix2D

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 LongMatrix2D

Parameters:

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

Returns:

this (for convenience only).

getNegativeValues

public void getNegativeValues(IntArrayList rowList,
                              IntArrayList columnList,
                              LongArrayList valueList)

Description copied from class: LongMatrix2D

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 LongMatrix2D

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,
                        LongArrayList valueList)

Description copied from class: LongMatrix2D

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 LongMatrix2D

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,
                              LongArrayList valueList)

Description copied from class: LongMatrix2D

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 LongMatrix2D

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 long getQuick(int row,
                     int column)

Description copied from class: LongMatrix2D

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 LongMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

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 LongMatrix2D like(int rows,
                         int columns)

Description copied from class: LongMatrix2D

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

Specified by:

like in class LongMatrix2D

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

Description copied from class: LongMatrix2D

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 DenseLongMatrix2D the new matrix must be of type DenseLongMatrix1D, if the receiver is an instance of type SparseLongMatrix2D the new matrix must be of type SparseLongMatrix1D, etc.

Specified by:

like1D in class LongMatrix2D

Parameters:

size - the number of cells the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

getMaxLocation

public long[] getMaxLocation()

Description copied from class: LongMatrix2D

Return the maximum value of this matrix together with its location

Overrides:

getMaxLocation in class LongMatrix2D

Returns:

maximum_value, row_location, column_location };

getMinLocation

public long[] getMinLocation()

Description copied from class: LongMatrix2D

Return the minimum value of this matrix together with its location

Overrides:

getMinLocation in class LongMatrix2D

Returns:

minimum_value, row_location, column_location};

setQuick

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

Description copied from class: LongMatrix2D

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 LongMatrix2D

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 long[][] toArray()

Description copied from class: LongMatrix2D

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 LongMatrix2D

Returns:

an array filled with the values of the cells.

vectorize

public LongMatrix1D vectorize()

Description copied from class: LongMatrix2D

Returns a vector obtained by stacking the columns of the matrix on top of one another.

Specified by:

vectorize in class LongMatrix2D

Returns:

a vector of columns of this matrix.

zMult

public LongMatrix1D zMult(LongMatrix1D y,
                          LongMatrix1D z,
                          long alpha,
                          long beta,
                          boolean transposeA)

Description copied from class: LongMatrix2D

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 LongMatrix2D

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 LongMatrix2D zMult(LongMatrix2D B,
                          LongMatrix2D C,
                          long alpha,
                          long beta,
                          boolean transposeA,
                          boolean transposeB)

Description copied from class: LongMatrix2D

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 LongMatrix2D

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 long zSum()

Description copied from class: LongMatrix2D

Returns the sum of all cells; Sum( x[i,j] ).

Overrides:

zSum in class LongMatrix2D

Returns:

the sum.