Teuchos_TimeMonitor.hpp File Reference

Timer class that starts when constructed and stops when the destructor is called. More...

#include "Teuchos_ConfigDefs.hpp"
#include "Teuchos_PerformanceMonitorBase.hpp"
#include "Teuchos_Time.hpp"

Namespaces
namespace	Teuchos
Classes
class	Teuchos::TimeMonitor
	A timer class that starts when constructed and stops when the destructor is called. More...
Defines
#define	TEUCHOS_TIMER(funcName, strName)
	Defines a static non-member function that returns a time monitor.
#define	TEUCHOS_FUNC_TIME_MONITOR(FUNCNAME)
	Defines a timer for a specific function.

---

Detailed Description

Timer class that starts when constructed and stops when the destructor is called.

---

Define Documentation

#define TEUCHOS_TIMER	(	funcName,
		strName		)

Value:

static Teuchos::Time& funcName() \
  {static Teuchos::RCP<Time> rtn = \
      Teuchos::TimeMonitor::getNewCounter(strName); return *rtn;}

Defines a static non-member function that returns a time monitor.

#define TEUCHOS_FUNC_TIME_MONITOR

(

FUNCNAME

)

Value:

static Teuchos::RCP<Teuchos::Time> blabla_localTimer; \
  if(!blabla_localTimer.get()) { \
    std::ostringstream oss; \
    oss << FUNCNAME; \
    blabla_localTimer = Teuchos::TimeMonitor::getNewCounter(oss.str()); \
  } \
  Teuchos::TimeMonitor blabla_localTimeMonitor(*blabla_localTimer)

Defines a timer for a specific function.

Note that the name of the timer can be formated with stream inserts. For example, we can define a time monitor for a function as follows:

 template<typename Scalar>
 void foo()
 {
 TEUCHOS_FUNC_TIME_MONITOR(
 "foo<"<<Teuchos::ScalarTraits<Scalar>::name()<<">()"
 );
 ...
 }

The timer can then be printed at the end of the program using

 Teuchos::TimeMonitor::summarize(std::cout);

---