diff options
| author | tlacombe <lacombe1993@gmail.com> | 2020-01-13 17:30:38 +0100 |
|---|---|---|
| committer | tlacombe <lacombe1993@gmail.com> | 2020-01-13 17:30:38 +0100 |
| commit | cabafa3852c2d325b83593d34f16dfbc2d9eaefb (patch) | |
| tree | 2f4496c5b2e6af613f8f18b0621d875e6fefa72d | |
| parent | e807654f30363ec92c0d24b702bfd081ec8aae5a (diff) | |
fix typo in doc wasserstein_distance with new variables naming conventions.
| -rw-r--r-- | src/python/gudhi/wasserstein.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/src/python/gudhi/wasserstein.py b/src/python/gudhi/wasserstein.py index aef54f64..b6495c80 100644 --- a/src/python/gudhi/wasserstein.py +++ b/src/python/gudhi/wasserstein.py @@ -55,7 +55,7 @@ def _perstot(X, order, internal_p): ''' :param X: (n x 2) numpy.array (points of a given diagram). :param internal_p: Ground metric on the (upper-half) plane (i.e. norm l_p in R^2); Default value is 2 (Euclidean norm). - :param order: exponent for Wasserstein; Default value is 2. + :param order: exponent for Wasserstein. Default value is 2. :returns: float, the total persistence of the diagram (that is, its distance to the empty diagram). ''' Xdiag = _proj_on_diag(X) @@ -68,7 +68,7 @@ def wasserstein_distance(X, Y, order=2., internal_p=2.): :param Y: (m x 2) numpy.array encoding the second diagram. :param internal_p: Ground metric on the (upper-half) plane (i.e. norm l_p in R^2); Default value is 2 (euclidean norm). :param order: exponent for Wasserstein; Default value is 2. - :returns: the q-Wasserstein distance (1 <= q < infinity) with respect to the internal_p-norm as ground metric. + :returns: the Wasserstein distance of order q (1 <= q < infinity) between persistence diagrams with respect to the internal_p-norm as ground metric. :rtype: float ''' n = len(X) |