Parallel Colt 0.7.2

cern.colt.matrix
Class AbstractMatrix3D

java.lang.Object
  extended by cern.colt.PersistentObject
      extended by cern.colt.matrix.AbstractMatrix
          extended by cern.colt.matrix.AbstractMatrix3D
All Implemented Interfaces:
Serializable, Cloneable
Direct Known Subclasses:
DComplexMatrix3D, DoubleMatrix3D, FComplexMatrix3D, FloatMatrix3D, IntMatrix3D, 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.

Version:
1.0, 09/24/99
Author:
wolfgang.hoschek@cern.ch
See Also:
Serialized Form

Field Summary
 
Fields inherited from class cern.colt.PersistentObject
serialVersionUID
 
Method Summary
 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.
 int size()
          Returns the number of cells which is slices()*rows()*columns().
 int slices()
          Returns the number of slices.
 int sliceStride()
          Returns the slice stride.
 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:
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:
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 int 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 String toStringShort()
Returns a string representation of the receiver's shape.


Parallel Colt 0.7.2

Jump to the Parallel Colt Homepage