diff options
author | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-09-17 09:37:25 +0200 |
---|---|---|
committer | ROUVREAU Vincent <vincent.rouvreau@inria.fr> | 2020-09-17 09:37:25 +0200 |
commit | 837ffddda60d3f389184fe167710f74ad8adf36b (patch) | |
tree | 565a39123c4b3d74b345effc81051e0707bdbc9d /src/Alpha_complex/include/gudhi/Alpha_complex.h | |
parent | 282934d4f51acac046c04f752534a6a900880df9 (diff) |
Some documentation for weighted version
Diffstat (limited to 'src/Alpha_complex/include/gudhi/Alpha_complex.h')
-rw-r--r-- | src/Alpha_complex/include/gudhi/Alpha_complex.h | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h index b66ec20d..1d395bd8 100644 --- a/src/Alpha_complex/include/gudhi/Alpha_complex.h +++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h @@ -132,17 +132,18 @@ class Alpha_complex { using Triangulation = typename std::conditional<Weighted, CGAL::Regular_triangulation<Kernel, TDS>, CGAL::Delaunay_triangulation<Kernel, TDS>>::type; + /** \brief CGAL kernel container for computations in function of the weighted or not characteristics.*/ using A_kernel_d = Alpha_kernel_d<Kernel, Weighted>; // Numeric type of coordinates in the kernel using FT = typename A_kernel_d::FT; - /** \brief If Weighted, the weighted point is cached (point + weight [= squared radius]), - * else a pair of point and squared radius is cached. + /** \brief Sphere is a std::pair<Kernel::Point_d, Kernel::FT> (aka. circurmcenter and squared radius). + * If Weighted, Sphere is a Kernel::Weighted_point_d (aka. circurmcenter and the weight value is the squared radius). */ using Sphere = typename A_kernel_d::Sphere; - /** \brief A point in Euclidean space.*/ + /** \brief A point, or a weighted point in Euclidean space.*/ using Point_d = typename std::conditional<Weighted, typename A_kernel_d::Weighted_point_d, typename A_kernel_d::Point_d>::type; |