diff options
Diffstat (limited to 'src/cython/doc')
| -rw-r--r-- | src/cython/doc/bottleneck_distance_ref.rst | 5 | ||||
| -rw-r--r-- | src/cython/doc/bottleneck_distance_sum.rst | 15 | ||||
| -rw-r--r-- | src/cython/doc/bottleneck_distance_user.rst | 37 | ||||
| -rw-r--r-- | src/cython/doc/index.rst | 5 |
4 files changed, 62 insertions, 0 deletions
diff --git a/src/cython/doc/bottleneck_distance_ref.rst b/src/cython/doc/bottleneck_distance_ref.rst new file mode 100644 index 00000000..7f816cd6 --- /dev/null +++ b/src/cython/doc/bottleneck_distance_ref.rst @@ -0,0 +1,5 @@ +=========================== +Bottleneck reference manual +=========================== + +.. automethod:: gudhi.bottleneck_distance diff --git a/src/cython/doc/bottleneck_distance_sum.rst b/src/cython/doc/bottleneck_distance_sum.rst new file mode 100644 index 00000000..6cffa122 --- /dev/null +++ b/src/cython/doc/bottleneck_distance_sum.rst @@ -0,0 +1,15 @@ +===================================== ===================================== ===================================== +:Author: Francois Godi :Introduced in: GUDHI 1.4.0 :Copyright: GPL v3 +===================================== ===================================== ===================================== +:Requires: CGAL ≥ 4.8.0 +===================================== ===================================== ===================================== + ++-------------------------------------------+----------------------------------------------------------------------+ +| .. image:: | Bottleneck distance measures the similarity between two persistence | +| img/perturb_pd.png | diagrams. It's the shortest distance b for which there exists a | +| | perfect matching between the points of the two diagrams (+ all the | +| | diagonal points) such that any couple of matched points are at | +| | distance at most b. | ++-------------------------------------------+----------------------------------------------------------------------+ +| :doc:`bottleneck_distance_user` | :doc:`bottleneck_distance_ref` | ++-------------------------------------------+----------------------------------------------------------------------+ diff --git a/src/cython/doc/bottleneck_distance_user.rst b/src/cython/doc/bottleneck_distance_user.rst new file mode 100644 index 00000000..08c6e451 --- /dev/null +++ b/src/cython/doc/bottleneck_distance_user.rst @@ -0,0 +1,37 @@ +=============================== +Bottleneck distance user manual +=============================== +Definition +---------- + +.. include:: bottleneck_distance_sum.rst + +Function +-------- +.. automethod:: gudhi.bottleneck_distance + + +Basic example +------------- + +This example computes the bottleneck distance from 2 persistence diagrams: + +.. testcode:: + + import gudhi + + diag1 = [[2.7, 3.7],[9.6, 14.],[34.2, 34.974], [3.,float('Inf')]] + diag2 = [[2.8, 4.45],[9.5, 14.1],[3.2,float('Inf')]] + + message = "Bottleneck distance approximation=" + repr(gudhi.bottleneck_distance(diag1, diag2, 0.1)) + print(message) + + message = "Bottleneck distance exact value=" + repr(gudhi.bottleneck_distance(diag1, diag2)) + print(message) + +The output is: + +.. testoutput:: + + Bottleneck distance approximation=0.8081763781405569 + Bottleneck distance exact value=0.75 diff --git a/src/cython/doc/index.rst b/src/cython/doc/index.rst index 91e31ff6..de90cf7c 100644 --- a/src/cython/doc/index.rst +++ b/src/cython/doc/index.rst @@ -62,6 +62,11 @@ Witness complex Toolbox ******* +Bottleneck distance +=================== + +.. include:: bottleneck_distance_sum.rst + Persistence cohomology ====================== |