linearApproximationPolicy.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2026 by                                             *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *                                                                          *
 *   The aGrUM/pyAgrum library is free software; you can redistribute it    *
 *   and/or modify it under the terms of either :                           *
 *                                                                          *
 *    - the GNU Lesser General Public License as published by               *
 *      the Free Software Foundation, either version 3 of the License,      *
 *      or (at your option) any later version,                              *
 *    - the MIT license (MIT),                                              *
 *    - or both in dual license, as here.                                   *
 *                                                                          *
 *   (see https://agrum.gitlab.io/articles/dual-licenses-lgplv3mit.html)    *
 *                                                                          *
 *   This aGrUM/pyAgrum library is distributed in the hope that it will be  *
 *   useful, but WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,          *
 *   INCLUDING BUT NOT LIMITED TO THE WARRANTIES MERCHANTABILITY or FITNESS *
 *   FOR A PARTICULAR PURPOSE  AND NONINFRINGEMENT. IN NO EVENT SHALL THE   *
 *   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *
 *   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,        *
 *   ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR  *
 *   OTHER DEALINGS IN THE SOFTWARE.                                        *
 *                                                                          *
 *   See LICENCES for more details.                                         *
 *                                                                          *
 *   SPDX-FileCopyrightText: Copyright 2005-2026                            *
 *       - Pierre-Henri WUILLEMIN(_at_LIP6)                                 *
 *       - Christophe GONZALES(_at_AMU)                                     *
 *   SPDX-License-Identifier: LGPL-3.0-or-later OR MIT                      *
 *                                                                          *
 *   Contact  : info_at_agrum_dot_org                                       *
 *   homepage : http://agrum.gitlab.io                                      *
 *   gitlab   : https://gitlab.com/agrumery/agrum                           *
 *                                                                          *
 ****************************************************************************/
 

#ifndef GUM_LINEAR_APPROXIMATION_POLICY_H
#define GUM_LINEAR_APPROXIMATION_POLICY_H
 
#include <typeinfo>
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/approximations/approximationPolicy.h>
 
namespace gum {

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

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

    LinearApproximationPolicy(const LinearApproximationPolicy< GUM_ELEMENT >* md);

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

    GUM_ELEMENT fromExact(const GUM_ELEMENT& value) const override;

    void combineAdd(const ApproximationPolicy< GUM_ELEMENT >* ap) override;

    void combineSub(const ApproximationPolicy< GUM_ELEMENT >* ap) override;

    void combineMult(const ApproximationPolicy< GUM_ELEMENT >* ap) override;

    void combineDiv(const ApproximationPolicy< GUM_ELEMENT >* ap) override;

    void combineMax(const ApproximationPolicy< GUM_ELEMENT >* ap) override;

    void combineMin(const ApproximationPolicy< GUM_ELEMENT >* ap) override;

    GUM_ELEMENT safeFromExact(const GUM_ELEMENT& value);

    Idx encode(const GUM_ELEMENT& value) const;

    GUM_ELEMENT decode(Idx representation) const;

    virtual void setEpsilon(const GUM_ELEMENT& e);

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

    virtual void setLowLimit(const GUM_ELEMENT& newLowLimit);

    const GUM_ELEMENT& lowLimit() const;

    virtual void setHighLimit(const GUM_ELEMENT& newHighLimit);

    const GUM_ELEMENT& highLimit() const;
 
    protected:
    GUM_ELEMENT lowLimit_;

    GUM_ELEMENT highLimit_;

    GUM_ELEMENT epsilon_;

    Idx _encode_(const GUM_ELEMENT& value) const;

    GUM_ELEMENT _decode_(const GUM_ELEMENT& 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/base/core/approximations/linearApproximationPolicy_tpl.h>
 
#endif /* GUM_LINEAR_APPROXIMATION_POLICY_H */