This class allows one to push and pop timers on and off a stack. More...

#include <Teuchos_StackedTimer.hpp>

Classes
struct	AlignmentWidths
	Stores the column widths for output alignment. More...

class	LevelTimer
	Timer info at a given level and all the children. More...

struct	OutputOptions
	Struct for controlling output options like histograms. More...

Public Member Functions
	StackedTimer (const char *name, const bool start_base_timer=true)

void	startBaseTimer ()

void	stopBaseTimer ()

void	start (const std::string name, const bool push_kokkos_profiling_region=true)

void	stop (const std::string &name, const bool pop_kokkos_profiling_region=true)

void	incrementUpdates (const long long i=1)

double	accumulatedTime (const std::string &name="")

double	accumulatedTimePerUpdate (const std::string &name="")

double	accumulatedTimePerTimerCall (const std::string &name="")

const BaseTimer *	findBaseTimer (const std::string &name) const

BaseTimer::TimeInfo	findTimer (const std::string &name)

void	report (std::ostream &os, Teuchos::RCP< const Teuchos::Comm< int > > comm, OutputOptions options=OutputOptions())

Protected Member Functions
void	flatten ()

void	merge (Teuchos::RCP< const Teuchos::Comm< int > > comm)

void	collectRemoteData (Teuchos::RCP< const Teuchos::Comm< int > > comm, const OutputOptions &options)

double	computeColumnWidthsForAligment (std::string prefix, int print_level, std::vector< bool > &printed, double parent_time, const OutputOptions &options)

double	printLevel (std::string prefix, int level, std::ostream &os, std::vector< bool > &printed, double parent_time, const OutputOptions &options)

Protected Attributes
LevelTimer *	top_
	Current level running. More...

LevelTimer	timer_
	Base timer. More...

bool	enable_verbose_
	If set to true, prints to the debug ostream. At construction, default value is set from environment variable. More...

Teuchos::RCP< std::ostream >	verbose_ostream_
	For debugging, this is the ostream used for printing. More...

Detailed Description

This class allows one to push and pop timers on and off a stack.

To use this class one would do something like this

StackedTimer timer(); // construct top level timer timer.start("some comp"); do_work(); timer.start("sub comp"); more_work(); timer.stop(); // stopping sub comp timer.stop(); // stopping comp

timer.stop(); // stopping all timer stuff timer.report(std::cout); // dump to screen

Definition at line 184 of file Teuchos_StackedTimer.hpp.

Constructor & Destructor Documentation

Teuchos::StackedTimer::StackedTimer	(	const char *	name,
		const bool	start_base_timer = `true`
	)

inlineexplicit

Construct a stacked timer

Parameters

[in]	name	Top level name of the timer
[in]	start_top_timer	Automatically start the top level timer. If set to false, the user will have to start it manually.

Definition at line 431 of file Teuchos_StackedTimer.hpp.

Member Function Documentation

void Teuchos::StackedTimer::startBaseTimer ( )

inline

Start the base level timer only

Definition at line 448 of file Teuchos_StackedTimer.hpp.

void Teuchos::StackedTimer::stopBaseTimer ( )

inline

Stop the base level timer only

Definition at line 458 of file Teuchos_StackedTimer.hpp.

void Teuchos::StackedTimer::start	(	const std::string	name,
		const bool	push_kokkos_profiling_region = `true`
	)

inline

Start a sublevel timer

Parameters

[in]	name	Name of the timer you wish to start
[in]	push_kokkos_profiling_region	Optional parameter that if set to true, will pushRegion() in kokkos profiling for this timer. The TimeMonitor will always set this to false since it does its own pushRegion() in the Timer object (this prevents double registering with kokkos).

Definition at line 470 of file Teuchos_StackedTimer.hpp.

void Teuchos::StackedTimer::stop	(	const std::string &	name,
		const bool	pop_kokkos_profiling_region = `true`
	)

inline

Stop the current top running timer, should be called for the root timer prior to final output

Parameters

[in]	name	Name of the timer you wish to stop
[in]	pop_kokkos_profiling_region	Optional parameter that if set to true, will popRegion() in kokkos profiling for this timer. The TimeMonitor will always set this to false since it does its own pushRegion() in the Timer object (this prevents double registering with kokkos).

Definition at line 490 of file Teuchos_StackedTimer.hpp.

void Teuchos::StackedTimer::incrementUpdates ( const long long i = 1 )

inline

Increment the iteration count for the running timer

Parameters

[in] i amount to increment the count

Definition at line 509 of file Teuchos_StackedTimer.hpp.

double Teuchos::StackedTimer::accumulatedTime ( const std::string & name = "" )

inline

Return the accumulated time the named timer has, if name is blank top level timer

Parameters

[in] name Name of the timer to output

Returns: amount of time in seconds

Definition at line 518 of file Teuchos_StackedTimer.hpp.

double Teuchos::StackedTimer::accumulatedTimePerUpdate ( const std::string & name = "" )

inline

Return the time spent per update at a given level

Parameters

[in] name name of subtimer, if blank return current level time

Returns: time in seconds per update at provided level

Definition at line 530 of file Teuchos_StackedTimer.hpp.

double Teuchos::StackedTimer::accumulatedTimePerTimerCall ( const std::string & name = "" )

inline

Return the time spent per timer start/stop at a given level

Parameters

[in] name name of subtimer, if blank return current level time

Returns: time in seconds per start/stop call at provided level

Definition at line 541 of file Teuchos_StackedTimer.hpp.

const BaseTimer* Teuchos::StackedTimer::findBaseTimer ( const std::string & name ) const

inline

Return pointer to the BaseTimer corresponding to a given string (full string name)

Parameters

name	input string to search for

Returns: BaseTimer

Definition at line 553 of file Teuchos_StackedTimer.hpp.

BaseTimer::TimeInfo Teuchos::StackedTimer::findTimer ( const std::string & name )

inline

Return the time info for a given string (full string name)

Parameters

name	input string to search for

Returns: Time data

Definition at line 565 of file Teuchos_StackedTimer.hpp.

void Teuchos::StackedTimer::report	(	std::ostream &	os,
		Teuchos::RCP< const Teuchos::Comm< int > >	comm,
		OutputOptions	options = `OutputOptions()`
	)

Dump all the data from all the MPI ranks to an ostream

Parameters

[in]	os	- Output stream
[in]	comm	- Teuchos comm pointer

Definition at line 500 of file Teuchos_StackedTimer.cpp.

void Teuchos::StackedTimer::flatten ( )

protected

Flatten the timers into a single array

Definition at line 74 of file Teuchos_StackedTimer.cpp.

void Teuchos::StackedTimer::merge ( Teuchos::RCP< const Teuchos::Comm< int > > comm )

protected

Merge all the timers together into a single structure

Parameters

[in] comm - Communicator to use

Definition at line 82 of file Teuchos_StackedTimer.cpp.

void Teuchos::StackedTimer::collectRemoteData	(	Teuchos::RCP< const Teuchos::Comm< int > >	comm,
		const OutputOptions &	options
	)

protected

Migrate all the timer data to rank=0 if parallel

Definition at line 89 of file Teuchos_StackedTimer.cpp.

double Teuchos::StackedTimer::computeColumnWidthsForAligment	(	std::string	prefix,
		int	print_level,
		std::vector< bool > &	printed,
		double	parent_time,
		const OutputOptions &	options
	)

protected

Compute the column widths to align the output from report() in columns.

Returns: total time for this level

Definition at line 184 of file Teuchos_StackedTimer.cpp.

double Teuchos::StackedTimer::printLevel	(	std::string	prefix,
		int	level,
		std::ostream &	os,
		std::vector< bool > &	printed,
		double	parent_time,
		const OutputOptions &	options
	)

protected

Recursive call to print a level of timer data.

Definition at line 307 of file Teuchos_StackedTimer.cpp.

Member Data Documentation

LevelTimer* Teuchos::StackedTimer::top_

protected

Current level running.

Definition at line 609 of file Teuchos_StackedTimer.hpp.

LevelTimer Teuchos::StackedTimer::timer_

protected

Base timer.

Definition at line 611 of file Teuchos_StackedTimer.hpp.

bool Teuchos::StackedTimer::enable_verbose_

protected

If set to true, prints to the debug ostream. At construction, default value is set from environment variable.

Definition at line 647 of file Teuchos_StackedTimer.hpp.

Teuchos::RCP<std::ostream> Teuchos::StackedTimer::verbose_ostream_

protected

For debugging, this is the ostream used for printing.

Definition at line 650 of file Teuchos_StackedTimer.hpp.

The documentation for this class was generated from the following files:

Classes

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation