Class UpperTriangularMatrix

    • Constructor Detail

      • UpperTriangularMatrix

        public UpperTriangularMatrix​(int dim)
        Constructs an upper triangular matrix of dimension dim * dim.
        Parameters:
        dim - the matrix dimension
      • UpperTriangularMatrix

        public UpperTriangularMatrix​(double[][] data)
        Constructs an upper triangular matrix from a 2D double[][] array.
        Parameters:
        data - the 2D array input
        Throws:
        IllegalArgumentException - when the input data is not a upper triangular
      • UpperTriangularMatrix

        public UpperTriangularMatrix​(Matrix A)
        Constructs an upper triangular matrix from a matrix.
        Parameters:
        A - a matrix
        Throws:
        IllegalArgumentException - when A is not square
      • UpperTriangularMatrix

        public UpperTriangularMatrix​(UpperTriangularMatrix U)
        Copy constructor.
        Parameters:
        U - an upper triangular matrix
    • Method Detail

      • deepCopy

        public UpperTriangularMatrix deepCopy()
        Description copied from interface: DeepCopyable
        The implementation returns an instance created from this by the copy constructor of the class, or just this if the instance itself is immutable.
        Specified by:
        deepCopy in interface DeepCopyable
        Specified by:
        deepCopy in interface Matrix
        Returns:
        an independent (deep) copy of the instance
      • nRows

        public int nRows()
        Description copied from interface: Table
        Gets the number of rows. Rows count from 1.
        Specified by:
        nRows in interface Table
        Returns:
        the number of rows
      • nCols

        public int nCols()
        Description copied from interface: Table
        Gets the number of columns. Columns count from 1.
        Specified by:
        nCols in interface Table
        Returns:
        the number of columns
      • set

        public void set​(int i,
                        int j,
                        double value)
                 throws MatrixAccessException
        Description copied from interface: MatrixAccess
        Set the matrix entry at [i,j] to a value. This is the only method that may change a matrix.
        Specified by:
        set in interface MatrixAccess
        Parameters:
        i - the row index
        j - the column index
        value - the value to set A[i,j] to
        Throws:
        MatrixAccessException - if i or j is out of range
      • getRow

        public Vector getRow​(int i)
        Description copied from interface: Matrix
        Get the specified row in the matrix as a vector.
        Specified by:
        getRow in interface Matrix
        Parameters:
        i - the row index
        Returns:
        the vector A[i, ]
      • getColumn

        public Vector getColumn​(int j)
        Description copied from interface: Matrix
        Get the specified column in the matrix as a vector.
        Specified by:
        getColumn in interface Matrix
        Parameters:
        j - the column index
        Returns:
        a vector A[, j]
      • t

        public LowerTriangularMatrix t()
        Description copied from interface: MatrixRing
        Get the transpose of this matrix. This is the involution on the matrix ring.
        Specified by:
        t in interface MatrixRing
        Returns:
        the transpose of this matrix
      • scaled

        public UpperTriangularMatrix scaled​(double scalar)
        Description copied from interface: Matrix
        Scale this matrix, A, by a constant.
        Specified by:
        scaled in interface Matrix
        Parameters:
        scalar - a double
        Returns:
        cA
      • multiply

        public Vector multiply​(Vector v)
        Description copied from interface: Matrix
        Right multiply this matrix, A, by a vector.
        Specified by:
        multiply in interface Matrix
        Parameters:
        v - a vector
        Returns:
        Av, a vector
      • ONE

        public UpperTriangularMatrix ONE()
        Description copied from interface: MatrixRing
        Get an identity matrix that has the same dimension as this matrix. For a non-square matrix, it zeros out the rows (columns) with index > nCols (nRows).
        Specified by:
        ONE in interface MatrixRing
        Specified by:
        ONE in interface Monoid<Matrix>
        Returns:
        an identity matrix
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object