public class DenseColumnObjectMatrix2D extends ObjectMatrix2D
Implementation:
Internally holds one single contigous one-dimensional array, addressed in column 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 column-major. Applications demanding utmost speed can exploit this fact. Setting/getting values in a loop column-by-column is quicker than row-by-row. Thus
for (int column = 0; column < columns; column++) { for (int row = 0; row < rows; row++) { matrix.setQuick(row, column, someValue); } }is quicker than
for (int row = 0; row < rows; row++) { for (int column = 0; column < columns; column++) { matrix.setQuick(row, column, someValue); } }
Constructor and Description |
---|
DenseColumnObjectMatrix2D(int rows,
int columns)
Constructs a matrix with a given number of rows and columns.
|
DenseColumnObjectMatrix2D(int rows,
int columns,
Object[] elements,
int rowZero,
int columnZero,
int rowStride,
int columnStride,
boolean isView)
Constructs a matrix with the given parameters.
|
DenseColumnObjectMatrix2D(Object[][] values)
Constructs a matrix with a copy of the given values.
|
Modifier and Type | Method and Description |
---|---|
Object |
aggregate(ObjectMatrix2D other,
ObjectObjectFunction aggr,
ObjectObjectFunction f)
Applies a function to each corresponding cell of two matrices and
aggregates the results.
|
Object |
aggregate(ObjectObjectFunction aggr,
ObjectFunction f)
Applies a function to each cell and aggregates the results.
|
Object |
aggregate(ObjectObjectFunction aggr,
ObjectFunction f,
IntArrayList rowList,
IntArrayList columnList)
Applies a function to all cells with a given indexes and aggregates the
results.
|
Object |
aggregate(ObjectObjectFunction aggr,
ObjectFunction f,
ObjectProcedure cond)
Applies a function to each cell that satisfies a condition and aggregates
the results.
|
ObjectMatrix2D |
assign(Object value)
Sets all cells to the state specified by value.
|
ObjectMatrix2D |
assign(Object[] values)
Sets all cells to the state specified by values.
|
ObjectMatrix2D |
assign(Object[][] values)
Sets all cells to the state specified by values.
|
ObjectMatrix2D |
assign(ObjectFunction function)
Assigns the result of a function to each cell;
x[row,col] = function(x[row,col]).
|
ObjectMatrix2D |
assign(ObjectMatrix2D source)
Replaces all cell values of the receiver with the values of another
matrix.
|
ObjectMatrix2D |
assign(ObjectMatrix2D y,
ObjectObjectFunction function)
Assigns the result of a function to each cell;
x[row,col] = function(x[row,col],y[row,col]).
|
ObjectMatrix2D |
assign(ObjectMatrix2D y,
ObjectObjectFunction function,
IntArrayList rowList,
IntArrayList columnList)
Assigns the result of a function to all cells with a given indexes
|
ObjectMatrix2D |
assign(ObjectProcedure cond,
Object value)
Assigns a value to all cells that satisfy a condition.
|
ObjectMatrix2D |
assign(ObjectProcedure cond,
ObjectFunction 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.
|
Object[] |
elements()
Returns the elements of this matrix.
|
ObjectMatrix2D |
forEachNonZero(IntIntObjectFunction function)
Assigns the result of a function to each non-zero cell;
x[row,col] = function(x[row,col]).
|
void |
getNonZeros(IntArrayList rowList,
IntArrayList columnList,
ObjectArrayList valueList)
Fills the coordinates and values of cells having non-zero values into the
specified lists.
|
Object |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column].
|
DenseObjectMatrix2D |
getRowMajor()
Returns a new matrix that has the same elements as this matrix, but they
are addressed internally in row major.
|
long |
index(int row,
int column)
Returns the position of the given coordinate within the (virtual or
non-virtual) internal 1-dimensional array.
|
ObjectMatrix2D |
like(int rows,
int columns)
Construct and returns a new empty matrix of the same dynamic type
as the receiver, having the specified number of rows and columns.
|
ObjectMatrix1D |
like1D(int size)
Construct and returns a new 1-d matrix of the corresponding dynamic
type, entirelly independent of the receiver.
|
void |
setQuick(int row,
int column,
Object value)
Sets the matrix cell at coordinate [row,column] to the specified
value.
|
Object[][] |
toArray()
Constructs and returns a 2-dimensional array containing the cell values.
|
ObjectMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of the matrix on top of
one another.
|
copy, equals, equals, get, like, set, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSorted, viewStrides
checkShape, checkShape, columns, columnStride, rows, rowStride, size, toStringShort
ensureCapacity, isView, trimToSize
clone
public DenseColumnObjectMatrix2D(Object[][] 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 DenseColumnObjectMatrix2D(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 || (double)columns*rows > Integer.MAX_VALUE
.public DenseColumnObjectMatrix2D(int rows, int columns, Object[] 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 || (double)columns*rows > Integer.MAX_VALUE
or flip's are illegal.public Object aggregate(ObjectObjectFunction aggr, ObjectFunction f)
ObjectMatrix2D
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 ObjectMatrix2D
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.DoubleFunctions
public Object aggregate(ObjectObjectFunction aggr, ObjectFunction f, ObjectProcedure cond)
ObjectMatrix2D
aggregate
in class ObjectMatrix2D
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.public Object aggregate(ObjectObjectFunction aggr, ObjectFunction f, IntArrayList rowList, IntArrayList columnList)
ObjectMatrix2D
aggregate
in class ObjectMatrix2D
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.public Object aggregate(ObjectMatrix2D other, ObjectObjectFunction aggr, ObjectObjectFunction f)
ObjectMatrix2D
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 ObjectMatrix2D
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.DoubleFunctions
public ObjectMatrix2D assign(ObjectFunction function)
ObjectMatrix2D
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 ObjectMatrix2D
function
- a function object taking as argument the current cell's value.DoubleFunctions
public ObjectMatrix2D assign(ObjectProcedure cond, ObjectFunction function)
ObjectMatrix2D
assign
in class ObjectMatrix2D
cond
- a condition.function
- a function object.public ObjectMatrix2D assign(ObjectProcedure cond, Object value)
ObjectMatrix2D
assign
in class ObjectMatrix2D
cond
- a condition.value
- a value.public ObjectMatrix2D assign(Object value)
ObjectMatrix2D
assign
in class ObjectMatrix2D
value
- the value to be filled into the cells.public ObjectMatrix2D assign(Object[] values)
ObjectMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class ObjectMatrix2D
values
- the values to be filled into the cells.public ObjectMatrix2D assign(Object[][] values)
ObjectMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class ObjectMatrix2D
values
- the values to be filled into the cells.public ObjectMatrix2D assign(ObjectMatrix2D source)
ObjectMatrix2D
assign
in class ObjectMatrix2D
source
- the source matrix to copy from (may be identical to the
receiver).public ObjectMatrix2D assign(ObjectMatrix2D y, ObjectObjectFunction function)
ObjectMatrix2D
assign
in class ObjectMatrix2D
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,DoubleFunctions
public ObjectMatrix2D assign(ObjectMatrix2D y, ObjectObjectFunction function, IntArrayList rowList, IntArrayList columnList)
ObjectMatrix2D
assign
in class ObjectMatrix2D
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.public int cardinality()
ObjectMatrix2D
cardinality
in class ObjectMatrix2D
public Object[] elements()
ObjectMatrix2D
elements
in class ObjectMatrix2D
public ObjectMatrix2D forEachNonZero(IntIntObjectFunction function)
ObjectMatrix2D
forEachNonZero
in class ObjectMatrix2D
function
- a function object taking as argument the current non-zero
cell's row, column and value.public DenseObjectMatrix2D getRowMajor()
public void getNonZeros(IntArrayList rowList, IntArrayList columnList, ObjectArrayList valueList)
ObjectMatrix2D
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 ObjectMatrix2D
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 Object getQuick(int row, int column)
ObjectMatrix2D
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 ObjectMatrix2D
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 ObjectMatrix2D like(int rows, int columns)
ObjectMatrix2D
like
in class ObjectMatrix2D
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.public ObjectMatrix1D like1D(int size)
ObjectMatrix2D
like1D
in class ObjectMatrix2D
size
- the number of cells the matrix shall have.public void setQuick(int row, int column, Object value)
ObjectMatrix2D
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 ObjectMatrix2D
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 Object[][] toArray()
ObjectMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
toArray
in class ObjectMatrix2D
public ObjectMatrix1D vectorize()
ObjectMatrix2D
vectorize
in class ObjectMatrix2D
Jump to the Parallel Colt Homepage