Package etomica.modules.multiharmonic.overlap

Class AccumulatorOverlapAverageUa2

java.lang.Object

etomica.modules.multiharmonic.overlap.AccumulatorOverlapAverageUa2

All Implemented Interfaces:

IDataSink

public class AccumulatorOverlapAverageUa2
extends java.lang.Object
implements IDataSink

Accumulator for taking ratio between two sums (and pretend it's an "average") Data added to this accumulator must be a 2-element DataDoubleArray

Field Summary

Fields

Modifier and Type	Field	Description
protected double	alphaCenter
protected double	alphaSpan
protected long	blockCounter
protected long	count

Constructor Summary

Constructors

Constructor	Description
AccumulatorOverlapAverageUa2(int aNBennetPoints, boolean aIsReference)

Method Summary

Modifier and Type	Method	Description
double	getAlphaCenter()
double	getAlphaSpan()
double	getBennetBias(int iParam)	Returns iParam'th factor used in the Bennet sum.
IData	getData()	Implements DataSource interface, but you probably want to getData for a specific Bennet parameter.
int	getNBennetPoints()
double	getUa2(int iParam)	Returns average value of expression used to determine optimal Bennet parameter (value[1]/(value[1]+expX[iParam]).
void	putData(IData value)	Add the given values to the sums and block sums
void	putDataInfo(IDataInfo info)	Informs the DataSink of the type of Data it should expect to receive.
void	reset()	Resets all sums to zero
void	setBennetParam(double aCenter, double aSpan)	sets the range of parameter values used for Bennets method.
void	setNumAlpha(int newNumAlpha)

Methods inherited from class java.lang.Object

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

Field Detail

blockCounter

protected long blockCounter

count

protected long count

alphaCenter

protected double alphaCenter

alphaSpan

protected double alphaSpan

Constructor Detail

AccumulatorOverlapAverageUa2

public AccumulatorOverlapAverageUa2(int aNBennetPoints,
                                    boolean aIsReference)

Method Detail

putDataInfo

public void putDataInfo(IDataInfo info)

Description copied from interface: IDataSink

Informs the DataSink of the type of Data it should expect to receive.

Specified by:

putDataInfo in interface IDataSink

setBennetParam

public void setBennetParam(double aCenter,
                           double aSpan)

sets the range of parameter values used for Bennets method. Default is a span of 5 centered about 1 (exp(-5) to (exp(5)).

Parameters:

aCenter - geometric mean of all values

aSpan - natural log of ratio of max value to aCenter

setNumAlpha

public void setNumAlpha(int newNumAlpha)

getAlphaCenter

public double getAlphaCenter()

getAlphaSpan

public double getAlphaSpan()

putData

public void putData(IData value)

Add the given values to the sums and block sums

Specified by:

putData in interface IDataSink

getNBennetPoints

public int getNBennetPoints()

getBennetBias

public double getBennetBias(int iParam)

Returns iParam'th factor used in the Bennet sum. Higher values indicate the overlap function is more like the 0th value.

getData

public IData getData()

Implements DataSource interface, but you probably want to getData for a specific Bennet parameter.

getUa2

public double getUa2(int iParam)

Returns average value of expression used to determine optimal Bennet parameter (value[1]/(value[1]+expX[iParam]).

reset

public void reset()

Resets all sums to zero