MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Public Member Functions | List of all members
MoochoPack::NLPAlgoConfigMamaJama Class Reference

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

#include <MoochoPack_NLPAlgoConfigMamaJama.hpp>

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

Classes

struct  SOptionValues
 

Public Member Functions

 NLPAlgoConfigMamaJama ()
 
 ~NLPAlgoConfigMamaJama ()
 
- Public Member Functions inherited from MoochoPack::NLPAlgoConfig
virtual ~NLPAlgoConfig ()
 
void set_options (const options_ptr_t &options)
 Set the OptionsFromStream object that will be used for specifying the options. More...
 
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
 
enum  EHessianInitialization
 
enum  EQPSolverType
 
enum  ELineSearchMethod
 
enum  EMeritFunctionType
 
enum  EL1PenaltyParamUpdate
 

Detailed Description

This is a do all configuration class for NLPAlgo.

This class relies on the builder class DecompositionSystemStateStepBuilderStd to perform many different tasks.

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

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 This will result in smaller executables for programs that don't need this extra functionality..

ToDo: Finish documentation!

Definition at line 69 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

Member Enumeration Documentation

Definition at line 107 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

Definition at line 110 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

Definition at line 114 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

Definition at line 117 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

Definition at line 122 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

Definition at line 126 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

Constructor & Destructor Documentation

MoochoPack::NLPAlgoConfigMamaJama::NLPAlgoConfigMamaJama ( )

Definition at line 203 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

MoochoPack::NLPAlgoConfigMamaJama::~NLPAlgoConfigMamaJama ( )

Definition at line 206 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

Member Function Documentation

void MoochoPack::NLPAlgoConfigMamaJama::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 211 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

const NLPAlgoConfig::options_ptr_t & MoochoPack::NLPAlgoConfigMamaJama::get_options ( ) const
virtual

Implements MoochoPack::NLPAlgoConfig.

Definition at line 218 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

void MoochoPack::NLPAlgoConfigMamaJama::config_algo_cntr ( NLPAlgoContainer algo_cntr,
std::ostream *  trase_out 
)
virtual

Implements MoochoPack::NLPAlgoConfig.

Definition at line 223 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

void MoochoPack::NLPAlgoConfigMamaJama::init_algo ( NLPAlgoInterface algo)
virtual

Implements MoochoPack::NLPAlgoConfig.

Definition at line 1527 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.


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