Documentation of 'cern.colt.matrix.tdcomplex.impl.DenseDComplexMatrix3D' Java class
DenseDComplexMatrix3D
Skip navigation links
cern.colt.matrix.tdcomplex.impl

Class DenseDComplexMatrix3D

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable

    public class DenseDComplexMatrix3D
extends DComplexMatrix3D
    Dense 3-d matrix holding complex elements.

    Internally holds one single contigous one-dimensional array, addressed in (in decreasing order of significance): slice major, row major, column major. Complex data is represented by 2 double values in sequence, i.e. elements[idx] constitute the real part and elements[idx+1] constitute the imaginary part, where idx = index(0,0,0) + slice * sliceStride + row * rowStride + column * columnStride. Note that this implementation is not synchronized.

    Applications demanding utmost speed can exploit knowledge about the internal addressing. Setting/getting values in a loop slice-by-slice, row-by-row, column-by-column is quicker than, for example, column-by-column, row-by-row, slice-by-slice. Thus 

     for (int slice = 0; slice < slices; slice++) {
     for (int row = 0; row < rows; row++) {
         for (int column = 0; column < columns; column++) {
             matrix.setQuick(slice, row, column, someValue);
         }
     }
 }
    is quicker than 
     for (int column = 0; column < columns; column++) {
     for (int row = 0; row < rows; row++) {
         for (int slice = 0; slice < slices; slice++) {
             matrix.setQuick(slice, row, column, someValue);
         }
     }
 }
    See Also:
    Serialized Form

    • Constructor Detail

      • DenseDComplexMatrix3D

        public DenseDComplexMatrix3D(double[][][] values)
        Constructs a matrix with a copy of the given values. * values is required to have the form re = values[slice][row][2*column], im = values[slice][row][2*column+1] and have exactly the same number of rows in every slice and exactly the same number of columns in in every row.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Parameters:
        values - The values to be filled into the new matrix.
        Throws:
        java.lang.IllegalArgumentException - if for any 1 <= slice < values.length: values[slice].length != values[slice-1].length .
        java.lang.IllegalArgumentException - if for any 1 <= row < values[0].length: values[slice][row].length != values[slice][row-1].length .

      • DenseDComplexMatrix3D

        public DenseDComplexMatrix3D(DoubleMatrix3D realPart)
        Constructs a matrix with the same size as realPart matrix and fills the real part of this matrix with elements of realPart.
        Parameters:
        realPart - a real matrix whose elements become a real part of this matrix
        Throws:
        java.lang.IllegalArgumentException - if (double)slices*columns*rows > Integer.MAX_VALUE.
        java.lang.IllegalArgumentException - if slices<0 || rows<0 || columns<0.

      • DenseDComplexMatrix3D

        public DenseDComplexMatrix3D(int slices,
                             int rows,
                             int columns)
        Constructs a matrix with a given number of slices, rows and columns. All entries are initially 0.
        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.
        Throws:
        java.lang.IllegalArgumentException - if (double)slices*columns*rows > Integer.MAX_VALUE.
        java.lang.IllegalArgumentException - if slices<0 || rows<0 || columns<0.

      • DenseDComplexMatrix3D

        public DenseDComplexMatrix3D(int slices,
                             int rows,
                             int columns,
                             double[] elements,
                             int sliceZero,
                             int rowZero,
                             int columnZero,
                             int sliceStride,
                             int rowStride,
                             int columnStride,
                             boolean isNoView)
        Constructs a matrix with the given parameters.
        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.
        elements - the cells.
        sliceZero - the position of the first element.
        rowZero - the position of the first element.
        columnZero - the position of the first element.
        sliceStride - the number of elements between two slices, i.e. index(k+1,i,j)-index(k,i,j).
        rowStride - the number of elements between two rows, i.e. index(k,i+1,j)-index(k,i,j).
        columnStride - the number of elements between two columns, i.e. index(k,i,j+1)-index(k,i,j).
        isNoView - if false then the view is constructed
        Throws:
        java.lang.IllegalArgumentException - if (double)slices*columns*rows > Integer.MAX_VALUE.
        java.lang.IllegalArgumentException - if slices<0 || rows<0 || columns<0.

    • Method Detail

      • assign

        public DComplexMatrix3D assign(DComplexMatrix3D source)
        Description copied from class: DComplexMatrix3D
        Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of slices, rows and columns. If both matrices share the same cells (as is the case if they are views derived from the same matrix) and intersect in an ambiguous way, then replaces as if using an intermediate auxiliary deep copy of other.
        Overrides:
        assign in class DComplexMatrix3D
        Parameters:
        source - the source matrix to copy from (may be identical to the receiver).
        Returns:
        this (for convenience only).

      • assign

        public DComplexMatrix3D assign(double re,
                               double im)
        Description copied from class: DComplexMatrix3D
        Sets all cells to the state specified by re and im.
        Overrides:
        assign in class DComplexMatrix3D
        Parameters:
        re - the real part of the value to be filled into the cells.
        im - the imagiary part of the value to be filled into the cells.
        Returns:
        this (for convenience only).

      • assign

        public DComplexMatrix3D assign(double[] values)
        Description copied from class: DComplexMatrix3D
        Sets all cells to the state specified by values. values is required to have the form re = values[slice*silceStride+row*rowStride+2*column], im = values[slice*silceStride+row*rowStride+2*column+1] and have exactly the same number of slices, rows and columns as the receiver.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Overrides:
        assign in class DComplexMatrix3D
        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).

      • assign

        public DComplexMatrix3D assign(double[][][] values)
        Description copied from class: DComplexMatrix3D
        Sets all cells to the state specified by values. values is required to have the form re = values[slice][row][2*column], im = values[slice][row][2*column+1] and have exactly the same number of slices, rows and columns as the receiver.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Overrides:
        assign in class DComplexMatrix3D
        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).

      • assignImaginary

        public DComplexMatrix3D assignImaginary(DoubleMatrix3D other)
        Description copied from class: DComplexMatrix3D
        Replaces imaginary part of the receiver with the values of another real matrix. The real part of the receiver remains unchanged. Both matrices must have the same size.
        Overrides:
        assignImaginary in class DComplexMatrix3D
        Parameters:
        other - the source matrix to copy from
        Returns:
        this (for convenience only).

      • assignReal

        public DComplexMatrix3D assignReal(DoubleMatrix3D other)
        Description copied from class: DComplexMatrix3D
        Replaces real part of the receiver with the values of another real matrix. The imaginary part of the receiver remains unchanged. Both matrices must have the same size.
        Overrides:
        assignReal in class DComplexMatrix3D
        Parameters:
        other - the source matrix to copy from
        Returns:
        this (for convenience only).

      • cardinality

        public int cardinality()
        Description copied from class: DComplexMatrix3D
        Returns the number of cells having non-zero values; ignores tolerance.
        Overrides:
        cardinality in class DComplexMatrix3D
        Returns:
        the number of cells having non-zero values.

      • fft2Slices

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

      • fft3

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

      • getNonZeros

        public void getNonZeros(IntArrayList sliceList,
                        IntArrayList rowList,
                        IntArrayList columnList,
                        java.util.ArrayList<double[]> valueList)
        Description copied from class: DComplexMatrix3D
        Fills the coordinates and values of cells having non-zero values into the specified lists. Fills into the lists, starting at index 0. After this call returns the specified lists all have a new size, the number of non-zero values.

        In general, fill order is unspecified. This implementation fill like: for (slice = 0..slices-1) for (row = 0..rows-1) for (column = 0..colums-1) do ... . However, subclasses are free to us any other order, even an order that may change over time as cell values are changed. (Of course, result lists indexes are guaranteed to correspond to the same cell).

        Overrides:
        getNonZeros in class DComplexMatrix3D
        Parameters:
        sliceList - the list to be filled with slice indexes, can have any size.
        rowList - the list to be filled with row indexes, can have any size.
        columnList - the list to be filled with column indexes, can have any size.
        valueList - the list to be filled with values, can have any size.

      • getQuick

        public double[] getQuick(int slice,
                         int row,
                         int column)
        Description copied from class: DComplexMatrix3D
        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 DComplexMatrix3D
        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.

      • ifft2Slices

        public void ifft2Slices(boolean scale)
        Computes the 2D inverse of the discrete Fourier transform (IDFT) of each slice of this matrix.
        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.
        Parameters:
        scale - if true then scaling is performed

      • like

        public DComplexMatrix3D like(int slices,
                             int rows,
                             int columns)
        Description copied from class: DComplexMatrix3D
        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.
        Specified by:
        like in class DComplexMatrix3D
        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.

      • like2D

        public DComplexMatrix2D like2D(int rows,
                               int columns)
        Description copied from class: DComplexMatrix3D
        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 DenseDComplexMatrix3D the new matrix must also be of type DenseDComplexMatrix2D, if the receiver is an instance of type SparseDComplexMatrix3D the new matrix must also be of type SparseDComplexMatrix2D, etc.
        Specified by:
        like2D in class DComplexMatrix3D
        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.

      • setQuick

        public void setQuick(int slice,
                     int row,
                     int column,
                     double re,
                     double im)
        Description copied from class: DComplexMatrix3D
        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 DComplexMatrix3D
        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.

      • setQuick

        public void setQuick(int slice,
                     int row,
                     int column,
                     double[] value)
        Description copied from class: DComplexMatrix3D
        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 DComplexMatrix3D
        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.

      • toArray

        public double[][][] toArray()
        Description copied from class: DComplexMatrix3D
        Constructs and returns a 3-dimensional array containing the cell values. The returned array values has the form values[slice][row][column] and has the same number of slices, rows and columns as the receiver.

        The values are copied. So subsequent changes in values are not reflected in the matrix, and vice-versa.

        Overrides:
        toArray in class DComplexMatrix3D
        Returns:
        an array filled with the values of the cells.

      • vectorize

        public DComplexMatrix1D vectorize()
        Description copied from class: DComplexMatrix3D
        Returns a vector obtained by stacking the columns of each slice of the matrix on top of one another.
        Specified by:
        vectorize in class DComplexMatrix3D
        Returns:
        a vector obtained by stacking the columns of each slice of the matrix on top of one another.

      • zSum

        public double[] zSum()
        Description copied from class: DComplexMatrix3D
        Returns the sum of all cells; Sum( x[i,j,k] ).
        Overrides:
        zSum in class DComplexMatrix3D
        Returns:
        the sum.

      • index

        public long index(int slice,
                  int row,
                  int column)
        Description copied from class: AbstractMatrix3D
        Returns the position of the given coordinate within the (virtual or non-virtual) internal 1-dimensional array.
        Overrides:
        index in class AbstractMatrix3D
        Parameters:
        slice - the index of the slice-coordinate.
        row - the index of the row-coordinate.
        column - the index of the third-coordinate.
Skip navigation links

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.