MOOCHO (Single Doxygen Collection) Version of the Day
IterationPack_AlgorithmTrackTesting.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_AlgorithmTrackTesting.hpp"
00045 #include "IterationPack_Algorithm.hpp"
00046 
00047 namespace IterationPack {
00048 
00049 void AlgorithmTrackTesting::output_iteration(const Algorithm& algo) const {
00050   std::ostream &o = journal_out();
00051   o
00052     << "\ntrack.output_iteration(algo) called for the iteration k = "
00053     << algo.state().k() << std::endl;
00054   o
00055     << "\nStep times for the current iteration (in seconds):\n";
00056   const int n = algo.num_steps();
00057   std::vector<double> step_times(n+1);
00058   algo.get_step_times_k(0,&step_times[0]);
00059   o << "  step_id:time = ";
00060   for( int l = 0; l < n+1; ++l )
00061     o << " " << (l+1) << ":" << step_times[l];
00062   o << "\n  total time = " << step_times[n] << std::endl;
00063   
00064 }
00065 
00066 void AlgorithmTrackTesting::output_final(const Algorithm& algo, EAlgoReturn algo_return) const {
00067   char algo_return_name[6][50] =
00068     {
00069       "TERMINATE_TRUE"
00070       ,"TERMINATE_FALSE"
00071       ,"MAX_ITER_EXCEEDED"
00072       ,"MAX_RUN_TIME_EXCEEDED"
00073       ,"INTERRUPTED_TERMINATE_TRUE"
00074       ,"INTERRUPTED_TERMINATE_FALSE"
00075     };
00076   std::ostream &o = journal_out();
00077   o << "\ntrack.output_final(algo,algo_return) called for the iteration k = "
00078     << algo.state().k() << " and algo_return = " << algo_return_name[algo_return]
00079     << std::endl;
00080   o << "Timing (in seconds) statistics for step 0 : ";
00081   double total, average, min, max, percent;
00082   algo.get_final_step_stats(0,&total,&average,&min,&max,&percent);
00083   o << "total = " << total << ", average = " << average << ", min = " << min
00084     << ", max = " << max << ", percent = " << percent << std::endl;
00085 }
00086 
00087 } // end namespace IterationPack 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines