MOOCHO (Single Doxygen Collection)  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Private Member Functions | Private Attributes | List of all members
MoochoPack::NLPAlgoContainer Class Reference

Implementation for NLPAlgo solver. More...

#include <MoochoPack_NLPAlgoContainer.hpp>

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

Private Member Functions

void assert_valid_setup () const
 
 NLPAlgoContainer (const NLPAlgoContainer &)
 
NLPAlgoContaineroperator= (const NLPAlgoContainer &)
 

Private Attributes

config_ptr_t config_
 

Constructors / initializers

 STANDARD_COMPOSITION_MEMBERS (NLPAlgoInterface, algo)
 Members for <<std comp>="">> of the algorithm object algo. More...
 
 NLPAlgoContainer ()
 Construct a container with no configuration object set. More...
 

Overridden from NLPAlgoClientInterface

void set_config (const config_ptr_t &config)
 
config_ptr_tget_config ()
 
const config_ptr_tget_config () const
 
NLPAlgoConfigconfig ()
 
const NLPAlgoConfigconfig () const
 

Overridden from NLPSolverClientInterface

EFindMinReturn find_min ()
 
void configure_algorithm (std::ostream *trase_out)
 
void print_algorithm (std::ostream &out) const
 
void set_algo_timing (bool algo_timing)
 
bool algo_timing () const
 
void print_algorithm_times (std::ostream &out) const
 

Additional Inherited Members

- Public Types inherited from MoochoPack::NLPAlgoClientInterface
typedef Teuchos::RCP
< NLPAlgoConfig
config_ptr_t
 
- Public Types inherited from MoochoPack::NLPSolverClientInterface
enum  EFindMinReturn { SOLUTION_FOUND, MAX_ITER_EXCEEDED, MAX_RUN_TIME_EXCEEDED, ALGORITHMIC_ERROR }
 
- Public Member Functions inherited from MoochoPack::NLPAlgoClientInterface
- 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 ()
 

Detailed Description

Implementation for NLPAlgo solver.

Acts as a container for NLPAlgo. This class is hidden from clients by not exposing it to them in header files.

Definition at line 57 of file MoochoPack_NLPAlgoContainer.hpp.

Constructor & Destructor Documentation

MoochoPack::NLPAlgoContainer::NLPAlgoContainer ( )
inline

Construct a container with no configuration object set.

Definition at line 67 of file MoochoPack_NLPAlgoContainer.hpp.

MoochoPack::NLPAlgoContainer::NLPAlgoContainer ( const NLPAlgoContainer )
private

Member Function Documentation

MoochoPack::NLPAlgoContainer::STANDARD_COMPOSITION_MEMBERS ( NLPAlgoInterface  ,
algo   
)

Members for <<std comp>="">> of the algorithm object algo.

void MoochoPack::NLPAlgoContainer::set_config ( const config_ptr_t config)
virtual
NLPAlgoContainer::config_ptr_t & MoochoPack::NLPAlgoContainer::get_config ( )
virtual
const NLPAlgoContainer::config_ptr_t & MoochoPack::NLPAlgoContainer::get_config ( ) const
virtual
NLPAlgoConfig & MoochoPack::NLPAlgoContainer::config ( )
virtual
const NLPAlgoConfig & MoochoPack::NLPAlgoContainer::config ( ) const
virtual
NLPSolverClientInterface::EFindMinReturn MoochoPack::NLPAlgoContainer::find_min ( )
virtual
void MoochoPack::NLPAlgoContainer::configure_algorithm ( std::ostream *  trase_out)
virtual
void MoochoPack::NLPAlgoContainer::print_algorithm ( std::ostream &  out) const
virtual
void MoochoPack::NLPAlgoContainer::set_algo_timing ( bool  algo_timing)
virtual
bool MoochoPack::NLPAlgoContainer::algo_timing ( ) const
virtual
void MoochoPack::NLPAlgoContainer::print_algorithm_times ( std::ostream &  out) const
virtual
void MoochoPack::NLPAlgoContainer::assert_valid_setup ( ) const
private

Definition at line 153 of file MoochoPack_NLPAlgoContainer.cpp.

NLPAlgoContainer& MoochoPack::NLPAlgoContainer::operator= ( const NLPAlgoContainer )
private

Member Data Documentation

config_ptr_t MoochoPack::NLPAlgoContainer::config_
private

Definition at line 108 of file MoochoPack_NLPAlgoContainer.hpp.


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