LAP_DoubleBandedUpperMatrix.h

Go to the documentation of this file.

#ifndef LAP_DoubleBandedUpperMatrix_H
#define LAP_DoubleBandedUpperMatrix_H

#include "LAP_DoubleBandedStorage.h"

#include "LAP_DoubleUpperMatrix.h"

#include "LAP_DoubleVector.h"
#include "LAP_DoubleFullGeneralMatrix.h"


#include "dfulluppermatrix_functions.h"
#include "dbandeduppermatrix_functions.h"
#include "dvector_functions.h"

#include "LAP_DoubleBandedStorage.h"

DEFINE_SPTR(LAP_DoubleBandedUpperMatrix);
class LAP_DoubleBandedUpperMatrix: public LAP_DoubleUpperMatrix  {
    
    SP_OBJECT(LAP_DoubleBandedUpperMatrix);
    
private:
    // ATTRIBUTES
    
  
    // ASSOCIATIONS
    // METHOD
  
  
public:
    // CONSTRUCTORS
    LAP_DoubleBandedUpperMatrix();
    LAP_DoubleBandedUpperMatrix(const LAP_DoubleBandedUpperMatrix& mat);
  
    // DESTRUCTORS
    virtual ~LAP_DoubleBandedUpperMatrix();

    
    
    // -------------
    // NEW METHODS
    // -------------
public:

    inline static SP::LAP_DoubleBandedUpperMatrix New() {
        SP::LAP_DoubleBandedUpperMatrix p(new LAP_DoubleBandedUpperMatrix(),
                                          LAP_DoubleBandedUpperMatrix::Delete());
        p->setThis(p);
        return p;
    };

    inline static SP::LAP_DoubleBandedUpperMatrix New(const tLVectorIndex& n) {
        SP::LAP_DoubleBandedUpperMatrix p=New();
        p->setSize(n);
        return p;
    };
    virtual SP::LAP_DoubleMatrix NewInstance() const {
        return New();
    }

    //-----------
    // OPERATORS
    // ----------
    virtual double& operator()(const tLVectorIndex& i,const tLVectorIndex& j) {
        return (i<=j)?getBandedStorage()(i,j):getNullValue();
    };
    
    virtual const double& operator()(const tLVectorIndex& i,const tLVectorIndex& j) const {
        return (i<=j)?getBandedStorage()(i,j):getNullValue();
    };

    //copy operators
    //==============
    
    LAP_DoubleBandedUpperMatrix& operator=(const double& s)  {
        getStorage().init(s);
        return (*this);
    };
    LAP_DoubleBandedUpperMatrix& operator=(const LAP_DoubleMatrix& s)  {
        copy(s);
        return (*this);
    };
    
    
    //scalar operators
    //================
    
    inline LAP_DoubleBandedUpperMatrix& operator^=(const lapack_real&  s) {
        getBandedStorage()^=s;
        return (*this);
    }
    
    inline LAP_DoubleBandedUpperMatrix& operator*=(const lapack_real&  s) {
        getBandedStorage()*=s;
        return (*this);
    }
    inline LAP_DoubleBandedUpperMatrix& operator/=(const lapack_real&  s) {
        getBandedStorage()/=s;
        return (*this);
    }
 
    inline LAP_DoubleBandedUpperMatrix& operator+=(const lapack_real&  s) {
        getBandedStorage()+=s;
        return (*this);
    }
  
  
    inline LAP_DoubleBandedUpperMatrix& operator-=(const lapack_real&  s) {
        getBandedStorage()-=s;
        return (*this);
    }
    inline tBoolean compile() {
        return getBandedStorage().compile();
    }
    //pack matrix operator
    //=====================
    
    inline LAP_DoubleBandedUpperMatrix& operator*=(const LAP_DoubleBandedUpperMatrix& s) {
        getBandedStorage()*=s.getBandedStorage();
        return (*this);
    }
    inline LAP_DoubleBandedUpperMatrix& operator/=(const LAP_DoubleBandedUpperMatrix& s) {
        getBandedStorage()/=s.getBandedStorage();
        return (*this);
    }
    
    inline LAP_DoubleBandedUpperMatrix& operator-=(const LAP_DoubleBandedUpperMatrix& s) {
        getBandedStorage()-=s.getBandedStorage();
        return (*this);
    }
    inline LAP_DoubleBandedUpperMatrix& operator+=(const LAP_DoubleBandedUpperMatrix& s) {
        getBandedStorage()+=s.getBandedStorage();
        return (*this);
    }
    
    
   
public:
    // COPY Methods
    // ==========
  
    
    
    virtual tBoolean copyLower(const LAP_DoubleFullGeneralMatrix& f);
  
    //dimension setting
    //=================
     
    virtual void setSize(const tLVectorIndex & nRows,const tLVectorIndex& nCols) {
        LAP_DoubleUpperMatrix::setSize(nRows,nCols);
        LAP_DoubleBandedStorage &s=getBandedStorage();
        tLVectorIndex nBandsNumber=s.getBandsNumber();
        if (nBandsNumber<=0) {
            if (nRows>=nCols) s.setBandsNumber(nCols,nRows-nCols+1);
            else s.setBandsNumber(nCols,1);
            nBandsNumber=s.getBandsNumber();
        }
        getStorage().setValuesNumber( ((tLVectorIndex) nCols) * nBandsNumber);
    }
    
    virtual void setSize(const tLVectorIndex & n) {
        LAP_DoubleUpperMatrix::setSize(n,n);
        LAP_DoubleBandedStorage &s=getBandedStorage();
        tLVectorIndex nBandsNumber=s.getBandsNumber();
        if (nBandsNumber<=0) {
            s.setBandsNumber(n,1);
            nBandsNumber=s.getBandsNumber();
        }
        getStorage().setValuesNumber( ((tLVectorIndex) n) * nBandsNumber);
    }
    
    inline void setBandsNumber(const tLVectorIndex& n) {
        getBandedStorage().setBandsNumber(n,1);
    }

    // values setting
    //================
    
    virtual void setValues(SP::LAP_DoubleVector values) {
        ASSERT_IN(values.get()!=null);

        //compute the numbr of columns
        tLVectorIndex n=values->getSize();
        n/=getBandsNumber();
        LAP_DoubleUpperMatrix::setSize(n,n);

        //set the values pointer
        getStorage().setValuesPointer(values);
        
    }
    virtual void setValues(const tLVectorIndex& n,const double* values) {
        tLVectorIndex nCols=n/getBandsNumber();
        LAP_DoubleUpperMatrix::setSize(nCols,nCols);
        
        //set the values pointer
        getStorage().setValues(n,values);
    }
  

    
    //======
public:
    inline LAP_DoubleBandedStorage& getBandedStorage() {
        return *dynamic_cast<LAP_DoubleBandedStorage*>(&getStorage());
    };
    inline const LAP_DoubleBandedStorage& getBandedStorage() const {
        return *dynamic_cast<const LAP_DoubleBandedStorage*>(&getStorage());
    };
public:
    inline  const tLVectorIndex&  getBandsNumber() const {
        return getBandedStorage().getBandsNumber();
    }
    inline  const tLVectorIndex&  getUpperBandsNumber() const {
        return getBandedStorage().getUpperBandsNumber();
    }
    virtual void getColumn(const tLVectorIndex& j,LAP_DoubleVector& v) const;
    virtual void getColumn(const tLVectorIndex& j,SP::LAP_DoubleVector v) const {
        ASSERT_IN(v.get()!=null);
        getColumn(j,*v.get());
    };

    virtual void getRow(const tLVectorIndex& i,LAP_DoubleVector& v) const;
    
    virtual void getRow(const tLVectorIndex& i,SP::LAP_DoubleVector v) const {
        ASSERT_IN(v.get()!=null);
        getRow(i,*v.get());
    };
    
 
  
    // ------------------------
    // operation on matrix
    // ------------------------
public:
    
    
    virtual tReal norm2() const;
    
    virtual tReal norm2(LAP_DoubleVector& v) const;
    
 
  

    virtual tReal sum(const tFlag& d,LAP_DoubleVector& s) const;
    
    virtual tReal sum(const tFlag& d,const tLVectorIndex& index) const;
    
    virtual tReal max(const tFlag& d,const tLVectorIndex& index) const {
        return getBandedStorage().max(d,index);
    }
  
    void indexMin(tLVectorIndex& i,tLVectorIndex& j) const {
        getBandedStorage().indexMin(i,j);
    }

   

    // ----------------
    // vector product
    // ----------------
    
public:
    virtual void vectorProduct(const tBoolean& isTrans,LAP_DoubleVector& X) const {
        vectorProduct(isTrans,1,X);
    } 
    /* \brief compute X:=alpha.op(This).X
     * @param isTrans : if (isTrans) op(A)=A else op(A)=tA
     * @param alpha: alpha value
     * @param X: X 
     */
    inline void vectorProduct(const tBoolean& isTrans,const double& alpha,LAP_DoubleVector& X) const {
        if (alpha==0) X=0;
        else {
            tLVectorIndex nRows=getRowsNumber();
            tLVectorIndex nCols=getColumnsNumber();
            if (nRows==nCols) {
                //X:=op(This).X
                vectorProduct(isTrans,nRows,X.getIncrement(),&X(0));
                //X*=alpha
                if (alpha!=1) X*=alpha;
            }
            else {
                LAP_DoubleVector Y;
                Y.setSize(nRows);
                vectorProduct(isTrans,
                              X.getSize(),X.getIncrement(),&X(0),
                              alpha,0.,
                              Y.getSize(),Y.getIncrement(),&Y(0));
                X.copy(Y);
            }
        }
      
    };
   
   
   
    void vectorProduct(const tBoolean& isTrans,
                       const LAP_DoubleVector& X,
                       const lapack_real& alpha,
                       const lapack_real& beta,
                       LAP_DoubleVector& Y) const {
        //get the dimenson of Matrix
        tLVectorIndex nRows=getRowsNumber();
        tLVectorIndex nCols=getColumnsNumber();

        if (nRows==0) return;
        
        if (isTrans) std::swap(nRows,nCols);
        
        tLVectorIndex nX=X.getSize();
        
        //verify the dimension of X
        if (nX!=nCols) {
            throw LAP_Exception("math/linalg/core","LAP_DoubleBandedUpperMatrix::product()","incompatible size of X vector");
        }
        //verify the packed upper marix is squared
        if (nRows!=nCols) {
            throw LAP_Exception("math/linalg/core","LAP_DoubleBandedUpperMatrix::product()","only squared matrix");
        }

        //create the right dimension of return vector Y
        if (beta==0) {
            //Y=X
            Y.copy(X);
            //Y=op(A).X
            vectorProduct(isTrans,nRows,Y.getIncrement(),&Y(0));
            //Y=alpha.op(A).X
            if (alpha!=1) Y*=alpha;
            return;
        }
        
        //verify the dimension of Y
        tLVectorIndex nY=Y.getSize();
        if (nY!=nRows) {
            throw LAP_Exception("math/linalg/core","LAP_DoubleBandedUpperMatrix::product()","incompatible size of Y vector");
        }
        
        //test if the lapack mat-vector routine can be called : Y:=alpha.op(A).X
        vectorProduct(isTrans,
                      nX,X.getIncrement(),&X(0),
                      alpha,
                      beta,
                      nY,Y.getIncrement(),&Y(0));
    };
    
    void vectorProduct(const tBoolean& isTrans,
                       const LAP_ConstDoubleVector& X,
                       const lapack_real& alpha,
                       const lapack_real& beta,
                       LAP_DoubleVector& Y) const {
        //get the dimenson of Matrix
        tLVectorIndex nRows=getRowsNumber();
        tLVectorIndex nCols=getColumnsNumber();
        if (isTrans) std::swap(nRows,nCols);
        
        tLVectorIndex nX=X.getSize();
        
        //verify the dimension of X
        if (nX!=nCols) {
            throw LAP_Exception("math/linalg/core","LAP_DoubleBandedUpperMatrix::product()","incompatible size of X vector");
        }
       
        if (beta==0) {
            Y.setSize(nRows);
        }
        tLVectorIndex nY=Y.getSize();
        if (nY!=nRows) {
            throw LAP_Exception("math/linalg/core","LAP_DoubleBandedUpperMatrix::product()","incompatible size of Y vector");
        }
      
        vectorProduct(isTrans,
                      nX,X.getIncrement(),&X(0),
                      alpha,
                      beta,
                      nY,Y.getIncrement(),&Y(0));
    };
  
    
    
public:

    
    inline void vectorProduct(const tBoolean& isTrans,const tLVectorIndex& nX,const tLVectorIncrement& incX,double* X) const {
        
        tLVectorIndex nRows=getRowsNumber();
        tLVectorIndex nCols=getColumnsNumber();
        if (nRows==0) return;
        
        if (nRows!=nCols) {
            throw LAP_Exception("math/linalg/core","LAP_DoubleBandedUpperMatrix::product()",
                                "X=A.X needs to have a squared matrix");
        }
        if (nCols!=nX) {
            throw LAP_Exception("math/linal/core","LAP_DoubleBandedUpperMatrix::product","incompatible size of X vector");
        }
        
        DoubleBandedUpperMatrixVectorProduct(isTrans,
                                             nRows,
                                             getBandedStorage().getBandsNumber(),
                                             &(*this)[0],
                                             nX,incX,X);
    }
    void vectorProduct(const tBoolean& isTrans,
                       const tLVectorIndex& nX,const tLVectorIncrement& incX,const double *x,
                       const double& alpha,const double& beta,
                       const tLVectorIndex& nY,const tLVectorIncrement& incY,double *y) const;
    
    
public:
   
    void rankProduct(const tBoolean& isTransU,
                     const LAP_DoubleVector& Diag,
                     LAP_DoubleVector& X) const {
        tLVectorIndex nX=X.getSize();
        
        if (nX!=getRowsNumber()) {
            throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:rankDProduct","incompatible dimension of vector");
        }
        if (nX!=getColumnsNumber()) {
            throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:rankDProduct","incompatible dimension of vector");
        }
        if (nX!=Diag.getSize()) {
            throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:rankDProduct","incompatible dimension of vectors");
        }
        DoubleBandedUpperMatrixVectorProduct(isTransU,
                                             getRowsNumber(),
                                             getBandedStorage().getBandsNumber(),
                                             &(*this)[0],
                                             X.getSize(),X.getIncrement(),&X(0));
        
        X*=Diag;
        
        DoubleBandedUpperMatrixVectorProduct(!isTransU,
                                             getRowsNumber(),
                                             getBandedStorage().getBandsNumber(),
                                             &(*this)[0],
                                             X.getSize(),X.getIncrement(),&X(0));
    }
    
    void rankProduct(const tBoolean& isTransU,
                     LAP_DoubleVector& X) const {
        tLVectorIndex nX=X.getSize();
        
        if (nX!=getRowsNumber()) {
            throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:rankProduct","incompatible dimension of vector");
        }
        if (nX!=getColumnsNumber()) {
            throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:rankProduct","incompatible dimension of vector");
        }
        DoubleBandedUpperMatrixVectorProduct(isTransU,
                                             getRowsNumber(),
                                             getBandedStorage().getBandsNumber(),
                                             &(*this)[0],
                                             X.getSize(),X.getIncrement(),&X(0));
        DoubleBandedUpperMatrixVectorProduct(!isTransU,
                                             getRowsNumber(),
                                             getBandedStorage().getBandsNumber(),
                                             &(*this)[0],
                                             X.getSize(),X.getIncrement(),&X(0));
        
    }
    
    
  
    
    
public:

  
    // ----------------
    // matrix product
    // ----------------
    virtual SP::LAP_DoubleMatrix matrixProduct(const LAP_DoubleMatrix& B) const;
    

   
    tBoolean matrixProduct(const LAP_DoubleMatrix& B,
                           LAP_DoubleFullGeneralMatrix& C) const;
    
    
    
    //product with full matrix
    //-------------------------
    
    void matrixProduct(const LAP_DoubleFullGeneralMatrix& B,
                       LAP_DoubleFullGeneralMatrix& C) const {

        matrixProduct(true,false,B,1.,C);
    };
    
    void matrixProduct(const tBoolean& isTransB,
                       const LAP_DoubleFullGeneralMatrix& B,
                       LAP_DoubleFullGeneralMatrix& C) const {
        
        matrixProduct(true,isTransB,B,1.,C);
    };
    
    void matrixProduct(const LAP_DoubleBandedUpperMatrix& B,
                       LAP_DoubleFullGeneralMatrix& C) const;
    
        
    void matrixProduct(const tBoolean& isLeft,
                       const tBoolean& isTrans,
                       const LAP_DoubleFullGeneralMatrix& B,
                       const double& alpha,
                       LAP_DoubleFullGeneralMatrix& C) const;
    

    virtual void matrixProduct( const tBoolean& isLeft,
                                const tBoolean& isTrans,
                                const double& alpha,
                                LAP_DoubleFullGeneralMatrix& A) const {
        matrixProduct(isLeft,isTrans,*this,alpha,A);
    }
    
    
    
    
    static void matrixProduct(const tBoolean& isLeft,
                              const tBoolean& isTransA,
                              const LAP_DoubleBandedUpperMatrix& A,
                              const lapack_real& alpha,
                              LAP_DoubleFullGeneralMatrix& B);

    
    
  
    // ----------------------
    // eigen values & vectors
    // ------------------------
public:
    
    
    static tBoolean computeEigenValues(const LAP_DoubleBandedUpperMatrix&A,
                                       LAP_DoubleVector& U) {

        tLVectorIndex i,nRows=A.getRowsNumber();
        U.setSize(nRows);
        double *U_i=&U(0);
        const tLVectorIndex &nBands=A.getBandedStorage().getBandsNumber();
        const tLVectorIncrement &incU=U.getIncrement();
        const double *A_ii=&A(0,0);
        for (i=0;i<nRows;i++) {
            *U_i=*A_ii;
            U_i+=incU;
            A_ii+=nBands;
        }
        return true;
    }
    
    virtual tBoolean computeEigenValues(LAP_DoubleVector& U) const {
        return computeEigenValues(*this,U);
    };    
   
  


  
    // -----------------------
    // linear system solver
    // -----------------------
     
    void solve(const tBoolean& isTrans,
               LAP_DoubleVector& B) const {
        tLVectorIndex nB=B.getSize();
        if (nB!=0)
            solve(isTrans,nB,B.getIncrement(),&B(0));
    }
    
    virtual void solve(const tBoolean& isTrans,
                       const tLVectorIndex& nB,const tLVectorIncrement& incB,double *B) const {
        tLVectorIndex nRows=getRowsNumber();
        tLVectorIndex nCols=getColumnsNumber();
        if (nRows==0) return;
        if (nRows!=nB) throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:solve","incompatible dimension of vector");
        if (nRows!=nCols)
            throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:solve","only be used with squared matrix");

        DoubleBandedUpperMatrixVectorSolve(isTrans,nRows,getBandedStorage().getBandsNumber(),&(*this)[0],nB,incB,B);
    }

    virtual tBoolean solve(const tBoolean& isTrans,
                           LAP_DoubleFullGeneralMatrix& X) const {
        return solve(isTrans,*this,X);
    }
    
    static tBoolean solve(const tBoolean& isTransA,
                          const LAP_DoubleBandedUpperMatrix& A,
                          LAP_DoubleFullGeneralMatrix& B) {

        tLVectorIndex nARows=A.getRowsNumber();
        tLVectorIndex nBRows=B.getRowsNumber();
        tLVectorIndex nBCols=B.getColumnsNumber();
        tLVectorIndex ldb=B.getLeadingDimension();
        
        if (nARows==0) return true;
        
        if (nARows!=nBRows)
            throw LAP_Exception("math/linal/core"," LAP_DoubleBandedUpperMatrix:solve","incompatible size of matrices");
        
        return DoubleBandedUpperMatrixSolve(isTransA,nARows,A.getBandsNumber(),&A[0],nBCols,ldb,&B(0,0));
        
        
    }
    
    

  
};
#endif