AbstractOptimizer.h

Go to the documentation of this file.

//
// File: AbstractOptimizer.h
// Created by: Julien Dutheil
// Created on: Mon Dec 22 12:18:09 2003
//

/*
Copyright or © or Copr. Bio++ Development Team, (November 17, 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 _ABSTRACTOPTIMIZER_H_
#define _ABSTRACTOPTIMIZER_H_

#include "Optimizer.h"

namespace bpp
{

class AbstractOptimizer:
  public virtual Optimizer
{
  private:
    
    Function* function_;
  
    ParameterList parameters_;
  
    OutputStream* messageHandler_;
  
    OutputStream* profiler_;
    
    std::string constraintPolicy_;
    
    OptimizationStopCondition* stopCondition_;
    
    OptimizationStopCondition* defaultStopCondition_;

    unsigned int verbose_;

    bool isInitialized_;

    time_t startTime_;

    std::vector<OptimizationListener*> listeners_;

    bool updateParameters_;

    std::string stepChar_;

  protected:

    unsigned int nbEvalMax_;
    
    unsigned int nbEval_;

    double currentValue_;

    bool tolIsReached_;

  public:
    AbstractOptimizer(Function* function = 0);

    AbstractOptimizer(const AbstractOptimizer& opt);
    
    AbstractOptimizer& operator=(const AbstractOptimizer& opt);

    virtual ~AbstractOptimizer()
    {
      delete stopCondition_;
      delete defaultStopCondition_;
    }
  
  public:
    
    void init(const ParameterList& params) throw (Exception);
    double step() throw (Exception);
    double optimize() throw (Exception);
    bool isInitialized() const { return isInitialized_; }
    const ParameterList& getParameters() const { return parameters_; }
  double getParameterValue(const std::string& name) const { return parameters_.getParameterValue(name); }
    void setFunction(Function* function)
    { 
      function_ = function;
      if (function) stopCondition_->init();
    }
    const Function* getFunction() const { return function_; }
    Function* getFunction() { return function_; }
    bool hasFunction() const { return function_ != 0; }
    double getFunctionValue() const throw (NullPointerException)
    {
      if (!function_) throw NullPointerException("AbstractOptimizer::getFunctionValue. No function associated to this optimizer.");
      return currentValue_;
    }
    
    void setMessageHandler(OutputStream* mh) { messageHandler_ = mh; }
    OutputStream* getMessageHandler() const { return messageHandler_; }
    void setProfiler(OutputStream* profiler) { profiler_ = profiler; }
    OutputStream* getProfiler() const { return profiler_; }

    unsigned int getNumberOfEvaluations() const { return nbEval_; }
    void setStopCondition(const OptimizationStopCondition& stopCondition)
    {
      stopCondition_ = dynamic_cast<OptimizationStopCondition*>(stopCondition.clone());
    }
    OptimizationStopCondition* getStopCondition() { return stopCondition_; }
    const OptimizationStopCondition* getStopCondition() const { return stopCondition_; }
    OptimizationStopCondition* getDefaultStopCondition() { return defaultStopCondition_; }
    const OptimizationStopCondition* getDefaultStopCondition() const { return defaultStopCondition_; }
    bool isToleranceReached() const { return tolIsReached_; }
    bool isMaximumNumberOfEvaluationsReached() const { return nbEval_ >= nbEvalMax_; }
    void setMaximumNumberOfEvaluations(unsigned int max) { nbEvalMax_ = max; }
    void setVerbose(unsigned int v) { verbose_ = v; }
    unsigned int getVerbose() const { return verbose_; }
    void setConstraintPolicy(const std::string& constraintPolicy) { constraintPolicy_ = constraintPolicy; }
    std::string getConstraintPolicy() const { return constraintPolicy_; }
    void addOptimizationListener(OptimizationListener* listener)
    {
      if (listener)
        listeners_.push_back(listener);
    }
    void updateParameters(bool yn) { updateParameters_ = yn; }

    bool updateParameters() const { return updateParameters_; }

    void setOptimizationProgressCharacter(const std::string& c) { stepChar_ = c; }
    const std::string& getOptimizationProgressCharacter() const { return stepChar_; }
  
  protected:

    virtual void doInit(const ParameterList& params) throw (Exception) = 0;
    
    virtual double doStep() throw (Exception) = 0;
    
    void autoParameter();
  
    void ignoreConstraints();
  
    void profile(double v);
  
    void profile(unsigned int v);
 
    void profile(const std::string& s);
  
    void profileln(double v);
  
    void profileln(unsigned int v);
 
    void profileln(const std::string& s);
  
    void printPoint(const ParameterList& params, double value);
    
    void printMessage(const std::string& message);

    void fireOptimizationInitializationPerformed(const OptimizationEvent& event);

    void fireOptimizationStepPerformed(const OptimizationEvent& event);

    bool listenerModifiesParameters() const;
  protected:
    ParameterList& getParameters_() { return parameters_; }
    Parameter& getParameter_(size_t i) { return parameters_[i]; }
    Function* getFunction_() { return function_; }
    void setDefaultStopCondition_(OptimizationStopCondition* osc)
    {
      defaultStopCondition_ = osc;
    }
  
};

} //end of namespace bpp.

#endif  //_ABSTRACTOPTIMIZER_H_