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::BFGSUpdate_StrategySetOptions Class Reference

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

#include <MoochoPack_BFGSUpdate_StrategySetOptions.hpp>

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

Public Member Functions

 BFGSUpdate_StrategySetOptions (BFGSUpdate_Strategy *target=0, const char opt_grp_name[]="BFGSUpdate")
 
- 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< BFGSUpdate_Strategy >
 SetOptionsToTargetBase (BFGSUpdate_Strategy *target=0)
 
void set_target (BFGSUpdate_Strategy *target)
 
BFGSUpdate_Strategy * get_target ()
 
const BFGSUpdate_Strategy * get_target () const
 
BFGSUpdate_Strategy & target ()
 
const BFGSUpdate_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 BFGSUpdate_Strategy from an OptionsFromStream object.

The default options group name is BFGSUpdate.

The options group is:

{verbatim} options_group BFGSUpdate { rescale_init_identity = true; use_dampening = true; secant_testing = DEFAULT; secant_testing = TEST; secant_testing = NO_TEST; secant_warning_tol = 1e-6; secant_error_tol = 1e-2; } {verbatim}

Definition at line 70 of file MoochoPack_BFGSUpdate_StrategySetOptions.hpp.

Constructor & Destructor Documentation

MoochoPack::BFGSUpdate_StrategySetOptions::BFGSUpdate_StrategySetOptions ( BFGSUpdate_Strategy target = 0,
const char  opt_grp_name[] = "BFGSUpdate" 
)

Definition at line 73 of file MoochoPack_BFGSUpdate_StrategySetOptions.cpp.

Member Function Documentation

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

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.

Definition at line 82 of file MoochoPack_BFGSUpdate_StrategySetOptions.cpp.


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