MOOCHO (Single Doxygen Collection) Version of the Day
ProfileHackPack_profile_hack.hpp
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 #ifndef PROFILE_HACK_H
00043 #define PROFILE_HACK_H
00044 
00045 #include "StopWatchPack_stopwatch.hpp"
00046 
00047 namespace ProfileHackPack {
00048 
00060 
00067 void set_time( const char func_name[], double time_secs );
00068 
00071 void print_timings( std::ostream& out );
00072 
00123 class ProfileTiming {
00124 public:
00131   ProfileTiming( const std::string& func_name, std::ostream* out = NULL )
00132     : func_name_(func_name), out_(out)
00133   {
00134     timer_.reset();
00135     timer_.start();
00136   }
00138   ~ProfileTiming()
00139   {
00140     set_time( func_name_.c_str(), timer_.read() );
00141     if( out_ )
00142       print_timings( *out_ );
00143   }
00144 
00145 private:
00147   std::string                 func_name_;
00148   std::ostream                *out_;
00149   StopWatchPack::stopwatch    timer_;
00150 
00151   // Not defined and not to be called!
00152   ProfileTiming();
00153   ProfileTiming(const ProfileTiming&);
00154   ProfileTiming& operator=(const ProfileTiming&);
00155 
00156 }; // end class ProfileTiming
00157 
00159 
00160 } // end namespace ProfileHackPack
00161 
00162 #endif // PROFILE_HACK_H
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines