nvtx3::category Class Reference

Object for intra-domain grouping of NVTX events. More...

#include <nvtx3.hpp>

Inheritance diagram for nvtx3::category:

Public Types
using	id_type = uint32_t
	Type used for categorys integer id.

Public Member Functions
constexpr	category (id_type id) noexcept
	Construct a category with the specified id. More...
constexpr id_type	get_id () const noexcept
	Returns the id of the category.
	category (category const &)=default
category &	operator= (category const &)=default
	category (category &&)=default
category &	operator= (category &&)=default

Detailed Description

Object for intra-domain grouping of NVTX events.

A category is simply an integer id that allows for fine-grain grouping of NVTX events. For example, one might use separate categories for IO, memory allocation, compute, etc.

Example:

nvtx3::category cat1{1};

// Range `r1` belongs to the category identified by the value `1`.
nvtx3::thread_range r1{cat1};

// Range `r2` belongs to the same category as `r1`
nvtx3::thread_range r2{nvtx3::category{1}};

To associate a name string with a category id, see named_category.

Constructor & Destructor Documentation

constexpr nvtx3::category::category ( id_type  id )

inlineexplicitnoexcept

Construct a category with the specified id.

The category will be unnamed and identified only by its id value.

All category objects sharing the same id are equivalent.

Parameters

[in]

id

The category's identifying value

---

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

• nvtx3.hpp