cifly 0.1.2

cifly is the Rust core that powers the CIfly declarative framework for efficient causal inference algorithms.
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

use std::collections::HashMap;
use std::error::Error;
use std::{cmp, fmt};

use crate::ruletable::Ruletable;

/// Internal `Graph` representation.
///
/// # Usage
/// Can be constructed using [`Graph::new`] and then passed to `reach`.
pub struct Graph {
    n: usize,
    seps: Vec<usize>,
    vals: Vec<(usize, usize)>,
}

impl Graph {
    /// Constructs a new `Graph` from a map of edge types to edge lists.
    ///
    /// Each edge type (string) must be defined in the `Ruletable`.
    /// Each entry in `edge_lists` is a list of edges (u, v).
    ///
    /// Returns an error if any edge type is undefined in the rule table.
    pub fn new(
        edge_lists: &HashMap<String, Vec<(usize, usize)>>,
        ruletable: &Ruletable,
    ) -> Result<Graph, ParseGraphError> {
        let mut n = 0;
        for edges in edge_lists.values() {
            for &(u, v) in edges.iter() {
                n = cmp::max(n, cmp::max(u, v));
            }
        }
        n += 1;

        let mut degree = vec![0_usize; n];
        for edges in edge_lists.values() {
            for &(u, v) in edges.iter() {
                degree[u] += 1;
                degree[v] += 1;
            }
        }

        let mut seps = vec![0_usize; n + 1];
        for i in 0..n {
            seps[i + 1] = seps[i] + degree[i];
        }

        let mut vals = vec![(0_usize, 0_usize); seps[n]];
        let mut cursor = seps[..n].to_vec();

        for (edge_string, edges) in edge_lists.iter() {
            let (edge_num, edge_rev_num) = ruletable
                .get_edge_ids(edge_string)
                .ok_or(ParseGraphError(format!(
                    "edge {edge_string} was not specified in rule table"
                )))
                .unwrap();

            for &(u, v) in edges.iter() {
                let pos_u = cursor[u];
                vals[pos_u] = (v, edge_num);
                cursor[u] += 1;

                let pos_v = cursor[v];
                vals[pos_v] = (u, edge_rev_num);
                cursor[v] += 1;
            }
        }
        Ok(Graph { n, seps, vals })
    }

    pub(crate) fn num_vertices(&self) -> usize {
        self.n
    }

    pub(crate) fn neighbors(&self, u: usize) -> &[(usize, usize)] {
        let start = self.seps[u];
        let end = self.seps[u + 1];
        &self.vals[start..end]
    }
}

/// Error type for reporting invalid graph definitions.
#[derive(Debug)]
pub struct ParseGraphError(String);

impl fmt::Display for ParseGraphError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Error when parsing graph: {}", self.0)
    }
}

impl Error for ParseGraphError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}

/// Internal `Sets` representation.
///
/// # Usage
/// Can be constructed using [`Sets::new`] and then passed to `reach`.
pub struct Sets(Vec<Vec<bool>>);

impl Sets {
    /// Constructs a new `Sets` from a map of set labels to element lists.
    ///
    /// Each set label must be defined in the `Ruletable`.
    /// Duplicates within a set cause an error.
    pub fn new(
        sets: &HashMap<String, Vec<usize>>,
        ruletable: &Ruletable,
    ) -> Result<Sets, ParseSetsError> {
        let mut z = vec![Vec::new(); ruletable.num_sets()];
        for (set_string, set) in sets.iter() {
            let n = *set.iter().max().unwrap_or(&0) + 1;
            let set_num = ruletable
                .get_set_id(set_string)
                .ok_or(ParseSetsError(format!(
                    "set {set_string} was not specified in rule table"
                )))?;
            z[set_num] = vec![false; n];
            for &x in set.iter() {
                if z[set_num][x] {
                    return Err(ParseSetsError(format!(
                        "found duplicate entry {x} in set {set_string}"
                    )));
                }
                z[set_num][x] = true;
            }
        }
        Ok(Sets(z))
    }

    pub(crate) fn contains(&self, set_id: usize, element: usize) -> bool {
        if element >= self.0[set_id].len() {
            return false;
        }
        self.0[set_id][element]
    }

    pub(crate) fn elements(&self, set_id: usize) -> impl Iterator<Item = usize> + '_ {
        self.0[set_id]
            .iter()
            .enumerate()
            .filter(|(_, &val)| val)
            .map(|(i, _)| i)
    }

    pub(crate) fn max_size(&self) -> usize {
        self.0.iter().map(|s| s.len()).max().unwrap_or(0)
    }
}

/// Error type for reporting invalid set definitions.
#[derive(Debug)]
pub struct ParseSetsError(String);

impl fmt::Display for ParseSetsError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "Error when parsing sets: {}", self.0)
    }
}

impl Error for ParseSetsError {
    fn source(&self) -> Option<&(dyn Error + 'static)> {
        None
    }
}