cern.colt.matrix.tobject.impl
Class WrapperObjectMatrix3D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix3D
              cern.colt.matrix.tobject.ObjectMatrix3D
                  cern.colt.matrix.tobject.impl.WrapperObjectMatrix3D

All Implemented Interfaces:

Serializable, Cloneable

Direct Known Subclasses:

DenseLargeObjectMatrix3D

public class WrapperObjectMatrix3D
extends ObjectMatrix3D

3-d matrix holding Object 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

WrapperObjectMatrix3D(ObjectMatrix3D newContent)

Method Summary

Object	elements() Returns the elements of this matrix.
Object	getQuick(int slice, int row, int column) Returns the matrix cell value at coordinate [slice,row,column].
ObjectMatrix3D	like(int slices, int rows, int columns) Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of slices, rows and columns.
ObjectMatrix2D	like2D(int rows, int columns) Construct and returns a new 2-d matrix of the corresponding dynamic type, sharing the same cells.
void	setQuick(int slice, int row, int column, Object value) Sets the matrix cell at coordinate [slice,row,column] to the specified value.
ObjectMatrix1D	vectorize() Returns a vector obtained by stacking the columns of the matrix on top of one another.
ObjectMatrix2D	viewColumn(int column) Constructs and returns a new 2-dimensional slice view representing the slices and rows of the given column.
ObjectMatrix3D	viewColumnFlip() Constructs and returns a new flip view along the column axis.
ObjectMatrix3D	viewDice(int axis0, int axis1, int axis2) Constructs and returns a new dice view; Swaps dimensions (axes); Example: 3 x 4 x 5 matrix --> 4 x 3 x 5 matrix.
ObjectMatrix3D	viewPart(int slice, int row, int column, int depth, int height, int width) Constructs and returns a new sub-range view that is a depth x height x width sub matrix starting at [slice,row,column]; Equivalent to view().part(slice,row,column,depth,height,width); Provided for convenience only.
ObjectMatrix2D	viewRow(int row) Constructs and returns a new 2-dimensional slice view representing the slices and columns of the given row.
ObjectMatrix3D	viewRowFlip() Constructs and returns a new flip view along the row axis.
ObjectMatrix3D	viewSelection(int[] sliceIndexes, int[] rowIndexes, int[] columnIndexes) Constructs and returns a new selection view that is a matrix holding the indicated cells.
ObjectMatrix2D	viewSlice(int slice) Constructs and returns a new 2-dimensional slice view representing the rows and columns of the given slice.
ObjectMatrix3D	viewSliceFlip() Constructs and returns a new flip view along the slice axis.
ObjectMatrix3D	viewStrides(int _sliceStride, 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.ObjectMatrix3D

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

Methods inherited from class cern.colt.matrix.AbstractMatrix3D

checkShape, checkShape, columns, columnStride, index, rows, rowStride, size, slices, sliceStride, 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

WrapperObjectMatrix3D

public WrapperObjectMatrix3D(ObjectMatrix3D newContent)

Method Detail

elements

public Object elements()

Description copied from class: ObjectMatrix3D

Returns the elements of this matrix.

Specified by:

elements in class ObjectMatrix3D

Returns:

the elements

getQuick

public Object getQuick(int slice,
                       int row,
                       int column)

Description copied from class: ObjectMatrix3D

Returns the matrix cell value at coordinate [slice,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): slice<0 || slice>=slices() || row<0 || row>=rows() || column<0 || column>=column().

Specified by:

getQuick in class ObjectMatrix3D

Parameters:

slice - the index of the slice-coordinate.

row - the index of the row-coordinate.

column - the index of the column-coordinate.

Returns:

the value at the specified coordinate.

like

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

Description copied from class: ObjectMatrix3D

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

Specified by:

like in class ObjectMatrix3D

Parameters:

slices - the number of slices the matrix shall have.

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.

setQuick

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

Description copied from class: ObjectMatrix3D

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

Specified by:

setQuick in class ObjectMatrix3D

Parameters:

slice - the index of the slice-coordinate.

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: ObjectMatrix3D

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

Specified by:

vectorize in class ObjectMatrix3D

Returns:

a vector of columns of this matrix.

viewColumn

public ObjectMatrix2D viewColumn(int column)

Description copied from class: ObjectMatrix3D

Constructs and returns a new 2-dimensional slice view representing the slices and 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 ( view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.

Overrides:

viewColumn in class ObjectMatrix3D

Parameters:

column - the index of the column to fix.

Returns:

a new 2-dimensional slice view.

See Also:

ObjectMatrix3D.viewSlice(int), ObjectMatrix3D.viewRow(int)

viewColumnFlip

public ObjectMatrix3D viewColumnFlip()

Description copied from class: ObjectMatrix3D

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.

Overrides:

viewColumnFlip in class ObjectMatrix3D

Returns:

a new flip view.

See Also:

ObjectMatrix3D.viewSliceFlip(), ObjectMatrix3D.viewRowFlip()

viewSlice

public ObjectMatrix2D viewSlice(int slice)

Description copied from class: ObjectMatrix3D

Constructs and returns a new 2-dimensional slice view representing the rows and columns of the given slice. 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 ( view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.

Overrides:

viewSlice in class ObjectMatrix3D

Parameters:

slice - the index of the slice to fix.

Returns:

a new 2-dimensional slice view.

See Also:

ObjectMatrix3D.viewRow(int), ObjectMatrix3D.viewColumn(int)

viewSliceFlip

public ObjectMatrix3D viewSliceFlip()

Description copied from class: ObjectMatrix3D

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

Overrides:

viewSliceFlip in class ObjectMatrix3D

Returns:

a new flip view.

See Also:

ObjectMatrix3D.viewRowFlip(), ObjectMatrix3D.viewColumnFlip()

viewDice

public ObjectMatrix3D viewDice(int axis0,
                               int axis1,
                               int axis2)

Description copied from class: ObjectMatrix3D

Constructs and returns a new dice view; Swaps dimensions (axes); Example: 3 x 4 x 5 matrix --> 4 x 3 x 5 matrix. The view has dimensions exchanged; what used to be one axis is now another, in all desired permutations. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Overrides:

viewDice in class ObjectMatrix3D

Parameters:

axis0 - the axis that shall become axis 0 (legal values 0..2).

axis1 - the axis that shall become axis 1 (legal values 0..2).

axis2 - the axis that shall become axis 2 (legal values 0..2).

Returns:

a new dice view.

viewPart

public ObjectMatrix3D viewPart(int slice,
                               int row,
                               int column,
                               int depth,
                               int height,
                               int width)

Description copied from class: ObjectMatrix3D

Constructs and returns a new sub-range view that is a depth x height x width sub matrix starting at [slice,row,column]; Equivalent to view().part(slice,row,column,depth,height,width); Provided for convenience only. The returned view is backed by this matrix, so changes in the returned view are reflected in this matrix, and vice-versa.

Overrides:

viewPart in class ObjectMatrix3D

Parameters:

slice - The index of the slice-coordinate.

row - The index of the row-coordinate.

column - The index of the column-coordinate.

depth - The depth of the box.

height - The height of the box.

width - The width of the box.

Returns:

the new view.

viewRow

public ObjectMatrix2D viewRow(int row)

Description copied from class: ObjectMatrix3D

Constructs and returns a new 2-dimensional slice view representing the slices and 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 ( view().part(...)), then apply this method to the sub-range view. To obtain 1-dimensional views, apply this method, then apply another slice view (methods viewColumn, viewRow) on the intermediate 2-dimensional view. To obtain 1-dimensional views on subranges, apply both steps.

Overrides:

viewRow in class ObjectMatrix3D

Parameters:

row - the index of the row to fix.

Returns:

a new 2-dimensional slice view.

See Also:

ObjectMatrix3D.viewSlice(int), ObjectMatrix3D.viewColumn(int)

viewRowFlip

public ObjectMatrix3D viewRowFlip()

Description copied from class: ObjectMatrix3D

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.

Overrides:

viewRowFlip in class ObjectMatrix3D

Returns:

a new flip view.

See Also:

ObjectMatrix3D.viewSliceFlip(), ObjectMatrix3D.viewColumnFlip()

viewSelection

public ObjectMatrix3D viewSelection(int[] sliceIndexes,
                                    int[] rowIndexes,
                                    int[] columnIndexes)

Description copied from class: ObjectMatrix3D

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

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.

Overrides:

viewSelection in class ObjectMatrix3D

Parameters:

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

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 ObjectMatrix3D viewStrides(int _sliceStride,
                                  int _rowStride,
                                  int _columnStride)

Description copied from class: ObjectMatrix3D

Constructs and returns a new stride view which is a sub matrix consisting of every i-th cell. More specifically, the view has this.slices()/sliceStride slices and this.rows()/rowStride rows and this.columns()/columnStride columns holding cells this.get(k*sliceStride,i*rowStride,j*columnStride) for all k = 0..slices()/sliceStride - 1, 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 ObjectMatrix3D

Parameters:

_sliceStride - the slice step factor.

_rowStride - the row step factor.

_columnStride - the column step factor.

Returns:

a new view.

like2D

public ObjectMatrix2D like2D(int rows,
                             int columns)

Description copied from class: ObjectMatrix3D

Construct and returns a new 2-d matrix of the corresponding dynamic type, sharing the same cells. For example, if the receiver is an instance of type DenseDoubleMatrix3D the new matrix must also be of type DenseDoubleMatrix2D, if the receiver is an instance of type SparseDoubleMatrix3D the new matrix must also be of type SparseDoubleMatrix2D, etc.

Specified by:

like2D in class ObjectMatrix3D

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.