summaryrefslogtreecommitdiff
path: root/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-09-17 09:37:25 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2020-09-17 09:37:25 +0200
commit837ffddda60d3f389184fe167710f74ad8adf36b (patch)
tree565a39123c4b3d74b345effc81051e0707bdbc9d /src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
parent282934d4f51acac046c04f752534a6a900880df9 (diff)
Some documentation for weighted version
Diffstat (limited to 'src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h')
-rw-r--r--src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h b/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
index a4824207..e3567a6d 100644
--- a/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
+++ b/src/Alpha_complex/include/gudhi/Alpha_complex/Alpha_kernel_d.h
@@ -32,6 +32,14 @@ namespace Gudhi {
namespace alpha_complex {
+/**
+ * \class Alpha_kernel_d
+ * \brief Alpha complex kernel container.
+ *
+ * \details
+ * The Alpha complex kernel container stores CGAL Kernel and dispatch basics computations in function of the weighted
+ * or not version of the Alpha complex.
+ */
template < typename Kernel, bool Weighted = false >
class Alpha_kernel_d {
};