HSICStat¶
- class HSICStat(*args)¶
Base class of HSICStat.
Notes
This is a base class for the implementation of an HSIC statistic but cannot be used by itself. An HSIC statistic object can be created by using the derived classes:
HSICUStat
andHSICVStat
.Methods
computeHSICIndex
(*args)Compute the HSIC index between two samples.
computePValue
(distribution, n, HSICObs, mHSIC)Compute the p-value of the statistic.
Accessor to the object's name.
getId
()Accessor to the object's id.
Accessor to the underlying implementation.
getName
()Accessor to the object's name.
Indicate the compatibility with a conditional HSIC estimator.
setName
(name)Accessor to the object's name.
- __init__(*args)¶
- computeHSICIndex(*args)¶
Compute the HSIC index between two samples.
- Parameters:
- covarianceMatrixX
CovarianceMatrix
The xi-covariance model discretized over the input marginal sample xi.
- covarianceMatrixY
CovarianceMatrix
The covariance model associated with the output sample, discretized over the last one.
- weights
Point
orMatrix
(deprecated) The weight argument used for the statistic.
- covarianceMatrixX
- Returns:
- hsicIndexthe HSIC index of the two
Sample
.
- hsicIndexthe HSIC index of the two
- computePValue(distribution, n, HSICObs, mHSIC)¶
Compute the p-value of the statistic.
- getClassName()¶
Accessor to the object’s name.
- Returns:
- class_namestr
The object class name (object.__class__.__name__).
- getId()¶
Accessor to the object’s id.
- Returns:
- idint
Internal unique identifier.
- getImplementation()¶
Accessor to the underlying implementation.
- Returns:
- implImplementation
A copy of the underlying implementation object.
- getName()¶
Accessor to the object’s name.
- Returns:
- namestr
The name of the object.
- isCompatibleWithConditionalAnalysis()¶
Indicate the compatibility with a conditional HSIC estimator.
- Returns:
- isCompatiblebool
Indicate the compatibility with a conditional HSIC estimator.
- setName(name)¶
Accessor to the object’s name.
- Parameters:
- namestr
The name of the object.