Kokkos::utils::timer::Event< Kokkos::HIP > Struct Reference

Specialization for Kokkos::HIP that uses hipEvent_t. More...

#include <Event.hpp>

Classes
struct	EventDeleter
	To be used for the custom deleter of event. More...

Public Types
using	impl_event_t = hipEvent_t
using	event_storage_t = std::unique_ptr<ihipEvent_t, EventDeleter>
using	impl_clock_t
	Let's choose a steady clock.
using	impl_event_t

Public Member Functions
	Event ()
void	record (const Kokkos::HIP &exec)
	Record this event in the execution space instance exec.
template<typename Duration = milliseconds>
Duration	duration (Event &other)
void	record ()
	Record this event.
void	record (const Exec &)
Duration	duration (const Event &other) const
	Get a Duration object between this event and other.

Public Attributes
event_storage_t	event = nullptr
impl_event_t	event

Private Member Functions
float	elapsed (Event &other)
	Measure the elapsed time in milliseconds.

Detailed Description

Specialization for Kokkos::HIP that uses hipEvent_t.

Note

It must properly manage event.

Definition at line 15 of file Event.hpp.

Member Typedef Documentation

event_storage_t

using Kokkos::utils::timer::Event< Kokkos::HIP >::event_storage_t = std::unique_ptr<ihipEvent_t, EventDeleter>

Definition at line 26 of file Event.hpp.

impl_clock_t

using Kokkos::utils::timer::Event< Kokkos::HIP >::impl_clock_t

Let's choose a steady clock.

Definition at line 35 of file Event.hpp.

impl_event_t [1/2]

using Kokkos::utils::timer::Event< Kokkos::HIP >::impl_event_t

Definition at line 41 of file Event.hpp.

impl_event_t [2/2]

using Kokkos::utils::timer::Event< Kokkos::HIP >::impl_event_t = hipEvent_t

Definition at line 25 of file Event.hpp.

Constructor & Destructor Documentation

Event()

Kokkos::utils::timer::Event< Kokkos::HIP >::Event ( )

inline

Definition at line 32 of file Event.hpp.

Member Function Documentation

duration() [1/2]

Duration Kokkos::utils::timer::Event< Kokkos::HIP >::duration ( const Event< Kokkos::HIP > & other ) const

inline

Get a Duration object between this event and other.

Definition at line 60 of file Event.hpp.

duration() [2/2]

template<typename Duration = milliseconds>

Duration Kokkos::utils::timer::Event< Kokkos::HIP >::duration ( Event< Kokkos::HIP > & other )

inline

Definition at line 42 of file Event.hpp.

elapsed()

float Kokkos::utils::timer::Event< Kokkos::HIP >::elapsed ( Event< Kokkos::HIP > & other )

inlineprivate

Measure the elapsed time in milliseconds.

As specified in https://rocm.docs.amd.com/projects/HIP/en/develop/doxygen/html/group___event.html.

Definition at line 52 of file Event.hpp.

record() [1/3]

void Kokkos::utils::timer::Event< Kokkos::HIP >::record ( )

inline

Record this event.

Definition at line 48 of file Event.hpp.

record() [2/3]

void Kokkos::utils::timer::Event< Kokkos::HIP >::record ( const Exec & )

inline

Definition at line 54 of file Event.hpp.

record() [3/3]

void Kokkos::utils::timer::Event< Kokkos::HIP >::record ( const Kokkos::HIP & exec )

inline

Record this event in the execution space instance exec.

Definition at line 39 of file Event.hpp.

Member Data Documentation

event [1/2]

impl_event_t Kokkos::utils::timer::Event< Kokkos::HIP >::event

Definition at line 43 of file Event.hpp.

event [2/2]

event_storage_t Kokkos::utils::timer::Event< Kokkos::HIP >::event = nullptr

Definition at line 30 of file Event.hpp.

---

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

• /__w/kokkos-utils/kokkos-utils/include/kokkos-utils/timer/HIP/Event.hpp