lar::util::StatCollector2D< T, W > Class Template Reference

Collects statistics on two homogeneous quantities (weighted) More...

#include <StatCollector.h>

Inheritance diagram for lar::util::StatCollector2D< T, W >:

Public Types
using	Base_t = details::WeightTracker< W >
using	This_t = StatCollector2D< T, W >
	this type More...
using	Data_t = T
	type of the data More...
using	Weight_t = typename Base_t::Weight_t
	type of the weight More...
using	Pair_t = std::tuple< Data_t, Data_t >
using	WeightedPair_t = std::tuple< Data_t, Data_t, Weight_t >
Public Types inherited from lar::util::details::WeightTracker< W >
using	Weight_t = W
	type of the weight More...

Public Member Functions
template<typename Iter >
void	add_unweighted (Iter begin, Iter end)
	Adds entries from a sequence with weight 1. More...
template<typename Iter , typename Pred >
void	add_unweighted (Iter begin, Iter end, Pred extractor)
	Adds entries from a sequence with weight 1. More...
template<typename Cont , typename Pred >
void	add_unweighted (Cont cont, Pred extractor)
	Adds all entries from a container, with weight 1. More...
template<typename Cont >
void	add_unweighted (Cont cont)
	Adds all entries from a container, with weight 1. More...
template<typename VIter , typename WIter , typename VPred , typename WPred = identity>
void	add_weighted (VIter begin_value, VIter end_value, WIter begin_weight, VPred value_extractor, WPred weight_extractor=WPred())
	Adds entries from a sequence with individually specified weights. More...
template<typename Iter >
void	add_weighted (Iter begin, Iter end)
	Adds entries from a sequence with individually specified weights. More...
template<typename Cont >
void	add_weighted (Cont cont)
	Adds entries from a sequence with individually specified weights. More...
void	clear ()
	Clears all the statistics. More...
Add elements
void	add (Data_t x, Data_t y, Weight_t weight=Weight_t(1.0))
	Adds one entry with specified values and weight. More...
void	add (Pair_t value, Weight_t weight=Weight_t(1.0))
void	add (WeightedPair_t value)
Statistic retrieval
int	N () const
	Returns the number of entries added. More...
Weight_t	Weights () const
	Returns the sum of the weights. More...
Weight_t	SumX () const
	Returns the weighted sum of the x values. More...
Weight_t	SumY () const
	Returns the weighted sum of the y values. More...
Weight_t	SumSqX () const
	Returns the weighted sum of the square of the x values. More...
Weight_t	SumSqY () const
	Returns the weighted sum of the square of the y values. More...
Weight_t	SumXY () const
	Returns the weighted sum of the product of x and y values. More...
Weight_t	AverageX () const
	Returns the x value average. More...
Weight_t	AverageY () const
	Returns the y value average. More...
Weight_t	VarianceX () const
	Returns the variance of the x values. More...
Weight_t	VarianceY () const
	Returns the variance of the y values. More...
Weight_t	Covariance () const
	Returns the covariance of the (x, y) pair. More...
Weight_t	RMSx () const
	Returns the standard deviation of the x sample. More...
Weight_t	RMSy () const
	Returns the standard deviation of the y sample. More...
Weight_t	LinearCorrelation () const
	Returns the linear correlation. More...
Weight_t	AverageWeight () const
	Returns the arithmetic average of the weights. More...
Public Member Functions inherited from lar::util::details::WeightTracker< W >
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...

Protected Types
using	Variable_t = details::DataTracker2< Data_t, Weight_t >

Protected Attributes
Variable_t	x
	accumulator for variable x More...
Variable_t	y
	accumulator for variable y More...
Weight_t	sum_xy = Weight_t(0)
	weighted sum of xy More...
Protected Attributes inherited from lar::util::details::WeightTracker< W >
int	n = 0
	number of added entries More...
Weight_t	w = Weight_t(0)
	total weight More...

Additional Inherited Members
Static Public Member Functions inherited from lar::util::details::WeightTracker< W >
template<typename V >
static constexpr V	sqr (V const &v)
	Returns the square of the specified value. More...

Detailed Description

template<typename T, typename W = T>
class lar::util::StatCollector2D< T, W >

Collects statistics on two homogeneous quantities (weighted)

---

Template Parameters

T	type of the quantities
W	type of the weight (as T by default)

This is a convenience class, as easy to use as:

lar::util::StatCollector2D<double> stat;
stat.add(3.0, 4.0, 2.0);
stat.add(4.0, 3.0, 2.0);
stat.add(5.0, 5.0, 1.0);
std::cout << "Statistics from " << stat.N() << " entries: "
  << stat.AverageX() << ", " << stat.AverageY() << std::endl;

or also

std::vector<std::pair<double, double>> values({
  { 3.0, 4.0, 2.0 },
  { 4.0, 3.0, 2.0 },
  { 5.0, 5.0, 1.0 },
  });
lar::util::StatCollector<double> stat;
stat.add_weighted(values.begin(), values.end());
std::cout << "Statistics from " << stat.N() << " entries: "
  << stat.AverageX() << ", " << stat.AverageY() << std::endl;

that should both print: "Statistics from 3 entries: 3.8, 3.8".

Other functions are available allowing addition of weighted and unweighted data from collections. For additional examples, see the unit test StatCollector_test.cc .

Definition at line 477 of file StatCollector.h.

Member Typedef Documentation

template<typename T, typename W = T>

using lar::util::StatCollector2D< T, W >::Base_t = details::WeightTracker<W>

Definition at line 479 of file StatCollector.h.

template<typename T, typename W = T>

using lar::util::StatCollector2D< T, W >::Data_t = T

type of the data

Definition at line 483 of file StatCollector.h.

template<typename T, typename W = T>

using lar::util::StatCollector2D< T, W >::Pair_t = std::tuple<Data_t, Data_t>

Definition at line 486 of file StatCollector.h.

template<typename T, typename W = T>

using lar::util::StatCollector2D< T, W >::This_t = StatCollector2D<T, W>

this type

Definition at line 482 of file StatCollector.h.

template<typename T, typename W = T>

using lar::util::StatCollector2D< T, W >::Variable_t = details::DataTracker2<Data_t, Weight_t>

protected

Definition at line 728 of file StatCollector.h.

template<typename T, typename W = T>

using lar::util::StatCollector2D< T, W >::Weight_t = typename Base_t::Weight_t

type of the weight

Definition at line 484 of file StatCollector.h.

template<typename T, typename W = T>

using lar::util::StatCollector2D< T, W >::WeightedPair_t = std::tuple<Data_t, Data_t, Weight_t>

Definition at line 487 of file StatCollector.h.

Member Function Documentation

template<typename T , typename W >

void lar::util::StatCollector2D< T, W >::add	(	Data_t	x,
		Data_t	y,
		Weight_t	weight = Weight_t(1.0)
	)

Adds one entry with specified values and weight.

Definition at line 943 of file StatCollector.h.

{
  Base_t::add(weight);
  x.add(x_value, weight);
  y.add(y_value, weight);
  sum_xy += weight * x_value * y_value;
} // StatCollector2D<T, W>::add()

template<typename T, typename W = T>

void lar::util::StatCollector2D< T, W >::add ( Pair_t  value, Weight_t  weight = Weight_t(1.0)  )

inline

Definition at line 498 of file StatCollector.h.

        { add(std::get<0>(value), std::get<1>(value), weight); }

template<typename T, typename W = T>

void lar::util::StatCollector2D< T, W >::add ( WeightedPair_t  value )

inline

Definition at line 501 of file StatCollector.h.

        { add(std::get<0>(value), std::get<1>(value), std::get<2>(value)); }

template<typename T, typename W = T>

template<typename Iter >

void lar::util::StatCollector2D< T, W >::add_unweighted ( Iter  begin, Iter  end  )

inline

Adds entries from a sequence with weight 1.

Template Parameters

Iter	forward iterator to the pairs to be added

Parameters

begin	iterator pointing to the first element to be added
end	iterator pointing after the last element to be added

The value pointed by the iterator must be a tuple with types compatible with Pair_t.

Definition at line 515 of file StatCollector.h.

        {  add_unweighted(begin, end, identity()); }

template<typename T , typename W >

template<typename Iter , typename Pred >

void lar::util::StatCollector2D< T, W >::add_unweighted	(	Iter	begin,
		Iter	end,
		Pred	extractor
	)

Adds entries from a sequence with weight 1.

Template Parameters

Iter	forward iterator to the elements to be added
Pred	a predicate to extract the element from iterator value

Parameters

begin	iterator pointing to the first element to be added
end	iterator pointing after the last element to be added
extractor	the predicate extracting the value to be inserted

The predicate is required to react to a call like with:

Pair_t Pred::operator() (typename Iter::value_type);

Definition at line 955 of file StatCollector.h.

{
  std::for_each
    (begin, end, [this, extractor](auto item) { this->add(extractor(item)); });
} // StatCollector2D<T, W>::add_unweighted(Iter, Iter, Pred)

template<typename T, typename W = T>

template<typename Cont , typename Pred >

void lar::util::StatCollector2D< T, W >::add_unweighted ( Cont  cont, Pred  extractor  )

inline

Adds all entries from a container, with weight 1.

Template Parameters

Cont	type of container of the elements to be added
Pred	a predicate to extract the element from iterator value

Parameters

cont	container of the elements to be added
extractor	the predicate extracting the value to be inserted

The predicate is required to react to a call like with:

Pair_t Pred::operator() (typename Cont::value_type);

The container must support the range-based for loop syntax, that is is must have std::begin<Cont>() and std::end<Cont>() defined.

Definition at line 549 of file StatCollector.h.

        { add_unweighted(std::begin(cont), std::end(cont), extractor); }

template<typename T, typename W = T>

template<typename Cont >

void lar::util::StatCollector2D< T, W >::add_unweighted ( Cont  cont )

inline

Adds all entries from a container, with weight 1.

Template Parameters

Cont	type of container of the elements to be added

Parameters

cont	container of the elements to be added

The container must support the range-based for loop syntax, that is is must have std::begin<Cont>() and std::end<Cont>() defined. The value in the container must be convertible to the Data_t type.

Definition at line 562 of file StatCollector.h.

        { add_unweighted(std::begin(cont), std::end(cont)); }

template<typename T , typename W >

template<typename VIter , typename WIter , typename VPred , typename WPred >

void lar::util::StatCollector2D< T, W >::add_weighted	(	VIter	begin_value,
		VIter	end_value,
		WIter	begin_weight,
		VPred	value_extractor,
		WPred	weight_extractor = WPred()
	)

Adds entries from a sequence with individually specified weights.

Template Parameters

VIter	forward iterator to the elements to be added
WIter	forward iterator to the weights
VPred	a predicate to extract the element from iterator value
WPred	a predicate to extract the weight from iterator value

Parameters

begin_value	iterator pointing to the first element to be added
end_value	iterator pointing after the last element to be added
begin_weight	iterator pointing to the weight of first element
value_extractor	predicate extracting the value to be inserted
weight_extractor	predicate extracting the weight to be inserted

Each element is added with the weight pointed by the matching element in the list pointed by begin_weight: the element *(begin_value) will have weight *(begin_weight), the next element *(begin_value + 1) will have weight *(begin_weight + 1), etc.

The predicates are required to react to a call like with:

Pair_t VPred::operator() (typename VIter::value_type);
Weight_t WPred::operator() (typename WIter::value_type);

Definition at line 964 of file StatCollector.h.

  {
  while (begin_value != end_value) {
    add(value_extractor(*begin_value), weight_extractor(*begin_weight));
    ++begin_value;
    ++begin_weight;
  } // while
} // StatCollector2D<T, W>::add_weighted(VIter, VIter, WIter, VPred, WPred)

template<typename T , typename W >

template<typename Iter >

void lar::util::StatCollector2D< T, W >::add_weighted	(	Iter	begin,
		Iter	end
	)

Adds entries from a sequence with individually specified weights.

Template Parameters

Iter	forward iterator to WeightedPair_t elements to be added

Parameters

begin	iterator pointing to the first element to be added
end	iterator pointing after the last element to be added

The value pointed by the iterator must be a WeightedPair_t or something with elements convertible to its own (Data_t, Data_t and Weight_t). For more complicate structures, use the version with two predicates (using the weight iterator the same as the value iterator).

Definition at line 980 of file StatCollector.h.

                                                                    {

  std::for_each(begin, end, [this](auto p) { this->add(p); });

} // StatCollector2D<T, W>::add_weighted(Iter, Iter)

template<typename T, typename W = T>

template<typename Cont >

void lar::util::StatCollector2D< T, W >::add_weighted ( Cont  cont )

inline

Adds entries from a sequence with individually specified weights.

Template Parameters

Cont	type of container of WeightedPair_t elements to be added

Parameters

cont	container of (x, y, weight) pairs to be added

The values in the container must be tuples with first and second element convertible to the Data_t and the third element convertible to Weight_t.

Definition at line 625 of file StatCollector.h.

        { add_weighted(std::begin(cont), std::end(cont)); }

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::AverageWeight ( ) const

inline

Returns the arithmetic average of the weights.

Returns

the weight average

Exceptions

std::range_error

if no entry was added

Definition at line 723 of file StatCollector.h.

{ return Base_t::AverageWeight(); }

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::AverageX

(

)

const

Returns the x value average.

Returns

the x value average

Exceptions

std::range_error

if the total weight is 0 (usually: no data)

Definition at line 999 of file StatCollector.h.

{
  if (Weights() == Weight_t(0))
    throw std::range_error("StatCollector2D<>::AverageX(): divide by 0");
  return SumX() / Weights();
} // StatCollector2D<T, W>::AverageX()

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::AverageY

(

)

const

Returns the y value average.

Returns

the y value average

Exceptions

std::range_error

if the total weight is 0 (usually: no data)

Definition at line 1030 of file StatCollector.h.

{
  if (Weights() == Weight_t(0))
    throw std::range_error("StatCollector2D<>::AverageY(): divide by 0");
  return SumY() / Weights();
} // StatCollector2D<T, W>::AverageY()

template<typename T , typename W >

void lar::util::StatCollector2D< T, W >::clear ( )

inline

Clears all the statistics.

Definition at line 989 of file StatCollector.h.

                                                {
  Base_t::clear();
  x.clear();
  y.clear();
  sum_xy = Weight_t(0);
} // StatCollector<T, W>::clear()

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::Covariance

(

)

const

Returns the covariance of the (x, y) pair.

Returns

the square of the RMS of the y values

Exceptions

std::range_error

if the total weight is 0 (usually: no data)

Definition at line 1050 of file StatCollector.h.

{
  if (Weights() == Weight_t(0))
    throw std::range_error("StatCollector2D<>::Covariance(): divide by 0");
  return (SumXY() - SumX() * SumY() / Weights()) / Weights();
} // StatCollector2D<T, W>::VarianceY()

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::LinearCorrelation

(

)

const

Returns the linear correlation.

Returns

the linear correlation RMS of the y values

Exceptions

std::range_error	if the total weight is 0 (see Covariance())
std::range_error	if any variance is non-positive

Definition at line 1071 of file StatCollector.h.

{
  if (Weights() == Data_t(0))
    throw std::range_error("StatCollector2D<>::LinearCorrelation(): divide by 0");

  const Weight_t var_prod = VarianceX() * VarianceY();
  if (var_prod <= Weight_t(0))
    throw std::range_error("StatCollector2D<>::LinearCorrelation(): variance is 0");

  return Covariance() / std::sqrt(var_prod);
} // StatCollector2D<T, W>::LinearCorrelation()

template<typename T, typename W = T>

int lar::util::StatCollector2D< T, W >::N ( void  ) const

inline

Returns the number of entries added.

Definition at line 637 of file StatCollector.h.

{ return Base_t::N(); }

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::RMSx

(

)

const

Returns the standard deviation of the x sample.

Returns

the RMS of the x values

Exceptions

std::range_error	if the total weight is 0 (see VarianceX())
std::range_error	if VarianceX() is negative (due to rounding errors)

Definition at line 1019 of file StatCollector.h.

{
  const Weight_t rms2 = VarianceX();
  if (rms2 < Weight_t(0)) return 0.;
//    throw std::range_error("StatCollector2D<>::RMSx(): negative RMS^2");
  return std::sqrt(rms2);
} // StatCollector2D<T, W>::RMSx()

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::RMSy

(

)

const

Returns the standard deviation of the y sample.

Returns

the RMS of the y values

Exceptions

std::range_error	if the total weight is 0 (see VarianceY())
std::range_error	if VarianceY() is negative (due to rounding errors)

Definition at line 1060 of file StatCollector.h.

{
  const Weight_t rms2 = VarianceY();
  if (rms2 < Weight_t(0)) return 0.;
//    throw std::range_error("StatCollector2D<>::RMSy(): negative RMS^2");
  return std::sqrt(rms2);
} // StatCollector2D<T, W>::RMSy()

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::SumSqX ( ) const

inline

Returns the weighted sum of the square of the x values.

Definition at line 649 of file StatCollector.h.

{ return x.SumSq(); }

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::SumSqY ( ) const

inline

Returns the weighted sum of the square of the y values.

Definition at line 652 of file StatCollector.h.

{ return y.SumSq(); }

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::SumX ( ) const

inline

Returns the weighted sum of the x values.

Definition at line 643 of file StatCollector.h.

{ return x.Sum(); }

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::SumXY ( ) const

inline

Returns the weighted sum of the product of x and y values.

Definition at line 655 of file StatCollector.h.

{ return sum_xy; }

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::SumY ( ) const

inline

Returns the weighted sum of the y values.

Definition at line 646 of file StatCollector.h.

{ return y.Sum(); }

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::VarianceX

(

)

const

Returns the variance of the x values.

Returns

the square of the RMS of the x values

Exceptions

std::range_error

if the total weight is 0 (usually: no data)

Definition at line 1009 of file StatCollector.h.

{
  if (Weights() == Weight_t(0))
    throw std::range_error("StatCollector2D<>::VarianceX(): divide by 0");
  return (SumSqX() - sqr(SumX()) / Weights()) / Weights();
} // StatCollector2D<T, W>::VarianceX()

template<typename T , typename W >

lar::util::StatCollector2D< T, W >::Weight_t lar::util::StatCollector2D< T, W >::VarianceY

(

)

const

Returns the variance of the y values.

Returns

the square of the RMS of the y values

Exceptions

std::range_error

if the total weight is 0 (usually: no data)

Definition at line 1040 of file StatCollector.h.

{
  if (Weights() == Weight_t(0))
    throw std::range_error("StatCollector2D<>::VarianceY(): divide by 0");
  return (SumSqY() - sqr(SumY()) / Weights()) / Weights();
} // StatCollector2D<T, W>::VarianceY()

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::Weights ( ) const

inline

Returns the sum of the weights.

Definition at line 640 of file StatCollector.h.

{ return Base_t::Weights(); }

Member Data Documentation

template<typename T, typename W = T>

Weight_t lar::util::StatCollector2D< T, W >::sum_xy = Weight_t(0)

protected

weighted sum of xy

Definition at line 732 of file StatCollector.h.

template<typename T, typename W = T>

Variable_t lar::util::StatCollector2D< T, W >::x

protected

accumulator for variable x

Definition at line 730 of file StatCollector.h.

template<typename T, typename W = T>

Variable_t lar::util::StatCollector2D< T, W >::y

protected

accumulator for variable y

Definition at line 731 of file StatCollector.h.

---

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

• lardataalg/lardataalg/Utilities/StatCollector.h