MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_LineSearchFailureNewDecompositionSelection_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_LineSearchFailureNewDecompositionSelection_Step.hpp"
46 #include "MoochoPack_MoochoAlgorithmStepNames.hpp"
47 #include "MoochoPack_moocho_algo_conversion.hpp"
48 #include "MoochoPack_Exceptions.hpp"
49 #include "IterationPack_print_algorithm_step.hpp"
50 
51 namespace MoochoPack {
52 
53 LineSearchFailureNewDecompositionSelection_Step::LineSearchFailureNewDecompositionSelection_Step(
54  const line_search_step_ptr_t &line_search_step
55  ,const new_decomp_strategy_ptr_t &new_decomp_strategy
56  )
57  :line_search_step_(line_search_step)
58  ,new_decomp_strategy_(new_decomp_strategy)
59  ,last_ls_failure_k_(-100) // has not failed yet
60 {}
61 
63  Algorithm& _algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss
64  )
65 {
66  try {
67  return line_search_step().do_step(_algo,step_poss,type,assoc_step_poss);
68  }
69  catch(const LineSearchFailure& lsf_excpt) {
70  NLPAlgo &algo = rsqp_algo(_algo);
71  NLPAlgoState &s = algo.rsqp_state();
72 
73  EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
74  std::ostream& out = algo.track().journal_out();
75 
76  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_BASIC_ALGORITHM_INFO) ) {
77  out << "\nLine search failed "
78  << " (k = " << algo.state().k() << ")\n"
79  << "LineSearchFailure description: " << lsf_excpt.what() << "\n";
80  }
81 
82  if( last_ls_failure_k_ == s.k() - 1 ) {
83  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_BASIC_ALGORITHM_INFO) ) {
84  out << "\nThe line search failed again even with a new decomposition!"
85  << " (k = " << algo.state().k() << ")\n"
86  << "We quit!\n";
87  }
88  throw;
89  }
90 
91  if( static_cast<int>(olevel) >= static_cast<int>(PRINT_BASIC_ALGORITHM_INFO) ) {
92  out << "\nSelecting a new decomposition..."
93  << " (k = " << algo.state().k() << ")\n";
94  }
95 
96  last_ls_failure_k_ = s.k();
97  return new_decomp_strategy().new_decomposition(algo,step_poss,type,assoc_step_poss);
98  }
99  return false; // will never be executed.
100 }
101 
103  const Algorithm& algo
104  ,poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss
105  ,std::ostream& out, const std::string& L
106  ) const
107 {
108  out
109  << L << "do line search step : " << typeName(line_search_step()) << std::endl;
110  line_search_step().print_step(algo,step_poss,type,assoc_step_poss,out,L+" ");
111  out
112  << L << "end line search step\n"
113  << L << "if thrown line_search_failure then\n"
114  << L << " if line search failed at the last iteration also then\n"
115  << L << " throw line_search_failure\n"
116  << L << " end\n"
117  << L << " new decomposition selection : " << typeName(new_decomp_strategy()) << std::endl
118  ;
119  new_decomp_strategy().print_new_decomposition(
120  rsqp_algo(algo),step_poss,type,assoc_step_poss,out, L + " " );
121  out
122  << L << " end new decomposition selection\n"
123  << L << "end\n"
124  ;
125 }
126 
127 } // end namespace MoochoPack
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 std::ostream & journal_out() const
Thrown if a line search failure occurs.
Reduced space SQP state encapsulation interface.
AlgorithmTracker & track()
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
AlgorithmState & state()
NLPAlgoState & rsqp_state()
<<std aggr>="">> members for algo_cntr
std::string typeName(const T &t)