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(self)

Accessor to the object’s name.

getCopulaInferenceSetResult(self, variablesNames)

Get the result of a set of variables.

getCopulaInferenceSetResultCollection(self)

Sequence of results accessor.

getDesignOfExperiment(self)

Design of experiments accessor.

getElapsedTime(self)

Elapsed time in seconds to perform the analysis.

getId(self)

Accessor to the object’s id.

getName(self)

Accessor to the object’s name.

getShadowedId(self)

Accessor to the object’s shadowed id.

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.

setName(self, name)

Accessor to the object’s name.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.

__init__(self, *args)

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

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

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

getCopulaInferenceSetResult(self, variablesNames)

Get the result of a set of variables.

Parameters
variablessequence of str

Names of the variables

Returns
resultCopulaInferenceSetResult

The result of the given set of variables

getCopulaInferenceSetResultCollection(self)

Sequence of results accessor.

Returns
resultssequence of CopulaInferenceSetResult

The results of each set of variables

getDesignOfExperiment(self)

Design of experiments accessor.

Returns
designDesignOfExperiment

Design of experiments containing the analysed points

getElapsedTime(self)

Elapsed time in seconds to perform the analysis.

Returns
timedouble

Elapsed time in seconds to perform the analysis

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.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

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.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.