ExpectationSimulationResult

class ExpectationSimulationResult(*args)

Expectation simulation result.

Gathers the results of a ExpectationSimulationAlgorithm algorithm.

See also

ExpectationSimulationAlgorithm

Methods

getBlockSize(self)	Accessor to the block size.
getClassName(self)	Accessor to the object’s name.
getCoefficientOfVariation(self)	Accessor to the expectation distribution.
getExpectationDistribution(self)	Accessor to the expectation distribution.
getExpectationEstimate(self)	Accessor to the expectation estimate.
getId(self)	Accessor to the object’s id.
getName(self)	Accessor to the object’s name.
getOuterSampling(self)	Accessor to the outer sampling.
getRandomVector(self)	Accessor to the random variable.
getShadowedId(self)	Accessor to the object’s shadowed id.
getStandardDeviation(self)	Accessor to the expectation distribution.
getVarianceEstimate(self)	Accessor to the variance estimate.
getVisibility(self)	Accessor to the object’s visibility state.
hasName(self)	Test if the object is named.
hasVisibleName(self)	Test if the object has a distinguishable name.
setBlockSize(self, blockSize)	Accessor to the block size.
setExpectationEstimate(self, expectationEstimate)	Accessor to the expectation estimate.
setName(self, name)	Accessor to the object’s name.
setOuterSampling(self, outerSampling)	Accessor to the outer sampling.
setRandomVector(self, randomVector)	Accessor to the random variable.
setShadowedId(self, id)	Accessor to the object’s shadowed id.
setVarianceEstimate(self, varianceEstimate)	Accessor to the variance estimate.
setVisibility(self, visible)	Accessor to the object’s visibility state.

__init__(self, \*args)

Initialize self. See help(type(self)) for accurate signature.

getBlockSize(self)

Accessor to the block size.

Returns

blockSizeint

Number of terms in the probability simulation estimator grouped together.

getClassName(self)

Accessor to the object’s name.

Returns

class_namestr

The object class name (object.__class__.__name__).

getCoefficientOfVariation(self)

Accessor to the expectation distribution.

Returns

coefficientOfVariationPoint

Coefficient of variation.

getExpectationDistribution(self)

Accessor to the expectation distribution.

Returns

expectationEstimateDistribution

Distribution of the expectation.

getExpectationEstimate(self)

Accessor to the expectation estimate.

Returns

expectationEstimatePoint

Estimate of the expectation.

getId(self)

Accessor to the object’s id.

Returns

idint

Internal unique identifier.

getName(self)

Accessor to the object’s name.

Returns

namestr

The name of the object.

getOuterSampling(self)

Accessor to the outer sampling.

Returns

outerSamplingint

Number of groups of terms in the probability simulation estimator.

getRandomVector(self)

Accessor to the random variable.

Returns

eventRandomVector

Random variable we want to study.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns

idint

Internal unique identifier.

getStandardDeviation(self)

Accessor to the expectation distribution.

Returns

standardDeviationPoint

Standard deviation.

getVarianceEstimate(self)

Accessor to the variance estimate.

Returns

expectationEstimatePoint

Estimate of the variance.

getVisibility(self)

Accessor to the object’s visibility state.

Returns

visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns

hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns

hasVisibleNamebool

True if the name is not empty and not the default one.

setBlockSize(self, blockSize)

Accessor to the block size.

Parameters

blockSizeint,

Number of terms in the probability simulation estimator grouped together.

setExpectationEstimate(self, expectationEstimate)

Accessor to the expectation estimate.

Parameters

expectationEstimatePoint

Estimate of the expectation.

setName(self, name)

Accessor to the object’s name.

Parameters

namestr

The name of the object.

setOuterSampling(self, outerSampling)

Accessor to the outer sampling.

Parameters

outerSamplingint,

Number of groups of terms in the probability simulation estimator.

setRandomVector(self, randomVector)

Accessor to the random variable.

Parameters

eventRandomVector

Random variable we want to study.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters

idint

Internal unique identifier.

setVarianceEstimate(self, varianceEstimate)

Accessor to the variance estimate.

Parameters

expectationEstimatePoint

Estimate of the variance.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters

visiblebool

Visibility flag.