Structural Bioinformatics Library
Template C++ / Python API for developping structural bioinformatics applications.
T_Real_value_function_minimizer_Ipopt< PointType, RealValueFunction, GradientFunction, MinimizerConstraints > Class Template Reference

Minimizer of a real valued function. More...

#include <Real_value_function_minimizer_Ipopt.hpp>

Public Types

typedef T_Real_value_function_minimizer_Ipopt< PointType, RealValueFunction, GradientFunction, MinimizerConstraints > Self
 
typedef PointType Point
 

Constructors

 T_Real_value_function_minimizer_Ipopt (void)
 

Functors

std::pair< bool, Point * > operator() (const Point *p) const
 

Tuning Minimization

void set_tolerance (double tolerance)
 
void set_maximum_number_of_iterations (unsigned max_iter)
 
void set_verbose_mode (unsigned verbose_mode)
 

Detailed Description

template<class PointType, class RealValueFunction, class GradientFunction, class MinimizerConstraints = T_Minimizer_Ipopt_parameters_without_constraint<PointType, RealValueFunction, GradientFunction>>
class SBL::CSB::T_Real_value_function_minimizer_Ipopt< PointType, RealValueFunction, GradientFunction, MinimizerConstraints >

Minimizer of a real valued function.

Minimizer of a real valued function.

  \tparam PointType Point type argument of the real value function.

  \tparam RealValueFunction Functor taking a Point type and returning a value.

  \tparam GradientFunction Gradient of the function represented by RealValueFunction.

  \tparam MinimizerConstraints Constraints of the minimizer (default is without constraint).

Member Typedef Documentation

◆ Point

typedef PointType Point

◆ Self

typedef T_Real_value_function_minimizer_Ipopt<PointType, RealValueFunction, GradientFunction, MinimizerConstraints> Self

Constructor & Destructor Documentation

◆ T_Real_value_function_minimizer_Ipopt()

Member Function Documentation

◆ operator()()

std::pair< bool, PointType * > operator() ( const Point p) const
inline

◆ set_maximum_number_of_iterations()

void set_maximum_number_of_iterations ( unsigned  max_iter)
inline

◆ set_tolerance()

void set_tolerance ( double  tolerance)
inline

◆ set_verbose_mode()

void set_verbose_mode ( unsigned  verbose_mode)
inline