OneDimensionOptimizationTools.h

Go to the documentation of this file.

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

#ifndef BPP_NUMERIC_FUNCTION_ONEDIMENSIONOPTIMIZATIONTOOLS_H
#define BPP_NUMERIC_FUNCTION_ONEDIMENSIONOPTIMIZATIONTOOLS_H


#include "../../Io/OutputStream.h"
#include "DirectionFunction.h"
#include "Functions.h"

namespace bpp
{
class BracketPoint
{
public:
  double x;
  double f;

public:
  // Constructor and destructor:
  BracketPoint() : x(0),
    f(0) {}
  BracketPoint(double xval, double fval) : x(xval),
    f(fval) {}
  virtual ~BracketPoint() {}

public:
  void set(double x, double f);
};

class Bracket
{
public:
  // Constructor and destructor::
  Bracket() : a(),
    b(),
    c() {}
  virtual ~Bracket() {}

public:
  // Methods:
  void setA(double xa, double fa);
  void setB(double xb, double fb);
  void setC(double xc, double fc);

public:
  BracketPoint a, b, c;
};

class OneDimensionOptimizationTools
{
public:
  OneDimensionOptimizationTools() {}
  virtual ~OneDimensionOptimizationTools() {}

public:
  static Bracket bracketMinimum(double a, double b, FunctionInterface& function, ParameterList parameters);

  static Bracket inwardBracketMinimum(double a, double b, FunctionInterface& function, ParameterList parameters, unsigned int intervalsNum = 10);


  static unsigned int lineMinimization(
      std::shared_ptr<DirectionFunction> f1dim,
      ParameterList& parameters,
      std::vector<double>& xi,
      double tolerance,
      std::shared_ptr<OutputStream> profiler = nullptr,
      std::shared_ptr<OutputStream> messenger = nullptr,
      unsigned int verbose = 2);

  static unsigned int lineSearch(
      std::shared_ptr<DirectionFunction> f1dim,
      ParameterList& parameters,
      std::vector<double>& xi,
      std::vector<double>& gradient,
      std::shared_ptr<OutputStream> profiler = nullptr,
      std::shared_ptr<OutputStream> messenger = nullptr,
      unsigned int verbose = 2);

public:
  static double GLIMIT;
};
} // end of namespace bpp.
#endif // BPP_NUMERIC_FUNCTION_ONEDIMENSIONOPTIMIZATIONTOOLS_H