core::optimization::func_1d Class Reference

#include <LineMinimizer.hh>

Collaboration diagram for core::optimization::func_1d:

Public Member Functions
	func_1d (Multivec &start, Multivec &dir, Multifunc const &score_fxn)
Real	operator() (Real displacement)
Real	dfunc (Real displacement)
void	reset_eval_count ()
int	get_eval_count ()
int	get_deriv_count ()
void	dump (Real displacement)
	Error condition wherein the computed gradient does not match the actual gradient; invokes the Multifunc::dump( vars, vars2 ) method. More...

Public Attributes
Multivec	_dE_dvars

Private Attributes
Multivec const	_starting_point
Multivec const	_search_direction
Multivec	_eval_point
Multifunc const &	_func
int	_eval_count
int	_deriv_count
Real	_search_direction_magnitude

Detailed Description

Definition at line 39 of file LineMinimizer.hh.

Constructor & Destructor Documentation

core::optimization::func_1d::func_1d ( Multivec &  start, Multivec &  dir, Multifunc const &  score_fxn  )

inline

Definition at line 52 of file LineMinimizer.hh.

References _search_direction, and _starting_point.

Member Function Documentation

Real core::optimization::func_1d::dfunc ( Real  displacement)

inline

Definition at line 73 of file LineMinimizer.hh.

References _dE_dvars, _deriv_count, _eval_point, _func, _search_direction, _starting_point, and core::optimization::Multifunc::dfunc().

Referenced by core::optimization::StrongWolfeLineMinimization::StrongWolfe(), and core::optimization::StrongWolfeLineMinimization::zoom().

void core::optimization::func_1d::dump

(

Real

displacement)

Error condition wherein the computed gradient does not match the actual gradient; invokes the Multifunc::dump( vars, vars2 ) method.

Definition at line 56 of file LineMinimizer.cc.

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

int core::optimization::func_1d::get_deriv_count ( )

inline

Definition at line 88 of file LineMinimizer.hh.

References _deriv_count.

int core::optimization::func_1d::get_eval_count ( )

inline

Definition at line 87 of file LineMinimizer.hh.

References _eval_count.

Real core::optimization::func_1d::operator() ( Real  displacement)

inline

Definition at line 65 of file LineMinimizer.hh.

References _eval_count, _eval_point, _func, _search_direction, and _starting_point.

void core::optimization::func_1d::reset_eval_count ( )

inline

Definition at line 86 of file LineMinimizer.hh.

References _eval_count.

Member Data Documentation

Multivec core::optimization::func_1d::_dE_dvars

Definition at line 45 of file LineMinimizer.hh.

Referenced by dfunc(), and core::optimization::StrongWolfeLineMinimization::StrongWolfe().

int core::optimization::func_1d::_deriv_count

private

Definition at line 49 of file LineMinimizer.hh.

Referenced by dfunc(), and get_deriv_count().

int core::optimization::func_1d::_eval_count

private

Definition at line 48 of file LineMinimizer.hh.

Referenced by get_eval_count(), operator()(), and reset_eval_count().

Multivec core::optimization::func_1d::_eval_point

private

Definition at line 43 of file LineMinimizer.hh.

Referenced by dfunc(), and operator()().

Multifunc const& core::optimization::func_1d::_func

private

Definition at line 47 of file LineMinimizer.hh.

Referenced by dfunc(), and operator()().

Multivec const core::optimization::func_1d::_search_direction

private

Definition at line 42 of file LineMinimizer.hh.

Referenced by dfunc(), func_1d(), and operator()().

Real core::optimization::func_1d::_search_direction_magnitude

private

Definition at line 50 of file LineMinimizer.hh.

Multivec const core::optimization::func_1d::_starting_point

private

Definition at line 41 of file LineMinimizer.hh.

Referenced by dfunc(), func_1d(), and operator()().

---

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

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