From 9fc5621abbf55da2883a33e53e7d1a18218dc99a Mon Sep 17 00:00:00 2001 From: vrouvrea Date: Fri, 16 Nov 2018 14:23:54 +0000 Subject: Doc review : User version bad description for Alpha complex 3d Add a comment for alpha complex 3d example creation for templates Code review : SAFE is now the default version git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alpha_complex_3d_module_vincent@3990 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: a283cc630ac78634d6700aefb981d130c9464024 --- src/Alpha_complex/doc/Intro_alpha_complex.h | 6 ++++-- src/Alpha_complex/example/Weighted_alpha_complex_3d_from_points.cpp | 1 + src/Alpha_complex/include/gudhi/Alpha_complex_3d.h | 4 ++-- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h index 648fb6d6..fddab003 100644 --- a/src/Alpha_complex/doc/Intro_alpha_complex.h +++ b/src/Alpha_complex/doc/Intro_alpha_complex.h @@ -168,8 +168,10 @@ namespace alpha_complex { * * \section weighted3dexample 3d specific example * - * A specific module for Alpha complex is available in 3d (cf. Alpha_complex_3d) and allows to construct default, exact, - * weighted, periodic or weighted and periodic versions of alpha complexes + * A specific module for Alpha complex is available in 3d (cf. Alpha_complex_3d) and allows to construct standard, + * weighted, periodic or weighted and periodic versions of alpha complexes. Alpha values computation can be + * Gudhi::alpha_complex::complexity::FAST, Gudhi::alpha_complex::complexity::SAFE (default value) or + * Gudhi::alpha_complex::complexity::EXACT. * * This example builds the CGAL 3d weighted alpha shapes from a small molecule, and initializes the alpha complex with * it. This example is taken from CGAL 3d diff --git a/src/Alpha_complex/example/Weighted_alpha_complex_3d_from_points.cpp b/src/Alpha_complex/example/Weighted_alpha_complex_3d_from_points.cpp index 68f72f0a..3a69623f 100644 --- a/src/Alpha_complex/example/Weighted_alpha_complex_3d_from_points.cpp +++ b/src/Alpha_complex/example/Weighted_alpha_complex_3d_from_points.cpp @@ -7,6 +7,7 @@ #include #include // for numeric limits +// Complexity = EXACT, weighted = true, periodic = false using Weighted_alpha_complex_3d = Gudhi::alpha_complex::Alpha_complex_3d; using Point = Weighted_alpha_complex_3d::Point_3; diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h index 00a47d5c..b441a5b2 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex_3d.h @@ -146,7 +146,7 @@ struct Value_from_iterator { * Duplicate points are inserted once in the Alpha_complex. This is the reason why the vertices may be not contiguous. * * \tparam Complexity shall be `Gudhi::alpha_complex::complexity`. Default value is - * `Gudhi::alpha_complex::complexity::FAST`. + * `Gudhi::alpha_complex::complexity::SAFE`. * * \tparam Weighted Boolean used to set/unset the weighted version of Alpha_complex_3d. Default value is false. * @@ -169,7 +169,7 @@ struct Value_from_iterator { * 3d Delaunay complex. * */ -template +template class Alpha_complex_3d { // Epick = Exact_predicates_inexact_constructions_kernel // Epeck = Exact_predicates_exact_constructions_kernel -- cgit v1.2.3