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:

[legend]List of all members.

Public Types
typedef Teuchos::RefCountPtr< NLPAlgoConfig >	config_ptr_t
«std comp» members for config.
virtual void	set_config (const config_ptr_t &config)=0
virtual config_ptr_t &	get_config ()=0
virtual const config_ptr_t &	get_config () const =0
virtual NLPAlgoConfig &	config ()=0
virtual const NLPAlgoConfig &	config () const =0
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.

---

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

typedef Teuchos::RefCountPtr<NLPAlgoConfig> MoochoPack::NLPAlgoClientInterface::config_ptr_t

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]

Implemented in MoochoPack::NLPAlgoContainer.

virtual config_ptr_t& MoochoPack::NLPAlgoClientInterface::get_config (   )  [pure virtual]

Implemented in MoochoPack::NLPAlgoContainer.

virtual const config_ptr_t& MoochoPack::NLPAlgoClientInterface::get_config (   )  const [pure virtual]

Implemented in MoochoPack::NLPAlgoContainer.

virtual NLPAlgoConfig& MoochoPack::NLPAlgoClientInterface::config (   )  [pure virtual]

Implemented in MoochoPack::NLPAlgoContainer.

virtual const NLPAlgoConfig& MoochoPack::NLPAlgoClientInterface::config (   )  const [pure virtual]

Implemented in MoochoPack::NLPAlgoContainer.

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.

---

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

• MoochoPack_NLPAlgoClientInterface.hpp

---