JaiaBot 3.0.0
JaiaBot micro-AUV software
Loading...
Searching...
No Matches
jaiabot::utils::RollingStatsAccumulator< Quantity > Class Template Reference

Maintains a circular buffer of n samples of some boost::units::quantity and allows for computation of statistics on the contents of this buffer. More...

#include <jaiabot/utils/stats.h>

Public Types

using value_type = typename Quantity::value_type
using unit_type = typename Quantity::unit_type
using unit2_type = typename boost::units::multiply_typeof_helper<unit_type, unit_type>::type
using QuantitySquared = boost::units::quantity<unit2_type, value_type>

Public Member Functions

 RollingStatsAccumulator (std::size_t n)
 Constructor.
void push_back (const Quantity &v)
void operator() (const Quantity &v)
std::size_t size () const
std::size_t n () const
Quantity mean () const
Quantity μ () const
Quantity median () const
QuantitySquared variance (VarianceNorm norm=VarianceNorm::UNBIASED) const
 Variance.
QuantitySquared σ2 (VarianceNorm norm=VarianceNorm::UNBIASED) const
Quantity stddev (VarianceNorm norm=VarianceNorm::UNBIASED) const
 Standard deviation.
Quantity σ (VarianceNorm norm=VarianceNorm::UNBIASED) const
Quantity min () const
Quantity max () const

Friends

std::ostream & operator<< (std::ostream &os, const RollingStatsAccumulator &acc)

Detailed Description

template<typename Quantity>
class jaiabot::utils::RollingStatsAccumulator< Quantity >

Maintains a circular buffer of n samples of some boost::units::quantity and allows for computation of statistics on the contents of this buffer.

Definition at line 67 of file stats.h.

Member Typedef Documentation

◆ QuantitySquared

template<typename Quantity>
using jaiabot::utils::RollingStatsAccumulator< Quantity >::QuantitySquared = boost::units::quantity<unit2_type, value_type>

Definition at line 81 of file stats.h.

◆ unit2_type

template<typename Quantity>
using jaiabot::utils::RollingStatsAccumulator< Quantity >::unit2_type = typename boost::units::multiply_typeof_helper<unit_type, unit_type>::type

Definition at line 80 of file stats.h.

◆ unit_type

template<typename Quantity>
using jaiabot::utils::RollingStatsAccumulator< Quantity >::unit_type = typename Quantity::unit_type

Definition at line 79 of file stats.h.

◆ value_type

template<typename Quantity>
using jaiabot::utils::RollingStatsAccumulator< Quantity >::value_type = typename Quantity::value_type

Definition at line 78 of file stats.h.

Constructor & Destructor Documentation

◆ RollingStatsAccumulator()

template<typename Quantity>
jaiabot::utils::RollingStatsAccumulator< Quantity >::RollingStatsAccumulator ( std::size_t n)
inline

Constructor.

Parameters
nNumber of samples to maintain

Definition at line 73 of file stats.h.

Member Function Documentation

◆ μ()

template<typename Quantity>
Quantity jaiabot::utils::RollingStatsAccumulator< Quantity >::μ ( ) const
inline

Definition at line 87 of file stats.h.

◆ σ()

template<typename Quantity>
Quantity jaiabot::utils::RollingStatsAccumulator< Quantity >::σ ( VarianceNorm norm = VarianceNorm::UNBIASED) const
inline

Definition at line 127 of file stats.h.

◆ σ2()

template<typename Quantity>
QuantitySquared jaiabot::utils::RollingStatsAccumulator< Quantity >::σ2 ( VarianceNorm norm = VarianceNorm::UNBIASED) const
inline

Definition at line 118 of file stats.h.

◆ max()

template<typename Quantity>
Quantity jaiabot::utils::RollingStatsAccumulator< Quantity >::max ( ) const
inline

Definition at line 130 of file stats.h.

◆ mean()

template<typename Quantity>
Quantity jaiabot::utils::RollingStatsAccumulator< Quantity >::mean ( ) const
inline

Definition at line 86 of file stats.h.

◆ median()

template<typename Quantity>
Quantity jaiabot::utils::RollingStatsAccumulator< Quantity >::median ( ) const
inline

Definition at line 89 of file stats.h.

◆ min()

template<typename Quantity>
Quantity jaiabot::utils::RollingStatsAccumulator< Quantity >::min ( ) const
inline

Definition at line 129 of file stats.h.

◆ n()

template<typename Quantity>
std::size_t jaiabot::utils::RollingStatsAccumulator< Quantity >::n ( ) const
inline

Definition at line 84 of file stats.h.

◆ operator()()

template<typename Quantity>
void jaiabot::utils::RollingStatsAccumulator< Quantity >::operator() ( const Quantity & v)
inline

Definition at line 76 of file stats.h.

◆ push_back()

template<typename Quantity>
void jaiabot::utils::RollingStatsAccumulator< Quantity >::push_back ( const Quantity & v)
inline

Definition at line 75 of file stats.h.

◆ size()

template<typename Quantity>
std::size_t jaiabot::utils::RollingStatsAccumulator< Quantity >::size ( ) const
inline

Definition at line 83 of file stats.h.

◆ stddev()

template<typename Quantity>
Quantity jaiabot::utils::RollingStatsAccumulator< Quantity >::stddev ( VarianceNorm norm = VarianceNorm::UNBIASED) const
inline

Standard deviation.

Parameters
normIf UNBIASED, normalize with N-1; if BIASED normalize with N

Definition at line 123 of file stats.h.

◆ variance()

template<typename Quantity>
QuantitySquared jaiabot::utils::RollingStatsAccumulator< Quantity >::variance ( VarianceNorm norm = VarianceNorm::UNBIASED) const
inline

Variance.

Parameters
normIf UNBIASED, normalize with N-1; if BIASED normalize with N

Definition at line 105 of file stats.h.

◆ operator<<

template<typename Quantity>
std::ostream & operator<< ( std::ostream & os,
const RollingStatsAccumulator< Quantity > & acc )
friend

Definition at line 28 of file stats.h.


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