MoochoPack::CheckConvergence_Strategy Class Reference

Strategy interface for performing convergence checks. More...

#include <MoochoPack_CheckConvergence_Strategy.hpp>

Inheritance diagram for MoochoPack::CheckConvergence_Strategy:

[legend]List of all members.

Public Member Functions
void	opt_error_check (const EOptErrorCheck &opt_error_check)
	<<std member="" comp="">> members for whether to check the reduced or full gradient of the Lagrangian.
void	scale_opt_error_by (const EScaleKKTErrorBy &scale_opt_error_by)
	<<std member="" comp="">> members for how the optimality condition should be scaled
void	scale_feas_error_by (const EScaleKKTErrorBy &scale_feas_error_by)
	<<std member="" comp="">> members for how the feasibility condition should be scaled
void	scale_comp_error_by (const EScaleKKTErrorBy &scale_comp_error_by)
	<<std member="" comp="">> members for how the complimentarity condition should be scaled
void	scale_opt_error_by_Gf (const bool &scale_opt_error_by_Gf)
	<<std member="" comp="">> members for whether the optimality conditions should be scaled by the
	CheckConvergence_Strategy (EOptErrorCheck opt_error_check=OPT_ERROR_REDUCED_GRADIENT_LAGR, EScaleKKTErrorBy scale_opt_error_by=SCALE_BY_ONE, EScaleKKTErrorBy scale_feas_error_by=SCALE_BY_ONE, EScaleKKTErrorBy scale_comp_error_by=SCALE_BY_ONE, bool scale_opt_error_by_Gf=true)
	*******************************************
virtual bool	Converged (Algorithm &_algo)=0
virtual void	print_step (const Algorithm &_algo, std::ostream &out, const std::string &L) const =0

---

Detailed Description

Strategy interface for performing convergence checks.

This object can not change the flow of control or do anything fancy. It just checks convergence by calculating norm errors and comparing with tolerance It can update iteration quantities if desired.

See the printed documentation generated by this->print_step().

Definition at line 47 of file MoochoPack_CheckConvergence_Strategy.hpp.

---

Constructor & Destructor Documentation

MoochoPack::CheckConvergence_Strategy::CheckConvergence_Strategy (  EOptErrorCheck  opt_error_check = OPT_ERROR_REDUCED_GRADIENT_LAGR, EScaleKKTErrorBy  scale_opt_error_by = SCALE_BY_ONE, EScaleKKTErrorBy  scale_feas_error_by = SCALE_BY_ONE, EScaleKKTErrorBy  scale_comp_error_by = SCALE_BY_ONE, bool  scale_opt_error_by_Gf = true )

******************************************* Definition at line 41 of file MoochoPack_CheckConvergence_Strategy.cpp.

---

Member Function Documentation

void MoochoPack::CheckConvergence_Strategy::opt_error_check (  const EOptErrorCheck &  opt_error_check  )  [inline]

<<std member="" comp="">> members for whether to check the reduced or full gradient of the Lagrangian. Definition at line 60 of file MoochoPack_CheckConvergence_Strategy.hpp.

void MoochoPack::CheckConvergence_Strategy::scale_opt_error_by (  const EScaleKKTErrorBy &  scale_opt_error_by  )  [inline]

<<std member="" comp="">> members for how the optimality condition should be scaled Definition at line 72 of file MoochoPack_CheckConvergence_Strategy.hpp.

void MoochoPack::CheckConvergence_Strategy::scale_feas_error_by (  const EScaleKKTErrorBy &  scale_feas_error_by  )  [inline]

<<std member="" comp="">> members for how the feasibility condition should be scaled Definition at line 78 of file MoochoPack_CheckConvergence_Strategy.hpp.

void MoochoPack::CheckConvergence_Strategy::scale_comp_error_by (  const EScaleKKTErrorBy &  scale_comp_error_by  )  [inline]

<<std member="" comp="">> members for how the complimentarity condition should be scaled Definition at line 84 of file MoochoPack_CheckConvergence_Strategy.hpp.

void MoochoPack::CheckConvergence_Strategy::scale_opt_error_by_Gf (  const bool &  scale_opt_error_by_Gf  )  [inline]

<<std member="" comp="">> members for whether the optimality conditions should be scaled by the Definition at line 90 of file MoochoPack_CheckConvergence_Strategy.hpp.

virtual bool MoochoPack::CheckConvergence_Strategy::Converged (  Algorithm &  _algo  )  [pure virtual]

Implemented in MoochoPack::CheckConvergenceIP_Strategy, and MoochoPack::CheckConvergenceStd_Strategy.

virtual void MoochoPack::CheckConvergence_Strategy::print_step (  const Algorithm &  _algo, std::ostream &  out, const std::string &  L )  const [pure virtual]

Implemented in MoochoPack::CheckConvergenceIP_Strategy, and MoochoPack::CheckConvergenceStd_Strategy.

---

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

• MoochoPack_CheckConvergence_Strategy.hpp
• MoochoPack_CheckConvergence_Strategy.cpp

---