Struct CausalGraph 

pub struct CausalGraph {
    pub var_names: Vec<String>,
    pub sep_sets: Vec<Vec<Option<Vec<usize>>>>,
    /* private fields */
}

Mixed graph for causal discovery algorithms.

Each edge (i, j) is stored as a pair (mark_at_i, mark_at_j), where mark_at_i is the mark at node i (endpoint facing node i) and mark_at_j is the mark at node j.

• Directed edge i → j: (Tail, Arrow) stored at entry (i, j).
• Undirected edge i — j: (Tail, Tail).
• Bidirected edge i ↔ j: (Arrow, Arrow).
• Circle endpoint i o→ j: (Circle, Arrow).

Fields

var_names: Vec<String>

Variable names.

sep_sets: Vec<Vec<Option<Vec<usize>>>>

Separation sets: sep[i][j] is the set that d-separates i and j.

Implementations

impl CausalGraph

pub fn new(var_names: &[&str]) -> Self

Create a new graph with the given variable names, initially fully connected.

pub fn num_vars(&self) -> usize

Number of variables (nodes).

pub fn set_edge( &mut self, i: usize, j: usize, mark_at_i: EdgeMark, mark_at_j: EdgeMark, )

Set or update an edge between i and j.

mark_at_i is the endpoint mark at node i; mark_at_j is the mark at j. Setting an edge is symmetric: edges[i][j] and edges[j][i] are both updated.

pub fn remove_edge(&mut self, i: usize, j: usize)

Remove an edge between i and j.

pub fn is_adjacent(&self, i: usize, j: usize) -> bool

Whether there is any edge between i and j.

pub fn get_mark_at(&self, from: usize, to: usize) -> Option<EdgeMark>

Get the mark at node to on the edge from from to to.

Returns None if the edge doesn’t exist. The returned mark is the one facing node to (i.e., the arrowhead/tail at to).

pub fn get_mark_from(&self, from: usize, to: usize) -> Option<EdgeMark>

Get the mark at node from on the edge between from and to.

Returns None if the edge doesn’t exist.

pub fn is_directed(&self, i: usize, j: usize) -> bool

Whether there is a directed edge i → j (tail at i, arrow at j).

pub fn is_undirected(&self, i: usize, j: usize) -> bool

Whether there is an undirected edge i — j (tail at both ends).

pub fn is_bidirected(&self, i: usize, j: usize) -> bool

Whether there is a bidirected edge i ↔ j (arrow at both ends).

pub fn neighbors(&self, i: usize) -> impl Iterator<Item = usize> + '_

Return an iterator over the neighbours of node i.

pub fn get_sep_set(&self, i: usize, j: usize) -> Option<&Vec<usize>>

Return the separation set for nodes i and j, if any.

pub fn set_sep_set(&mut self, i: usize, j: usize, sep: Vec<usize>)

Set the separation set for nodes i and j.

pub fn make_complete(&mut self)

Initialize the graph as a complete undirected graph (all edges i — j).

Trait Implementations

impl Clone for CausalGraph

fn clone(&self) -> CausalGraph

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CausalGraph

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.