MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | List of all members
MoochoPack::MeritFunc_ModifiedL1LargerSteps_AddedStepSetOptions Class Reference

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

#include <MoochoPack_MeritFunc_ModifiedL1LargerSteps_AddedStepSetOptions.hpp>

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

Public Member Functions

 MeritFunc_ModifiedL1LargerSteps_AddedStepSetOptions (MeritFunc_ModifiedL1LargerSteps_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_ModifiedL1LargerSteps_AddedStep >
 SetOptionsToTargetBase (MeritFunc_ModifiedL1LargerSteps_AddedStep *target=0)
 
void set_target (MeritFunc_ModifiedL1LargerSteps_AddedStep *target)
 
MeritFunc_ModifiedL1LargerSteps_AddedStep * get_target ()
 
const
MeritFunc_ModifiedL1LargerSteps_AddedStep * 
get_target () const
 
MeritFunc_ModifiedL1LargerSteps_AddedStep & target ()
 
const
MeritFunc_ModifiedL1LargerSteps_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_ModifiedL1LargerSteps_AddedStep from a OptionsFromStream object.

The options group is:

{verbatim} options_group MeritFuncModifiedL1LargerSteps { after_k_iter = 3; obj_increase_threshold = 1e-3; max_pos_penalty_increase = 1.0; pos_to_neg_penalty_increase = 1.0; incr_mult_factor = 1e-4; } {verbatim}

{description} [after_k_iter] ToDo : Finish. Example: after_k_iter = 4; [obj_increase_threshold] ToDo : Finish. Example: obj_increase_threshold = 1e-4; [max_pos_penalty_increase] ToDo : Finish. Example: max_pos_penalty_increase = 1.0; [pos_to_neg_penalty_increase] ToDo : Finish. Example: pos_to_neg_penalty_increase = 1.0; [incr_mult_factor] ToDo : Finish. Example: incr_mult_factor = 1e-4; {description}

Definition at line 79 of file MoochoPack_MeritFunc_ModifiedL1LargerSteps_AddedStepSetOptions.hpp.

Constructor & Destructor Documentation

MoochoPack::MeritFunc_ModifiedL1LargerSteps_AddedStepSetOptions::MeritFunc_ModifiedL1LargerSteps_AddedStepSetOptions ( MeritFunc_ModifiedL1LargerSteps_AddedStep target = 0)

Member Function Documentation

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

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.


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