MoochoPack : Framework for Large-Scale Optimization Algorithms Version of the Day
MoochoPack_LineSearchFullStepAfterKIter_Step.cpp
00001 #if 0
00002 
00003 // @HEADER
00004 // ***********************************************************************
00005 // 
00006 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00007 //                  Copyright (2003) Sandia Corporation
00008 // 
00009 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00010 // license for use of this work by or on behalf of the U.S. Government.
00011 // 
00012 // Redistribution and use in source and binary forms, with or without
00013 // modification, are permitted provided that the following conditions are
00014 // met:
00015 //
00016 // 1. Redistributions of source code must retain the above copyright
00017 // notice, this list of conditions and the following disclaimer.
00018 //
00019 // 2. Redistributions in binary form must reproduce the above copyright
00020 // notice, this list of conditions and the following disclaimer in the
00021 // documentation and/or other materials provided with the distribution.
00022 //
00023 // 3. Neither the name of the Corporation nor the names of the
00024 // contributors may be used to endorse or promote products derived from
00025 // this software without specific prior written permission.
00026 //
00027 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00028 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00029 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00030 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00031 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00032 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00033 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00034 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00035 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00036 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00037 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00038 //
00039 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00040 // 
00041 // ***********************************************************************
00042 // @HEADER
00043 
00044 #include <ostream>
00045 
00046 #include "MoochoPack_LineSearchFullStepAfterKIter_Step.hpp"
00047 #include "MoochoPack_moocho_algo_conversion.hpp"
00048 #include "IterationPack_print_algorithm_step.hpp"
00049 
00050 bool MoochoPack::LineSearchFullStepAfterKIter_Step::do_step(Algorithm& _algo
00051   , poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss)
00052 {
00053   NLPAlgo &algo = rsqp_algo(_algo);
00054   NLPAlgoState  &s    = algo.rsqp_state();
00055   NLP     &nlp  = algo.nlp();
00056 
00057   EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
00058   std::ostream& out = algo.track().journal_out();
00059   out << std::boolalpha;
00060 
00061   // print step header.
00062   if( (int)olevel >= (int)PRINT_ALGORITHM_STEPS ) {
00063     using IterationPack::print_algorithm_step;
00064     print_algorithm_step( algo, step_poss, type, assoc_step_poss, out );
00065   }
00066 
00067   const bool take_full_step = s.k() > full_steps_after_k();
00068 
00069   if( (int)olevel >= (int)PRINT_ALGORITHM_STEPS ) {
00070       out << "\nk = " << s.k() << ( take_full_step ? " > " : " < ")
00071           << "full_steps_after_k = " << full_steps_after_k() << std::endl;
00072   }
00073 
00074   if( !take_full_step ) {
00075     return line_search().do_step(_algo,step_poss,type,assoc_step_poss);
00076   }
00077   else {
00078     if( (int)olevel >= (int)PRINT_ALGORITHM_STEPS ) {
00079       out << "\nKeep the full step...\n";
00080     }
00081   }
00082 
00083   return true;
00084 }
00085 
00086 void MoochoPack::LineSearchFullStepAfterKIter_Step::print_step( const Algorithm& algo
00087   , poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss
00088   , std::ostream& out, const std::string& L ) const
00089 {
00090   out << L << "*** Start using full steps after full_steps_after_k iterations.\n"
00091     << L << "default: full_steps_after_k = very big\n";
00092   out << L << "if k < full_steps_after_k then\n";
00093   line_search().print_step(algo,step_poss,type,assoc_step_poss,out,L + "    " );
00094   out << L << "end\n";
00095 }
00096 
00097 #endif // 0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends