kamping::measurements::AggregatedTree< DataType > Class Template Reference

Class representing an aggregated measurement tree, i.e., a measurement tree for which the global aggregation has been performed. More...

#include <aggregated_tree_node.hpp>

Public Member Functions
template<typename MeasurementNode , typename Communicator >
	AggregatedTree (MeasurementNode const &measurement_root_node, Communicator const &comm)
	Globally aggregates the measurement tree provided with.
auto &	root ()
	Access to the root of the aggregated tree.
auto const &	root () const
	Access to the root of the aggregated tree.

Detailed Description

template<typename DataType>
class kamping::measurements::AggregatedTree< DataType >

Class representing an aggregated measurement tree, i.e., a measurement tree for which the global aggregation has been performed.

Template Parameters

DataType

Type of interanlly stored data.

Constructor & Destructor Documentation

AggregatedTree()

template<typename DataType >

template<typename MeasurementNode , typename Communicator >

kamping::measurements::AggregatedTree< DataType >::AggregatedTree ( MeasurementNode const & measurement_root_node, Communicator const & comm )

inline

Globally aggregates the measurement tree provided with.

Parameters

measurement_root_node	across all ranks in
comm	.

Template Parameters

MeasurementNode	Type of the measurement tree to aggregate.
Communicator	Communicator defining the scope for the global aggregation.

Member Function Documentation

root() [1/2]

template<typename DataType >

auto & kamping::measurements::AggregatedTree< DataType >::root ( )

inline

Access to the root of the aggregated tree.

Returns

Reference to root node of aggregated tree.

root() [2/2]

template<typename DataType >

auto const & kamping::measurements::AggregatedTree< DataType >::root ( ) const

inline

Access to the root of the aggregated tree.

Returns

Reference to root node of aggregated tree.

---

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

• include/kamping/measurements/aggregated_tree_node.hpp