cdt::ergodic_moves::MetropolisTransition Class Reference

Result of one fully sampled Metropolis-Hastings transition. More...

#include <Move_outcome.hpp>

Collaboration diagram for cdt::ergodic_moves::MetropolisTransition:

Public Member Functions
constexpr	MetropolisTransition (move_tracker::MoveType const move, MoveOutcome const outcome) noexcept
constexpr auto	accepted () const noexcept -> bool
constexpr auto	move () const noexcept -> move_tracker::MoveType
auto	operator== (MetropolisTransition const &other) const -> bool=default
constexpr auto	outcome () const noexcept -> MoveOutcome
constexpr auto	successful () const noexcept -> bool

Detailed Description

Result of one fully sampled Metropolis-Hastings transition.

Candidate success and Metropolis acceptance are distinct: a valid candidate may still be rejected and leave the canonical state unchanged.

Definition at line 96 of file Move_outcome.hpp.

Constructor & Destructor Documentation

MetropolisTransition()

cdt::ergodic_moves::MetropolisTransition::MetropolisTransition ( move_tracker::MoveType const move, MoveOutcome const outcome )

inlineconstexprnoexcept

Parameters

move	Sampled Pachner move kind.
outcome	Final accounting outcome for the transition.

Definition at line 104 of file Move_outcome.hpp.

References move(), and outcome().

Referenced by operator==().

Member Function Documentation

accepted()

auto cdt::ergodic_moves::MetropolisTransition::accepted ( ) const -> bool

inlinenodiscardconstexprnoexcept

Returns

Whether Metropolis-Hastings accepted and committed the move.

Definition at line 126 of file Move_outcome.hpp.

move()

auto cdt::ergodic_moves::MetropolisTransition::move ( ) const -> move_tracker::MoveType

inlinenodiscardconstexprnoexcept

Returns

The sampled Pachner move kind.

Definition at line 110 of file Move_outcome.hpp.

Referenced by MetropolisTransition().

operator==()

auto cdt::ergodic_moves::MetropolisTransition::operator== ( MetropolisTransition const & other ) const -> bool=default

default

Parameters

other

Transition report to compare.

Returns

Whether move and outcome are equal.

References MetropolisTransition().

outcome()

auto cdt::ergodic_moves::MetropolisTransition::outcome ( ) const -> MoveOutcome

inlinenodiscardconstexprnoexcept

Returns

The final transition-accounting outcome.

Definition at line 114 of file Move_outcome.hpp.

Referenced by MetropolisTransition().

successful()

auto cdt::ergodic_moves::MetropolisTransition::successful ( ) const -> bool

inlinenodiscardconstexprnoexcept

Returns

Whether proposal construction and validation succeeded.

Definition at line 118 of file Move_outcome.hpp.

---

The documentation for this class was generated from the following file:

• include/Move_outcome.hpp