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>
impl<Args: Clone, Data: Clone, Ret: Clone, F: GenFn<(i64, Args), Data, Ret>> ParticleSystem<Args, Data, Ret, F>
Sourcepub fn new(model: F, num_particles: usize, rng: ThreadRng) -> Self
pub fn new(model: F, num_particles: usize, rng: ThreadRng) -> Self
Construct a new particle filter under the model with num_particles particles.
Sourcepub fn init_step(&mut self, args: Args, constraints: Data)
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).
Sourcepub fn step(self, constraints: Data) -> Self
pub fn step(self, constraints: Data) -> Self
Extend the current filter from t to t+1 with new constraints.
Sourcepub fn effective_sample_size(&self) -> f64
pub fn effective_sample_size(&self) -> f64
Calculate the effective sample size (ESS) with the current paticle weights.
Sourcepub fn resample(&mut self) -> f64
pub fn resample(&mut self) -> f64
Perform multinomial resampling based on the normalized particle weights, and return the log total weight.
Sourcepub fn log_marginal_likelihood_estimate(&self) -> f64
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>
impl<Args, Data, Ret, F> Unpin for ParticleSystem<Args, Data, Ret, F>
impl<Args, Data, Ret, F> UnsafeUnpin for ParticleSystem<Args, Data, Ret, F>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> Read<Exclusive, BecauseExclusive> for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
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
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
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.