Struct ndhistogram::value::Sum

pub struct Sum<T = f64> { /* fields omitted */ }

ndhistogram bin value type for filling unweighted values. Analogous to [WeightedSum]. Methods returning variance and standard deviation assume Poisson statistics.

Implementations

impl<T: Copy> Sum<T>

pub fn new() -> Self where
    Self: Default, 

Factory method to create an unfilled (or zero valued) Sum.

pub fn get(&self) -> T

Get the current value.

pub fn variance(&self) -> T

Estimate of the variance of value assuming Poisson statistics.

pub fn standard_deviation<O: Float>(&self) -> O where
    T: Into<O>,
    O: Float, 

Square root of the variance.

Trait Implementations

impl<T: Clone> Clone for Sum<T>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Sum<T>

impl<T: Debug> Debug for Sum<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for Sum<T>

pub fn default() -> Sum<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for Sum<T>

impl<T: Copy + Fill> Fill for Sum<T>

pub fn fill(&mut self)

Fill this value with unit weight. For a simple number type this means simply increment by one.

impl<T: Hash> Hash for Sum<T>

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<T: Ord> Ord for Sum<T>

pub fn cmp(&self, other: &Sum<T>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq<Sum<T>> for Sum<T>

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<Sum<T>> for Sum<T>

pub fn partial_cmp(&self, other: &Sum<T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Sum<T>) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Sum<T>) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Sum<T>) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Sum<T>) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T> StructuralEq for Sum<T>

impl<T> StructuralPartialEq for Sum<T>