public class DenseLongMatrix2D extends LongMatrix2D
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); } }
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.
|
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] ).
|
copy, equals, equals, get, like, set, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSelection, viewSorted, viewStrides, zMult, zMult
checkShape, checkShape, columns, columnStride, rows, rowStride, size, toStringShort
ensureCapacity, isView, trimToSize
clone
public DenseLongMatrix2D(long[][] values)
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
values
- The values to be filled into the new matrix.IllegalArgumentException
- if
for any 1 <= row < values.length: values[row].length != values[row-1].length
.public DenseLongMatrix2D(int rows, int columns)
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.IllegalArgumentException
- if
rows<0 || columns<0 || (int)columns*rows > Long.MAX_VALUE
.public DenseLongMatrix2D(int rows, int columns, long[] elements, int rowZero, int columnZero, int rowStride, int columnStride, boolean isView)
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 constructedIllegalArgumentException
- if
rows<0 || columns<0 || (int)columns*rows > Long.MAX_VALUE
or flip's are illegal.public long aggregate(LongLongFunction aggr, LongFunction f)
LongMatrix2D
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); --> 14For further examples, see the package doc.
aggregate
in class LongMatrix2D
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.LongFunctions
public long aggregate(LongLongFunction aggr, LongFunction f, LongProcedure cond)
LongMatrix2D
aggregate
in class LongMatrix2D
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.LongFunctions
public long aggregate(LongLongFunction aggr, LongFunction f, IntArrayList rowList, IntArrayList columnList)
LongMatrix2D
aggregate
in class LongMatrix2D
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.LongFunctions
public long aggregate(LongMatrix2D other, LongLongFunction aggr, LongLongFunction f)
LongMatrix2D
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)); --> 56For further examples, see the package doc.
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.LongFunctions
public LongMatrix2D assign(LongFunction function)
LongMatrix2D
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.350783For further examples, see the package doc.
assign
in class LongMatrix2D
function
- a function object taking as argument the current cell's value.LongFunctions
public LongMatrix2D assign(LongProcedure cond, LongFunction function)
LongMatrix2D
assign
in class LongMatrix2D
cond
- a condition.function
- a function object.LongFunctions
public LongMatrix2D assign(LongProcedure cond, long value)
LongMatrix2D
assign
in class LongMatrix2D
cond
- a condition.value
- a value.public LongMatrix2D assign(long value)
LongMatrix2D
assign
in class LongMatrix2D
value
- the value to be filled into the cells.public LongMatrix2D assign(long[] values)
LongMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class LongMatrix2D
values
- the values to be filled into the cells.public LongMatrix2D assign(int[] values)
LongMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class LongMatrix2D
values
- the values to be filled into the cells.public LongMatrix2D assign(long[][] values)
LongMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class LongMatrix2D
values
- the values to be filled into the cells.public LongMatrix2D assign(LongMatrix2D source)
LongMatrix2D
assign
in class LongMatrix2D
source
- the source matrix to copy from (may be identical to the
receiver).public LongMatrix2D assign(LongMatrix2D y, LongLongFunction function)
LongMatrix2D
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 729For further examples, see the package doc.
assign
in class LongMatrix2D
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,LongFunctions
public LongMatrix2D assign(LongMatrix2D y, LongLongFunction function, IntArrayList rowList, IntArrayList columnList)
LongMatrix2D
assign
in class LongMatrix2D
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.LongFunctions
public int cardinality()
LongMatrix2D
cardinality
in class LongMatrix2D
public long[] elements()
LongMatrix2D
elements
in class LongMatrix2D
public LongMatrix2D forEachNonZero(IntIntLongFunction function)
LongMatrix2D
forEachNonZero
in class LongMatrix2D
function
- a function object taking as argument the current non-zero
cell's row, column and value.public void getNegativeValues(IntArrayList rowList, IntArrayList columnList, LongArrayList valueList)
LongMatrix2D
getNegativeValues
in class LongMatrix2D
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.public void getNonZeros(IntArrayList rowList, IntArrayList columnList, LongArrayList valueList)
LongMatrix2D
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.
getNonZeros
in class LongMatrix2D
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.public void getPositiveValues(IntArrayList rowList, IntArrayList columnList, LongArrayList valueList)
LongMatrix2D
getPositiveValues
in class LongMatrix2D
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.public long getQuick(int row, int column)
LongMatrix2D
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().
getQuick
in class LongMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.public long index(int row, int column)
AbstractMatrix2D
index
in class AbstractMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.public LongMatrix2D like(int rows, int columns)
LongMatrix2D
like
in class LongMatrix2D
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.public LongMatrix1D like1D(int size)
LongMatrix2D
like1D
in class LongMatrix2D
size
- the number of cells the matrix shall have.public long[] getMaxLocation()
LongMatrix2D
getMaxLocation
in class LongMatrix2D
public long[] getMinLocation()
LongMatrix2D
getMinLocation
in class LongMatrix2D
public void setQuick(int row, int column, long value)
LongMatrix2D
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().
setQuick
in class LongMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.value
- the value to be filled into the specified cell.public long[][] toArray()
LongMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
toArray
in class LongMatrix2D
public LongMatrix1D vectorize()
LongMatrix2D
vectorize
in class LongMatrix2D
public LongMatrix1D zMult(LongMatrix1D y, LongMatrix1D z, long alpha, long beta, boolean transposeA)
LongMatrix2D
zMult
in class LongMatrix2D
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.public LongMatrix2D zMult(LongMatrix2D B, LongMatrix2D C, long alpha, long beta, boolean transposeA, boolean transposeB)
LongMatrix2D
zMult
in class LongMatrix2D
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.public long zSum()
LongMatrix2D
zSum
in class LongMatrix2D
Jump to the Parallel Colt Homepage