diff options
| author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-03-23 12:14:07 +0100 |
|---|---|---|
| committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-03-23 12:14:07 +0100 |
| commit | 59585b27d83f3835f46a47c90c732bdb2a19d376 (patch) | |
| tree | 8e690290b2984160356ebf8779882cd7710a6058 /src/Alpha_complex/include/gudhi/Alpha_complex.h | |
| parent | cd47fa8e718f6ede07aead032d524022bd68b608 (diff) | |
Doc review: document what is the filtration value when not computed
Diffstat (limited to 'src/Alpha_complex/include/gudhi/Alpha_complex.h')
| -rw-r--r-- | src/Alpha_complex/include/gudhi/Alpha_complex.h | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h index 65c969d2..1b5d6997 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h @@ -259,7 +259,8 @@ class Alpha_complex { * `true`. * @param[in] exact Exact filtration values computation. Not exact if `Kernel` is not <a target="_blank" * href="https://doc.cgal.org/latest/Kernel_d/structCGAL_1_1Epeck__d.html">CGAL::Epeck_d</a>. - * @param[in] default_filtration_value Set this value to `true` if filtration values are not needed to be computed. + * @param[in] default_filtration_value Set this value to `true` if filtration values are not needed to be computed + * (will be set to `NaN`). * Default value is `false` (which means compute the filtration values). * * @return true if creation succeeds, false otherwise. |