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
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128

use std::cmp::Ordering;
use std::ops::{Add, Div, Mul, Sub};

use num_traits::One;

use crate::{CenteredInterval, Interval};

/// Interval represented by its lower and upper bounds.
#[must_use]
#[derive(Clone)]
pub struct BoundedInterval<T> {
    pub(crate) lower: T,
    pub(crate) upper: T,
}

impl<T> Interval<T> for BoundedInterval<T>
where
    T: Copy + One + Add<Output = T> + Sub<Output = T> + Div<Output = T> + PartialOrd,
{
    #[inline]
    fn mean(&self) -> T {
        (self.lower + self.upper) / (T::one() + T::one())
    }

    #[inline]
    fn margin(&self) -> T {
        (self.upper - self.lower) / (T::one() + T::one())
    }

    #[inline]
    fn lower(&self) -> T {
        self.lower
    }

    #[inline]
    fn upper(&self) -> T {
        self.upper
    }

    #[inline]
    fn bounds(&self) -> (T, T) {
        (self.lower, self.upper)
    }

    #[inline]
    fn contains(&self, point: T) -> bool {
        point >= self.lower && point <= self.upper
    }
}

impl<T> From<CenteredInterval<T>> for BoundedInterval<T>
where
    T: Copy + Add<Output = T> + Sub<Output = T> + PartialOrd,
{
    fn from(interval: CenteredInterval<T>) -> Self {
        Self {
            lower: interval.lower(),
            upper: interval.upper(),
        }
    }
}

impl<T> Add<T> for BoundedInterval<T>
where
    T: Copy + Add<Output = T>,
{
    type Output = Self;

    fn add(self, rhs: T) -> Self::Output {
        Self {
            lower: self.lower + rhs,
            upper: self.upper + rhs,
        }
    }
}

impl<T> Mul<T> for BoundedInterval<T>
where
    T: Copy + Mul<Output = T>,
{
    type Output = Self;

    fn mul(self, rhs: T) -> Self::Output {
        Self {
            lower: self.lower * rhs,
            upper: self.upper * rhs,
        }
    }
}

impl<T> PartialEq<Self> for BoundedInterval<T> {
    #[must_use]
    fn eq(&self, _other: &Self) -> bool {
        false
    }
}

impl<T: PartialOrd<T>> PartialOrd<Self> for BoundedInterval<T> {
    #[must_use]
    fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
        if self.upper < other.lower {
            Some(Ordering::Less)
        } else if self.lower > other.upper {
            Some(Ordering::Greater)
        } else {
            None
        }
    }
}

impl<T> PartialEq<T> for BoundedInterval<T> {
    fn eq(&self, _other: &T) -> bool {
        false
    }
}

impl<T: PartialOrd<T>> PartialOrd<T> for BoundedInterval<T> {
    #[must_use]
    fn partial_cmp(&self, other: &T) -> Option<Ordering> {
        if &self.upper < other {
            Some(Ordering::Less)
        } else if &self.lower > other {
            Some(Ordering::Greater)
        } else {
            None
        }
    }
}