Struct Sum

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

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 of the sum.

pub fn sum(&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>(&self) -> O

where T: Into<O>, O: Float,

Square root of the variance.

Trait Implementations

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

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

fn default() -> Sum<T>

Returns the “default value” for a type.

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

fn fill(&mut self)

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

impl<T, W> FillWith<W> for Sum<T>

where T: FillWith<W> + Copy, W: Copy,

fn fill_with(&mut self, weight: W)

Fill this value with some data. For a simple number type means adding the weight.

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

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

Feeds this value into the given Hasher.

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

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

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

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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

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

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

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<T: PartialOrd> PartialOrd for Sum<T>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

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

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

impl<T> StructuralPartialEq for Sum<T>