GoldenSectionSearch.h

Go to the documentation of this file.

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

#ifndef BPP_NUMERIC_FUNCTION_GOLDENSECTIONSEARCH_H
#define BPP_NUMERIC_FUNCTION_GOLDENSECTIONSEARCH_H


#include "AbstractOptimizer.h"

namespace bpp
{
class GoldenSectionSearch :
  public AbstractOptimizer
{
public:
  class GSSStopCondition :
    public AbstractOptimizationStopCondition
  {
public:
    GSSStopCondition(GoldenSectionSearch* gss) :
      AbstractOptimizationStopCondition(gss) {}
    virtual ~GSSStopCondition() {}

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

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

  friend class GSSStopCondition;

private:
  double f1, f2, x0, x1, x2, x3;
  double xinf_, xsup_;
  bool isInitialIntervalSet_;

public:
  GoldenSectionSearch(std::shared_ptr<FunctionInterface> function);
  virtual ~GoldenSectionSearch() {}

  GoldenSectionSearch* clone() const override { return new GoldenSectionSearch(*this); }

public:
  double getFunctionValue() const override;
  void doInit(const ParameterList& params) override;

  double doStep() override;

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

protected:
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_FUNCTION_GOLDENSECTIONSEARCH_H