diff options
Diffstat (limited to 'src/common/doc')
| -rw-r--r-- | src/common/doc/installation.h | 7 | ||||
| -rw-r--r-- | src/common/doc/main_page.md | 5 |
2 files changed, 8 insertions, 4 deletions
diff --git a/src/common/doc/installation.h b/src/common/doc/installation.h index 2e64bef8..ce2c5448 100644 --- a/src/common/doc/installation.h +++ b/src/common/doc/installation.h @@ -32,7 +32,10 @@ make \endverbatim * * \subsection testsuites Test suites * To test your build, run the following command in a terminal: - * \verbatim make test \endverbatim + * \verbatim make test \endverbatim + * `make test` is using <a href="https://cmake.org/cmake/help/latest/manual/ctest.1.html">Ctest</a> (CMake test driver + * program). If some of the tests are failing, please send us the result of the following command: + * \verbatim ctest --output-on-failure \endverbatim * * \subsection documentationgeneration Documentation * To generate the documentation, <a target="_blank" href="http://www.doxygen.org/">Doxygen</a> is required. @@ -71,7 +74,7 @@ make doxygen * your operating system is detailed here http://doc.cgal.org/latest/Manual/installation.html * * The following examples/utilities require the <a target="_blank" href="http://www.cgal.org/">Computational Geometry Algorithms - * Library</a> (CGAL \cite cgal:eb-15b) and will not be built if CGAL version 4.11.0 or higher is not installed: + * Library</a> (CGAL \cite cgal:eb-19b) and will not be built if CGAL version 4.11.0 or higher is not installed: * \li <a href="_simplex_tree_2example_alpha_shapes_3_simplex_tree_from_off_file_8cpp-example.html"> * Simplex_tree/example_alpha_shapes_3_simplex_tree_from_off_file.cpp</a> * \li <a href="_witness_complex_2strong_witness_persistence_8cpp-example.html"> diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md index d8cbf97f..0b4bfb7a 100644 --- a/src/common/doc/main_page.md +++ b/src/common/doc/main_page.md @@ -43,8 +43,9 @@ The filtration value of each simplex is computed as the square of the circumradius of the simplex if the circumsphere is empty (the simplex is then said to be Gabriel), and as the minimum of the filtration 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> + All simplices that have a filtration value \f$ > \alpha^2 \f$ are removed from the Delaunay complex + when creating the simplicial complex if it is specified.<br> + For performances reasons, it is advised to use \ref cgal ≥ 5.0.0. </td> <td width="15%"> <b>Author:</b> Vincent Rouvreau<br> |