From 59585b27d83f3835f46a47c90c732bdb2a19d376 Mon Sep 17 00:00:00 2001 From: ROUVREAU Vincent Date: Mon, 23 Mar 2020 12:14:07 +0100 Subject: Doc review: document what is the filtration value when not computed --- src/Alpha_complex/include/gudhi/Alpha_complex.h | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'src/Alpha_complex/include') 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 CGAL::Epeck_d. - * @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. -- cgit v1.2.3