Struct ndhistogram::axis::Uniform

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

An axis with equal sized bins.

An axis with N equally spaced, equal sized, bins between (low, high]. Below (above) this range is an underflow (overflow) bin. Hence this axis has N+2 bins.

Example

Create a 1D histogram with 10 uniform bins between -5.0 and 5.0, plus overflow and underflow bins.

   use ndhistogram::{ndhistogram, Histogram};
   use ndhistogram::axis::{Axis, Uniform, BinInterval};
   let hist = ndhistogram!(Uniform::new(10, -5.0, 5.0));
   let axis = &hist.axes().as_tuple().0;
   assert_eq!(axis.bin(0), Some(BinInterval::underflow(-5.0)));
   assert_eq!(axis.bin(1), Some(BinInterval::new(-5.0, -4.0)));
   assert_eq!(axis.bin(11), Some(BinInterval::overflow(5.0)));

Implementations

impl<T> Uniform<T> where
    T: PartialOrd, 

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). Under/overflow bins cover values outside this range.

Panics

Panics if num bins == 0 or low == high.

impl<T> Uniform<T>

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: Float> Axis for Uniform<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 num_bins(&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::num_bins 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.

pub 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 Uniform<T>

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

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

Formats the value using the given formatter.

impl<T: Default> Default for Uniform<T>

pub fn default() -> Uniform<T>

Returns the "default value" for a type.

impl<'de, T> Deserialize<'de> for Uniform<T> where
    T: Deserialize<'de>, 

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T: Display> Display for Uniform<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for Uniform<T>

impl<T: Hash> Hash for Uniform<T>

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl<'a, T: Float> IntoIterator for &'a Uniform<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: Ord> Ord for Uniform<T>

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Uniform<T>> for Uniform<T>

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Uniform<T>> for Uniform<T>

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

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

pub fn lt(&self, other: &Uniform<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Uniform<T>) -> bool

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

pub fn gt(&self, other: &Uniform<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Uniform<T>) -> bool

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

impl<T> Serialize for Uniform<T> where
    T: Serialize, 

pub fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<T> StructuralEq for Uniform<T>

impl<T> StructuralPartialEq for Uniform<T>