Struct ndhistogram::axis::UniformNoFlow

pub struct UniformNoFlow<T> { /* fields omitted */ }

An axis with equal sized bins and no under/overflow bins.

An axis with N equally spaced, equal sized, bins between (low, high]. Similar to Uniform but this axis has no over/underflow bins. Hence it has N+2 bins.

Example

Create a 1D histogram with uniform 10 uniform bins between -5.0 and 5.0.

   use ndhistogram::{ndhistogram, Histogram};
   use ndhistogram::axis::{Axis, UniformNoFlow, BinInterval};
   let hist = ndhistogram!(UniformNoFlow::new(10, -5.0, 5.0));
   let axis = &hist.axes().0;
   assert_eq!(axis.bin(0), Some(BinInterval::new(-5.0, -4.0)));
   assert_eq!(axis.bin(10), None);

Implementations

impl<T: Float> UniformNoFlow<T>

pub fn new(num: usize, low: T, high: T) -> Self

Factory method to create an axis with num uniformly spaced bins in the range [low, high) with no under/overflow bins.

pub fn low(&self) -> &T

Return the lowest bin edge.

pub fn high(&self) -> &T

Return the highest bin edge.

Trait Implementations

impl<T: Float> Axis for UniformNoFlow<T>

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 UniformNoFlow<T>

pub fn clone(&self) -> UniformNoFlow<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 UniformNoFlow<T>

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

Formats the value using the given formatter.

impl<T: Float + Display> Display for UniformNoFlow<T>

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

Formats the value using the given formatter.

impl<'a, T: Float> IntoIterator for &'a UniformNoFlow<T>

type Item = (usize, <Uniform<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<UniformNoFlow<T>> for UniformNoFlow<T>

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

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

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

This method tests for !=.

impl<T> StructuralPartialEq for UniformNoFlow<T>