LibCarna::base::math::Statistics< T > Struct Template Reference

Holds mean and variance of an characteristic. More...

#include <math.hpp>

Public Member Functions
	Statistics (T mean, T variance)
	Initializes with mean and variance.
	Statistics (std::size_t size, const std::function< T(std::size_t) > values)
	Computes statistics from size samples queried from values.
Statistics< T > &	operator= (const Statistics< T > &other)
	Copies from other.
T	standardDeviation () const
	Computes the standard deviation.

Public Attributes
T	mean
	Holds the mean.
T	variance
	Holds the variance.

Detailed Description

template<typename T>
struct LibCarna::base::math::Statistics< T >

Holds mean and variance of an characteristic.

Definition at line 653 of file math.hpp.

Constructor & Destructor Documentation

Statistics() [1/2]

template<typename T >

LibCarna::base::math::Statistics< T >::Statistics ( T  mean, T  variance  )

inline

Initializes with mean and variance.

Definition at line 661 of file math.hpp.

Statistics() [2/2]

template<typename T >

LibCarna::base::math::Statistics< T >::Statistics ( std::size_t  size, const std::function< T(std::size_t) >  values  )

inline

Computes statistics from size samples queried from values.

Definition at line 668 of file math.hpp.

Member Function Documentation

operator=()

template<typename T >

Statistics< T > & LibCarna::base::math::Statistics< T >::operator= ( const Statistics< T > &  other )

inline

Copies from other.

Definition at line 699 of file math.hpp.

standardDeviation()

template<typename T >

T LibCarna::base::math::Statistics< T >::standardDeviation ( ) const

inline

Computes the standard deviation.

Definition at line 709 of file math.hpp.

Member Data Documentation

mean

template<typename T >

T LibCarna::base::math::Statistics< T >::mean

Holds the mean.

Definition at line 655 of file math.hpp.

variance

template<typename T >

T LibCarna::base::math::Statistics< T >::variance

Holds the variance.

Definition at line 656 of file math.hpp.

---

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

• include/LibCarna/base/math.hpp