summaryrefslogtreecommitdiff
path: root/src/python/doc/wasserstein_distance_sum.inc
diff options
context:
space:
mode:
authortlacombe <lacombe1993@gmail.com>2020-03-31 11:21:27 +0200
committertlacombe <lacombe1993@gmail.com>2020-03-31 11:21:27 +0200
commit4cdc7f03fb5917134ba8886b026c8990f56bcfeb (patch)
tree5541f1e51ac12cdce0de8e9cb3199dcc8cff5449 /src/python/doc/wasserstein_distance_sum.inc
parent889d7c92e9cdbab28eba53a9de38a7a0fb27688d (diff)
merged doc from barycenters to wasserstein distance
Diffstat (limited to 'src/python/doc/wasserstein_distance_sum.inc')
-rw-r--r--src/python/doc/wasserstein_distance_sum.inc10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/python/doc/wasserstein_distance_sum.inc b/src/python/doc/wasserstein_distance_sum.inc
index a97f428d..09424de2 100644
--- a/src/python/doc/wasserstein_distance_sum.inc
+++ b/src/python/doc/wasserstein_distance_sum.inc
@@ -3,11 +3,11 @@
+-----------------------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------+
| .. figure:: | The q-Wasserstein distance measures the similarity between two | :Author: Theo Lacombe |
- | ../../doc/Bottleneck_distance/perturb_pd.png | persistence diagrams. It's the minimum value c that can be achieved | |
- | :figclass: align-center | by a perfect matching between the points of the two diagrams (+ all | :Introduced in: GUDHI 3.1.0 |
- | | diagonal points), where the value of a matching is defined as the | |
- | Wasserstein distance is the q-th root of the sum of the | q-th root of the sum of all edge lengths to the power q. Edge lengths| :Copyright: MIT |
- | edge lengths to the power q. | are measured in norm p, for :math:`1 \leq p \leq \infty`. | |
+ | ../../doc/Bottleneck_distance/perturb_pd.png | persistence diagrams using the sum of all edges lengths (instead of | |
+ | :figclass: align-center | the maximum). It allows to define sophisticated objects such as | :Introduced in: GUDHI 3.1.0 |
+ | | barycenters of a family of persistence diagrams. | |
+ | Wasserstein distance is the q-th root of the sum of the | | :Copyright: MIT |
+ | edge lengths to the power q. | | |
| | | :Requires: Python Optimal Transport (POT) :math:`\geq` 0.5.1 |
+-----------------------------------------------------------------+----------------------------------------------------------------------+------------------------------------------------------------------+
| * :doc:`wasserstein_distance_user` | |