Package etomica.integrator.mcmove

Class MCMoveTracker

java.lang.Object

etomica.integrator.mcmove.MCMoveTracker

Direct Known Subclasses:

MCMoveStepTracker

public class MCMoveTracker
extends java.lang.Object

This class is responsible for tracking acceptance statistics for an MCMove. The acceptance ratio and probability can be retrieved. This class has no effect on the MCMove.

Field Summary

Fields

Modifier and Type	Field	Description
protected double	chiSum
long	nAccept
long	nTrials

Constructor Summary

Constructors

Constructor	Description
MCMoveTracker()

Method Summary

Modifier and Type	Method	Description
double	acceptanceProbability()	Returns the average probability of accepting the move associated with this tracker.
double	acceptanceRatio()	Returns the fraction of accepted trials of the move associated with this tracker.
void	reset()
void	updateCounts(boolean moveWasAccepted, double chi)	Updates statistics regarding the acceptance rate of this move.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

nTrials

public long nTrials

nAccept

public long nAccept

chiSum

protected double chiSum

Constructor Detail

MCMoveTracker

public MCMoveTracker()

Method Detail

updateCounts

public void updateCounts(boolean moveWasAccepted,
                         double chi)

Updates statistics regarding the acceptance rate of this move. This method should only be called by the Integrator after a move has been accepted or rejected.

Parameters:

moveWasAccepted - indicates whether the most recently attempted move was accepted

chi - indicates the probability with which the MC move was accepted.

acceptanceRatio

public double acceptanceRatio()

Returns the fraction of accepted trials of the move associated with this tracker.

acceptanceProbability

public double acceptanceProbability()

Returns the average probability of accepting the move associated with this tracker.

reset

public void reset()