Skip to main content

InterventionOverlay

Struct InterventionOverlay 

Source
pub struct InterventionOverlay {
    pub hard_set: Vec<Option<f64>>,
    pub shifts: Vec<f64>,
    pub stochastic: Vec<Option<StochasticPolicy>>,
    pub soft: Vec<Option<MechanismOverride>>,
    pub active: Vec<bool>,
}
Expand description

Compact overlay describing how sampling differs from the observational plan.

The underlying CompiledCausalModel is never cloned; overlays are applied during ancestral sampling.

Fields§

§hard_set: Vec<Option<f64>>

Per-node hard sets (dense index → value), None = not hard-set.

§shifts: Vec<f64>

Per-node additive shifts.

§stochastic: Vec<Option<StochasticPolicy>>

Per-node stochastic policies.

§soft: Vec<Option<MechanismOverride>>

Per-node soft mechanism overrides.

§active: Vec<bool>

Optional temporal activation mask per node (true = active at current step).

Implementations§

Source§

impl InterventionOverlay

Source

pub fn observational(n_nodes: usize) -> Self

Empty overlay (observational) for n_nodes.

Source

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

Reject a node carrying both a hard set and an additive shift.

A hard set replaces a node’s assignment outright, so an additive shift on the same node has nothing well-defined to add to: the mechanism it would shift is exactly the one the set discarded. Rather than pick a winner silently, both overlay construction and the overlay-accepting samplers refuse the pair and make the caller say which they meant.

Called for you by Self::from_interventions and Self::from_sequence_at; call it yourself if you populate the public fields directly.

§Errors

ModelError::Unsupported naming the first offending dense node index.

Source

pub fn is_empty(&self) -> bool

Whether any node is intervened.

Source

pub fn from_interventions( model: &CompiledCausalModel, interventions: &[Intervention], ) -> Result<Self, ModelError>

Compile interventions against a model (simultaneous / single-step).

§Errors

Unknown variables, invalid interventions, or a node both set and shifted (see Self::validate).

Source

pub fn from_sequence_at( model: &CompiledCausalModel, seq: &InterventionSequence, t: i32, ) -> Result<Self, ModelError>

Overlay for a temporal sequence at discrete step t.

§Errors

Invalid sequence, unknown variables, or a node both set and shifted at t (see Self::validate).

Trait Implementations§

Source§

impl Clone for InterventionOverlay

Source§

fn clone(&self) -> InterventionOverlay

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 InterventionOverlay

Source§

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

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

impl Default for InterventionOverlay

Source§

fn default() -> InterventionOverlay

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

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

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> ForeignBufferOwner for T
where T: Send + Sync + Debug + 'static,

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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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