tim::policy::record_statistics< CompT, Tp > Struct Template Reference

Specification of how to accumulate statistics. This will not be used unless tim::trait::statistics has been assigned a type and tim::trait::record_statistics is true. Set tim::trait::permissive_statistics to allow implicit conversions, e.g. int -> size_t. More...

#include "timemory/mpl/policy.hpp"

Collaboration diagram for tim::policy::record_statistics< CompT, Tp >:

Public Types
using	type = Tp
using	this_type = record_statistics< CompT, type >
using	policy_type = this_type
using	statistics_type = statistics< type >

Public Member Functions
void	operator() (statistics< type > &, const CompT &, bool _accum=true)
void	operator() (type &, const CompT &)

Detailed Description

template<typename CompT, typename Tp>
struct tim::policy::record_statistics< CompT, Tp >

Specification of how to accumulate statistics. This will not be used unless tim::trait::statistics has been assigned a type and tim::trait::record_statistics is true. Set tim::trait::permissive_statistics to allow implicit conversions, e.g. int -> size_t.

template <typename CompT, typename Tp>
struct record_statistics
{
    using type            = Tp;
    using component_type  = CompT;
    using statistics_type = statistics<type>;
 
    static void apply(statistics_type& stats, const component_type& obj)
    {
        // example:
        //      typeid(stats) is tim::statistics<double>
        //      obj.get() returns a double precision value
        stats += obj.get();
    }
};

Definition at line 47 of file policy.hpp.

Member Typedef Documentation

policy_type

template<typename CompT , typename Tp >

using tim::policy::record_statistics< CompT, Tp >::policy_type = this_type

Definition at line 51 of file policy.hpp.

statistics_type

template<typename CompT , typename Tp >

using tim::policy::record_statistics< CompT, Tp >::statistics_type = statistics<type>

Definition at line 52 of file policy.hpp.

this_type

template<typename CompT , typename Tp >

using tim::policy::record_statistics< CompT, Tp >::this_type = record_statistics<CompT, type>

Definition at line 50 of file policy.hpp.

type

template<typename CompT , typename Tp >

using tim::policy::record_statistics< CompT, Tp >::type = Tp

Definition at line 49 of file policy.hpp.

Member Function Documentation

operator()() [1/2]

template<typename CompT , typename Tp >

void tim::policy::record_statistics< CompT, Tp >::operator() ( statistics< type > &  _stats, const CompT &  _obj, bool  _accum = true  )

inline

Definition at line 53 of file add_statistics.hpp.

{
    using component_type = std::remove_pointer_t<decay_t<CompT>>;
    using result_type    = decltype(std::declval<CompT>().get());
    static_assert(std::is_same<result_type, Tp>::value,
                  "Error! The default implementation of "
                  "'policy::record_statistics<Component, T>::operator()' requires 'T' "
                  "to be the same type as the return type from 'Component::get()'");
 
    if(!_last)
    {
        if(_obj.get_laps() < 2)
        {
            _stats += _obj.get();
        }
        else
        {
            CONDITIONAL_PRINT_HERE(settings::debug(),
                                   "Updating statistics<%s> skipped for %s. Laps: %lu > "
                                   "1",
                                   demangle<Tp>().c_str(),
                                   demangle<component_type>().c_str(),
                                   (unsigned long) _obj.get_laps());
        }
    }
    else
    {
        constexpr bool has_accum = trait::base_has_accum<component_type>::value;
        // make a copy and replace the accumulation with last measurement
        auto _tmp = _obj;
        IF_CONSTEXPR(has_accum) { _tmp.set_accum(_tmp.get_last()); }
        else { _tmp.set_value(_tmp.get_last()); }
        _stats += _tmp.get();
    }
}

References CONDITIONAL_PRINT_HERE, tim::debug, and IF_CONSTEXPR.

operator()() [2/2]

template<typename CompT , typename Tp >

void tim::policy::record_statistics< CompT, Tp >::operator() ( type &  , const CompT &    )

inline

Definition at line 55 of file policy.hpp.

{}

---

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

• timemory/mpl/policy.hpp
• timemory/operations/types/add_statistics.hpp