DirectionFunction.h

Go to the documentation of this file.

//
// File: DirectionFunction.h
// Authors:
//   Julien Dutheil
// Created: 2007-04-11 17:28:00
//
 
/*
  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 BPP_NUMERIC_FUNCTION_DIRECTIONFUNCTION_H
#define BPP_NUMERIC_FUNCTION_DIRECTIONFUNCTION_H
 
 
#include "../../App/ApplicationTools.h"
#include "../../Io/OutputStream.h"
#include "../AutoParameter.h"
#include "../Parametrizable.h"
#include "Functions.h"
 
namespace bpp
{
class DirectionFunction :
  public Function,
  public ParametrizableAdapter
{
private:
  mutable ParameterList params_, p_, xt_;
  std::vector<double> xi_;
  Function* function_;
  std::string constraintPolicy_;
  OutputStream* messenger_;
 
public:
  DirectionFunction(Function* function = 0) :
    params_(), p_(), xt_(), xi_(),
    function_(function), constraintPolicy_(AutoParameter::CONSTRAINTS_KEEP),
    messenger_(ApplicationTools::message.get()) {}
 
  DirectionFunction(const DirectionFunction& df) :
    ParametrizableAdapter(df), params_(df.params_), p_(df.p_), xt_(df.p_), xi_(df.xi_),
    function_(df.function_), constraintPolicy_(df.constraintPolicy_), messenger_(df.messenger_) {}
 
  DirectionFunction& operator=(const DirectionFunction& df)
  {
    ParametrizableAdapter::operator=(df);
    params_ = df.params_;
    p_ = df.p_;
    xt_ = df.p_;
    xi_ = df.xi_;
    function_ = df.function_;
    constraintPolicy_ = df.constraintPolicy_;
    messenger_ = df.messenger_;
    return *this;
  }
 
  virtual ~DirectionFunction() {}
 
  DirectionFunction* clone() const { return new DirectionFunction(*this); }
 
public:
  // Function interface implementation:
  void setParameters(const ParameterList& parameters);
  double getValue() const;
  const ParameterList& getParameters() const;
 
public:
  // Specific methods:
  void init(const ParameterList& p, const std::vector<double>& xi);
  void autoParameter();
  void ignoreConstraints();
  void setConstraintPolicy(const std::string& constraintPolicy) { constraintPolicy_ = constraintPolicy; }
  std::string getConstraintPolicy() const { return constraintPolicy_; }
  void setMessageHandler(OutputStream* messenger) { messenger_ = messenger; }
  Function* getFunction() const { return function_; }
  ParameterList getFunctionParameters() const { return p_; }
  size_t getNumberOfParameters() const { return p_.size(); }
 
protected:
  ParameterList& getParameters_();
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_FUNCTION_DIRECTIONFUNCTION_H