summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorROUVREAU Vincent <vincent.rouvreau@inria.fr>2021-04-21 10:08:19 +0200
committerROUVREAU Vincent <vincent.rouvreau@inria.fr>2021-04-21 10:08:19 +0200
commit29fa56b6768d7314fcddf39d7681aa6a82417b4e (patch)
tree8c8d5a079e2f802e3baa162a2331ffd3fc7ab0e6
parent2750e632b1419741ca1b720df0103f18dd954ae1 (diff)
cell complex is only for coxeter. eigen is required for coxeter, not cgal
-rw-r--r--src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h5
-rw-r--r--src/Coxeter_triangulation/include/gudhi/Cell_complex.h10
-rw-r--r--src/common/doc/main_page.md2
3 files changed, 9 insertions, 8 deletions
diff --git a/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h b/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h
index 3316bd81..99239e3a 100644
--- a/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h
+++ b/src/Coxeter_triangulation/doc/intro_coxeter_triangulation.h
@@ -166,6 +166,8 @@ The base function classes above can be composed or modified into new functions u
The type of \f$T\f$ is required to be a model of the concept
\ref Gudhi::coxeter_triangulation::TriangulationForManifoldTracing "TriangulationForManifoldTracing".
+It is also possible to implement your own function as detailed in this \ref exampleswithcustomfunction.
+
\section cellcomplex Cell complex construction
The output of the manifold tracing algorithm can be transformed into the Hasse diagram of a cell complex that
@@ -194,6 +196,9 @@ triangulation.
\li The method \ref Gudhi::coxeter_triangulation::Cell_complex::cell_point_map() "cell_point_map()" returns a map from
the vertex cells in the cell complex to their Cartesian coordinates.
+The use and interfaces of this \ref Gudhi::coxeter_triangulation::Cell_complex "Cell_complex" is limited to the
+Coxeter_triangulation implementation.
+
\section example Examples
\subsection examplewithoutboundaries Basic example without boundaries
diff --git a/src/Coxeter_triangulation/include/gudhi/Cell_complex.h b/src/Coxeter_triangulation/include/gudhi/Cell_complex.h
index b386e369..219f525b 100644
--- a/src/Coxeter_triangulation/include/gudhi/Cell_complex.h
+++ b/src/Coxeter_triangulation/include/gudhi/Cell_complex.h
@@ -25,18 +25,14 @@ namespace Gudhi {
namespace coxeter_triangulation {
-/**
- * \ingroup coxeter_triangulation
- */
-
/** \class Cell_complex
* \brief A class that constructs the cell complex from the output provided by the class
- * Gudhi::Manifold_tracing<Triangulation_>.
+ * \ref Gudhi::coxeter_triangulation::Manifold_tracing.
+ *
+ * The use and interfaces of this cell complex is limited to the \ref coxeter_triangulation implementation.
*
* \tparam Out_simplex_map_ The type of a map from a simplex type that is a
* model of SimplexInCoxeterTriangulation to Eigen::VectorXd.
- *
- * \ingroup coxeter_triangulation
*/
template <class Out_simplex_map_>
class Cell_complex {
diff --git a/src/common/doc/main_page.md b/src/common/doc/main_page.md
index c58b6994..17354179 100644
--- a/src/common/doc/main_page.md
+++ b/src/common/doc/main_page.md
@@ -314,7 +314,7 @@
<b>Author:</b> Siargey Kachanovich<br>
<b>Introduced in:</b> GUDHI 3.4.0<br>
<b>Copyright:</b> MIT [(LGPL v3)](../../licensing/)<br>
- <b>Requires:</b> \ref cgal &ge; 4.11.0
+ <b>Requires:</b> \ref eigen &ge; 3.1.0
</td>
</tr>
<tr>