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
111
112
113

mod categorical;
pub use categorical::*;

use crate::{
    models::graphs::DiGraph,
    types::{Map, Result},
};

/// A trait for continuous time Bayesian networks (CTBNs).
pub trait CTBN {
    /// The type of the CIM.
    type CIM;
    /// The type of the initial distribution.
    type InitialDistribution;
    /// The type of the observed event.
    type Event;
    /// The type of the observed trajectory.
    type Trajectory;
    /// The type of a collection of trajectories.
    type Trajectories;

    /// Constructs a new CTBN.
    ///
    /// # Arguments
    ///
    /// * `graph` - The underlying graph.
    /// * `cims` - The conditional intensity matrices.
    ///
    /// # Notes
    ///
    /// The distribution of the initial state (i.e. initial distribution) is uniform.
    /// See `with_initial_distribution` to specify the initial distribution.
    ///
    /// # Errors
    ///
    /// * If the number of CIMs does not match the number of vertices in the graph.
    /// * If the labels of the CIMs do not match the labels of the graph.
    /// * If the conditioning labels of the CIMs do not match the parents of the vertices in the graph.
    ///
    /// # Returns
    ///
    /// A new CTBN instance.
    ///
    fn new<I>(graph: DiGraph, cims: I) -> Result<Self>
    where
        I: IntoIterator<Item = Self::CIM>,
        Self: Sized;

    /// Returns the initial distribution.
    ///
    /// # Returns
    ///
    /// A reference to the initial distribution.
    ///
    fn initial_distribution(&self) -> &Self::InitialDistribution;

    /// Returns the underlying graph.
    ///
    /// # Returns
    ///
    /// A reference to the graph.
    ///
    fn graph(&self) -> &DiGraph;

    /// Returns a map labels-distributions.
    ///
    /// # Returns
    ///
    /// A reference to the CIMs.
    ///
    fn cims(&self) -> &Map<String, Self::CIM>;

    /// Returns the parameters size.
    ///
    /// # Returns
    ///
    /// The parameters size.
    ///
    fn parameters_size(&self) -> usize;

    /// Creates a new categorical continuous-time Bayesian network with optional fields.
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the model.
    /// * `description` - The description of the model.
    /// * `initial_distribution` - The initial distribution of the model.
    /// * `graph` - The underlying graph.
    /// * `cims` - The conditional intensity matrices.
    ///
    /// # Errors
    ///
    /// * If `name` is an empty string.
    /// * If `description` is an empty string.
    /// * If the number of CIMs does not match the number of vertices in the graph.
    /// * If the labels of the CIMs do not match the labels of the graph.
    /// * If the conditioning labels of the CIMs do not match the parents of the vertices in the graph.
    ///
    /// # Returns
    ///
    /// A new categorical continuous-time Bayesian network instance.
    ///
    fn with_optionals<I>(
        name: Option<String>,
        description: Option<String>,
        initial_distribution: Self::InitialDistribution,
        graph: DiGraph,
        cims: I,
    ) -> Result<Self>
    where
        I: IntoIterator<Item = Self::CIM>,
        Self: Sized;
}