MoochoPack::NLPAlgoConfigIP Class Reference

This is a do all configuration class for NLPAlgo. More...

#include <MoochoPack_NLPAlgoConfigIP.hpp>

Inheritance diagram for MoochoPack::NLPAlgoConfigIP:

[legend]
List of all members.

Enums for variaous options categories

enum  EQuasiNewton {
  QN_AUTO, QN_BFGS, QN_PBFGS, QN_LBFGS,
  QN_LPBFGS
}
  More...
enum  EHessianInitialization {
  INIT_HESS_AUTO, INIT_HESS_IDENTITY, INIT_HESS_FIN_DIFF_SCALE_IDENTITY, INIT_HESS_FIN_DIFF_SCALE_DIAGONAL,
  INIT_HESS_FIN_DIFF_SCALE_DIAGONAL_ABS
}
  More...
enum  EQPSolverType {
  QP_AUTO, QP_QPSOL, QP_QPOPT, QP_QPKWIK,
  QP_QPSCHUR
}
  More...
enum  ELineSearchMethod {
  LINE_SEARCH_AUTO, LINE_SEARCH_NONE, LINE_SEARCH_DIRECT, LINE_SEARCH_2ND_ORDER_CORRECT,
  LINE_SEARCH_WATCHDOG, LINE_SEARCH_FILTER
}
  More...
enum  EMeritFunctionType { MERIT_FUNC_AUTO, MERIT_FUNC_L1, MERIT_FUNC_MOD_L1, MERIT_FUNC_MOD_L1_INCR }
  More...
enum  EL1PenaltyParamUpdate { L1_PENALTY_PARAM_AUTO, L1_PENALTY_PARAM_WITH_MULT, L1_PENALTY_PARAM_MULT_FREE }
  More...
void set_options (const options_ptr_t &options)
 Set the OptionsFromStream object that will be used for specifying the options.
const options_ptr_tget_options () const
 
void config_algo_cntr (NLPAlgoContainer *algo_cntr, std::ostream *trase_out)
 
void init_algo (NLPAlgoInterface *algo)
 

Public Member Functions

 NLPAlgoConfigIP ()
 
 ~NLPAlgoConfigIP ()
 

Static Private Member Functions

static void readin_options (const OptionsFromStreamPack::OptionsFromStream &options, SOptionValues *option_values, std::ostream *trase_out)
 Read in the options from a stream.
static void set_default_options (const SOptionValues &user_option_values, SOptionValues *current_option_values, std::ostream *trase_out)
 Set the defaults for options not set by the user.

Private Attributes

DecompositionSystemStateStepBuilderStd decomp_sys_step_builder_
 Builder class for some common code.
options_ptr_t options_
 Smart pointer to options.
SOptionValues uov_
 Options structs.
SOptionValues cov_

Classes

struct  SOptionValues
  More...

Detailed Description

This is a do all configuration class for NLPAlgo.

Options specific for to this configuration class and the classes that it works with that can be set through this->set_options(), see the file Moocho.opt.NLPAlgoConfigIP.

Note that all built-in support for basis permutations and direct sparse solvers can be left out if the macro MOOCHO_NO_BASIS_PERM_DIRECT_SOLVERS is defined.

ToDo: Finish documentation!

Definition at line 50 of file MoochoPack_NLPAlgoConfigIP.hpp.


Member Enumeration Documentation

enum MoochoPack::NLPAlgoConfigIP::EQuasiNewton

Enumerator:
QN_AUTO 
QN_BFGS 
QN_PBFGS 
QN_LBFGS 
QN_LPBFGS 

Definition at line 88 of file MoochoPack_NLPAlgoConfigIP.hpp.

enum MoochoPack::NLPAlgoConfigIP::EHessianInitialization

Enumerator:
INIT_HESS_AUTO 
INIT_HESS_IDENTITY 
INIT_HESS_FIN_DIFF_SCALE_IDENTITY 
INIT_HESS_FIN_DIFF_SCALE_DIAGONAL 
INIT_HESS_FIN_DIFF_SCALE_DIAGONAL_ABS 

Definition at line 91 of file MoochoPack_NLPAlgoConfigIP.hpp.

enum MoochoPack::NLPAlgoConfigIP::EQPSolverType

Enumerator:
QP_AUTO 
QP_QPSOL 
QP_QPOPT 
QP_QPKWIK 
QP_QPSCHUR 

Definition at line 95 of file MoochoPack_NLPAlgoConfigIP.hpp.

enum MoochoPack::NLPAlgoConfigIP::ELineSearchMethod

Enumerator:
LINE_SEARCH_AUTO 
LINE_SEARCH_NONE 
LINE_SEARCH_DIRECT 
LINE_SEARCH_2ND_ORDER_CORRECT 
LINE_SEARCH_WATCHDOG 
LINE_SEARCH_FILTER 

Definition at line 98 of file MoochoPack_NLPAlgoConfigIP.hpp.

enum MoochoPack::NLPAlgoConfigIP::EMeritFunctionType

Enumerator:
MERIT_FUNC_AUTO 
MERIT_FUNC_L1 
MERIT_FUNC_MOD_L1 
MERIT_FUNC_MOD_L1_INCR 

Definition at line 103 of file MoochoPack_NLPAlgoConfigIP.hpp.

enum MoochoPack::NLPAlgoConfigIP::EL1PenaltyParamUpdate

Enumerator:
L1_PENALTY_PARAM_AUTO 
L1_PENALTY_PARAM_WITH_MULT 
L1_PENALTY_PARAM_MULT_FREE 

Definition at line 107 of file MoochoPack_NLPAlgoConfigIP.hpp.


Constructor & Destructor Documentation

MoochoPack::NLPAlgoConfigIP::NLPAlgoConfigIP (  ) 

Definition at line 164 of file MoochoPack_NLPAlgoConfigIP.cpp.

MoochoPack::NLPAlgoConfigIP::~NLPAlgoConfigIP (  ) 

Definition at line 167 of file MoochoPack_NLPAlgoConfigIP.cpp.


Member Function Documentation

void MoochoPack::NLPAlgoConfigIP::set_options ( const options_ptr_t options  ) 

Set the OptionsFromStream object that will be used for specifying the options.

Parameters:
options [in] If NULL then no options will be set. If !=NULL then this is the OptionsFromStream object that will be used to extract the options to use for the algorithm. The state of this object must be maintained by the client until config_algo_cntr() is called and it is at this point that the options are read.

Definition at line 172 of file MoochoPack_NLPAlgoConfigIP.cpp.

const NLPAlgoConfig::options_ptr_t & MoochoPack::NLPAlgoConfigIP::get_options (  )  const [virtual]

Implements MoochoPack::NLPAlgoConfig.

Definition at line 179 of file MoochoPack_NLPAlgoConfigIP.cpp.

void MoochoPack::NLPAlgoConfigIP::config_algo_cntr ( NLPAlgoContainer algo_cntr,
std::ostream *  trase_out 
) [virtual]

*****************************************************

*****************************************************

***********************************************************

***********************************************************

Implements MoochoPack::NLPAlgoConfig.

Definition at line 184 of file MoochoPack_NLPAlgoConfigIP.cpp.

void MoochoPack::NLPAlgoConfigIP::init_algo ( NLPAlgoInterface algo  )  [virtual]

Implements MoochoPack::NLPAlgoConfig.

Definition at line 1256 of file MoochoPack_NLPAlgoConfigIP.cpp.

void MoochoPack::NLPAlgoConfigIP::readin_options ( const OptionsFromStreamPack::OptionsFromStream options,
SOptionValues option_values,
std::ostream *  trase_out 
) [static, private]

Read in the options from a stream.

Definition at line 1288 of file MoochoPack_NLPAlgoConfigIP.cpp.

void MoochoPack::NLPAlgoConfigIP::set_default_options ( const SOptionValues user_option_values,
SOptionValues current_option_values,
std::ostream *  trase_out 
) [static, private]

Set the defaults for options not set by the user.

Definition at line 1514 of file MoochoPack_NLPAlgoConfigIP.cpp.


Member Data Documentation

DecompositionSystemStateStepBuilderStd MoochoPack::NLPAlgoConfigIP::decomp_sys_step_builder_ [private]

Builder class for some common code.

Definition at line 143 of file MoochoPack_NLPAlgoConfigIP.hpp.

options_ptr_t MoochoPack::NLPAlgoConfigIP::options_ [private]

Smart pointer to options.

Definition at line 146 of file MoochoPack_NLPAlgoConfigIP.hpp.

SOptionValues MoochoPack::NLPAlgoConfigIP::uov_ [private]

Options structs.

Definition at line 149 of file MoochoPack_NLPAlgoConfigIP.hpp.

SOptionValues MoochoPack::NLPAlgoConfigIP::cov_ [private]

Definition at line 150 of file MoochoPack_NLPAlgoConfigIP.hpp.


The documentation for this class was generated from the following files:
Generated on Tue Oct 20 12:54:14 2009 for MOOCHO (Single Doxygen Collection) by doxygen 1.4.7