Struct Histogram

pub struct Histogram { /* private fields */ }

Image histogram

Implementations

impl Histogram

pub fn new(nbins: usize) -> Histogram

Create a new histogram with the given number of bins

pub fn join(h: impl AsRef<[Histogram]>) -> Histogram

Join data from multiple histograms

pub fn add_value<T: Type>(&mut self, value: T)

Add a value to the histogram

pub fn incr_bin(&mut self, index: usize)

Increment a bin without adding a value

pub fn bin(&self, index: usize) -> usize

Get value of a specific bin

pub fn bins(&self) -> impl '_ + Iterator<Item = (usize, usize)>

Returns an iterator over all bins

pub fn len(&self) -> usize

Get the number of bins

pub fn is_empty(&self) -> bool

Returns true when there are zero bins

pub fn min_index(&self) -> usize

Get the bin index of the minimum value. There may be other bins with the same value, which would not be reported by this function

pub fn max_index(&self) -> usize

Get the bin index of the maximum value. There may be other bins with the same value, which would not be reported by this function

pub fn count(&self, v: usize) -> usize

Count the number of bins with the given value

pub fn distribution(&self) -> Vec<f64>

Get distribution of values

pub fn sum(&self) -> usize

Get sum of all values

Trait Implementations

impl AsRef<[usize]> for Histogram

fn as_ref(&self) -> &[usize]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Histogram

fn clone(&self) -> Histogram

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Histogram

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Histogram

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Index<usize> for Histogram

type Output = usize

The returned type after indexing.

fn index(&self, i: usize) -> &usize

Performs the indexing (container[index]) operation.

impl IndexMut<usize> for Histogram

fn index_mut(&mut self, i: usize) -> &mut usize

Performs the mutable indexing (container[index]) operation.

impl PartialEq for Histogram

fn eq(&self, other: &Histogram) -> bool

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

const 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 Serialize for Histogram

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Histogram

impl StructuralPartialEq for Histogram