Path Integral Quantum Monte Carlo
Public Member Functions | Static Public Attributes
NumberDistributionEstimator Class Reference

Computes the probability distribution function for the number of particles. More...

#include <estimator.h>

+ Inheritance diagram for NumberDistributionEstimator:
+ Collaboration diagram for NumberDistributionEstimator:

Public Member Functions

 NumberDistributionEstimator (const Path &, ActionBase *, const MTRand &, double, int _frequency=1, string _label="number")
 Constructor. More...
 
 ~NumberDistributionEstimator ()
 Destructor.
 
string getName () const
 Get the name of the estimator.
 
- Public Member Functions inherited from EstimatorBase
 EstimatorBase (const Path &_path, ActionBase *_actionPtr, const MTRand &_random, double _maxR, int _frequency=1, string _label="")
 Constructor. More...
 
virtual ~EstimatorBase ()
 Destructor.
 
virtual void sample ()
 Sample the estimator. More...
 
void reset ()
 Reset numAccumulated and the estimator to 0.
 
void restart (const uint32, const uint32)
 Restart the measurment process from a previous state.
 
virtual void output ()
 Output the estimator value to disk. More...
 
virtual void outputFlat ()
 Output a flat estimator value to disk. More...
 
virtual void outputFooter ()
 Ouptut the fooder to disk.
 
bool baseSample ()
 Determine the basic sampling condition. More...
 
uint32 getTotNumAccumulated () const
 Get the total number of accumulated measurments.
 
uint32 getNumAccumulated () const
 Get the number of accumulated measurements since the last reset.
 
uint32 getNumSampled () const
 Get the number of samples since the last reset.
 
void prepare ()
 Prepare the estimator for i/o. More...
 
void addEndLine ()
 Add a carriage return to estimator files.
 
void appendLabel (string append)
 Append to default label. More...
 
string getLabel () const
 Get the estimator label.
 

Static Public Attributes

static const string name
 

Additional Inherited Members

- Protected Member Functions inherited from EstimatorBase
void initialize (int)
 Initialize estimator. More...
 
void initialize (vector< string >)
 Initialize estimator. More...
 
- Protected Attributes inherited from EstimatorBase
const Pathpath
 A constant reference to the paths.
 
ActionBaseactionPtr
 A pointer to the action.
 
MTRand random
 
double maxR
 
fstream * outFilePtr
 The output fie.
 
map< string, int > estIndex
 Map estimator labels to indices.
 
Array< double, 1 > estimator
 The estimator array.
 
Array< double, 1 > norm
 The normalization factor for each estimator.
 
int numEst
 The number of individual quantities measured.
 
int frequency
 The frequency at which we accumulate.
 
int startSlice
 Where imaginary time averages begin.
 
int endSlice
 Where imaginary time averages end.
 
int endDiagSlice
 Where imaginary time averages end for diagonal estimiators.
 
vector< double > sliceFactor
 Used to properly incorporate end affects.
 
string label
 The label used for the output file.
 
uint32 numSampled
 The number of times we have sampled.
 
uint32 numAccumulated
 The number of accumulated values.
 
uint32 totNumAccumulated
 The total number of accumulated values.
 
int numBeads0
 The target number of beads for the canonical ensemble.
 
bool diagonal
 Is this a diagonal estimator?
 
bool endLine
 Should we output a carriage return?
 
bool canonical
 Are we in the canonical ensemble?
 
string header
 The data file header.
 

Detailed Description

Computes the probability distribution function for the number of particles.

Definition at line 390 of file estimator.h.

Constructor & Destructor Documentation

◆ NumberDistributionEstimator()

NumberDistributionEstimator::NumberDistributionEstimator ( const Path _path,
ActionBase _actionPtr,
const MTRand &  _random,
double  _maxR,
int  _frequency = 1,
string  _label = "number" 
)

Constructor.

The number of particles probability distribution is setup. We allow for particle fluctuations up to 50 particles away from the initial value specified.

Definition at line 759 of file estimator.cpp.

761  :
762  EstimatorBase(_path,_actionPtr,_random,_maxR,_frequency,_label) {
763 
764  /* For now, we assume 50 particles on each side of the mean */
765  particleShift = 50;
766  startParticleNumber = max(constants()->initialNumParticles()-particleShift,0);
767  if (startParticleNumber == 0)
768  endParticleNumber = 2*particleShift;
769  else
770  endParticleNumber = constants()->initialNumParticles() + particleShift;
771  maxNumParticles = endParticleNumber - startParticleNumber + 1;
772 
773  /* If our number of paticles is too small, we compensate */
774  if ((constants()->initialNumParticles() - particleShift) < 0)
775  particleShift = constants()->initialNumParticles();
776 
777  initialize(maxNumParticles);
778 
779  /* Set estimator name and header */
780  header = str(format("#%15d") % startParticleNumber);
781  for (int n = startParticleNumber+1; n <= endParticleNumber; n++)
782  header.append(str(format("%16d") % n));
783 }
int initialNumParticles()
Get initial number of particles.
Definition: constants.h:100
string header
The data file header.
Definition: estimator.h:110
EstimatorBase(const Path &_path, ActionBase *_actionPtr, const MTRand &_random, double _maxR, int _frequency=1, string _label="")
Constructor.
Definition: estimator.cpp:103
void initialize(int)
Initialize estimator.
Definition: estimator.cpp:201
Ttype & max(Ttype &x, Ttype &y)
Maximum of two inputs.
Definition: common.h:146
ConstantParameters * constants()
Global public access to the constants.
Definition: constants.h:201
+ Here is the call graph for this function:

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