linearApproximationPolicy.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Christophe GONZALES and Pierre-Henri WUILLEMIN  *
 *   {prenom.nom}_at_lip6.fr                                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef GUM_LINEAR_APPROXIMATION_POLICY_H
#define GUM_LINEAR_APPROXIMATION_POLICY_H

#include <agrum/agrum.h>
#include <agrum/core/approximations/approximationPolicy.h>
#include <typeinfo>

namespace gum {

  template < typename GUM_SCALAR >
  class LinearApproximationPolicy
      : public virtual ApproximationPolicy< GUM_SCALAR > {
    public:
    // ===========================================================================
    // ===========================================================================

    LinearApproximationPolicy(GUM_SCALAR low = (GUM_SCALAR)0.0,
                              GUM_SCALAR high = (GUM_SCALAR)1.0,
                              GUM_SCALAR eps = (GUM_SCALAR)0.1);

    LinearApproximationPolicy(const LinearApproximationPolicy< GUM_SCALAR >* md);


    // ===========================================================================
    // ===========================================================================

    GUM_SCALAR fromExact(const GUM_SCALAR& value) const;

    void combineAdd(const ApproximationPolicy< GUM_SCALAR >* ap);

    void combineSub(const ApproximationPolicy< GUM_SCALAR >* ap);

    void combineMult(const ApproximationPolicy< GUM_SCALAR >* ap);

    void combineDiv(const ApproximationPolicy< GUM_SCALAR >* ap);

    void combineMax(const ApproximationPolicy< GUM_SCALAR >* ap);

    void combineMin(const ApproximationPolicy< GUM_SCALAR >* ap);

    GUM_SCALAR safeFromExact(const GUM_SCALAR& value);

    Idx encode(const GUM_SCALAR& value) const;

    GUM_SCALAR decode(Idx representation) const;

    virtual void setEpsilon(const GUM_SCALAR& e);

    virtual void setLimits(const GUM_SCALAR& newLowLimit,
                           const GUM_SCALAR& newHighLimit);

    virtual void setLowLimit(const GUM_SCALAR& newLowLimit);

    const GUM_SCALAR& lowLimit() const;

    virtual void setHighLimit(const GUM_SCALAR& newHighLimit);

    const GUM_SCALAR& highLimit() const;

    protected:
    GUM_SCALAR _lowLimit;

    GUM_SCALAR _highLimit;

    GUM_SCALAR _epsilon;

    Idx __encode(const GUM_SCALAR& value) const;

    GUM_SCALAR __decode(const GUM_SCALAR& representation) const;

    void _computeNbInterval();

    Idx _nbInterval;
  };
}   // namespace gum


#ifndef GUM_NO_EXTERN_TEMPLATE_CLASS
extern template class gum::LinearApproximationPolicy< double >;
#endif


// Always inline template classes implementation.
#include <agrum/core/approximations/linearApproximationPolicy_tpl.h>

#endif /* GUM_LINEAR_APPROXIMATION_POLICY_H */