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.

This is required by GridBuilder to know how to build a Grid’s projections on the coordinate axes.

Required Associated Types

type Elem: Ord

Required Methods

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 fo 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.

Errors

See each of the struct-level documentation for details on errors an implementor may return.

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

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.

Implementors

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

type Elem = T

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

type Elem = T

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

type Elem = T

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

type Elem = T

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

type Elem = T