Public Member Functions | List of all members
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 (disabled state).
 
 MemoryRecorder (Statistics *stats, RmmResourceAdaptor *mr, std::string name)
 Constructs an active MemoryRecorder. More...
 
 ~MemoryRecorder ()
 Destructor. More...
 
 MemoryRecorder (MemoryRecorder const &)=delete
 Deleted copy and move constructors/assignments.
 
MemoryRecorderoperator= (MemoryRecorder const &)=delete
 
 MemoryRecorder (MemoryRecorder &&)=delete
 
MemoryRecorderoperator= (MemoryRecorder &&)=delete
 

Detailed Description

RAII-style object for scoped memory usage tracking.

Automatically tracks memory usage between construction and destruction.

Definition at line 263 of file statistics.hpp.

Constructor & Destructor Documentation

◆ MemoryRecorder()

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

Constructs an active MemoryRecorder.

Parameters
statsPointer to Statistics object that will store the result.
mrMemory resource that provides the scoped memory statistics.
nameName of the scope.

◆ ~MemoryRecorder()

rapidsmpf::Statistics::MemoryRecorder::~MemoryRecorder ( )

Destructor.

Captures memory counters and stores them in the Statistics object.


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