cern.colt.matrix.tfcomplex.impl
Class DenseLargeFComplexMatrix3D

java.lang.Object
  cern.colt.PersistentObject
      cern.colt.matrix.AbstractMatrix
          cern.colt.matrix.AbstractMatrix3D
              cern.colt.matrix.tfcomplex.FComplexMatrix3D
                  cern.colt.matrix.tfcomplex.impl.WrapperFComplexMatrix3D
                      cern.colt.matrix.tfcomplex.impl.DenseLargeFComplexMatrix3D

All Implemented Interfaces:

Serializable, Cloneable

public class DenseLargeFComplexMatrix3D
extends WrapperFComplexMatrix3D

Dense 3-d matrix holding complex elements.
Implementation:

This data structure allows to store more than 2^31 elements. Internally holds one three-dimensional array, elements[slices][rows][2*columns]. Complex data is represented by 2 float values in sequence, i.e. elements[slice][row][2*column] constitute the real part and elements[slice][row][2*column+1] constitute the imaginary part. Note that this implementation is not synchronized.

Author:

Piotr Wendykier (piotr.wendykier@gmail.com)

See Also:

Serialized Form

Constructor Summary

DenseLargeFComplexMatrix3D(int slices, int rows, int columns)

Method Summary

float[][][]	elements() Returns the elements of this matrix.
void	fft2Slices() Computes the 2D discrete Fourier transform (DFT) of each slice of this matrix.
void	fft3() Computes the 3D discrete Fourier transform (DFT) of this matrix.
float[]	getQuick(int slice, int row, int column) Returns the matrix cell value at coordinate [slice,row,column].
void	ifft2Slices(boolean scale) Computes the 2D inverse of the discrete Fourier transform (IDFT) of each slice of this matrix.
void	ifft3(boolean scale) Computes the 3D inverse of the discrete Fourier transform (IDFT) of this matrix.
FComplexMatrix3D	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.
void	setQuick(int slice, int row, int column, float[] value) Sets the matrix cell at coordinate [slice,row,column] to the specified value.
void	setQuick(int slice, int row, int column, float re, float im) Sets the matrix cell at coordinate [slice,row,column] to the specified value.

Methods inherited from class cern.colt.matrix.tfcomplex.impl.WrapperFComplexMatrix3D

getImaginaryPart, getRealPart, like2D, vectorize, viewColumn, viewColumnFlip, viewDice, viewPart, viewRow, viewRowFlip, viewSelection, viewSlice, viewSliceFlip, viewStrides

Methods inherited from class cern.colt.matrix.tfcomplex.FComplexMatrix3D

aggregate, aggregate, assign, assign, assign, assign, assign, assign, assign, assign, assign, assignImaginary, assignReal, cardinality, copy, equals, equals, get, getNonZeros, like, set, set, toArray, toString, toString, viewSelection, zSum

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

DenseLargeFComplexMatrix3D

public DenseLargeFComplexMatrix3D(int slices,
                                  int rows,
                                  int columns)

Method Detail

getQuick

public float[] getQuick(int slice,
                        int row,
                        int column)

Description copied from class: FComplexMatrix3D

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

Overrides:

getQuick in class WrapperFComplexMatrix3D

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.

setQuick

public void setQuick(int slice,
                     int row,
                     int column,
                     float[] value)

Description copied from class: FComplexMatrix3D

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

Overrides:

setQuick in class WrapperFComplexMatrix3D

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.

setQuick

public void setQuick(int slice,
                     int row,
                     int column,
                     float re,
                     float im)

Description copied from class: FComplexMatrix3D

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

Overrides:

setQuick in class WrapperFComplexMatrix3D

Parameters:

slice - the index of the slice-coordinate.

row - the index of the row-coordinate.

column - the index of the column-coordinate.

re - the real part of the value to be filled into the specified cell.

im - the imaginary part of the value to be filled into the specified cell.

fft2Slices

public void fft2Slices()

Computes the 2D discrete Fourier transform (DFT) of each slice of this matrix.

Overrides:

fft2Slices in class WrapperFComplexMatrix3D

fft3

public void fft3()

Computes the 3D discrete Fourier transform (DFT) of this matrix.

Overrides:

fft3 in class WrapperFComplexMatrix3D

ifft2Slices

public void ifft2Slices(boolean scale)

Computes the 2D inverse of the discrete Fourier transform (IDFT) of each slice of this matrix.

Overrides:

ifft2Slices in class WrapperFComplexMatrix3D

Parameters:

scale - if true then scaling is performed

ifft3

public void ifft3(boolean scale)

Computes the 3D inverse of the discrete Fourier transform (IDFT) of this matrix.

Overrides:

ifft3 in class WrapperFComplexMatrix3D

Parameters:

scale - if true then scaling is performed

elements

public float[][][] elements()

Description copied from class: FComplexMatrix3D

Returns the elements of this matrix.

Overrides:

elements in class WrapperFComplexMatrix3D

Returns:

the elements

like

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

Description copied from class: FComplexMatrix3D

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 DenseComplexMatrix3D the new matrix must also be of type DenseComplexMatrix3D. In general, the new matrix should have internal parametrization as similar as possible.

Overrides:

like in class WrapperFComplexMatrix3D

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.