cern.colt.matrix.tobject.impl

Class WrapperObjectMatrix1D

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.AbstractMatrix

cern.colt.matrix.AbstractMatrix1D

cern.colt.matrix.tobject.ObjectMatrix1D

cern.colt.matrix.tobject.impl.WrapperObjectMatrix1D

All Implemented Interfaces:

Serializable, Cloneable

public class WrapperObjectMatrix1D
extends ObjectMatrix1D

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

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
WrapperObjectMatrix1D(ObjectMatrix1D newContent)

Method Summary

Methods

Modifier and Type	Method and Description
Object	elements() Returns the elements of this matrix.
Object	getQuick(int index) Returns the matrix cell value at coordinate index.
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.
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	viewStrides(int _stride) 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.ObjectMatrix1D

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

Methods inherited from class cern.colt.matrix.AbstractMatrix1D

checkSize, index, 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

WrapperObjectMatrix1D

public WrapperObjectMatrix1D(ObjectMatrix1D newContent)

Method Detail

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.

elements

public Object elements()

Description copied from class: ObjectMatrix1D

Returns the elements of this matrix.

Specified by:

elements in class ObjectMatrix1D

Returns:

the elements

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.

viewFlip

public ObjectMatrix1D viewFlip()

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

Overrides:

viewFlip in class ObjectMatrix1D

Returns:

a new flip view.

viewPart

public ObjectMatrix1D viewPart(int index,
                      int width)

Constructs and returns a new sub-range view that is a width sub matrix starting at index. 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 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.

Overrides:

viewPart in class ObjectMatrix1D

Parameters:

index - The index of the first cell.

width - The width of the range.

Returns:

the new view.

Throws:

IndexOutOfBoundsException - if index<0 || width<0 || index+width>size().

viewSelection

public ObjectMatrix1D viewSelection(int[] indexes)

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

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.

Overrides:

viewSelection in class ObjectMatrix1D

Parameters:

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.

Returns:

the new view.

Throws:

IndexOutOfBoundsException - if !(0 <= indexes[i] < size()) for any i=0..indexes.length()-1.

viewStrides

public ObjectMatrix1D viewStrides(int _stride)

Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell. More specifically, the view has size this.size()/stride holding cells this.get(i*stride) for all i = 0..size()/stride - 1.

Overrides:

viewStrides in class ObjectMatrix1D

Parameters:

_stride - the step factor.

Returns:

the new view.

Throws:

IndexOutOfBoundsException - if stride <= 0.