Struct ndhistogram::axis::Category

pub struct Category<T> where
    T: Value,  { /* fields omitted */ }

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. 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

pub 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.

pub fn numbins(&self) -> usize

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

pub 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::numbins is given.

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

An iterator over bin numbers

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

An iterator over bin numbers and bin intervals

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

An iterator over bin intervals.

impl<T: Clone> Clone for Category<T> where
    T: Value, 

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Category<T> where
    T: Value, 

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

Formats the value using the given formatter.

impl<T: Default> Default for Category<T> where
    T: Value, 

pub fn default() -> Category<T>

Returns the "default value" for a type.

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

pub 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 = Self::Item> + 'a>

Which kind of iterator are we turning this into?

pub fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<Category<T>> for Category<T> where
    T: Value, 

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

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Category<T>) -> bool

This method tests for !=.

impl<T> StructuralPartialEq for Category<T> where
    T: Value,