MOOCHO (Single Doxygen Collection) Version of the Day
MoochoPack_CheckConvergenceStd_AddedStep.cpp
Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 // Moocho: Multi-functional Object-Oriented arCHitecture for Optimization
00005 //                  Copyright (2003) Sandia Corporation
00006 // 
00007 // Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
00008 // license for use of this work by or on behalf of the U.S. Government.
00009 // 
00010 // Redistribution and use in source and binary forms, with or without
00011 // modification, are permitted provided that the following conditions are
00012 // met:
00013 //
00014 // 1. Redistributions of source code must retain the above copyright
00015 // notice, this list of conditions and the following disclaimer.
00016 //
00017 // 2. Redistributions in binary form must reproduce the above copyright
00018 // notice, this list of conditions and the following disclaimer in the
00019 // documentation and/or other materials provided with the distribution.
00020 //
00021 // 3. Neither the name of the Corporation nor the names of the
00022 // contributors may be used to endorse or promote products derived from
00023 // this software without specific prior written permission.
00024 //
00025 // THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "AS IS" AND ANY
00026 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00027 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00028 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL SANDIA CORPORATION OR THE
00029 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
00030 // EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
00031 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
00032 // PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
00033 // LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00034 // NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
00035 // SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00036 //
00037 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00038 // 
00039 // ***********************************************************************
00040 // @HEADER
00041 
00042 //#include <assert.h>
00043 
00044 #include <ostream>
00045 
00046 #include "MoochoPack_CheckConvergenceStd_AddedStep.hpp"
00047 #include "MoochoPack_NLPAlgoContainer.hpp"
00048 #include "MoochoPack_moocho_algo_conversion.hpp"
00049 #include "IterationPack_print_algorithm_step.hpp"
00050 
00051 namespace MoochoPack {
00052 
00053 CheckConvergenceStd_AddedStep::CheckConvergenceStd_AddedStep(
00054   Teuchos::RCP<CheckConvergence_Strategy> convergence_strategy
00055   )
00056   :
00057   convergence_strategy_(convergence_strategy)
00058   {}
00059 
00060 bool CheckConvergenceStd_AddedStep::do_step(
00061   Algorithm& _algo, poss_type step_poss, IterationPack::EDoStepType type
00062   ,poss_type assoc_step_poss
00063   )
00064   {
00065   
00066     TEUCHOS_TEST_FOR_EXCEPTION(!convergence_strategy_.get(),
00067           std::logic_error,
00068           "Don't have a valid convergence_strategy in CheckConvergenceStd_AddedStep\n"
00069     );
00070 
00071   NLPAlgo &algo   = rsqp_algo(_algo);
00072 
00073   EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
00074   std::ostream& out = algo.track().journal_out();
00075 
00076   // print step header.
00077   if( static_cast<int>(olevel) >= static_cast<int>(PRINT_ALGORITHM_STEPS) ) {
00078     using IterationPack::print_algorithm_step;
00079     print_algorithm_step( algo, step_poss, type, assoc_step_poss, out );
00080   }
00081 
00082   const bool found_solution = convergence_strategy_->Converged(_algo);
00083 
00084   if( found_solution )
00085   {
00086     if( static_cast<int>(olevel) > static_cast<int>(PRINT_NOTHING) )
00087       out << "\nJackpot!  Found the solution!!!!!! (k = " << algo.state().k() << ")\n";
00088     algo.terminate(true); // found min
00089     return false; // skip the other steps and terminate
00090   }
00091   
00092   if( static_cast<int>(olevel) > static_cast<int>(PRINT_NOTHING) )
00093     out << "\nHave not found the solution yet, have to keep going (k = " << algo.state().k() << ") :-(\n";
00094   
00095   // We are not at the solution so keep going
00096   return true;
00097   }
00098 
00099 void CheckConvergenceStd_AddedStep::print_step( const Algorithm& algo
00100   , poss_type step_poss, IterationPack::EDoStepType type, poss_type assoc_step_poss
00101   , std::ostream& out, const std::string& L ) const
00102   {
00103 
00104     TEUCHOS_TEST_FOR_EXCEPTION(!convergence_strategy_.get(),
00105           std::logic_error,
00106           "Don't have a valid convergence_strategy in CheckConvergenceStd_AddedStep\n"
00107     );
00108   
00109   convergence_strategy_->print_step(algo, out, L);
00110   }
00111 
00112 } // end namespace MoochoPack
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines