diff options
| author | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-11-16 15:42:32 +0000 |
|---|---|---|
| committer | vrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb> | 2018-11-16 15:42:32 +0000 |
| commit | 8e3cb05c8187b8ab8c8fe6622f5d5f605efaed5a (patch) | |
| tree | d8910e7ae6ba90b30575baa589bfc6f7a8bd5521 /src/Alpha_complex | |
| parent | 83b8e026c0ca3171615e7dc760f0cc61cc7ee933 (diff) | |
Doc review : Add a note to explain setting max_alpha_square value won't speed up the complex creation, on the contrary.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alpha_complex_3d_module_vincent@3995 636b058d-ea47-450e-bf9e-a15bfbe3eedb
Former-commit-id: 293e99e3946641f042f862c267baf548b08e53ca
Diffstat (limited to 'src/Alpha_complex')
| -rw-r--r-- | src/Alpha_complex/include/gudhi/Alpha_complex.h | 3 | ||||
| -rw-r--r-- | src/Alpha_complex/include/gudhi/Alpha_complex_3d.h | 5 |
2 files changed, 6 insertions, 2 deletions
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h index 4c07eddb..5c577c29 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h @@ -244,6 +244,9 @@ class Alpha_complex { * * @return true if creation succeeds, false otherwise. * + * @note Setting the max_alpha_square with a smaller value will not accelerate the complex creation. On the contrary + * it will launch SimplicialComplexForAlpha::prune_above_filtration after the complete creation. + * * @pre Delaunay triangulation must be already constructed with dimension strictly greater than 0. * @pre The simplicial complex must be empty (no vertices) * diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h index 95e68b7e..9c9bc929 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h @@ -437,9 +437,10 @@ class Alpha_complex_3d { * * @return true if creation succeeds, false otherwise. * - * @pre The simplicial complex must be empty (no vertices) + * @note Setting the max_alpha_square with a smaller value will not accelerate the complex creation. On the contrary + * it will launch SimplicialComplexForAlpha3d::prune_above_filtration after the complete creation. * - * Initialization can be launched once. + * @pre The simplicial complex must be empty (no vertices). * */ template <typename SimplicialComplexForAlpha3d, |