public abstract class DoubleMatrix1D 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.
size, stride, zeroisNoViewserialVersionUID| Modifier | Constructor and Description |
|---|---|
protected |
DoubleMatrix1D()
Makes this class non instantiable, but still let's others inherit from it.
|
| Modifier and Type | Method and Description |
|---|---|
double |
aggregate(DoubleDoubleFunction aggr,
DoubleFunction f)
Applies a function to each cell and aggregates the results.
|
double |
aggregate(DoubleMatrix1D other,
DoubleDoubleFunction aggr,
DoubleDoubleFunction f)
Applies a function to each corresponding cell of two matrices and aggregates the results.
|
DoubleMatrix1D |
assign(double value)
Sets all cells to the state specified by value.
|
DoubleMatrix1D |
assign(double[] values)
Sets all cells to the state specified by values.
|
DoubleMatrix1D |
assign(DoubleFunction function)
Assigns the result of a function to each cell; x[i] = function(x[i]).
|
DoubleMatrix1D |
assign(DoubleMatrix1D other)
Replaces all cell values of the receiver with the values of another matrix.
|
DoubleMatrix1D |
assign(DoubleMatrix1D y,
DoubleDoubleFunction function)
Assigns the result of a function to each cell; x[i] = function(x[i],y[i]).
|
DoubleMatrix1D |
assign(DoubleMatrix1D y,
DoubleDoubleFunction function,
IntArrayList nonZeroIndexes)
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.
|
protected int |
cardinality(int maxCardinality)
Returns the number of cells having non-zero values, but at most maxCardinality; ignores tolerance.
|
DoubleMatrix1D |
copy()
Constructs and returns a deep copy of the receiver.
|
boolean |
equals(double value)
Returns whether all cells are equal to the given value.
|
boolean |
equals(Object obj)
Compares this object against the specified object.
|
double |
get(int index)
Returns the matrix cell value at coordinate index.
|
protected DoubleMatrix1D |
getContent()
Returns the content of this matrix if it is a wrapper; or this otherwise.
|
void |
getNonZeros(IntArrayList indexList,
DoubleArrayList valueList)
Fills the coordinates and values of cells having non-zero values into the specified lists.
|
void |
getNonZeros(IntArrayList indexList,
DoubleArrayList valueList,
int maxCardinality)
Fills the coordinates and values of cells having non-zero values into the specified lists.
|
abstract double |
getQuick(int index)
Returns the matrix cell value at coordinate index.
|
protected boolean |
haveSharedCells(DoubleMatrix1D other)
Returns true if both matrices share at least one identical cell.
|
protected boolean |
haveSharedCellsRaw(DoubleMatrix1D other)
Returns true if both matrices share at least one identical cell.
|
DoubleMatrix1D |
like()
Construct and returns a new empty matrix of the same dynamic type as the receiver, having the same size.
|
abstract DoubleMatrix1D |
like(int size)
Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified size.
|
abstract DoubleMatrix2D |
like2D(int rows,
int columns)
Construct and returns a new 2-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
|
void |
set(int index,
double value)
Sets the matrix cell at coordinate index to the specified value.
|
abstract void |
setQuick(int index,
double value)
Sets the matrix cell at coordinate index to the specified value.
|
void |
swap(DoubleMatrix1D other)
Swaps each element this[i] with other[i].
|
double[] |
toArray()
Constructs and returns a 1-dimensional array containing the cell values.
|
void |
toArray(double[] values)
Fills the cell values into the specified 1-dimensional array.
|
String |
toString()
Returns a string representation using default formatting.
|
protected DoubleMatrix1D |
view()
Constructs and returns a new view equal to the receiver.
|
DoubleMatrix1D |
viewFlip()
Constructs and returns a new flip view.
|
DoubleMatrix1D |
viewPart(int index,
int width)
Constructs and returns a new sub-range view that is a width sub matrix starting at index.
|
DoubleMatrix1D |
viewSelection(DoubleProcedure condition)
Constructs and returns a new selection view that is a matrix holding the cells matching the given condition.
|
DoubleMatrix1D |
viewSelection(int[] indexes)
Constructs and returns a new selection view that is a matrix holding the indicated cells.
|
protected abstract DoubleMatrix1D |
viewSelectionLike(int[] offsets)
Construct and returns a new selection view.
|
DoubleMatrix1D |
viewSorted()
Sorts the vector into ascending order, according to the natural ordering.
|
DoubleMatrix1D |
viewStrides(int stride)
Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell.
|
double |
zDotProduct(DoubleMatrix1D y)
Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]).
|
protected double |
zDotProduct(DoubleMatrix1D y,
IntArrayList nonZeroIndexes)
Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]).
|
double |
zDotProduct(DoubleMatrix1D y,
int from,
int length)
Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]).
|
double |
zDotProduct(DoubleMatrix1D y,
int from,
int length,
IntArrayList nonZeroIndexes)
Returns the dot product of two vectors x and y, which is Sum(x[i]*y[i]).
|
double |
zSum()
Returns the sum of all cells; Sum( x[i] ).
|
_offset, _rank, checkIndex, checkIndexes, checkRange, checkSize, checkSize, index, setUp, setUp, size, stride, toStringShort, vFlip, vPart, vStridesensureCapacity, isView, trimToSizecloneprotected DoubleMatrix1D()
public double aggregate(DoubleDoubleFunction aggr, DoubleFunction f)
Example:
cern.jet.math.Functions F = cern.jet.math.Functions.functions; matrix = 0 1 2 3 // Sum( x[i]*x[i] ) matrix.aggregate(F.plus,F.square); --> 14For 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 value.f - a function transforming the current cell value.Functionspublic double aggregate(DoubleMatrix1D other, DoubleDoubleFunction aggr, DoubleDoubleFunction 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)); --> 56For 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().Functionspublic DoubleMatrix1D assign(double[] 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 DoubleMatrix1D assign(double value)
value - the value to be filled into the cells.public DoubleMatrix1D assign(DoubleFunction 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.350783For further examples, see the package doc.
function - a function object taking as argument the current cell's value.Functionspublic DoubleMatrix1D assign(DoubleMatrix1D other)
other - the source matrix to copy from (may be identical to the receiver).IllegalArgumentException - if size() != other.size().public DoubleMatrix1D assign(DoubleMatrix1D y, DoubleDoubleFunction function)
Example:
// assign x[i] = x[i]y[i] m1 = 0 1 2 3; m2 = 0 2 4 6; m1.assign(m2, cern.jet.math.Functions.pow); --> m1 == 1 1 16 729For 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().Functionspublic DoubleMatrix1D assign(DoubleMatrix1D y, DoubleDoubleFunction function, IntArrayList nonZeroIndexes)
Example:
// assign x[i] = x[i]y[i]
m1 = 0 1 2 3;
m2 = 0 2 4 6;
m1.assign(m2, cern.jet.math.Functions.pow);
-->
m1 == 1 1 16 729
// for non-standard functions there is no shortcut:
m1.assign(m2,
new DoubleDoubleFunction() {
public double apply(double x, double y) { return Math.pow(x,y); }
}
);
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().Functionspublic int cardinality()
protected int cardinality(int maxCardinality)
public DoubleMatrix1D 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 boolean equals(double value)
value - the value to test against.public boolean equals(Object obj)
true if and only if the argument is
not null and is at least a DoubleMatrix1D object
that has the same sizes as the receiver and
has exactly the same values at the same indexes.public double get(int index)
index - the index of the cell.IndexOutOfBoundsException - if index<0 || index>=size().protected DoubleMatrix1D getContent()
public void getNonZeros(IntArrayList indexList, DoubleArrayList 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 void getNonZeros(IntArrayList indexList, DoubleArrayList valueList, int maxCardinality)
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 double 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.protected boolean haveSharedCells(DoubleMatrix1D other)
protected boolean haveSharedCellsRaw(DoubleMatrix1D other)
public DoubleMatrix1D like()
public abstract DoubleMatrix1D like(int size)
size - the number of cell the matrix shall have.public abstract DoubleMatrix2D like2D(int rows, int columns)
rows - the number of rows the matrix shall have.columns - the number of columns the matrix shall have.public void set(int index,
double value)
index - the index of the cell.value - the value to be filled into the specified cell.IndexOutOfBoundsException - if index<0 || index>=size().public abstract void setQuick(int index,
double 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(DoubleMatrix1D other)
IllegalArgumentException - if size() != other.size().public double[] toArray()
public void toArray(double[] values)
IllegalArgumentException - if values.length < size().public String toString()
protected DoubleMatrix1D view()
clone() and casts the result.
Note that the view is not a deep copy. The returned matrix is backed by this matrix, so changes in the returned matrix are reflected in this matrix, and vice-versa.
Use copy() to construct an independent deep copy rather than a new view.
public DoubleMatrix1D viewFlip()
public DoubleMatrix1D 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 DoubleMatrix1D 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 DoubleMatrix1D viewSelection(DoubleProcedure condition)
Example:
// extract and view all cells with even value
matrix = 0 1 2 3
matrix.viewSelection(
new DoubleProcedure() {
public final boolean apply(double 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.protected abstract DoubleMatrix1D viewSelectionLike(int[] offsets)
offsets - the offsets of the visible elements.public DoubleMatrix1D viewSorted()
Sorting.sort(DoubleMatrix1D).
For more advanced sorting functionality, see Sorting.public DoubleMatrix1D viewStrides(int stride)
stride - the step factor.IndexOutOfBoundsException - if stride <= 0.public double zDotProduct(DoubleMatrix1D y)
y - the second vector.public double zDotProduct(DoubleMatrix1D y, int from, int length)
y - the second vector.from - the first index to be considered.length - the number of cells to be considered.public double zDotProduct(DoubleMatrix1D y, int from, int length, IntArrayList nonZeroIndexes)
y - the second vector.nonZeroIndexes - the indexes of cells in yhaving a non-zero value.protected double zDotProduct(DoubleMatrix1D y, IntArrayList nonZeroIndexes)
y - the second vector.nonZeroIndexes - the indexes of cells in yhaving a non-zero value.public double zSum()
Copyright © 2006–2019 SYSTAP, LLC DBA Blazegraph. All rights reserved.