causal-hub 0.0.6

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

mod missing;
pub use missing::*;

mod table;
pub use table::*;

mod trajectory;
use std::borrow::Cow;

pub use trajectory::*;

use crate::{
    models::HasLabels,
    types::{Result, Set},
};

/// A trait for dataset.
pub trait Dataset: HasLabels {
    /// The type of the values.
    type Values;
    /// The type of the support metadata (variable ranges / state sets).
    type Support: Clone;
    /// The type of the evidence,
    type Evidence;
    /// The type of the evidence iterator.
    type EvidenceIter<'a>: Iterator<Item = Result<Self::Evidence>>
    where
        Self: 'a;

    /// Returns the support metadata of the dataset.
    ///
    /// # Returns
    ///
    /// A reference to the support metadata.
    ///
    fn support(&self) -> Cow<'_, Self::Support>;

    /// The values of the dataset.
    ///
    /// # Returns
    ///
    /// A reference to the values.
    ///
    fn values(&self) -> &Self::Values;

    /// An iterator over the evidence in the dataset.
    ///
    /// # Returns
    ///
    /// An iterator over the evidence in the dataset.
    ///
    fn evidence_iter(&self) -> Self::EvidenceIter<'_>;

    /// The sample size.
    ///
    /// # Notes
    ///
    /// If the dataset is weighted, this should return the sum of the weights.
    ///
    /// # Returns
    ///
    /// The number of samples in the dataset.
    ///
    fn sample_size(&self) -> f64;

    /// Restrict the dataset to the specified variables.
    ///
    /// # Arguments
    ///
    /// * `x` - Set of variables to select.
    ///
    /// # Errors
    ///
    /// * If the set of variables is empty.
    /// * If any variable in the set is out of bounds.
    ///
    /// # Returns
    ///
    /// A dataset restricted to the specified variables.
    ///
    fn select(&self, x: &Set<usize>) -> Result<Self>
    where
        Self: Sized;
}