legume-numeric 0.8.11

Numeric and ML foundation for the legume ecosystem (matrix, Leiden, candle, MCMC)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

use rand::rngs::SmallRng;

/// Trait for any MCMC model that can be run by the engine.
///
/// Separates model-specific logic (state, sweep, summarization) from
/// the generic MCMC loop (warmup, thinning, sample collection).
pub trait McmcModel {
    /// Full sampler state, mutated each sweep.
    type State;
    /// One collected posterior sample (extracted from state).
    type Sample: Send;
    /// Final result with posterior summaries.
    type Result;

    /// Initialize the sampler state.
    fn init(&self, rng: &mut SmallRng) -> Self::State;

    /// Run one full sweep (e.g. one Gibbs iteration, one ESS step).
    fn sweep(&self, state: &mut Self::State, rng: &mut SmallRng);

    /// Extract a sample from the current state.
    fn collect(&self, state: &Self::State) -> Self::Sample;

    /// Compute posterior summaries from collected samples.
    fn summarize(&self, samples: Vec<Self::Sample>) -> Self::Result;
}