From fee58180eb9e2617f92e2f92bb6d1120348f310f Mon Sep 17 00:00:00 2001
From: vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>
Date: Fri, 27 Jan 2017 17:10:54 +0000
Subject: Add bottleneck distance

git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/ST_cythonize@2019 636b058d-ea47-450e-bf9e-a15bfbe3eedb

Former-commit-id: 1320379f3d41ef4d11326c1aad1dd20469d3f4e0
---
 src/cython/doc/bottleneck_distance_user.rst | 37 +++++++++++++++++++++++++++++
 1 file changed, 37 insertions(+)
 create mode 100644 src/cython/doc/bottleneck_distance_user.rst

(limited to 'src/cython/doc/bottleneck_distance_user.rst')

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
-- 
cgit v1.2.3