num::markov::MetropolisStats Struct Reference

Statistics returned by a single Metropolis sweep. More...

#include <mcmc.hpp>

Public Member Functions
real	acceptance_rate () const

Public Attributes
idx	accepted = 0
	Number of accepted proposals.
idx	total = 0
	Total proposals (= n_sites)

Detailed Description

Statistics returned by a single Metropolis sweep.

Definition at line 38 of file mcmc.hpp.

Member Function Documentation

acceptance_rate()

real num::markov::MetropolisStats::acceptance_rate ( ) const

inline

Definition at line 41 of file mcmc.hpp.

References accepted, and total.

Member Data Documentation

accepted

idx num::markov::MetropolisStats::accepted = 0

Number of accepted proposals.

Definition at line 39 of file mcmc.hpp.

Referenced by acceptance_rate(), num::markov::metropolis_sweep(), and num::markov::metropolis_sweep_prob().

total

idx num::markov::MetropolisStats::total = 0

Total proposals (= n_sites)

Definition at line 40 of file mcmc.hpp.

Referenced by acceptance_rate(), num::markov::metropolis_sweep(), and num::markov::metropolis_sweep_prob().

---

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

• /home/runner/work/numerics/numerics/include/stochastic/mcmc.hpp