KaMPIng 0.1.1
Flexible and (near) zero-overhead C++ bindings for MPI
Loading...
Searching...
No Matches
kamping::measurements::internal::NodeMeasurements< T, default_global_aggregation_mode > Class Template Reference

Class to store measurement data points associated with a node in a measurement tree, e.g., a timer-tree. More...

#include <measurement_utils.hpp>

Public Member Functions

void aggregate_measurements_locally (T const &datapoint, LocalAggregationMode const &mode)
 Add the result of a time measurement (i.e. a duration) to the node.
 
auto constmeasurements () const
 Access to stored duration(s).
 
automeasurements_aggregation_operations ()
 Access to the data aggregation operations (used during the evaluation).
 
auto constmeasurements_aggregation_operations () const
 Access to the data aggregation operations (used during the evaluation).
 

Detailed Description

template<typename T, GlobalAggregationMode default_global_aggregation_mode>
class kamping::measurements::internal::NodeMeasurements< T, default_global_aggregation_mode >

Class to store measurement data points associated with a node in a measurement tree, e.g., a timer-tree.

Template Parameters
TType of the data point.
default_global_aggregation_modeDefault mode to use for global aggregation when not further specified.

Member Function Documentation

◆ aggregate_measurements_locally()

template<typename T , GlobalAggregationMode default_global_aggregation_mode>
void kamping::measurements::internal::NodeMeasurements< T, default_global_aggregation_mode >::aggregate_measurements_locally ( T const & datapoint,
LocalAggregationMode const & mode )
inline

Add the result of a time measurement (i.e. a duration) to the node.

Parameters
datapointData point which is added to the node.
modeThe kamping::measurements::KeyAggregationMode parameter determines how multiple time measurements shall be handled. They can either be accumulated (the durations are added together) or appended (the durations are stored in a list).

◆ measurements()

template<typename T , GlobalAggregationMode default_global_aggregation_mode>
auto const & kamping::measurements::internal::NodeMeasurements< T, default_global_aggregation_mode >::measurements ( ) const
inline

Access to stored duration(s).

Returns
Return a reference to duration(s).

◆ measurements_aggregation_operations() [1/2]

template<typename T , GlobalAggregationMode default_global_aggregation_mode>
auto & kamping::measurements::internal::NodeMeasurements< T, default_global_aggregation_mode >::measurements_aggregation_operations ( )
inline

Access to the data aggregation operations (used during the evaluation).

Returns
Return a reference to data aggregation operations.

◆ measurements_aggregation_operations() [2/2]

template<typename T , GlobalAggregationMode default_global_aggregation_mode>
auto const & kamping::measurements::internal::NodeMeasurements< T, default_global_aggregation_mode >::measurements_aggregation_operations ( ) const
inline

Access to the data aggregation operations (used during the evaluation).

Returns
Return a reference to data aggregation operations.

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