tim::component::user_mode_time Struct Reference

This is the total amount of time spent executing in user mode. More...

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

Collaboration diagram for tim::component::user_mode_time:

Public Types
using	ratio_t = std::micro
using	value_type = int64_t
using	this_type = user_mode_time
using	base_type = base< this_type, value_type >

Public Member Functions
double	get_display () const
double	get () const
void	start ()
void	stop ()
void	start (const cache_type &_cache)
void	stop (const cache_type &_cache)

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record ()
static value_type	record (const cache_type &_cache)

Detailed Description

This is the total amount of time spent executing in user mode.

Definition at line 459 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::user_mode_time::base_type = base<this_type, value_type>

Definition at line 464 of file components.hpp.

ratio_t

using tim::component::user_mode_time::ratio_t = std::micro

Definition at line 461 of file components.hpp.

this_type

using tim::component::user_mode_time::this_type = user_mode_time

Definition at line 463 of file components.hpp.

value_type

using tim::component::user_mode_time::value_type = int64_t

Definition at line 462 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 467 of file components.hpp.

    {
        return "CPU time spent executing in user mode (via rusage)";
    }

get()

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

inline

Definition at line 474 of file components.hpp.

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

References tim::component::base< user_mode_time, int64_t >::get_unit(), and tim::component::base< Tp, Value >::load().

Referenced by get_display().

get_display()

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

inline

Definition at line 473 of file components.hpp.

{ return get(); }

References get().

label()

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

inlinestatic

Definition at line 466 of file components.hpp.

{ return "user_mode"; }

record() [1/2]

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

inlinestatic

Definition at line 471 of file components.hpp.

{ return get_user_mode_time(); }

Referenced by start(), and stop().

record() [2/2]

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

inlinestatic

Definition at line 492 of file components.hpp.

    {
        return _cache.get_user_mode_time();
    }

start() [1/2]

void tim::component::user_mode_time::start ( )

inline

Definition at line 480 of file components.hpp.

{ value = record(); }

References record().

start() [2/2]

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

inline

Definition at line 497 of file components.hpp.

{ value = record(_cache); }

References record().

stop() [1/2]

void tim::component::user_mode_time::stop ( )

inline

Definition at line 482 of file components.hpp.

    {
        auto tmp = record();
        if(tmp > value)
        {
            value = (tmp - value);
            accum += value;
        }
    }

References record().

stop() [2/2]

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

inline

Definition at line 499 of file components.hpp.

    {
        auto tmp = record(_cache);
        if(tmp > value)
        {
            accum += (tmp - value);
            value = tmp;
        }
    }

References record().

---

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

• timemory/components/rusage/components.hpp