MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
List of all members
MoochoPack::CheckConvergenceStd_Strategy Class Reference

Implementation of CheckConvergence_Strategy interface. More...

#include <MoochoPack_CheckConvergenceStd_Strategy.hpp>

Inheritance diagram for MoochoPack::CheckConvergenceStd_Strategy:
Inheritance graph
[legend]

Overridden from CheckConvergence_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 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)
 

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.

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

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