Add package description

This commit is contained in:
Andreas Fabri 2025-12-02 14:01:32 +00:00
parent 73c78729c0
commit 02b9720f5f
3 changed files with 12 additions and 2 deletions

View File

@ -15,6 +15,7 @@
/*!
\addtogroup PkgHDVFRef
\cgalPkgDescriptionBegin{HDVF,PkgHDVF}
\cgalPkgPicture{HDVF-small.png}
@ -34,4 +35,13 @@ The package provides an implementation of Homological Discrete %Vector Fields, a
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
\cgalCRPSection{Concepts}
- `AbstactChainComplex`
\cgalCRPSection{Classes}
- `CGAL::Homological_discrete_vector_field::Abstact_simplicial_chain_complex`
*/

View File

@ -27,7 +27,7 @@ namespace CGAL {
namespace Homological_discrete_vector_field {
/*!
\ingroup PkgHDVFAlgorithmClasses
\ingroup PkgHDVFRef
The class `Hdvf_duality` is the implementation of homological discrete vector fields (HDVF for short) for Alexander duality computation.

View File

@ -28,7 +28,7 @@ namespace Homological_discrete_vector_field {
template<typename CoefficientRing, typename Traits> class Duality_simplicial_complex_tools ;
/*!
\ingroup PkgHDVFAlgorithmClasses
\ingroup PkgHDVFRef
The class `Simplicial_chain_complex` refines the `Abstract_simplicial_chain_complex` class by assigning coordinates to vertices (i.e.\ 0-simplices). Hence, vtk output is available.