/*
Copyright � 1999 CERN - European Organization for Nuclear Research.
Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose
is hereby granted without fee, provided that the above copyright notice appear in all copies and
that both that copyright notice and this permission notice appear in supporting documentation.
CERN makes no representations about the suitability of this software for any purpose.
It is provided "as is" without expressed or implied warranty.
*/
package cern.colt.matrix;
import cern.colt.list.IntArrayList;
import cern.colt.list.ObjectArrayList;
import cern.colt.matrix.impl.AbstractMatrix1D;
/**
Abstract base class for 1-d matrices (aka <i>vectors</i>) holding <tt>Object</tt> elements.
First see the <a href="package-summary.html">package summary</a> and javadoc <a href="package-tree.html">tree view</a> to get the broad picture.
<p>
A matrix has a number of cells (its <i>size</i>), which are assigned upon instance construction.
Elements are accessed via zero based indexes.
Legal indexes are of the form <tt>[0..size()-1]</tt>.
Any attempt to access an element at a coordinate <tt>index<0 || index>=size()</tt> will throw an <tt>IndexOutOfBoundsException</tt>.
@author wolfgang.hoschek@cern.ch
@version 1.0, 09/24/99
*/
public abstract class ObjectMatrix1D extends AbstractMatrix1D {
/**
* Makes this class non instantiable, but still let's others inherit from it.
*/
protected ObjectMatrix1D() {}
/**
Applies a function to each cell and aggregates the results.
Returns a value <tt>v</tt> such that <tt>v==a(size())</tt> where <tt>a(i) == aggr( a(i-1), f(get(i)) )</tt> and terminators are <tt>a(1) == f(get(0)), a(0)==null</tt>.
<p>
<b>Example:</b>
<pre>
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);
--> 14
</pre>
For further examples, see the <a href="package-summary.html#FunctionObjects">package doc</a>.
@param aggr an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell value.
@param f a function transforming the current cell value.
@return the aggregated measure.
*/
public Object aggregate(cern.colt.function.ObjectObjectFunction aggr, cern.colt.function.ObjectFunction f) {
if (size==0) return null;
Object a = f.apply(getQuick(size-1));
for (int i=size-1; --i >= 0; ) {
a = aggr.apply(a, f.apply(getQuick(i)));
}
return a;
}
/**
Applies a function to each corresponding cell of two matrices and aggregates the results.
Returns a value <tt>v</tt> such that <tt>v==a(size())</tt> where <tt>a(i) == aggr( a(i-1), f(get(i),other.get(i)) )</tt> and terminators are <tt>a(1) == f(get(0),other.get(0)), a(0)==null</tt>.
<p>
<b>Example:</b>
<pre>
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
</pre>
For further examples, see the <a href="package-summary.html#FunctionObjects">package doc</a>.
@param aggr an aggregation function taking as first argument the current aggregation and as second argument the transformed current cell values.
@param f a function transforming the current cell values.
@return the aggregated measure.
@throws IllegalArgumentException if <tt>size() != other.size()</tt>.
*/
public Object aggregate(ObjectMatrix1D other, cern.colt.function.ObjectObjectFunction aggr, cern.colt.function.ObjectObjectFunction f) {
checkSize(other);
if (size==0) return null;
Object a = f.apply(getQuick(size-1),other.getQuick(size-1));
for (int i=size-1; --i >= 0; ) {
a = aggr.apply(a, f.apply(getQuick(i),other.getQuick(i)));
}
return a;
}
/**
* Sets all cells to the state specified by <tt>values</tt>.
* <tt>values</tt> is required to have the same number of cells as the receiver.
* <p>
* The values are copied. So subsequent changes in <tt>values</tt> are not reflected in the matrix, and vice-versa.
*
* @param values the values to be filled into the cells.
* @return <tt>this</tt> (for convenience only).
* @throws IllegalArgumentException if <tt>values.length != size()</tt>.
*/
public ObjectMatrix1D assign(Object[] values) {
if (values.length != size) throw new IllegalArgumentException("Must have same number of cells: length="+values.length+", size()="+size());
for (int i=size; --i >= 0;) {
setQuick(i,values[i]);
}
return this;
}
/**
Assigns the result of a function to each cell; <tt>x[i] = function(x[i])</tt>.
(Iterates downwards from <tt>[size()-1]</tt> to <tt>[0]</tt>).
<p>
<b>Example:</b>
<pre>
// 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
</pre>
For further examples, see the <a href="package-summary.html#FunctionObjects">package doc</a>.
@param function a function object taking as argument the current cell's value.
@return <tt>this</tt> (for convenience only).
@see cern.jet.math.Functions
*/
public ObjectMatrix1D assign(cern.colt.function.ObjectFunction function) {
for (int i=size; --i >= 0; ) {
setQuick(i, function.apply(getQuick(i)));
}
return this;
}
/**
* Replaces all cell values of the receiver with the values of another matrix.
* Both matrices must have the same size.
* If both matrices share the same cells (as is the case if they are views derived from the same matrix) and intersect in an ambiguous way, then replaces <i>as if</i> using an intermediate auxiliary deep copy of <tt>other</tt>.
*
* @param other the source matrix to copy from (may be identical to the receiver).
* @return <tt>this</tt> (for convenience only).
* @throws IllegalArgumentException if <tt>size() != other.size()</tt>.
*/
public ObjectMatrix1D assign(ObjectMatrix1D other) {
if (other==this) return this;
checkSize(other);
if (haveSharedCells(other)) other = other.copy();
for (int i=size; --i >= 0;) {
setQuick(i,other.getQuick(i));
}
return this;
}
/**
Assigns the result of a function to each cell; <tt>x[i] = function(x[i],y[i])</tt>.
<p>
<b>Example:</b>
<pre>
// 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
</pre>
For further examples, see the <a href="package-summary.html#FunctionObjects">package doc</a>.
@param y the secondary matrix to operate on.
@param function a function object taking as first argument the current cell's value of <tt>this</tt>,
and as second argument the current cell's value of <tt>y</tt>,
@return <tt>this</tt> (for convenience only).
@throws IllegalArgumentException if <tt>size() != y.size()</tt>.
@see cern.jet.math.Functions
*/
public ObjectMatrix1D assign(ObjectMatrix1D y, cern.colt.function.ObjectObjectFunction function) {
checkSize(y);
for (int i=size; --i >= 0; ) {
setQuick(i, function.apply(getQuick(i), y.getQuick(i)));
}
return this;
}
/**
* Sets all cells to the state specified by <tt>value</tt>.
* @param value the value to be filled into the cells.
* @return <tt>this</tt> (for convenience only).
*/
public ObjectMatrix1D assign(Object value) {
for (int i=size; --i >= 0;) {
setQuick(i,value);
}
return this;
}
/**
* Returns the number of cells having non-zero values; ignores tolerance.
*/
public int cardinality() {
int cardinality = 0;
for (int i=size; --i >= 0;) {
if (getQuick(i) != null) cardinality++;
}
return cardinality;
}
/**
* Constructs and returns a deep copy of the receiver.
* <p>
* <b>Note that the returned matrix is an independent deep copy.</b>
* The returned matrix is not backed by this matrix, so changes in the returned matrix are not reflected in this matrix, and vice-versa.
*
* @return a deep copy of the receiver.
*/
public ObjectMatrix1D copy() {
ObjectMatrix1D copy = like();
copy.assign(this);
return copy;
}
/**
* Compares the specified Object with the receiver for equality.
* Equivalent to <tt>equals(otherObj,true)</tt>.
*
* @param otherObj the Object to be compared for equality with the receiver.
* @return true if the specified Object is equal to the receiver.
*/
public boolean equals(Object otherObj) { //delta
return equals(otherObj, true);
}
/**
* Compares the specified Object with the receiver for equality.
* Returns true if and only if the specified Object is also at least an ObjectMatrix1D, both matrices have the
* same size, and all corresponding pairs of cells in the two matrices are the same.
* In other words, two matrices are defined to be equal if they contain the
* same cell values in the same order.
* Tests elements for equality or identity as specified by <tt>testForEquality</tt>.
* When testing for equality, two elements <tt>e1</tt> and
* <tt>e2</tt> are <i>equal</i> if <tt>(e1==null ? e2==null :
* e1.equals(e2))</tt>.)
*
* @param otherObj the Object to be compared for equality with the receiver.
* @param testForEquality if true -> tests for equality, otherwise for identity.
* @return true if the specified Object is equal to the receiver.
*/
public boolean equals(Object otherObj, boolean testForEquality) { //delta
if (! (otherObj instanceof ObjectMatrix1D)) {return false;}
if (this==otherObj) return true;
if (otherObj==null) return false;
ObjectMatrix1D other = (ObjectMatrix1D) otherObj;
if (size!=other.size()) return false;
if (! testForEquality) {
for (int i=size; --i >= 0; ) {
if (getQuick(i) != other.getQuick(i)) return false;
}
}
else {
for (int i=size; --i >= 0; ) {
if (!(getQuick(i)==null ? other.getQuick(i)==null : getQuick(i).equals(other.getQuick(i)))) return false;
}
}
return true;
}
/**
* Returns the matrix cell value at coordinate <tt>index</tt>.
*
* @param index the index of the cell.
* @return the value of the specified cell.
* @throws IndexOutOfBoundsException if <tt>index<0 || index>=size()</tt>.
*/
public Object get(int index) {
if (index<0 || index>=size) checkIndex(index);
return getQuick(index);
}
/**
* Returns the content of this matrix if it is a wrapper; or <tt>this</tt> otherwise.
* Override this method in wrappers.
*/
protected ObjectMatrix1D getContent() {
return this;
}
/**
Fills the coordinates and values of cells having non-zero values into the specified lists.
Fills into the lists, starting at index 0.
After this call returns the specified lists all have a new size, the number of non-zero values.
<p>
In general, fill order is <i>unspecified</i>.
This implementation fills like: <tt>for (index = 0..size()-1) do ... </tt>.
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).
<p>
<b>Example:</b>
<br>
<pre>
0, 0, 8, 0, 7
-->
indexList = (2,4)
valueList = (8,7)
</pre>
In other words, <tt>get(2)==8, get(4)==7</tt>.
@param indexList the list to be filled with indexes, can have any size.
@param valueList the list to be filled with values, can have any size.
*/
public void getNonZeros(IntArrayList indexList, ObjectArrayList valueList) {
boolean fillIndexList = indexList != null;
boolean fillValueList = valueList != null;
if (fillIndexList) indexList.clear();
if (fillValueList) valueList.clear();
int s = size;
for (int i=0; i < s; i++) {
Object value = getQuick(i);
if (value != null) {
if (fillIndexList) indexList.add(i);
if (fillValueList) valueList.add(value);
}
}
}
/**
* Returns the matrix cell value at coordinate <tt>index</tt>.
*
* <p>Provided with invalid parameters this method may return invalid objects without throwing any exception.
* <b>You should only use this method when you are absolutely sure that the coordinate is within bounds.</b>
* Precondition (unchecked): <tt>index<0 || index>=size()</tt>.
*
* @param index the index of the cell.
* @return the value of the specified cell.
*/
public abstract Object getQuick(int index);
/**
* Returns <tt>true</tt> if both matrices share at least one identical cell.
*/
protected boolean haveSharedCells(ObjectMatrix1D other) {
if (other==null) return false;
if (this==other) return true;
return getContent().haveSharedCellsRaw(other.getContent());
}
/**
* Returns <tt>true</tt> if both matrices share at least one identical cell.
*/
protected boolean haveSharedCellsRaw(ObjectMatrix1D other) {
return false;
}
/**
* Construct and returns a new empty matrix <i>of the same dynamic type</i> as the receiver, having the same size.
* For example, if the receiver is an instance of type <tt>DenseObjectMatrix1D</tt> the new matrix must also be of type <tt>DenseObjectMatrix1D</tt>,
* if the receiver is an instance of type <tt>SparseObjectMatrix1D</tt> the new matrix must also be of type <tt>SparseObjectMatrix1D</tt>, etc.
* In general, the new matrix should have internal parametrization as similar as possible.
*
* @return a new empty matrix of the same dynamic type.
*/
public ObjectMatrix1D like() {
return like(size);
}
/**
* Construct and returns a new empty matrix <i>of the same dynamic type</i> as the receiver, having the specified size.
* For example, if the receiver is an instance of type <tt>DenseObjectMatrix1D</tt> the new matrix must also be of type <tt>DenseObjectMatrix1D</tt>,
* if the receiver is an instance of type <tt>SparseObjectMatrix1D</tt> the new matrix must also be of type <tt>SparseObjectMatrix1D</tt>, etc.
* In general, the new matrix should have internal parametrization as similar as possible.
*
* @param size the number of cell the matrix shall have.
* @return a new empty matrix of the same dynamic type.
*/
public abstract ObjectMatrix1D like(int size);
/**
* Construct and returns a new 2-d matrix <i>of the corresponding dynamic type</i>, entirelly independent of the receiver.
* For example, if the receiver is an instance of type <tt>DenseObjectMatrix1D</tt> the new matrix must be of type <tt>DenseObjectMatrix2D</tt>,
* if the receiver is an instance of type <tt>SparseObjectMatrix1D</tt> the new matrix must be of type <tt>SparseObjectMatrix2D</tt>, etc.
*
* @param rows the number of rows the matrix shall have.
* @param columns the number of columns the matrix shall have.
* @return a new matrix of the corresponding dynamic type.
*/
public abstract ObjectMatrix2D like2D(int rows, int columns);
/**
* Sets the matrix cell at coordinate <tt>index</tt> to the specified value.
*
* @param index the index of the cell.
* @param value the value to be filled into the specified cell.
* @throws IndexOutOfBoundsException if <tt>index<0 || index>=size()</tt>.
*/
public void set(int index, Object value) {
if (index<0 || index>=size) checkIndex(index);
setQuick(index,value);
}
/**
* Sets the matrix cell at coordinate <tt>index</tt> to the specified value.
*
* <p>Provided with invalid parameters this method may access illegal indexes without throwing any exception.
* <b>You should only use this method when you are absolutely sure that the coordinate is within bounds.</b>
* Precondition (unchecked): <tt>index<0 || index>=size()</tt>.
*
* @param index the index of the cell.
* @param value the value to be filled into the specified cell.
*/
public abstract void setQuick(int index, Object value);
/**
Swaps each element <tt>this[i]</tt> with <tt>other[i]</tt>.
@throws IllegalArgumentException if <tt>size() != other.size()</tt>.
*/
public void swap(ObjectMatrix1D other) {
checkSize(other);
for (int i=size; --i >= 0; ) {
Object tmp = getQuick(i);
setQuick(i, other.getQuick(i));
other.setQuick(i, tmp);
}
return;
}
/**
Constructs and returns a 1-dimensional array containing the cell values.
The values are copied. So subsequent changes in <tt>values</tt> are not reflected in the matrix, and vice-versa.
The returned array <tt>values</tt> has the form
<br>
<tt>for (int i=0; i < size(); i++) values[i] = get(i);</tt>
@return an array filled with the values of the cells.
*/
public Object[] toArray() {
Object[] values = new Object[size];
toArray(values);
return values;
}
/**
Fills the cell values into the specified 1-dimensional array.
The values are copied. So subsequent changes in <tt>values</tt> are not reflected in the matrix, and vice-versa.
After this call returns the array <tt>values</tt> has the form
<br>
<tt>for (int i=0; i < size(); i++) values[i] = get(i);</tt>
@throws IllegalArgumentException if <tt>values.length < size()</tt>.
*/
public void toArray(Object[] values) {
if (values.length < size) throw new IllegalArgumentException("values too small");
for (int i=size; --i >= 0; ) {
values[i] = getQuick(i);
}
}
/**
* Returns a string representation using default formatting.
* @see cern.colt.matrix.objectalgo.Formatter
*/
public String toString() {
return new cern.colt.matrix.objectalgo.Formatter().toString(this);
}
/**
* Constructs and returns a new view equal to the receiver.
* The view is a shallow clone. Calls <code>clone()</code> and casts the result.
* <p>
* <b>Note that the view is not a deep copy.</b>
* The returned matrix is backed by this matrix, so changes in the returned matrix are reflected in this matrix, and vice-versa.
* <p>
* Use {@link #copy()} to construct an independent deep copy rather than a new view.
*
* @return a new view of the receiver.
*/
protected ObjectMatrix1D view() {
return (ObjectMatrix1D) clone();
}
/**
Constructs and returns a new <i>flip view</i>.
What used to be index <tt>0</tt> is now index <tt>size()-1</tt>, ..., what used to be index <tt>size()-1</tt> is now index <tt>0</tt>.
The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.
@return a new flip view.
*/
public ObjectMatrix1D viewFlip() {
return (ObjectMatrix1D) (view().vFlip());
}
/**
Constructs and returns a new <i>sub-range view</i> that is a <tt>width</tt> sub matrix starting at <tt>index</tt>.
Operations on the returned view can only be applied to the restricted range.
Any attempt to access coordinates not contained in the view will throw an <tt>IndexOutOfBoundsException</tt>.
<p>
<b>Note that the view is really just a range restriction:</b>
The returned matrix is backed by this matrix, so changes in the returned matrix are reflected in this matrix, and vice-versa.
<p>
The view contains the cells from <tt>index..index+width-1</tt>.
and has <tt>view.size() == width</tt>.
A view's legal coordinates are again zero based, as usual.
In other words, legal coordinates of the view are <tt>0 .. view.size()-1==width-1</tt>.
As usual, any attempt to access a cell at other coordinates will throw an <tt>IndexOutOfBoundsException</tt>.
@param index The index of the first cell.
@param width The width of the range.
@throws IndexOutOfBoundsException if <tt>index<0 || width<0 || index+width>size()</tt>.
@return the new view.
*/
public ObjectMatrix1D viewPart(int index, int width) {
return (ObjectMatrix1D) (view().vPart(index,width));
}
/**
Constructs and returns a new <i>selection view</i> that is a matrix holding the indicated cells.
There holds <tt>view.size() == indexes.length</tt> and <tt>view.get(i) == this.get(indexes[i])</tt>.
Indexes can occur multiple times and can be in arbitrary order.
<p>
<b>Example:</b>
<br>
<pre>
this = (0,0,8,0,7)
indexes = (0,2,4,2)
-->
view = (0,8,7,8)
</pre>
Note that modifying <tt>indexes</tt> 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.
@param indexes The indexes of the cells that shall be visible in the new view. To indicate that <i>all</i> cells shall be visible, simply set this parameter to <tt>null</tt>.
@return the new view.
@throws IndexOutOfBoundsException if <tt>!(0 <= indexes[i] < size())</tt> for any <tt>i=0..indexes.length()-1</tt>.
*/
public ObjectMatrix1D viewSelection(int[] indexes) {
// check for "all"
if (indexes==null) {
indexes = new int[size];
for (int i=size; --i >= 0; ) indexes[i] = i;
}
checkIndexes(indexes);
int[] offsets = new int[indexes.length];
for (int i=indexes.length; --i >= 0; ) {
offsets[i] = index(indexes[i]);
}
return viewSelectionLike(offsets);
}
/**
Constructs and returns a new <i>selection view</i> that is a matrix holding the cells matching the given condition.
Applies the condition to each cell and takes only those cells where <tt>condition.apply(get(i))</tt> yields <tt>true</tt>.
<p>
<b>Example:</b>
<br>
<pre>
// 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
</pre>
For further examples, see the <a href="package-summary.html#FunctionObjects">package doc</a>.
The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.
@param condition The condition to be matched.
@return the new view.
*/
public ObjectMatrix1D viewSelection(cern.colt.function.ObjectProcedure condition) {
IntArrayList matches = new IntArrayList();
for (int i=0; i < size; i++) {
if (condition.apply(getQuick(i))) matches.add(i);
}
matches.trimToSize();
return viewSelection(matches.elements());
}
/**
* Construct and returns a new selection view.
*
* @param offsets the offsets of the visible elements.
* @return a new view.
*/
protected abstract ObjectMatrix1D viewSelectionLike(int[] offsets);
/**
Sorts the vector into ascending order, according to the <i>natural ordering</i>.
This sort is guaranteed to be <i>stable</i>.
For further information, see {@link cern.colt.matrix.objectalgo.Sorting#sort(ObjectMatrix1D)}.
For more advanced sorting functionality, see {@link cern.colt.matrix.objectalgo.Sorting}.
@return a new sorted vector (matrix) view.
*/
public ObjectMatrix1D viewSorted() {
return cern.colt.matrix.objectalgo.Sorting.mergeSort.sort(this);
}
/**
Constructs and returns a new <i>stride view</i> which is a sub matrix consisting of every i-th cell.
More specifically, the view has size <tt>this.size()/stride</tt> holding cells <tt>this.get(i*stride)</tt> for all <tt>i = 0..size()/stride - 1</tt>.
@param stride the step factor.
@throws IndexOutOfBoundsException if <tt>stride <= 0</tt>.
@return the new view.
*/
public ObjectMatrix1D viewStrides(int stride) {
return (ObjectMatrix1D) (view().vStrides(stride));
}
/**
* Applies a procedure to each cell's value.
* Iterates downwards from <tt>[size()-1]</tt> to <tt>[0]</tt>,
* as demonstrated by this snippet:
* <pre>
* for (int i=size(); --i >=0;) {
* if (!procedure.apply(getQuick(i))) return false;
* }
* return true;
* </pre>
* Note that an implementation may use more efficient techniques, but must not use any other order.
*
* @param procedure a procedure object taking as argument the current cell's value. Stops iteration if the procedure returns <tt>false</tt>, otherwise continues.
* @return <tt>false</tt> if the procedure stopped before all elements where iterated over, <tt>true</tt> otherwise.
*/
private boolean xforEach(final cern.colt.function.ObjectProcedure procedure) {
for (int i=size; --i >= 0;) {
if (!procedure.apply(getQuick(i))) return false;
}
return true;
}
}