Kokkos Node API and Local Linear Algebra Kernels Version of the Day
Public Member Functions
TSQR::StatTimeMonitor Class Reference

Like Teuchos::TimeMonitor, but collects running stats. More...

#include <Tsqr_StatTimeMonitor.hpp>

List of all members.

Public Member Functions

 StatTimeMonitor (Teuchos::Time &timer, TimeStats &stats)
 Constructor.
 ~StatTimeMonitor ()
 Destructor.

Detailed Description

Like Teuchos::TimeMonitor, but collects running stats.

Like Teuchos::TimeMonitor, this class uses the RAII idiom to time a scope. However, it also maintains running statistics, via a reference to a TimeStats object.

Note:
Implementers: You may safely add new statistics to TimeStats without needing to change this class.

Definition at line 65 of file Tsqr_StatTimeMonitor.hpp.


Constructor & Destructor Documentation

TSQR::StatTimeMonitor::StatTimeMonitor ( Teuchos::Time timer,
TimeStats stats 
)

Constructor.

Parameters:
timer[in/out] Reference to the raw timer object
stats[in/out] Running statistics, to be updated when this StatTimeMonitor falls out of scope

Definition at line 51 of file Tsqr_StatTimeMonitor.cpp.

TSQR::StatTimeMonitor::~StatTimeMonitor ( )

Destructor.

Updates running statistics via the TimeStats object.

Definition at line 61 of file Tsqr_StatTimeMonitor.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends