|
Parallel Colt 0.7.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object cern.colt.PersistentObject cern.colt.matrix.AbstractMatrix cern.colt.matrix.AbstractMatrix2D cern.colt.matrix.tfloat.FloatMatrix2D cern.colt.matrix.tfloat.impl.DenseColFloatMatrix2D
public class DenseColFloatMatrix2D
Dense 2-d matrix holding float 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 column 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 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 Summary | |
---|---|
DenseColFloatMatrix2D(float[][] values)
Constructs a matrix with a copy of the given values. |
|
DenseColFloatMatrix2D(int rows,
int columns)
Constructs a matrix with a given number of rows and columns. |
|
DenseColFloatMatrix2D(int rows,
int columns,
float[] elements,
int rowZero,
int columnZero,
int rowStride,
int columnStride,
boolean isView)
Constructs a view with the given parameters. |
Method Summary | |
---|---|
float |
aggregate(FloatFloatFunction aggr,
FloatFunction f)
Applies a function to each cell and aggregates the results. |
float |
aggregate(FloatFloatFunction aggr,
FloatFunction f,
FloatProcedure cond)
Applies a function to each cell that satisfies a condition and aggregates the results. |
float |
aggregate(FloatFloatFunction aggr,
FloatFunction f,
IntArrayList rowList,
IntArrayList columnList)
Applies a function to all cells with a given indexes and aggregates the results. |
float |
aggregate(FloatMatrix2D other,
FloatFloatFunction aggr,
FloatFloatFunction f)
Applies a function to each corresponding cell of two matrices and aggregates the results. |
FloatMatrix2D |
assign(float value)
Sets all cells to the state specified by value. |
FloatMatrix2D |
assign(float[] values)
Sets all cells to the state specified by values. |
FloatMatrix2D |
assign(float[][] values)
Sets all cells to the state specified by values. |
FloatMatrix2D |
assign(FloatFunction function)
Assigns the result of a function to each cell; x[row,col] = function(x[row,col]). |
FloatMatrix2D |
assign(FloatMatrix2D source)
Replaces all cell values of the receiver with the values of another matrix. |
FloatMatrix2D |
assign(FloatMatrix2D y,
FloatFloatFunction function)
Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]). |
FloatMatrix2D |
assign(FloatMatrix2D y,
FloatFloatFunction function,
IntArrayList rowList,
IntArrayList columnList)
Assigns the result of a function to all cells with a given indexes |
FloatMatrix2D |
assign(FloatProcedure cond,
float value)
Assigns a value to all cells that satisfy a condition. |
FloatMatrix2D |
assign(FloatProcedure cond,
FloatFunction 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. |
void |
dct2(boolean scale)
|
void |
dctColumns(boolean scale)
|
void |
dctRows(boolean scale)
|
void |
dht2()
|
void |
dhtColumns()
|
void |
dhtRows()
|
void |
dst2(boolean scale)
|
void |
dstColumns(boolean scale)
|
void |
dstRows(boolean scale)
|
float[] |
elements()
Returns the elements of this matrix. |
void |
fft2()
|
FloatMatrix2D |
forEachNonZero(IntIntFloatFunction function)
Assigns the result of a function to each non-zero cell; x[row,col] = function(x[row,col]). |
FComplexMatrix2D |
getFft2()
|
FComplexMatrix2D |
getFftColumns()
|
FComplexMatrix2D |
getFftRows()
|
FComplexMatrix2D |
getIfft2(boolean scale)
|
FComplexMatrix2D |
getIfftColumns(boolean scale)
|
FComplexMatrix2D |
getIfftRows(boolean scale)
|
float[] |
getMaxLocation()
Return the maximum value of this matrix together with its location |
float[] |
getMinLocation()
Return the minimum value of this matrix together with its location |
void |
getNegativeValues(IntArrayList rowList,
IntArrayList columnList,
FloatArrayList valueList)
Fills the coordinates and values of cells having negative values into the specified lists. |
void |
getNonZeros(IntArrayList rowList,
IntArrayList columnList,
FloatArrayList valueList)
Fills the coordinates and values of cells having non-zero values into the specified lists. |
void |
getPositiveValues(IntArrayList rowList,
IntArrayList columnList,
FloatArrayList valueList)
Fills the coordinates and values of cells having positive values into the specified lists. |
float |
getQuick(int row,
int column)
Returns the matrix cell value at coordinate [row,column]. |
void |
idct2(boolean scale)
|
void |
idctColumns(boolean scale)
|
void |
idctRows(boolean scale)
|
void |
idht2(boolean scale)
|
void |
idhtColumns(boolean scale)
|
void |
idhtRows(boolean scale)
|
void |
idst2(boolean scale)
|
void |
idstColumns(boolean scale)
|
void |
idstRows(boolean scale)
|
void |
ifft2(boolean scale)
|
long |
index(int row,
int column)
Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array. |
FloatMatrix2D |
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. |
FloatMatrix1D |
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,
float value)
Sets the matrix cell at coordinate [row,column] to the specified value. |
float[][] |
toArray()
Constructs and returns a 2-dimensional array containing the cell values. |
FloatMatrix1D |
vectorize()
Returns a vector obtained by stacking the columns of the matrix on top of one another. |
FloatMatrix1D |
zMult(FloatMatrix1D y,
FloatMatrix1D z,
float alpha,
float beta,
boolean transposeA)
Linear algebraic matrix-vector multiplication; z = alpha * A * y + beta*z. |
FloatMatrix2D |
zMult(FloatMatrix2D B,
FloatMatrix2D C,
float alpha,
float beta,
boolean transposeA,
boolean transposeB)
Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C. |
float |
zSum()
Returns the sum of all cells; Sum( x[i,j] ). |
Methods inherited from class cern.colt.matrix.tfloat.FloatMatrix2D |
---|
copy, equals, equals, get, like, normalize, set, toString, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSelection, viewSelection, viewSorted, viewStrides, zAssign8Neighbors, 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 |
---|
public DenseColFloatMatrix2D(float[][] 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 DenseColFloatMatrix2D(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 || (float)columns*rows > Integer.MAX_VALUE
.public DenseColFloatMatrix2D(int rows, int columns, float[] 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 constructed
IllegalArgumentException
- if
rows<0 || columns<0 || (float)columns*rows > Integer.MAX_VALUE
or flip's are illegal.Method Detail |
---|
public float aggregate(FloatFloatFunction aggr, FloatFunction f)
FloatMatrix2D
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 FloatMatrix2D
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.
FloatFunctions
public float aggregate(FloatFloatFunction aggr, FloatFunction f, FloatProcedure cond)
FloatMatrix2D
aggregate
in class FloatMatrix2D
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.
FloatFunctions
public float aggregate(FloatFloatFunction aggr, FloatFunction f, IntArrayList rowList, IntArrayList columnList)
FloatMatrix2D
aggregate
in class FloatMatrix2D
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.
FloatFunctions
public float aggregate(FloatMatrix2D other, FloatFloatFunction aggr, FloatFloatFunction f)
FloatMatrix2D
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 FloatMatrix2D
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.
FloatFunctions
public FloatMatrix2D assign(FloatFunction function)
FloatMatrix2D
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 FloatMatrix2D
function
- a function object taking as argument the current cell's value.
FloatFunctions
public FloatMatrix2D assign(FloatProcedure cond, FloatFunction function)
FloatMatrix2D
assign
in class FloatMatrix2D
cond
- a condition.function
- a function object.
FloatFunctions
public FloatMatrix2D assign(FloatProcedure cond, float value)
FloatMatrix2D
assign
in class FloatMatrix2D
cond
- a condition.value
- a value.
public FloatMatrix2D assign(float value)
FloatMatrix2D
assign
in class FloatMatrix2D
value
- the value to be filled into the cells.
public FloatMatrix2D assign(float[] values)
FloatMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class FloatMatrix2D
values
- the values to be filled into the cells.
public FloatMatrix2D assign(float[][] values)
FloatMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
assign
in class FloatMatrix2D
values
- the values to be filled into the cells.
public FloatMatrix2D assign(FloatMatrix2D source)
FloatMatrix2D
assign
in class FloatMatrix2D
source
- the source matrix to copy from (may be identical to the
receiver).
public FloatMatrix2D assign(FloatMatrix2D y, FloatFloatFunction function)
FloatMatrix2D
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 FloatMatrix2D
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,
FloatFunctions
public FloatMatrix2D assign(FloatMatrix2D y, FloatFloatFunction function, IntArrayList rowList, IntArrayList columnList)
FloatMatrix2D
assign
in class FloatMatrix2D
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.
FloatFunctions
public int cardinality()
FloatMatrix2D
cardinality
in class FloatMatrix2D
public void dct2(boolean scale)
public void dctColumns(boolean scale)
public void dctRows(boolean scale)
public void dht2()
public void dhtColumns()
public void dhtRows()
public void dst2(boolean scale)
public void dstColumns(boolean scale)
public void dstRows(boolean scale)
public float[] elements()
FloatMatrix2D
elements
in class FloatMatrix2D
public void fft2()
public FloatMatrix2D forEachNonZero(IntIntFloatFunction function)
FloatMatrix2D
forEachNonZero
in class FloatMatrix2D
function
- a function object taking as argument the current non-zero
cell's row, column and value.
public FComplexMatrix2D getFft2()
public FComplexMatrix2D getFftColumns()
public FComplexMatrix2D getFftRows()
public FComplexMatrix2D getIfft2(boolean scale)
public FComplexMatrix2D getIfftColumns(boolean scale)
public FComplexMatrix2D getIfftRows(boolean scale)
public void getNegativeValues(IntArrayList rowList, IntArrayList columnList, FloatArrayList valueList)
FloatMatrix2D
getNegativeValues
in class FloatMatrix2D
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, FloatArrayList valueList)
FloatMatrix2D
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 FloatMatrix2D
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, FloatArrayList valueList)
FloatMatrix2D
getPositiveValues
in class FloatMatrix2D
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 float getQuick(int row, int column)
FloatMatrix2D
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 FloatMatrix2D
row
- the index of the row-coordinate.column
- the index of the column-coordinate.
public void idct2(boolean scale)
public void idctColumns(boolean scale)
public void idctRows(boolean scale)
public void idht2(boolean scale)
public void idhtColumns(boolean scale)
public void idhtRows(boolean scale)
public void idst2(boolean scale)
public void idstColumns(boolean scale)
public void idstRows(boolean scale)
public void ifft2(boolean scale)
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 FloatMatrix2D like(int rows, int columns)
FloatMatrix2D
like
in class FloatMatrix2D
rows
- the number of rows the matrix shall have.columns
- the number of columns the matrix shall have.
public FloatMatrix1D like1D(int size)
FloatMatrix2D
like1D
in class FloatMatrix2D
size
- the number of cells the matrix shall have.
public float[] getMaxLocation()
FloatMatrix2D
getMaxLocation
in class FloatMatrix2D
public float[] getMinLocation()
FloatMatrix2D
getMinLocation
in class FloatMatrix2D
public void setQuick(int row, int column, float value)
FloatMatrix2D
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 FloatMatrix2D
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 float[][] toArray()
FloatMatrix2D
The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.
toArray
in class FloatMatrix2D
public FloatMatrix1D vectorize()
FloatMatrix2D
vectorize
in class FloatMatrix2D
public FloatMatrix1D zMult(FloatMatrix1D y, FloatMatrix1D z, float alpha, float beta, boolean transposeA)
FloatMatrix2D
zMult
in class FloatMatrix2D
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 FloatMatrix2D zMult(FloatMatrix2D B, FloatMatrix2D C, float alpha, float beta, boolean transposeA, boolean transposeB)
FloatMatrix2D
zMult
in class FloatMatrix2D
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 float zSum()
FloatMatrix2D
zSum
in class FloatMatrix2D
|
Parallel Colt 0.7.2 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |