Kokkos::Time Class Reference

Kokkos_Time: The Kokkos Timing Class. More...

#include <Kokkos_Time.hpp>

List of all members.

Public Member Functions
	Time ()
	Time Constructor.
	Time (const Time &time)
	Time Copy Constructor.
double	wallTime () const
	Time wall-clock time function.
void	resetStartTime ()
	Kokkos_Time function to reset the start time for a timer object.
double	elapsedTime () const
	Kokkos_Time elapsed time function.
virtual	~Time ()
	Kokkos_Time Destructor.

---

Detailed Description

Kokkos_Time: The Kokkos Timing Class.

The Kokkos_Time class is a wrapper that encapsulates the general information needed getting timing information. Currently it return the elapsed time for each calling processor.. A Kokkos_Comm object is required for building all Kokkos_Time objects.

Kokkos_Time support both serial execution and (via MPI) parallel distributed memory execution. It is meant to insulate the user from the specifics of timing across a variety of platforms.

---

Constructor & Destructor Documentation

Kokkos::Time::Time (   )  [inline]

Time Constructor. Creates a Time instance. This instance can be queried for elapsed time on the calling processor. StartTime is also set for use with the ElapsedTime function.

Kokkos::Time::Time (  const Time &  time  )  [inline]

Time Copy Constructor. Makes an exact copy of an existing Time instance.

virtual Kokkos::Time::~Time (   )  [inline, virtual]

Kokkos_Time Destructor. Completely deletes a Kokkos_Time object.

---

Member Function Documentation

double Kokkos::Time::elapsedTime (   )  const [inline]

Kokkos_Time elapsed time function. Returns the elapsed time in seconds since the timer object was constructed, or since the ResetStartTime function was called. A code section can be timed by putting it between the Kokkos_Time constructor and a call to ElapsedTime, or between a call to ResetStartTime and ElapsedTime.

void Kokkos::Time::resetStartTime (   )  [inline]

Kokkos_Time function to reset the start time for a timer object. Resets the start time for the timer object to the current time A code section can be timed by putting it between a call to ResetStartTime and ElapsedTime.

double Kokkos::Time::wallTime (   )  const [inline]

Time wall-clock time function. Returns the wall-clock time in seconds. A code section can be timed by putting it between two calls to wallTime and taking the difference of the times.

---

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

• Kokkos_Time.hpp

---