Struct rolling_stats::Stats[][src]

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
[src]

pub fn new() -> Stats<T>[src]

Create a new stats object

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

Update the stats object

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

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>[src]

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

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

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

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

Auto Trait Implementations

impl<T> RefUnwindSafe for Stats<T> where
    T: RefUnwindSafe
[src]

impl<T> Send for Stats<T> where
    T: Send
[src]

impl<T> Sync for Stats<T> where
    T: Sync
[src]

impl<T> Unpin for Stats<T> where
    T: Unpin
[src]

impl<T> UnwindSafe for Stats<T> where
    T: UnwindSafe
[src]

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.