approximationScheme.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_H
#define GUM_APPROXIMATION_SCHEME_H

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

namespace gum {

  class ApproximationScheme : public IApproximationSchemeConfiguration {
    public:
    // ========================================================================
    // ========================================================================

    ApproximationScheme(bool v = false);

    virtual ~ApproximationScheme();

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

    void setEpsilon(double eps);

    double epsilon() const;

    void disableEpsilon();

    void enableEpsilon();

    bool isEnabledEpsilon() const;

    void setMinEpsilonRate(double rate);

    double minEpsilonRate() const;

    void disableMinEpsilonRate();

    void enableMinEpsilonRate();

    bool isEnabledMinEpsilonRate() const;

    void setMaxIter(Size max);

    Size maxIter() const;

    void disableMaxIter();

    void enableMaxIter();

    bool isEnabledMaxIter() const;

    void setMaxTime(double timeout);

    double maxTime() const;

    double currentTime() const;

    void disableMaxTime();

    void enableMaxTime();

    bool isEnabledMaxTime() const;

    void setPeriodSize(Size p);

    Size periodSize() const;

    void setVerbosity(bool v);

    bool verbosity() const;

    ApproximationSchemeSTATE stateApproximationScheme() const;

    Size nbrIterations() const;

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

    void initApproximationScheme();

    bool startOfPeriod();

    void updateApproximationScheme(unsigned int incr = 1);

    Size remainingBurnIn();

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

#endif   // GUM_APPROXIMATION_SCHEME_H