r2rs-nmath 0.1.1

Statistics programming for Rust based on R's nmath package
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

// Translation of nmath's pwilcox
//
// Copyright (C) 2020 neek-sss
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <https://www.gnu.org/licenses/>.

use num_traits::Float;
use strafe_type::{FloatConstraint, LogProbability64, Natural64, Probability64, Real64};

use crate::{distribution::wilcox::cwilcox, func::choose, traits::DPQ};

/// The distribution function of the Wilcoxon distribution.
pub fn pwilcox<R: Into<Real64>, N1: Into<Natural64>, N2: Into<Natural64>>(
    q: R,
    m: N1,
    n: N2,
    lower_tail: bool,
) -> Probability64 {
    pwilcox_inner(q, m, n, lower_tail, false).into()
}

/// The distribution function of the Wilcoxon distribution.
pub fn log_pwilcox<R: Into<Real64>, N1: Into<Natural64>, N2: Into<Natural64>>(
    q: R,
    m: N1,
    n: N2,
    lower_tail: bool,
) -> LogProbability64 {
    pwilcox_inner(q, m, n, lower_tail, true).into()
}

pub fn pwilcox_inner<R: Into<Real64>, N1: Into<Natural64>, N2: Into<Natural64>>(
    q: R,
    m: N1,
    n: N2,
    mut lower_tail: bool,
    log: bool,
) -> f64 {
    let mut q = q.into().unwrap();
    let mut m = m.into().unwrap();
    let mut n = n.into().unwrap();

    let mut i = 0;
    let mut c = 0.0;
    let mut p = 0.0;

    if !m.is_finite() || !n.is_finite() {
        return f64::nan();
    }
    m = m.round();
    n = n.round();

    q = (q + 1e-7).floor();

    if q < 0.0 {
        return f64::dt_0(lower_tail, log);
    }
    if q >= m * n {
        return f64::dt_1(lower_tail, log);
    }

    let mm = m;
    let nn = n;
    c = choose(m + n, n).unwrap();
    p = 0.0;
    /* Use summation of probs over the shorter range */
    if q <= m * n / 2.0 {
        i = 0;
        while i <= q as i32 {
            p += cwilcox(i, mm as usize, nn as usize) / c;
            i += 1
        }
    } else {
        q = m * n - q;
        i = 0;
        while (i as f64) < q {
            p += cwilcox(i, mm as usize, nn as usize) / c;
            i += 1
        }
        lower_tail = !lower_tail
        /* p = 1 - p; */
    }

    p.dt_val(lower_tail, log)
}