this struct extracts the high-water mark (or a change in the high-water mark) of the resident set size (RSS). Which is current amount of memory in RAM. When used on a system with swap enabled, this value may fluctuate but should not on an HPC system.
More...
#include "timemory/components/rusage/components.hpp"
this struct extracts the high-water mark (or a change in the high-water mark) of the resident set size (RSS). Which is current amount of memory in RAM. When used on a system with swap enabled, this value may fluctuate but should not on an HPC system.
Definition at line 50 of file components.hpp.
◆ description()
static std::string tim::component::peak_rss::description |
( |
| ) |
|
|
inlinestatic |
Definition at line 53 of file components.hpp.
55 return "Measures changes in the high-water mark for the amount of memory "
56 "allocated in RAM. May fluctuate if swap is enabled";
◆ get()
double tim::component::peak_rss::get |
( |
| ) |
const |
|
inline |
◆ get_display()
double tim::component::peak_rss::get_display |
( |
| ) |
const |
|
inline |
◆ label()
static std::string tim::component::peak_rss::label |
( |
| ) |
|
|
inlinestatic |
◆ record() [1/2]
static value_type tim::component::peak_rss::record |
( |
| ) |
|
|
inlinestatic |
◆ record() [2/2]
read the value from cached data
Definition at line 83 of file components.hpp.
83 {
return _cache.get_peak_rss(); }
◆ sample() [1/2]
void tim::component::peak_rss::sample |
( |
| ) |
|
|
inline |
◆ sample() [2/2]
void tim::component::peak_rss::sample |
( |
const cache_type & |
_cache | ) |
|
|
inline |
sample a measurement from cached data
Definition at line 77 of file components.hpp.
79 accum = value = std::max<int64_t>(value,
record(_cache));
References record().
◆ start() [1/2]
void tim::component::peak_rss::start |
( |
| ) |
|
|
inline |
◆ start() [2/2]
void tim::component::peak_rss::start |
( |
const cache_type & |
_cache | ) |
|
|
inline |
◆ stop() [1/2]
void tim::component::peak_rss::stop |
( |
| ) |
|
|
inline |
◆ stop() [2/2]
void tim::component::peak_rss::stop |
( |
const cache_type & |
_cache | ) |
|
|
inline |
stop a measurement using the cached data
Definition at line 89 of file components.hpp.
92 auto delta = tmp - value;
::tim::statistics< Tp > max(::tim::statistics< Tp > lhs, const Tp &rhs)
References record().
The documentation for this struct was generated from the following file: