Struct UniformCyclic

pub struct UniformCyclic<T = f64> { /* private fields */ }

A wrap-around axis with equal-sized bins.

An axis with N equally-spaced, equal-sized bins, in [low, high). Entries outside this interval get wrapped around. There are no overflow bins so this axis has exactly N bins.

Examples

1D histogram with 4 bins distributed around a circle.

use ndhistogram::{ndhistogram, Histogram};
use ndhistogram::axis::{Axis, BinInterval, UniformCyclic};
let mut hist = ndhistogram!(UniformCyclic::new(4, 0.0, 360.0)?);
hist.fill(& 45.0         ); // Add entry at 45 degrees
hist.fill(&(45.0 + 360.0)); // Add entry at 45 degrees + one whole turn
hist.fill(&(45.0 - 360.0)); // Add entry at 45 degrees + one whole turn backwards
// All 3 above entries end up in the same bin
assert_eq!(hist.value(&45.0), Some(&3.0));
// Lookup also wraps around
assert_eq!(hist.value(&(45.0 + 360.0)), Some(&3.0));
assert_eq!(hist.value(&(45.0 - 360.0)), Some(&3.0));

Time of day

use ndhistogram::{ndhistogram, Histogram};
use ndhistogram::axis::{Axis, BinInterval, UniformCyclic};

let bins_per_day = 24;
let hours_per_bin = 1;
let start_at_zero = 0;
let four_pm = 16;
let mut hist = ndhistogram!(UniformCyclic::with_step_size(
    bins_per_day, start_at_zero, hours_per_bin
)?);
hist.fill(&40);                               // The 40th hour of the week ...
assert_eq!(hist.value(&four_pm), Some(&1.0)); // ... is at 4 pm.

Implementations

impl<T> UniformCyclic<T>

where T: PartialOrd + Num + NumCast + NumOps + Copy,

pub fn new(nbins: usize, low: T, high: T) -> Result<Self, AxisError>

where T: Float,

Create a wrap-around axis with nbins uniformly-spaced bins in the range [low, high).

Only implemented for Float. Use UniformCyclic::with_step_size for integers.

For floating point types, infinities and NaN do not map to any bin.

The parameters have the same constraints as UniformNoFlow::new, otherwise an error in returned.

pub fn with_step_size(nbins: usize, low: T, step: T) -> Result<Self, AxisError>

Create a wrap-around axis with nbins uniformly-spaced bins in the range [low, low+num*step). The parameters have the same constraints as UniformNoFlow::new, otherwise an error is returned.

impl<T> UniformCyclic<T>

pub fn low(&self) -> &T

Low edge of axis (excluding wrap-around)

pub fn high(&self) -> &T

High edge of axis (excluding wrap-around)

Trait Implementations

impl<T: PartialOrd + Num + NumCast + NumOps + Copy> Axis for UniformCyclic<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

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.

fn num_bins(&self) -> usize

The number of bins in this axis, including underflow and overflow.

fn bin(&self, index: usize) -> Option<<Self as Axis>::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.

fn indices(&self) -> Box<dyn Iterator<Item = usize>>

An iterator over bin numbers

fn iter(&self) -> Box<dyn Iterator<Item = (usize, Self::BinInterval)> + '_>

An iterator over bin numbers and bin intervals

fn bins(&self) -> Box<dyn Iterator<Item = Self::BinInterval> + '_>

An iterator over bin intervals.

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

fn clone(&self) -> UniformCyclic<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug> Debug for UniformCyclic<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for UniformCyclic<T>

fn default() -> UniformCyclic<T>

Returns the “default value” for a type.

impl<T> Display for UniformCyclic<T>

where T: PartialOrd + NumCast + NumOps + Copy + Display,

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

Formats the value using the given formatter.

impl<T: Hash> Hash for UniformCyclic<T>

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T> IntoIterator for &'a UniformCyclic<T>

where UniformCyclic<T>: Axis,

type Item = (usize, <UniformCyclic<T> as Axis>::BinInterval)

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = <&'a UniformCyclic<T> as IntoIterator>::Item> + 'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: Ord> Ord for UniformCyclic<T>

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for UniformCyclic<T>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for UniformCyclic<T>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T: Eq> Eq for UniformCyclic<T>

impl<T> StructuralPartialEq for UniformCyclic<T>