Struct basic_dsp::Statistics

#[repr(C)]
pub struct Statistics<T> {
    pub sum: T,
    pub count: usize,
    pub average: T,
    pub rms: T,
    pub min: T,
    pub min_index: usize,
    pub max: T,
    pub max_index: usize,
}

Statistics about numeric data

Fields

sum: T

Sum of all values

count: usize

How many numbers have been considered for the stats

average: T

Average value

rms: T

Root-mean-square or rms over all values.

min: T

The smallest value.

min_index: usize

The index of the smallest value.

max: T

The largest value.

max_index: usize

The index of the largest value.

Trait Implementations

impl<T> Clone for Statistics<T> where
    T: Clone, 

pub fn clone(&self) -> Statistics<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Statistics<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> PartialEq<Statistics<T>> for Statistics<T> where
    T: PartialEq<T>, 

pub fn eq(&self, other: &Statistics<T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Statistics<T>) -> bool

This method tests for !=.

impl<T> PreciseStats<Complex<T>> for Statistics<Complex<T>> where
    T: RealNumber, 

pub fn add_prec(
    &mut self,
    elem: Complex<T>,
    index: usize,
    sumc: &mut Complex<T>,
    rmsc: &mut Complex<T>
)

Adds a new values to the statistics using the Kahan summation algorithm described here: https://en.wikipedia.org/wiki/Kahan_summation_algorithm

impl<T> PreciseStats<T> for Statistics<T> where
    T: RealNumber, 

pub fn add_prec(&mut self, elem: T, index: usize, sumc: &mut T, rmsc: &mut T)

Adds a new values to the statistics using the Kahan summation algorithm described here: https://en.wikipedia.org/wiki/Kahan_summation_algorithm

impl<T> Stats<Complex<T>> for Statistics<Complex<T>> where
    T: RealNumber, 

pub fn empty() -> Statistics<Complex<T>>

Creates an empty statistics struct.

pub fn invalid() -> Statistics<Complex<T>>

Creates a statistics struct which resembles an invalid result.

pub fn merge(stats: &[Statistics<Complex<T>>]) -> Statistics<Complex<T>>

Merges several statistics into one.

pub fn merge_cols(
    stats: &[ArrayVec<Statistics<Complex<T>>, {_: usize}>]
) -> ArrayVec<Statistics<Complex<T>>, {_: usize}>

Merges several vectors of statistics into one vector.

pub fn empty_vec(len: usize) -> ArrayVec<Statistics<Complex<T>>, {_: usize}>

Creates a vector of empty statistics structs.

pub fn add(&mut self, elem: Complex<T>, index: usize)

Adds a new value to the statistics, all statistic fields get updated.

impl<T> Stats<T> for Statistics<T> where
    T: RealNumber, 

pub fn empty() -> Statistics<T>

Creates an empty statistics struct.

pub fn invalid() -> Statistics<T>

Creates a statistics struct which resembles an invalid result.

pub fn merge(stats: &[Statistics<T>]) -> Statistics<T>

Merges several statistics into one.

pub fn merge_cols(
    stats: &[ArrayVec<Statistics<T>, {_: usize}>]
) -> ArrayVec<Statistics<T>, {_: usize}>

Merges several vectors of statistics into one vector.

pub fn empty_vec(len: usize) -> ArrayVec<Statistics<T>, {_: usize}>

Creates a vector of empty statistics structs.

pub fn add(&mut self, elem: T, index: usize)

Adds a new value to the statistics, all statistic fields get updated.

impl<T> Copy for Statistics<T> where
    T: Copy, 

impl<T> StructuralPartialEq for Statistics<T>