MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStepSetOptions Class Reference

Set options for MeritFunc_PenaltyParamUpdate_AddedStep from a OptionsFromStream object. More...

#include <MoochoPack_MeritFunc_PenaltyParamUpdate_AddedStepSetOptions.hpp>

Inheritance diagram for MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStepSetOptions:

Public Member Functions
	MeritFunc_PenaltyParamUpdate_AddedStepSetOptions (MeritFunc_PenaltyParamUpdate_AddedStep *target=0)
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< MeritFunc_PenaltyParamUpdate_AddedStep >
	SetOptionsToTargetBase (MeritFunc_PenaltyParamUpdate_AddedStep *target=0)
void	set_target (MeritFunc_PenaltyParamUpdate_AddedStep *target)
MeritFunc_PenaltyParamUpdate_AddedStep *	get_target ()
const MeritFunc_PenaltyParamUpdate_AddedStep *	get_target () const
MeritFunc_PenaltyParamUpdate_AddedStep &	target ()
const MeritFunc_PenaltyParamUpdate_AddedStep &	target () const

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

Detailed Description

Set options for MeritFunc_PenaltyParamUpdate_AddedStep from a OptionsFromStream object.

The options group is:

 options_group MeritFuncPenaltyParamUpdate {
     small_mu     = 1e-6;
     min_mu_ratio = 1e-8;
     mult_factor  = 1e-4;
     kkt_near_sol = 1.0;
 }

• [small_mu] The smallest mu allows when away from the soltion.
  Example: small_mu = 1e-6;
• [min_mu_ratio] This bounds the smallest mu(i) as:
  min(mu(i))/max(mu(i)) >= min_mu_ratio.
  Example: min_mu_ratio = 1e-4;
• [mult_factor] Multiplicative factor for mu(j) = (1.0+mult_factor) * abs(lambda(j)).
  Example: mult_factor = 1e-4;
• [kkt_near_sol] When the total kkt_error is below kkt_near_sol a safer penalty update will be used.
  Example: kkt_near_sol = 1.0;

Definition at line 78 of file MoochoPack_MeritFunc_PenaltyParamUpdate_AddedStepSetOptions.hpp.

Constructor & Destructor Documentation

MoochoPack::MeritFunc_PenaltyParamUpdate_AddedStepSetOptions::MeritFunc_PenaltyParamUpdate_AddedStepSetOptions

(

MeritFunc_PenaltyParamUpdate_AddedStep *

target = 0

)

Definition at line 72 of file MoochoPack_MeritFunc_PenaltyParamUpdate_AddedStepSetOptions.cpp.

Member Function Documentation

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

protectedvirtual

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.

Definition at line 80 of file MoochoPack_MeritFunc_PenaltyParamUpdate_AddedStepSetOptions.cpp.

---

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

• MoochoPack_MeritFunc_PenaltyParamUpdate_AddedStepSetOptions.hpp
• MoochoPack_MeritFunc_PenaltyParamUpdate_AddedStepSetOptions.cpp