ComplexMatrix
org.jscience.mathematics.vector

Class ComplexMatrix

  • All Implemented Interfaces:
    javolution.lang.Immutable, javolution.lang.Realtime, javolution.lang.ValueType, GroupAdditive<Matrix<Complex>>, Ring<Matrix<Complex>>, Structure<Matrix<Complex>>, VectorSpace<Matrix<Complex>,Complex>


    public final class ComplexMatrixextends Matrix<Complex>

    This class represents an optimized matrix implementation for complex numbers.

    Instances of this class can be created from ComplexVector, either as rows or columns if the matrix is transposed. For example:

            ComplexVector<Rational> column0 = ComplexVector.valueOf(...);        ComplexVector<Rational> column1 = ComplexVector.valueOf(...);        ComplexMatrix<Rational> M = ComplexMatrix.valueOf(column0, column1).transpose();     

    • Method Detail

      • valueOf

        public static ComplexMatrix valueOf(Complex[][] elements)
        Returns a complex matrix from the specified 2-dimensional array. The first dimension being the row and the second being the column.
        Parameters:
        elements - this matrix elements.
        Returns:
        the matrix having the specified elements.
        Throws:
        DimensionException - if rows have different length.
        See Also:
        ComplexVector
      • valueOf

        public static ComplexMatrix valueOf(ComplexVector... rows)
        Returns a complex matrix holding the specified row vectors (column vectors if transposed).
        Parameters:
        rows - the row vectors.
        Returns:
        the matrix having the specified rows.
        Throws:
        DimensionException - if the rows do not have the same dimension.
      • valueOf

        public static ComplexMatrix valueOf(List<ComplexVector> rows)
        Returns a complex matrix holding the row vectors from the specified collection (column vectors if transposed).
        Parameters:
        rows - the list of row vectors.
        Returns:
        the matrix having the specified rows.
        Throws:
        DimensionException - if the rows do not have the same dimension.
      • valueOf

        public static ComplexMatrix valueOf(Matrix<Complex> that)
        Returns a complex matrix equivalent to the specified matrix.
        Parameters:
        that - the matrix to convert.
        Returns:
        that or a complex matrix holding the same elements as the specified matrix.
      • getNumberOfRows

        public int getNumberOfRows()
        Description copied from class: Matrix
        Returns the number of rows m for this matrix.
        Specified by:
        getNumberOfRows in class Matrix<Complex>
        Returns:
        m, the number of rows.
      • getNumberOfColumns

        public int getNumberOfColumns()
        Description copied from class: Matrix
        Returns the number of columns n for this matrix.
        Specified by:
        getNumberOfColumns in class Matrix<Complex>
        Returns:
        n, the number of columns.
      • get

        public Complex get(int i,          int j)
        Description copied from class: Matrix
        Returns a single element from this matrix.
        Specified by:
        get in class Matrix<Complex>
        Parameters:
        i - the row index (range [0..m[).
        j - the column index (range [0..n[).
        Returns:
        the element read at [i,j].
      • getRow

        public ComplexVector getRow(int i)
        Description copied from class: Matrix
        Returns the row identified by the specified index in this matrix.
        Specified by:
        getRow in class Matrix<Complex>
        Parameters:
        i - the row index (range [0..m[).
        Returns:
        the vector holding the specified row.
      • getColumn

        public ComplexVector getColumn(int j)
        Description copied from class: Matrix
        Returns the column identified by the specified index in this matrix.
        Specified by:
        getColumn in class Matrix<Complex>
        Parameters:
        j - the column index (range [0..n[).
        Returns:
        the vector holding the specified column.
      • minus

        public ComplexMatrix minus(Matrix<Complex> that)
        Description copied from class: Matrix
        Returns the difference between this matrix and the one specified.
        Overrides:
        minus in class Matrix<Complex>
        Parameters:
        that - the matrix to be subtracted.
        Returns:
        this - that.
      • determinant

        public Complex determinant()
        Description copied from class: Matrix
        Returns the determinant of this matrix.
        Specified by:
        determinant in class Matrix<Complex>
        Returns:
        this matrix determinant.
      • cofactor

        public Complex cofactor(int i,               int j)
        Description copied from class: Matrix
        Returns the cofactor of an element in this matrix. It is the value obtained by evaluating the determinant formed by the elements not in that particular row or column.
        Specified by:
        cofactor in class Matrix<Complex>
        Parameters:
        i - the row index.
        j - the column index.
        Returns:
        the cofactor of THIS[i,j].
      • adjoint

        public ComplexMatrix adjoint()
        Description copied from class: Matrix
        Returns the adjoint of this matrix. It is obtained by replacing each element in this matrix with its cofactor and applying a + or - sign according (-1)**(i+j), and then finding the transpose of the resulting matrix.
        Specified by:
        adjoint in class Matrix<Complex>
        Returns:
        the adjoint of this matrix.
      • vectorization

        public ComplexVector vectorization()
        Description copied from class: Matrix
        Returns the vectorization of this matrix. The vectorization of a matrix is the column vector obtain by stacking the columns of the matrix on top of one another. The default implementation returns a DenseVector.
        Specified by:
        vectorization in class Matrix<Complex>
        Returns:
        the vectorization of this matrix.
        See Also:
        Wikipedia: Vectorization.
      • copy

        public ComplexMatrix copy()
        Description copied from class: Matrix
        Returns a copy of this matrix allocated by the calling thread (possibly on the stack).
        Specified by:
        copy in interface javolution.lang.ValueType
        Specified by:
        copy in class Matrix<Complex>
        Returns:
        an identical and independant copy of this matrix.

SCaVis 2.2 © jWork.ORG