EstimationStatistic#

class EstimationStatistic(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

A type of estimation statistic used for calculating energy distance.

Methods

from_string(string)

Parse the estimation statistic from a string.

classmethod from_string(string)[source]#

Parse the estimation statistic from a string.

The string is converted to upercase first. Valid values are:
  • "U_STATISTIC" or "U": for the unbiased version.

  • "V_STATISTIC" or "V": for the biased version.

Examples

>>> from dcor import EstimationStatistic
>>>
>>> EstimationStatistic.from_string('u')
<EstimationStatistic.U_STATISTIC: 1>
>>> EstimationStatistic.from_string('V')
<EstimationStatistic.V_STATISTIC: 2>
>>> EstimationStatistic.from_string('V_STATISTIC')
<EstimationStatistic.V_STATISTIC: 2>
>>> EstimationStatistic.from_string('u_statistic')
<EstimationStatistic.U_STATISTIC: 1>
Parameters

string (str) –

Return type

EstimationStatistic