BaseEstimator.h

// BaseEstimator.h:
// ----------------
//

#ifndef __IPSDKMATH_BASEESTIMATOR_H__
#define __IPSDKMATH_BASEESTIMATOR_H__

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

#include <IPSDKMath/IPSDKMathExports.h>
#include <IPSDKMath/Estimation/EstimationTypes.h>
#include <IPSDKUtil/Tools/ProcessingResult.h>
#include <boost/noncopyable.hpp>

namespace ipsdk {
namespace math {


class IPSDKMATH_API BaseEstimator : public boost::noncopyable
{
    // friend class for protected members acccess
    friend class BaseRobustEstimator;

public:
    BaseEstimator();
    virtual ~BaseEstimator() = 0;

// methods
public:
    bool            isInit() const;

    ipUInt32        getNbMinRequestedData() const;

    ipUInt32        getNbEstimParams() const;

    ipUInt32        getDataSize() const;

    BoolResult      computeEstimation(const DataSet& dataSet,
                                      ParameterType& estimParams);

    BoolResult      computeResiduals(const DataSet& dataSet,
                                     const ParameterType& estimParams,
                                     ResidualsSet& residualsSet) const;

protected:
    void                initBase(const ipUInt32 nbMinRequestedData,
                                 const ipUInt32 nbEstimParams,
                                 const ipUInt32 dataSize);

    BoolResult          checkData(const DataSet& dataSet,
                                  const ParameterType& estimParams) const;

    virtual BoolResult  processEstimation(const DataSet& dataSet,
                                          ParameterType& estimParams) = 0;

    virtual BoolResult  processResiduals(const DataSet& dataSet,
                                         const ParameterType& estimParams,
                                         ResidualsSet& residualsSet) const = 0;

// attributes
private:
    ipUInt32        _nbMinRequestedData;

    ipUInt32        _nbEstimParams;

    ipUInt32        _dataSize;

    bool            _bInit;
};


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


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

#pragma warning (pop)

#endif // __IPSDKMATH_BASEESTIMATOR_H__