SensitivityBenchmarkProblem

class SensitivityBenchmarkProblem(name, distribution, function, firstOrderIndices, totalOrderIndices)

Methods

getFirstOrderIndices()	Returns the first order Sobol' sensitivity indices.
getFunction()	Returns the function.
getInputDistribution()	Returns the input distribution.
getName()	Returns the name of the problem.
getTotalOrderIndices()	Returns the total order Sobol' sensitivity indices.

__init__(name, distribution, function, firstOrderIndices, totalOrderIndices)

Creates a reliability problem.

Parameters:

namestr

The name of the benchmark problem. This is a short string, typically less than a dozen of caracters.

distributionot.Distribution

The input distribution.

functionot.Function

The model.

firstOrderIndicesot.Point

The first order indices.

totalOrderIndicesot.Point

The total order indices.

Examples

>>> import otbenchmark as otb
>>> problem = otb.SensitivityBenchmarkProblem(name, distribution, function,
...     firstOrderIndices, totalOrderIndices)  

getFirstOrderIndices()

Returns the first order Sobol’ sensitivity indices.

Parameters:

None.

Returns:

firstOrderIndices: ot.Point

The first order sensitivity indices.

getFunction()

Returns the function.

Parameters:

None.

Returns:

function: ot.Function

The function.

getInputDistribution()

Returns the input distribution.

Parameters:

None.

Returns:

distribution: ot.Distribution

The distribution.

getName()

Returns the name of the problem.

Parameters:

None.

Returns:

name: str

The name.

getTotalOrderIndices()

Returns the total order Sobol’ sensitivity indices.

Parameters:

None.

Returns:

totalOrderIndices: ot.Point

The total order sensitivity indices.