NLPInterfacePack: C++ Interfaces and Implementation for Non-Linear Programs  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Protected Member Functions | List of all members
NLPInterfacePack::CalcFiniteDiffProdSetOptions Class Reference

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

#include <NLPInterfacePack_CalcFiniteDiffProdSetOptions.hpp>

Inheritance diagram for NLPInterfacePack::CalcFiniteDiffProdSetOptions:
Inheritance graph
[legend]

Public Member Functions

 CalcFiniteDiffProdSetOptions (CalcFiniteDiffProd *target=0, const char opt_grp_name[]="CalcFiniteDiffProd")
 

Protected Member Functions

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

Detailed Description

Set options for CalcFiniteDiffProd from an OptionsFromStream object.

The default options group name is CalcFiniteDiffProd.

The options group is:

options_group CalcFiniteDiffProdSetOptions {
*    fd_method_order = FD_ORDER_ONE;
*    fd_method_order = FD_ORDER_TWO;
*    fd_method_order = FD_ORDER_TWO_CENTRAL;
*    fd_method_order = FD_ORDER_TWO_AUTO;
*    fd_method_order = FD_ORDER_FOUR;
*    fd_method_order = FD_ORDER_FOUR_CENTRAL;
*    fd_method_order = FD_ORDER_FOUR_AUTO; *** (Default)
*    fd_step_select = FD_STEP_ABSOLUTE; *** (Default)
*    fd_step_select = FD_STEP_RELATIVE;
*    fd_step_size = -1.0; *** (default)
*    fd_step_size_min = -1.0; *** (default)
*    fd_step_size_f = -1.0; *** (default)
*    fd_step_size_c = -1.0; *** (default)
}

Definition at line 76 of file NLPInterfacePack_CalcFiniteDiffProdSetOptions.hpp.

Constructor & Destructor Documentation

NLPInterfacePack::CalcFiniteDiffProdSetOptions::CalcFiniteDiffProdSetOptions ( CalcFiniteDiffProd target = 0,
const char  opt_grp_name[] = "CalcFiniteDiffProd" 
)

Member Function Documentation

void NLPInterfacePack::CalcFiniteDiffProdSetOptions::setOption ( int  option_num,
const std::string &  option_value 
)
protectedvirtual

Overridden from SetOptionsFromStreamNode.

Implements OptionsFromStreamPack::SetOptionsFromStreamNode.

Definition at line 83 of file NLPInterfacePack_CalcFiniteDiffProdSetOptions.cpp.


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