Skip to main content

MarkovChainMonteCarlo

Struct MarkovChainMonteCarlo 

Source
pub struct MarkovChainMonteCarlo {
    pub step_size: f64,
    pub n_warmup: usize,
}
Expand description

Markov Chain Monte Carlo samplers.

Implements Metropolis-Hastings (random-walk), Gibbs sampling helpers, and a simplified dual-averaging NUTS-like step-size adaptation.

Fields§

§step_size: f64

Step size (proposal std for MH).

§n_warmup: usize

Number of warm-up (burn-in) steps.

Implementations§

Source§

impl MarkovChainMonteCarlo

Source

pub fn new(step_size: f64, n_warmup: usize) -> Self

Creates a new MCMC sampler with the given step size and warm-up count.

Source

pub fn metropolis_hastings<F>( &self, log_target: F, init: f64, n_samples: usize, seed: u64, ) -> Vec<f64>
where F: Fn(f64) -> f64,

Runs a Metropolis-Hastings random-walk chain.

§Arguments
  • log_target - Closure returning log π(θ) (up to normalisation).
  • init - Initial parameter value.
  • n_samples - Number of post-warmup samples to return.
  • seed - RNG seed.
Source

pub fn metropolis_hastings_vec<F>( &self, log_target: F, init: Vec<f64>, n_samples: usize, seed: u64, ) -> Vec<Vec<f64>>
where F: Fn(&[f64]) -> f64,

Metropolis-Hastings for a vector-valued parameter.

Source

pub fn gibbs_bivariate_gaussian( mu1: f64, mu2: f64, sigma1: f64, sigma2: f64, rho: f64, n_samples: usize, seed: u64, ) -> Vec<[f64; 2]>

Gibbs sampler for a bivariate Gaussian with known full conditionals.

Samples from N([μ1, μ2], [[σ1², ρσ1σ2],[ρσ1σ2, σ2²]]).

Source

pub fn nuts_step<F>( &self, log_target: F, grad_log_target: impl Fn(f64) -> f64, init: f64, seed: u64, ) -> f64
where F: Fn(f64) -> f64,

Simplified NUTS (No-U-Turn Sampler) step using leapfrog integration.

Returns a single sample given gradient function grad_log_target.

Source

pub fn effective_sample_size(chain: &[f64]) -> f64

Returns the effective sample size (ESS) from a chain using autocorrelation.

Trait Implementations§

Source§

impl Clone for MarkovChainMonteCarlo

Source§

fn clone(&self) -> MarkovChainMonteCarlo

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MarkovChainMonteCarlo

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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.