Teuchos_TimeMonitor.hpp

Go to the documentation of this file.
00001 // @HEADER
00002 // ***********************************************************************
00003 // 
00004 //                    Teuchos: Common Tools Package
00005 //                 Copyright (2004) 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 Michael A. Heroux (maherou@sandia.gov) 
00025 // 
00026 // ***********************************************************************
00027 // @HEADER
00028 
00029 #ifndef TEUCHOS_TIMEMONITOR_H
00030 #define TEUCHOS_TIMEMONITOR_H
00031 
00039 #include "Teuchos_ConfigDefs.hpp"
00040 #include "Teuchos_Time.hpp"
00041 #include "Teuchos_RefCountPtr.hpp"
00042 #include "Teuchos_Array.hpp"
00043 #include <iostream>
00044 
00045 #define TEUCHOS_TIMER(funcName, strName) \
00046 static Teuchos::Time& funcName()       \
00047 {static Teuchos::RefCountPtr<Time> rtn =        \
00048 Teuchos::TimeMonitor::getNewTimer(strName); return *rtn;}
00049 
00050 namespace Teuchos
00051 {
00061   class TimeMonitor
00062     {
00063     public:
00064  
00066       TimeMonitor(Time& timer, bool reset=false)
00067         : timer_(timer), isRoot_(!timer.isRunning())
00068         {
00069           if (isRoot_) timer_.start(reset);
00070         }
00071 
00073       inline ~TimeMonitor()
00074         {
00075           if (isRoot_) timer_.stop();
00076         }
00077 
00080       static void summarize(ostream &out=std::cout);
00081 
00084       static RefCountPtr<Time> getNewTimer(const string& name);
00085     private:
00086       
00087       Time& timer_;
00088       bool isRoot_;
00089 
00091       static void gatherTimings(const Array<double>& timings,
00092                                 Array<double>& minTime,
00093                                 Array<double>& avgTime,
00094                                 Array<double>& maxTime);
00095       
00096       static Array<RefCountPtr<Time> > timers_;
00097     };
00098 
00099 }
00100 #endif

Generated on Thu Sep 18 12:39:10 2008 for Teuchos - Trilinos Tools Package by doxygen 1.3.9.1