Struct IdentifiedEstimand 

#[non_exhaustive]
pub struct IdentifiedEstimand {
    pub method: Arc<str>,
    pub adjustment_set: Arc<[VariableId]>,
    pub instruments: Arc<[VariableId]>,
    pub mediators: Arc<[VariableId]>,
    pub functional: ExprId,
    pub rd_design: Option<RdDesignParams>,
}

One identified estimand.

Backdoor estimands use Self::adjustment_set; IV estimands populate Self::instruments; front-door estimands populate Self::mediators. Sharp RD estimands populate Self::rd_design. Unused role slices are empty.

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.

method: Arc<str>

Method tag (wire string; parse with Self::method_kind).

adjustment_set: Arc<[VariableId]>

Adjustment set (dense variable ids). Empty when not an adjustment estimand.

instruments: Arc<[VariableId]>

Instrument variables (dense ids). Empty unless IV.

mediators: Arc<[VariableId]>

Mediator variables for front-door / two-stage. Empty unless front-door.

functional: ExprId

Functional expression id in arena.

rd_design: Option<RdDesignParams>

Sharp RD design parameters (when method is rd.sharp).

Implementations

impl IdentifiedEstimand

pub fn new( method: impl Into<Arc<str>>, adjustment_set: Arc<[VariableId]>, instruments: Arc<[VariableId]>, mediators: Arc<[VariableId]>, functional: ExprId, rd_design: Option<RdDesignParams>, ) -> Self

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

pub fn method_kind(&self) -> Result<EstimandMethod, String>

Parse the method tag into a typed EstimandMethod.

Errors

Unknown method string.

pub fn backdoor( method: impl Into<Arc<str>>, adjustment_set: Arc<[VariableId]>, functional: ExprId, ) -> Self

Backdoor-style estimand with an adjustment set and empty IV/mediator roles.

pub fn instrumental( method: impl Into<Arc<str>>, instruments: Arc<[VariableId]>, functional: ExprId, ) -> Self

IV estimand with instruments and empty adjustment/mediators.

pub fn frontdoor( method: impl Into<Arc<str>>, mediators: Arc<[VariableId]>, functional: ExprId, ) -> Self

Front-door estimand with mediators and empty adjustment/instruments.

pub fn rd_sharp(functional: ExprId, design: RdDesignParams) -> Self

Sharp regression-discontinuity estimand (not backdoor-shaped).

pub fn temporal_mediation( method: impl Into<Arc<str>>, mediators: Arc<[VariableId]>, functional: ExprId, ) -> Self

Temporal mediation estimand (mediators + temporal_mediation.* method tag).

Trait Implementations

impl Clone for IdentifiedEstimand

fn clone(&self) -> IdentifiedEstimand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IdentifiedEstimand

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

Formats the value using the given formatter.