Struct rolling_stats::Stats

pub struct Stats<T: Float + Zero + One + AddAssign + FromPrimitive + PartialEq + Debug> {
    pub min: T,
    pub max: T,
    pub mean: T,
    pub std_dev: T,
    pub count: usize,
    // some fields omitted
}

Stats object calculates continuous min/max/mean/deviation for tracking of time varying statistics.

See: https://en.wikipedia.org/wiki/Algorithms_for_calculating_variance#Welford's_Online_algorithm for Details of the underlying algorithm.

Fields

min: T

Minimum value

max: T

Maximum value

mean: T

Mean of sample set

std_dev: T

Standard deviation of sample

count: usize

Number of values collected

Implementations

impl<T> Stats<T> where
    T: Float + Zero + One + AddAssign + FromPrimitive + PartialEq + Debug, 

pub fn new() -> Stats<T>

Create a new stats object

pub fn update(&mut self, value: T)

Update the stats object

pub fn merge<S: Iterator<Item = Stats<T>>>(stats: S) -> Stats<T>

Merge a set of stats objects for analysis This performs a weighted averaging across the provided stats object, the output object should not be updated further.

Trait Implementations

impl<T: Clone + Float + Zero + One + AddAssign + FromPrimitive + PartialEq + Debug> Clone for Stats<T>

fn clone(&self) -> Stats<T>

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug + Float + Zero + One + AddAssign + FromPrimitive + PartialEq> Debug for Stats<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de, T: Float + Zero + One + AddAssign + FromPrimitive + PartialEq + Debug> Deserialize<'de> for Stats<T> where
    T: Deserialize<'de>,
    T: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Display for Stats<T> where
    T: Display + Float + Zero + One + AddAssign + FromPrimitive + PartialEq + Debug, 

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Float + Zero + One + AddAssign + FromPrimitive + PartialEq + Debug> Serialize for Stats<T> where
    T: Serialize, 

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.