tim::component::wall_clock Struct Reference

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

Collaboration diagram for tim::component::wall_clock:

Public Types
using	ratio_t = std::nano
using	value_type = int64_t
using	base_type = base< wall_clock, value_type >

Public Member Functions
double	get () const noexcept
auto	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

Detailed Description

Definition at line 44 of file wall_clock.hpp.

Member Typedef Documentation

base_type

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

Definition at line 48 of file wall_clock.hpp.

ratio_t

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

Definition at line 46 of file wall_clock.hpp.

value_type

using tim::component::wall_clock::value_type = int64_t

Definition at line 47 of file wall_clock.hpp.

Member Function Documentation

description()

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

inlinestatic

Definition at line 51 of file wall_clock.hpp.

    {
        return "Real-clock timer (i.e. wall-clock timer)";
    }

get()

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

inlinenoexcept

Definition at line 60 of file wall_clock.hpp.

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

References tim::component::base< wall_clock, int64_t >::get_unit(), and tim::component::base< wall_clock, int64_t >::load().

Referenced by get_display().

get_display()

auto tim::component::wall_clock::get_display ( ) const

inlinenoexcept

Definition at line 64 of file wall_clock.hpp.

{ return get(); }

References get().

label()

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

inlinestatic

Definition at line 50 of file wall_clock.hpp.

{ return "wall"; }

record()

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

inlinestaticnoexcept

Definition at line 55 of file wall_clock.hpp.

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

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

start()

void tim::component::wall_clock::start ( )

inlinenoexcept

Definition at line 66 of file wall_clock.hpp.

{ value = record(); }

References record().

stop()

void tim::component::wall_clock::stop ( )

inlinenoexcept

Definition at line 67 of file wall_clock.hpp.

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

References record().

---

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

• timemory/components/timing/wall_clock.hpp