Struct ndhistogram::value::WeightedSum

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

ndhistogram bin value type that calculates a weight sum. It also provides methods to keep track of the sum of weights squared. This is used to provide estimates of the statistical error on the weighted sum. This performs a similar function to Sumw2 that ROOT users may be familiar with.

Implementations

impl<T: Copy> WeightedSum<T>

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

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

pub fn get(&self) -> T

Get the current value of the weighted sum.

pub fn variance(&self) -> T

Estimate of the variance of the weighted sum value is the sum of the weights squared.

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 WeightedSum<T>

pub fn clone(&self) -> WeightedSum<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 WeightedSum<T>

impl<T: Debug> Debug for WeightedSum<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for WeightedSum<T>

pub fn default() -> WeightedSum<T>

Returns the "default value" for a type.

impl<T: Eq> Eq for WeightedSum<T>

impl<T: Copy + Fill> Fill for WeightedSum<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, W> FillWith<W> for WeightedSum<T> where
    T: FillWith<W> + Copy,
    W: Mul<Output = W> + Copy, 

pub 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 WeightedSum<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 WeightedSum<T>

pub fn cmp(&self, other: &WeightedSum<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<WeightedSum<T>> for WeightedSum<T>

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

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

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

This method tests for !=.

impl<T: PartialOrd> PartialOrd<WeightedSum<T>> for WeightedSum<T>

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

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

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

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

pub fn le(&self, other: &WeightedSum<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: &WeightedSum<T>) -> bool

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

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

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

impl<T> StructuralEq for WeightedSum<T>

impl<T> StructuralPartialEq for WeightedSum<T>