rapidsmpf::Statistics::ReportArgs Struct Reference

Named-argument struct for report(). More...

#include <statistics.hpp>

Public Attributes
std::optional< any_device_resource >	mr = std::nullopt
std::optional< any_host_device_resource >	pinned_mr = std::nullopt
std::string_view	header = "Statistics:"
	Header line prepended to the report.

Detailed Description

Named-argument struct for report().

All fields carry defaults so any subset may be supplied using designated initialisers:

stats.report({.mr = my_mr, .header = "Run 1:"});

Definition at line 177 of file statistics.hpp.

Member Data Documentation

mr

std::optional<any_device_resource> rapidsmpf::Statistics::ReportArgs::mr = std::nullopt

Optional RMM resource adaptor used for memory profiling. When provided, a memory profiling section is included in the report. When std::nullopt, the memory profiling section shows "Disabled".

Definition at line 181 of file statistics.hpp.

pinned_mr

std::optional<any_host_device_resource> rapidsmpf::Statistics::ReportArgs::pinned_mr = std::nullopt

Optional pinned memory resource. When provided, a pinned memory section is included in the report.

Definition at line 184 of file statistics.hpp.

---

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

• /__w/rapidsmpf/rapidsmpf/cpp/include/rapidsmpf/statistics.hpp