reCTBN 0.1.0

A Continuous Time Bayesian Networks Library written in Rust
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

//! Defines methods for dealing with Probabilistic Graphical Models like the CTBNs

pub mod ctbn;
pub mod ctmp;

use std::collections::BTreeSet;

use thiserror::Error;

use crate::params;

/// Error types for trait Network
#[derive(Error, Debug)]
pub enum NetworkError {
    #[error("Error during node insertion")]
    NodeInsertionError(String),
}

/// This type is used to represent a specific realization of a generic NetworkProcess
pub type NetworkProcessState = Vec<params::StateType>;

/// It defines the required methods for a structure used as a Probabilistic Graphical Models (such
/// as a CTBN).
pub trait NetworkProcess: Sync {
    fn initialize_adj_matrix(&mut self);

    /// Add a **node** to the network
    ///
    ///  # Arguments
    ///
    ///  * `n` - instantiation of the `enum params::Params` describing a node
    ///
    ///  # Return
    ///
    ///  * A `Result` containing the `node_idx` automatically assigned if everything is fine,
    ///    or a `NetworkError` if something went wrong.
    fn add_node(&mut self, n: params::Params) -> Result<usize, NetworkError>;

    /// Add a **directed edge** between a two nodes of the network.
    ///
    /// # Arguments
    ///
    /// * `parent` - parent node.
    /// * `child` - child node.
    fn add_edge(&mut self, parent: usize, child: usize);

    /// Get all the indices of the nodes contained inside the network.
    fn get_node_indices(&self) -> std::ops::Range<usize>;

    /// Get the numbers of nodes contained in the network.
    fn get_number_of_nodes(&self) -> usize;

    /// Get the **node param**.
    ///
    /// # Arguments
    ///
    /// * `node_idx` - node index value.
    ///
    /// # Return
    ///
    /// * The selected **node param**.
    fn get_node(&self, node_idx: usize) -> &params::Params;

    /// Get the **node param**.
    ///
    /// # Arguments
    ///
    /// * `node_idx` - node index value.
    ///
    /// # Return
    ///
    /// * The selected **node mutable param**.
    fn get_node_mut(&mut self, node_idx: usize) -> &mut params::Params;

    /// Compute the index that must be used to access the parameters of a `node`, given a specific
    /// configuration of the network.
    ///
    /// Usually, the only values really used in `current_state` are the ones in the parent set of
    /// the `node`.
    ///
    /// # Arguments
    ///
    /// * `node` - selected node.
    /// * `current_state` - current configuration of the network.
    ///
    /// # Return
    ///
    /// * Index of the `node` relative to the network.
    fn get_param_index_network(&self, node: usize, current_state: &NetworkProcessState) -> usize;

    /// Compute the index that must be used to access the parameters of a `node`, given a specific
    /// configuration of the network and a generic `parent_set`.
    ///
    /// Usually, the only values really used in `current_state` are the ones in the parent set of
    /// the `node`.
    ///
    /// # Arguments
    ///
    /// * `current_state` - current configuration of the network.
    /// * `parent_set` - parent set of the selected `node`.
    ///
    /// # Return
    ///
    /// * Index of the `node` relative to the network.
    fn get_param_index_from_custom_parent_set(
        &self,
        current_state: &Vec<params::StateType>,
        parent_set: &BTreeSet<usize>,
    ) -> usize;

    /// Get the **parent set** of a given **node**.
    ///
    /// # Arguments
    ///
    /// * `node` - node index value.
    ///
    /// # Return
    ///
    /// * The **parent set** of the selected node.
    fn get_parent_set(&self, node: usize) -> BTreeSet<usize>;

    /// Get the **children set** of a given **node**.
    ///
    /// # Arguments
    ///
    /// * `node` - node index value.
    ///
    /// # Return
    ///
    /// * The **children set** of the selected node.
    fn get_children_set(&self, node: usize) -> BTreeSet<usize>;
}