Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary > Struct Template Reference

Matcher to select events that occur within a region. More...

#include <EventRegionMatcher.hpp>

Public Member Functions
bool	operator() (const PushRegionEvent &event)
	If the event matches matcher, matching is set to true.
bool	operator() (const PopRegionEvent &)
	Decrement nested_level if we are still matching.
template<Event EventType>
bool	operator() (const EventType &) const

Public Attributes
MatcherType	matcher {}
bool	matching = false
uint32_t	nested_level = invalid_nested_level

Static Public Attributes
static constexpr uint32_t	invalid_nested_level = Kokkos::Experimental::finite_max_v<uint32_t>

Detailed Description

template<typename MatcherType, bool TrueOnBoundary = false>
requires MatcherFor<MatcherType, PushRegionEvent>
struct Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >

Matcher to select events that occur within a region.

The region is selected by matcher.

Any event occuring between the matching PushRegionEvent and its corresponding PopRegionEvent will match.

Set TrueOnBoundary to true if it must return true for the opening PushRegionEvent and closing PopRegionEvent and false otherwise.

Definition at line 22 of file EventRegionMatcher.hpp.

Member Function Documentation

operator()() [1/3]

template<typename MatcherType, bool TrueOnBoundary = false>

template<Event EventType>

bool Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >::operator() ( const EventType & ) const

inline

Definition at line 62 of file EventRegionMatcher.hpp.

operator()() [2/3]

template<typename MatcherType, bool TrueOnBoundary = false>

bool Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >::operator() ( const PopRegionEvent & )

inline

Decrement nested_level if we are still matching.

Definition at line 45 of file EventRegionMatcher.hpp.

operator()() [3/3]

template<typename MatcherType, bool TrueOnBoundary = false>

bool Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >::operator() ( const PushRegionEvent & event )

inline

If the event matches matcher, matching is set to true.

Definition at line 27 of file EventRegionMatcher.hpp.

Member Data Documentation

invalid_nested_level

template<typename MatcherType, bool TrueOnBoundary = false>

uint32_t Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >::invalid_nested_level = Kokkos::Experimental::finite_max_v<uint32_t>

staticconstexpr

Definition at line 24 of file EventRegionMatcher.hpp.

matcher

template<typename MatcherType, bool TrueOnBoundary = false>

MatcherType Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >::matcher {}

Definition at line 66 of file EventRegionMatcher.hpp.

matching

template<typename MatcherType, bool TrueOnBoundary = false>

bool Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >::matching = false

Definition at line 67 of file EventRegionMatcher.hpp.

nested_level

template<typename MatcherType, bool TrueOnBoundary = false>

uint32_t Kokkos::utils::callbacks::EventRegionMatcher< MatcherType, TrueOnBoundary >::nested_level = invalid_nested_level

Definition at line 68 of file EventRegionMatcher.hpp.

---

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

• /__w/kokkos-utils/kokkos-utils/include/kokkos-utils/callbacks/EventRegionMatcher.hpp