summaryrefslogtreecommitdiff
path: root/src/Cech_complex
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-10 15:44:18 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2018-04-10 15:44:18 +0000
commit9afff26c8f15121aa58eb1a1beacffc2a38cd477 (patch)
tree618f942586d33b6ee7da275911458326cc2f571d /src/Cech_complex
parentf70b243734ccc904f75937b90a90db45203ba8ec (diff)
Doc review : Add explanation when to use Alpha or Cech.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/cechcomplex_vincent@3369 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 4b6cf58478a7dbe1825491681507d4304d8f3584
Diffstat (limited to 'src/Cech_complex')
-rw-r--r--src/Cech_complex/doc/Intro_cech_complex.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/src/Cech_complex/doc/Intro_cech_complex.h b/src/Cech_complex/doc/Intro_cech_complex.h
index 4d88a1e9..c2844bac 100644
--- a/src/Cech_complex/doc/Intro_cech_complex.h
+++ b/src/Cech_complex/doc/Intro_cech_complex.h
@@ -27,7 +27,7 @@ namespace Gudhi {
namespace cech_complex {
-/** \defgroup cech_complex Cech complex
+/** \defgroup cech_complex Čech complex
*
* \author Vincent Rouvreau
*
@@ -42,6 +42,10 @@ namespace cech_complex {
*
* The input shall be a point cloud in an Euclidean space.
*
+ * \remark For people only interested in the topology of the \ref cech_complex (for instance persistence),
+ * \ref alpha_complex is equivalent to the \ref cech_complex and much smaller if you do not bound the radii.
+ * \ref cech_complex can still make sense in higher dimension precisely because you can bound the radii.
+ *
* \subsection cechalgorithm Algorithm
*
* Cech_complex first builds a proximity graph from a point cloud.