MOOCHO (Single Doxygen Collection) Version of the Day
IterationPack_AlgorithmStepTesting.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 <iomanip>
00043 
00044 #include "IterationPack_AlgorithmStepTesting.hpp"
00045 #include "IterationPack_Algorithm.hpp"
00046 #include "IterationPack_print_algorithm_step.hpp"
00047 
00048 namespace {
00049 char step_type_name[3][15] = { "DO_MAIN_STEP", "DO_PRE_STEP" , "DO_POST_STEP" };
00050 } // namespace
00051 
00052 namespace IterationPack {
00053 
00054 bool AlgorithmStepTesting::do_step(Algorithm& algo, poss_type step_poss, EDoStepType type
00055     , poss_type assoc_step_poss)
00056 {
00057   print_algorithm_step( algo, step_poss, type, assoc_step_poss
00058     , algo.track().journal_out() );
00059   return true;
00060 }
00061 
00062 void AlgorithmStepTesting::initialize_step(
00063   Algorithm& algo, poss_type step_poss, EDoStepType type
00064   ,poss_type assoc_step_poss
00065   )
00066 {
00067   print_step_poss( algo, step_poss, type, assoc_step_poss );
00068   algo.track().journal_out() << "\" : initialize_step(...) called\n";
00069 }
00070 
00071 void AlgorithmStepTesting::inform_updated(
00072   Algorithm& algo, poss_type step_poss, EDoStepType type
00073   ,poss_type assoc_step_poss
00074   )
00075 {
00076   print_step_poss( algo, step_poss, type, assoc_step_poss );
00077   algo.track().journal_out() << "\" : inform_step(...) called\n";
00078 }
00079 
00080 void AlgorithmStepTesting::finalize_step(
00081   Algorithm& algo, poss_type step_poss, EDoStepType type
00082   ,poss_type assoc_step_poss
00083   )
00084 {
00085   print_step_poss( algo, step_poss, type, assoc_step_poss );
00086   algo.track().journal_out() << "\" : finalize_step(...) called\n";
00087 }
00088 
00089 void AlgorithmStepTesting::print_step( const Algorithm& algo, poss_type step_poss, EDoStepType type
00090   , poss_type assoc_step_poss ,std::ostream& out, const std::string& leading_str ) const
00091 {
00092   algo.track().journal_out()
00093     << std::endl << leading_str << step_poss << ", " << step_type_name[type];
00094   if(type == DO_MAIN_STEP) {
00095     algo.track().journal_out()
00096       << ", \"" << algo.get_step_name(step_poss) << "\"";
00097   }
00098   else {
00099     EAssocStepType _type = (type == DO_PRE_STEP ? PRE_STEP : POST_STEP );
00100     algo.track().journal_out()
00101       << ", " << assoc_step_poss
00102       << ", \"" << algo.get_assoc_step_name(step_poss,_type,assoc_step_poss) << "\"";
00103   }
00104   algo.track().journal_out()
00105     << "\" : print_step(algo,step_poss,type,assoc_step_poss,out) called\n";
00106 }
00107 
00108 // private
00109 
00110 void AlgorithmStepTesting::print_step_poss(
00111   const Algorithm& algo, poss_type step_poss, EDoStepType type
00112   ,poss_type assoc_step_poss
00113   ) const
00114 {
00115   algo.track().journal_out()
00116     << std::endl << step_poss << ", " << step_type_name[type];
00117   if(type == DO_MAIN_STEP) {
00118     algo.track().journal_out()
00119       << ", \"" << algo.get_step_name(step_poss) << "\"";
00120   }
00121   else {
00122     EAssocStepType _type = (type == DO_PRE_STEP ? PRE_STEP : POST_STEP );
00123     algo.track().journal_out()
00124       << ", " << assoc_step_poss
00125       << ", \"" << algo.get_assoc_step_name(step_poss,_type,assoc_step_poss) << "\"";
00126   }
00127 }
00128 
00129 } // end namespace IterationPack 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines