causal-hub 0.0.5

A library for causal models, inference and discovery.
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

mod table;
mod trajectory;

use crate::{
    datasets::{MissingMechanism, MissingMethod},
    models::Labelled,
    types::{Error, Labels, Result},
};

/// A struct representing a Bayesian estimator.
#[derive(Clone, Debug)]
pub struct BE<'a, D, T> {
    dataset: &'a D,
    missing_method: Option<MissingMethod>,
    missing_mechanism: Option<MissingMechanism>,
    prior: T,
}

impl<'a, D> BE<'a, D, ()> {
    /// Creates a new Bayesian estimator.
    ///
    /// # Arguments
    ///
    /// * `dataset` - A reference to the dataset to fit the estimator to.
    ///
    /// # Returns
    ///
    /// A new Bayesian estimator.
    ///
    #[inline]
    pub const fn new(dataset: &'a D) -> Self {
        Self {
            dataset,
            missing_method: None,
            missing_mechanism: None,
            prior: (),
        }
    }
}

impl<'a, D, T> BE<'a, D, T> {
    /// Sets the missing handling method.
    ///
    /// # Arguments
    ///
    /// * `missing_method` - An optional missing handling method to set.
    /// * `missing_mechanism` - An optional missing mechanism to set.
    ///
    /// # Returns
    ///
    /// A new estimator with the specified missing handling method.
    ///
    #[inline]
    pub fn with_missing_method(
        mut self,
        missing_method: Option<MissingMethod>,
        missing_mechanism: Option<MissingMechanism>,
    ) -> Result<Self> {
        // Validate missing method and mechanism.
        match (missing_method, &missing_mechanism) {
            (Some(MissingMethod::LW) | Some(MissingMethod::PW), Some(_)) => {
                return Err(Error::InvalidParameter(
                    "missing_mechanism",
                    "must be None if missing_method is LW or PW",
                ));
            }
            (Some(MissingMethod::IPW) | Some(MissingMethod::AIPW), None) => {
                return Err(Error::InvalidParameter(
                    "missing_mechanism",
                    "must be provided if missing_method is IPW or AIPW",
                ));
            }
            _ => {}
        }

        self.missing_method = missing_method;
        self.missing_mechanism = missing_mechanism;
        Ok(self)
    }

    /// Sets the prior distribution.
    ///
    /// # Arguments
    ///
    /// * `prior` - The prior distribution to set.
    ///
    /// # Returns
    ///
    /// A new Bayesian estimator with the specified prior.
    ///
    #[inline]
    pub fn with_prior<U>(self, prior: U) -> BE<'a, D, U> {
        BE {
            dataset: self.dataset,
            missing_method: self.missing_method,
            missing_mechanism: self.missing_mechanism,
            prior,
        }
    }
}

impl<D, T> Labelled for BE<'_, D, T>
where
    D: Labelled,
{
    #[inline]
    fn labels(&self) -> &Labels {
        self.dataset.labels()
    }
}