deep_causality 0.13.5

Computational causality library. Provides causality graph, collections, context and causal reasoning.
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
 */

use crate::utils_test::test_utils;
use crate::{BaseCausaloid, CausableGraph, CausaloidGraph, IdentificationValue};

// Generates a fixed sized array with sample data
pub fn generate_sample_data<const N: usize>() -> [f64; N] {
    [0.99; N]
}

pub fn build_linear_graph(k: usize) -> CausaloidGraph<BaseCausaloid<f64, f64>> {
    let mut g = CausaloidGraph::<BaseCausaloid<f64, f64>>::new(0 as IdentificationValue);

    let root_causaloid = test_utils::get_test_causaloid_num_input_output(0);
    let root_index = g
        .add_root_causaloid(root_causaloid)
        .expect("Failed to add root causaloid");

    let mut previous_idx = root_index;

    for i in 1..k {
        let causaloid = test_utils::get_test_causaloid_num_input_output(i as IdentificationValue);
        let current_idx = g.add_causaloid(causaloid).expect("Failed to add causaloid");

        g.add_edge(previous_idx, current_idx)
            .expect("Failed to add edge");

        previous_idx = current_idx;
    }

    g.freeze();

    g
}

pub fn get_small_multi_cause_graph_and_data() -> (CausaloidGraph<BaseCausaloid<f64, f64>>, [f64; 4])
{
    let g = build_multi_cause_graph();
    (g, test_utils::generate_sample_data())
}

pub fn build_multi_cause_graph() -> CausaloidGraph<BaseCausaloid<f64, f64>> {
    // Builds a multi cause graph
    //  root(0)
    //  /  \
    //A(1) B(2)
    //  \ /
    //  C(3)

    let mut g = CausaloidGraph::<BaseCausaloid<f64, f64>>::new(0 as IdentificationValue);

    // Add root causaloid
    let root_causaloid = test_utils::get_test_causaloid_num_input_output(0);
    let root_index = g
        .add_root_causaloid(root_causaloid)
        .expect("Failed to add root causaloid");

    // Add causaloid A
    let causaloid = test_utils::get_test_causaloid_num_input_output(1);
    let idx_a = g.add_causaloid(causaloid).expect("Failed to add causaloid");

    // Link causaloid root to A causaloid
    g.add_edge(root_index, idx_a)
        .expect("Failed to add edge between root and A");

    // Add causaloid B
    let causaloid = test_utils::get_test_causaloid_num_input_output(2);
    let idx_b = g.add_causaloid(causaloid).expect("Failed to add causaloid");

    // Link causaloid B to root causaloid
    g.add_edge(root_index, idx_b)
        .expect("Failed to add edge between root and B");

    // Add causaloid C
    let causaloid = test_utils::get_test_causaloid_num_input_output(3);
    let idx_c = g.add_causaloid(causaloid).expect("Failed to add causaloid");

    // Link causaloid A to C
    g.add_edge(idx_a, idx_c)
        .expect("Failed to add edge between A and C");

    // Link causaloid B to C
    g.add_edge(idx_b, idx_c)
        .expect("Failed to add edge between C and B");

    // Now, we have a graph like this:
    //  root(0)
    //  /  \
    //A(1) B(2)
    //  \ /
    //  C(3)
    g.freeze();

    g
}

pub fn get_small_multi_layer_cause_graph_and_data()
-> (CausaloidGraph<BaseCausaloid<f64, f64>>, [f64; 8 + 1]) {
    // Builds a multi-layer cause graph:
    (build_multi_layer_cause_graph(), generate_sample_data())
}

pub fn build_multi_layer_cause_graph() -> CausaloidGraph<BaseCausaloid<f64, f64>> {
    // Builds a multi-layer cause graph:
    //    root
    //  /   |  \
    //  A   B   C
    // /\  /\  /\
    //D   E   F  G

    let mut g = CausaloidGraph::new(0);

    // Add root causaloid
    let root_causaloid = test_utils::get_test_causaloid_num_input_output(0);
    let root_index = g
        .add_root_causaloid(root_causaloid)
        .expect("Failed to add root causaloid");

    // ### First layer ### //

    // Add causaloid A
    let causaloid = test_utils::get_test_causaloid_num_input_output(1);
    let idx_a = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid A to root causaloid
    g.add_edge(root_index, idx_a)
        .expect("Failed to add edge between root and A");

    // Add causaloid B
    let causaloid = test_utils::get_test_causaloid_num_input_output(2);
    let idx_b = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid B to root causaloid
    g.add_edge(root_index, idx_b)
        .expect("Failed to add edge between root and B");

    // Add causaloid C
    let causaloid = test_utils::get_test_causaloid_num_input_output(3);
    let idx_c = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid C  to root causaloid
    g.add_edge(root_index, idx_c)
        .expect("Failed to add edge between root and C");

    // ### Second layer ### //

    // Add causaloid D
    let causaloid = test_utils::get_test_causaloid_num_input_output(4);
    let idx_d = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid D  to A
    g.add_edge(idx_a, idx_d)
        .expect("Failed to add edge between D and A");

    // Add causaloid E
    let causaloid = test_utils::get_test_causaloid_num_input_output(5);
    let idx_e = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid E  to A
    g.add_edge(idx_a, idx_e)
        .expect("Failed to add edge between A and E");
    // Link causaloid E  to B
    g.add_edge(idx_b, idx_e)
        .expect("Failed to add edge between B and E");

    // Add causaloid F
    let causaloid = test_utils::get_test_causaloid_num_input_output(6);
    let idx_f = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid F  to B
    g.add_edge(idx_b, idx_f)
        .expect("Failed to add edge between B and F");
    // Link causaloid F  to C
    g.add_edge(idx_c, idx_f)
        .expect("Failed to add edge between C and F");

    // Add causaloid G
    let causaloid = test_utils::get_test_causaloid_num_input_output(7);
    let idx_g = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid G  to C
    g.add_edge(idx_c, idx_g)
        .expect("Failed to add edge between A and C");

    g.freeze();

    g
}

pub fn get_left_imbalanced_cause_graph() -> (CausaloidGraph<BaseCausaloid<f64, f64>>, [f64; 6 + 1])
{
    // Builds a multi-layer cause graph:
    (build_left_imbalanced_cause_graph(), generate_sample_data())
}

pub fn build_left_imbalanced_cause_graph() -> CausaloidGraph<BaseCausaloid<f64, f64>> {
    // Builds a multi-layer cause graph:
    //    root
    //  /   |  \
    //  A   B   C
    // /\
    //D  E

    let mut g = CausaloidGraph::new(0);

    // Add root causaloid
    let root_causaloid = test_utils::get_test_causaloid_num_input_output(0);
    let root_index = g
        .add_root_causaloid(root_causaloid)
        .expect("Failed to add root causaloid");

    // ### First layer ### //

    // Add causaloid A
    let causaloid = test_utils::get_test_causaloid_num_input_output(1);
    let idx_a = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid A to root causaloid
    g.add_edge(root_index, idx_a)
        .expect("Failed to add edge between root and A");

    // Add causaloid B
    let causaloid = test_utils::get_test_causaloid_num_input_output(2);
    let idx_b = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid B to root causaloid
    g.add_edge(root_index, idx_b)
        .expect("Failed to add edge between root and B");

    // Add causaloid C
    let causaloid = test_utils::get_test_causaloid_num_input_output(3);
    let idx_c = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid C  to root causaloid
    g.add_edge(root_index, idx_c)
        .expect("Failed to add edge between root and C");

    // ### Second layer ### //

    // Add causaloid D
    let causaloid = test_utils::get_test_causaloid_num_input_output(4);
    let idx_d = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid D  to A
    g.add_edge(idx_a, idx_d)
        .expect("Failed to add edge between A and E");

    // Add causaloid E
    let causaloid = test_utils::get_test_causaloid_num_input_output(5);
    let idx_e = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid E  to A
    g.add_edge(idx_a, idx_e)
        .expect("Failed to add edge between A and B");

    g.freeze();

    g
}

pub fn get_right_imbalanced_cause_graph() -> (CausaloidGraph<BaseCausaloid<f64, f64>>, [f64; 6 + 1])
{
    // Builds a multi-layer cause graph:
    (build_right_imbalanced_cause_graph(), generate_sample_data())
}

pub fn build_right_imbalanced_cause_graph() -> CausaloidGraph<BaseCausaloid<f64, f64>> {
    // Builds a multi-layer cause graph:
    //    root
    //  /   |  \
    //  A   B   C
    //          /\
    //         D  E

    let mut g = CausaloidGraph::new(0);

    // Add root causaloid
    let root_causaloid = test_utils::get_test_causaloid_num_input_output(0);
    let root_index = g
        .add_root_causaloid(root_causaloid)
        .expect("Failed to add root causaloid");

    // ### First layer ### //

    // Add causaloid A
    let causaloid = test_utils::get_test_causaloid_num_input_output(1);
    let idx_a = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid A to root causaloid
    g.add_edge(root_index, idx_a)
        .expect("Failed to add edge between rootCause and A");

    // Add causaloid B
    let causaloid = test_utils::get_test_causaloid_num_input_output(2);
    let idx_b = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid B to root causaloid
    g.add_edge(root_index, idx_b)
        .expect("Failed to add edge between rootCause and B");

    // Add causaloid C
    let causaloid = test_utils::get_test_causaloid_num_input_output(3);
    let idx_c = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid C  to root causaloid
    g.add_edge(root_index, idx_c)
        .expect("Failed to add edge between root and C");

    // ### Second layer ### //

    // Add causaloid D
    let causaloid = test_utils::get_test_causaloid_num_input_output(4);
    let idx_d = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid D  to C
    g.add_edge(idx_c, idx_d)
        .expect("Failed to add edge between D to C");

    // Add causaloid E
    let causaloid = test_utils::get_test_causaloid_num_input_output(5);
    let idx_e = g.add_causaloid(causaloid).expect("Failed to add causaloid");
    // Link causaloid E  to C
    g.add_edge(idx_c, idx_e)
        .expect("Failed to add edge between c and e");

    g.freeze();

    g
}