MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_QPFailureReinitReducedHessian_Step.cpp
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 #include <ostream>
43 #include <typeinfo>
44 
45 #include "MoochoPack_QPFailureReinitReducedHessian_Step.hpp"
46 #include "MoochoPack_MoochoAlgorithmStepNames.hpp"
47 #include "MoochoPack_Exceptions.hpp"
48 #include "MoochoPack_moocho_algo_conversion.hpp"
49 #include "IterationPack_print_algorithm_step.hpp"
50 
51 namespace MoochoPack {
52 
53 QPFailureReinitReducedHessian_Step::QPFailureReinitReducedHessian_Step(
54  const null_space_step_ptr_t& null_space_step
55  )
56  :null_space_step_(null_space_step)
57  ,last_qp_failure_k_(-100) // has not failed yet.
58 {}
59 
61  Algorithm& _algo, poss_type step_poss, IterationPack::EDoStepType type
62  ,poss_type assoc_step_poss
63  )
64 {
65  try {
66  return null_space_step().do_step(_algo,step_poss,type,assoc_step_poss);
67  }
68  catch(const QPFailure& qp_excpt) {
69  NLPAlgo &algo = rsqp_algo(_algo);
70  NLPAlgoState &s = algo.rsqp_state();
71  EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
72  std::ostream &out = algo.track().journal_out();
73 
74  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_BASIC_ALGORITHM_INFO) ) {
75  out << "\nQP failed! "
76  << " (k = " << algo.state().k() << ")\n"
77  << "QPFailure description: " << qp_excpt.what() << "\n";
78  }
79  if( s.k() >= algo.algo_cntr().max_iter() ) {
80  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_BASIC_ALGORITHM_INFO) ) {
81  out << "\nThe maximum number of rSQP iterations\n"
82  << " have been exceeded so quit "
83  << " (k = " << algo.state().k() << ")\n";
84  }
85  algo.terminate(false);
86  return false;
87  }
88  if( last_qp_failure_k_ == s.k() ) {
89  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_BASIC_ALGORITHM_INFO) ) {
90  out << "\nThe QP failed again even with a new reduced Hessian rHL_k!"
91  << " (k = " << algo.state().k() << ")\n"
92  << "We quit!\n";
93  }
94  throw;
95  }
96  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_BASIC_ALGORITHM_INFO) ) {
97  out << "\nWiping out all memory for rHL and going back to reinitalize it ..."
98  << " (k = " << algo.state().k() << ")\n";
99  }
100  last_qp_failure_k_ = s.k(); // Remember this for later!
101  if( (int)olevel >= (int)PRINT_ALGORITHM_STEPS ) {
102  out << "Wipe out all update rHL_{k} for all k\n"
103  << "goto ReducedHessian\n";
104  }
105  s.rHL().set_all_not_updated();
106  algo.do_step_next( ReducedHessian_name );
107  return false;
108  }
109  return false; // will never be executed.
110 }
111 
113  const Algorithm& algo
114  ,poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss
115  ,std::ostream& out, const std::string& L
116  ) const
117 {
118  out
119  << L << "do null space step : " << typeName(null_space_step()) << std::endl;
120  null_space_step().print_step(algo,step_poss,type,assoc_step_poss,out,L+" ");
121  out
122  << L << "end null space step\n"
123  << L << "if QPFailure was thrown then\n"
124  << L << " if QP failed already then\n"
125  << L << " rethrow QPFailure\n"
126  << L << " end\n"
127  << L << " if k > max_iter then\n"
128  << L << " terminate the algorithm!\n"
129  << L << " end\n"
130  << L << " set all rHL_{k} to not updated\n"
131  << L << " goto ReducedHessian\n"
132  << L << "end\n"
133  ;
134 }
135 
136 } // end namespace MoochoPack
virtual void max_iter(size_t max_iter)
Thrown if a the QP failed and was not corrected.
void print_step(const Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss, std::ostream &out, const std::string &leading_str) const
rSQP Algorithm control class.
virtual void terminate(bool success)
virtual std::ostream & journal_out() const
Reduced space SQP state encapsulation interface.
virtual void do_step_next(const std::string &step_name)
AlgorithmTracker & track()
AlgorithmState & state()
NLPAlgoState & rsqp_state()
<<std aggr>="">> members for algo_cntr
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
std::string typeName(const T &t)