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

#include <MoochoPack_CheckConvergence_Strategy.hpp>

Inheritance diagram for MoochoPack::CheckConvergence_StrategySetOptions:

Public Member Functions
	CheckConvergence_StrategySetOptions (CheckConvergence_Strategy *target=0, const char opt_grp_name[]="CheckConvergenceStrategy")

Public Member Functions inherited from OptionsFromStreamPack::SetOptionsFromStreamNode
	SetOptionsFromStreamNode (const std::string &options_group, int num_options, const char *option_names[], bool exists_optional=true)
	Constructs with the name of the options group and the names of the options. More...

void	set_options (const OptionsFromStream &options)
	Overridden from SetOptionsFromStream and calls setOption(...). More...

Public Member Functions inherited from OptionsFromStreamPack::SetOptionsFromStream
virtual	~SetOptionsFromStream ()

Public Member Functions inherited from OptionsFromStreamPack::SetOptionsToTargetBase< CheckConvergence_Strategy >
	SetOptionsToTargetBase (CheckConvergence_Strategy *target=0)

void	set_target (CheckConvergence_Strategy *target)

CheckConvergence_Strategy *	get_target ()

const CheckConvergence_Strategy *	get_target () const

CheckConvergence_Strategy &	target ()

const CheckConvergence_Strategy &	target () const

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

Detailed Description

Set options for CheckConvergence_Strategy from an OptionsFromStream object.

The default options group name is CheckConvergenceStrategy.

The options group is:

{verbatim} options_group CheckConvergenceStrategy { 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 154 of file MoochoPack_CheckConvergence_Strategy.hpp.

Constructor & Destructor Documentation

MoochoPack::CheckConvergence_StrategySetOptions::CheckConvergence_StrategySetOptions	(	CheckConvergence_Strategy *	target = `0`,
		const char	opt_grp_name[] = `"CheckConvergenceStrategy"`
	)

Definition at line 97 of file MoochoPack_CheckConvergence_Strategy.cpp.

Member Function Documentation

void MoochoPack::CheckConvergence_StrategySetOptions::setOption	(	int	option_num,
		const std::string &	option_value
	)

protectedvirtual

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.

Definition at line 108 of file MoochoPack_CheckConvergence_Strategy.cpp.

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

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation