Skip to main content

ProbabilisticProgramEngine

Struct ProbabilisticProgramEngine 

Source
pub struct ProbabilisticProgramEngine { /* private fields */ }
Expand description

The main engine struct — declared here so all modules share one definition.

Implementations§

Source§

impl ProbabilisticProgramEngine

Source

pub fn new(config: PpeEngineConfig) -> Self

Create a new engine with the given configuration.

Source

pub fn add_variable(&mut self, name: String, prior: PpePrior) -> VarId

Register a new variable with the given name and prior. Returns its stable VarId.

Source

pub fn observe(&mut self, var_id: VarId, value: f64)

Condition variable var_id on the observed value.

Source

pub fn clear_observation(&mut self, var_id: VarId)

Remove an observation, allowing the variable to be sampled freely.

Source

pub fn sample( &mut self, method: PpeSamplingMethod, ) -> Result<PpeSampleResult, String>

Run posterior sampling with the given method.

§Errors

Returns an error string if no variables have been registered.

Source

pub fn posterior_mean(&self, var_id: VarId) -> Option<f64>

Posterior mean of variable var_id from the last sampling run.

Source

pub fn posterior_std(&self, var_id: VarId) -> Option<f64>

Posterior standard deviation of variable var_id.

Source

pub fn credible_interval(&self, var_id: VarId, alpha: f64) -> Option<(f64, f64)>

Central credible interval at coverage 1 - alpha.

E.g., alpha = 0.05 returns the 95% CI as (lower, upper).

Source

pub fn log_likelihood(&self, var_id: VarId, value: f64) -> f64

Log-density (log prior) of value under the prior of var_id.

Source

pub fn marginal_distribution( &self, var_id: VarId, n_bins: usize, ) -> Vec<(f64, f64)>

Approximate marginal distribution as a histogram with n_bins equal-width bins.

Returns a Vec<(bin_centre, frequency)> in ascending order.

Source

pub fn sampling_stats(&self) -> PpeSamplingStats

Diagnostics about the current state of the engine.

Source

pub fn config(&self) -> &PpeEngineConfig

Return a reference to the engine configuration.

Source

pub fn get_variable(&self, var_id: VarId) -> Option<&ProbVar>

Look up a variable by its id.

Source

pub fn n_variables(&self) -> usize

Number of registered variables.

Source

pub fn n_samples(&self, var_id: VarId) -> usize

Number of retained samples for a given variable (0 if no sampling has been run).

Source

pub fn raw_samples(&self, var_id: VarId) -> Option<&[f64]>

Raw posterior samples for var_id.

Source

pub fn last_result(&self) -> Option<&PpeSampleResult>

Last PpeSampleResult returned by sample.

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

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more