Struct ndhistogram::axis::VariableNoFlow
source · pub struct VariableNoFlow<T = f64> { /* private fields */ }
Expand description
An axis with variable sized bins and no overflow bins.
An axis with variable sized bins constructed with a list of bin edges. This axis has (num edges - 1) bins.
Example
Create a 1D histogram with 3 variable width bins between 0.0 and 7.0.
use ndhistogram::{ndhistogram, Histogram};
use ndhistogram::axis::{Axis, VariableNoFlow};
let mut hist = ndhistogram!(VariableNoFlow::new(vec![0.0, 1.0, 3.0, 7.0]); i32);
hist.fill(&-1.0); // will be ignored as there is no underflow bin
hist.fill(&1.0);
hist.fill(&2.0);
assert_eq!(
hist.values().copied().collect::<Vec<_>>(),
vec![0, 2, 0],
);
Implementations§
source§impl<T: PartialOrd + Copy> VariableNoFlow<T>
impl<T: PartialOrd + Copy> VariableNoFlow<T>
sourcepub fn new<I: IntoIterator<Item = T>>(bin_edges: I) -> Self
pub fn new<I: IntoIterator<Item = T>>(bin_edges: I) -> Self
Factory method to create an variable binning from a set of bin edges with no under/overflow bins. See the documentation for Variable::new.
Panics
Panics under the same conditions as Variable::new.
Trait Implementations§
source§impl<T: PartialOrd + Copy> Axis for VariableNoFlow<T>
impl<T: PartialOrd + Copy> Axis for VariableNoFlow<T>
§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<T: Clone> Clone for VariableNoFlow<T>
impl<T: Clone> Clone for VariableNoFlow<T>
source§fn clone(&self) -> VariableNoFlow<T>
fn clone(&self) -> VariableNoFlow<T>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<T: Debug> Debug for VariableNoFlow<T>
impl<T: Debug> Debug for VariableNoFlow<T>
source§impl<T: Default> Default for VariableNoFlow<T>
impl<T: Default> Default for VariableNoFlow<T>
source§fn default() -> VariableNoFlow<T>
fn default() -> VariableNoFlow<T>
Returns the “default value” for a type. Read more
source§impl<'de, T> Deserialize<'de> for VariableNoFlow<T>where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for VariableNoFlow<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<T: PartialOrd + Copy + Display> Display for VariableNoFlow<T>where
Self: Axis,
impl<T: PartialOrd + Copy + Display> Display for VariableNoFlow<T>where Self: Axis,
source§impl<T: Hash> Hash for VariableNoFlow<T>
impl<T: Hash> Hash for VariableNoFlow<T>
source§impl<'a, T: PartialOrd + Copy> IntoIterator for &'a VariableNoFlow<T>
impl<'a, T: PartialOrd + Copy> IntoIterator for &'a VariableNoFlow<T>
§type Item = (usize, <VariableNoFlow<T> as Axis>::BinInterval)
type Item = (usize, <VariableNoFlow<T> as Axis>::BinInterval)
The type of the elements being iterated over.
§type IntoIter = Box<dyn Iterator<Item = <&'a VariableNoFlow<T> as IntoIterator>::Item> + 'a, Global>
type IntoIter = Box<dyn Iterator<Item = <&'a VariableNoFlow<T> as IntoIterator>::Item> + 'a, Global>
Which kind of iterator are we turning this into?
source§impl<T: Ord> Ord for VariableNoFlow<T>
impl<T: Ord> Ord for VariableNoFlow<T>
source§fn cmp(&self, other: &VariableNoFlow<T>) -> Ordering
fn cmp(&self, other: &VariableNoFlow<T>) -> Ordering
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<VariableNoFlow<T>> for VariableNoFlow<T>
impl<T: PartialEq> PartialEq<VariableNoFlow<T>> for VariableNoFlow<T>
source§fn eq(&self, other: &VariableNoFlow<T>) -> bool
fn eq(&self, other: &VariableNoFlow<T>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<T: PartialOrd> PartialOrd<VariableNoFlow<T>> for VariableNoFlow<T>
impl<T: PartialOrd> PartialOrd<VariableNoFlow<T>> for VariableNoFlow<T>
source§fn partial_cmp(&self, other: &VariableNoFlow<T>) -> Option<Ordering>
fn partial_cmp(&self, other: &VariableNoFlow<T>) -> Option<Ordering>
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 moresource§impl<T> Serialize for VariableNoFlow<T>where
T: Serialize,
impl<T> Serialize for VariableNoFlow<T>where T: Serialize,
impl<T: Eq> Eq for VariableNoFlow<T>
impl<T> StructuralEq for VariableNoFlow<T>
impl<T> StructuralPartialEq for VariableNoFlow<T>
Auto Trait Implementations§
impl<T> RefUnwindSafe for VariableNoFlow<T>where T: RefUnwindSafe,
impl<T> Send for VariableNoFlow<T>where T: Send,
impl<T> Sync for VariableNoFlow<T>where T: Sync,
impl<T> Unpin for VariableNoFlow<T>where T: Unpin,
impl<T> UnwindSafe for VariableNoFlow<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