bpci 0.1.0

Binomial proportion confidence intervals
Documentation 
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

use std::fmt::Debug;
use std::ops::Div;

use num_traits::{One, Zero};

use crate::{Error, NSuccessesSample, Result, Sample};

/// Represents a sample with its size and proportion.
pub struct ProportionSample<N, P> {
    pub(crate) size: N,
    pub(crate) proportion: P,
}

impl<N, P> ProportionSample<N, P>
where
    N: Debug + Zero + PartialOrd,
    P: Zero + One + Debug + PartialOrd,
{
    pub fn new(size: N, proportion: P) -> Result<Self> {
        if size < N::zero() {
            return Err(Error::OutOfRange(format!("size `{:?}` must be non-negative", size)));
        }
        if proportion < P::zero() || proportion > P::one() {
            return Err(Error::OutOfRange(format!("`{:?}` is out of range 0..=1", proportion)));
        }
        Ok(Self { size, proportion })
    }
}

impl<N: Copy, P: Copy> Sample<N, P> for ProportionSample<N, P> {
    fn size(&self) -> N {
        self.size
    }

    fn p_hat(&self) -> P {
        self.proportion
    }
}

impl<N, P> From<NSuccessesSample<N>> for ProportionSample<N, P>
where
    N: Copy + Into<P>,
    P: Div<Output = P>,
{
    fn from(other: NSuccessesSample<N>) -> Self {
        Self {
            size: other.size(),
            proportion: other.p_hat(),
        }
    }
}