ALPSCore reference
Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Attributes | List of all members
alps::mcbase Class Referenceabstract

#include <mcbase.hpp>

Collaboration diagram for alps::mcbase:
Collaboration graph

Public Types

typedef alps::params parameters_type
 
typedef std::vector< std::string > result_names_type
 
typedef alps::accumulators::result_set results_type
 

Public Member Functions

 mcbase (parameters_type const &parms, std::size_t seed_offset=0)
 
virtual void update ()=0
 
virtual void measure ()=0
 
virtual double fraction_completed () const =0
 
bool run (boost::function< bool()> const &stop_callback)
 
result_names_type result_names () const
 
result_names_type unsaved_result_names () const
 
results_type collect_results () const
 
results_type collect_results (result_names_type const &names) const
 
void save (std::string const &filename) const
 
void load (std::string const &filename)
 
virtual void save (alps::hdf5::archive &ar) const
 
virtual void load (alps::hdf5::archive &ar)
 

Static Public Member Functions

static parameters_typedefine_parameters (parameters_type &parameters)
 

Protected Types

typedef alps::accumulators::accumulator_set observable_collection_type
 

Protected Attributes

parameters_type parameters
 
alps::random01 random
 
observable_collection_type measurements
 

Detailed Description

Definition at line 21 of file mcbase.hpp.

Member Typedef Documentation

Definition at line 25 of file mcbase.hpp.

Definition at line 29 of file mcbase.hpp.

typedef std::vector<std::string> alps::mcbase::result_names_type

Definition at line 30 of file mcbase.hpp.

Definition at line 32 of file mcbase.hpp.

Constructor & Destructor Documentation

alps::mcbase::mcbase ( parameters_type const &  parms,
std::size_t  seed_offset = 0 
)

Definition at line 12 of file mcbase.cpp.

Member Function Documentation

mcbase::results_type alps::mcbase::collect_results ( ) const

Definition at line 54 of file mcbase.cpp.

mcbase::results_type alps::mcbase::collect_results ( result_names_type const &  names) const

Definition at line 58 of file mcbase.cpp.

mcbase::parameters_type & alps::mcbase::define_parameters ( parameters_type parameters)
static

Definition at line 19 of file mcbase.cpp.

virtual double alps::mcbase::fraction_completed ( ) const
pure virtual
void alps::mcbase::load ( std::string const &  filename)

Definition at line 28 of file mcbase.cpp.

void alps::mcbase::load ( alps::hdf5::archive ar)
virtual

Definition at line 72 of file mcbase.cpp.

virtual void alps::mcbase::measure ( )
pure virtual
mcbase::result_names_type alps::mcbase::result_names ( ) const

Definition at line 43 of file mcbase.cpp.

bool alps::mcbase::run ( boost::function< bool()> const &  stop_callback)

Definition at line 33 of file mcbase.cpp.

void alps::mcbase::save ( std::string const &  filename) const

Definition at line 23 of file mcbase.cpp.

void alps::mcbase::save ( alps::hdf5::archive ar) const
virtual

Definition at line 66 of file mcbase.cpp.

mcbase::result_names_type alps::mcbase::unsaved_result_names ( ) const

Definition at line 50 of file mcbase.cpp.

virtual void alps::mcbase::update ( )
pure virtual

Member Data Documentation

observable_collection_type alps::mcbase::measurements
protected

Definition at line 58 of file mcbase.hpp.

parameters_type alps::mcbase::parameters
protected

Definition at line 55 of file mcbase.hpp.

alps::random01 alps::mcbase::random
protected

Definition at line 57 of file mcbase.hpp.


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