MOOCHO (Single Doxygen Collection) Version of the Day
Public Member Functions
MoochoPack::NLPAlgoInterface Class Reference

Interface NLPAlgoContainer uses to access NLPAlgo. More...

#include <MoochoPack_NLPAlgoInterface.hpp>

Inheritance diagram for MoochoPack::NLPAlgoInterface:
Inheritance graph

List of all members.

Public Member Functions

virtual ~NLPAlgoInterface ()
virtual void interface_print_algorithm (std::ostream &out) const =0
 Print the algorithm description.
dispatch ()=0
 Start the iterations.
virtual const NLPAlgoStateretrieve_state () const =0
 Return the state object.

Algorithm timing

virtual void interface_set_algo_timing (bool algo_timing)=0
virtual bool interface_algo_timing () const =0
virtual void interface_print_algorithm_times (std::ostream &out) const =0

Detailed Description

Interface NLPAlgoContainer uses to access NLPAlgo.

This interface helps avoid dangerous usage stategies for an NLPAlgo object.

Definition at line 54 of file MoochoPack_NLPAlgoInterface.hpp.

Constructor & Destructor Documentation

virtual MoochoPack::NLPAlgoInterface::~NLPAlgoInterface ( ) [inline, virtual]

Definition at line 58 of file MoochoPack_NLPAlgoInterface.hpp.

Member Function Documentation

virtual void MoochoPack::NLPAlgoInterface::interface_print_algorithm ( std::ostream &  out) const [pure virtual]

Print the algorithm description.

Implemented in MoochoPack::NLPAlgo.

virtual NLPSolverClientInterface::EFindMinReturn MoochoPack::NLPAlgoInterface::dispatch ( ) [pure virtual]

Start the iterations.

This function returns true if the solution was found and false if the maximum number of iterations was reached before the solution was found.

Implemented in MoochoPack::NLPAlgo.

virtual const NLPAlgoState& MoochoPack::NLPAlgoInterface::retrieve_state ( ) const [pure virtual]

Return the state object.

Implemented in MoochoPack::NLPAlgo.

virtual void MoochoPack::NLPAlgoInterface::interface_set_algo_timing ( bool  algo_timing) [pure virtual]

Implemented in MoochoPack::NLPAlgo.

virtual bool MoochoPack::NLPAlgoInterface::interface_algo_timing ( ) const [pure virtual]

Implemented in MoochoPack::NLPAlgo.

virtual void MoochoPack::NLPAlgoInterface::interface_print_algorithm_times ( std::ostream &  out) const [pure virtual]

Implemented in MoochoPack::NLPAlgo.

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