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

mod parser;
pub use parser::BifParser;

use crate::types::Result;

/// A trait for reading and writing BIF files.
pub trait BifIO: Sized {
    /// Create an instance of the type from a BIF string.
    ///
    /// # Arguments
    ///
    /// * `bif` - A string slice that holds the BIF data.
    ///
    /// # Returns
    ///
    /// A new instance of the type.
    ///
    fn from_bif_string(bif: &str) -> Result<Self>;

    /// Convert the instance to a BIF string.
    ///
    /// # Returns
    ///
    /// A string that holds the BIF data.
    ///
    fn to_bif_string(&self) -> Result<String>;

    /// Read a BIF file and create an instance of the type.
    ///
    /// # Arguments
    ///
    /// * `path` - A string slice that holds the path to the BIF file.
    ///
    /// # Returns
    ///
    /// A new instance of the type.
    ///
    fn from_bif_file(path: &str) -> Result<Self>;

    /// Write the instance to a BIF file.
    ///
    /// # Arguments
    ///
    /// * `path` - A string slice that holds the path to the BIF file.
    ///
    fn to_bif_file(&self, path: &str) -> Result<()>;
}