ndhistogram/value/
weightedsum.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
use std::ops::Mul;

use num_traits::Float;

use crate::{Fill, FillWith};

/// 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](https://root.cern.ch/doc/master/classTH1.html) users may be familiar
/// with.
#[derive(Copy, Default, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct WeightedSum<T = f64> {
    sumw: T,
    sumw2: T,
}

impl<T: Copy> WeightedSum<T> {
    /// Factory method to create an unfilled (or zero-valued) WeightedSum.
    pub fn new() -> Self
    where
        Self: Default,
    {
        Self::default()
    }

    /// Get the current value of the weighted sum.
    pub fn get(&self) -> T {
        self.sum()
    }

    /// Get the current value of the weighted sum.
    pub fn sum(&self) -> T {
        self.sumw
    }

    /// Estimate of the variance of the weighted sum value is the sum of the
    /// weights squared.
    pub fn variance(&self) -> T {
        self.sumw2
    }

    /// Square root of the variance.
    pub fn standard_deviation<O>(&self) -> O
    where
        T: Into<O>,
        O: Float,
    {
        self.variance().into().sqrt()
    }
}

impl<T: Copy + Fill> Fill for WeightedSum<T> {
    #[inline]
    fn fill(&mut self) {
        self.sumw.fill();
        self.sumw2.fill();
    }
}

impl<T, W> FillWith<W> for WeightedSum<T>
where
    T: FillWith<W> + Copy,
    W: Mul<Output = W> + Copy,
{
    #[inline]
    fn fill_with(&mut self, weight: W) {
        self.sumw.fill_with(weight);
        self.sumw2.fill_with(weight * weight);
    }
}