tim::component::thread_cpu_clock Struct Reference

this clock measures the CPU time within the current thread (excludes sibling/child threads). Only relevant as a time when a different is computed Do not use a single CPU time as an amount of time; it doesn't work that way. More...

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

Collaboration diagram for tim::component::thread_cpu_clock:

Public Types
using	ratio_t = std::nano
using	value_type = int64_t
using	base_type = base< thread_cpu_clock, value_type >
using	storage_type = empty_storage

Public Member Functions
double	get () const noexcept
double	get_display () const noexcept
void	start () noexcept
void	stop () noexcept

Static Public Member Functions
static std::string	label ()
static std::string	description ()
static value_type	record () noexcept
template<typename... Args>
static opaque	get_opaque (Args &&...)

Detailed Description

this clock measures the CPU time within the current thread (excludes sibling/child threads). Only relevant as a time when a different is computed Do not use a single CPU time as an amount of time; it doesn't work that way.

Definition at line 206 of file components.hpp.

Member Typedef Documentation

base_type

using tim::component::thread_cpu_clock::base_type = base<thread_cpu_clock, value_type>

Definition at line 210 of file components.hpp.

ratio_t

using tim::component::thread_cpu_clock::ratio_t = std::nano

Definition at line 208 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::thread_cpu_clock::value_type = int64_t

Definition at line 209 of file components.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 213 of file components.hpp.

{ return "CPU-clock timer for the calling thread"; }

get()

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

inlinenoexcept

Definition at line 218 of file components.hpp.

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

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

Referenced by get_display().

get_display()

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

inlinenoexcept

Definition at line 222 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::thread_cpu_clock::label ( )

inlinestatic

Definition at line 212 of file components.hpp.

{ return "thread_cpu"; }

record()

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

inlinestaticnoexcept

Definition at line 214 of file components.hpp.

    {
        return tim::get_clock_thread_now<int64_t, ratio_t>();
    }

Referenced by tim::component::thread_cpu_util::record(), start(), and stop().

start()

void tim::component::thread_cpu_clock::start ( )

inlinenoexcept

Definition at line 223 of file components.hpp.

{ value = record(); }

References record().

stop()

void tim::component::thread_cpu_clock::stop ( )

inlinenoexcept

Definition at line 224 of file components.hpp.

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

References record().

---

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

• timemory/components/timing/components.hpp