summaryrefslogtreecommitdiff
path: root/src/Alpha_complex/doc/Intro_alpha_complex.h
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-02-03 11:37:33 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-02-03 11:37:33 +0000
commit26bed354555e0f0fc18c6adc6a4b0fe27379a4a6 (patch)
tree0945d5a3a6e903c4bc2fb5745d965eee22f5ead3 /src/Alpha_complex/doc/Intro_alpha_complex.h
parent8cb0b53a28b9d4cf6b97abcffbb527b51e322a22 (diff)
Mentionning Delaunay complex in Alpha complex documentation (user and reference)
Specifying Alpha complex Kernel must be an Epick_d dD kernel (user and reference) git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alphashapes@998 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: b1a7a0cadd236bbfa6c529f2979ad2096414e207
Diffstat (limited to 'src/Alpha_complex/doc/Intro_alpha_complex.h')
-rw-r--r--src/Alpha_complex/doc/Intro_alpha_complex.h4
1 files changed, 3 insertions, 1 deletions
diff --git a/src/Alpha_complex/doc/Intro_alpha_complex.h b/src/Alpha_complex/doc/Intro_alpha_complex.h
index 8eea6ba7..b109956d 100644
--- a/src/Alpha_complex/doc/Intro_alpha_complex.h
+++ b/src/Alpha_complex/doc/Intro_alpha_complex.h
@@ -52,10 +52,12 @@ namespace alphacomplex {
* \cite cgal:hdj-t-15b from <a target="_blank" href="http://www.cgal.org/">CGAL</a> (the Computational Geometry
* Algorithms Library \cite cgal:eb-15b).
*
- * The complex is a template class requiring a <a target="_blank"
+ * The complex is a template class requiring an Epick_d <a target="_blank"
* href="http://doc.cgal.org/latest/Kernel_d/index.html#Chapter_dD_Geometry_Kernel">dD Geometry Kernel</a>
* \cite cgal:s-gkd-15b from CGAL as template.
*
+ * \remark When Alpha_complex is constructed with an infinite value of alpha, the complex is a Delaunay complex.
+ *
* \section pointsexample Example from points
*
* This example builds the Delaunay triangulation from the given points in a 2D static kernel, and initializes the