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

Collaboration diagram for tim::component::papi_array< MaxNumEvents >:

Public Types
using	size_type = size_t

using	event_list = std::vector< int >

using	value_type = std::array< long long, MaxNumEvents >

using	entry_type = typename value_type::value_type

using	this_type = papi_array< MaxNumEvents >

using	base_type = base< this_type, value_type >

using	storage_type = typename base_type::storage_type

using	tracker_type = policy::instance_tracker< this_type >

using	get_initializer_t = std::function< event_list()>

using	common_type = void

template<typename Tp >
using	array_t = std::array< Tp, MaxNumEvents >

Public Member Functions
	papi_array ()

	~papi_array ()=default

	papi_array (const papi_array &)=default

	papi_array (papi_array &&) noexcept=default

papi_array &	operator= (const papi_array &)=default

papi_array &	operator= (papi_array &&) noexcept=default

size_t	size ()

template<typename Tp = double>
std::vector< Tp >	get () const

void	sample ()

void	start ()

void	stop ()

this_type &	operator+= (const this_type &rhs)

this_type &	operator-= (const this_type &rhs)

this_type &	operator/= (size_t _val)

entry_type	get_display (int evt_type) const

template<typename Archive >
void	load (Archive &ar, const unsigned int)

template<typename Archive >
void	save (Archive &ar, const unsigned int) const

std::vector< std::string >	label_array () const

std::vector< std::string >	description_array () const

std::vector< std::string >	display_unit_array () const

std::vector< int64_t >	unit_array () const

string_t	get_display () const

Static Public Member Functions
static auto &	get_initializer ()

static void	configure ()

static void	initialize ()

static void	thread_finalize ()

static void	finalize ()

static value_type	record ()

static std::string	label ()

static std::string	description ()

template<typename... Args>
static opaque	get_opaque (Args &&...)

Static Public Attributes
static const short	precision = 3

static const short	width = 8

Protected Attributes
event_list	events

Friends
struct	operation::record< this_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<size_t MaxNumEvents>
struct tim::component::papi_array< MaxNumEvents >

Definition at line 47 of file papi_array.hpp.

Member Typedef Documentation

◆ array_t

template<size_t MaxNumEvents>

template<typename Tp >

using tim::component::papi_array< MaxNumEvents >::array_t = std::array<Tp, MaxNumEvents>

Definition at line 67 of file papi_array.hpp.

◆ base_type

template<size_t MaxNumEvents>

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

Definition at line 57 of file papi_array.hpp.

◆ common_type

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::common_type = void

Definition at line 61 of file papi_array.hpp.

◆ entry_type

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::entry_type = typename value_type::value_type

Definition at line 55 of file papi_array.hpp.

◆ event_list

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::event_list = std::vector<int>

Definition at line 53 of file papi_array.hpp.

◆ get_initializer_t

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::get_initializer_t = std::function<event_list()>

Definition at line 60 of file papi_array.hpp.

◆ size_type

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::size_type = size_t

Definition at line 52 of file papi_array.hpp.

◆ storage_type

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::storage_type = typename base_type::storage_type

Definition at line 58 of file papi_array.hpp.

◆ this_type

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::this_type = papi_array<MaxNumEvents>

Definition at line 56 of file papi_array.hpp.

◆ tracker_type

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::tracker_type = policy::instance_tracker<this_type>

Definition at line 59 of file papi_array.hpp.

◆ value_type

template<size_t MaxNumEvents>

using tim::component::papi_array< MaxNumEvents >::value_type = std::array<long long, MaxNumEvents>

Definition at line 54 of file papi_array.hpp.

Constructor & Destructor Documentation

◆ papi_array() [1/3]

template<size_t MaxNumEvents>

tim::component::papi_array< MaxNumEvents >::papi_array ( )

inline

Definition at line 93 of file papi_array.hpp.

93{ events = get_events<common_type>(); }

tim::component::papi_array::events

event_list events

Definition: papi_common.hpp:352

References tim::component::papi_array< MaxNumEvents >::events.

◆ ~papi_array()

template<size_t MaxNumEvents>

tim::component::papi_array< MaxNumEvents >::~papi_array ( )

default

◆ papi_array() [2/3]

template<size_t MaxNumEvents>

tim::component::papi_array< MaxNumEvents >::papi_array ( const papi_array< MaxNumEvents > & )

default

◆ papi_array() [3/3]

template<size_t MaxNumEvents>

tim::component::papi_array< MaxNumEvents >::papi_array ( papi_array< MaxNumEvents > && )

defaultnoexcept

Member Function Documentation

◆ configure()

template<size_t MaxNumEvents>

static void tim::component::papi_array< MaxNumEvents >::configure ( )

inlinestatic

Definition at line 78 of file papi_array.hpp.

    {
        if(!is_configured<common_type>())
            papi_common::initialize<common_type>();
    }

Referenced by tim::component::papi_array< MaxNumEvents >::initialize(), tim::component::papi_array< MaxNumEvents >::sample(), and tim::component::papi_array< MaxNumEvents >::start().

◆ description()

template<size_t MaxNumEvents>

static std::string tim::component::papi_array< MaxNumEvents >::description ( )

inlinestatic

Definition at line 229 of file papi_array.hpp.

229{ return "Fixed-size array of PAPI HW counters"; }

◆ description_array()

template<size_t MaxNumEvents>

std::vector< std::string > tim::component::papi_array< MaxNumEvents >::description_array ( ) const

inline

Definition at line 299 of file papi_array.hpp.

    {
        std::vector<std::string> arr(events.size());
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = papi::get_event_info(events[i]).long_descr;
        return arr;
    }

References tim::component::papi_array< MaxNumEvents >::events.

◆ display_unit_array()

template<size_t MaxNumEvents>

std::vector< std::string > tim::component::papi_array< MaxNumEvents >::display_unit_array ( ) const

inline

Definition at line 310 of file papi_array.hpp.

    {
        std::vector<std::string> arr(events.size());
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = papi::get_event_info(events[i]).units;
        return arr;
    }

References tim::component::papi_array< MaxNumEvents >::events.

◆ finalize()

template<size_t MaxNumEvents>

static void tim::component::papi_array< MaxNumEvents >::finalize ( )

inlinestatic

Definition at line 89 of file papi_array.hpp.

89{ papi_common::finalize<common_type>(); }

◆ get()

template<size_t MaxNumEvents>

template<typename Tp = double>

std::vector< Tp > tim::component::papi_array< MaxNumEvents >::get ( ) const

inline

Definition at line 120 of file papi_array.hpp.

    {
        std::vector<Tp> values;
        auto&           _data = load();
        values.reserve(_data.size());
        for(auto& itr : _data)
            values.emplace_back(itr);
        values.resize(events.size());
        return values;
    }

References tim::component::papi_array< MaxNumEvents >::events, and tim::component::base< papi_array< MaxNumEvents >, std::array< long long, MaxNumEvents > >::load().

◆ get_display() [1/2]

template<size_t MaxNumEvents>

string_t tim::component::papi_array< MaxNumEvents >::get_display ( ) const

inline

Definition at line 331 of file papi_array.hpp.

    {
        if(events.size() == 0)
            return "";
        auto val          = load();
        auto _get_display = [&](std::ostream& os, size_type idx) {
            auto     _obj_value = val[idx];
            auto     _evt_type  = events[idx];
            string_t _label     = papi::get_event_info(_evt_type).short_descr;
            string_t _disp      = papi::get_event_info(_evt_type).units;
            auto     _prec      = base_type::get_precision();
            auto     _width     = base_type::get_width();
            auto     _flags     = base_type::get_format_flags();
 
            std::stringstream ss;
            std::stringstream ssv;
            std::stringstream ssi;
            ssv.setf(_flags);
            ssv << std::setw(_width) << std::setprecision(_prec) << _obj_value;
            if(!_disp.empty())
                ssv << " " << _disp;
            if(!_label.empty())
                ssi << " " << _label;
            ss << ssv.str() << ssi.str();
            os << ss.str();
        };
 
        std::stringstream ss;
        for(size_type i = 0; i < events.size(); ++i)
        {
            _get_display(ss, i);
            if(i + 1 < events.size())
                ss << ", ";
        }
        return ss.str();
    }

References tim::component::papi_array< MaxNumEvents >::events, tim::component::base< Tp, Value >::get_format_flags(), tim::component::base< Tp, Value >::get_precision(), tim::component::base< Tp, Value >::get_width(), tim::component::base< papi_array< MaxNumEvents >, std::array< long long, MaxNumEvents > >::load(), and tim::os.

Referenced by tim::component::papi_array< MaxNumEvents >::save().

◆ get_display() [2/2]

template<size_t MaxNumEvents>

entry_type tim::component::papi_array< MaxNumEvents >::get_display ( int evt_type ) const

inline

Definition at line 231 of file papi_array.hpp.

    {
        return accum.at(evt_type);
    }

◆ get_initializer()

template<size_t MaxNumEvents>

static auto & tim::component::papi_array< MaxNumEvents >::get_initializer ( )

inlinestatic

Definition at line 77 of file papi_array.hpp.

77{ return papi_common::get_initializer<common_type>(); }

◆ 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{};
    }

◆ initialize()

template<size_t MaxNumEvents>

static void tim::component::papi_array< MaxNumEvents >::initialize ( )

inlinestatic

Definition at line 83 of file papi_array.hpp.

83{ configure(); }

tim::component::papi_array::configure

static void configure()

Definition: papi_array.hpp:78

References tim::component::papi_array< MaxNumEvents >::configure().

◆ label()

template<size_t MaxNumEvents>

static std::string tim::component::papi_array< MaxNumEvents >::label ( )

inlinestatic

Definition at line 222 of file papi_array.hpp.

    {
        return "papi_array" + std::to_string((event_set<common_type>() < 0)
                                                 ? 0
                                                 : event_set<common_type>());
    }

◆ label_array()

template<size_t MaxNumEvents>

std::vector< std::string > tim::component::papi_array< MaxNumEvents >::label_array ( ) const

inline

Definition at line 263 of file papi_array.hpp.

    {
        std::vector<std::string> arr(events.size());
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = papi::get_event_info(events[i]).short_descr;
 
        for(auto& itr : arr)
        {
            size_t n = std::string::npos;
            while((n = itr.find("L/S")) != std::string::npos)
                itr.replace(n, 3, "Loads_Stores");
        }
 
        for(auto& itr : arr)
        {
            size_t n = std::string::npos;
            while((n = itr.find('/')) != std::string::npos)
                itr.replace(n, 1, "_per_");
        }
 
        for(auto& itr : arr)
        {
            size_t n = std::string::npos;
            while((n = itr.find(' ')) != std::string::npos)
                itr.replace(n, 1, "_");
 
            while((n = itr.find("__")) != std::string::npos)
                itr.replace(n, 2, "_");
        }
 
        return arr;
    }

References tim::component::papi_array< MaxNumEvents >::events.

◆ load()

template<size_t MaxNumEvents>

template<typename Archive >

void tim::component::papi_array< MaxNumEvents >::load	(	Archive &	ar,
		const unsigned int
	)

inline

Definition at line 240 of file papi_array.hpp.

    {
        ar(cereal::make_nvp("laps", laps), cereal::make_nvp("value", value),
           cereal::make_nvp("accum", accum), cereal::make_nvp("events", events));
    }

References tim::component::papi_array< MaxNumEvents >::events, and tim::component::base< papi_array< MaxNumEvents >, std::array< long long, MaxNumEvents > >::laps.

◆ operator+=()

template<size_t MaxNumEvents>

this_type & tim::component::papi_array< MaxNumEvents >::operator+= ( const this_type & rhs )

inline

Definition at line 170 of file papi_array.hpp.

    {
        for(size_type i = 0; i < events.size(); ++i)
            accum[i] += rhs.accum[i];
        for(size_type i = 0; i < events.size(); ++i)
            value[i] += rhs.value[i];
        return *this;
    }

References tim::component::papi_array< MaxNumEvents >::events.

◆ operator-=()

template<size_t MaxNumEvents>

this_type & tim::component::papi_array< MaxNumEvents >::operator-= ( const this_type & rhs )

inline

Definition at line 181 of file papi_array.hpp.

    {
        for(size_type i = 0; i < events.size(); ++i)
            accum[i] -= rhs.accum[i];
        for(size_type i = 0; i < events.size(); ++i)
            value[i] -= rhs.value[i];
        return *this;
    }

References tim::component::papi_array< MaxNumEvents >::events.

◆ operator/=()

template<size_t MaxNumEvents>

this_type & tim::component::papi_array< MaxNumEvents >::operator/= ( size_t _val )

inline

Definition at line 192 of file papi_array.hpp.

    {
        for(size_type i = 0; i < events.size(); ++i)
            accum[i] /= _val;
        for(size_type i = 0; i < events.size(); ++i)
            value[i] /= _val;
        return *this;
    }

◆ operator=() [1/2]

template<size_t MaxNumEvents>

papi_array & tim::component::papi_array< MaxNumEvents >::operator= ( const papi_array< MaxNumEvents > & )

default

◆ operator=() [2/2]

template<size_t MaxNumEvents>

papi_array & tim::component::papi_array< MaxNumEvents >::operator= ( papi_array< MaxNumEvents > && )

defaultnoexcept

◆ record()

template<size_t MaxNumEvents>

static value_type tim::component::papi_array< MaxNumEvents >::record ( )

inlinestatic

Definition at line 108 of file papi_array.hpp.

    {
        value_type read_value{};
        read_value.fill(0);
        if(is_configured<common_type>())
            papi::read(event_set<common_type>(), read_value.data());
        return read_value;
    }

Referenced by tim::component::papi_array< MaxNumEvents >::sample(), tim::component::papi_array< MaxNumEvents >::start(), and tim::component::papi_array< MaxNumEvents >::stop().

◆ sample()

template<size_t MaxNumEvents>

void tim::component::papi_array< MaxNumEvents >::sample ( )

inline

Definition at line 134 of file papi_array.hpp.

    {
        if(tracker_type::get_thread_started() == 0)
            configure();
        if(events.empty())
            events = get_events<common_type>();
 
        tracker_type::start();
        value = record();
    }

References tim::component::papi_array< MaxNumEvents >::configure(), tim::component::papi_array< MaxNumEvents >::events, tim::component::papi_array< MaxNumEvents >::record(), and tim::invoke::start().

◆ save()

template<size_t MaxNumEvents>

template<typename Archive >

void tim::component::papi_array< MaxNumEvents >::save	(	Archive &	ar,
		const unsigned int
	)		const

inline

Definition at line 250 of file papi_array.hpp.

    {
        array_t<double> _disp;
        for(size_type i = 0; i < events.size(); ++i)
            _disp[i] = get_display(i);
        ar(cereal::make_nvp("laps", laps), cereal::make_nvp("repr_data", _disp),
           cereal::make_nvp("value", value), cereal::make_nvp("accum", accum),
           cereal::make_nvp("display", _disp), cereal::make_nvp("events", events));
    }

References tim::component::papi_array< MaxNumEvents >::events, tim::component::papi_array< MaxNumEvents >::get_display(), and tim::component::base< papi_array< MaxNumEvents >, std::array< long long, MaxNumEvents > >::laps.

◆ size()

template<size_t MaxNumEvents>

size_t tim::component::papi_array< MaxNumEvents >::size ( )

inline

Definition at line 104 of file papi_array.hpp.

104{ return events.size(); }

References tim::component::papi_array< MaxNumEvents >::events.

◆ start()

template<size_t MaxNumEvents>

void tim::component::papi_array< MaxNumEvents >::start ( )

inline

Definition at line 148 of file papi_array.hpp.

    {
        if(tracker_type::get_thread_started() == 0 || events.size() == 0)
            configure();
 
        events = get_events<common_type>();
        tracker_type::start();
        value = record();
    }

References tim::component::papi_array< MaxNumEvents >::configure(), tim::component::papi_array< MaxNumEvents >::events, tim::component::papi_array< MaxNumEvents >::record(), and tim::invoke::start().

◆ stop()

template<size_t MaxNumEvents>

void tim::component::papi_array< MaxNumEvents >::stop ( )

inline

Definition at line 160 of file papi_array.hpp.

    {
        tracker_type::stop();
        using namespace tim::component::operators;
        value = (record() - value);
        accum += value;
    }

References tim::component::papi_array< MaxNumEvents >::record(), and tim::invoke::stop().

◆ thread_finalize()

template<size_t MaxNumEvents>

static void tim::component::papi_array< MaxNumEvents >::thread_finalize ( )

inlinestatic

Definition at line 84 of file papi_array.hpp.

    {
        papi_common::finalize<common_type>();
        papi_common::finalize_papi();
    }

References tim::component::papi_common::finalize_papi().

◆ unit_array()

template<size_t MaxNumEvents>

std::vector< int64_t > tim::component::papi_array< MaxNumEvents >::unit_array ( ) const

inline

Definition at line 321 of file papi_array.hpp.

    {
        std::vector<int64_t> arr(events.size());
        for(size_type i = 0; i < events.size(); ++i)
            arr[i] = 1;
        return arr;
    }

References tim::component::papi_array< MaxNumEvents >::events.

Friends And Related Function Documentation

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

template<size_t MaxNumEvents>

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

friend

Definition at line 192 of file papi_array.hpp.

◆ operation::record< this_type >

template<size_t MaxNumEvents>

friend struct operation::record< this_type >

friend

Definition at line 64 of file papi_array.hpp.

◆ operation::set_started< this_type >

template<size_t MaxNumEvents>

friend struct operation::set_started< this_type >

friend

Definition at line 64 of file papi_array.hpp.

◆ operation::set_stopped< this_type >

template<size_t MaxNumEvents>

friend struct operation::set_stopped< this_type >

friend

Definition at line 64 of file papi_array.hpp.

◆ operation::start< this_type >

template<size_t MaxNumEvents>

friend struct operation::start< this_type >

friend

Definition at line 64 of file papi_array.hpp.

◆ operation::stop< this_type >

template<size_t MaxNumEvents>

friend struct operation::stop< this_type >

friend

Definition at line 64 of file papi_array.hpp.

◆ operator<<

template<size_t MaxNumEvents>

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

friend

Definition at line 370 of file papi_array.hpp.

    {
        if(obj.events.size() == 0)
            return os;
        // output the metrics
        auto _value = obj.get_display();
        auto _label = this_type::get_label();
        auto _disp  = this_type::display_unit();
        auto _prec  = this_type::get_precision();
        auto _width = this_type::get_width();
        auto _flags = this_type::get_format_flags();
 
        std::stringstream ss_value;
        std::stringstream ss_extra;
        ss_value.setf(_flags);
        ss_value << std::setw(_width) << std::setprecision(_prec) << _value;
        if(!_disp.empty())
        {
            ss_extra << " " << _disp;
        }
        else if(!_label.empty())
        {
            ss_extra << " " << _label;
        }
        os << ss_value.str() << ss_extra.str();
        return os;
    }

Member Data Documentation

◆ events

template<size_t MaxNumEvents>

event_list tim::component::papi_common::events

protected

Definition at line 352 of file papi_common.hpp.

◆ precision

template<size_t MaxNumEvents>

const short tim::component::papi_array< MaxNumEvents >::precision = 3

static

Definition at line 63 of file papi_array.hpp.

◆ width

template<size_t MaxNumEvents>

const short tim::component::papi_array< MaxNumEvents >::width = 8

static

Definition at line 64 of file papi_array.hpp.

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

timemory/components/papi/papi_array.hpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ array_t

◆ base_type

◆ common_type

◆ entry_type

◆ event_list

◆ get_initializer_t

◆ size_type

◆ storage_type

◆ this_type

◆ tracker_type

◆ value_type

Constructor & Destructor Documentation

◆ papi_array() [1/3]

◆ ~papi_array()

◆ papi_array() [2/3]

◆ papi_array() [3/3]

Member Function Documentation

◆ configure()

◆ description()

◆ description_array()

◆ display_unit_array()

◆ finalize()

◆ get()

◆ get_display() [1/2]

◆ get_display() [2/2]

◆ get_initializer()

◆ get_opaque()

◆ initialize()

◆ label()

◆ label_array()

◆ load()

◆ operator+=()

◆ operator-=()

◆ operator/=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ record()

◆ sample()

◆ save()

◆ size()

◆ start()

◆ stop()

◆ thread_finalize()

◆ unit_array()

Friends And Related Function Documentation

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

◆ operation::record< this_type >

◆ operation::set_started< this_type >

◆ operation::set_stopped< this_type >

◆ operation::start< this_type >

◆ operation::stop< this_type >

◆ operator<<

Member Data Documentation

◆ events

◆ precision

◆ width