cern.colt.matrix.tobject.impl
Class WrapperObjectMatrix2D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix2D
              cern.colt.matrix.tobject.ObjectMatrix2D
                  cern.colt.matrix.tobject.impl.WrapperObjectMatrix2D

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DenseLargeObjectMatrix2D, DiagonalObjectMatrix2D, SparseCCMObjectMatrix2D, SparseCCObjectMatrix2D, SparseRCMObjectMatrix2D, SparseRCObjectMatrix2D

public class WrapperObjectMatrix2D
extends ObjectMatrix2D

2-d matrix holding Object elements; either a view wrapping another matrix or a matrix whose views are wrappers.

Version:

1.0, 04/14/2000

Author:

wolfgang.hoschek@cern.ch, Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

WrapperObjectMatrix2D(ObjectMatrix2D newContent)

Method Summary

ObjectMatrix2D	assign(int[] values)
ObjectMatrix2D	assign(Object[] values) Sets all cells to the state specified by values.
ObjectMatrix2D	assign(ObjectMatrix2D y, ObjectObjectFunction function) Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).
Object	elements() Returns the elements of this matrix.
boolean	equals(Object obj) Compares the specified Object with the receiver for equality.
Object	getQuick(int row, int column) Returns the matrix cell value at coordinate [row,column].
ObjectMatrix2D	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.
ObjectMatrix1D	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, Object value) Sets the matrix cell at coordinate [row,column] to the specified value.
ObjectMatrix1D	vectorize() Returns a vector obtained by stacking the columns of the matrix on top of one another.
ObjectMatrix1D	viewColumn(int column) Constructs and returns a new slice view representing the rows of the given column.
ObjectMatrix2D	viewColumnFlip() Constructs and returns a new flip view along the column axis.
ObjectMatrix2D	viewDice() Constructs and returns a new dice (transposition) view; Swaps axes; example: 3 x 4 matrix --> 4 x 3 matrix.
ObjectMatrix2D	viewPart(int row, int column, int height, int width) Constructs and returns a new sub-range view that is a height x width sub matrix starting at [row,column].
ObjectMatrix1D	viewRow(int row) Constructs and returns a new slice view representing the columns of the given row.
ObjectMatrix2D	viewRowFlip() Constructs and returns a new flip view along the row axis.
ObjectMatrix2D	viewSelection(int[] rowIndexes, int[] columnIndexes) Constructs and returns a new selection view that is a matrix holding the indicated cells.
ObjectMatrix2D	viewStrides(int _rowStride, int _columnStride) Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell.

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

aggregate, aggregate, aggregate, aggregate, assign, assign, assign, assign, assign, assign, assign, cardinality, copy, equals, forEachNonZero, get, getNonZeros, like, set, toArray, toString, viewSelection, viewSorted

Methods inherited from class cern.colt.matrix.AbstractMatrix2D

checkShape, checkShape, columns, columnStride, index, 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

WrapperObjectMatrix2D

public WrapperObjectMatrix2D(ObjectMatrix2D newContent)

Method Detail

assign

public ObjectMatrix2D assign(ObjectMatrix2D y,
                             ObjectObjectFunction function)

Description copied from class: ObjectMatrix2D

Assigns the result of a function to each cell; x[row,col] = function(x[row,col],y[row,col]).

Overrides:

assign in class ObjectMatrix2D

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).

See Also:

DoubleFunctions

assign

public ObjectMatrix2D assign(int[] values)

assign

public ObjectMatrix2D assign(Object[] values)

Description copied from class: ObjectMatrix2D

Sets all cells to the state specified by values. values is required to have the form values[row*column] and elements have to be stored in a row-wise order.

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

Overrides:

assign in class ObjectMatrix2D

Parameters:

values - the values to be filled into the cells.

Returns:

this (for convenience only).

elements

public Object elements()

Description copied from class: ObjectMatrix2D

Returns the elements of this matrix.

Specified by:

elements in class ObjectMatrix2D

Returns:

the elements

getQuick

public Object getQuick(int row,
                       int column)

Description copied from class: ObjectMatrix2D

Returns the matrix cell value at coordinate [row,column].

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().

Specified by:

getQuick in class ObjectMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

equals

public boolean equals(Object obj)

Description copied from class: ObjectMatrix2D

Compares the specified Object with the receiver for equality. Equivalent to equals(otherObj,true).

Overrides:

equals in class ObjectMatrix2D

Parameters:

obj - the Object to be compared for equality with the receiver.

Returns:

true if the specified Object is equal to the receiver.

like

public ObjectMatrix2D like(int rows,
                           int columns)

Description copied from class: ObjectMatrix2D

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

Specified by:

like in class ObjectMatrix2D

Parameters:

rows - the number of rows the matrix shall have.

columns - the number of columns the matrix shall have.

Returns:

a new empty matrix of the same dynamic type.

like1D

public ObjectMatrix1D like1D(int size)

Description copied from class: ObjectMatrix2D

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

Specified by:

like1D in class ObjectMatrix2D

Parameters:

size - the number of cells the matrix shall have.

Returns:

a new matrix of the corresponding dynamic type.

setQuick

public void setQuick(int row,
                     int column,
                     Object value)

Description copied from class: ObjectMatrix2D

Sets the matrix cell at coordinate [row,column] 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): 0 <= column < columns() && 0 <= row < rows().

Specified by:

setQuick in class ObjectMatrix2D

Parameters:

row - the index of the row-coordinate.

column - the index of the column-coordinate.

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

vectorize

public ObjectMatrix1D vectorize()

Description copied from class: ObjectMatrix2D

Returns a vector obtained by stacking the columns of the matrix on top of one another.

Specified by:

vectorize in class ObjectMatrix2D

Returns:

a vector of columns of this matrix.

viewColumn

public ObjectMatrix1D viewColumn(int column)

Description copied from class: ObjectMatrix2D

Constructs and returns a new slice view representing the rows of the given column. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa. To obtain a slice view on subranges, construct a sub-ranging view ( viewPart(...)), then apply this method to the sub-range view.

Example:

2 x 3 matrix: 1, 2, 3 4, 5, 6

viewColumn(0) ==>

Matrix1D of size 2: 1, 4

Overrides:

viewColumn in class ObjectMatrix2D

Parameters:

column - the column to fix.

Returns:

a new slice view.

See Also:

ObjectMatrix2D.viewRow(int)

viewColumnFlip

public ObjectMatrix2D viewColumnFlip()

Description copied from class: ObjectMatrix2D

Constructs and returns a new flip view along the column axis. What used to be column 0 is now column columns()-1, ..., what used to be column columns()-1 is now column 0. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Example:

2 x 3 matrix: 1, 2, 3 4, 5, 6

columnFlip ==>

2 x 3 matrix: 3, 2, 1 6, 5, 4

columnFlip ==>

2 x 3 matrix: 1, 2, 3 4, 5, 6

Overrides:

viewColumnFlip in class ObjectMatrix2D

Returns:

a new flip view.

See Also:

ObjectMatrix2D.viewRowFlip()

viewDice

public ObjectMatrix2D viewDice()

Description copied from class: ObjectMatrix2D

Constructs and returns a new dice (transposition) view; Swaps axes; example: 3 x 4 matrix --> 4 x 3 matrix. The view has both dimensions exchanged; what used to be columns become rows, what used to be rows become columns. In other words: view.get(row,column)==this.get(column,row). This is a zero-copy transposition, taking O(1), i.e. constant time. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa. Use idioms like result = viewDice(A).copy() to generate an independent transposed matrix.

Example:

2 x 3 matrix: 1, 2, 3 4, 5, 6

transpose ==>

3 x 2 matrix: 1, 4 2, 5 3, 6

transpose ==>

2 x 3 matrix: 1, 2, 3 4, 5, 6

Overrides:

viewDice in class ObjectMatrix2D

Returns:

a new dice view.

viewPart

public ObjectMatrix2D viewPart(int row,
                               int column,
                               int height,
                               int width)

Description copied from class: ObjectMatrix2D

Constructs and returns a new sub-range view that is a height x width sub matrix starting at [row,column]. 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 IndexOutOfBoundsException.

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 [row,column] to [row+height-1,column+width-1], all inclusive. and has view.rows() == height; view.columns() == width;. A view's legal coordinates are again zero based, as usual. In other words, legal coordinates of the view range from [0,0] to [view.rows()-1==height-1,view.columns()-1==width-1]. As usual, any attempt to access a cell at a coordinate column<0 || column>=view.columns() || row<0 || row>=view.rows() will throw an IndexOutOfBoundsException.

Overrides:

viewPart in class ObjectMatrix2D

Parameters:

row - The index of the row-coordinate.

column - The index of the column-coordinate.

height - The height of the box.

width - The width of the box.

Returns:

the new view.

viewRow

public ObjectMatrix1D viewRow(int row)

Description copied from class: ObjectMatrix2D

Constructs and returns a new slice view representing the columns of the given row. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa. To obtain a slice view on subranges, construct a sub-ranging view ( viewPart(...)), then apply this method to the sub-range view.

Example:

2 x 3 matrix: 1, 2, 3 4, 5, 6

viewRow(0) ==>

Matrix1D of size 3: 1, 2, 3

Overrides:

viewRow in class ObjectMatrix2D

Parameters:

row - the row to fix.

Returns:

a new slice view.

See Also:

ObjectMatrix2D.viewColumn(int)

viewRowFlip

public ObjectMatrix2D viewRowFlip()

Description copied from class: ObjectMatrix2D

Constructs and returns a new flip view along the row axis. What used to be row 0 is now row rows()-1, ..., what used to be row rows()-1 is now row 0. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Example:

2 x 3 matrix: 1, 2, 3 4, 5, 6

rowFlip ==>

2 x 3 matrix: 4, 5, 6 1, 2, 3

rowFlip ==>

2 x 3 matrix: 1, 2, 3 4, 5, 6

Overrides:

viewRowFlip in class ObjectMatrix2D

Returns:

a new flip view.

See Also:

ObjectMatrix2D.viewColumnFlip()

viewSelection

public ObjectMatrix2D viewSelection(int[] rowIndexes,
                                    int[] columnIndexes)

Description copied from class: ObjectMatrix2D

Constructs and returns a new selection view that is a matrix holding the indicated cells. There holds view.rows() == rowIndexes.length, view.columns() == columnIndexes.length and view.get(i,j) == this.get(rowIndexes[i],columnIndexes[j]). Indexes can occur multiple times and can be in arbitrary order.

Example:

         this = 2 x 3 matrix:
         1, 2, 3
         4, 5, 6
         rowIndexes     = (0,1)
         columnIndexes  = (1,0,1,0)
         -->
         view = 2 x 4 matrix:
         2, 1, 2, 1
         5, 4, 5, 4
 
 

Note that modifying the index arguments 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.

To indicate "all" rows or "all columns", simply set the respective parameter

Overrides:

viewSelection in class ObjectMatrix2D

Parameters:

rowIndexes - The rows of the cells that shall be visible in the new view. To indicate that all rows shall be visible, simply set this parameter to null.

columnIndexes - The columns of the cells that shall be visible in the new view. To indicate that all columns shall be visible, simply set this parameter to null.

Returns:

the new view.

viewStrides

public ObjectMatrix2D viewStrides(int _rowStride,
                                  int _columnStride)

Description copied from class: ObjectMatrix2D

Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell. More specifically, the view has this.rows()/rowStride rows and this.columns()/columnStride columns holding cells this.get(i*rowStride,j*columnStride) for all i = 0..rows()/rowStride - 1, j = 0..columns()/columnStride - 1. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Overrides:

viewStrides in class ObjectMatrix2D

Parameters:

_rowStride - the row step factor.

_columnStride - the column step factor.

Returns:

a new view.