basic_stats 1.0.0

Lightweight library with basic statistical estimators and hypothesis tests.
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

#![cfg(feature = "binomial")]

mod nocover;

use basic_stats::{
    binomial::*,
    core::{AltHyp, Ci},
};
use nocover::nocover;

#[test]
fn test_bernoulli_p_hat() {
    // Returns an error if `n == 0` or `n < n_s`.
    assert!(bernoulli_p_hat(0, 0).is_err());
    assert!(bernoulli_p_hat(1, 2).is_err());
    if nocover() {
        assert!(bernoulli_p_hat(1, 0).unwrap().is_finite());
    }
}

#[test]
fn test_binomial_z() {
    // Returns an error in any of these conditions:
    // - `n == 0`.
    // - `p0` not in interval `(0, 1)`.
    assert!(binomial_z(0, 0, 0.5).is_err());
    assert!(binomial_z(1, 0, 0.).is_err());
    assert!(binomial_z(1, 0, 1.).is_err());
    if nocover() {
        assert!(binomial_z(1, 0, 0.5).unwrap().is_finite());
    }
}

#[test]
fn test_binomial_z_p() {
    // Returns an error in any of these conditions:
    // - `n == 0`.
    // - `p0` not in interval `(0, 1)`.
    assert!(binomial_z_p(0, 0, 0.5, AltHyp::Ne).is_err());
    assert!(binomial_z_p(1, 0, 0., AltHyp::Ne).is_err());
    assert!(binomial_z_p(1, 0, 1., AltHyp::Ne).is_err());
    if nocover() {
        assert!(binomial_z_p(1, 0, 0.5, AltHyp::Ne).unwrap().is_finite());
    }
}

#[test]
fn test_one_proportion_z_test() {
    // Returns an error in any of these conditions:
    // - `n == 0`.
    // - `p0` not in interval `(0, 1)`.
    // - `alpha` not in interval `(0, 1)`.
    assert!(one_proportion_z_test(0, 0, 0.5, AltHyp::Ne, 0.5).is_err());
    assert!(one_proportion_z_test(1, 0, 0., AltHyp::Ne, 0.5).is_err());
    assert!(one_proportion_z_test(1, 0, 1., AltHyp::Ne, 0.5).is_err());
    assert!(one_proportion_z_test(1, 0, 0.5, AltHyp::Ne, 0.).is_err());
    assert!(one_proportion_z_test(1, 0, 0.5, AltHyp::Ne, 1.).is_err());
    if nocover() {
        assert!(one_proportion_z_test(1, 0, 0.5, AltHyp::Ne, 0.5).is_ok());
    }
}

#[test]
fn test_binomial_ws_alt_hyp_ci() {
    // binomial_ws_alt_hyp_ci(n, n_s, alt_hyp, alpha) covered by binomial_ws_alt_hyp_ci
}

#[test]
fn test_binomial_ws_ci() {
    // Returns an error in any of these conditions:
    // - `n == 0`.
    // - `alpha` not in interval `(0, 1)`.

    assert!(binomial_ws_ci(0, 0, 0.5).is_err());
    assert!(binomial_ws_ci(0, 1, 0.5).is_err());
    assert!(binomial_ws_ci(2, 1, 0.).is_err());
    assert!(binomial_ws_ci(2, 1, 1.).is_err());
    assert!(binomial_ws_ci(2, 1, f64::NAN).is_err());
    assert!(binomial_ws_ci(2, 1, f64::INFINITY).is_err());

    if nocover() {
        let Ci(lo, hi) = binomial_ws_ci(1, 1, 0.5).unwrap();
        assert!(lo.is_finite());
        assert!(hi.is_finite());
    }
}

#[test]
fn test_binomial_cp_alt_hyp_ci() {
    // binomial_cp_alt_hyp_ci(n, n_s, alt_hyp, alpha) covered by binomial_cp_ci.
}

#[test]
fn test_binomial_cp_ci() {
    // Returns an error in any of these conditions:
    // - `n == 0` or `n < n_s`.
    // - `alpha` is not in interval `(0, 1)`.

    assert!(binomial_cp_ci(0, 0, 0.5).is_err());
    assert!(binomial_cp_ci(2, 3, 0.5).is_err());
    assert!(binomial_cp_ci(2, 1, 0.).is_err());
    assert!(binomial_cp_ci(2, 1, 1.).is_err());
}

#[test]
fn test_exact_binomial_p() {
    // Returns an error in any of these conditions:
    // - `n == 0` or `n < n_s`.
    // - `p0` is not in interval `[0, 1]`.

    assert!(exact_binomial_p(0, 0, 0.5, AltHyp::Ne).is_err());
    assert!(exact_binomial_p(2, 3, 0.5, AltHyp::Ne).is_err());
    assert!(exact_binomial_p(2, 1, -1., AltHyp::Ne).is_err());
    assert!(exact_binomial_p(2, 1, 2., AltHyp::Ne).is_err());

    if nocover() {
        assert!(exact_binomial_p(1, 0, 0., AltHyp::Ne).unwrap().is_finite());
        assert!(exact_binomial_p(1, 0, 1., AltHyp::Ne).unwrap().is_finite());
        assert!(exact_binomial_p(1, 1, 0., AltHyp::Ne).unwrap().is_finite());
        assert!(exact_binomial_p(1, 1, 1., AltHyp::Ne).unwrap().is_finite());
    }
}

#[test]
fn test_exact_binomial_test() {
    // Returns an error in any of these conditions:
    // - `n == 0` or `n < n_s`.
    // - `p0` is not in interval `[0, 1]`.
    // - `alpha` is not in interval `(0, 1)`.

    assert!(exact_binomial_test(0, 0, 0.5, AltHyp::Ne, 0.5).is_err());
    assert!(exact_binomial_test(2, 3, 0.5, AltHyp::Ne, 0.5).is_err());
    assert!(exact_binomial_test(2, 1, -1., AltHyp::Ne, 0.5).is_err());
    assert!(exact_binomial_test(2, 1, 2., AltHyp::Ne, 0.5).is_err());
    assert!(exact_binomial_test(2, 1, 0.5, AltHyp::Ne, 0.).is_err());
    assert!(exact_binomial_test(2, 1, 0.5, AltHyp::Ne, 1.).is_err());

    if nocover() {
        assert!(exact_binomial_test(1, 0, 0., AltHyp::Ne, 0.5).is_ok());
        assert!(exact_binomial_test(1, 0, 1., AltHyp::Ne, 0.5).is_ok());

        assert!(exact_binomial_test(1, 1, 0., AltHyp::Ne, 0.5).is_ok());
        assert!(exact_binomial_test(1, 1, 1., AltHyp::Ne, 0.5).is_ok());
    }
}