Struct AverageEffectQuery 

#[non_exhaustive]
pub struct AverageEffectQuery {
    pub treatment: VariableId,
    pub outcome: VariableId,
    pub effect_modifiers: Arc<[VariableId]>,
    pub control: Intervention,
    pub active: Intervention,
    pub target_population: TargetPopulation,
}

Average treatment effect (ATE / ATT-style) query.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

treatment: VariableId

Treatment variable.

outcome: VariableId

Outcome variable.

effect_modifiers: Arc<[VariableId]>

Optional effect modifiers .

control: Intervention

Control intervention level (typically treatment = 0).

active: Intervention

Active intervention level (typically treatment = 1).

target_population: TargetPopulation

Target population.

Implementations

impl AverageEffectQuery

pub fn new( treatment: VariableId, outcome: VariableId, effect_modifiers: impl Into<Arc<[VariableId]>>, control: Intervention, active: Intervention, target_population: TargetPopulation, ) -> Self

Full constructor (required outside this crate because the type is #[non_exhaustive]).

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

ATE for binary treatment coded as 0/1 on treatment.

Examples

use antecedent_core::{AverageEffectQuery, VariableId};

let q = AverageEffectQuery::binary_ate(VariableId::from_raw(0), VariableId::from_raw(1));
assert_eq!(q.treatment, VariableId::from_raw(0));

pub fn with_levels( treatment: VariableId, outcome: VariableId, control_level: f64, active_level: f64, ) -> Self

ATE with explicit control/active float levels.

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

Attach effect modifiers (IDs already resolved).

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

Set target population.

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

Validate that interventions target the treatment variable.

Errors

Returns QueryError when interventions are inconsistent.

Trait Implementations

impl Clone for AverageEffectQuery

fn clone(&self) -> AverageEffectQuery

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AverageEffectQuery

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

Formats the value using the given formatter.

impl Eq for AverageEffectQuery

impl From<AverageEffectQuery> for CausalQuery

fn from(query: AverageEffectQuery) -> Self

Converts to this type from the input type.

impl Hash for AverageEffectQuery

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for AverageEffectQuery

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AverageEffectQuery