Package etomica.data

Class DataSourceAcceptanceProbability

java.lang.Object

etomica.data.DataSourceScalar

etomica.data.DataSourceAcceptanceRatio

etomica.data.DataSourceAcceptanceProbability

All Implemented Interfaces:

IDataSource

public class DataSourceAcceptanceProbability
extends DataSourceAcceptanceRatio

Data source giving the average acceptance probability of MCMove type moves. Returns acceptance probability as kept by the MCMove.

Field Summary

Fields inherited from class etomica.data.DataSourceAcceptanceRatio

move

Fields inherited from class etomica.data.DataSourceScalar

data, dataInfo, tag

Constructor Summary

Constructors

Constructor	Description
DataSourceAcceptanceProbability()	Constructs with no MCMove specified.
DataSourceAcceptanceProbability(MCMove move)

Method Summary

Modifier and Type	Method	Description
Unit	defaultIOUnit()
double	getDataAsScalar()	Returns the value of the acceptance ratios as currently kept by the MCMove classes identified with setMove.

Methods inherited from class etomica.data.DataSourceAcceptanceRatio

getMove, setMove

Methods inherited from class etomica.data.DataSourceScalar

getData, getDataDouble, getDataInfo, getTag

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSourceAcceptanceProbability

public DataSourceAcceptanceProbability()

Constructs with no MCMove specified. Calls to getDataAsScalar will return Double.NaN until an MCMove is specified.

DataSourceAcceptanceProbability

public DataSourceAcceptanceProbability(MCMove move)

Method Detail

defaultIOUnit

public Unit defaultIOUnit()

Overrides:

defaultIOUnit in class DataSourceAcceptanceRatio

Returns:

Decimal.UNIT

getDataAsScalar

public double getDataAsScalar()

Returns the value of the acceptance ratios as currently kept by the MCMove classes identified with setMove. Each element of the returned array applies to the corresponding element in the MCMove array.

Overrides:

getDataAsScalar in class DataSourceAcceptanceRatio