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>
impl<P, L> EvolutionChain<P, L>
Sourcepub fn new(model: EvolutionModel<P, L>) -> Self
pub fn new(model: EvolutionModel<P, L>) -> Self
Create a chain over the model’s fixed-β target.
Sourcepub fn target_rate(self, rate: f64) -> Self
pub fn target_rate(self, rate: f64) -> Self
Set the adaptation’s target acceptance rate (default 0.44).
Sourcepub fn override_site(self, addr: Address, proposal: SiteProposal) -> Self
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, …).
Sourcepub fn overrides(&self) -> &HashMap<Address, SiteProposal>
pub fn overrides(&self) -> &HashMap<Address, SiteProposal>
The registered per-address proposal overrides.
Sourcepub fn model(&self) -> &EvolutionModel<P, L>
pub fn model(&self) -> &EvolutionModel<P, L>
The underlying model.
Sourcepub fn init<R: Rng>(&self, rng: &mut R) -> Trace
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).
Sourcepub fn init_from(&self, genome: &P::Genome) -> Option<Trace>
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).
Sourcepub fn try_init_from(&self, genome: &P::Genome) -> Result<Trace, GenomeError>
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.
Sourcepub fn init_from_with_latents<R: Rng>(
&self,
rng: &mut R,
genome: &P::Genome,
) -> Result<Trace, GenomeError>
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.
Sourcepub fn step<R: Rng>(
&mut self,
rng: &mut R,
current: &Trace,
) -> (P::Genome, Trace)
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.
Sourcepub fn step_scored<R: Rng>(
&mut self,
rng: &mut R,
current: &Trace,
) -> Option<(P::Genome, Trace, f64)>
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.
Sourcepub fn decode(&self, state: &Trace) -> P::Genome
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.
Auto Trait Implementations§
impl<P, L> Freeze for EvolutionChain<P, L>where
EvolutionModel<P, L>: Freeze,
impl<P, L> RefUnwindSafe for EvolutionChain<P, L>where
EvolutionModel<P, L>: RefUnwindSafe,
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>where
EvolutionModel<P, L>: UnsafeUnpin,
impl<P, L> UnwindSafe for EvolutionChain<P, L>where
EvolutionModel<P, L>: UnwindSafe,
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
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
self from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
self is actually part of its subset T (and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
self.to_subset but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
self to the equivalent element of its superset.