public abstract class ObjectMatrix1D extends AbstractMatrix1D
A matrix has a number of cells (its size), which are assigned upon instance construction. Elements are accessed via zero based indexes. Legal indexes are of the form [0..size()-1]. Any attempt to access an element at a coordinate index<0 || index>=size() will throw an IndexOutOfBoundsException.
| Modifier and Type | Method and Description |
|---|---|
Object |
aggregate(ObjectMatrix1D 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 indexList)
Applies a function to all cells with a given indexes and aggregates the
results.
|
ObjectMatrix1D |
assign(Object value)
Sets all cells to the state specified by value.
|
ObjectMatrix1D |
assign(Object[] values)
Sets all cells to the state specified by values.
|
ObjectMatrix1D |
assign(ObjectFunction function)
Assigns the result of a function to each cell;
x[i] = function(x[i]).
|
ObjectMatrix1D |
assign(ObjectMatrix1D other)
Replaces all cell values of the receiver with the values of another
matrix.
|
ObjectMatrix1D |
assign(ObjectMatrix1D y,
ObjectObjectFunction function)
Assigns the result of a function to each cell;
x[i] = function(x[i],y[i]).
|
int |
cardinality()
Returns the number of cells having non-zero values; ignores tolerance.
|
ObjectMatrix1D |
copy()
Constructs and returns a deep copy of the receiver.
|
abstract Object |
elements()
Returns the elements of this matrix.
|
boolean |
equals(Object otherObj)
Compares the specified Object with the receiver for equality.
|
boolean |
equals(Object otherObj,
boolean testForEquality)
Compares the specified Object with the receiver for equality.
|
Object |
get(int index)
Returns the matrix cell value at coordinate index.
|
void |
getNonZeros(IntArrayList indexList,
ObjectArrayList valueList)
Fills the coordinates and values of cells having non-zero values into the
specified lists.
|
abstract Object |
getQuick(int index)
Returns the matrix cell value at coordinate index.
|
ObjectMatrix1D |
like()
Construct and returns a new empty matrix of the same dynamic type
as the receiver, having the same size.
|
abstract ObjectMatrix1D |
like(int size)
Construct and returns a new empty matrix of the same dynamic type
as the receiver, having the specified size.
|
abstract ObjectMatrix2D |
like2D(int rows,
int columns)
Construct and returns a new 2-d matrix of the corresponding dynamic
type, entirelly independent of the receiver.
|
abstract ObjectMatrix2D |
reshape(int rows,
int columns)
Returns new ObjectMatrix2D of size rows x columns whose elements are taken
column-wise from this matrix.
|
abstract ObjectMatrix3D |
reshape(int slices,
int rows,
int columns)
Returns new ObjectMatrix3D of size slices x rows x columns, whose elements
are taken column-wise from this matrix.
|
void |
set(int index,
Object value)
Sets the matrix cell at coordinate index to the specified value.
|
abstract void |
setQuick(int index,
Object value)
Sets the matrix cell at coordinate index to the specified value.
|
void |
setSize(int size)
Sets the size of this matrix.
|
void |
swap(ObjectMatrix1D other)
Swaps each element this[i] with other[i].
|
Object[] |
toArray()
Constructs and returns a 1-dimensional array containing the cell values.
|
void |
toArray(Object[] values)
Fills the cell values into the specified 1-dimensional array.
|
String |
toString()
Returns a string representation using default formatting.
|
ObjectMatrix1D |
viewFlip()
Constructs and returns a new flip view.
|
ObjectMatrix1D |
viewPart(int index,
int width)
Constructs and returns a new sub-range view that is a
width sub matrix starting at index.
|
ObjectMatrix1D |
viewSelection(int[] indexes)
Constructs and returns a new selection view that is a matrix
holding the indicated cells.
|
ObjectMatrix1D |
viewSelection(ObjectProcedure condition)
Constructs and returns a new selection view that is a matrix
holding the cells matching the given condition.
|
ObjectMatrix1D |
viewSorted()
Sorts the vector into ascending order, according to the natural
ordering.
|
ObjectMatrix1D |
viewStrides(int stride)
Constructs and returns a new stride view which is a sub matrix
consisting of every i-th cell.
|
checkSize, index, size, stride, toStringShortensureCapacity, isView, trimToSizeclonepublic Object aggregate(ObjectObjectFunction aggr, ObjectFunction f)
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.public Object aggregate(ObjectObjectFunction aggr, ObjectFunction f, IntArrayList indexList)
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.indexList - indexes.public Object aggregate(ObjectMatrix1D other, ObjectObjectFunction aggr, ObjectObjectFunction f)
Example:
cern.jet.math.Functions F = cern.jet.math.Functions.functions;
x = 0 1 2 3
y = 0 1 2 3
// Sum( x[i]*y[i] )
x.aggregate(y, F.plus, F.mult);
--> 14
// Sum( (x[i]+y[i])ˆ2 )
x.aggregate(y, F.plus, F.chain(F.square,F.plus));
--> 56
For further examples, see the package doc.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.IllegalArgumentException - if size() != other.size().public ObjectMatrix1D assign(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 cells.IllegalArgumentException - if values.length != size().public ObjectMatrix1D assign(ObjectFunction function)
Example:
// change each cell to its sine
matrix = 0.5 1.5 2.5 3.5
matrix.assign(cern.jet.math.Functions.sin);
-->
matrix == 0.479426 0.997495 0.598472 -0.350783
For further examples, see the package doc.function - a function object taking as argument the current cell's value.DoubleFunctionspublic ObjectMatrix1D assign(ObjectMatrix1D other)
other - the source matrix to copy from (may be identical to the
receiver).IllegalArgumentException - if size() != other.size().public ObjectMatrix1D assign(ObjectMatrix1D y, ObjectObjectFunction function)
Example:
// assign x[i] = x[i]<sup>y[i]</sup>
m1 = 0 1 2 3;
m2 = 0 2 4 6;
m1.assign(m2, cern.jet.math.Functions.pow);
-->
m1 == 1 1 16 729
For further examples, see the package doc.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,IllegalArgumentException - if size() != y.size().DoubleFunctionspublic ObjectMatrix1D assign(Object value)
value - the value to be filled into the cells.public int cardinality()
public ObjectMatrix1D copy()
Note that the returned matrix is an independent deep copy. The returned matrix is not backed by this matrix, so changes in the returned matrix are not reflected in this matrix, and vice-versa.
public abstract Object elements()
public boolean equals(Object otherObj)
public boolean equals(Object otherObj, boolean testForEquality)
otherObj - the Object to be compared for equality with the receiver.testForEquality - if true -> tests for equality, otherwise for identity.public Object get(int index)
index - the index of the cell.IndexOutOfBoundsException - if index<0 || index>=size().public void getNonZeros(IntArrayList indexList, ObjectArrayList valueList)
In general, fill order is unspecified. This implementation fills like: for (index = 0..size()-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:
0, 0, 8, 0, 7
-->
indexList = (2,4)
valueList = (8,7)
In other words, get(2)==8, get(4)==7.indexList - the list to be filled with indexes, can have any size.valueList - the list to be filled with values, can have any size.public abstract Object getQuick(int index)
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): index<0 || index>=size().
index - the index of the cell.public ObjectMatrix1D like()
public abstract ObjectMatrix1D like(int size)
size - the number of cell the matrix shall have.public abstract ObjectMatrix2D like2D(int rows, int columns)
rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.public abstract ObjectMatrix2D reshape(int rows, int columns)
rows - number of rowscolumns - number of columnspublic abstract ObjectMatrix3D reshape(int slices, int rows, int columns)
rows - number of rowscolumns - number of columnspublic void set(int index,
Object value)
index - the index of the cell.value - the value to be filled into the specified cell.IndexOutOfBoundsException - if index<0 || index>=size().public void setSize(int size)
size - public abstract void setQuick(int index,
Object 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): index<0 || index>=size().
index - the index of the cell.value - the value to be filled into the specified cell.public void swap(ObjectMatrix1D other)
IllegalArgumentException - if size() != other.size().public Object[] toArray()
public void toArray(Object[] values)
IllegalArgumentException - if values.length < size().public String toString()
toString in class ObjectObjectFormatterpublic ObjectMatrix1D viewFlip()
public ObjectMatrix1D viewPart(int index, int width)
Note that the view is really just a range restriction: The returned matrix is backed by this matrix, so changes in the returned matrix are reflected in this matrix, and vice-versa.
The view contains the cells from index..index+width-1. and has view.size() == width. A view's legal coordinates are again zero based, as usual. In other words, legal coordinates of the view are 0 .. view.size()-1==width-1. As usual, any attempt to access a cell at other coordinates will throw an IndexOutOfBoundsException.
index - The index of the first cell.width - The width of the range.IndexOutOfBoundsException - if index<0 || width<0 || index+width>size().public ObjectMatrix1D viewSelection(int[] indexes)
Example:
this = (0,0,8,0,7)
indexes = (0,2,4,2)
-->
view = (0,8,7,8)
Note that modifying indexes after this call has returned has no
effect on the view. The returned view is backed by this matrix, so
changes in the returned view are reflected in this matrix, and
vice-versa.indexes - The indexes of the cells that shall be visible in the new
view. To indicate that all cells shall be visible,
simply set this parameter to null.IndexOutOfBoundsException - if !(0 <= indexes[i] < size()) for any
i=0..indexes.length()-1.public ObjectMatrix1D viewSelection(ObjectProcedure condition)
Example:
// extract and view all cells with even value
matrix = 0 1 2 3
matrix.viewSelection(
new ObjectProcedure() {
public final boolean apply(Object a) { return a % 2 == 0; }
}
);
-->
matrix == 0 2
For further examples, see the package doc. The returned
view is backed by this matrix, so changes in the returned view are
reflected in this matrix, and vice-versa.condition - The condition to be matched.public ObjectMatrix1D viewSorted()
ObjectSorting.sort(ObjectMatrix1D).
For more advanced sorting functionality, see
ObjectSorting.public ObjectMatrix1D viewStrides(int stride)
stride - the step factor.IndexOutOfBoundsException - if stride <= 0.Jump to the Parallel Colt Homepage