MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
Classes | Public Member Functions
MoochoPack::NLPAlgoConfigIP Class Reference

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

#include <MoochoPack_NLPAlgoConfigIP.hpp>

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

List of all members.

Classes

struct  SOptionValues
  More...

Public Member Functions

 NLPAlgoConfigIP ()
 
 ~NLPAlgoConfigIP ()
 
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)
 

Enums for variaous options categories

enum  EQuasiNewton
  More...
enum  EHessianInitialization
  More...
enum  EQPSolverType
  More...
enum  ELineSearchMethod
  More...
enum  EMeritFunctionType
  More...
enum  EL1PenaltyParamUpdate
  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 63 of file MoochoPack_NLPAlgoConfigIP.hpp.


Member Enumeration Documentation

Definition at line 101 of file MoochoPack_NLPAlgoConfigIP.hpp.

Definition at line 104 of file MoochoPack_NLPAlgoConfigIP.hpp.

Definition at line 108 of file MoochoPack_NLPAlgoConfigIP.hpp.

Definition at line 111 of file MoochoPack_NLPAlgoConfigIP.hpp.

Definition at line 116 of file MoochoPack_NLPAlgoConfigIP.hpp.

Definition at line 120 of file MoochoPack_NLPAlgoConfigIP.hpp.


Constructor & Destructor Documentation

MoochoPack::NLPAlgoConfigIP::NLPAlgoConfigIP ( )

Definition at line 177 of file MoochoPack_NLPAlgoConfigIP.cpp.

MoochoPack::NLPAlgoConfigIP::~NLPAlgoConfigIP ( )

Definition at line 180 of file MoochoPack_NLPAlgoConfigIP.cpp.


Member Function Documentation

void MoochoPack::NLPAlgoConfigIP::set_options ( const options_ptr_t options) [virtual]

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

Overridden from NLPAlgoConfig

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.

Implements MoochoPack::NLPAlgoConfig.

Definition at line 185 of file MoochoPack_NLPAlgoConfigIP.cpp.

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

Implements MoochoPack::NLPAlgoConfig.

Definition at line 192 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 197 of file MoochoPack_NLPAlgoConfigIP.cpp.

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

Implements MoochoPack::NLPAlgoConfig.

Definition at line 1269 of file MoochoPack_NLPAlgoConfigIP.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends