summaryrefslogtreecommitdiff
path: root/src/python/gudhi/bottleneck.cc
diff options
context:
space:
mode:
authorMarc Glisse <marc.glisse@inria.fr>2020-06-05 20:16:38 +0200
committerMarc Glisse <marc.glisse@inria.fr>2020-06-05 20:16:38 +0200
commit82dc35dd749a1f388be268d7a7e3bd22f18afcf7 (patch)
treed057b579dd35c10c2b1dd6b86e24fe9e1d5002cc /src/python/gudhi/bottleneck.cc
parentbea81f2d7bc53876a6f071c919663261314965ab (diff)
Doc changes after Vincent's review
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 732cb9a8..59be6088 100644
--- a/src/python/gudhi/bottleneck.cc
+++ b/src/python/gudhi/bottleneck.cc
@@ -29,7 +29,8 @@ PYBIND11_MODULE(bottleneck, m) {
py::arg("diagram_1"), py::arg("diagram_2"),
py::arg("e") = (std::numeric_limits<double>::min)(),
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)