tim::component::peak_rss Struct Reference

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"

Collaboration diagram for tim::component::peak_rss:

Public Types
using	storage_type = empty_storage
using	base_type = void

Public Member Functions
double	get () const
double	get_display () const
void	start ()
void	stop ()
void	sample ()
	sample a measurement More...
void	sample (const cache_type &_cache)
	sample a measurement from cached data More...
void	start (const cache_type &_cache)
	start a measurement using the cached data More...
void	stop (const cache_type &_cache)
	stop a measurement using the cached data More...

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()
static value_type	record (const cache_type &_cache)
	read the value from cached data More...
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

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.

Member Typedef Documentation

base_type

using tim::component::empty_base::base_type = void

inherited

Definition at line 67 of file declaration.hpp.

storage_type

using tim::component::empty_base::storage_type = empty_storage

inherited

Definition at line 66 of file declaration.hpp.

Member Function Documentation

description()

static std::string tim::component::peak_rss::description ( )

inlinestatic

Definition at line 53 of file components.hpp.

    {
        return "Measures changes in the high-water mark for the amount of memory "
               "allocated in RAM. May fluctuate if swap is enabled";
    }

get()

double tim::component::peak_rss::get ( ) const

inline

Definition at line 59 of file components.hpp.

    {
        auto val = base_type::load();
        return val / static_cast<double>(base_type::get_unit());
    }

References tim::cereal::load().

Referenced by get_display().

get_display()

double tim::component::peak_rss::get_display ( ) const

inline

Definition at line 64 of file components.hpp.

{ return get(); }

References get().

get_opaque()

template<typename... Args>

static opaque tim::component::empty_base::get_opaque ( Args &&  ... )

inlinestaticinherited

Definition at line 72 of file declaration.hpp.

    {
        return opaque{};
    }

label()

static std::string tim::component::peak_rss::label ( )

inlinestatic

Definition at line 52 of file components.hpp.

{ return "peak_rss"; }

record() [1/2]

static value_type tim::component::peak_rss::record ( )

inlinestatic

Definition at line 58 of file components.hpp.

{ return get_peak_rss(); }

Referenced by sample(), start(), and stop().

record() [2/2]

static value_type tim::component::peak_rss::record ( const cache_type &  _cache )

inlinestatic

read the value from cached data

Definition at line 83 of file components.hpp.

{ return _cache.get_peak_rss(); }

sample() [1/2]

void tim::component::peak_rss::sample ( )

inline

sample a measurement

Definition at line 74 of file components.hpp.

{ accum = value = std::max<int64_t>(value, record()); }

References record().

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.

    {
        accum = value = std::max<int64_t>(value, record(_cache));
    }

References record().

start() [1/2]

void tim::component::peak_rss::start ( )

inline

Definition at line 66 of file components.hpp.

{ value = record(); }

References record().

start() [2/2]

void tim::component::peak_rss::start ( const cache_type &  _cache )

inline

start a measurement using the cached data

Definition at line 86 of file components.hpp.

{ value = record(_cache); }

References record().

stop() [1/2]

void tim::component::peak_rss::stop ( )

inline

Definition at line 67 of file components.hpp.

    {
        value = (record() - value);
        accum += value;
    }

References record().

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.

    {
        auto tmp   = record(_cache);
        auto delta = tmp - value;
        accum      = std::max(static_cast<const value_type&>(accum), delta);
        value      = tmp;
    }

References std::max(), and record().

---

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

• timemory/components/rusage/components.hpp