this struct extracts the absolute value of high-water mark of the resident set size (RSS) at start and stop points. RSS is current amount of memory in RAM. More...

#include "timemory/components/rusage/components.hpp"

Collaboration diagram for tim::component::current_peak_rss:

Public Types
using	unit_type = std::pair< int64_t, int64_t >

using	display_unit_type = std::pair< std::string, std::string >

using	result_type = std::pair< double, double >

using	this_type = current_peak_rss

using	storage_type = empty_storage

using	base_type = void

Public Member Functions
void	start ()

void	stop ()

void	start (const cache_type &_cache)

void	stop (const cache_type &_cache)

std::string	get_display () const

result_type	get () const

Static Public Member Functions
static std::string	label ()

static std::string	description ()

static value_type	record ()

static value_type	record (const cache_type &_cache)

static std::pair< double, double >	unit ()

static std::vector< std::string >	display_unit_array ()

static std::vector< std::string >	label_array ()

static display_unit_type	display_unit ()

static std::pair< double, double >	unit_array ()

static std::vector< std::string >	description_array ()

static unit_type	get_unit ()

static display_unit_type	get_display_unit ()

template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

this struct extracts the absolute value of high-water mark of the resident set size (RSS) at start and stop points. RSS is current amount of memory in RAM.

Definition at line 563 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.

◆ display_unit_type

using tim::component::current_peak_rss::display_unit_type = std::pair<std::string, std::string>

Definition at line 566 of file components.hpp.

◆ result_type

using tim::component::current_peak_rss::result_type = std::pair<double, double>

Definition at line 567 of file components.hpp.

◆ storage_type

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

inherited

Definition at line 66 of file declaration.hpp.

◆ this_type

using tim::component::current_peak_rss::this_type = current_peak_rss

Definition at line 568 of file components.hpp.

◆ unit_type

using tim::component::current_peak_rss::unit_type = std::pair<int64_t, int64_t>

Definition at line 565 of file components.hpp.

Member Function Documentation

◆ description()

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

inlinestatic

Definition at line 571 of file components.hpp.

    {
        return "Absolute value of high-water mark of memory allocation in RAM";
    }

◆ description_array()

static std::vector< std::string > tim::component::current_peak_rss::description_array ( )

inlinestatic

Definition at line 655 of file components.hpp.

    {
        return std::vector<std::string>{ "Resident set size at start",
                                         "Resident set size at stop" };
    }

◆ display_unit()

static display_unit_type tim::component::current_peak_rss::display_unit ( )

inlinestatic

Definition at line 651 of file components.hpp.

651{ return display_unit_type{ "MB", "MB" }; }

tim::component::current_peak_rss::display_unit_type

std::pair< std::string, std::string > display_unit_type

Definition: components.hpp:566

Referenced by get_display_unit().

◆ display_unit_array()

static std::vector< std::string > tim::component::current_peak_rss::display_unit_array ( )

inlinestatic

Definition at line 640 of file components.hpp.

    {
        return std::vector<std::string>{ get_display_unit().first,
                                         get_display_unit().second };
    }

References get_display_unit().

◆ get()

result_type tim::component::current_peak_rss::get ( ) const

inline

Definition at line 627 of file components.hpp.

    {
        result_type data = base_type::load();
        data.first /= get_unit().first;
        data.second /= get_unit().second;
        return data;
    }

References get_unit(), and tim::cereal::load().

Referenced by get_display().

◆ get_display()

std::string tim::component::current_peak_rss::get_display ( ) const

inline

Definition at line 601 of file components.hpp.

    {
        std::stringstream ss;
        std::stringstream ssv;
        std::stringstream ssr;
        auto              _prec  = base_type::get_precision();
        auto              _width = base_type::get_width();
        auto              _flags = base_type::get_format_flags();
        auto              _disp  = get_display_unit();
 
        auto _val = get();
 
        ssv.setf(_flags);
        ssv << std::setw(_width) << std::setprecision(_prec) << std::get<0>(_val);
        if(!std::get<0>(_disp).empty())
            ssv << " " << std::get<0>(_disp);
 
        ssr.setf(_flags);
        ssr << std::setw(_width) << std::setprecision(_prec) << std::get<1>(_val);
        if(!std::get<1>(_disp).empty())
            ssr << " " << std::get<1>(_disp);
 
        ss << ssv.str() << ", " << ssr.str();
        return ss.str();
    }

References get(), and get_display_unit().

◆ get_display_unit()

static display_unit_type tim::component::current_peak_rss::get_display_unit ( )

inlinestatic

Definition at line 675 of file components.hpp.

    {
        static display_unit_type _instance = this_type::display_unit();
        static auto&             _mem      = _instance;
 
        if(settings::memory_units().length() > 0)
        {
            _mem.first  = std::get<0>(units::get_memory_unit(settings::memory_units()));
            _mem.second = std::get<0>(units::get_memory_unit(settings::memory_units()));
        }
 
        return _mem;
    }

References display_unit(), tim::units::get_memory_unit(), and tim::memory_units.

Referenced by display_unit_array(), and get_display().

◆ 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{};
    }

◆ get_unit()

static unit_type tim::component::current_peak_rss::get_unit ( )

inlinestatic

Definition at line 661 of file components.hpp.

    {
        static auto  _instance = this_type::unit();
        static auto& _mem      = _instance;
 
        if(settings::memory_units().length() > 0)
        {
            _mem.first  = std::get<1>(units::get_memory_unit(settings::memory_units()));
            _mem.second = std::get<1>(units::get_memory_unit(settings::memory_units()));
        }
 
        return _mem;
    }

References tim::units::get_memory_unit(), tim::memory_units, and unit().

Referenced by get().

◆ label()

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

inlinestatic

Definition at line 570 of file components.hpp.

570{ return "current_peak_rss"; }

◆ label_array()

static std::vector< std::string > tim::component::current_peak_rss::label_array ( )

inlinestatic

Definition at line 646 of file components.hpp.

    {
        return std::vector<std::string>{ "start peak rss", " stop peak rss" };
    }

◆ record() [1/2]

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

inlinestatic

Definition at line 576 of file components.hpp.

576{ return value_type{ get_peak_rss(), 0 }; }

tim::component::base< current_peak_rss, std::pair< int64_t, int64_t > >::value_type

std::pair< int64_t, int64_t > value_type

Definition: declaration.hpp:106

Referenced by start(), and stop().

◆ record() [2/2]

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

inlinestatic

Definition at line 587 of file components.hpp.

    {
        return value_type{ _cache.get_peak_rss(), 0 };
    }

◆ start() [1/2]

void tim::component::current_peak_rss::start ( )

inline

Definition at line 578 of file components.hpp.

578{ value = record(); }

tim::component::current_peak_rss::record

static value_type record()

Definition: components.hpp:576

References record().

◆ start() [2/2]

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

inline

Definition at line 592 of file components.hpp.

592{ value = record(_cache); }

References record().

◆ stop() [1/2]

void tim::component::current_peak_rss::stop ( )

inline

Definition at line 580 of file components.hpp.

    {
        using namespace tim::component::operators;
        value = value_type{ value.first, record().first };
        accum = std::max(accum, value);
    }

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

◆ stop() [2/2]

void tim::component::current_peak_rss::stop ( const cache_type & _cache )

inline

Definition at line 594 of file components.hpp.

    {
        value = value_type{ value.first, record(_cache).first };
        accum = std::max(accum, value);
    }

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

◆ unit()

static std::pair< double, double > tim::component::current_peak_rss::unit ( )

inlinestatic

Definition at line 635 of file components.hpp.

    {
        return std::pair<double, double>{ units::megabyte, units::megabyte };
    }

Referenced by get_unit(), and unit_array().

◆ unit_array()

static std::pair< double, double > tim::component::current_peak_rss::unit_array ( )

inlinestatic

Definition at line 653 of file components.hpp.

653{ return unit(); }

References unit().

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

timemory/components/rusage/components.hpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ base_type

◆ display_unit_type

◆ result_type

◆ storage_type

◆ this_type

◆ unit_type

Member Function Documentation

◆ description()

◆ description_array()

◆ display_unit()

◆ display_unit_array()

◆ get()

◆ get_display()

◆ get_display_unit()

◆ get_opaque()

◆ get_unit()

◆ label()

◆ label_array()

◆ record() [1/2]

◆ record() [2/2]

◆ start() [1/2]

◆ start() [2/2]

◆ stop() [1/2]

◆ stop() [2/2]

◆ unit()

◆ unit_array()