SobolSimulationResult

class SobolSimulationResult(*args)

Sobol simulation result.

Gathers the results of a SobolSimulationAlgorithm algorithm.

Methods

getBlockSize() Accessor to the block size.
getClassName() Accessor to the object’s name.
getFirstOrderIndicesDistribution() Accessor to the first order indices distribution.
getFirstOrderIndicesEstimate() Accessor to the first order indices estimate.
getId() Accessor to the object’s id.
getName() Accessor to the object’s name.
getOuterSampling() Accessor to the outer sampling.
getShadowedId() Accessor to the object’s shadowed id.
getTotalOrderIndicesDistribution() Accessor to the total order indices distribution.
getTotalOrderIndicesEstimate() Accessor to the total order indices estimate.
getVisibility() Accessor to the object’s visibility state.
hasName() Test if the object is named.
hasVisibleName() Test if the object has a distinguishable name.
setBlockSize(blockSize) Accessor to the block size.
setFirstOrderIndicesDistribution(…) Accessor to the first order indices distribution.
setName(name) Accessor to the object’s name.
setOuterSampling(outerSampling) Accessor to the outer sampling.
setShadowedId(id) Accessor to the object’s shadowed id.
setTotalOrderIndicesDistribution(…) Accessor to the total order indices distribution.
setVisibility(visible) Accessor to the object’s visibility state.
__init__(*args)

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

getBlockSize()

Accessor to the block size.

Returns:
blockSize : int

Number of terms in the probability simulation estimator grouped together.

getClassName()

Accessor to the object’s name.

Returns:
class_name : str

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

getFirstOrderIndicesDistribution()

Accessor to the first order indices distribution.

Returns:
distribution : Distribution

Distribution of the first order indices.

getFirstOrderIndicesEstimate()

Accessor to the first order indices estimate.

Returns:
estimate : Point

Estimate of the first order indices.

getId()

Accessor to the object’s id.

Returns:
id : int

Internal unique identifier.

getName()

Accessor to the object’s name.

Returns:
name : str

The name of the object.

getOuterSampling()

Accessor to the outer sampling.

Returns:
outerSampling : int

Number of groups of terms in the probability simulation estimator.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:
id : int

Internal unique identifier.

getTotalOrderIndicesDistribution()

Accessor to the total order indices distribution.

Returns:
distribution : Distribution

Distribution of the total order indices.

getTotalOrderIndicesEstimate()

Accessor to the total order indices estimate.

Returns:
estimate : Point

Estimate of the total order indices.

getVisibility()

Accessor to the object’s visibility state.

Returns:
visible : bool

Visibility flag.

hasName()

Test if the object is named.

Returns:
hasName : bool

True if the name is not empty.

hasVisibleName()

Test if the object has a distinguishable name.

Returns:
hasVisibleName : bool

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

setBlockSize(blockSize)

Accessor to the block size.

Parameters:
blockSize : int, blockSize \geq 0

Number of terms in the probability simulation estimator grouped together.

setFirstOrderIndicesDistribution(firstOrderIndicesDistribution)

Accessor to the first order indices distribution.

Parameters:
distribution : Distribution

Distribution of the first order indices.

setName(name)

Accessor to the object’s name.

Parameters:
name : str

The name of the object.

setOuterSampling(outerSampling)

Accessor to the outer sampling.

Parameters:
outerSampling : int, outerSampling \geq 0

Number of groups of terms in the probability simulation estimator.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:
id : int

Internal unique identifier.

setTotalOrderIndicesDistribution(totalOrderIndicesDistribution)

Accessor to the total order indices distribution.

Parameters:
distribution : Distribution

Distribution of the total order indices.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:
visible : bool

Visibility flag.