MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_NLPAlgo.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_H
43 #define RSQP_ALGO_H
44 
45 #include "MoochoPack_NLPAlgoInterface.hpp"
46 #include "MoochoPack_NLPAlgoContainer.hpp"
47 #include "MoochoPack_NLPAlgoState.hpp"
48 #include "IterationPack_Algorithm.hpp"
49 #include "StandardAggregationMacros.hpp"
50 
51 namespace MoochoPack {
52 
55 class NLPAlgo
56  : public NLPAlgoInterface
58 {
59 public:
60 
63 
65 
67  NLPAlgo();
68 
71 
72 
74 
75 
77  { return dynamic_cast<NLPAlgoState&>(state()); }
78 
80  const NLPAlgoState& rsqp_state() const
81  { return dynamic_cast<const NLPAlgoState&>(state()); }
82 
84  void do_step_first(Algorithm::poss_type first_step_poss)
85  { first_step_poss_ = first_step_poss; }
86 
89 
91  const NLPAlgoState& retrieve_state() const;
92 
98 
100  void interface_print_algorithm(std::ostream& out) const;
104  bool interface_algo_timing() const;
106  void interface_print_algorithm_times( std::ostream& out ) const;
107 
109 
111 
113  void print_algorithm(std::ostream& out) const;
114 
115 protected:
116 
117  // First step to execute
118  Algorithm::poss_type first_step_poss_;
119 
120 }; // end class NLPAlgo
121 
122 } // end namespace MoochoPack
123 
124 #endif // RSQP_ALGO_H
void interface_print_algorithm(std::ostream &out) const
Interface NLPAlgoContainer uses to access NLPAlgo.
virtual bool algo_timing() const
rSQP Algorithm control class.
NLPAlgo()
Constructs with no step, added_step, pre_step, post_step, state, or decomp_sys objects added...
Implementation for NLPAlgo solver.
void print_algorithm(std::ostream &out) const
overridden from Algorihth.
void interface_set_algo_timing(bool algo_timing)
Reduced space SQP state encapsulation interface.
NLPSolverClientInterface::EFindMinReturn dispatch()
This is the main control function for the rSQP algorithm.
#define STANDARD_AGGREGATION_MEMBERS(TYPE, NAME)
AlgorithmState & state()
NLPAlgoState & rsqp_state()
<<std aggr>="">> members for algo_cntr
bool interface_algo_timing() const
void interface_print_algorithm_times(std::ostream &out) const
void do_step_first(Algorithm::poss_type first_step_poss)
const NLPAlgoState & rsqp_state() const
const NLPAlgoState & retrieve_state() const