A simple timer that provides access to the MPI timing facilities. More...

#include <timer.hpp>

Public Member Functions
	timer ()
	Initializes the timer. More...

void	restart ()
	Restart the timer. More...

double	elapsed () const
	Return the amount of time that has elapsed since the last construction or reset, in seconds. More...

double	elapsed_max () const
	Return an estimate of the maximum possible value of elapsed(). More...

double	elapsed_min () const
	Returns the minimum non-zero value that `elapsed()` may return. More...

Static Public Member Functions
static bool	time_is_global ()
	Determines whether the elapsed time values are global times or local processor times. More...

Detailed Description

A simple timer that provides access to the MPI timing facilities.

The timer class is a simple wrapper around the MPI timing facilities that mimics the interface of the Boost Timer library.

Constructor & Destructor Documentation

boost::mpi::timer::timer ( )

inline

Initializes the timer.

References restart().

double boost::mpi::timer::elapsed ( ) const

inline

Return the amount of time that has elapsed since the last construction or reset, in seconds.

double boost::mpi::timer::elapsed_max ( ) const

inline

Return an estimate of the maximum possible value of elapsed().

Note that this routine may return too high a value on some systems.

double boost::mpi::timer::elapsed_min ( ) const

inline

Returns the minimum non-zero value that elapsed() may return.

This is the resolution of the timer.

void boost::mpi::timer::restart ( )

inline

Restart the timer.

Referenced by timer().

static bool boost::mpi::timer::time_is_global ( )

static

Determines whether the elapsed time values are global times or local processor times.

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