MoochoPack::NLPAlgoClientInterface Class Reference

Interface that smart clients use to set the algorithm configuration object that defines the rSQP algorithm to be used to solve the NLP. More...

#include <MoochoPack_NLPAlgoClientInterface.hpp>

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

List of all members.

Public Member Functions

virtual void configure_algorithm (std::ostream *trase_out=0)=0
 Causes the algorithm to be configured.
virtual void print_algorithm (std::ostream &out) const =0
 Print the configured algorithm.

Private Attributes

NLPAlgoConfigconfig
 

Public Types



typedef Teuchos::RCP
< NLPAlgoConfig
config_ptr_t
 

«std comp» members for config.



virtual void set_config (const config_ptr_t &config)=0
 
virtual config_ptr_tget_config ()=0
 
virtual const config_ptr_tget_config () const =0
 
virtual NLPAlgoConfigconfig ()=0
 
virtual const NLPAlgoConfigconfig () const =0
 

Detailed Description

Interface that smart clients use to set the algorithm configuration object that defines the rSQP algorithm to be used to solve the NLP.

ToDo: Finish documentation!

Definition at line 41 of file MoochoPack_NLPAlgoClientInterface.hpp.


Member Typedef Documentation

Definition at line 48 of file MoochoPack_NLPAlgoClientInterface.hpp.


Member Function Documentation

virtual void MoochoPack::NLPAlgoClientInterface::set_config ( const config_ptr_t config  )  [pure virtual]

virtual config_ptr_t& MoochoPack::NLPAlgoClientInterface::get_config (  )  [pure virtual]
virtual const config_ptr_t& MoochoPack::NLPAlgoClientInterface::get_config (  )  const [pure virtual]
virtual const NLPAlgoConfig& MoochoPack::NLPAlgoClientInterface::config (  )  const [pure virtual]
virtual void MoochoPack::NLPAlgoClientInterface::configure_algorithm ( std::ostream *  trase_out = 0  )  [pure virtual]

Causes the algorithm to be configured.

Causes the config object to configure the algorithm to be ready to solve an NLP or print the algorithm.

May be called after the nlp, track and config objects are set.

Must be called before print_algorithm() or find_min() are called.

Implemented in MoochoPack::NLPAlgoContainer.

virtual void MoochoPack::NLPAlgoClientInterface::print_algorithm ( std::ostream &  out  )  const [pure virtual]

Print the configured algorithm.

Implements MoochoPack::NLPSolverClientInterface.

Implemented in MoochoPack::NLPAlgoContainer.


Member Data Documentation

Definition at line 87 of file MoochoPack_NLPAlgoClientInterface.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:17:41 2011 for MOOCHO (Single Doxygen Collection) by  doxygen 1.6.3