juce::StatisticsAccumulator< FloatType > Class Template Reference

A class that measures various statistics about a series of floating point values that it is given. More...

#include <juce_StatisticsAccumulator.h>

Public Member Functions
	StatisticsAccumulator ()=default
	Constructs a new StatisticsAccumulator.
void	addValue (FloatType v) noexcept
	Add a new value to the accumulator. More...
void	reset () noexcept
	Reset the accumulator. More...
FloatType	getAverage () const noexcept
	Returns the average (arithmetic mean) of all previously added values. More...
FloatType	getVariance () const noexcept
	Returns the variance of all previously added values. More...
FloatType	getStandardDeviation () const noexcept
	Returns the standard deviation of all previously added values. More...
FloatType	getMinValue () const noexcept
	Returns the smallest of all previously added values. More...
FloatType	getMaxValue () const noexcept
	Returns the largest of all previously added values. More...
size_t	getCount () const noexcept
	Returns how many values have been added to this accumulator.

Detailed Description

template<typename FloatType>
class juce::StatisticsAccumulator< FloatType >

A class that measures various statistics about a series of floating point values that it is given.

Definition at line 38 of file juce_StatisticsAccumulator.h.

Member Function Documentation

addValue()

template<typename FloatType >

void juce::StatisticsAccumulator< FloatType >::addValue ( FloatType  v )

inlinenoexcept

Add a new value to the accumulator.

This will update all running statistics accordingly.

Definition at line 49 of file juce_StatisticsAccumulator.h.

reset()

template<typename FloatType >

void juce::StatisticsAccumulator< FloatType >::reset ( )

inlinenoexcept

Reset the accumulator.

This will reset all currently saved statistcs.

Definition at line 64 of file juce_StatisticsAccumulator.h.

getAverage()

template<typename FloatType >

FloatType juce::StatisticsAccumulator< FloatType >::getAverage ( ) const

inlinenoexcept

Returns the average (arithmetic mean) of all previously added values.

If no values have been added yet, this will return zero.

Definition at line 70 of file juce_StatisticsAccumulator.h.

getVariance()

template<typename FloatType >

FloatType juce::StatisticsAccumulator< FloatType >::getVariance ( ) const

inlinenoexcept

Returns the variance of all previously added values.

If no values have been added yet, this will return zero.

Definition at line 79 of file juce_StatisticsAccumulator.h.

Referenced by juce::StatisticsAccumulator< FloatType >::getStandardDeviation().

getStandardDeviation()

template<typename FloatType >

FloatType juce::StatisticsAccumulator< FloatType >::getStandardDeviation ( ) const

inlinenoexcept

Returns the standard deviation of all previously added values.

If no values have been added yet, this will return zero.

Definition at line 88 of file juce_StatisticsAccumulator.h.

References juce::StatisticsAccumulator< FloatType >::getVariance().

getMinValue()

template<typename FloatType >

FloatType juce::StatisticsAccumulator< FloatType >::getMinValue ( ) const

inlinenoexcept

Returns the smallest of all previously added values.

If no values have been added yet, this will return positive infinity.

Definition at line 96 of file juce_StatisticsAccumulator.h.

getMaxValue()

template<typename FloatType >

FloatType juce::StatisticsAccumulator< FloatType >::getMaxValue ( ) const

inlinenoexcept

Returns the largest of all previously added values.

If no values have been added yet, this will return negative infinity.

Definition at line 104 of file juce_StatisticsAccumulator.h.

---

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

• juce_StatisticsAccumulator.h