SparseDComplexMatrix3D
cern.colt.matrix.tdcomplex.impl

Class SparseDComplexMatrix3D

    • Constructor Detail

      • SparseDComplexMatrix3D

        public SparseDComplexMatrix3D(double[][][] values)
        Constructs a matrix with a copy of the given values. values is required to have the form values[slice][row][column] and have exactly the same number of rows in 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:
        IllegalArgumentException - if for any 1 <= slice < values.length: values[slice].length != values[slice-1].length .
        IllegalArgumentException - if for any 1 <= row < values[0].length: values[slice][row].length != values[slice][row-1].length .
      • SparseDComplexMatrix3D

        public SparseDComplexMatrix3D(int slices,                      int rows,                      int columns)
        Constructs a matrix with a given number of slices, rows and columns and default memory usage.
        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:
        IllegalArgumentException - if (double)slices*columns*rows > Integer.MAX_VALUE.
        IllegalArgumentException - if slices<0 || rows<0 || columns<0.
    • Method Detail

      • assign

        public DComplexMatrix3D assign(double[] value)
        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:
        value - the values to be filled into the cells.
        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.
      • 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.
      • 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.
      • 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[] 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.
      • 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.
      • 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.

SCaVis 2.1 © jWork.ORG