inmost_residual.h

#ifndef INMOST_RESIDUAL_INCLUDED
#define INMOST_RESIDUAL_INCLUDED
 
#include "inmost_common.h"
#include "inmost_sparse.h"
 
#if defined(USE_AUTODIFF) && defined(USE_SOLVER)
 
namespace INMOST
{
    class Residual
    {
        Sparse::HessianMatrix hessian; 
        Sparse::Matrix jacobian; 
        Sparse::Vector residual; 
        Sparse::LockService locks; 
    public:
        Residual(std::string name = "", INMOST_DATA_ENUM_TYPE start = 0, INMOST_DATA_ENUM_TYPE end = 0, INMOST_MPI_Comm _comm = INMOST_MPI_COMM_WORLD);
        Residual(const Residual & other);
        Residual & operator =(Residual const & other);
        INMOST_DATA_ENUM_TYPE GetFirstIndex() const {return residual.GetFirstIndex();}
        INMOST_DATA_ENUM_TYPE GetLastIndex() const {return residual.GetLastIndex();}
        void GetInterval(INMOST_DATA_ENUM_TYPE & start, INMOST_DATA_ENUM_TYPE & end) const;
        void SetInterval(INMOST_DATA_ENUM_TYPE beg, INMOST_DATA_ENUM_TYPE end);
        __INLINE multivar_expression_reference operator [](INMOST_DATA_ENUM_TYPE row)
        {return multivar_expression_reference(residual[row],&jacobian[row]);}
        __INLINE double Value(INMOST_DATA_ENUM_TYPE row) const {return residual[row];}
        __INLINE double & Value(INMOST_DATA_ENUM_TYPE row) { return residual[row]; }
        Matrix<multivar_expression_reference> operator [](const AbstractMatrix<INMOST_DATA_INTEGER_TYPE> & rows);
        rMatrix Value(const AbstractMatrix<INMOST_DATA_INTEGER_TYPE> & rows) const;
        Matrix<value_reference> Value(const AbstractMatrix<INMOST_DATA_INTEGER_TYPE>& rows);
        Sparse::HessianMatrix & GetHessian() {return hessian;}
        const Sparse::HessianMatrix & GetHessian() const {return hessian;}
        Sparse::Matrix & GetJacobian() {return jacobian;}
        const Sparse::Matrix & GetJacobian() const {return jacobian;}
        Sparse::Vector & GetResidual() {return residual;}
        const Sparse::Vector & GetResidual() const {return residual;}
        void ClearResidual();
        void ClearJacobian();
        void ClearHessian();
        void Clear();
        INMOST_DATA_REAL_TYPE Norm();
        void Rescale(INMOST_DATA_ENUM_TYPE p = 2);
        void InitLocks() {locks.SetInterval(GetFirstIndex(),GetLastIndex());}
        __INLINE void Lock(INMOST_DATA_ENUM_TYPE pos) {if(!locks.Empty()) locks.Lock(pos);}
        __INLINE void UnLock(INMOST_DATA_ENUM_TYPE pos) {if(!locks.Empty()) locks.UnLock(pos);}
        __INLINE bool TestLock(INMOST_DATA_ENUM_TYPE pos) {if(!locks.Empty()) return locks.TestLock(pos); return false;}
    };
} //namespace INMOST
 
#endif //USE_SOLVER && USE_AUTODIFF
 
#endif //INMOST_RESIDUAL_INCLUDED