Struct ndarray_stats::histogram::strategies::Auto

pub struct Auto<T> { /* private fields */ }

Maximum of the Sturges and FreedmanDiaconis strategies. Provides good all around performance.

A compromise to get a good value. For small datasets the Sturges value will usually be chosen, while larger datasets will usually default to FreedmanDiaconis. Avoids the overly conservative behaviour of FreedmanDiaconis and Sturges for small and large datasets respectively.

Notes

This strategy requires the data

• not being empty
• not being constant
• having positive IQR

Implementations

impl<T> Auto<T> where
    T: Ord + Clone + FromPrimitive + NumOps + Zero, 

pub fn bin_width(&self) -> T

The bin width (or bin length) according to the fitted strategy.

Trait Implementations

impl<T> BinsBuildingStrategy for Auto<T> where
    T: Ord + Clone + FromPrimitive + NumOps + Zero, 

fn from_array<S>(a: &ArrayBase<S, Ix1>) -> Result<Self, BinsBuildError> where
    S: Data<Elem = Self::Elem>, 

Returns Err(BinsBuildError::Strategy) if IQR==0. Returns Err(BinsBuildError::EmptyInput) if a.len()==0. Returns Ok(Self) otherwise.

type Elem = T

fn build(&self) -> Bins<T>

Returns a Bins instance, according to parameters inferred from observations.

fn n_bins(&self) -> usize

Returns the optimal number of bins, according to parameters inferred from observations.

impl<T: Debug> Debug for Auto<T>

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

Formats the value using the given formatter.