summaryrefslogtreecommitdiff
path: root/src/python/gudhi/hera
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/hera
parentbea81f2d7bc53876a6f071c919663261314965ab (diff)
Doc changes after Vincent's review
Diffstat (limited to 'src/python/gudhi/hera')
-rw-r--r--src/python/gudhi/hera/bottleneck.cc3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/python/gudhi/hera/bottleneck.cc b/src/python/gudhi/hera/bottleneck.cc
index 846a3525..0cb562ce 100644
--- a/src/python/gudhi/hera/bottleneck.cc
+++ b/src/python/gudhi/hera/bottleneck.cc
@@ -40,6 +40,9 @@ PYBIND11_MODULE(bottleneck, m) {
Compute the Bottleneck distance between two diagrams.
Points at infinity are supported.
+ .. note::
+ Points on the diagonal are not supported and must be filtered out before calling this function.
+
Parameters:
X (n x 2 numpy array): First diagram
Y (n x 2 numpy array): Second diagram