diff options
author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-11-06 07:22:06 +0100 |
---|---|---|
committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2019-11-06 07:22:06 +0100 |
commit | 8732cd18079a12ab813e863839c48b7c9e504fef (patch) | |
tree | 3b978aa490499ac4f5bed3feef1f98694aad06d7 | |
parent | 0f6714990421d967a5e76676920ab190acc61364 (diff) |
Add doc warnings
-rw-r--r-- | src/Alpha_complex/doc/Intro_alpha_complex.h | 1 | ||||
-rw-r--r-- | src/common/doc/main_page.md | 1 |
2 files changed, 2 insertions, 0 deletions
diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h index b075d1fc..fd6f4081 100644 --- a/src/Alpha_complex/doc/Intro_alpha_complex.h +++ b/src/Alpha_complex/doc/Intro_alpha_complex.h @@ -51,6 +51,7 @@ namespace alpha_complex { * - For people only interested in the topology of the \ref alpha_complex (for instance persistence), * \ref alpha_complex is equivalent to the \ref cech_complex and much smaller if you do not bound the radii. * \ref cech_complex can still make sense in higher dimension precisely because you can bound the radii. + * - For performances reasons, it is advised to use `Alpha_complex` with \ref cgal ≥ 5.0.0. * * \section pointsexample Example from points * diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index d8cbf97f..e8d11fdf 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -45,6 +45,7 @@ values of the codimension 1 cofaces that make it not Gabriel otherwise. All simplices that have a filtration value strictly greater than a given alpha squared value are not inserted into the complex.<br> + For performances reasons, it is advised to use \ref cgal ≥ 5.0.0. </td> <td width="15%"> <b>Author:</b> Vincent Rouvreau<br> |