MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_NLPAlgoClientInterface.hpp
1 // @HEADER
2 // ***********************************************************************
3 //
4 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
5 // Copyright (2003) Sandia Corporation
6 //
7 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
8 // license for use of this work by or on behalf of the U.S. Government.
9 //
10 // Redistribution and use in source and binary forms, with or without
11 // modification, are permitted provided that the following conditions are
12 // met:
13 //
14 // 1. Redistributions of source code must retain the above copyright
15 // notice, this list of conditions and the following disclaimer.
16 //
17 // 2. Redistributions in binary form must reproduce the above copyright
18 // notice, this list of conditions and the following disclaimer in the
19 // documentation and/or other materials provided with the distribution.
20 //
21 // 3. Neither the name of the Corporation nor the names of the
22 // contributors may be used to endorse or promote products derived from
23 // this software without specific prior written permission.
24 //
25 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
26 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
27 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
29 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
30 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
31 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
32 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
33 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
34 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
35 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 //
37 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
38 //
39 // ***********************************************************************
40 // @HEADER
41 
42 #ifndef RSQP_ALGO_CLIENT_INTERFACE_H
43 #define RSQP_ALGO_CLIENT_INTERFACE_H
44 
45 #include "MoochoPack_NLPSolverClientInterface.hpp"
46 
47 namespace MoochoPack {
48 
55 public:
56 
59 
62 
64 
67 
69  virtual void set_config(const config_ptr_t& config) = 0;
71  virtual config_ptr_t& get_config() = 0;
73  virtual const config_ptr_t& get_config() const = 0;
75  virtual NLPAlgoConfig& config() = 0;
77  virtual const NLPAlgoConfig& config() const = 0;
78 
80 
91  virtual void configure_algorithm(std::ostream* trase_out = 0) = 0;
92 
94  virtual void print_algorithm(std::ostream& out) const = 0;
95 
96 private:
97 
98 #ifdef DOXYGEN_COMPILE // Strictly for doxygen diagrams
99 
101 #endif
102 
103 }; // end class NLPAlgoClientInterface
104 
105 } // end namespace MoochoPack
106 
107 #endif // RSQP_ALGO_CLIENT_INTERFACE_H
Interface that smart clients use to set the algorithm configuration object that defines the rSQP algo...
virtual config_ptr_t & get_config()=0
virtual void set_config(const config_ptr_t &config)=0
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.
Interface for objects responsible for configuring an rSQP algorithm.
This is the most basic interface that clients use to solve an NLP.
virtual NLPAlgoConfig & config()=0