IApproximationSchemeConfiguration.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_CONFIGURATION_H
#define GUM_APPROXIMATION_SCHEME_CONFIGURATION_H
 
#include <agrum/agrum.h>
 
#include <agrum/base/core/signal/signalers.h>
#include <agrum/base/core/timer.h>
 
#include <agrum/base/core/math/math_utils.h>
 
namespace gum {

  class IApproximationSchemeConfiguration {
    public:
    Signaler3< Size, double, double > onProgress;

    Signaler1< const std::string& > onStop;

    enum class ApproximationSchemeSTATE : char {
      Undefined,
      Continue,
      Epsilon,
      Rate,
      Limit,
      TimeLimit,
      Stopped
    };
 
    // ======================================================================
    // ======================================================================

    IApproximationSchemeConfiguration();

    virtual ~IApproximationSchemeConfiguration();
 
    // ======================================================================
    // ======================================================================

    std::string messageApproximationScheme() const;

    virtual void setEpsilon(double eps) = 0;

    virtual double epsilon() const = 0;

    virtual void disableEpsilon() = 0;

    virtual void enableEpsilon() = 0;

    virtual bool isEnabledEpsilon() const = 0;

    virtual void setMinEpsilonRate(double rate) = 0;

    virtual double minEpsilonRate() const = 0;

    virtual void disableMinEpsilonRate() = 0;

    virtual void enableMinEpsilonRate() = 0;

    virtual bool isEnabledMinEpsilonRate() const = 0;

    virtual void setMaxIter(Size max) = 0;

    virtual Size maxIter() const = 0;

    virtual void disableMaxIter() = 0;

    virtual void enableMaxIter() = 0;

    virtual bool isEnabledMaxIter() const = 0;

    virtual void setMaxTime(double timeout) = 0;

    virtual double maxTime() const = 0;

    virtual double currentTime() const = 0;

    virtual void disableMaxTime() = 0;

    virtual void enableMaxTime() = 0;

    virtual bool isEnabledMaxTime() const = 0;

    virtual void setPeriodSize(Size p) = 0;

    virtual Size periodSize() const = 0;

    virtual void setVerbosity(bool v) = 0;

    virtual bool verbosity() const = 0;

    virtual ApproximationSchemeSTATE stateApproximationScheme() const = 0;

    virtual Size nbrIterations() const = 0;

    virtual const std::vector< double >& history() const = 0;
  };
}   // namespace gum
 
#ifndef GUM_NO_INLINE
#  include <agrum/base/core/approximations/IApproximationSchemeConfiguration_inl.h>
#endif
 
#endif   // GUM_APPROXIMATION_SCHEME_CONFIGURATION_H