DenseColumnDComplexMatrix2D
cern.colt.matrix.tdcomplex.impl

Class DenseColumnDComplexMatrix2D

  • All Implemented Interfaces:
    Serializable, Cloneable


    public class DenseColumnDComplexMatrix2Dextends DComplexMatrix2D
    Dense 2-d matrix holding complex elements. Implementation:

    Internally holds one single contigous one-dimensional array, addressed in row 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) + row * rowStride + column * columnStride. Note that this implementation is not synchronized.

    Cells are internally addressed in row-major. Applications demanding utmost speed can exploit this fact. Setting/getting values in a loop row-by-row is quicker than column-by-column. Thus

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

      • DenseColumnDComplexMatrix2D

        public DenseColumnDComplexMatrix2D(double[][] values)
        Constructs a matrix with a copy of the given values. values is required to have the form re = values[row][2*column]; im = values[row][2*column+1] and have exactly the same number of rows and columns as the receiver. Due to the fact that complex data is represented by 2 double values in sequence: the real and imaginary parts, the new matrix will be of the size values.length by values[0].length / 2.

        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 <= row < values.length: values[row].length != values[row-1].length .
      • DenseColumnDComplexMatrix2D

        public DenseColumnDComplexMatrix2D(DoubleMatrix2D realPart)
        Constructs a complex 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:
        IllegalArgumentException - if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE .
      • DenseColumnDComplexMatrix2D

        public DenseColumnDComplexMatrix2D(int rows,                           int columns)
        Constructs a matrix with a given number of rows and columns. All entries are initially 0.
        Parameters:
        rows - the number of rows the matrix shall have.
        columns - the number of columns the matrix shall have.
        Throws:
        IllegalArgumentException - if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE .
      • DenseColumnDComplexMatrix2D

        public DenseColumnDComplexMatrix2D(int rows,                           int columns,                           double[] elements,                           int rowZero,                           int columnZero,                           int rowStride,                           int columnStride,                           boolean isNoView)
        Constructs a matrix with the given parameters.
        Parameters:
        rows - the number of rows the matrix shall have.
        columns - the number of columns the matrix shall have.
        elements - the cells.
        rowZero - the position of the first element.
        columnZero - the position of the first element.
        rowStride - the number of elements between two rows, i.e. index(i+1,j)-index(i,j).
        columnStride - the number of elements between two columns, i.e. index(i,j+1)-index(i,j).
        isNoView - if false then the view is constructed
        Throws:
        IllegalArgumentException - if rows<0 || columns<0 || (double)columns*rows > Integer.MAX_VALUE or flip's are illegal.
    • Method Detail

      • assign

        public DComplexMatrix2D assign(DComplexMatrix2D source)
        Description copied from class: DComplexMatrix2D
        Replaces all cell values of the receiver with the values of another matrix. Both matrices must have the same number of 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 DComplexMatrix2D
        Parameters:
        source - the source matrix to copy from (may be identical to the receiver).
        Returns:
        this (for convenience only).
      • assign

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

        public DComplexMatrix2D assign(double[] values)
        Description copied from class: DComplexMatrix2D
        Sets all cells to the state specified by values. values is required to have the form re = values[row*rowStride+column*columnStride]; im = values[row*rowStride+column*columnStride+1] and have exactly the same number of 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 DComplexMatrix2D
        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).
      • assign

        public DComplexMatrix2D assign(double[][] values)
        Description copied from class: DComplexMatrix2D
        Sets all cells to the state specified by values. values is required to have the form re = values[row][2*column]; im = values[row][2*column+1] and have exactly the same number of 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 DComplexMatrix2D
        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).
      • assign

        public DComplexMatrix2D assign(float[] values)
        Description copied from class: DComplexMatrix2D
        Sets all cells to the state specified by values. values is required to have the form re = values[row*rowStride+column*columnStride]; im = values[row*rowStride+column*columnStride+1] and have exactly the same number of 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 DComplexMatrix2D
        Parameters:
        values - the values to be filled into the cells.
        Returns:
        this (for convenience only).
      • assignImaginary

        public DComplexMatrix2D assignImaginary(DoubleMatrix2D other)
        Description copied from class: DComplexMatrix2D
        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 DComplexMatrix2D
        Parameters:
        other - the source matrix to copy from
        Returns:
        this (for convenience only).
      • assignReal

        public DComplexMatrix2D assignReal(DoubleMatrix2D other)
        Description copied from class: DComplexMatrix2D
        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 DComplexMatrix2D
        Parameters:
        other - the source matrix to copy from
        Returns:
        this (for convenience only).
      • cardinality

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

        public void fft2()
        Computes the 2D discrete Fourier transform (DFT) of this matrix.
      • fftColumns

        public void fftColumns()
        Computes the discrete Fourier transform (DFT) of each column of this matrix.
      • fftRows

        public void fftRows()
        Computes the discrete Fourier transform (DFT) of each row of this matrix.
      • forEachNonZero

        public DComplexMatrix2D forEachNonZero(IntIntDComplexFunction function)
        Description copied from class: DComplexMatrix2D
        Assigns the result of a function to each non-zero cell. Use this method for fast special-purpose iteration. If you want to modify another matrix instead of this (i.e. work in read-only mode), simply return the input value unchanged. Parameters to function are as follows: first==row, second==column, third==nonZeroValue.
        Overrides:
        forEachNonZero in class DComplexMatrix2D
        Parameters:
        function - a function object taking as argument the current non-zero cell's row, column and value.
        Returns:
        this (for convenience only).
      • getConjugateTranspose

        public DComplexMatrix2D getConjugateTranspose()
        Description copied from class: DComplexMatrix2D
        Returns a new matrix that is a complex conjugate of this matrix. If unconjugated complex transposition is needed, one should use viewDice() method. This method creates a new object (not a view), so changes in the returned matrix are NOT reflected in this matrix.
        Overrides:
        getConjugateTranspose in class DComplexMatrix2D
        Returns:
        a complex conjugate matrix
      • getNonZeros

        public void getNonZeros(IntArrayList rowList,               IntArrayList columnList,               ArrayList<double[]> valueList)
        Description copied from class: DComplexMatrix2D
        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 fills like for (row = 0..rows-1) for (column = 0..columns-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 DComplexMatrix2D
        Parameters:
        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 row,                int column)
        Description copied from class: DComplexMatrix2D
        Returns the matrix cell value at coordinate [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): 0 <= column < columns() && 0 <= row < rows().

        Specified by:
        getQuick in class DComplexMatrix2D
        Parameters:
        row - the index of the row-coordinate.
        column - the index of the column-coordinate.
        Returns:
        the value at the specified coordinate.
      • ifft2

        public void ifft2(boolean scale)
        Computes the 2D inverse of the discrete Fourier transform (IDFT) of this matrix.
        Parameters:
        scale - if true then scaling is performed
      • ifftColumns

        public void ifftColumns(boolean scale)
        Computes the inverse of the discrete Fourier transform (IDFT) of each column of this matrix.
        Parameters:
        scale - if true then scaling is performed
      • ifftRows

        public void ifftRows(boolean scale)
        Computes the inverse of the discrete Fourier transform (IDFT) of each row of this matrix.
        Parameters:
        scale - if true then scaling is performed
      • like

        public DComplexMatrix2D like(int rows,                    int columns)
        Description copied from class: DComplexMatrix2D
        Construct and returns a new empty matrix of the same dynamic type as the receiver, having the specified number of rows and columns. For example, if the receiver is an instance of type DenseComplexMatrix2D the new matrix must also be of type DenseComplexMatrix2D. In general, the new matrix should have internal parametrization as similar as possible.
        Specified by:
        like in class DComplexMatrix2D
        Parameters:
        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.
      • like1D

        public DComplexMatrix1D like1D(int size)
        Description copied from class: DComplexMatrix2D
        Construct and returns a new 1-d matrix of the corresponding dynamic type, entirelly independent of the receiver. For example, if the receiver is an instance of type DenseComplexMatrix2D the new matrix must be of type DenseComplexMatrix1D.
        Specified by:
        like1D in class DComplexMatrix2D
        Parameters:
        size - the number of cells the matrix shall have.
        Returns:
        a new matrix of the corresponding dynamic type.
      • setQuick

        public void setQuick(int row,            int column,            double re,            double im)
        Description copied from class: DComplexMatrix2D
        Sets the matrix cell at coordinate [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): 0 <= column < columns() && 0 <= row < rows().

        Specified by:
        setQuick in class DComplexMatrix2D
        Parameters:
        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 row,            int column,            double[] value)
        Description copied from class: DComplexMatrix2D
        Sets the matrix cell at coordinate [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): 0 <= column < columns() && 0 <= row < rows().

        Specified by:
        setQuick in class DComplexMatrix2D
        Parameters:
        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: DComplexMatrix2D
        Constructs and returns a 2-dimensional array containing the cell values. The returned array values has the form re = values[row][2*column]; im = values[row][2*column+1] and has the same number of 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 DComplexMatrix2D
        Returns:
        an array filled with the values of the cells.
      • zMult

        public DComplexMatrix2D zMult(DComplexMatrix2D B,                     DComplexMatrix2D C,                     double[] alpha,                     double[] beta,                     boolean transposeA,                     boolean transposeB)
        Description copied from class: DComplexMatrix2D
        Linear algebraic matrix-matrix multiplication; C = alpha * A x B + beta*C. Matrix shapes: A(m x n), B(n x p), C(m x p).
        Note: Matrix shape conformance is checked after potential transpositions.
        Overrides:
        zMult in class DComplexMatrix2D
        Parameters:
        B - the second source matrix.
        C - the matrix where results are to be stored. Set this parameter to null to indicate that a new result matrix shall be constructed.
        Returns:
        C (for convenience only).
      • index

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

SCaVis 2.2 © jWork.ORG