Struct CausalState 

pub struct CausalState<I, O, C>
where
    I: Default,
    O: Default + Debug,
    C: Clone,
{ /* private fields */ }

A CausalState represents a state in a causal state machine (CSM) that can be evaluated based on causal conditions.

In a CSM, states are paired with actions. When a state’s conditions are met (evaluated to true), the associated action is triggered.

Purpose

CausalState encapsulates a reference to a causaloid that defines when the state should be considered active, along with:

• An identifier for the state
• A version number for tracking changes
• Data that can be used for evaluation

Usage

CausalState is typically used in conjunction with CausalAction in a state-action pair within a causal state machine (CSM). The CSM evaluates states, and when conditions are met, fires the associated actions.

Implementations

impl<I, O, C> CausalState<I, O, C>

where I: Default + Clone + Debug + Send + Sync, O: CsmEvaluable + Default + Debug + Clone + Send + Sync, C: Clone + Send + Sync, Causaloid<I, O, (), C>: MonadicCausable<I, O>,

pub fn eval(&self) -> Result<PropagatingEffect<O>, CsmError>

Evaluates the state using its internal data.

This method uses the state’s causaloid to determine if the state’s conditions are met based on the internal data value.

Returns

• Ok(PropagatingEffect<O>) if evaluation succeeds
• Err(CausalStateError) if an error occurs during evaluation

pub fn eval_with_data( &self, data: &PropagatingEffect<I>, ) -> Result<PropagatingEffect<O>, CsmError>

Evaluates the state using provided external data.

This method uses the state’s causaloid to determine if the state’s conditions are met based on the provided data value, rather than the internal data.

Parameters

• data: The numerical value to use for evaluation

Returns

• Ok(PropagatingEffect<O>) if evaluation succeeds
• Err(CsmError) if an error occurs during evaluation

impl<I, O, C> CausalState<I, O, C>

where I: Default, O: Default + Debug, C: Clone,

pub fn id(&self) -> usize

pub fn version(&self) -> usize

pub fn data(&self) -> &PropagatingEffect<I>

pub fn causaloid(&self) -> &Causaloid<I, O, (), C>

pub fn context(&self) -> &C

pub fn uncertain_parameter(&self) -> &Option<UncertainParameter>

impl<I, O, C> CausalState<I, O, C>

where I: Default, O: Default + Debug, C: Clone,

pub fn new( id: usize, version: usize, data: PropagatingEffect<I>, causaloid: Causaloid<I, O, (), C>, uncertain_parameter: Option<UncertainParameter>, ) -> Self

Trait Implementations

impl<I, O, C> Clone for CausalState<I, O, C>

where I: Default + Clone, O: Default + Debug + Clone, C: Clone + Clone,

fn clone(&self) -> CausalState<I, O, C>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I, O, C> Debug for CausalState<I, O, C>

where I: Default + Debug, O: Default + Debug + Debug, C: Clone + Debug,

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

Formats the value using the given formatter.

impl<I, O, C> Display for CausalState<I, O, C>

where I: Debug + Default, O: Default + Debug, C: Clone,

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

Formats the value using the given formatter.