Skip to main content

EvolutionChain

Struct EvolutionChain 

Source
pub struct EvolutionChain<P, L>{ /* private fields */ }
Expand description

An MH chain over the fixed-β Boltzmann target π_β ∝ p(x)·exp(β·f(x)).

Implementations§

Source§

impl<P, L> EvolutionChain<P, L>

Source

pub fn new(model: EvolutionModel<P, L>) -> Self

Create a chain over the model’s fixed-β target.

Source

pub fn target_rate(self, rate: f64) -> Self

Set the adaptation’s target acceptance rate (default 0.44).

Source

pub fn override_site(self, addr: Address, proposal: SiteProposal) -> Self

Force a specific f64 proposal for one address (e.g. SiteProposal::Reflect { lower, upper } for a bounded coordinate, or SiteProposal::PriorResample for an independence move).

Honoured by Self::step, Self::step_scored and Self::run_chain. Since fugue selects the default f64 proposal from the site’s declared [fugue::Support] — a Uniform site already gets a reflected walk at its own bounds — an override is only needed to change that default (a narrower reflection interval, a log-space walk on a Normal site known to be positive, …).

Source

pub fn overrides(&self) -> &HashMap<Address, SiteProposal>

The registered per-address proposal overrides.

Source

pub fn model(&self) -> &EvolutionModel<P, L>

The underlying model.

Source

pub fn init<R: Rng>(&self, rng: &mut R) -> Trace

Draw an initial state: a prior sample’s fully-scored trace (latent likelihood sites included).

Source

pub fn init_from(&self, genome: &P::Genome) -> Option<Trace>

Warm-start the chain from a given genome: encode it under the model’s prior (GenomePrior::trace_of) and score it through the target program. Works for any prior — including grammar priors over trees — so a classic GA/GP result can seed an inference chain. Returns None if the genome is outside the prior’s support (its target density is −∞, which can never be left by an MH chain) or cannot be scored from its encoding alone: wrong dimension for the prior, or a likelihood with latent nuisance sites (see Self::try_init_from for the reason and Self::init_from_with_latents to draw them). Never panics (EV-N3).

Source

pub fn try_init_from(&self, genome: &P::Genome) -> Result<Trace, GenomeError>

Self::init_from with the reason on failure: EvolutionModel::score’s errors for a structural mismatch, or GenomeError::ConstraintViolation for a genome outside the prior’s support.

Source

pub fn init_from_with_latents<R: Rng>( &self, rng: &mut R, genome: &P::Genome, ) -> Result<Trace, GenomeError>

Warm-start from a genome when the likelihood has latent nuisance sites (an inferred noise scale, a Pareto weight): the genome’s sites come from its encoding, the latent ones are drawn from their priors with rng, and the result is a complete, fully scored state. Same errors as Self::try_init_from.

Source

pub fn step<R: Rng>( &mut self, rng: &mut R, current: &Trace, ) -> (P::Genome, Trace)

One π_β-invariant transition. Moves ANY site type; honours Self::override_site. Returns the decoded genome and the new state (the freshly scored proposal on acceptance, a copy of current on rejection).

Costs exactly one model execution — the proposal — plus, on rejection, a replay of the prior program only (no likelihood / fitness evaluation) to decode the genome of the unchanged state. Callers who keep their own decoded genome can use Self::step_scored and skip even that.

§Contract on current

current must be a fully scored trace of this chain’s target: one returned by Self::init, Self::init_from / Self::init_from_with_latents, or a previous step / step_scored. Its accumulators and per-site densities are trusted as the current state’s log-density and as the reverse-move densities of sites a proposal makes vanish. A trace assembled by hand — TraceGenome::to_trace or GenomePrior::trace_of, whose per-site logp is 0 — violates this and over-accepts structure-shrinking moves until the first acceptance; route it through init_from first.

Source

pub fn step_scored<R: Rng>( &mut self, rng: &mut R, current: &Trace, ) -> Option<(P::Genome, Trace, f64)>

One π_β-invariant transition from a scored state, at the cost of a single model execution: Some((genome, scored_trace, log_weight)) on acceptance — log_weight == scored_trace.total_log_weight() — or None on rejection, in which case the caller keeps current. Same contract on current as Self::step.

Source

pub fn decode(&self, state: &Trace) -> P::Genome

Decode the genome of a chain state by replaying the prior program over it (the prior’s return value is the decoded genome). No likelihood or fitness is evaluated. state must be a complete assignment for the prior — every trace this chain hands out is.

Source

pub fn run_chain<R: Rng>( &self, rng: &mut R, n: usize, warmup: usize, ) -> Vec<(P::Genome, Trace)>
where P::Genome: Clone,

Full warmup-then-frozen chain: warmup adaptive iterations are discarded, then n samples are collected from the frozen kernel. Returns decoded genomes with their traces.

Auto Trait Implementations§

§

impl<P, L> Freeze for EvolutionChain<P, L>
where EvolutionModel<P, L>: Freeze,

§

impl<P, L> RefUnwindSafe for EvolutionChain<P, L>

§

impl<P, L> Send for EvolutionChain<P, L>
where EvolutionModel<P, L>: Send,

§

impl<P, L> Sync for EvolutionChain<P, L>
where EvolutionModel<P, L>: Sync,

§

impl<P, L> Unpin for EvolutionChain<P, L>
where EvolutionModel<P, L>: Unpin,

§

impl<P, L> UnsafeUnpin for EvolutionChain<P, L>

§

impl<P, L> UnwindSafe for EvolutionChain<P, L>

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> 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> 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
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

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

§

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

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

fn is_in_subset(&self) -> bool

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

fn to_subset_unchecked(&self) -> SS

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

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, !>

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V