BrentOneDimension.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: The Bio++ Development Group
//
// SPDX-License-Identifier: CECILL-2.1

#ifndef BPP_NUMERIC_FUNCTION_BRENTONEDIMENSION_H
#define BPP_NUMERIC_FUNCTION_BRENTONEDIMENSION_H


#include "AbstractOptimizer.h"

namespace bpp
{
class BrentOneDimension :
  public AbstractOptimizer
{
public:
  class BODStopCondition :
    public AbstractOptimizationStopCondition
  {
public:
    BODStopCondition(BrentOneDimension* bod) :
      AbstractOptimizationStopCondition(bod)
    {
      tolerance_ = bod->tol2;
      burnin_ = 3;
    }
    virtual ~BODStopCondition() {}

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

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

  enum Bracketing
  {
    BRACKET_OUTWARD = 0,
    BRACKET_INWARD = 1
  };

  friend class BODStopCondition;

protected:
  double a, b, d, e, etemp, fu, fv, fw, fx, p, q, r, tol1, tol2, u, v, w, x, xm;
  double _xinf, _xsup;
  bool isInitialIntervalSet_;
  Bracketing bracketing_;

public:
  BrentOneDimension(std::shared_ptr<FunctionInterface> function = nullptr);
  virtual ~BrentOneDimension() {}

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

public:
  double optimize(); // redefinition
  void doInit(const ParameterList& params);

  double doStep();

public:
  void setInitialInterval(double inf, double sup);
  bool isInitialIntervalSet() const { return isInitialIntervalSet_; }

  BrentOneDimension::Bracketing getBracketing() const { return bracketing_; }

  void setBracketing(BrentOneDimension::Bracketing bracketing)  { bracketing_ = bracketing; }

public:
  static double ZEPS;
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_FUNCTION_BRENTONEDIMENSION_H