densmatrix.3.man

来自「COOOL：CWP面向对象最优化库（CWP Object Oriented Op」· MAN 代码 · 共 135 行

DENSE(derived)     C++ UITILITY CLASSES      DENSE(derived)

                                                     Jun  1 15:17
NAME
    dense Matrix class template, inherited from Matrix

SYNOPSIS
    #include <Matrix.hh>

    class DensMatrix : public Matrix<Type>

        \fIPublic members\fP
            DensMatrix();
            DensMatrix(int, int);
            DensMatrix(int, const Vector<Type>*);
            DensMatrix(const DensMatrix<Type>&);
            ~DensMatrix();
            const char* matrixType() const;
            DensMatrix<Type> adjoint();
            Vector<Type>& operator[](int);
            const Vector<Type> rowVector(int) const;
            const Vector<Type> colVector(int) const;
            DensMatrix<Type>& chaSize(int, int);
            Type operator() (char*, int);
            Type operator() (int, char*);
            Type rowMax(int);
            Type rowMin(int);
            Type colMax(int);
            Type colMin(int);
            operator DensMatrix<int>();
            operator DensMatrix<long>();
            operator DensMatrix<float>();
            operator DensMatrix<double>();
            DensMatrix<Type> operator-();
            DensMatrix<Type>& operator= (const DensMatrix<Type>&);
            DensMatrix<Type>& operator= (const Type);
            DensMatrix<Type>& operator+= (const DensMatrix<Type>&);
            DensMatrix<Type>& operator+= (const Type);
            DensMatrix<Type>& operator-= (const DensMatrix<Type>&);
            DensMatrix<Type>& operator-= (const Type);
            DensMatrix<Type>& operator*= (const Type);
            DensMatrix<Type>& operator/= (const Type);
            DensMatrix<Type>& addVal(const int, const Vector<Type>&);
            DensMatrix<Type>& addVal(const int, const DensMatrix<Type>&);
            DensMatrix<Type>& addVal(const Vector<Type>&, const int);
            DensMatrix<Type>& addVal(const DensMatrix<Type>&, const int);
            Vector<Type>  atdotx(const Vector<Type>&);
            Vector<Type>  adotx(const Vector<Type>&);

        \fIFriends\fP
            ostream& operator<<(ostream&, const DensMatrix<Type>&);
            Vector<Type> operator*(const DensMatrix<Type>&, const Vector<Type>&
            Vector<Type> operator*(const Vector<Type>&, const DensMatrix<Type>&
            DensMatrix<Type> operator+(const DensMatrix<Type>&,const DensMatrix
            DensMatrix<Type> operator+(const DensMatrix<Type>&,const Type);
            DensMatrix<Type> operator+(const Type,const DensMatrix<Type>&);
            DensMatrix<Type> operator-(const DensMatrix<Type>&,const DensMatrix
            DensMatrix<Type> operator-(const DensMatrix<Type>&,const Type);
            DensMatrix<Type> operator-(const Type,const DensMatrix<Type>&);
            DensMatrix<Type> operator* (const DensMatrix<Type>&,const DensMatri
            Vector<Type> operator* (const DensMatrix<Type>&, Vector<Type>&);
            DensMatrix<Type> operator* (const DensMatrix<Type>&,const Type);
            DensMatrix<Type> operator* (const Type, const DensMatrix<Type>&);
            DensMatrix<Type> operator/ (const DensMatrix<Type>&,const Type);

        \fIPrivate members\fP
            Vector<Type>  *aa;

DESCRIPTION
    DensMatrix<Type>
    is a class for general dense Matrix, it manages to do 
    algebraic operations of two-dimensional arrays.
    

DESCRIPTION
    Constructors:	 
      DensMatrix(): construct a DensMatrix of size 1x1;
      DensMatrix(m, n): construct a DensMatrix of size mxn;
      DensMatrix(A): copy the DensMatrix A to a new DensMatrix;
      DensMatrix(1, v): construct a one-row DensMatrix from 
        Vector v;
      DensMatrix(v, 1): construct a one-column DensMatrix from 
        Vector v;
    
    Fetching information of the DensMatrix:
      char* matrixType(): returns the name of the matrix type;
      DensMatrix<Type> adjoint(): returns the transpose;
      Vector<Type> rowVector(i): returns the ith row Vector;
      Vector<Type> colVector(i): returns the ith column Vector;
      Type operator()("", i): summation of the ith row;
      Type operator()(i, ""): summation of the ith column;
      Type rowMax(int): Maximum element of the ith row;
      Type rowMin(int): Minimum element of the ith row;
      Type colMax(int): Maximum element of the ith column;
      Type colMin(int): Minimum element of the ith column;
    
    Modifying the DensMatrix:
      Vector<Type>& operator[](i): access the ith element;
      DensMatrix<Type>& chaSize(m, n): change the size to mxn;
      DensMatrix<Type>& addVal(int, v):
        			append Vector v to the last row;
      DensMatrix<Type>& addVal(int, A): 
        			append Matrix A to the last row;
      DensMatrix<Type>& addVal(v, int): 
        			append Vector v to the last column;
      DensMatrix<Type>& addVal(A, int): 
        			append Matrix A to the last column;
    
    Arithmatic:
      Operators -, =, +=, -=, *= /=, +, -, *, /,
         arithmatics with other Matrix, Vectors, a single number;
      Vector<Type> adotx(x): dot product with Vector x;
      Vector<Type> atdotx(x): transpose of the DensMatrix dots 
         with Vector x;
    
    I/O operators: <<, >>
    

CAVEATS
    Implicit type conversion is not implemented here, so argument 
    types need to be consistent. This restriction should be 
    removed soon. This class template is the derived class from 
    Matrix, this issue will be discussed later.

DEFINED MACROS
    DENSMATRIX_HH

INCLUDED FILES
    "Matrix.hh"

SOURCE FILES
    DensMatrix.hh