summaryrefslogtreecommitdiff
path: root/src/cython/doc/bottleneck_distance_user.rst
blob: 3bc170f4c6c6ba62b3cbb2872ce76d571e93a8d5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
===============================
Bottleneck distance user manual
===============================
Definition
----------

.. include:: bottleneck_distance_sum.rst

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=" + 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