BaseCostFunction.h

// BaseCostFunction.h:
// -------------------
//

#ifndef __IPSDKMATH_BASECOSTFUNCTION_H__
#define __IPSDKMATH_BASECOSTFUNCTION_H__

// suppression warnings
// warning C4275: non dll-interface class 'boost::noncopyable_::noncopyable' used as base for dll-interface class 'ipsdk::math::BaseCostFunction'
#pragma warning (push)
#pragma warning (disable : 4275)

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

namespace ipsdk {
namespace math {


class IPSDKMATH_API BaseCostFunction : public boost::noncopyable
{
public:
    BaseCostFunction();
    virtual ~BaseCostFunction() = 0;

// methods
public:
    bool            isInit() const;

    ipUInt32        getNbParameters() const;

    ipUInt32        getNbEquations() const;

    BoolResult      computeEquations(const Vector& parameters,
                                     Vector& equations) const;

    BoolResult      computeJacobian(const Vector& parameters,
                                    Matrix& jacobian) const;

    void            clear();

protected:
    void                initBase(const ipUInt32 nbParameters,
                                 const ipUInt32 nbEquations);

    virtual BoolResult  processEquations(const Vector& parameters,
                                         Vector& equations)  const = 0;

    virtual BoolResult  processJacobian(const Vector& parameters,
                                        Matrix& jacobian) const;

    virtual void        clearDerived() {}

// attributes
protected:
    ipUInt32        _nbParameters;

    ipUInt32        _nbEquations;

    bool            _bInit;
};


inline bool
BaseCostFunction::isInit() const
{
    return _bInit;
}


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

#pragma warning (pop)

#endif // __IPSDKMATH_BASECOSTFUNCTION_H__