summaryrefslogtreecommitdiff
path: root/src/python/gudhi/bottleneck.cc
diff options
context:
space:
mode:
Diffstat (limited to 'src/python/gudhi/bottleneck.cc')
-rw-r--r--src/python/gudhi/bottleneck.cc3
1 files changed, 2 insertions, 1 deletions
diff --git a/src/python/gudhi/bottleneck.cc b/src/python/gudhi/bottleneck.cc
index 838bf9eb..8a3d669a 100644
--- a/src/python/gudhi/bottleneck.cc
+++ b/src/python/gudhi/bottleneck.cc
@@ -33,7 +33,8 @@ PYBIND11_MODULE(bottleneck, m) {
py::arg("diagram_1"), py::arg("diagram_2"),
py::arg("e") = py::none(),
R"pbdoc(
- This function returns the point corresponding to a given vertex.
+ Compute the Bottleneck distance between two diagrams.
+ Points at infinity and on the diagonal are supported.
:param diagram_1: The first diagram.
:type diagram_1: numpy array of shape (m,2)