Enum StepOutcome 

#[non_exhaustive]
pub enum StepOutcome {
    Accepted,
    RejectedProposal,
    NoProposal,
}

Outcome of a completed Metropolis-Hastings step.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Accepted

A concrete proposal was accepted and committed.

RejectedProposal

A concrete proposal was produced and then rejected by the Metropolis-Hastings acceptance draw.

NoProposal

No concrete proposal was available, so the step was an ordinary self-loop without a Metropolis-Hastings acceptance draw.

Implementations

impl StepOutcome

pub const fn is_accepted(self) -> bool

Whether this outcome accepted and committed a concrete proposal.

use markov_chain_monte_carlo::prelude::delayed::StepOutcome;

assert!(StepOutcome::Accepted.is_accepted());
assert!(!StepOutcome::RejectedProposal.is_accepted());
assert!(!StepOutcome::NoProposal.is_accepted());

pub const fn has_proposal(self) -> bool

Whether this outcome includes a concrete proposal.

use markov_chain_monte_carlo::prelude::delayed::StepOutcome;

assert!(StepOutcome::Accepted.has_proposal());
assert!(StepOutcome::RejectedProposal.has_proposal());
assert!(!StepOutcome::NoProposal.has_proposal());

Trait Implementations

impl Clone for StepOutcome

fn clone(&self) -> StepOutcome

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepOutcome

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

Formats the value using the given formatter.

impl From<StepOutcome> for TraceStepOutcome

fn from(outcome: StepOutcome) -> TraceStepOutcome

Converts to this type from the input type.

impl PartialEq for StepOutcome

fn eq(&self, other: &StepOutcome) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for StepOutcome

impl Eq for StepOutcome

impl StructuralPartialEq for StepOutcome