summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-05-07 08:40:55 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-05-07 08:40:55 +0200
commitd61bfd349274456f8d7e0ccd64839a2d84eea0a0 (patch)
tree6d6d0f845dd11150b182e02f940fedae75c2fdf4
parent47e5ac79af3a354358515c0213b28848f878fde6 (diff)
doc
-rw-r--r--src/python/gudhi/bottleneck.cc5
1 files changed, 2 insertions, 3 deletions
diff --git a/src/python/gudhi/bottleneck.cc b/src/python/gudhi/bottleneck.cc
index 577e5e0b..732cb9a8 100644
--- a/src/python/gudhi/bottleneck.cc
+++ b/src/python/gudhi/bottleneck.cc
@@ -32,9 +32,9 @@ PYBIND11_MODULE(bottleneck, m) {
This function returns the point corresponding to a given vertex.
:param diagram_1: The first diagram.
- :type diagram_1: vector[pair[double, double]]
+ :type diagram_1: numpy array of shape (m,2)
:param diagram_2: The second diagram.
- :type diagram_2: vector[pair[double, double]]
+ :type diagram_2: numpy array of shape (n,2)
:param e: If `e` is 0, this uses an expensive algorithm to compute the
exact distance.
If `e` is not 0, it asks for an additive `e`-approximation, and
@@ -42,7 +42,6 @@ PYBIND11_MODULE(bottleneck, m) {
bits of the mantissa may be wrong). This version of the algorithm takes
advantage of the limited precision of `double` and is usually a lot
faster to compute, whatever the value of `e`.
-
Thus, by default, `e` is the smallest positive double.
:type e: float
:rtype: float