Teuchos_TimeMonitor.hpp

Go to the documentation of this file.

// @HEADER
// ***********************************************************************
// 
//                    Teuchos: Common Tools Package
//                 Copyright (2004) Sandia Corporation
// 
// Under terms of Contract DE-AC04-94AL85000, there is a non-exclusive
// license for use of this work by or on behalf of the U.S. Government.
// 
// This library is free software; you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation; either version 2.1 of the
// License, or (at your option) any later version.
//  
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//  
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
// USA
// Questions? Contact Michael A. Heroux (maherou@sandia.gov) 
// 
// ***********************************************************************
// @HEADER

#ifndef TEUCHOS_TIMEMONITOR_H
#define TEUCHOS_TIMEMONITOR_H

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_Time.hpp"
#include "Teuchos_RefCountPtr.hpp"
#include "Teuchos_Array.hpp"
#include <iostream>

#define TEUCHOS_TIMER(funcName, strName) \
static Teuchos::Time& funcName()       \
{static Teuchos::RefCountPtr<Time> rtn =        \
Teuchos::TimeMonitor::getNewTimer(strName); return *rtn;}

namespace Teuchos
{
  class TimeMonitor
    {
    public:
 
      TimeMonitor(Time& timer, bool reset=false)
        : timer_(timer), isRoot_(!timer.isRunning())
        {
          if (isRoot_) timer_.start(reset);
        }

      inline ~TimeMonitor()
        {
          if (isRoot_) timer_.stop();
        }

      static void summarize(ostream &out=std::cout);

      static RefCountPtr<Time> getNewTimer(const string& name);
    private:
      
      Time& timer_;
      bool isRoot_;

      static void gatherTimings(const Array<double>& timings,
                                Array<double>& minTime,
                                Array<double>& avgTime,
                                Array<double>& maxTime);
      
      static Array<RefCountPtr<Time> > timers_;
    };

}
#endif

---