Merge pull request #1725 from DGtal-team/docpolyDEC

Fixing DEC documentation for PolygonalCalculus.

examples/polyscope-examples/dgtalCalculus-bunny.cpp

@@ -19,6 +19,7 @@
  * Laboratoire d'InfoRmatique en Image et Systemes d'information - LIRIS (CNRS, UMR 5205), CNRS, France
  *
  * @date 2021/09/02
+ * @ingroup Examples
  *
  * This file is part of the DGtal library.
  */

examples/polyscope-examples/dgtalCalculus-geodesic.cpp

@@ -17,6 +17,7 @@
  * @file
  * @author David Coeurjolly (\c david.coeurjolly@liris.cnrs.fr )
  * Laboratoire d'InfoRmatique en Image et Systemes d'information - LIRIS (CNRS, UMR 5205), CNRS, France
+ * @ingroup Examples
  *
  * @date 2021/09/02
  *

examples/polyscope-examples/dgtalCalculus-halfsphere.cpp

@@ -19,6 +19,7 @@
  * Laboratory of Mathematics (CNRS, UMR 5127), University of Savoie, France
  *
  * @date 2022/04/10
+ * @ingroup Examples
  *
  * This file is part of the DGtal library.
  */

examples/polyscope-examples/dgtalCalculus-poisson.cpp

@@ -19,6 +19,7 @@
  * Laboratoire d'InfoRmatique en Image et Systemes d'information - LIRIS (CNRS, UMR 5205), CNRS, France
  *
  * @date 2021/09/02
+ * @ingroup Examples
  *
  * This file is part of the DGtal library.
  */

examples/polyscope-examples/dgtalCalculus-single.cpp

@@ -20,6 +20,7 @@
  *
  * @date 2021/09/02
  *
+ * @ingroup Examples
  * This file is part of the DGtal library.
  */
 #include <iostream>

src/DGtal/dec/doc/modulePolygonalCalculus.dox

@@ -177,7 +177,7 @@ Operator  | Output | Description
 `calculus.P(f)`|  \f$ n_f \times n_f\f$  | Projection operator acting on a discrete 1-form that removes the associated non-tangential part of the vector reconstructed using the sharp operator
 
 Discrete flat and sharp operators match with the DEC operators (see \ref moduleDECIntroduction). For short, the flat operator embeds  an ambient vector as a discrete 1-form (roughly values on the face edges) while the sharp operator pull-back a 1-form to reconstruct a vector in @f$\mathbb{R}^3@f$. These operators are rank 2 and @f$ sharp_f flat_f s = s\f$ for any vector @f$s@f$ in the face tangent plane, but  @f$ flat_f sharp_f v = v@f$ for any vector v does not hold  (due to rank deficiencies of the matrices).
-This is quantified by the projection operator @f$P@f$ (see @cite degoes2020discrete for structural lemmas, e.g. @f$ normal_f\cdot (sharp_f flat_f s)=0\quad \forall s\in$\mathbb{R}^3@f$...).
+This is quantified by the projection operator @f$P@f$ (see @cite degoes2020discrete for structural lemmas, e.g. @f$ normal_f\cdot (sharp_f flat_f s)=0\quad \forall s\in \mathbb{R}^3@f$...).
 
 
 For interested readers, @cite degoes2020discrete has a discussion about the relationship between these operators and the classical DEC or FEM ones.

src/DGtal/dec/doc/packageDEC.dox

@@ -75,8 +75,14 @@ Basic operators, such as Hodge duality operator or exterior derivative, can be c
 - exampleHarmonicParametrization.cpp
 - exampleVectorHeatMethod.cpp
 - dgtalCalculus-poisson.cpp
-- dgtalCalculus-laplace.cpp
+- dgtalCalculus.cpp
+- dgtalCalculus-single.cpp
+- dgtalCalculus-geodesic.cpp
+- dgtalCalculus-halfsphere.cpp
 - dgtalCalculus-bunny.cpp
+- exampleVectorHeatMethod.cpp
+- exampleHarmonicParametrization.cpp
+- exampleBunnyHead.cpp
 
 */