summaryrefslogtreecommitdiff
path: root/src/Alpha_complex/include/gudhi
diff options
context:
space:
mode:
authorvrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-10-03 14:03:50 +0000
committervrouvrea <vrouvrea@636b058d-ea47-450e-bf9e-a15bfbe3eedb>2016-10-03 14:03:50 +0000
commit3950bb33f65f4831060f10a73c7e88cdfe9717bf (patch)
tree0a271e25a478b4192c9e72425c4d8989e044c5cc /src/Alpha_complex/include/gudhi
parent66cdca82e9ca86fcdfa2a08c6003a5661d802cf3 (diff)
Rephrase create_complex.
git-svn-id: svn+ssh://scm.gforge.inria.fr/svnroot/gudhi/branches/alpha_complex_create_complex@1609 636b058d-ea47-450e-bf9e-a15bfbe3eedb Former-commit-id: 8e21ddb519ab3dc87f6de08f6f7fcb38848bfc78
Diffstat (limited to 'src/Alpha_complex/include/gudhi')
-rw-r--r--src/Alpha_complex/include/gudhi/Alpha_complex.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/src/Alpha_complex/include/gudhi/Alpha_complex.h b/src/Alpha_complex/include/gudhi/Alpha_complex.h
index 0613ca7c..ffcd26a3 100644
--- a/src/Alpha_complex/include/gudhi/Alpha_complex.h
+++ b/src/Alpha_complex/include/gudhi/Alpha_complex.h
@@ -148,9 +148,7 @@ class Alpha_complex {
init_from_range(points);
}
- /** \brief Alpha_complex destructor.
- *
- * @warning Deletes the Delaunay triangulation.
+ /** \brief Alpha_complex destructor deletes the Delaunay triangulation.
*/
~Alpha_complex() {
delete triangulation_;
@@ -211,7 +209,8 @@ class Alpha_complex {
return create_complex(complex, std::numeric_limits<Filtration_value>::infinity());
}
- /** \brief Initialize the simplicial complex from the Delaunay triangulation.
+ /** \brief Inserts all Delaunay triangulation into the simplicial complex.
+ * It also computes the filtration values accordingly to the \ref createcomplexalgorithm
*
* \tparam SimplicialComplexForAlpha must meet `SimplicialComplexForAlpha` concept.
*
@@ -220,8 +219,9 @@ class Alpha_complex {
*
* @return true if creation succeeds, false otherwise.
*
- * @warning Delaunay triangulation must be already constructed with at least one vertex and dimension must be more
+ * @pre Delaunay triangulation must be already constructed with at least one vertex and dimension must be more
* than 0.
+ * @pre The simplicial complex must be empty (no vertices)
*
* Initialization can be launched once.
*/