Struct ndhistogram::axis::Variable

pub struct Variable<T = f64> { /* fields omitted */ }

An axis with variable sized bins.

An axis with variable sized bins. Constructed with a list of bin edges. Beyond the lowest (highest) bin edges is an underflow (overflow) bin. Hence this axis has num edges + 1 bins.

Example

Create a 1D histogram with 3 variable width bin 0.0 and 7.0, plus overflow and underflow bins.

   use ndhistogram::{ndhistogram, Histogram};
   use ndhistogram::axis::{Axis, Variable, BinInterval};
   let mut hist = ndhistogram!(Variable::new(vec![0.0, 1.0, 3.0, 7.0]); i32);
   hist.fill(&0.0);
   hist.fill(&1.0);
   hist.fill(&2.0);
   assert_eq!(
       hist.values().copied().collect::<Vec<_>>(),
       vec![0, 1, 2, 0, 0],
   );

Implementations

impl<T> Variable<T> where
    T: PartialOrd + Copy, 

pub fn new<I: IntoIterator<Item = T>>(bin_edges: I) -> Self

Factory method to create an axis with Variable binning given a set of bin edges.

Panics

Panics if errors less than 2 edges are provided or if it fails to sort the bin edges (for example if a NAN value is given).

pub fn low(&self) -> &T

Low edge of axis (excluding underflow bin).

pub fn high(&self) -> &T

High edge of axis (excluding overflow bin).

Trait Implementations

impl<T> Axis for Variable<T> where
    T: PartialOrd + Copy, 

type Coordinate = T

The type representing a location on this axis.

type BinInterval = BinInterval<T>

The type of an interval representing the set of Coordinates that correspond to a histogram bin

pub fn index(&self, coordinate: &Self::Coordinate) -> Option<usize>

Map from coordinate to bin number. Returns an option as not all valid coordinates are necessarily contained within a bin.

pub fn numbins(&self) -> usize

The number of bins in this axis, including underflow and overflow.

pub fn bin(&self, index: usize) -> Option<Self::BinInterval>

Map from bin number to axis to the interval covering the range of coordinates that this bin contains. Returns an option in case an index >= Axis::numbins is given.

pub fn indices(&self) -> Box<dyn Iterator<Item = usize>>

An iterator over bin numbers

pub fn iter(&self) -> Box<dyn Iterator<Item = (usize, Self::BinInterval)> + '_>

An iterator over bin numbers and bin intervals

pub fn bins(&self) -> Box<dyn Iterator<Item = Self::BinInterval> + '_>

An iterator over bin intervals.

impl<T: Clone> Clone for Variable<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Variable<T>

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

Formats the value using the given formatter.

impl<T: Display + PartialOrd + Copy> Display for Variable<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Variable<T>

impl<'a, T> IntoIterator for &'a Variable<T> where
    Variable<T>: Axis, 

type Item = (usize, <Variable<T> as Axis>::BinInterval)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = Self::Item> + 'a>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<Variable<T>> for Variable<T>

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

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

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

This method tests for !=.

impl<T> StructuralEq for Variable<T>

impl<T> StructuralPartialEq for Variable<T>