Struct GraphicalSeparation

Source
pub struct GraphicalSeparation<'a, G, D>
where G: BaseGraph<Direction = D>,
{ /* private fields */ }
Expand description

Graphical independence struct

Implementations§

Source§

impl<'a, G, D> GraphicalSeparation<'a, G, D>
where G: BaseGraph<Direction = D>,

Source

pub const fn new(g: &'a G) -> Self

Build a new graphical independence struct.

§Panics

If $\mathbf{X}$, $\mathbf{Y}$ and $\mathbf{Z}$ are not disjoint subsets of $\mathbf{V}$.

§Examples
use causal_hub::prelude::*;

// Build a new directed graph.
let g = DiGraph::new(
    ["A", "B", "C", "D", "E", "F"],
    [
        ("A", "C"),
        ("B", "C"),
        ("C", "D"),
        ("C", "E"),
    ]
);

// Build d-separation query struct.
let q = GSeparation::from(&g);

// Assert A _||_ B | { } .
assert!(q.are_independent([0], [1], []));
// Assert A _||_ B | { C } .
assert!(!q.are_independent([0], [1], [2]));
// Assert A _||_ D | { } .
assert!(!q.are_independent([0], [3], []));
// Assert A _||_ D | { C } .
assert!(q.are_independent([0], [3], [2]));
// Assert { A, B } _||_ { D, E } | { C } .
assert!(q.are_independent([0, 1], [3, 4], [2]));

Trait Implementations§

Source§

impl<'a, G, D: Clone> Clone for GraphicalSeparation<'a, G, D>
where G: BaseGraph<Direction = D> + Clone,

Source§

fn clone(&self) -> GraphicalSeparation<'a, G, D>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<'a, G, D: Debug> Debug for GraphicalSeparation<'a, G, D>
where G: BaseGraph<Direction = D> + Debug,

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'a, G, D> From<&'a G> for GraphicalSeparation<'a, G, D>
where G: BaseGraph<Direction = D>,

Source§

fn from(g: &'a G) -> Self

Converts to this type from the input type.
Source§

impl<'a, G> GeneralizedIndependence for GraphicalSeparation<'a, G, Directed>
where G: DirectedGraph<Direction = Directed> + MoralGraph,

Source§

fn are_independent<I, J, K>(&self, x: I, y: J, z: K) -> bool
where I: IntoIterator<Item = usize>, J: IntoIterator<Item = usize>, K: IntoIterator<Item = usize>,

Checks whether $\mathbf{X} \mathrlap{\thinspace\perp}{\perp}_{\mathcal{G}} \mathbf{Y} \mid \mathbf{Z}$ holds or not.

Source§

impl<'a, G> GeneralizedIndependence for GraphicalSeparation<'a, G, Undirected>
where G: UndirectedGraph<Direction = Undirected>,

Source§

fn are_independent<I, J, K>(&self, x: I, y: J, z: K) -> bool
where I: IntoIterator<Item = usize>, J: IntoIterator<Item = usize>, K: IntoIterator<Item = usize>,

Checks whether $\mathbf{X} \mathrlap{\thinspace\perp}{\perp}_{\mathcal{G}} \mathbf{Y} \mid \mathbf{Z}$ holds or not.

Source§

impl<'a, G> Independence for GraphicalSeparation<'a, G, Directed>
where G: DirectedGraph<Direction = Directed> + MoralGraph,

Source§

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

Checks whether $\mathbf{X} \mathrlap{\thinspace\perp}{\perp} \mathbf{Y} \mid \mathbf{Z}$ holds or not.
Source§

impl<'a, G> Independence for GraphicalSeparation<'a, G, Undirected>
where G: UndirectedGraph<Direction = Undirected>,

Source§

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

Checks whether $\mathbf{X} \mathrlap{\thinspace\perp}{\perp} \mathbf{Y} \mid \mathbf{Z}$ holds or not.

Auto Trait Implementations§

§

impl<'a, G, D> Freeze for GraphicalSeparation<'a, G, D>

§

impl<'a, G, D> RefUnwindSafe for GraphicalSeparation<'a, G, D>
where G: RefUnwindSafe,

§

impl<'a, G, D> Send for GraphicalSeparation<'a, G, D>

§

impl<'a, G, D> Sync for GraphicalSeparation<'a, G, D>

§

impl<'a, G, D> Unpin for GraphicalSeparation<'a, G, D>

§

impl<'a, G, D> UnwindSafe for GraphicalSeparation<'a, G, D>
where G: RefUnwindSafe,

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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<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§

unsafe 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V