MOOCHO (Single Doxygen Collection) Version of the Day
Public Member Functions | Protected Member Functions
MoochoPack::CheckConvergenceStd_Strategy Class Reference

Implementation of CheckConvergence_Strategy interface. More...

#include <MoochoPack_CheckConvergenceStd_Strategy.hpp>

Inheritance diagram for MoochoPack::CheckConvergenceStd_Strategy:
Inheritance graph

List of all members.

Public Member Functions

 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)

Protected Member Functions

value_type CalculateScalingFactor (NLPAlgoState &state, EScaleKKTErrorBy scale_by) const

Overridden from CheckConvergence_Strategy

virtual bool Converged (Algorithm &_algo)
virtual void print_step (const Algorithm &_algo, std::ostream &out, const std::string &L) 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_CheckConvergenceStd_Strategy.hpp.

Constructor & Destructor Documentation

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 

Definition at line 65 of file MoochoPack_CheckConvergenceStd_Strategy.cpp.

Member Function Documentation

bool MoochoPack::CheckConvergenceStd_Strategy::Converged ( Algorithm _algo) [virtual]
void MoochoPack::CheckConvergenceStd_Strategy::print_step ( const Algorithm _algo,
std::ostream &  out,
const std::string &  L 
) const [virtual]
value_type MoochoPack::CheckConvergenceStd_Strategy::CalculateScalingFactor ( NLPAlgoState state,
EScaleKKTErrorBy  scale_by 
) const [protected]

Definition at line 279 of file MoochoPack_CheckConvergenceStd_Strategy.cpp.

The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines