Trait ndarray_stats::histogram::strategies::BinsBuildingStrategy

pub trait BinsBuildingStrategy {
    type Elem: Ord;
    fn from_array<S>(array: &ArrayBase<S, Ix1>) -> Result<Self, BinsBuildError>
    where
        S: Data<Elem = Self::Elem>,
        Self: Sized;
    fn build(&self) -> Bins<Self::Elem>;
    fn n_bins(&self) -> usize;
}

A trait implemented by all strategies to build Bins with parameters inferred from observations.

A BinsBuildingStrategy is required by GridBuilder to know how to build a Grid's projections on the coordinate axes.

Associated Types

type Elem: Ord

Loading content...

Required methods

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

Given some observations in a 1-dimensional array it returns a BinsBuildingStrategy that has learned the required parameter to build a collection of Bins.

It returns Err if it is not possible to build a collection of Bins given the observed data according to the chosen strategy.

fn build(&self) -> Bins<Self::Elem>

Returns a Bins instance, built accordingly to the parameters inferred from observations in from_array.

fn n_bins(&self) -> usize

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

Loading content...

Implementors

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

type Elem = T

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.

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

fn n_bins(&self) -> usize

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

type Elem = T

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.

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

fn n_bins(&self) -> usize

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

type Elem = T

fn from_array<S>(a: &ArrayBase<S, Ix1>) -> 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.

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

fn n_bins(&self) -> usize

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

type Elem = T

fn from_array<S>(a: &ArrayBase<S, Ix1>) -> 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.

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

fn n_bins(&self) -> usize

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

type Elem = T

fn from_array<S>(a: &ArrayBase<S, Ix1>) -> 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.

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

fn n_bins(&self) -> usize

Loading content...