tim::component::voluntary_context_switch Struct Reference

the number of times a context switch resulted due to a process voluntarily giving up the processor before its time slice was completed (usually to await availability of a resource). More...

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

Collaboration diagram for tim::component::voluntary_context_switch:

Public Types
using	value_type = int64_t
using	base_type = base< voluntary_context_switch >
using	storage_type = empty_storage

Public Member Functions
value_type	get_display () const
value_type	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)
template<typename... Args>
static opaque	get_opaque (Args &&...)

Static Public Attributes
static const short	precision = 0
static const short	width = 3
static const std::ios_base::fmtflags	format_flags = {}

Detailed Description

the number of times a context switch resulted due to a process voluntarily giving up the processor before its time slice was completed (usually to await availability of a resource).

Definition at line 329 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::voluntary_context_switch::base_type = base<voluntary_context_switch>

Definition at line 332 of file components.hpp.

storage_type

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

inherited

Definition at line 66 of file declaration.hpp.

value_type

using tim::component::voluntary_context_switch::value_type = int64_t

Definition at line 331 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 339 of file components.hpp.

    {
        return "Number of context switches due to a process voluntarily giving up the "
               "processor before its time slice was completed";
    }

get()

value_type tim::component::voluntary_context_switch::get ( ) const

inline

Definition at line 350 of file components.hpp.

{ return get_display(); }

References get_display().

get_display()

value_type tim::component::voluntary_context_switch::get_display ( ) const

inline

Definition at line 345 of file components.hpp.

    {
        auto val = base_type::load();
        return val;
    }

References tim::component::base< voluntary_context_switch >::load().

Referenced by 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::voluntary_context_switch::label ( )

inlinestatic

Definition at line 338 of file components.hpp.

{ return "vol_cxt_swch"; }

record() [1/2]

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

inlinestatic

Definition at line 344 of file components.hpp.

{ return get_num_voluntary_context_switch(); }

Referenced by start(), and stop().

record() [2/2]

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

inlinestatic

Definition at line 358 of file components.hpp.

    {
        return _cache.get_num_voluntary_context_switch();
    }

start() [1/2]

void tim::component::voluntary_context_switch::start ( )

inline

Definition at line 351 of file components.hpp.

{ value = record(); }

References record().

start() [2/2]

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

inline

Definition at line 363 of file components.hpp.

{ value = record(_cache); }

References record().

stop() [1/2]

void tim::component::voluntary_context_switch::stop ( )

inline

Definition at line 352 of file components.hpp.

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

References record().

stop() [2/2]

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

inline

Definition at line 365 of file components.hpp.

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

References record().

Member Data Documentation

format_flags

const std::ios_base::fmtflags tim::component::voluntary_context_switch::format_flags = {}

static

Definition at line 336 of file components.hpp.

precision

const short tim::component::voluntary_context_switch::precision = 0

static

Definition at line 334 of file components.hpp.

width

const short tim::component::voluntary_context_switch::width = 3

static

Definition at line 335 of file components.hpp.

---

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

• timemory/components/rusage/components.hpp