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

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

use num_traits::Zero;

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

/// Represents a sample as size and number of successes.
pub struct NSuccessesSample<N> {
    size: N,
    pub(crate) n_successes: N,
}

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

impl<N, P> Sample<N, P> for NSuccessesSample<N>
where
    N: Copy + Into<P>,
    P: Div<Output = P>,
{
    fn size(&self) -> N {
        self.size
    }

    fn p_hat(&self) -> P {
        self.n_successes.into() / self.size.into()
    }
}