cgal/Generalized_map/doc/Generalized_map/PackageDescription.txt

40 lines
1.4 KiB
Plaintext

/// \defgroup PkgGeneralizedMaps Generalized Maps Reference
/// \defgroup PkgGeneralizedMapsConcepts Concepts
/// \ingroup PkgGeneralizedMaps
/// \defgroup PkgGeneralizedMapsClasses Classes
/// \ingroup PkgGeneralizedMaps
/*!
\addtogroup PkgGeneralizedMaps
\cgalPkgDescriptionBegin{Generalized Maps,PkgGeneralizedMapsSummary}
\cgalPkgPicture{gmap_logo.png}
\cgalPkgSummaryBegin
\cgalPkgAuthor{Guillaume Damiand}
\cgalPkgDesc{This package implements Generalized Maps in <I>d</I> dimensions. A generalized map is a data structure enabling to represent an orientable or non orientable subdivided object by describing all the cells of the subdivision (for example in 3D vertices, edges, faces, volumes) and all the incidence and adjacency relationships between these cells. Information can be associated to cells thanks to attributes. The package provides basic creation, modification operations, and several iterators enabling to run through some specific part of the object.}
\cgalPkgManuals{Chapter_Generalized_Maps,PkgGeneralizedMaps}
\cgalPkgSummaryEnd
\cgalPkgShortInfoBegin
\cgalPkgSince{4.9}
\cgalPkgBib{cgal:d-gm}
\cgalPkgLicense{\ref licensesLGPL "LGPL"}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
## Concepts ##
- `GenericMap`
- `GenericMapItems`
- `CellAttribute`
- `GeneralizedMap`
## Classes ##
- `CGAL::Generalized_map<d,Items,Alloc>`
- `CGAL::Cell_attribute<GMap,Info_,Tag,OnMerge,OnSplit>`
- `CGAL::Generic_map_min_items<d>`
*/