diff options
author | Vincent Rouvreau <VincentRouvreau@users.noreply.github.com> | 2019-06-13 09:32:41 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-06-13 09:32:41 +0200 |
commit | f9a2172f24da8d7538c67fbf4e7580ab09b456c5 (patch) | |
tree | 00929e00513e0780d955aea8c3230d8ba543ac2c /src/Bottleneck_distance/include | |
parent | db3f192fbc3ea8b47b208563735ef0958e7adab9 (diff) | |
parent | 48d625be3d6ee81bc3bc785276dcb32721cc7417 (diff) |
Merge pull request #69 from VincentRouvreau/bottleneck_documentation
Bottleneck documentation
Diffstat (limited to 'src/Bottleneck_distance/include')
-rw-r--r-- | src/Bottleneck_distance/include/gudhi/Bottleneck.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/src/Bottleneck_distance/include/gudhi/Bottleneck.h b/src/Bottleneck_distance/include/gudhi/Bottleneck.h index 7a553006..4ce6cacc 100644 --- a/src/Bottleneck_distance/include/gudhi/Bottleneck.h +++ b/src/Bottleneck_distance/include/gudhi/Bottleneck.h @@ -6,6 +6,9 @@ * * Copyright (C) 2015 Inria * + * Modifications: + * - 2019/06 Vincent Rouvreau : Fix doxygen warning. + * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or @@ -92,6 +95,10 @@ inline double bottleneck_distance_exact(Persistence_graph& g) { * * \tparam Persistence_diagram1,Persistence_diagram2 * models of the concept `PersistenceDiagram`. + * + * \param[in] diag1 The first persistence diagram. + * \param[in] diag2 The second persistence diagram. + * * \param[in] e * \parblock * If `e` is 0, this uses an expensive algorithm to compute the exact distance. |