ell::MS_Boltzmann Class Reference
#include <MinimumSelector.hh>
Inheritance diagram for ell::MS_Boltzmann:
Detailed Description
Selects randomly a minimum from a given landscape topology using a Boltzmann distribution based on the energy of the minima. The probability to choose a minimum M is equal to e^(-(E(M)*F)/kT), i.e. is the Boltzmann weight scaled with a factor F. This factor allows for the (in/de)crease of the probability low energy minima. The higher > 1 this factor is set the more like it is to select one of the lowest energy minima. The used kT value is derived from LandscapeTopology::BOLTZMANN_KT.
Definition at line 96 of file MinimumSelector.hh.
Public Member Functions | |
| MS_Boltzmann (const double shiftFactor=1.0) | |
| virtual size_t | select (const LandscapeTopology *const lt, const bool minimaChanged=true) |
| virtual | ~MS_Boltzmann () |
Protected Attributes | |
| std::vector< double > | boltzWeightSum |
| const double | shiftFactor |
Constructor & Destructor Documentation
| ell::MS_Boltzmann::MS_Boltzmann | ( | const double | shiftFactor = 1.0 |
) |
construction
- Parameters:
-
shiftFactor the factor used to (in/de)crease to Boltzmann weight using the formula e^(-(E(M)*F)/kT).
Definition at line 59 of file MinimumSelector.cc.
| ell::MS_Boltzmann::~MS_Boltzmann | ( | ) | [virtual] |
Member Function Documentation
| size_t ell::MS_Boltzmann::select | ( | const LandscapeTopology *const | lt, | |
| const bool | minimaChanged = true | |||
| ) | [virtual] |
Selects randomly a minimum from the landscape topology using a uniform distribution and returns the corresponding index.
- Parameters:
-
lt the landscape topology to select a minimum from minimaChanged whether or not the minima of lt have changed since the last call of this selector. If true the Boltzmann weight of all minima is recalculated.
- Returns:
- the index of the minimum selected or INVALID_INDEX if the topology holds no minima or none this selector would choose.
Implements ell::MinimumSelector.
Definition at line 77 of file MinimumSelector.cc.
Field Documentation
std::vector<double> ell::MS_Boltzmann::boltzWeightSum [protected] |
The Boltzmann weights of all minima successively summed up to allow for a weight based selection.
Definition at line 135 of file MinimumSelector.hh.
const double ell::MS_Boltzmann::shiftFactor [protected] |
The factor used to (in/de)crease to Boltzmann weight using the formula e^(-(E(M)*F)/kT).
Definition at line 131 of file MinimumSelector.hh.
The documentation for this class was generated from the following files:
- src/ell/MinimumSelector.hh
- src/ell/MinimumSelector.cc