NonLinearSolver.h

// NonLinearSolver.h:
// ------------------
//

#ifndef __IPSDKMATH_NONLINEARSOLVER_H__
#define __IPSDKMATH_NONLINEARSOLVER_H__

// suppression warnings
// warning C4275: non dll-interface class 'boost::noncopyable_::noncopyable' used as base for dll-interface class 'ipsdk::math::NonLinearSolver'
// warning C4251: 'ipsdk::math::NonLinearSolver::_optStatus' : class 'ipsdk::math::NonLinearSolver::eOptStatus' needs to have dll-interface to be used by clients of class 'ipsdk::math::NonLinearSolver'
#pragma warning (push)
#pragma warning (disable : 4275 4251)

#include <IPSDKMath/IPSDKMathExports.h>
#include <IPSDKMath/Optimization/OptimizationTypes.h>
#include <boost/noncopyable.hpp>

namespace ipsdk {
namespace math {


class IPSDKMATH_API NonLinearSolver : public boost::noncopyable
{
public:
    NonLinearSolver();
    ~NonLinearSolver();

// methods
public:
    const ipUInt32              getNbMaxIteration() const;
    void                        setNbMaxIteration(const ipUInt32 nbMaxIteration);

    eOptStatus                  getStatus() const;

    OptResult                   solve(const CostFunctionConstPtr& pCostFunction,
                                      const Vector& initParams);

    ipUInt32                    getNbIteration() const;

    const Vector&               getEstimParams() const;

    void                        clearResults();

protected:
    static ipInt32              minPackProxy(void* pThis,
                                             ipInt32 m, ipInt32 n,
                                             ipReal64* x, ipReal64* fvec, ipReal64* fjac,
                                             ipInt32 ldfjac, ipInt32 iflag);

// attributes
protected:
    ipUInt32                _nbMaxIteration;

    eOptStatus              _optStatus;

    ipUInt32                _nbIteration;

    Vector                  _estimParams;

    CostFunctionConstPtr    _pCostFunction;

    Vector                  _funValue;
    Vector                  _wa2;
    Vector                  _wa4;
    Matrix                  _jacValue;

    std::string             _errorMsg;
};


inline eOptStatus
NonLinearSolver::getStatus() const
{
    return _optStatus;
}

inline const ipUInt32
NonLinearSolver::getNbMaxIteration() const
{
    return _nbMaxIteration;
}

inline void
NonLinearSolver::setNbMaxIteration(const ipUInt32 nbMaxIteration)
{
    _nbMaxIteration = nbMaxIteration;
}


} // end of namespace math
} // end of namespace ipsdk

#pragma warning (pop)

#endif // __IPSDKMATH_NONLINEARSOLVER_H__