SobolSimulationResult

class SobolSimulationResult(*args)

Sobol simulation result.

Gathers the results of a SobolSimulationAlgorithm algorithm.

Methods

getBlockSize(self)

Accessor to the block size.

getClassName(self)

Accessor to the object’s name.

getFirstOrderIndicesDistribution(self)

Accessor to the first order indices distribution.

getFirstOrderIndicesEstimate(self)

Accessor to the first order indices estimate.

getId(self)

Accessor to the object’s id.

getName(self)

Accessor to the object’s name.

getOuterSampling(self)

Accessor to the outer sampling.

getShadowedId(self)

Accessor to the object’s shadowed id.

getTotalOrderIndicesDistribution(self)

Accessor to the total order indices distribution.

getTotalOrderIndicesEstimate(self)

Accessor to the total order indices 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.

setFirstOrderIndicesDistribution(self, …)

Accessor to the first order indices distribution.

setName(self, name)

Accessor to the object’s name.

setOuterSampling(self, outerSampling)

Accessor to the outer sampling.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setTotalOrderIndicesDistribution(self, …)

Accessor to the total order indices distribution.

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__).

getFirstOrderIndicesDistribution(self)

Accessor to the first order indices distribution.

Returns
distributionDistribution

Distribution of the first order indices.

getFirstOrderIndicesEstimate(self)

Accessor to the first order indices estimate.

Returns
estimatePoint

Estimate of the first order indices.

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.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getTotalOrderIndicesDistribution(self)

Accessor to the total order indices distribution.

Returns
distributionDistribution

Distribution of the total order indices.

getTotalOrderIndicesEstimate(self)

Accessor to the total order indices estimate.

Returns
estimatePoint

Estimate of the total order indices.

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, blockSize \geq 0

Number of terms in the probability simulation estimator grouped together.

setFirstOrderIndicesDistribution(self, firstOrderIndicesDistribution)

Accessor to the first order indices distribution.

Parameters
distributionDistribution

Distribution of the first order indices.

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, outerSampling \geq 0

Number of groups of terms in the probability simulation estimator.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setTotalOrderIndicesDistribution(self, totalOrderIndicesDistribution)

Accessor to the total order indices distribution.

Parameters
distributionDistribution

Distribution of the total order indices.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.