ExpectationSimulationResult

class ExpectationSimulationResult(*args)

Expectation simulation result.

Gathers the results of a ExpectationSimulationAlgorithm algorithm.

Methods

getBlockSize()	Accessor to the block size.
getClassName()	Accessor to the object's name.
getCoefficientOfVariation()	Accessor to the coefficient of variation of the estimator of the expectation.
getExpectationDistribution()	Accessor to the distribution of the estimator of the expectation.
getExpectationEstimate()	Accessor to the expectation estimate.
getName()	Accessor to the object's name.
getOuterSampling()	Accessor to the outer sampling.
getRandomVector()	Accessor to the random variable.
getStandardDeviation()	Accessor to the standard deviation of the estimator of the expectation.
getTimeDuration()	Accessor to the elapsed time.
getVarianceEstimate()	Accessor to the variance of the estimator of the expectation.
hasName()	Test if the object is named.
setBlockSize(blockSize)	Accessor to the block size.
setExpectationEstimate(expectationEstimate)	Accessor to the expectation estimate.
setName(name)	Accessor to the object's name.
setOuterSampling(outerSampling)	Accessor to the outer sampling.
setRandomVector(randomVector)	Accessor to the random variable.
setTimeDuration(time)	Accessor to the elapsed time.
setVarianceEstimate(varianceEstimate)	Accessor to the variance of the estimator of the expectation.

See also

ExpectationSimulationAlgorithm

__init__(*args)

getBlockSize()

Accessor to the block size.

Returns:

blockSizeint

Number of terms in the probability simulation estimator grouped together.

getClassName()

Accessor to the object’s name.

Returns:

class_namestr

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

getCoefficientOfVariation()

Accessor to the coefficient of variation of the estimator of the expectation.

Returns:

coefficientOfVariationPoint

Coefficient of variation of the estimator of the expectation.

getExpectationDistribution()

Accessor to the distribution of the estimator of the expectation.

Returns:

expectationDistributionDistribution

Distribution of the estimator of the expectation.

getExpectationEstimate()

Accessor to the expectation estimate.

Returns:

expectationEstimatePoint

Estimate of the expectation.

getName()

Accessor to the object’s name.

Returns:

namestr

The name of the object.

getOuterSampling()

Accessor to the outer sampling.

Returns:

outerSamplingint

Number of groups of terms in the probability simulation estimator.

getRandomVector()

Accessor to the random variable.

Returns:

randomVectorRandomVector

Random vector we want to study.

getStandardDeviation()

Accessor to the standard deviation of the estimator of the expectation.

Returns:

standardDeviationPoint

Standard deviation of the estimator of the expectation.

getTimeDuration()

Accessor to the elapsed time.

Returns:

timefloat

Simulation duration in seconds

getVarianceEstimate()

Accessor to the variance of the estimator of the expectation.

Returns:

varianceEstimatePoint

Estimate of the variance of the estimator of the expectation.

hasName()

Test if the object is named.

Returns:

hasNamebool

True if the name is not empty.

setBlockSize(blockSize)

Accessor to the block size.

Parameters:

blockSizeint,

Number of terms in the probability simulation estimator grouped together.

setExpectationEstimate(expectationEstimate)

Accessor to the expectation estimate.

Parameters:

expectationEstimatePoint

Estimate of the expectation.

setName(name)

Accessor to the object’s name.

Parameters:

namestr

The name of the object.

setOuterSampling(outerSampling)

Accessor to the outer sampling.

Parameters:

outerSamplingint,

Number of groups of terms in the probability simulation estimator.

setRandomVector(randomVector)

Accessor to the random variable.

Parameters:

randomVectorRandomVector

Random vector we want to study.

setTimeDuration(time)

Accessor to the elapsed time.

Parameters:

timefloat

Simulation duration in seconds

setVarianceEstimate(varianceEstimate)

Accessor to the variance of the estimator of the expectation.

Parameters:

varianceEstimatePoint

Estimate of the variance.

Examples using the class

Analyse the central tendency of a cantilever beam

Analyse the central tendency of a cantilever beam

Evaluate the mean of a random vector by simulations

Evaluate the mean of a random vector by simulations

Gaussian Process Regression: propagate uncertainties

Gaussian Process Regression: propagate uncertainties