Struct ndhistogram::axis::VariableCyclic
source · pub struct VariableCyclic<T = f64> { /* private fields */ }
Expand description
A wrap-around axis with variable-sized bins.
A wrap-around axis with variable-sized bins, constructed from a list of bin edges.
Examples
1D histogram with cyclic variable sized azimuthal angle binning.
use ndhistogram::{ndhistogram, Histogram};
use ndhistogram::axis::{Axis, BinInterval, VariableCyclic};
use std::f64::consts::PI;
let mut hist = ndhistogram!(VariableCyclic::new(vec![0.0, PI/2.0, PI, 2.0*PI]); i32);
let angle = 0.1;
hist.fill(&angle); // fills the first bin
hist.fill(&(angle + 2.0*PI)); // wraps around and fills the same first bin
assert_eq!(hist.value(&angle), Some(&2));
Implementations§
source§impl<T> VariableCyclic<T>where
T: PartialOrd + Copy,
impl<T> VariableCyclic<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 VariableCyclic<T>where
T: PartialOrd + Copy + Num,
impl<T> Axis for VariableCyclic<T>where T: PartialOrd + Copy + Num,
§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 VariableCyclic<T>
impl<T: Clone> Clone for VariableCyclic<T>
source§fn clone(&self) -> VariableCyclic<T>
fn clone(&self) -> VariableCyclic<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 VariableCyclic<T>
impl<T: Debug> Debug for VariableCyclic<T>
source§impl<T: Default> Default for VariableCyclic<T>
impl<T: Default> Default for VariableCyclic<T>
source§fn default() -> VariableCyclic<T>
fn default() -> VariableCyclic<T>
Returns the “default value” for a type. Read more
source§impl<'de, T> Deserialize<'de> for VariableCyclic<T>where
T: Deserialize<'de>,
impl<'de, T> Deserialize<'de> for VariableCyclic<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> Display for VariableCyclic<T>where
T: PartialOrd + Copy + Display,
impl<T> Display for VariableCyclic<T>where T: PartialOrd + Copy + Display,
source§impl<T: Hash> Hash for VariableCyclic<T>
impl<T: Hash> Hash for VariableCyclic<T>
source§impl<'a, T> IntoIterator for &'a VariableCyclic<T>where
VariableCyclic<T>: Axis,
impl<'a, T> IntoIterator for &'a VariableCyclic<T>where VariableCyclic<T>: Axis,
§type Item = (usize, <VariableCyclic<T> as Axis>::BinInterval)
type Item = (usize, <VariableCyclic<T> as Axis>::BinInterval)
The type of the elements being iterated over.
§type IntoIter = Box<dyn Iterator<Item = <&'a VariableCyclic<T> as IntoIterator>::Item> + 'a, Global>
type IntoIter = Box<dyn Iterator<Item = <&'a VariableCyclic<T> as IntoIterator>::Item> + 'a, Global>
Which kind of iterator are we turning this into?
source§impl<T: Ord> Ord for VariableCyclic<T>
impl<T: Ord> Ord for VariableCyclic<T>
source§fn cmp(&self, other: &VariableCyclic<T>) -> Ordering
fn cmp(&self, other: &VariableCyclic<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<VariableCyclic<T>> for VariableCyclic<T>
impl<T: PartialEq> PartialEq<VariableCyclic<T>> for VariableCyclic<T>
source§fn eq(&self, other: &VariableCyclic<T>) -> bool
fn eq(&self, other: &VariableCyclic<T>) -> bool
This method tests for
self
and other
values to be equal, and is used
by ==
.source§impl<T: PartialOrd> PartialOrd<VariableCyclic<T>> for VariableCyclic<T>
impl<T: PartialOrd> PartialOrd<VariableCyclic<T>> for VariableCyclic<T>
source§fn partial_cmp(&self, other: &VariableCyclic<T>) -> Option<Ordering>
fn partial_cmp(&self, other: &VariableCyclic<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 VariableCyclic<T>where
T: Serialize,
impl<T> Serialize for VariableCyclic<T>where T: Serialize,
impl<T: Eq> Eq for VariableCyclic<T>
impl<T> StructuralEq for VariableCyclic<T>
impl<T> StructuralPartialEq for VariableCyclic<T>
Auto Trait Implementations§
impl<T> RefUnwindSafe for VariableCyclic<T>where T: RefUnwindSafe,
impl<T> Send for VariableCyclic<T>where T: Send,
impl<T> Sync for VariableCyclic<T>where T: Sync,
impl<T> Unpin for VariableCyclic<T>where T: Unpin,
impl<T> UnwindSafe for VariableCyclic<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