MonteCounter.hh

Go to the documentation of this file.

#ifndef CASM_MonteCounter_HH
#define CASM_MonteCounter_HH
 
#include "casm/global/definitions.hh"
#include "casm/monte_carlo/MonteDefinitions.hh"
 
namespace CASM {
namespace Monte {
 
class EquilibriumMonteSettings;
class MonteCarlo;
 
class MonteCounter {
 public:
  typedef Index size_type;
 
  MonteCounter(const EquilibriumMonteSettings &settings,
               size_type _steps_per_pass);
 
  size_type pass() const;
 
  size_type step() const;
 
  size_type steps_per_pass() const;
 
  size_type samples() const;
 
  void increment_samples();
 
  void reset();
 
  void set(size_type _pass, size_type _step, size_type _samples);
 
  bool sample_time() const;
 
  MonteCounter &operator++();
 
  MonteCounter operator++(int);
 
  bool is_complete() const;
 
  bool minimums_met() const;
 
  bool maximums_met() const;
 
  void debugprint(std::ostream &sout) const;
 
 private:
  size_type m_pass = 0;
 
  size_type m_step = 0;
 
  size_type m_samples = 0;
 
  size_type m_since_last_sample = 0;
 
  // --- If not in 'must converge mode' -----
 
  bool m_is_N_step = false;
  size_type m_N_step = 0;
 
  bool m_is_N_pass = false;
  size_type m_N_pass = 0;
 
  bool m_is_N_sample = false;
  size_type m_N_sample = 0;
 
  // --- Imposed limits ------------
 
  bool m_is_max_step = false;
  size_type m_max_step = 0;
 
  bool m_is_min_step = false;
  size_type m_min_step = 0;
 
  bool m_is_max_pass = false;
  size_type m_max_pass = 0;
 
  bool m_is_min_pass = false;
  size_type m_min_pass = 0;
 
  bool m_is_max_sample = false;
  size_type m_max_sample = 0;
 
  bool m_is_min_sample = false;
  size_type m_min_sample = 0;
 
  // --- Periods at which certain things should happen --------
 
  SAMPLE_MODE m_sample_mode = SAMPLE_MODE::PASS;
 
  int m_sample_period;
 
  int m_steps_per_pass;
};
 
}  // namespace Monte
}  // namespace CASM
 
#endif