OptimizationStopCondition.h

Go to the documentation of this file.

//
// File: OptimizationStopCondition.h
// Created by: Julien Dutheil
// Created on: Tue Dec 23 11:51:31 2003
//

/*
  Copyright or © or Copr. Bio++ Development Team, (November 19, 2004)

  This software is a computer program whose purpose is to provide classes
  for numerical calculus.

  This software is governed by the CeCILL  license under French law and
  abiding by the rules of distribution of free software.  You can  use, 
  modify and/ or redistribute the software under the terms of the CeCILL
  license as circulated by CEA, CNRS and INRIA at the following URL
  "http://www.cecill.info". 

  As a counterpart to the access to the source code and  rights to copy,
  modify and redistribute granted by the license, users are provided only
  with a limited warranty  and the software's author,  the holder of the
  economic rights,  and the successive licensors  have only  limited
  liability. 

  In this respect, the user's attention is drawn to the risks associated
  with loading,  using,  modifying and/or developing or reproducing the
  software by the user in light of its specific status of free software,
  that may mean  that it is complicated to manipulate,  and  that  also
  therefore means  that it is reserved for developers  and  experienced
  professionals having in-depth computer knowledge. Users are therefore
  encouraged to load and test the software's suitability as regards their
  requirements in conditions enabling the security of their systems and/or 
  data to be ensured and,  more generally, to use and operate it in the 
  same conditions as regards security. 

  The fact that you are presently reading this means that you have had
  knowledge of the CeCILL license and that you accept its terms.
*/

#ifndef _OPTIMIZATIONSTOPCONDITION_H_
#define _OPTIMIZATIONSTOPCONDITION_H_

#include "../ParameterList.h"

using namespace std;

namespace bpp
{

  class Optimizer;
  
  /******************************************************************************/

  class OptimizationStopCondition:
    public virtual Clonable
  {
  public:
    OptimizationStopCondition() {}
    virtual ~OptimizationStopCondition() {}

#ifndef NO_VIRTUAL_COV
    OptimizationStopCondition *
#else
    Clonable*
#endif
    clone() const = 0;
  
  public:

    virtual const Optimizer* getOptimizer() const = 0;
    virtual void setOptimizer(const Optimizer* optimizer) = 0;

    virtual void init() = 0;

    virtual bool isToleranceReached() const = 0;
    
    virtual void setTolerance(double tolerance) = 0;

    virtual double getTolerance() const = 0;
    
    virtual double getCurrentTolerance() const = 0;
  };

  /******************************************************************************/

  class AbstractOptimizationStopCondition:
    public virtual OptimizationStopCondition
  {
  protected:
    const Optimizer* optimizer_;
    double tolerance_;

    mutable double callCount_;
  
    int burnin_;
  
  public:
    AbstractOptimizationStopCondition(const Optimizer* optimizer):
        optimizer_(optimizer),
        tolerance_(0.000001),
        callCount_(0),
        burnin_(0) {}
    
    AbstractOptimizationStopCondition(const Optimizer* optimizer, double tolerance):
        optimizer_(optimizer),
        tolerance_(tolerance),
        callCount_(0),
        burnin_(0) {}

    AbstractOptimizationStopCondition(const Optimizer* optimizer, int burnin):
        optimizer_(optimizer),
        tolerance_(0.000001),
        callCount_(0),
        burnin_(burnin) {}

    AbstractOptimizationStopCondition(const Optimizer* optimizer, double tolerance, int burnin):
        optimizer_(optimizer),
        tolerance_(tolerance),
        callCount_(0),
        burnin_(burnin) {}

    AbstractOptimizationStopCondition(const AbstractOptimizationStopCondition& aosc):
        optimizer_(aosc.optimizer_),
        tolerance_(aosc.tolerance_),
        callCount_(aosc.callCount_),
        burnin_(aosc.burnin_) {}
  
    AbstractOptimizationStopCondition& operator=(const AbstractOptimizationStopCondition& aosc)
    {
      optimizer_ = aosc.optimizer_;
      tolerance_ = aosc.tolerance_;
      callCount_ = aosc.callCount_;
      burnin_    = aosc.burnin_;
      return *this;
    }

    virtual ~AbstractOptimizationStopCondition() {}

  public:
    const Optimizer* getOptimizer() const { return optimizer_; }
    void setOptimizer(const Optimizer* optimizer) { optimizer_ = optimizer; }
    void setTolerance(double tolerance) { tolerance_ = tolerance; }
    double getTolerance() const { return tolerance_; }
    void init() { resetCounter(); }
    virtual void resetCounter() { callCount_ = 0; }
    virtual void setBurnin(int burnin) { burnin_ = burnin; }
    virtual int getBurnin() const { return burnin_; }

  };
  
  /******************************************************************************/

  class ParametersStopCondition:
    public AbstractOptimizationStopCondition
  {
  private:

    mutable ParameterList lastParametersEstimates_;
    
    mutable ParameterList newParametersEstimates_;
  
  public:
    ParametersStopCondition(const Optimizer* optimizer);
    ParametersStopCondition(const Optimizer* optimizer, double tolerance);
    ParametersStopCondition(const Optimizer* optimizer, int burnin);
    ParametersStopCondition(const Optimizer* optimizer, double tolerance, int burnin);
    
    virtual ~ParametersStopCondition() {}

    ParametersStopCondition* clone() const { return new ParametersStopCondition(*this); }
  
  public:
    void init();

    bool isToleranceReached() const;
    
    double getCurrentTolerance() const;
  };

  /******************************************************************************/

  class FunctionStopCondition:
    public AbstractOptimizationStopCondition
  {
  private:
    mutable double lastFunctionValue_;
    
    mutable double newFunctionValue_;
  
  public:
    FunctionStopCondition(const Optimizer* optimizer);
    FunctionStopCondition(const Optimizer* optimizer, double tolerance);
    FunctionStopCondition(const Optimizer* optimizer, int burnin);
    FunctionStopCondition(const Optimizer* optimizer, double tolerance, int burnin);
    
    virtual ~FunctionStopCondition();

#ifndef NO_VIRTUAL_COV
    FunctionStopCondition*
#else
    Clonable*
#endif
    clone() const { return new FunctionStopCondition(*this); }
  
  public:
    void init();
    bool isToleranceReached() const;
    double getCurrentTolerance() const;

  };

} //end of namespace bpp.

#endif  //_OPTIMIZATIONSTOPCONDITION_H_