Struct Category

pub struct Category<T>
where
    T: Eq + Hash,
{ /* private fields */ }

An axis to represent a set of discrete values or categories with an overflow bin.

This axis also includes an overflow bin, to include “other” values not given when the axis was constructed. See CategoryNoFlow for a variant that includes no overflow bin.

Example

use ndhistogram::axis::{Axis, Category, SingleValueBinInterval};
let colors = Category::new(vec!["red", "blue", "pink", "yellow", "black"]);
assert_eq!(colors.index(&"red"), Some(0));
assert_eq!(colors.index(&"green"), Some(5));
assert_eq!(colors.bin(1), Some(SingleValueBinInterval::new("blue")));
assert_eq!(colors.bin(5), Some(SingleValueBinInterval::overflow()));

Implementations

impl<T: Value> Category<T>

pub fn new<I: IntoIterator<Item = T>>(values: I) -> Self

Factory method to create a category axis without an overflow bin.

Takes an iterator over a set of values that represent each category. All other values will be mapped to the overflow bin.

Trait Implementations

impl<T: Value> Axis for Category<T>

type Coordinate = T

The type representing a location on this axis.

type BinInterval = SingleValueBinInterval<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::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 for Category<T>

where T: Eq + Hash + Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for Category<T>

where T: Eq + Hash + Debug,

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

Formats the value using the given formatter.

impl<T> Default for Category<T>

where T: Eq + Hash + Default,

fn default() -> Category<T>

Returns the “default value” for a type.

impl<T: Display + Value> Display for Category<T>

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

Formats the value using the given formatter.

impl<'a, T: Value> IntoIterator for &'a Category<T>

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

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = <&'a Category<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> PartialEq for Category<T>

where T: Eq + Hash + PartialEq,

fn eq(&self, other: &Category<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> Eq for Category<T>

where T: Eq + Hash + Eq,

impl<T> StructuralPartialEq for Category<T>

where T: Eq + Hash,