Struct ndarray_histogram::histogram::strategies::Rice

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

A strategy that does not take variability into account, only data size. Commonly overestimates number of bins required.

Let n be the number of observations and n_bins be the number of bins.

n_bins = 2n^1/3

n_bins is only proportional to cube root of n. It tends to overestimate the n_bins and it does not take into account data variability.

Notes

This strategy requires the data

• not being empty
• not being constant

Implementations

impl<T> Rice<T>where T: Ord + Send + Clone + FromPrimitive + ToPrimitive + 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 Rice<T>where T: Ord + Send + Clone + FromPrimitive + ToPrimitive + NumOps + Zero,

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

Returns Err(BinsBuildError::Strategy) if the array is constant. 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.

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

Returns a strategy that has learnt the required parameter for building Bins for given 1-dimensional array, or an Err if it is not possible to infer the required parameter with the given data and specified strategy.

impl<T: Debug> Debug for Rice<T>

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

Formats the value using the given formatter.