Skip to main content

ParticleSystem

Struct ParticleSystem 

Source
pub struct ParticleSystem<Args: Clone, Data: Clone, Ret: Clone, F: GenFn<(i64, Args), Data, Ret>> {
    pub traces: Vec<Trace<(i64, Args), Data, Ret>>,
    /* private fields */
}
Expand description

Basic particle filter for generative functions with a time parameter as the first input argument.

Fields§

§traces: Vec<Trace<(i64, Args), Data, Ret>>

Persistent traces contained within the system

Implementations§

Source§

impl<Args: Clone, Data: Clone, Ret: Clone, F: GenFn<(i64, Args), Data, Ret>> ParticleSystem<Args, Data, Ret, F>

Source

pub fn new(model: F, num_particles: usize, rng: ThreadRng) -> Self

Construct a new particle filter under the model with num_particles particles.

Source

pub fn init_step(&mut self, args: Args, constraints: Data)

Initialize the particle filter by generating self.num_particles traces from the model with (1, args).

Source

pub fn step(self, constraints: Data) -> Self

Extend the current filter from t to t+1 with new constraints.

Source

pub fn effective_sample_size(&self) -> f64

Calculate the effective sample size (ESS) with the current paticle weights.

Source

pub fn resample(&mut self) -> f64

Perform multinomial resampling based on the normalized particle weights, and return the log total weight.

Source

pub fn log_marginal_likelihood_estimate(&self) -> f64

Return the current log marginal likelihood estimate from the particles.

Auto Trait Implementations§

§

impl<Args, Data, Ret, F> !RefUnwindSafe for ParticleSystem<Args, Data, Ret, F>

§

impl<Args, Data, Ret, F> !Send for ParticleSystem<Args, Data, Ret, F>

§

impl<Args, Data, Ret, F> !Sync for ParticleSystem<Args, Data, Ret, F>

§

impl<Args, Data, Ret, F> !UnwindSafe for ParticleSystem<Args, Data, Ret, F>

§

impl<Args, Data, Ret, F> Freeze for ParticleSystem<Args, Data, Ret, F>
where Box<F>: Freeze, Vec<Trace<(i64, Args), Data, Ret>>: Freeze,

§

impl<Args, Data, Ret, F> Unpin for ParticleSystem<Args, Data, Ret, F>
where Box<F>: Unpin, Vec<Trace<(i64, Args), Data, Ret>>: Unpin,

§

impl<Args, Data, Ret, F> UnsafeUnpin for ParticleSystem<Args, Data, Ret, F>
where Box<F>: UnsafeUnpin, Vec<Trace<(i64, Args), Data, Ret>>: UnsafeUnpin,

Blanket Implementations§

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

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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