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

#include <ConstrainedOptPack_DirectLineSearchArmQuad_StrategySetOptions.hpp>

Inheritance diagram for ConstrainedOptPack::DirectLineSearchArmQuad_StrategySetOptions:

Public Member Functions
	DirectLineSearchArmQuad_StrategySetOptions (DirectLineSearchArmQuad_Strategy *qp_solver=0, const char opt_grp_name[]="DirectLineSearchArmQuad")

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< DirectLineSearchArmQuad_Strategy >
	SetOptionsToTargetBase (DirectLineSearchArmQuad_Strategy *target=0)

void	set_target (DirectLineSearchArmQuad_Strategy *target)

DirectLineSearchArmQuad_Strategy *	get_target ()

const DirectLineSearchArmQuad_Strategy *	get_target () const

DirectLineSearchArmQuad_Strategy &	target ()

const DirectLineSearchArmQuad_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 DirectLineSearchArmQuad_Strategy from a OptionsFromStream object.

The default options group name is DirectLineSearchArmQuad.

The options group is:

{verbatim} options_group DirectLineSearchArmQuad { slope_frac = ?; min_frac_step = ?: max_frac_step = ?; max_ls_iter = ?; max_out_ls_iter = ?; } {verbatim}

{description} [slope_frac] Fraction of intial decent slope of merit function required by armijo test. Mapps to eta in linesearch algorithm. Must be in the range [0, 1]. Example: slope_frac = 1.0e-4; [min_frac_step] Minimum fractional change in the step length per linesearch iteration. Mapps to min_frac in the linesearch algorithm. Must be in the range (0, 1]. Example: min_frac_step = 0.1; [max_frac_step] Maximum fractional change in the step length per linesearch iteration. Mapps to max_frac in the linesearch algorithm. Must be in the range (0, 1]. Note that max_frac_step must be greater than min_frac_step. Example: min_frac_step = 0.5; [max_ls_iter] The maximum number of linesearch iterations to take before giving up and declaring a line search failure. Mapps to max_ls_iter in linesearch algorithm. Example: max_ls_iter = 20. [max_out_ls_iter] A flag to max out on line search iterations. Mostly just used for debugging, not very useful in general. {description}

Definition at line 90 of file ConstrainedOptPack_DirectLineSearchArmQuad_StrategySetOptions.hpp.

Constructor & Destructor Documentation

ConstrainedOptPack::DirectLineSearchArmQuad_StrategySetOptions::DirectLineSearchArmQuad_StrategySetOptions	(	DirectLineSearchArmQuad_Strategy *	qp_solver = `0`,
		const char	opt_grp_name[] = `"DirectLineSearchArmQuad"`
	)

Definition at line 72 of file ConstrainedOptPack_DirectLineSearchArmQuad_StrategySetOptions.cpp.

Member Function Documentation

void ConstrainedOptPack::DirectLineSearchArmQuad_StrategySetOptions::setOption	(	int	option_num,
		const std::string &	option_value
	)

protectedvirtual

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.

Definition at line 81 of file ConstrainedOptPack_DirectLineSearchArmQuad_StrategySetOptions.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