Struct ndhistogram::axis::Variable
source · pub struct Variable<T = f64> { /* private fields */ }
Expand description
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 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§
source§impl<T> Variable<T>where
T: PartialOrd + Copy,
impl<T> Variable<T>where T: PartialOrd + Copy,
sourcepub fn new<I: IntoIterator<Item = T>>(bin_edges: I) -> Self
pub fn new<I: IntoIterator<Item = T>>(bin_edges: I) -> Self
Trait Implementations§
source§impl<T> Axis for Variable<T>where
T: PartialOrd + Copy,
impl<T> Axis for Variable<T>where T: PartialOrd + Copy,
§type Coordinate = T
type Coordinate = T
The type representing a location on this axis.
§type BinInterval = BinInterval<T>
type BinInterval = BinInterval<T>
The type of an interval representing the set of Coordinates that correspond to a histogram bin
source§fn index(&self, coordinate: &Self::Coordinate) -> Option<usize>
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.
source§fn num_bins(&self) -> usize
fn num_bins(&self) -> usize
The number of bins in this axis, including underflow and overflow.
source§fn bin(&self, index: usize) -> Option<Self::BinInterval>
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.
source§fn iter(&self) -> Box<dyn Iterator<Item = (usize, Self::BinInterval)> + '_>
fn iter(&self) -> Box<dyn Iterator<Item = (usize, Self::BinInterval)> + '_>
An iterator over bin numbers and bin intervals
source§impl<'de, T> Deserialize<'de> for Variable<T>where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for Variable<T>where T: Deserialize<'de>,
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
source§impl<'a, T> IntoIterator for &'a Variable<T>where
Variable<T>: Axis,
impl<'a, T> IntoIterator for &'a Variable<T>where Variable<T>: Axis,
source§impl<T: Ord> Ord for Variable<T>
impl<T: Ord> Ord for Variable<T>
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere Self: Sized,
Compares and returns the maximum of two values. Read more
source§impl<T: PartialEq> PartialEq<Variable<T>> for Variable<T>
impl<T: PartialEq> PartialEq<Variable<T>> for Variable<T>
source§impl<T: PartialOrd> PartialOrd<Variable<T>> for Variable<T>
impl<T: PartialOrd> PartialOrd<Variable<T>> for Variable<T>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for
self
and other
) and is used by the <=
operator. Read moreimpl<T: Eq> Eq for Variable<T>
impl<T> StructuralEq for Variable<T>
impl<T> StructuralPartialEq for Variable<T>
Auto Trait Implementations§
impl<T> RefUnwindSafe for Variable<T>where T: RefUnwindSafe,
impl<T> Send for Variable<T>where T: Send,
impl<T> Sync for Variable<T>where T: Sync,
impl<T> Unpin for Variable<T>where T: Unpin,
impl<T> UnwindSafe for Variable<T>where T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more