MoochoPack::LineSearchWatchDog_Step Class Reference

Implements watchdog line search. More...

#include <MoochoPack_LineSearchWatchDog_Step.hpp>

List of all members.

Public Member Functions
void	set_direct_line_search (const Teuchos::RefCountPtr< DirectLineSearch_Strategy > &direct_line_search)
	<<std comp="">> members for direct_line_search
void	set_merit_func (const Teuchos::RefCountPtr< MeritFuncNLP > &merit_func)
	<<std comp="">> members for merit_func
void	eta (const value_type &eta)
	<<std member="" comp="">> members for the armijo fractional reduction parameter.
void	opt_kkt_err_threshold (const value_type &opt_kkt_err_threshold)
	<<std member="" comp="">> members for the threshold for opt_kkt_err before the watchdog procedure should kick-in.
void	feas_kkt_err_threshold (const value_type &feas_kkt_err_threshold)
	<<std member="" comp="">> members for the threshold for feas_kkt_err before the watchdog procedure should kick-in.
	LineSearchWatchDog_Step (const direct_line_search_ptr_t &direct_line_search=0, const merit_func_ptr_t &merit_func=0, value_type eta=1e-4, value_type opt_kkt_err_threshold=1e-1, value_type feas_kkt_err_threshold=1e-3)
bool	do_step (Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
void	print_step (const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const

---

Detailed Description

Implements watchdog line search.

The watchdog proceedure will only be considered when : opt_kkt_err_k <= opt_kkt_err_threshold && feas_kkt_err_k <= feas_kkt_err_threshold (see step listing). The default behavior is to never use the watchdog procedure.

Definition at line 48 of file MoochoPack_LineSearchWatchDog_Step.hpp.

---

Constructor & Destructor Documentation

MoochoPack::LineSearchWatchDog_Step::LineSearchWatchDog_Step (  const direct_line_search_ptr_t &  direct_line_search = 0, const merit_func_ptr_t &  merit_func = 0, value_type  eta = 1e-4, value_type  opt_kkt_err_threshold = 1e-1, value_type  feas_kkt_err_threshold = 1e-3 )

Definition at line 54 of file MoochoPack_LineSearchWatchDog_Step.cpp.

---

Member Function Documentation

void MoochoPack::LineSearchWatchDog_Step::set_direct_line_search (  const Teuchos::RefCountPtr< DirectLineSearch_Strategy > &  direct_line_search  )  [inline]

<<std comp="">> members for direct_line_search Definition at line 52 of file MoochoPack_LineSearchWatchDog_Step.hpp.

void MoochoPack::LineSearchWatchDog_Step::set_merit_func (  const Teuchos::RefCountPtr< MeritFuncNLP > &  merit_func  )  [inline]

<<std comp="">> members for merit_func Definition at line 55 of file MoochoPack_LineSearchWatchDog_Step.hpp.

void MoochoPack::LineSearchWatchDog_Step::eta (  const value_type &  eta  )  [inline]

<<std member="" comp="">> members for the armijo fractional reduction parameter. Definition at line 59 of file MoochoPack_LineSearchWatchDog_Step.hpp.

void MoochoPack::LineSearchWatchDog_Step::opt_kkt_err_threshold (  const value_type &  opt_kkt_err_threshold  )  [inline]

<<std member="" comp="">> members for the threshold for opt_kkt_err before the watchdog procedure should kick-in. Definition at line 64 of file MoochoPack_LineSearchWatchDog_Step.hpp.

void MoochoPack::LineSearchWatchDog_Step::feas_kkt_err_threshold (  const value_type &  feas_kkt_err_threshold  )  [inline]

<<std member="" comp="">> members for the threshold for feas_kkt_err before the watchdog procedure should kick-in. Definition at line 69 of file MoochoPack_LineSearchWatchDog_Step.hpp.

bool MoochoPack::LineSearchWatchDog_Step::do_step (  Algorithm &  algo, poss_type  step_poss, IterationPack::EDoStepType  type, poss_type  assoc_step_poss )

Definition at line 70 of file MoochoPack_LineSearchWatchDog_Step.cpp.

void MoochoPack::LineSearchWatchDog_Step::print_step (  const Algorithm &  algo, poss_type  step_poss, IterationPack::EDoStepType  type, poss_type  assoc_step_poss, std::ostream &  out, const std::string &  leading_str )  const

Definition at line 420 of file MoochoPack_LineSearchWatchDog_Step.cpp.

---

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

• MoochoPack_LineSearchWatchDog_Step.hpp
• MoochoPack_LineSearchWatchDog_Step.cpp

---