diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-06-06 14:36:36 +0200 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-06-06 14:36:36 +0200 |
| commit | 90198a22800834acd333f9b8360221035f6862cf (patch) | |
| tree | c3bfaedfb2d0886bacbc1a2a68177533f3ee3d38 /src/Bottleneck_distance/include/gudhi/Bottleneck.h | |
| parent | 30fac00a3aee2f26aa44e62eb923af733c4f3bc7 (diff) | |
Fix #11 - Distance computation shall be better documented.
Diffstat (limited to 'src/Bottleneck_distance/include/gudhi/Bottleneck.h')
| -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. |