summaryrefslogtreecommitdiff
path: root/src/python/doc
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-11-16 23:14:08 +0100
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2019-11-16 23:14:08 +0100
commit82b099abf5eec3157f7993a570bab3f9f3f00598 (patch)
tree29a63ac0db56adf09b9cadb115037d5125889755 /src/python/doc
parent5a2c3559da581136edb7facf5578bd1443080ef3 (diff)
parent6c341ffd5500f6393467fce3f5e091afc354d25b (diff)
Merge branch 'master' into alpha_complex_with_cgal_epeck_d
Diffstat (limited to 'src/python/doc')
-rw-r--r--src/python/doc/index.rst4
-rw-r--r--src/python/doc/wasserstein_distance_user.rst8
2 files changed, 6 insertions, 6 deletions
diff --git a/src/python/doc/index.rst b/src/python/doc/index.rst
index 16d918bc..8f27da0d 100644
--- a/src/python/doc/index.rst
+++ b/src/python/doc/index.rst
@@ -23,7 +23,7 @@ Alpha complex
.. include:: alpha_complex_sum.inc
Rips complex
--------------
+------------
.. include:: rips_complex_sum.inc
@@ -74,7 +74,7 @@ Bottleneck distance
.. include:: bottleneck_distance_sum.inc
Wasserstein distance
-===================
+====================
.. include:: wasserstein_distance_sum.inc
diff --git a/src/python/doc/wasserstein_distance_user.rst b/src/python/doc/wasserstein_distance_user.rst
index bcb7f19d..a049cfb5 100644
--- a/src/python/doc/wasserstein_distance_user.rst
+++ b/src/python/doc/wasserstein_distance_user.rst
@@ -3,7 +3,7 @@
.. To get rid of WARNING: document isn't included in any toctree
Wasserstein distance user manual
-===============================
+================================
Definition
----------
@@ -13,7 +13,7 @@ This implementation is based on ideas from "Large Scale Computation of Means and
Function
--------
-.. autofunction:: gudhi.wasserstein_distance
+.. autofunction:: gudhi.wasserstein.wasserstein_distance
Basic example
@@ -24,13 +24,13 @@ Note that persistence diagrams must be submitted as (n x 2) numpy arrays and mus
.. testcode::
- import gudhi
+ import gudhi.wasserstein
import numpy as np
diag1 = np.array([[2.7, 3.7],[9.6, 14.],[34.2, 34.974]])
diag2 = np.array([[2.8, 4.45],[9.5, 14.1]])
- message = "Wasserstein distance value = " + '%.2f' % gudhi.wasserstein_distance(diag1, diag2, q=2., p=1.)
+ message = "Wasserstein distance value = " + '%.2f' % gudhi.wasserstein.wasserstein_distance(diag1, diag2, q=2., p=1.)
print(message)
The output is: