IApproximationSchemeConfiguration.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Pierre-Henri WUILLEMIN et Christophe GONZALES   *
 *   {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_APPROXIMATION_SCHEME_CONFIGURATION_H
#define GUM_APPROXIMATION_SCHEME_CONFIGURATION_H

#include <agrum/agrum.h>
#include <agrum/core/math/math.h>
#include <agrum/core/signal/signaler.h>
#include <agrum/core/timer.h>

namespace gum {

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

    Signaler1< std::string > onStop;

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

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

    IApproximationSchemeConfiguration();

    ~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/core/approximations/IApproximationSchemeConfiguration_inl.h>
#endif

#endif   // GUM_APPROXIMATION_SCHEME_CONFIGURATION_H