Struct ndhistogram::VecHistogram

pub struct VecHistogram<A, V> { /* fields omitted */ }

A Histogram that stores its values in a Vec.

See ndhistogram for examples of its use.

Implementations

impl<A: Axes, V: Default + Clone> VecHistogram<A, V>

pub fn new(axes: A) -> VecHistogram<A, V>

Trait Implementations

impl<A: Clone, V: Clone> Clone for VecHistogram<A, V>

pub fn clone(&self) -> VecHistogram<A, V>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug, V: Debug> Debug for VecHistogram<A, V>

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

Formats the value using the given formatter.

impl<A: Axes, V> Display for VecHistogram<A, V>

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

Formats the value using the given formatter.

impl<A: Axes, V> Histogram<A, V> for VecHistogram<A, V>

pub fn value(&self, coordinate: &A::Coordinate) -> Option<&V>

Read a bin value given a coordinate. Returns an Option as the given coordinate may not be mapeed to a bin.

pub fn axes(&self) -> &A

The histogram Axes that map coordinates to bin numbers.

pub fn value_at_index(&self, index: usize) -> Option<&V>

Read a bin value given an index. Return an Option as the given index may not be valid for this histogram.

pub fn values<'a>(&'a self) -> Box<dyn Iterator<Item = &'a V> + 'a>

Iterator over bin values.

pub fn iter<'a>(
    &'a self
) -> Box<dyn Iterator<Item = Item<A::BinInterval, &'a V>> + 'a>

Iterator over bin indices, bin interval and bin values.

pub fn value_at_index_mut(&mut self, index: usize) -> Option<&mut V>

Mutable access to a bin value at a given index.

pub fn values_mut(&mut self) -> Box<dyn Iterator<Item = &'_ mut V> + '_>

Mutable iterator over bin values.

pub fn iter_mut(
    &mut self
) -> Box<dyn Iterator<Item = Item<<A as Axis>::BinInterval, &'_ mut V>> + '_>

Mutable iterator bin indices, bin interval and bin values.

pub fn value_mut(&mut self, coordinate: &A::Coordinate) -> Option<&mut V>

Mutable access to a bin value at a given coordinate.

pub fn fill(&mut self, coordinate: &A::Coordinate) where
    V: Fill, 

Fill the histogram bin value at coordinate with unit weight. If the Axes do no cover that coordinate, do nothing. See Fill.

pub fn fill_weight<W>(&mut self, coordinate: &A::Coordinate, weight: W) where
    V: FillWeight<W>, 

Fill the histogram bin value at coordinate with a weight. If the Axes do no cover that coordinate, do nothing. See FillWeight.

impl<'a, A: Axes, V> IntoIterator for &'a VecHistogram<A, V>

type Item = Item<A::BinInterval, &'a V>

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = Item<<A as Axis>::BinInterval, &'a V>> + 'a>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl<'a, A: Axes, V: 'a> IntoIterator for &'a mut VecHistogram<A, V>

type Item = Item<A::BinInterval, &'a mut V>

The type of the elements being iterated over.

type IntoIter = Box<dyn Iterator<Item = Item<<A as Axis>::BinInterval, &'a mut V>> + 'a>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.