MetaOptimizer.h

Go to the documentation of this file.

//
// File: MetaOptimizer.h
// Created by: Julien Dutheil
// Created on: Fri Oct 12 16:05 2007
// From file: NewtonBrentMetaOptimizer.h
// Created on: Tue Nov 17 17:22 2004
// 
//

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

  This software is a computer program whose purpose is to provide classes
  for phylogenetic data analysis.

  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 METAOPTIMIZER_H__
#define METAOPTIMIZER_H__

#include "AbstractOptimizer.h"

// From the STL:
#include <vector>

namespace bpp
{

  class MetaOptimizerInfos:
    public virtual Clonable
  {
  public:
    static std::string IT_TYPE_STEP;
    static std::string IT_TYPE_FULL;

  private:
    std::vector<std::string> names_;
    std::vector<Optimizer*> optimizers_;
    std::vector< std::vector<std::string> > parameterNames_;
    std::vector<unsigned short> derivatives_;
    std::vector<std::string> itTypes_;

  public:
    MetaOptimizerInfos() : names_(), optimizers_(), parameterNames_(), derivatives_(), itTypes_() {}
    MetaOptimizerInfos(const MetaOptimizerInfos& infos) :
      names_(infos.names_),
      optimizers_(infos.optimizers_),
      parameterNames_(infos.parameterNames_),
      derivatives_(infos.derivatives_),
      itTypes_(infos.itTypes_)
    {
      for (unsigned int i = 0; i < optimizers_.size(); i++)
        optimizers_[i] = dynamic_cast<Optimizer*>(infos.optimizers_[i]->clone());
    }

    MetaOptimizerInfos& operator=(const MetaOptimizerInfos& infos)
    {
      names_          = infos.names_;
      optimizers_     = infos.optimizers_;
      parameterNames_ = infos.parameterNames_;
      derivatives_    = infos.derivatives_;
      itTypes_        = infos.itTypes_;
      for (unsigned int i = 0; i < optimizers_.size(); i++)
        optimizers_[i] = dynamic_cast<Optimizer *>(infos.optimizers_[i]->clone());
      return *this;
    }

    virtual ~MetaOptimizerInfos()
    {
      for(unsigned int i = 0; i < optimizers_.size(); i++)
        delete optimizers_[i];
    }

  public:
#ifndef NO_VIRTUAL_COV
    MetaOptimizerInfos* clone() const { return new MetaOptimizerInfos(*this); }
#else
    Clonable* clone() const { return new MetaOptimizerInfos(*this); }
#endif

  public:
    virtual void addOptimizer(const std::string & name, Optimizer * optimizer, const std::vector<std::string> & params, unsigned short derivatives = 0, const std::string & type = IT_TYPE_STEP)
    {
      names_.push_back(name);
      optimizers_.push_back(optimizer);
      parameterNames_.push_back(params);
      derivatives_.push_back(derivatives);
      itTypes_.push_back(type);
    }

    virtual const std::string& getName(size_t i) const { return names_[i]; }
    
    virtual Optimizer* getOptimizer(size_t i) { return optimizers_[i]; }
    virtual const Optimizer* getOptimizer(size_t i) const { return optimizers_[i]; }

    virtual std::vector<std::string>& getParameterNames(size_t i) { return parameterNames_[i]; }
    virtual const std::vector<std::string>& getParameterNames(size_t i) const { return parameterNames_[i]; }

    virtual std::string& getIterationType(size_t i) { return itTypes_[i]; }
    virtual const std::string& getIterationType(size_t i) const { return itTypes_[i]; }

    virtual bool requiresFirstOrderDerivatives(size_t i) const { return derivatives_[i] > 0; }  
    virtual bool requiresSecondOrderDerivatives(size_t i) const { return derivatives_[i] > 1; }  

    virtual size_t getNumberOfOptimizers() const { return optimizers_.size(); }
  };

  class MetaOptimizer:
    public AbstractOptimizer
  {
  private:
    MetaOptimizerInfos* optDesc_;
    std::vector<ParameterList> optParameters_;
    std::vector<size_t> nbParameters_;
    unsigned int n_;
    double precisionStep_;
    unsigned int stepCount_;
    double initialValue_;
    
  public:
    MetaOptimizer(Function* function, MetaOptimizerInfos* desc, unsigned int n = 1);

    virtual ~MetaOptimizer();

    MetaOptimizer(const MetaOptimizer& opt);

    MetaOptimizer& operator=(const MetaOptimizer& opt);

    MetaOptimizer* clone() const { return new MetaOptimizer(*this); }

  public:
    
    void setFunction(Function* function)
    { 
      AbstractOptimizer::setFunction(function);
      for(unsigned int i = 0; i < optDesc_->getNumberOfOptimizers(); i++)
        optDesc_->getOptimizer(i)->setFunction(function);
    }

    void doInit(const ParameterList& parameters) throw (Exception);
    
    double doStep() throw (Exception);

    MetaOptimizerInfos* getOptimizers() { return optDesc_; }
    
    const MetaOptimizerInfos* getOptimizers() const { return optDesc_; }

  };

} //end of namespace bpp.

#endif //METAOPTIMIZER_H__