|
MOOCHO (Single Doxygen Collection)
Version of the Day
|
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
|
MOOCHO (Single Doxygen Collection)
Version of the Day
|
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>
Public Member Functions | |
| virtual void | configure_algorithm (std::ostream *trase_out=0)=0 |
| Causes the algorithm to be configured. More... | |
| virtual void | print_algorithm (std::ostream &out) const =0 |
| Print the configured algorithm. More... | |
 Public Member Functions inherited from MoochoPack::NLPSolverClientInterface | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (int, max_iter) | |
| Set the maximum number of iterations the rSQP algorithm can perform. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (double, max_run_time) | |
| Set the maximum run_time. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (value_type, opt_tol) | |
| Set the termination tolerance for the relative (scaled) linear dependence of the gradients part of the first order necessary optimality conditions. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (value_type, feas_tol) | |
| Set the termination tolerance for the (scaled) equality constraints ||c(x*)||inf which is part of the first order necessary optimality conditions. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (value_type, comp_tol) | |
| Set the termination tolerance for the complementarity condition for the (scaled) bound constraints which is part of the first order necessary optimality conditions. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (value_type, step_tol) | |
| Set the termination tolerance for the change in the estimate of the solution. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (EJournalOutputLevel, journal_output_level) | |
| Determine the amount of output to a journal file. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (EJournalOutputLevel, null_space_journal_output_level) | |
| Determine the amount of output of the null space to a journal file. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (int, journal_print_digits) | |
| Set the precesion of the journal output. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, check_results) | |
| Set whether computations will be double checked or not. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, calc_conditioning) | |
| Set whether the condition numbers of important matrics is computed and printed or not. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, calc_matrix_norms) | |
| Set whether or not matrix norms are computed and printed. More... | |
| STANDARD_MEMBER_COMPOSITION_MEMBERS (bool, calc_matrix_info_null_space_only) | |
| Set whether calc_conditioning and calc_matrix_norms apply to only null space matrices. More... | |
| STANDARD_COMPOSITION_MEMBERS (NLP, nlp) | |
| <<std comp>="">> members for the nlp More... | |
| STANDARD_COMPOSITION_MEMBERS (AlgorithmTracker, track) | |
| <<std comp>="">> members for the track More... | |
| NLPSolverClientInterface (int max_iter=10000, double max_run_time=1e+10, value_type opt_tol=1e-6, value_type feas_tol=1e-6, value_type comp_tol=1e-6, value_type step_tol=1e-2, EJournalOutputLevel journal_output_level=PRINT_ALGORITHM_STEPS, EJournalOutputLevel null_space_journal_output_level=PRINT_ALGORITHM_STEPS, int journal_print_digits=6, bool check_results=false, bool calc_conditioning=false, bool calc_matrix_norms=false, bool calc_matrix_info_null_space_only=false) | |
| Construct with no references set to nlp or track objects. More... | |
| virtual | ~NLPSolverClientInterface () |
| virtual EFindMinReturn | find_min ()=0 |
| Find the minimun of the set NLP. More... | |
| virtual void | set_algo_timing (bool algo_timing)=0 |
| Causes algorithm to be timed. More... | |
| virtual bool | algo_timing () const =0 |
| virtual void | print_algorithm_times (std::ostream &out) const =0 |
| Outputs table of times for each step and the cummulative times. More... | |
Private Attributes | |
| NLPAlgoConfig * | config |
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_t & | get_config ()=0 |
| virtual const config_ptr_t & | get_config () const =0 |
| virtual NLPAlgoConfig & | config ()=0 |
| virtual const NLPAlgoConfig & | config () const =0 |
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 54 of file MoochoPack_NLPAlgoClientInterface.hpp.
Definition at line 61 of file MoochoPack_NLPAlgoClientInterface.hpp.
|
pure virtual |
Implemented in MoochoPack::NLPAlgoContainer.
|
pure virtual |
Implemented in MoochoPack::NLPAlgoContainer.
|
pure virtual |
Implemented in MoochoPack::NLPAlgoContainer.
|
pure virtual |
Implemented in MoochoPack::NLPAlgoContainer.
|
pure virtual |
Implemented in MoochoPack::NLPAlgoContainer.
|
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.
|
pure virtual |
Print the configured algorithm.
Implements MoochoPack::NLPSolverClientInterface.
Implemented in MoochoPack::NLPAlgoContainer.
|
private |
Definition at line 100 of file MoochoPack_NLPAlgoClientInterface.hpp.
1.8.6