diff options
Diffstat (limited to 'cython/doc/bottleneck_distance_user.rst')
| -rw-r--r-- | cython/doc/bottleneck_distance_user.rst | 40 |
1 files changed, 0 insertions, 40 deletions
diff --git a/cython/doc/bottleneck_distance_user.rst b/cython/doc/bottleneck_distance_user.rst deleted file mode 100644 index 605db022..00000000 --- a/cython/doc/bottleneck_distance_user.rst +++ /dev/null @@ -1,40 +0,0 @@ -:orphan: - -.. To get rid of WARNING: document isn't included in any toctree - -Bottleneck distance user manual -=============================== -Definition ----------- - -.. include:: bottleneck_distance_sum.inc - -Function --------- -.. autofunction:: 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=" + '%.2f' % gudhi.bottleneck_distance(diag1, diag2, 0.1) - print(message) - - message = "Bottleneck distance value=" + '%.2f' % gudhi.bottleneck_distance(diag1, diag2) - print(message) - -The output is: - -.. testoutput:: - - Bottleneck distance approximation=0.81 - Bottleneck distance value=0.75 |