#include <StatCollector.h>

Inheritance diagram for lar::util::details::WeightTracker< W >:

Public Types
using	Weight_t = W
	type of the weight More...

Public Member Functions
void	add (Weight_t weight)
	Adds the specified weight to the statistics. More...

void	clear ()
	Resets the count. More...

int	N () const
	Returns the number of entries added. More...

Weight_t	Weights () const
	Returns the sum of the weights. More...

Weight_t	AverageWeight () const
	Returns the arithmetic average of the weights. More...

Static Public Member Functions
template<typename V >
static constexpr V	sqr (V const &v)
	Returns the square of the specified value. More...

Protected Attributes
int	n = 0
	number of added entries More...

Weight_t	w = Weight_t(0)
	total weight More...

Detailed Description

template<typename W>
class lar::util::details::WeightTracker< W >

Class tracking the number of entries and their total weight

Template Parameters

W	type of the weight

Definition at line 48 of file StatCollector.h.

Member Typedef Documentation

template<typename W>

using lar::util::details::WeightTracker< W >::Weight_t = W

type of the weight

Definition at line 50 of file StatCollector.h.

Member Function Documentation

template<typename W>

void lar::util::details::WeightTracker< W >::add ( Weight_t weight )

inline

Adds the specified weight to the statistics.

Definition at line 53 of file StatCollector.h.

53 { ++n; w += weight; }

test.weight

weight

Definition: test.py:257

lar::util::details::WeightTracker::n

int n

number of added entries

Definition: StatCollector.h:77

lar::util::details::WeightTracker::w

Weight_t w

total weight

Definition: StatCollector.h:78

template<typename W >

lar::util::details::WeightTracker< W >::Weight_t lar::util::details::WeightTracker< W >::AverageWeight ( ) const

Returns the arithmetic average of the weights.

Returns: the weight average

Exceptions

std::range_error if no entry was added

Definition at line 841 of file StatCollector.h.

 {
   if (N() == 0)
     throw std::range_error("WeightTracker<>::AverageWeight(): divide by 0");
   return Weights() / N();
 } // details::WeightTracker<W>::AverageWeight()