ell::SA_Metropolis Class Reference
#include <StateAcceptor.hh>
Inheritance diagram for ell::SA_Metropolis:
Detailed Description
This subclass of StateAcceptor implements the Metropolis criterion to determine if a given State is valid to be accepted as successor in a walk. The acceptance probability used is min( 1, e^(-deltaE/kT) ) utilizing the Boltzmann weight of energy difference deltaE between the new State and the last accepted one in the state collector.
Definition at line 247 of file StateAcceptor.hh.
Public Member Functions | |
| virtual bool | accept (const StateCollector *const sc, const State &succ) const |
| SA_Metropolis (const double kT) | |
| virtual | ~SA_Metropolis () |
Protected Attributes | |
| const double | kT |
Constructor & Destructor Documentation
| ell::SA_Metropolis::SA_Metropolis | ( | const double | kT | ) |
Construction
- Parameters:
-
kT the weighted temperature to calculate the Boltzmann weight of a State.
Definition at line 59 of file StateAcceptor.cc.
| virtual ell::SA_Metropolis::~SA_Metropolis | ( | ) | [inline, virtual] |
Definition at line 261 of file StateAcceptor.hh.
Member Function Documentation
| bool ell::SA_Metropolis::accept | ( | const StateCollector *const | sc, | |
| const State & | succ | |||
| ) | const [virtual] |
Checks if State succ is valid successor to last accepted State from StateCollector sc, using the metropolis criterion.
- Parameters:
-
sc the StateCollector to test against succ the successor State to test
- Returns:
- true if valid successor
Implements ell::StateAcceptor.
Definition at line 62 of file StateAcceptor.cc.
Field Documentation
const double ell::SA_Metropolis::kT [protected] |
the weighted temperature to calculate the Boltzmann weight of a State.
Definition at line 252 of file StateAcceptor.hh.
The documentation for this class was generated from the following files:
- src/ell/StateAcceptor.hh
- src/ell/StateAcceptor.cc