Package org.anchoranalysis.mpp.bean.proposer

Class ScalarProposer

Object

AnchorBean<ScalarProposer>

InitializableBean<ScalarProposer,NullInitialization>

NullParametersBean<ScalarProposer>

ScalarProposer

public abstract class ScalarProposer
extends NullParametersBean<ScalarProposer>

An abstract base class for proposing scalar values.

Constructor Summary

Constructors

Constructor	Description
ScalarProposer()

Method Summary

Modifier and Type	Method	Description
abstract double	propose(RandomNumberGenerator randomNumberGenerator, Optional<Resolution> resolution)	Proposes a scalar value based on the given parameters.

Methods inherited from class org.anchoranalysis.bean.NullParametersBean

initializeRecursive, onInitialization, onInitialization

Methods inherited from class org.anchoranalysis.bean.initializable.InitializableBean

getInitialization, getLogger, getPropertyInitializer, initialize, initializeRecursive, initRecursiveWithInitializer, isInitialized

Methods inherited from class org.anchoranalysis.bean.AnchorBean

checkMisconfigured, describeBean, describeChildren, duplicateBean, fields, findFieldsOfClass, getBeanName, getLocalPath, localise, toString

Methods inherited from class java.lang.Object

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

Constructor Details

ScalarProposer

public ScalarProposer()

Method Details

propose

public abstract double propose(RandomNumberGenerator randomNumberGenerator,
 Optional<Resolution> resolution)
                        throws OperationFailedException

Proposes a scalar value based on the given parameters.

Parameters:

randomNumberGenerator - a random number generator for any stochastic processes

resolution - an optional resolution to consider when proposing the scalar value

Returns:

the proposed scalar value as a double

Throws:

OperationFailedException - if the proposal operation fails