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

Set options for CheckConvergenceStd_AddedStep from an OptionsFromStream object. More...

#include <MoochoPack_CheckConvergenceStd_AddedStepSetOptions.hpp>

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

List of all members.

Public Member Functions

 CheckConvergenceStd_AddedStepSetOptions (CheckConvergenceStd_AddedStep *target=0, const char opt_grp_name[]="CheckConvergenceStd")
 

Protected Member Functions

void setOption (int option_num, const std::string &option_value)
 Overridden from SetOptionsFromStreamNode.

Detailed Description

Set options for CheckConvergenceStd_AddedStep from an OptionsFromStream object.

The default options group name is CheckConvergenceStd.

The options group is:

{verbatim} options_group CheckConvergenceStd { scale_kkt_error_by = SCALE_BY_ONE; scale_opt_error_by_Gf = true; } {verbatim}

{description} [scale_kkt_error_by] Determines if and how the optimality (opt_kkt_err) and feasiblity (feas_kkt_err) errors for the convergence check are scaled by for the unkowns x before comparing it to the set tolerances of opt_tol and feas_tol (see the class {CheckConvergenceStd_AddedStep} and its printed algorithm for more details). {description} [SCALE_BY_ONE] no scaling by x [SCALE_BY_NORM_2_X] scale opt_kkt_err and feas_kkt_err by 1/||x||2 [SCALE_BY_NORM_INF_X] scale opt_kkt_err and feas_kkt_err by 1/||x||inf {description} [scale_opt_error_by_Gf] Determines if opt_kkt_err is scaled by ||Gf_k||inf or not. {description}

Definition at line 81 of file MoochoPack_CheckConvergenceStd_AddedStepSetOptions.hpp.


Constructor & Destructor Documentation

MoochoPack::CheckConvergenceStd_AddedStepSetOptions::CheckConvergenceStd_AddedStepSetOptions ( CheckConvergenceStd_AddedStep target = 0,
const char  opt_grp_name[] = "CheckConvergenceStd" 
)


Member Function Documentation

void MoochoPack::CheckConvergenceStd_AddedStepSetOptions::setOption ( int  option_num,
const std::string &  option_value 
) [protected, virtual]

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.


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