summaryrefslogtreecommitdiff
path: root/src/python/gudhi/bottleneck.cc
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-06-09 19:45:31 +0200
committerGitHub <noreply@github.com>2020-06-09 19:45:31 +0200
commit58f7cd2d1fec9b12665ad10c16b9812eba303570 (patch)
treed68fd29693505e78811db0ff1b9fe052fc11637b /src/python/gudhi/bottleneck.cc
parent434cc66fbf832ca492e5f0710c8afc67d681637a (diff)
parentdacc3e363ded8b68bb4b71c1602e2c52b10b36e5 (diff)
Merge pull request #337 from mglisse/herab
Interface for hera's bottleneck_distance
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)