Skip to main content

PathSpecificEffectQuery

Struct PathSpecificEffectQuery 

Source
pub struct PathSpecificEffectQuery {
    pub treatment: VariableId,
    pub outcome: VariableId,
    pub path_nodes: Arc<[VariableId]>,
    pub control: Intervention,
    pub active: Intervention,
    pub target_population: TargetPopulation,
    pub max_paths: usize,
    pub max_len: usize,
}
Expand description

Path-specific effect / contribution query.

Prefer this over overloading MediationQuery. Path contribution attribution is available via GCM path_decompose; path-restricted natural effects identify/estimate via the ID family (path_specific.natural) and functional.effect plug-in estimation.

Fields§

§treatment: VariableId

Treatment / source variable.

§outcome: VariableId

Outcome variable.

§path_nodes: Arc<[VariableId]>

Intermediate nodes constraining the path set (empty = all directed paths).

§control: Intervention

Control intervention level.

§active: Intervention

Active intervention level.

§target_population: TargetPopulation

Target population.

§max_paths: usize

Maximum number of paths to enumerate.

§max_len: usize

Maximum path length (edges).

Implementations§

Source§

impl PathSpecificEffectQuery

Source

pub fn binary(treatment: VariableId, outcome: VariableId) -> Self

Binary 0/1 treatment contrast with all directed paths and default limits.

Source

pub fn with_path_nodes(self, nodes: impl Into<Arc<[VariableId]>>) -> Self

Restrict to paths that visit these intermediate nodes (in any order).

Source

pub const fn with_max_paths(self, max_paths: usize) -> Self

Cap path enumeration.

Source

pub const fn with_max_len(self, max_len: usize) -> Self

Cap path length.

Source

pub fn with_target_population(self, population: TargetPopulation) -> Self

Set target population.

Source

pub fn validate(&self) -> Result<(), QueryError>

Validate ids, interventions, and limits.

§Errors

Treatment equals outcome, zero limits, path-node overlaps, or bad interventions.

Trait Implementations§

Source§

impl Clone for PathSpecificEffectQuery

Source§

fn clone(&self) -> PathSpecificEffectQuery

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 PathSpecificEffectQuery

Source§

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

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

impl From<PathSpecificEffectQuery> for CausalQuery

Source§

fn from(query: PathSpecificEffectQuery) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for PathSpecificEffectQuery

Source§

fn eq(&self, other: &PathSpecificEffectQuery) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for PathSpecificEffectQuery

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> 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.