core::optimization::LineMinimizationAlgorithm Class Reference

#include <LineMinimizer.hh>

Inheritance diagram for core::optimization::LineMinimizationAlgorithm:

Public Member Functions
	~LineMinimizationAlgorithm () override
	LineMinimizationAlgorithm (Multifunc const &score_fxn, Size dimension)
virtual Real	operator() (Multivec &, Multivec &)
virtual bool	provide_stored_derivatives ()
bool	nonmonotone ()
void	store_current_derivatives (Multivec &curr_derivs)
void	fetch_stored_derivatives (Multivec &get_derivs)
Real	quadratic_interpolation (Real point1, Real func1, Real deriv1, Real point2, Real func2)
Real	quadratic_deriv_interpolation (Real point1, Real func1, Real deriv1, Real point2, Real func2, Real deriv2)
Real	secant_interpolation (Real point1, Real deriv1, Real point2, Real deriv2)
Real	cubic_interpolation (Real point1, Real func1, Real deriv1, Real point2, Real func2, Real deriv2)
bool	silent ()
void	silent (bool s_in)

Public Attributes
Multivec	_stored_derivatives
Real	_last_accepted_step
Real	_func_to_beat
Real	_deriv_sum
int	_num_linemin_calls

Protected Attributes
Real const	_tolerance
Multifunc const &	_func
bool	_nonmonotone
bool	_silent

Constructor & Destructor Documentation

~LineMinimizationAlgorithm()

core::optimization::LineMinimizationAlgorithm::~LineMinimizationAlgorithm ( )

overridedefault

Auto-generated virtual destructor

LineMinimizationAlgorithm()

core::optimization::LineMinimizationAlgorithm::LineMinimizationAlgorithm ( Multifunc const &  score_fxn, Size  dimension  )

inline

Member Function Documentation

cubic_interpolation()

Real core::optimization::LineMinimizationAlgorithm::cubic_interpolation	(	Real	point1,
		Real	func1,
		Real	deriv1,
		Real	point2,
		Real	func2,
		Real	deriv2
	)

References protocols::cryst::denom(), and protocols::mean_field::max().

fetch_stored_derivatives()

void core::optimization::LineMinimizationAlgorithm::fetch_stored_derivatives

(

Multivec &

get_derivs

)

nonmonotone()

bool core::optimization::LineMinimizationAlgorithm::nonmonotone ( )

inline

References _nonmonotone.

Referenced by core::optimization::ArmijoLineMinimization::ArmijoLineMinimization().

operator()()

virtual Real core::optimization::LineMinimizationAlgorithm::operator() ( Multivec &  , Multivec &    )

inlinevirtual

Reimplemented in core::optimization::StrongWolfeLineMinimization, core::optimization::ArmijoLineMinimization, and core::optimization::BrentLineMinimization.

provide_stored_derivatives()

virtual bool core::optimization::LineMinimizationAlgorithm::provide_stored_derivatives ( )

inlinevirtual

Reimplemented in core::optimization::StrongWolfeLineMinimization, and core::optimization::ArmijoLineMinimization.

quadratic_deriv_interpolation()

Real core::optimization::LineMinimizationAlgorithm::quadratic_deriv_interpolation	(	Real	point1,
		Real	func1,
		Real	deriv1,
		Real	point2,
		Real	func2,
		Real	deriv2
	)

quadratic_interpolation()

Real core::optimization::LineMinimizationAlgorithm::quadratic_interpolation	(	Real	point1,
		Real	func1,
		Real	deriv1,
		Real	point2,
		Real	func2
	)

secant_interpolation()

Real core::optimization::LineMinimizationAlgorithm::secant_interpolation	(	Real	point1,
		Real	deriv1,
		Real	point2,
		Real	deriv2
	)

silent() [1/2]

bool core::optimization::LineMinimizationAlgorithm::silent ( )

inline

References _silent.

silent() [2/2]

void core::optimization::LineMinimizationAlgorithm::silent ( bool  s_in )

inline

References _silent.

store_current_derivatives()

void core::optimization::LineMinimizationAlgorithm::store_current_derivatives

(

Multivec &

curr_derivs

)

Member Data Documentation

_deriv_sum

Real core::optimization::LineMinimizationAlgorithm::_deriv_sum

_func

Multifunc const& core::optimization::LineMinimizationAlgorithm::_func

protected

_func_to_beat

Real core::optimization::LineMinimizationAlgorithm::_func_to_beat

_last_accepted_step

Real core::optimization::LineMinimizationAlgorithm::_last_accepted_step

_nonmonotone

bool core::optimization::LineMinimizationAlgorithm::_nonmonotone

protected

Referenced by core::optimization::ArmijoLineMinimization::ArmijoLineMinimization(), and nonmonotone().

_num_linemin_calls

int core::optimization::LineMinimizationAlgorithm::_num_linemin_calls

_silent

bool core::optimization::LineMinimizationAlgorithm::_silent

protected

Referenced by silent().

_stored_derivatives

Multivec core::optimization::LineMinimizationAlgorithm::_stored_derivatives

_tolerance

Real const core::optimization::LineMinimizationAlgorithm::_tolerance

protected

---

The documentation for this class was generated from the following files:

• src/core/optimization/LineMinimizer.hh
• src/core/optimization/LineMinimizer.cc