ironcalc_base 0.7.1

Open source spreadsheet engine
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

use statrs::distribution::{Discrete, DiscreteCDF, Poisson};

use crate::expressions::types::CellReferenceIndex;
use crate::{
    calc_result::CalcResult, expressions::parser::Node, expressions::token::Error, model::Model,
};

impl<'a> Model<'a> {
    // =POISSON.DIST(x, mean, cumulative)
    pub(crate) fn fn_poisson_dist(
        &mut self,
        args: &[Node],
        cell: CellReferenceIndex,
    ) -> CalcResult {
        if args.len() != 3 {
            return CalcResult::new_args_number_error(cell);
        }

        // x
        let x = match self.get_number_no_bools(&args[0], cell) {
            Ok(f) => f.trunc(),
            Err(e) => return e,
        };

        // mean (lambda)
        let lambda = match self.get_number_no_bools(&args[1], cell) {
            Ok(f) => f,
            Err(e) => return e,
        };

        let cumulative = match self.get_boolean(&args[2], cell) {
            Ok(b) => b,
            Err(e) => return e,
        };

        if x < 0.0 || lambda < 0.0 {
            return CalcResult::Error {
                error: Error::NUM,
                origin: cell,
                message: "Invalid parameters for POISSON.DIST".to_string(),
            };
        }

        // Guard against insane k for u64
        if x < 0.0 || x > (u64::MAX as f64) {
            return CalcResult::Error {
                error: Error::NUM,
                origin: cell,
                message: "Invalid parameters for POISSON.DIST".to_string(),
            };
        }

        let k = x as u64;

        // Special-case lambda = 0: degenerate distribution at 0
        if lambda == 0.0 {
            let result = if cumulative {
                // For x >= 0, P(X <= x) = 1
                1.0
            } else {
                // P(X = 0) = 1, P(X = k>0) = 0
                if k == 0 {
                    1.0
                } else {
                    0.0
                }
            };
            return CalcResult::Number(result);
        }

        let dist = match Poisson::new(lambda) {
            Ok(d) => d,
            Err(_) => {
                return CalcResult::Error {
                    error: Error::NUM,
                    origin: cell,
                    message: "Invalid parameters for POISSON.DIST".to_string(),
                }
            }
        };

        let prob = if cumulative { dist.cdf(k) } else { dist.pmf(k) };

        if !prob.is_finite() {
            return CalcResult::Error {
                error: Error::NUM,
                origin: cell,
                message: "Invalid result for POISSON.DIST".to_string(),
            };
        }

        CalcResult::Number(prob)
    }
}