cern.colt.matrix.tobject.impl
Class DenseObjectMatrix1D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix1D
              cern.colt.matrix.tobject.ObjectMatrix1D
                  cern.colt.matrix.tobject.impl.DenseObjectMatrix1D

All Implemented Interfaces:

Serializable, Cloneable

public class DenseObjectMatrix1D
extends ObjectMatrix1D

Dense 1-d matrix (aka vector) holding Object elements. First see the package summary and javadoc tree view to get the broad picture.

Implementation:

Internally holds one single contigous one-dimensional array. Note that this implementation is not synchronized.

Memory requirements:

memory [bytes] = 8*size(). Thus, a 1000000 matrix uses 8 MB.

Time complexity:

O(1) (i.e. constant time) for the basic operations get, getQuick, set, setQuick and size,

Version:

1.0, 09/24/99

Author:

wolfgang.hoschek@cern.ch

See Also:

Serialized Form

Constructor Summary

DenseObjectMatrix1D(int size)
Constructs a matrix with a given number of cells.

DenseObjectMatrix1D(Object[] values)
Constructs a matrix with a copy of the given values.

Method Summary

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 source) 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]).
Object	elements() Returns the elements of this matrix.
Object	getQuick(int index) Returns the matrix cell value at coordinate index.
long	index(int rank) Returns the position of the element with the given relative rank within the (virtual or non-virtual) internal 1-dimensional array.
ObjectMatrix1D	like(int size) Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified size.
ObjectMatrix2D	like2D(int rows, int columns) Construct and returns a new 2-d matrix of the corresponding dynamic type, entirelly independent of the receiver.
ObjectMatrix2D	reshape(int rows, int columns) Returns new ObjectMatrix2D of size rows x columns whose elements are taken column-wise from this matrix.
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	setQuick(int index, Object value) Sets the matrix cell at coordinate index to the specified value.
void	swap(ObjectMatrix1D other) Swaps each element this[i] with other[i].
void	toArray(Object[] values) Fills the cell values into the specified 1-dimensional array.

Methods inherited from class cern.colt.matrix.tobject.ObjectMatrix1D

cardinality, copy, equals, equals, get, getNonZeros, like, set, setSize, toArray, toString, viewFlip, viewPart, viewSelection, viewSelection, viewSorted, viewStrides

Methods inherited from class cern.colt.matrix.AbstractMatrix1D

checkSize, size, stride, 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

DenseObjectMatrix1D

public DenseObjectMatrix1D(Object[] values)

Constructs a matrix with a copy of the given values. The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Parameters:

values - The values to be filled into the new matrix.

DenseObjectMatrix1D

public DenseObjectMatrix1D(int size)

Constructs a matrix with a given number of cells. All entries are initially 0.

Parameters:

size - the number of cells the matrix shall have.

Throws:

IllegalArgumentException - if size<0.

Method Detail

aggregate

public Object aggregate(ObjectObjectFunction aggr,
                        ObjectFunction f)

Description copied from class: ObjectMatrix1D

Applies a function to each cell and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(i)) ) and terminators are a(1) == f(get(0)), a(0)==null.

Overrides:

aggregate in class ObjectMatrix1D

Parameters:

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.

Returns:

the aggregated measure.

aggregate

public Object aggregate(ObjectObjectFunction aggr,
                        ObjectFunction f,
                        IntArrayList indexList)

Description copied from class: ObjectMatrix1D

Applies a function to all cells with a given indexes and aggregates the results.

Overrides:

aggregate in class ObjectMatrix1D

Parameters:

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.

Returns:

the aggregated measure.

aggregate

public Object aggregate(ObjectMatrix1D other,
                        ObjectObjectFunction aggr,
                        ObjectObjectFunction f)

Description copied from class: ObjectMatrix1D

Applies a function to each corresponding cell of two matrices and aggregates the results. Returns a value v such that v==a(size()) where a(i) == aggr( a(i-1), f(get(i),other.get(i)) ) and terminators are a(1) == f(get(0),other.get(0)), a(0)==null.

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.

Overrides:

aggregate in class ObjectMatrix1D

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.

Returns:

the aggregated measure.

assign

public ObjectMatrix1D assign(Object[] values)

Sets all cells to the state specified by values. values is required to have the same number of cells as the receiver.

The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

Overrides:

assign in class ObjectMatrix1D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if values.length != size().

assign

public ObjectMatrix1D assign(ObjectFunction function)

Assigns the result of a function to each cell; x[i] = function(x[i]). (Iterates downwards from [size()-1] to [0]).

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.

Overrides:

assign in class ObjectMatrix1D

Parameters:

function - a function object taking as argument the current cell's value.

Returns:

this (for convenience only).

See Also:

DoubleFunctions

assign

public ObjectMatrix1D assign(ObjectMatrix1D source)

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 as if using an intermediate auxiliary deep copy of other.

Overrides:

assign in class ObjectMatrix1D

Parameters:

source - the source matrix to copy from (may be identical to the receiver).

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if size() != other.size().

assign

public ObjectMatrix1D assign(ObjectMatrix1D y,
                             ObjectObjectFunction function)

Assigns the result of a function to each cell; x[i] = function(x[i],y[i]). (Iterates downwards from [size()-1] to [0]).

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 non-standard functions there is no shortcut: 
         m1.assign(m2,
            new ObjectobjectFunction() {
               public Object apply(Object x, Object y) { return Math.pow(x,y); }
            }
         );
 
 

For further examples, see the package doc.

Overrides:

assign in class ObjectMatrix1D

Parameters:

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,

Returns:

this (for convenience only).

Throws:

IllegalArgumentException - if size() != y.size().

See Also:

DoubleFunctions

assign

public ObjectMatrix1D assign(Object value)

Description copied from class: ObjectMatrix1D

Sets all cells to the state specified by value.

Overrides:

assign in class ObjectMatrix1D

Parameters:

value - the value to be filled into the cells.

Returns:

this (for convenience only).

elements

public Object elements()

Description copied from class: ObjectMatrix1D

Returns the elements of this matrix.

Specified by:

elements in class ObjectMatrix1D

Returns:

the elements

getQuick

public Object getQuick(int index)

Returns the matrix cell value at coordinate 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().

Specified by:

getQuick in class ObjectMatrix1D

Parameters:

index - the index of the cell.

Returns:

the value of the specified cell.

index

public long index(int rank)

Returns the position of the element with the given relative rank within the (virtual or non-virtual) internal 1-dimensional array. You may want to override this method for performance.

Overrides:

index in class AbstractMatrix1D

Parameters:

rank - the rank of the element.

like

public ObjectMatrix1D like(int size)

Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified size. For example, if the receiver is an instance of type DenseObjectMatrix1D the new matrix must also be of type DenseObjectMatrix1D, if the receiver is an instance of type SparseObjectMatrix1D the new matrix must also be of type SparseObjectMatrix1D, etc. In general, the new matrix should have internal parametrization as similar as possible.

Specified by:

like in class ObjectMatrix1D

Parameters:

size - the number of cell the matrix shall have.

Returns:

a new empty matrix of the same dynamic type.

like2D

public ObjectMatrix2D like2D(int rows,
                             int columns)

Construct and returns a new 2-d matrix of the corresponding dynamic type, entirelly independent of the receiver. For example, if the receiver is an instance of type DenseObjectMatrix1D the new matrix must be of type DenseObjectMatrix2D, if the receiver is an instance of type SparseObjectMatrix1D the new matrix must be of type SparseObjectMatrix2D, etc.

Specified by:

like2D in class ObjectMatrix1D

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

reshape

public ObjectMatrix2D reshape(int rows,
                              int columns)

Description copied from class: ObjectMatrix1D

Returns new ObjectMatrix2D of size rows x columns whose elements are taken column-wise from this matrix.

Specified by:

reshape in class ObjectMatrix1D

Parameters:

rows - number of rows

columns - number of columns

Returns:

new 2D matrix with columns being the elements of this matrix.

reshape

public ObjectMatrix3D reshape(int slices,
                              int rows,
                              int columns)

Description copied from class: ObjectMatrix1D

Returns new ObjectMatrix3D of size slices x rows x columns, whose elements are taken column-wise from this matrix.

Specified by:

reshape in class ObjectMatrix1D

rows - number of rows

columns - number of columns

Returns:

new 2D matrix with columns being the elements of this matrix.

setQuick

public void setQuick(int index,
                     Object value)

Sets the matrix cell at coordinate index to the specified 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().

Specified by:

setQuick in class ObjectMatrix1D

Parameters:

index - the index of the cell.

value - the value to be filled into the specified cell.

swap

public void swap(ObjectMatrix1D other)

Swaps each element this[i] with other[i].

Overrides:

swap in class ObjectMatrix1D

Throws:

IllegalArgumentException - if size() != other.size().

toArray

public void toArray(Object[] values)

Fills the cell values into the specified 1-dimensional array. The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa. After this call returns the array values has the form
for (int i=0; i < size(); i++) values[i] = get(i);

Overrides:

toArray in class ObjectMatrix1D

Throws:

IllegalArgumentException - if values.length < size().