approximationScheme.h

Go to the documentation of this file.

/****************************************************************************
 *   This file is part of the aGrUM/pyAgrum library.                        *
 *                                                                          *
 *   Copyright (c) 2005-2025 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-2025                            *
 *       - 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_APPROXIMATION_SCHEME_H
#define GUM_APPROXIMATION_SCHEME_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/approximations/IApproximationSchemeConfiguration.h>
 
namespace gum {

   *   }
   * }
   * // equivalent to
   * if (verbosity()) {
   *   GUM_TRACE(messageApproximationScheme());
   * }
   * @endcode
   */
  class ApproximationScheme: public IApproximationSchemeConfiguration {
    public:
    // ========================================================================
    // ========================================================================
 
    explicit ApproximationScheme(bool verbosity = false);
 
    virtual ~ApproximationScheme();

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

    void setEpsilon(double eps) override;

    double epsilon() const override;

    void disableEpsilon() override;

    void enableEpsilon() override;

    bool isEnabledEpsilon() const override;

    void setMinEpsilonRate(double rate) override;

    double minEpsilonRate() const override;

    void disableMinEpsilonRate() override;

    void enableMinEpsilonRate() override;

    bool isEnabledMinEpsilonRate() const override;

    void setMaxIter(Size max) override;

    Size maxIter() const override;

    void disableMaxIter() override;

    void enableMaxIter() override;

    bool isEnabledMaxIter() const override;

    void setMaxTime(double timeout) override;

    double maxTime() const override;

    double currentTime() const override;

    void disableMaxTime() override;

    void enableMaxTime() override;

    bool isEnabledMaxTime() const override;

    void setPeriodSize(Size p) override;

    Size periodSize() const override;

    void setVerbosity(bool v) override;

    bool verbosity() const override;

    ApproximationSchemeSTATE stateApproximationScheme() const override;

    Size nbrIterations() const override;

    const std::vector< double >& history() const override;

    void initApproximationScheme();

    bool startOfPeriod() const;

    void updateApproximationScheme(unsigned int incr = 1);

    Size remainingBurnIn() const;

    void stopApproximationScheme();

    bool continueApproximationScheme(double error);
 

 
    private:
    void stopScheme_(ApproximationSchemeSTATE new_state);
 
    protected:
    double current_epsilon_;

    double last_epsilon_;

    double current_rate_;

    Size current_step_;

    Timer timer_;

    ApproximationSchemeSTATE current_state_;

    std::vector< double > history_;

    double eps_;

    bool enabled_eps_;

    double min_rate_eps_;

    bool enabled_min_rate_eps_;

    double max_time_;

    bool enabled_max_time_;

    Size max_iter_;

    bool enabled_max_iter_;

    Size burn_in_;

    Size period_size_;

    bool verbosity_;
  };
}   // namespace gum
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/core/approximations/approximationScheme_inl.h>
#endif
 
#endif   // GUM_APPROXIMATION_SCHEME_H