MoochoPack::CheckConvergenceIP_Strategy Class Reference

Implementation of CheckConvergence_Strategy interface. More...

#include <MoochoPack_CheckConvergenceIP_Strategy.hpp>

Inheritance diagram for MoochoPack::CheckConvergenceIP_Strategy:

Public Member Functions
	CheckConvergenceIP_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)
Public Member Functions inherited from MoochoPack::CheckConvergenceStd_Strategy
	CheckConvergenceStd_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)
Public Member Functions inherited from MoochoPack::CheckConvergence_Strategy
	STANDARD_MEMBER_COMPOSITION_MEMBERS (EOptErrorCheck, opt_error_check)
	<<std member="" comp>="">> members for whether to check the reduced or full gradient of the Lagrangian. More...
	STANDARD_MEMBER_COMPOSITION_MEMBERS (EScaleKKTErrorBy, scale_opt_error_by)
	<<std member="" comp>="">> members for how the optimality condition should be scaled More...
	STANDARD_MEMBER_COMPOSITION_MEMBERS (EScaleKKTErrorBy, scale_feas_error_by)
	<<std member="" comp>="">> members for how the feasibility condition should be scaled More...
	STANDARD_MEMBER_COMPOSITION_MEMBERS (EScaleKKTErrorBy, scale_comp_error_by)
	<<std member="" comp>="">> members for how the complimentarity condition should be scaled More...
	STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, scale_opt_error_by_Gf)
	<<std member="" comp>="">> members for whether the optimality conditions should be scaled by the More...
	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)

Overridden from CheckConvergenceStd_Strategy
virtual bool	Converged (Algorithm &_algo)
virtual void	print_step (const Algorithm &_algo, std::ostream &out, const std::string &L) const

Additional Inherited Members
Public Types inherited from MoochoPack::CheckConvergence_Strategy
enum	EOptErrorCheck { OPT_ERROR_REDUCED_GRADIENT_LAGR, OPT_ERROR_GRADIENT_LAGR }
enum	EScaleKKTErrorBy { SCALE_BY_ONE, SCALE_BY_NORM_2_X, SCALE_BY_NORM_INF_X }
Protected Member Functions inherited from MoochoPack::CheckConvergenceStd_Strategy
value_type	CalculateScalingFactor (NLPAlgoState &state, EScaleKKTErrorBy scale_by) const

Detailed Description

Implementation of CheckConvergence_Strategy interface.

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 58 of file MoochoPack_CheckConvergenceIP_Strategy.hpp.

Constructor & Destructor Documentation

MoochoPack::CheckConvergenceIP_Strategy::CheckConvergenceIP_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 59 of file MoochoPack_CheckConvergenceIP_Strategy.cpp.

Member Function Documentation

bool MoochoPack::CheckConvergenceIP_Strategy::Converged ( Algorithm &  _algo )

virtual

Reimplemented from MoochoPack::CheckConvergenceStd_Strategy.

Definition at line 76 of file MoochoPack_CheckConvergenceIP_Strategy.cpp.

void MoochoPack::CheckConvergenceIP_Strategy::print_step ( const Algorithm &  _algo, std::ostream &  out, const std::string &  L  ) const

virtual

Reimplemented from MoochoPack::CheckConvergenceStd_Strategy.

Definition at line 184 of file MoochoPack_CheckConvergenceIP_Strategy.cpp.

---

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

• MoochoPack_CheckConvergenceIP_Strategy.hpp
• MoochoPack_CheckConvergenceIP_Strategy.cpp