Boost C++ Libraries Home Libraries People FAQ More

PrevUpHomeNext

Class timer

boost::mpi::timer — A simple timer that provides access to the MPI timing facilities.

Synopsis

// In header: <boost/mpi/timer.hpp>


class timer {
public:
  // construct/copy/destruct
  ();

  // public member functions
   ();
   () ;
   () ;
   () ;

  // public static functions
   ();
};

Description

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

timer public construct/copy/destruct

  1. ();

    Initializes the timer

    Postconditions:

    elapsed() == 0

timer public member functions

  1.  ();

    Restart the timer.

    Postconditions:

    elapsed() == 0

  2.  () ;

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

  3.  () ;

    Return an estimate of the maximum possible value of elapsed(). Note that this routine may return too high a value on some systems.

  4.  () ;

    Returns the minimum non-zero value that elapsed() may return. This is the resolution of the timer.

timer public static functions

  1.  ();

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


PrevUpHomeNext