EstimatorBase Class Reference

The base class that all estimator classes will be derived from. More...

#include <estimator.h>

Inheritance diagram for EstimatorBase:

Collaboration diagram for EstimatorBase:

Public Member Functions
	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.
virtual string	getName () const
	Get the name of the estimator.
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.

Protected Member Functions
virtual void	accumulate ()
	Accumulate the estimator.
void	initialize (int)
	Initialize estimator. More...
void	initialize (vector< string >)
	Initialize estimator. More...

Protected Attributes
const Path &	path
	A constant reference to the paths.
ActionBase *	actionPtr
	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

The base class that all estimator classes will be derived from.

Contains the common elements of all estimators, including the ability to initialize, accumulate, output and reset. We assume a default measurment frequency of every time.

Definition at line 28 of file estimator.h.

Constructor & Destructor Documentation

EstimatorBase()

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

Constructor.

Initialize and specify the output file.

We take in some options that might only be needed by derived classes (_actionPtr, _random, _maxR) in order to facilitate instantiation via a factory.

Definition at line 103 of file estimator.cpp.

                                                                            :
    path(_path),
    actionPtr(_actionPtr),
    random(_random),
    maxR(_maxR),
    frequency(_frequency),
    label(_label),
    numSampled(0),
    numAccumulated(0),
    totNumAccumulated(0),
    diagonal(true),
    endLine(true)
{
    /* Two handy local constants */
    canonical = constants()->canonical();
    numBeads0 = constants()->initialNumParticles()*constants()->numTimeSlices();
 
    /* A normalization factor for time slices used in estimators */
    sliceFactor.resize(constants()->numTimeSlices(),1.0);
 
    /*  The slices over which we average quantities PIGS vs. PIMC */
#if PIGS
    int midSlice = (path.numTimeSlices-1)/2;
    startSlice = midSlice - actionPtr->period;
    endSlice = midSlice + actionPtr->period;
    endDiagSlice = endSlice;
 
    if(actionPtr->local) {
        endDiagSlice = endSlice + 1;
        sliceFactor[startSlice] = 0.5;
        sliceFactor[endSlice] = 0.5;
    }
#else
    startSlice = 0;
    endSlice = path.numTimeSlices;
    endDiagSlice = endSlice;
#endif
}

Here is the call graph for this function:

Member Function Documentation

appendLabel()

void EstimatorBase::appendLabel

(

string

append

)

Append to default label.

AppendLabel.

Definition at line 325 of file estimator.cpp.

                                             {
    label = label + append;
}

baseSample()

bool EstimatorBase::baseSample

(

)

Determine the basic sampling condition.

We only sample when: 1) frequency > 0 2) numSampled is a even factor of frequency 3) The configuration (diagonal/off diagonal) matches the estimator type. 4) If we are canonical, then only when we match the desired number of particles

Definition at line 161 of file estimator.cpp.

                               {
 
    /* Increment the number of attempted samplings */
    numSampled++;
 
    if (!frequency)
        return false;
    if ((numSampled % frequency) != 0)
        return false;
    if (!(path.worm.isConfigDiagonal == diagonal))
        return false;
    if (!canonical)
        return true;
    if (path.worm.getNumBeadsOn() == numBeads0)
        return true;
 
    return false;
}

Here is the call graph for this function:

Here is the caller graph for this function:

initialize() [1/2]

void EstimatorBase::initialize ( int  _numEst )

protected

Initialize estimator.

Initilize the estimator and normalization arrays.

Definition at line 201 of file estimator.cpp.

                                          {
 
    numEst = _numEst;
    estimator.resize(numEst);
    norm.resize(numEst);
    norm = 1.0;
    reset();
}

Here is the call graph for this function:

Here is the caller graph for this function:

initialize() [2/2]

void EstimatorBase::initialize ( vector< string >  estLabel )

protected

Initialize estimator.

Initilize the estimator and normalization arrays.

Definition at line 215 of file estimator.cpp.

                                                      {
 
    /* Initialize the map linking names to indices */
    for(size_t i = 0; i < estLabel.size(); ++i) 
        estIndex[estLabel[i]] = i;
 
    /* write the header string */
    estLabel.front() = str(format("#%15s") % estLabel.front());
    header = "";
    for (const auto& label : estLabel)
        header += str(format("%16s") % label);
 
    numEst = estLabel.size();
    estimator.resize(numEst);
    norm.resize(numEst);
    norm = 1.0;
    reset();
}

Here is the call graph for this function:

output()

void EstimatorBase::output ( )

virtual

Output the estimator value to disk.

We only attempt an output if we have accumulated at least numBins measurements. This works because the final 'scalar' estimator is the diagonal estimator which gets measured for both diaagonal and off diagonal configurations.

Reimplemented in LocalPermutationEstimator, LocalSuperfluidDensityEstimator, PlaneAverageExternalPotentialEstimator, PlaneParticleAveragePositionEstimator, ParticlePositionEstimator, and TimeEstimator.

Definition at line 283 of file estimator.cpp.

                           {
 
    /* Average */
    estimator *= (norm/(1.0*numAccumulated));
 
    /* Now write the estimator values to disk */
    for (int n = 0; n < numEst; n++) 
        (*outFilePtr) << format("%16.8E") % estimator(n);
 
    if (endLine)
        (*outFilePtr) << endl;
 
    /* Reset all values */
    reset();
}

Here is the call graph for this function:

outputFlat()

void EstimatorBase::outputFlat ( )

virtual

Output a flat estimator value to disk.

Instead of keeping the individual binned averages, here we reset the output file and write the current average to disk.

Definition at line 305 of file estimator.cpp.

                               {
 
    /* Prepare the position file for writing over old data */
    communicate()->file(label)->reset();
 
    (*outFilePtr) << header;
    if (endLine)
        (*outFilePtr) << endl;
 
    /* Now write the running average of the estimator to disk */
    for (int n = 0; n < numEst; n++) 
        (*outFilePtr) << format("%16.8E\n") % 
            (norm(n)*estimator(n)/totNumAccumulated);
 
    communicate()->file(label)->rename();
}

Here is the call graph for this function:

Here is the caller graph for this function:

prepare()

void EstimatorBase::prepare

(

)

Prepare the estimator for i/o.

Prepare estimator for i/o.

Assign the output file and write a header depending on whether or not we are restarting the simulation.

Definition at line 240 of file estimator.cpp.

                            {
 
    /* Provided that we will perform at least one measurement, open an output
     * file and possibly write a header */
    if (frequency > 0) {
        /* Assign the output file pointer */
        outFilePtr = &(communicate()->file(label)->stream());
 
        /* Write the header to disk if we are not restarting or if this is
         * a new estimator. */
        if (!constants()->restart() || (!communicate()->file(label)->exists())) {
            (*outFilePtr) << header;
            if (endLine)
                (*outFilePtr) << endl;
        }
    }
}

Here is the call graph for this function:

sample()

void EstimatorBase::sample ( )

virtual

Sample the estimator.

Here we simply call accumulate every frequency times sample is called,
depending on whether we are measuring a diagonal or off-diagonal estimator. If frequency == 0, we don't bother to measure it.

Reimplemented in PIGSOneBodyDensityMatrixEstimator, CylinderPairCorrelationEstimator, CylinderOneBodyDensityMatrixEstimator, OneBodyDensityMatrixEstimator, DiagonalFractionEstimator, and TimeEstimator.

Definition at line 187 of file estimator.cpp.

                           {
 
    if (baseSample()) {
        totNumAccumulated++;
        numAccumulated++;
        accumulate();
    }
}

Here is the call graph for this function:

---

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

• include/estimator.h
• src/estimator.cpp