tim::component::papi_rate_tuple< RateT, EventTypes > Struct Template Reference

This component pairs a tim::component::papi_tuple with a component which will provide an interval over which the hardware counters will be reported, e.g. if RateT is tim::component::wall_clock, the reported values will be the hardware-counters w.r.t. the wall-clock time. If RateT is tim::component::cpu_clock, the reported values will be the hardware counters w.r.t. the cpu time. More...

#include "timemory/components/papi/papi_rate_tuple.hpp"

Collaboration diagram for tim::component::papi_rate_tuple< RateT, EventTypes >:

Public Types
using	size_type = std::size_t
using	tuple_type = papi_tuple< EventTypes... >
using	rate_type = RateT
using	value_type = std::pair< tuple_type, rate_type >
using	this_type = papi_rate_tuple< RateT, EventTypes... >
using	base_type = base< this_type, value_type >
using	storage_type = typename base_type::storage_type
using	common_type = tuple_type
template<typename Tp >
using	array_t = std::array< Tp, num_events >

Public Member Functions
void	start ()
void	stop ()
this_type &	operator+= (const this_type &rhs)
this_type &	operator-= (const this_type &rhs)
template<typename Tp = double>
auto	get () const

Static Public Member Functions
static void	configure ()
static void	initialize ()
static void	finalize ()
static void	global_init ()
static void	global_finalize ()
static void	thread_init ()
static void	thread_finalize ()
static std::string	label ()
static std::string	description ()
static auto	label_array ()
static auto	description_array ()
static auto	display_unit_array ()
static auto	unit_array ()

Static Public Attributes
static const size_type	num_events = sizeof...(EventTypes)

Friends
struct	operation::record< common_type >
struct	operation::start< this_type >
struct	operation::stop< this_type >
struct	operation::set_started< this_type >
struct	operation::set_stopped< this_type >
class	impl::storage< this_type, trait::uses_value_storage< this_type, value_type >::value >
std::ostream &	operator<< (std::ostream &os, const this_type &obj)

Detailed Description

template<typename RateT, int... EventTypes>
struct tim::component::papi_rate_tuple< RateT, EventTypes >

This component pairs a tim::component::papi_tuple with a component which will provide an interval over which the hardware counters will be reported, e.g. if RateT is tim::component::wall_clock, the reported values will be the hardware-counters w.r.t. the wall-clock time. If RateT is tim::component::cpu_clock, the reported values will be the hardware counters w.r.t. the cpu time.

Template Parameters

RateT	Component whose value will be the divisor for all the hardware counters
EventTypes	Compile-time constant list of PAPI event identifiers

// the "Instructions" alias below explicitly collects the total instructions per
second,
// the number of load instructions per second, the number of store instructions per
second using Instructions = papi_rate_tuple<wall_clock, PAPI_TOT_INS, PAPI_LD_INS,
PAPI_SR_INS>;
 
Instructions inst{};
inst.start();
...
inst.stop();
std::vector<double> data = inst.get();

Definition at line 74 of file papi_rate_tuple.hpp.

Member Typedef Documentation

array_t

template<typename RateT , int... EventTypes>

template<typename Tp >

using tim::component::papi_rate_tuple< RateT, EventTypes >::array_t = std::array<Tp, num_events>

Definition at line 94 of file papi_rate_tuple.hpp.

base_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::base_type = base<this_type, value_type>

Definition at line 89 of file papi_rate_tuple.hpp.

common_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::common_type = tuple_type

Definition at line 91 of file papi_rate_tuple.hpp.

rate_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::rate_type = RateT

Definition at line 86 of file papi_rate_tuple.hpp.

size_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::size_type = std::size_t

Definition at line 82 of file papi_rate_tuple.hpp.

storage_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::storage_type = typename base_type::storage_type

Definition at line 90 of file papi_rate_tuple.hpp.

this_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::this_type = papi_rate_tuple<RateT, EventTypes...>

Definition at line 88 of file papi_rate_tuple.hpp.

tuple_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::tuple_type = papi_tuple<EventTypes...>

Definition at line 85 of file papi_rate_tuple.hpp.

value_type

template<typename RateT , int... EventTypes>

using tim::component::papi_rate_tuple< RateT, EventTypes >::value_type = std::pair<tuple_type, rate_type>

Definition at line 87 of file papi_rate_tuple.hpp.

Member Function Documentation

configure()

template<typename RateT , int... EventTypes>

static void tim::component::papi_rate_tuple< RateT, EventTypes >::configure ( )

inlinestatic

Definition at line 103 of file papi_rate_tuple.hpp.

{ tuple_type::configure(); }

References tim::component::papi_tuple< EventTypes >::configure().

description()

template<typename RateT , int... EventTypes>

static std::string tim::component::papi_rate_tuple< RateT, EventTypes >::description ( )

inlinestatic

Definition at line 141 of file papi_rate_tuple.hpp.

    {
        return std::string(
                   "Reports the rate of the given set of HW counters w.r.t. the ") +
               rate_type::label() + " component";
    }

description_array()

template<typename RateT , int... EventTypes>

static auto tim::component::papi_rate_tuple< RateT, EventTypes >::description_array ( )

inlinestatic

Definition at line 196 of file papi_rate_tuple.hpp.

    {
        auto arr = tuple_type::description_array();
        for(auto& itr : arr)
            itr += " Rate";
        return arr;
    }

References tim::component::papi_tuple< EventTypes >::description_array().

display_unit_array()

template<typename RateT , int... EventTypes>

static auto tim::component::papi_rate_tuple< RateT, EventTypes >::display_unit_array ( )

inlinestatic

Definition at line 204 of file papi_rate_tuple.hpp.

    {
        auto arr = tuple_type::label_array();
        for(auto& itr : arr)
        {
            if(itr.empty())
                itr = "1";
            itr += "/" + rate_type::display_unit();
        }
        return arr;
    }

References tim::component::papi_tuple< EventTypes >::label_array().

finalize()

template<typename RateT , int... EventTypes>

static void tim::component::papi_rate_tuple< RateT, EventTypes >::finalize ( )

inlinestatic

Definition at line 105 of file papi_rate_tuple.hpp.

{ tuple_type::finalize(); }

References tim::component::papi_tuple< EventTypes >::finalize().

get()

template<typename RateT , int... EventTypes>

template<typename Tp = double>

auto tim::component::papi_rate_tuple< RateT, EventTypes >::get ( ) const

inline

Definition at line 180 of file papi_rate_tuple.hpp.

    {
        auto _val = value.first.template get<Tp>();
        for(auto& itr : _val)
            itr /= value.second.get();
        return _val;
    }

global_finalize()

template<typename RateT , int... EventTypes>

static void tim::component::papi_rate_tuple< RateT, EventTypes >::global_finalize ( )

inlinestatic

Definition at line 114 of file papi_rate_tuple.hpp.

    {
        /*operation::fini<tuple_type>{}(
            operation::mode_constant<operation::fini_mode::global>{});
        operation::fini<rate_type>{}(
            operation::mode_constant<operation::fini_mode::global>{});*/
    }

global_init()

template<typename RateT , int... EventTypes>

static void tim::component::papi_rate_tuple< RateT, EventTypes >::global_init ( )

inlinestatic

Definition at line 107 of file papi_rate_tuple.hpp.

    {
        operation::init<tuple_type>{}(
            operation::mode_constant<operation::init_mode::global>{});
        operation::init<rate_type>{}(
            operation::mode_constant<operation::init_mode::global>{});
    }

initialize()

template<typename RateT , int... EventTypes>

static void tim::component::papi_rate_tuple< RateT, EventTypes >::initialize ( )

inlinestatic

Definition at line 104 of file papi_rate_tuple.hpp.

{ tuple_type::initialize(); }

References tim::component::papi_tuple< EventTypes >::initialize().

label()

template<typename RateT , int... EventTypes>

static std::string tim::component::papi_rate_tuple< RateT, EventTypes >::label ( )

inlinestatic

Definition at line 137 of file papi_rate_tuple.hpp.

    {
        return tuple_type::label() + "_" + properties<rate_type>::id() + "_rate";
    }

References tim::component::properties< Tp >::id(), and tim::component::papi_tuple< EventTypes >::label().

label_array()

template<typename RateT , int... EventTypes>

static auto tim::component::papi_rate_tuple< RateT, EventTypes >::label_array ( )

inlinestatic

Definition at line 188 of file papi_rate_tuple.hpp.

    {
        auto arr = tuple_type::label_array();
        for(auto& itr : arr)
            itr += " per " + rate_type::get_display_unit();
        return arr;
    }

References tim::component::papi_tuple< EventTypes >::label_array().

operator+=()

template<typename RateT , int... EventTypes>

this_type& tim::component::papi_rate_tuple< RateT, EventTypes >::operator+= ( const this_type &  rhs )

inline

Definition at line 165 of file papi_rate_tuple.hpp.

    {
        value.first += rhs.value.first;
        value.second += rhs.value.second;
        return *this;
    }

operator-=()

template<typename RateT , int... EventTypes>

this_type& tim::component::papi_rate_tuple< RateT, EventTypes >::operator-= ( const this_type &  rhs )

inline

Definition at line 172 of file papi_rate_tuple.hpp.

    {
        value.first -= rhs.value.first;
        value.second -= rhs.value.second;
        return *this;
    }

start()

template<typename RateT , int... EventTypes>

void tim::component::papi_rate_tuple< RateT, EventTypes >::start ( )

inline

Definition at line 153 of file papi_rate_tuple.hpp.

    {
        value.first.start();
        value.second.start();
    }

stop()

template<typename RateT , int... EventTypes>

void tim::component::papi_rate_tuple< RateT, EventTypes >::stop ( )

inline

Definition at line 159 of file papi_rate_tuple.hpp.

    {
        value.second.stop();
        value.first.stop();
    }

thread_finalize()

template<typename RateT , int... EventTypes>

static void tim::component::papi_rate_tuple< RateT, EventTypes >::thread_finalize ( )

inlinestatic

Definition at line 129 of file papi_rate_tuple.hpp.

    {
        /*operation::fini<tuple_type>{}(
            operation::mode_constant<operation::fini_mode::thread>{});
        operation::fini<rate_type>{}(
            operation::mode_constant<operation::fini_mode::thread>{});*/
    }

thread_init()

template<typename RateT , int... EventTypes>

static void tim::component::papi_rate_tuple< RateT, EventTypes >::thread_init ( )

inlinestatic

Definition at line 122 of file papi_rate_tuple.hpp.

    {
        operation::init<tuple_type>{}(
            operation::mode_constant<operation::init_mode::thread>{});
        operation::init<rate_type>{}(
            operation::mode_constant<operation::init_mode::thread>{});
    }

unit_array()

template<typename RateT , int... EventTypes>

static auto tim::component::papi_rate_tuple< RateT, EventTypes >::unit_array ( )

inlinestatic

Definition at line 216 of file papi_rate_tuple.hpp.

    {
        std::array<double, num_events> arr;
        auto                           _units = tuple_type::unit_array();
        for(size_t i = 0; i < _units.size(); ++i)
            arr.at(i) = _units.at(i);
        for(auto& itr : _units)
            itr /= rate_type::unit();
        return arr;
    }

References tim::component::papi_tuple< EventTypes >::unit_array().

Friends And Related Function Documentation

impl::storage< this_type, trait::uses_value_storage< this_type, value_type >::value >

template<typename RateT , int... EventTypes>

friend class impl::storage< this_type, trait::uses_value_storage< this_type, value_type >::value >

friend

Definition at line 227 of file papi_rate_tuple.hpp.

operation::record< common_type >

template<typename RateT , int... EventTypes>

friend struct operation::record< common_type >

friend

Definition at line 83 of file papi_rate_tuple.hpp.

operation::set_started< this_type >

template<typename RateT , int... EventTypes>

friend struct operation::set_started< this_type >

friend

Definition at line 83 of file papi_rate_tuple.hpp.

operation::set_stopped< this_type >

template<typename RateT , int... EventTypes>

friend struct operation::set_stopped< this_type >

friend

Definition at line 83 of file papi_rate_tuple.hpp.

operation::start< this_type >

template<typename RateT , int... EventTypes>

friend struct operation::start< this_type >

friend

Definition at line 83 of file papi_rate_tuple.hpp.

operation::stop< this_type >

template<typename RateT , int... EventTypes>

friend struct operation::stop< this_type >

friend

Definition at line 83 of file papi_rate_tuple.hpp.

operator<<

template<typename RateT , int... EventTypes>

std::ostream& operator<< ( std::ostream &  os, const this_type &  obj  )

friend

Definition at line 227 of file papi_rate_tuple.hpp.

    {
        // output the metrics
        auto _value = obj.get();
        auto _label = this_type::label_array();
        auto _disp  = this_type::display_unit_array();
        auto _prec  = this_type::get_precision();
        auto _width = this_type::get_width();
        auto _flags = this_type::get_format_flags();
 
        for(size_t i = 0; i < _value.size(); ++i)
        {
            std::stringstream ss_value;
            std::stringstream ss_extra;
            ss_value.setf(_flags);
            ss_value << std::setw(_width) << std::setprecision(_prec) << _value.at(i);
            if(!_disp.at(i).empty())
            {
                ss_extra << " " << _disp.at(i);
            }
            else if(!_label.at(i).empty())
            {
                ss_extra << " " << _label.at(i);
            }
            os << ss_value.str() << ss_extra.str();
            if(i + 1 < _value.size())
                os << ", ";
        }
        return os;
    }

Member Data Documentation

num_events

template<typename RateT , int... EventTypes>

const size_type tim::component::papi_rate_tuple< RateT, EventTypes >::num_events = sizeof...(EventTypes)

static

Definition at line 83 of file papi_rate_tuple.hpp.

---

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

• timemory/components/papi/papi_rate_tuple.hpp