Struct Variable

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

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.

For floating point types, positive and negative infinities map to overflow and underflow bins respectively. NaN map to the overflow bin.

Example

Create a 1D histogram with 3 variable width bins between 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) -> Result<Self, AxisError>

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

If less than 2 edges are provided or if it fails to sort the bin edges (for example if a NAN value is given), an error is returned.

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

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.

fn num_bins(&self) -> usize

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

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::num_bins is given.

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

An iterator over bin numbers

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

An iterator over bin numbers and bin intervals

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

An iterator over bin intervals.

fn num_dim(&self) -> usize

The number of dimensions that this object corresponds to. For most Axis types this will simply be 1. However, Axes (i.e. a set of Axis) also implement Axis and should return the number of Axis that it contains.

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

impl<T: Default> Default for Variable<T>

fn default() -> Variable<T>

Returns the “default value” for a type.

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

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Variable<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 = <&'a Variable<T> as IntoIterator>::Item> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for Variable<T>

fn cmp(&self, other: &Variable<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Variable<T>

fn partial_cmp(&self, other: &Variable<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

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

impl<T> StructuralPartialEq for Variable<T>