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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162

// SPDX-License-Identifier: MIT
// Copyright (c) "2023" . The DeepCausality Authors. All Rights Reserved.
use std::collections::HashMap;
use std::ops::*;

use crate::errors::CausalityError;
use crate::prelude::{
    Causable, CausableGraphExplaining, CausableGraphReasoning, CausableReasoning, Causaloid,
    Datable, IdentificationValue, NumericalValue, SpaceTemporal, Spatial, Temporable,
};
use crate::types::reasoning_types::causaloid::causal_type::CausalType;

impl<'l, D, S, T, ST, V> Causable for Causaloid<'l, D, S, T, ST, V>
where
    D: Datable + Clone,
    S: Spatial<V> + Clone,
    T: Temporable<V> + Clone,
    ST: SpaceTemporal<V> + Clone,
    V: Default + Add<V, Output = V> + Sub<V, Output = V> + Mul<V, Output = V> + Clone,
{
    fn explain(&self) -> Result<String, CausalityError> {
        return if self.active.get() {
            match self.causal_type {
                CausalType::Singleton => {
                    let reason = format!(
                        "Causaloid: {} {} on last data {} evaluated to {}",
                        self.id,
                        self.description,
                        self.last_obs.get(),
                        self.is_active()
                    );
                    Ok(reason)
                }

                CausalType::Collection => Ok(self.causal_coll.as_ref().unwrap().explain()),

                CausalType::Graph => {
                    match self.causal_graph.as_ref().unwrap().explain_all_causes() {
                        Ok(str) => Ok(str),
                        Err(e) => Err(CausalityError(e.to_string())),
                    }
                }
            }
        } else {
            // Return an error message that the causaloid is not active
            let reason = format!(
                "Causaloid: {} has not been evaluated. Call verify() to activate it",
                self.id
            );

            Err(CausalityError(reason))
        };
    }

    fn is_active(&self) -> bool {
        self.active.get()
    }

    fn is_singleton(&self) -> bool {
        match self.causal_type {
            CausalType::Singleton => true,
            CausalType::Collection => false,
            CausalType::Graph => false,
        }
    }

    fn verify_single_cause(&self, obs: &NumericalValue) -> Result<bool, CausalityError> {
        if self.has_context {
            let contextual_causal_fn = self
                .context_causal_fn
                .expect("Causaloid::verify_single_cause: context_causal_fn is None");
            let context = self
                .context
                .expect("Causaloid::verify_single_cause: context is None");

            let res = match (contextual_causal_fn)(obs.to_owned(), context) {
                Ok(res) => {
                    // store the applied data to provide details in explain()
                    self.last_obs.set(obs.to_owned());
                    res
                }
                Err(e) => return Err(e),
            };

            Ok(self.check_active(res))
        } else {
            let causal_fn = self
                .causal_fn
                .expect("Causaloid::verify_single_cause: causal_fn is None");
            let res = match (causal_fn)(obs.to_owned()) {
                Ok(res) => {
                    // store the applied data to provide details in explain()
                    self.last_obs.set(obs.to_owned());
                    res
                }
                Err(e) => return Err(e),
            };

            Ok(self.check_active(res))
        }
    }

    fn verify_all_causes(
        &self,
        data: &[NumericalValue],
        data_index: Option<&HashMap<IdentificationValue, IdentificationValue>>,
    ) -> Result<bool, CausalityError> {
        match self.causal_type {
            CausalType::Singleton => Err(CausalityError(
                "Causaloid is singleton. Call verify_singleton instead.".into(),
            )),

            CausalType::Collection => match &self.causal_coll {
                None => Err(CausalityError(
                    "Causaloid::verify_all_causes: causal collection is None".into(),
                )),
                Some(coll) => {
                    let res = match coll.reason_all_causes(data) {
                        Ok(res) => res,
                        Err(e) => return Err(e),
                    };

                    Ok(self.check_active(res))
                }
            },

            CausalType::Graph => match &self.causal_graph {
                None => Err(CausalityError(
                    "Causaloid::verify_all_causes: Causal graph is None".into(),
                )),
                Some(graph) => {
                    let res = match graph.reason_all_causes(data, data_index) {
                        Ok(res) => res,
                        Err(e) => return Err(CausalityError(e.to_string())),
                    };

                    Ok(self.check_active(res))
                }
            },
        }
    }
}

impl<'l, D, S, T, ST, V> Causaloid<'l, D, S, T, ST, V>
where
    D: Datable + Clone,
    S: Spatial<V> + Clone,
    T: Temporable<V> + Clone,
    ST: SpaceTemporal<V> + Clone,
    V: Default + Add<V, Output = V> + Sub<V, Output = V> + Mul<V, Output = V> + Clone,
{
    #[inline(always)]
    fn check_active(&self, res: bool) -> bool {
        if res {
            self.active.set(true);
            true
        } else {
            self.active.set(false);
            false
        }
    }
}