Struct VmpMessage 

pub struct VmpMessage {
    pub natural_params: Vec<f64>,
    pub from: String,
    pub to: String,
    pub direction: MessageDirection,
}

A VMP message.

The natural_params vector has the dimensionality of the receiving variable’s exponential family in the factor→variable direction and the dimensionality of the sender’s sufficient statistics in the opposite direction. The engine is responsible for maintaining this invariant.

Fields

natural_params: Vec<f64>

Natural-parameter vector η (or its analogue for variable→factor messages, which carry expected sufficient statistics).

from: String

Sender identifier (factor id or variable name).

to: String

Receiver identifier.

direction: MessageDirection

Direction (factor→variable or variable→factor).

Implementations

impl VmpMessage

pub fn zeros( from: String, to: String, direction: MessageDirection, dim: usize, ) -> Self

Zero-message in the given direction and dimensionality.

pub fn dim(&self) -> usize

Dimensionality of the message.

pub fn product(a: &Self, b: &Self) -> Result<Self>

Sum two messages element-wise, producing a third (natural parameters add under the product-of-densities rule).

Requires identical direction / endpoints / dimensionality — otherwise returns a dimension-mismatch error.

pub fn accumulate(&mut self, rhs: &Self) -> Result<()>

Add rhs into self in place, producing the natural-parameter sum.

pub fn linf_residual(a: &Self, b: &Self) -> Result<f64>

L∞ residual between two messages of identical shape. Useful for convergence monitoring in the engine.

Trait Implementations

impl Clone for VmpMessage

fn clone(&self) -> VmpMessage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VmpMessage

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

Formats the value using the given formatter.