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

Minimizer of a real valued function using the header-only library LBFGS++. More...

#include <Real_value_function_minimizer_LBFGS.hpp>

Classes

class  Function
 

Public Types

typedef T_Real_value_function_minimizer_LBFGS< PointType, RealValueFunction, GradientFunction > Self
 
typedef PointType Point
 
typedef SBL::Models::T_Conformation_traits< PointConformation_traits
 
typedef Conformation_traits::FT FT
 

Constructors

 T_Real_value_function_minimizer_LBFGS (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 SBL::CSB::T_Real_value_function_minimizer_LBFGS< PointType, RealValueFunction, GradientFunction >

Minimizer of a real valued function using the header-only library LBFGS++.

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.

Member Typedef Documentation

◆ Conformation_traits

◆ FT

typedef Conformation_traits::FT FT

◆ Point

typedef PointType Point

◆ Self

typedef T_Real_value_function_minimizer_LBFGS<PointType, RealValueFunction, GradientFunction> Self

Constructor & Destructor Documentation

◆ T_Real_value_function_minimizer_LBFGS()

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