MoochoPack::NLPAlgoConfigMamaJama Class Reference

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

#include <MoochoPack_NLPAlgoConfigMamaJama.hpp>

Inheritance diagram for MoochoPack::NLPAlgoConfigMamaJama:

[legend]List of all members.

Enums for variaous options categories
enum	EQuasiNewton
	More...
enum	EHessianInitialization
	More...
enum	EQPSolverType
	More...
enum	ELineSearchMethod
	More...
enum	EMeritFunctionType
	More...
enum	EL1PenaltyParamUpdate
	More...
void	set_options (const options_ptr_t &options)
	Set the OptionsFromStream object that will be used for specifying the options.
const options_ptr_t &	get_options () const
void	config_algo_cntr (NLPAlgoContainer *algo_cntr, std::ostream *trase_out)
void	init_algo (NLPAlgoInterface *algo)
Public Member Functions
	NLPAlgoConfigMamaJama ()
	~NLPAlgoConfigMamaJama ()
Classes
struct	SOptionValues
	More...

---

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 56 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

---

Member Enumeration Documentation

enum MoochoPack::NLPAlgoConfigMamaJama::EQuasiNewton

Definition at line 94 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

enum MoochoPack::NLPAlgoConfigMamaJama::EHessianInitialization

Definition at line 97 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

enum MoochoPack::NLPAlgoConfigMamaJama::EQPSolverType

Definition at line 101 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

enum MoochoPack::NLPAlgoConfigMamaJama::ELineSearchMethod

Definition at line 104 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

enum MoochoPack::NLPAlgoConfigMamaJama::EMeritFunctionType

Definition at line 109 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

enum MoochoPack::NLPAlgoConfigMamaJama::EL1PenaltyParamUpdate

Definition at line 113 of file MoochoPack_NLPAlgoConfigMamaJama.hpp.

---

Constructor & Destructor Documentation

MoochoPack::NLPAlgoConfigMamaJama::NLPAlgoConfigMamaJama

(

)

Definition at line 190 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

MoochoPack::NLPAlgoConfigMamaJama::~NLPAlgoConfigMamaJama

(

)

Definition at line 193 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

---

Member Function Documentation

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

const NLPAlgoConfig::options_ptr_t & MoochoPack::NLPAlgoConfigMamaJama::get_options

(

)

const [virtual]

Implements MoochoPack::NLPAlgoConfig.

Definition at line 205 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 210 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

void MoochoPack::NLPAlgoConfigMamaJama::init_algo

(

NLPAlgoInterface *

algo

)

[virtual]

Implements MoochoPack::NLPAlgoConfig.

Definition at line 1514 of file MoochoPack_NLPAlgoConfigMamaJama.cpp.

---

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

• MoochoPack_NLPAlgoConfigMamaJama.hpp
• MoochoPack_NLPAlgoConfigMamaJama.cpp

---