cern.colt.matrix

Class AbstractMatrix3D

java.lang.Object

cern.colt.PersistentObject

cern.colt.matrix.AbstractMatrix

cern.colt.matrix.AbstractMatrix3D

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

DComplexMatrix3D, DoubleMatrix3D, FComplexMatrix3D, FloatMatrix3D, IntMatrix3D, LongMatrix3D, ObjectMatrix3D

public abstract class AbstractMatrix3D
extends AbstractMatrix

Abstract base class for 3-d matrices holding objects or primitive data types such as int, double, etc. First see the package summary and javadoc tree view to get the broad picture.

Note that this implementation is not synchronized.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	checkShape(AbstractMatrix3D B) Sanity check for operations requiring two matrices with the same number of slices, rows and columns.
void	checkShape(AbstractMatrix3D B, AbstractMatrix3D C) Sanity check for operations requiring matrices with the same number of slices, rows and columns.
int	columns() Returns the number of columns.
int	columnStride() Returns the column stride.
long	index(int slice, int row, int column) Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
int	rows() Returns the number of rows.
int	rowStride() Returns the row stride.
long	size() Returns the number of cells which is slices()*rows()*columns().
int	slices() Returns the number of slices.
int	sliceStride() Returns the slice stride.
java.lang.String	toStringShort() Returns a string representation of the receiver's shape.

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

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

checkShape

public void checkShape(AbstractMatrix3D B)

Sanity check for operations requiring two matrices with the same number of slices, rows and columns.

Throws:

java.lang.IllegalArgumentException - if slices() != B.slices() || rows() != B.rows() || columns() != B.columns() .

checkShape

public void checkShape(AbstractMatrix3D B,
                       AbstractMatrix3D C)

Sanity check for operations requiring matrices with the same number of slices, rows and columns.

Throws:

java.lang.IllegalArgumentException - if slices() != B.slices() || rows() != B.rows() || columns() != B.columns() || slices() != C.slices() || rows() != C.rows() || columns() != C.columns() .

columns

public int columns()

Returns the number of columns.

columnStride

public int columnStride()

Returns the column stride.

index

public long index(int slice,
                  int row,
                  int column)

Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.

Parameters:

slice - the index of the slice-coordinate.

row - the index of the row-coordinate.

column - the index of the third-coordinate.

rows

public int rows()

Returns the number of rows.

rowStride

public int rowStride()

Returns the row stride.

size

public long size()

Returns the number of cells which is slices()*rows()*columns().

Specified by:

size in class AbstractMatrix

slices

public int slices()

Returns the number of slices.

sliceStride

public int sliceStride()

Returns the slice stride.

toStringShort

public java.lang.String toStringShort()

Returns a string representation of the receiver's shape.