MoochoPack : Framework for Large-Scale Optimization Algorithms  Version of the Day
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
MoochoPack_LineSearchFullStepAfterKIter_Step.cpp
1 #if 0
2 
3 // @HEADER
4 // ***********************************************************************
5 //
6 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
7 // Copyright (2003) Sandia Corporation
8 //
9 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
10 // license for use of this work by or on behalf of the U.S. Government.
11 //
12 // Redistribution and use in source and binary forms, with or without
13 // modification, are permitted provided that the following conditions are
14 // met:
15 //
16 // 1. Redistributions of source code must retain the above copyright
17 // notice, this list of conditions and the following disclaimer.
18 //
19 // 2. Redistributions in binary form must reproduce the above copyright
20 // notice, this list of conditions and the following disclaimer in the
21 // documentation and/or other materials provided with the distribution.
22 //
23 // 3. Neither the name of the Corporation nor the names of the
24 // contributors may be used to endorse or promote products derived from
25 // this software without specific prior written permission.
26 //
27 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
28 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
31 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
34 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
35 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
36 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
37 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 //
39 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov)
40 //
41 // ***********************************************************************
42 // @HEADER
43 
44 #include <ostream>
45 
46 #include "MoochoPack_LineSearchFullStepAfterKIter_Step.hpp"
47 #include "MoochoPack_moocho_algo_conversion.hpp"
48 #include "IterationPack_print_algorithm_step.hpp"
49 
51  , poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
52 {
53  NLPAlgo &algo = rsqp_algo(_algo);
54  NLPAlgoState &s = algo.rsqp_state();
55  NLP &nlp = algo.nlp();
56 
57  EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
58  std::ostream& out = algo.track().journal_out();
59  out << std::boolalpha;
60 
61  // print step header.
62  if( (int)olevel >= (int)PRINT_ALGORITHM_STEPS ) {
63  using IterationPack::print_algorithm_step;
64  print_algorithm_step( algo, step_poss, type, assoc_step_poss, out );
65  }
66 
67  const bool take_full_step = s.k() > full_steps_after_k();
68 
69  if( (int)olevel >= (int)PRINT_ALGORITHM_STEPS ) {
70  out << "\nk = " << s.k() << ( take_full_step ? " > " : " < ")
71  << "full_steps_after_k = " << full_steps_after_k() << std::endl;
72  }
73 
74  if( !take_full_step ) {
75  return line_search().do_step(_algo,step_poss,type,assoc_step_poss);
76  }
77  else {
78  if( (int)olevel >= (int)PRINT_ALGORITHM_STEPS ) {
79  out << "\nKeep the full step...\n";
80  }
81  }
82 
83  return true;
84 }
85 
87  , poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss
88  , std::ostream& out, const std::string& L ) const
89 {
90  out << L << "*** Start using full steps after full_steps_after_k iterations.\n"
91  << L << "default: full_steps_after_k = very big\n";
92  out << L << "if k < full_steps_after_k then\n";
93  line_search().print_step(algo,step_poss,type,assoc_step_poss,out,L + " " );
94  out << L << "end\n";
95 }
96 
97 #endif // 0
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
bool do_step(Algorithm &algo, poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)