rapidsmpf::Statistics::MemoryRecorder Class Reference

RAII-style object for scoped memory usage tracking. More...

#include <statistics.hpp>

Public Member Functions
	MemoryRecorder ()=default
	Constructs a no-op MemoryRecorder.
	MemoryRecorder (std::shared_ptr< Statistics > stats, RmmResourceAdaptor mr, std::string name)
	Constructs an active MemoryRecorder. Pushes a scoped record at construction; the destructor pops it and (if stats is still enabled) publishes it under name. More...
	MemoryRecorder (MemoryRecorder const &)=delete
MemoryRecorder &	operator= (MemoryRecorder const &)=delete
	MemoryRecorder (MemoryRecorder &&)=delete
MemoryRecorder &	operator= (MemoryRecorder &&)=delete

Detailed Description

RAII-style object for scoped memory usage tracking.

Automatically tracks memory usage between construction and destruction.

Definition at line 570 of file statistics.hpp.

Constructor & Destructor Documentation

MemoryRecorder()

rapidsmpf::Statistics::MemoryRecorder::MemoryRecorder	(	std::shared_ptr< Statistics >	stats,
		RmmResourceAdaptor	mr,
		std::string	name
	)

Constructs an active MemoryRecorder. Pushes a scoped record at construction; the destructor pops it and (if stats is still enabled) publishes it under name.

Parameters

stats	Owning Statistics. Must not be null.
mr	RMM resource adaptor providing scoped memory statistics.
name	Name of the scope.

---

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

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