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 // This library is free software; you can redistribute it and/or modify
00011 // it under the terms of the GNU Lesser General Public License as
00012 // published by the Free Software Foundation; either version 2.1 of the
00013 // License, or (at your option) any later version.
00014 //  
00015 // This library is distributed in the hope that it will be useful, but
00016 // WITHOUT ANY WARRANTY; without even the implied warranty of
00017 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00018 // Lesser General Public License for more details.
00019 //  
00020 // You should have received a copy of the GNU Lesser General Public
00021 // License along with this library; if not, write to the Free Software
00022 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
00023 // USA
00024 // Questions? Contact Roscoe A. Bartlett (rabartl@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 //#include <assert.h>
00030 
00031 #include <ostream>
00032 
00033 #include "MoochoPack_CheckConvergenceStd_AddedStep.hpp"
00034 #include "MoochoPack_NLPAlgoContainer.hpp"
00035 #include "MoochoPack_moocho_algo_conversion.hpp"
00036 #include "IterationPack_print_algorithm_step.hpp"
00037 
00038 namespace MoochoPack {
00039 
00040 CheckConvergenceStd_AddedStep::CheckConvergenceStd_AddedStep(
00041   Teuchos::RCP<CheckConvergence_Strategy> convergence_strategy
00042   )
00043   :
00044   convergence_strategy_(convergence_strategy)
00045   {}
00046 
00047 bool CheckConvergenceStd_AddedStep::do_step(
00048   Algorithm& _algo, poss_type step_poss, IterationPack::EDoStepType type
00049   ,poss_type assoc_step_poss
00050   )
00051   {
00052   
00053     TEST_FOR_EXCEPTION(!convergence_strategy_.get(),
00054           std::logic_error,
00055           "Don't have a valid convergence_strategy in CheckConvergenceStd_AddedStep\n"
00056     );
00057 
00058   NLPAlgo &algo   = rsqp_algo(_algo);
00059 
00060   EJournalOutputLevel olevel = algo.algo_cntr().journal_output_level();
00061   std::ostream& out = algo.track().journal_out();
00062 
00063   // print step header.
00064   if( static_cast<int>(olevel) >= static_cast<int>(PRINT_ALGORITHM_STEPS) ) {
00065     using IterationPack::print_algorithm_step;
00066     print_algorithm_step( algo, step_poss, type, assoc_step_poss, out );
00067   }
00068 
00069   const bool found_solution = convergence_strategy_->Converged(_algo);
00070 
00071   if( found_solution )
00072   {
00073     if( static_cast<int>(olevel) > static_cast<int>(PRINT_NOTHING) )
00074       out << "\nJackpot!  Found the solution!!!!!! (k = " << algo.state().k() << ")\n";
00075     algo.terminate(true); // found min
00076     return false; // skip the other steps and terminate
00077   }
00078   
00079   if( static_cast<int>(olevel) > static_cast<int>(PRINT_NOTHING) )
00080     out << "\nHave not found the solution yet, have to keep going (k = " << algo.state().k() << ") :-(\n";
00081   
00082   // We are not at the solution so keep going
00083   return true;
00084   }
00085 
00086 void CheckConvergenceStd_AddedStep::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 
00091     TEST_FOR_EXCEPTION(!convergence_strategy_.get(),
00092           std::logic_error,
00093           "Don't have a valid convergence_strategy in CheckConvergenceStd_AddedStep\n"
00094     );
00095   
00096   convergence_strategy_->print_step(algo, out, L);
00097   }
00098 
00099 } // end namespace MoochoPack
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Generated on Wed Apr 13 10:10:59 2011 for MOOCHO (Single Doxygen Collection) by  doxygen 1.6.3