tim::operation::add_statistics< T > Struct Template Reference

Enabling statistics in timemory has two parts: More...

#include "timemory/operations/types/add_statistics.hpp"

Collaboration diagram for tim::operation::add_statistics< T >:

Public Types
using	type = T

Public Member Functions
template<typename StatsT >
	add_statistics (const type &_obj, StatsT &_stats, bool _last=false)
	add_statistics (const type &_obj, bool _last=false)
template<typename U >
auto	operator() (const U &rhs, bool _last=false) const
template<typename StatsT , typename U = type>
void	operator() (const U &rhs, StatsT &stats, bool _last=false, enable_if_t< enabled_statistics< U, StatsT >::value, int >=0) const
template<typename StatsT , typename U = type>
void	operator() (const U &, StatsT &, bool=true, enable_if_t<!enabled_statistics< U, StatsT >::value, int >=0) const

Detailed Description

template<typename T>
struct tim::operation::add_statistics< T >

Enabling statistics in timemory has two parts:

1. tim::trait::record_statistics must be set to true for component
2. tim::trait::statistics must set the data type of the statistics
   • this is usually set to the data type returned from get()
   • tuple<> is the default and will fully disable statistics unless changed

Definition at line 114 of file add_statistics.hpp.

Member Typedef Documentation

type

template<typename T >

using tim::operation::add_statistics< T >::type = T

Definition at line 116 of file add_statistics.hpp.

Constructor & Destructor Documentation

add_statistics() [1/2]

template<typename T >

template<typename StatsT >

tim::operation::add_statistics< T >::add_statistics ( const type &  _obj, StatsT &  _stats, bool  _last = false  )

inline

Definition at line 124 of file add_statistics.hpp.

    {
        (*this)(_obj, _stats, _last);
    }

add_statistics() [2/2]

template<typename T >

tim::operation::add_statistics< T >::add_statistics ( const type &  _obj, bool  _last = false  )

inline

Definition at line 132 of file add_statistics.hpp.

    {
        (*this)(_obj, _last);
    }

Member Function Documentation

operator()() [1/3]

template<typename T >

template<typename StatsT , typename U = type>

void tim::operation::add_statistics< T >::operator() ( const U &  , StatsT &  , bool  = true, enable_if_t<!enabled_statistics< U, StatsT >::value, int >  = 0  ) const

inline

Definition at line 158 of file add_statistics.hpp.

    {}

operator()() [2/3]

template<typename T >

template<typename U >

auto tim::operation::add_statistics< T >::operator() ( const U &  rhs, bool  _last = false  ) const

inline

Definition at line 141 of file add_statistics.hpp.

    {
        return sfinae(rhs, 0, 0, _last);
    }

operator()() [3/3]

template<typename T >

template<typename StatsT , typename U >

void tim::operation::add_statistics< T >::operator()	(	const U &	rhs,
		StatsT &	stats,
		bool	_last = false,
		enable_if_t< enabled_statistics< U, StatsT >::value, int >	= 0
	)		const

Definition at line 195 of file add_statistics.hpp.

{
    // for type comparison
    using incoming_t = decay_t<typename StatsT::value_type>;
    using expected_t = decay_t<typename trait::statistics<U>::type>;
    // check the incomming stat type against declared stat type
    // but allow for permissive_statistics when there is an acceptable
    // implicit conversion
    static_assert(trait::permissive_statistics<U>::value ||
                      std::is_same<incoming_t, expected_t>::value,
                  "add_statistics was passed a data type different than declared "
                  "trait::statistics type. To disable this error, e.g. permit "
                  "implicit conversion, set trait::permissive_statistics "
                  "to true_type for component");
    using stats_policy_type = policy::record_statistics<U>;
    DEBUG_PRINT_HERE("%s :: updating %s (accum: %s)", demangle<U>().c_str(),
                     demangle<StatsT>().c_str(), (_last) ? "y" : "n");
    stats_policy_type{}(stats, rhs, _last);
}

References DEBUG_PRINT_HERE.

---

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

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