CASM
AClustersApproachtoStatisticalMechanics
|
#include <MonteSampler.hh>
Sampler for site fraction.
Definition at line 396 of file MonteSampler.hh.
Public Types | |
typedef Index | size_type |
Public Member Functions | |
SiteFracMonteSampler (size_type _index, size_type _basis_size, std::string print_name, double data_confidence, size_type data_initsize) | |
Construct sampler that does not need to converge. More... | |
SiteFracMonteSampler (size_type _index, size_type _basis_size, std::string print_name, double data_prec, double data_confidence, size_type data_initsize) | |
Construct sampler that must converge. More... | |
void | sample (const MonteCarlo &mc, const MonteCounter &counter) |
Sample data from a MonteCarlo calculation. More... | |
std::unique_ptr < SiteFracMonteSampler > | clone () const |
Clone this object. More... | |
void | clear () |
Clear all data observations. More... | |
std::pair< bool, size_type > | is_equilibrated () const |
Returns pair(true, equil_steps) if equilibration has occured to required precision. More... | |
bool | must_converge () const |
Returns true if convergence criteria must be met for Monte Carlo calculation to be complete. More... | |
double | requested_precision () const |
Returns requested precision on the mean. More... | |
bool | is_converged (size_type equil_samples) const |
Returns true if convergence criteria have been met for data sampled in range [equil_samples, end) More... | |
double | mean (size_type equil_samples) const |
Returns <X> for data sampled in range [equil_samples, end) More... | |
double | squared_norm (size_type equil_samples) const |
Returns <X*X> for data sampled in range [equil_samples, end) More... | |
double | calculated_precision (size_type equil_samples) const |
Returns calculated precision on the mean for data sampled in range [equil_samples, end) More... | |
const MCData & | data () const |
const Access the raw data observation container More... | |
std::string | name () const |
Property name for printing. More... | |
Protected Member Functions | |
MCData & | data () |
Access the raw data observation container. More... | |
Private Member Functions | |
virtual SiteFracMonteSampler * | _clone () const |
Private Attributes | |
size_type | m_index |
size_type | m_basis_size |
Definition at line 400 of file MonteSampler.hh.
CASM::SiteFracMonteSampler::SiteFracMonteSampler | ( | size_type | _index, |
size_type | _basis_size, | ||
std::string | print_name, | ||
double | data_confidence, | ||
size_type | data_initsize | ||
) |
Construct sampler that does not need to converge.
_index | param composition index to sample, ex: 0 -> 'a', 1 -> 'b' |
_basis_size | number of sites per primitive cell |
print_name | Name to be printed, ex: "site_frac(Mg)" |
data_initsize | For constructing MCData object |
Definition at line 224 of file MonteSampler.cc.
CASM::SiteFracMonteSampler::SiteFracMonteSampler | ( | size_type | _index, |
size_type | _basis_size, | ||
std::string | print_name, | ||
double | data_prec, | ||
double | data_confidence, | ||
size_type | data_initsize | ||
) |
Construct sampler that must converge.
_index | param composition index to sample, ex: 0 -> 'a', 1 -> 'b' |
_basis_size | number of sites per primitive cell |
print_name | Name to be printed, ex: "site_frac(Mg)" |
data_prec | Required precision level |
data_confidence | Required confidence level |
data_initsize | For constructing MCData object |
Definition at line 242 of file MonteSampler.cc.
|
inlineprivatevirtual |
Reimplemented from CASM::MonteSampler.
Definition at line 428 of file MonteSampler.hh.
|
inlineinherited |
Returns calculated precision on the mean for data sampled in range [equil_samples, end)
Definition at line 119 of file MonteSampler.hh.
|
inlineinherited |
Clear all data observations.
Definition at line 47 of file MonteSampler.hh.
|
inline |
Clone this object.
Definition at line 422 of file MonteSampler.hh.
|
inlineinherited |
const Access the raw data observation container
Definition at line 130 of file MonteSampler.hh.
|
inlineprotectedinherited |
Access the raw data observation container.
Definition at line 148 of file MonteSampler.hh.
|
inlineinherited |
Returns true if convergence criteria have been met for data sampled in range [equil_samples, end)
Definition at line 82 of file MonteSampler.hh.
|
inlineinherited |
Returns pair(true, equil_steps) if equilibration has occured to required precision.
Definition at line 55 of file MonteSampler.hh.
|
inlineinherited |
Returns <X> for data sampled in range [equil_samples, end)
Definition at line 97 of file MonteSampler.hh.
|
inlineinherited |
Returns true if convergence criteria must be met for Monte Carlo calculation to be complete.
Definition at line 70 of file MonteSampler.hh.
|
inlineinherited |
Property name for printing.
Definition at line 135 of file MonteSampler.hh.
|
inlineinherited |
Returns requested precision on the mean.
Definition at line 75 of file MonteSampler.hh.
|
virtual |
Sample data from a MonteCarlo calculation.
Reimplemented from CASM::MonteSampler.
Definition at line 254 of file MonteSampler.cc.
|
inlineinherited |
Returns <X*X> for data sampled in range [equil_samples, end)
Definition at line 108 of file MonteSampler.hh.
|
private |
Definition at line 434 of file MonteSampler.hh.
|
private |
Definition at line 432 of file MonteSampler.hh.