CopulaInferenceResult

class persalys.CopulaInferenceResult(*args)

Get the results of a dependence inference analysis.

Notes

Structure created by the method run() of CopulaInferenceAnalysis, and obtained thanks to the method getResult().

Methods

getClassName()	Accessor to the object’s name.
getCopulaInferenceSetResult(variablesNames)	Get the result of a set of variables.
getCopulaInferenceSetResultCollection()	Sequence of results accessor.
getDesignOfExperiment()	Design of experiments accessor.
getElapsedTime()	Elapsed time in seconds to perform the analysis.
getId()	Accessor to the object’s id.
getName()	Accessor to the object’s name.
getShadowedId()	Accessor to the object’s shadowed id.
getVisibility()	Accessor to the object’s visibility state.
hasName()	Test if the object is named.
hasVisibleName()	Test if the object has a distinguishable name.
setName(name)	Accessor to the object’s name.
setShadowedId(id)	Accessor to the object’s shadowed id.
setVisibility(visible)	Accessor to the object’s visibility state.

__init__(*args)

getClassName()

Accessor to the object’s name.

Returns:

class_name : str

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

getCopulaInferenceSetResult(variablesNames)

Get the result of a set of variables.

Parameters:

variables : sequence of str

Names of the variables

Returns:

result : CopulaInferenceSetResult

The result of the given set of variables

getCopulaInferenceSetResultCollection()

Sequence of results accessor.

Returns:

results : sequence of CopulaInferenceSetResult

The results of each set of variables

getDesignOfExperiment()

Design of experiments accessor.

Returns:

design : DesignOfExperiment

Design of experiments containing the analysed points

getElapsedTime()

Elapsed time in seconds to perform the analysis.

Returns:

time : double

Elapsed time in seconds to perform the analysis

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.

getShadowedId()

Accessor to the object’s shadowed id.

Returns:

id : int

Internal unique identifier.

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.

setName(name)

Accessor to the object’s name.

Parameters:

name : str

The name of the object.

setShadowedId(id)

Accessor to the object’s shadowed id.

Parameters:

id : int

Internal unique identifier.

setVisibility(visible)

Accessor to the object’s visibility state.

Parameters:

visible : bool

Visibility flag.