Struct ndarray_stats::histogram::Histogram

pub struct Histogram<A: Ord> { /* fields omitted */ }

Histogram data structure.

Methods

impl<A: Ord> Histogram<A>

pub fn new(grid: Grid<A>) -> Self

Returns a new instance of Histogram given a Grid.

pub fn add_observation<S>(
    &mut self,
    observation: &ArrayBase<S, Ix1>
) -> Result<(), BinNotFound> where
    S: Data<Elem = A>, 

Adds a single observation to the histogram.

Panics if dimensions do not match: self.ndim() != observation.len().

Example:

use ndarray::array;
use ndarray_stats::histogram::{Edges, Bins, Histogram, Grid};
use noisy_float::types::n64;

let edges = Edges::from(vec![n64(-1.), n64(0.), n64(1.)]);
let bins = Bins::new(edges);
let square_grid = Grid::from(vec![bins.clone(), bins.clone()]);
let mut histogram = Histogram::new(square_grid);

let observation = array![n64(0.5), n64(0.6)];

histogram.add_observation(&observation)?;

let histogram_matrix = histogram.counts();
let expected = array![
    [0, 0],
    [0, 1],
];
assert_eq!(histogram_matrix, expected.into_dyn());

pub fn ndim(&self) -> usize

Returns the number of dimensions of the space the histogram is covering.

pub fn counts(&self) -> ArrayViewD<usize>

Borrows a view on the histogram counts matrix.

pub fn grid(&self) -> &Grid<A>

Borrows an immutable reference to the histogram grid.