ultra::distribution< T > Class Template Reference

#include <distribution.h>

Public Member Functions
void	clear ()
void	add (T)
bool	empty () const noexcept
std::size_t	size () const noexcept
double	entropy () const
T	max () const noexcept
T	mean () const noexcept
T	min () const noexcept
const std::map< T, std::uintmax_t > &	seen () const
T	standard_deviation () const
T	variance () const
void	merge (const distribution< T > &)
bool	is_valid () const
bool	load (std::istream &)
bool	save (std::ostream &) const

Detailed Description

template<ArithmeticFloatingType T>
class ultra::distribution< T >

Simplifies the calculation of statistics regarding a sequence (mean, variance, standard deviation, min and max).

Member Function Documentation

add()

template<ArithmeticFloatingType T>

void distribution::add

(

T

val

)

Add a new value to the distribution.

Parameters

[in]

val

new value upon which statistics are recalculated

Remarks

Function ignores NAN values.

clear()

template<ArithmeticFloatingType T>

void distribution::clear

(

)

Resets gathered statistics.

empty()

template<ArithmeticFloatingType T>

bool distribution::empty ( ) const

nodiscardnoexcept

Returns

true if the distribution is empty

max()

template<ArithmeticFloatingType T>

T distribution::max ( ) const

nodiscardnoexcept

Returns

the maximum value of the distribution

mean()

template<ArithmeticFloatingType T>

T distribution::mean ( ) const

nodiscardnoexcept

Returns

the mean value of the distribution

min()

template<ArithmeticFloatingType T>

T distribution::min ( ) const

nodiscardnoexcept

Returns

the minimum value of the distribution

size()

template<ArithmeticFloatingType T>

std::size_t distribution::size ( ) const

nodiscardnoexcept

Returns

number of elements of the distribution

variance()

template<ArithmeticFloatingType T>

T distribution::variance ( ) const

nodiscard

Returns

the variance of the distribution

---

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

• distribution.h
• distribution.tcc