Skip to main content

CausalGraph

Struct CausalGraph 

Source
pub struct CausalGraph {
    pub n_nodes: usize,
    pub parents: Vec<Vec<usize>>,
    pub children: Vec<Vec<usize>>,
    pub names: Vec<String>,
}
Expand description

A directed acyclic graph (DAG) representing causal relationships between variables.

Nodes are identified by usize indices. Edges represent direct causal effects from parent to child. The graph must be acyclic for causal semantics to be valid.

Fields§

§n_nodes: usize

Number of nodes in the graph.

§parents: Vec<Vec<usize>>

Adjacency list: parents[v] gives all parent nodes of v.

§children: Vec<Vec<usize>>

Adjacency list: children[v] gives all children of v.

§names: Vec<String>

Optional variable names.

Implementations§

Source§

impl CausalGraph

Source

pub fn new(n: usize) -> Self

Create a new empty causal graph with n nodes.

§Arguments
  • n — number of nodes
Source

pub fn set_names(&mut self, names: &[&str])

Set variable names.

§Arguments
  • names — slice of names, length must equal n_nodes
Source

pub fn add_edge(&mut self, from: usize, to: usize)

Add a directed edge from from (parent/cause) to to (child/effect).

§Panics

Panics if adding this edge would create a cycle.

Source

pub fn creates_cycle(&self, from: usize, to: usize) -> bool

Check whether adding edge from→to would create a cycle.

Source

pub fn topological_sort(&self) -> Option<Vec<usize>>

Return nodes in topological order (Kahn’s algorithm).

Returns None if the graph has a cycle (should not happen if edges are added via add_edge).

Source

pub fn ancestors(&self, v: usize) -> HashSet<usize>

Return all ancestors of node v (nodes from which v is reachable).

Source

pub fn descendants(&self, v: usize) -> HashSet<usize>

Return all descendants of node v.

Source

pub fn d_separated(&self, x: &[usize], y: &[usize], z: &[usize]) -> bool

Test d-separation: are node sets x and y d-separated by conditioning set z?

Uses the Bayes Ball algorithm. Returns true if x ⊥ y | z.

Source

pub fn markov_blanket(&self, v: usize) -> HashSet<usize>

Return the Markov blanket of node v: parents, children, and co-parents.

Source

pub fn is_acyclic(&self) -> bool

Check if the graph is acyclic.

Trait Implementations§

Source§

impl Clone for CausalGraph

Source§

fn clone(&self) -> CausalGraph

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CausalGraph

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.