songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Last update of ref manual.

This commit is contained in:
Guillaume Damiand 2016-03-11 08:01:52 +01:00
parent b5843faa1b
commit e8fa2c300a
2 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Generalized_map/doc/Generalized_map/Concepts/GeneralizedMap.h
View File

@ -20,7 +20,7 @@ public:
GeneralizedMap();
/*!
Construct a new generalized map from another one. The new generalized map is created by copying the darts and the non void attributes of gmap. GMap must be a model of `GeneralizedMap` concept, which can be defined with a different dimension and/or different attributes than `*this`. In this case, only permutations that are common to `gmap` and `*this`, and only non void i-attributes of `gmap` whose info type is the same to the info of non void i-attributes of `*this`, are copied.
Construct a new generalized map from another one. The new generalized map is created by copying the darts and the non void attributes of gmap. GMap must be a model of `GeneralizedMap` concept, which can be defined with a different dimension and/or different attributes than `*this`. In this case, only involutions that are common to `gmap` and `*this`, and only non void i-attributes of `gmap` whose info type is the same to the info of non void i-attributes of `*this`, are copied.
*/
template<typename GMap>
GeneralizedMap(const GMap& gmap);

8
Generalized_map/doc/Generalized_map/Concepts/GeneralizedMapItems.h
View File

@ -2,7 +2,7 @@
\ingroup PkgGeneralizedMapsConcepts
\cgalConcept
The concept `GeneralizedMapItems` allows to customize a <I>d</I>D generalized map by choosing the type of darts, and by enabling and disabling some attributes. For that, it defines an inner class template named \ref GeneralizedMapItems::GDart_wrapper "GDart_wrapper", with one template parameter, `GMap`, a model of the `GeneralizedMap` concept. This inner class must define two types: `%GDart` and `%Attributes`.
The concept `GeneralizedMapItems` allows to customize a <I>d</I>D generalized map by choosing the type of darts, and by enabling and disabling some attributes. For that, it defines an inner class template named \ref GeneralizedMapItems::GDart_wrapper "GDart_wrapper", with one template parameter, `GMap`, a model of the `GeneralizedMap` concept. This inner class must define two types: `%Dart` and `%Attributes`.
\cgalHasModel \ref CGAL::Generalized_map_min_items "CGAL::Generalized_map_min_items<d>"
@ -19,7 +19,7 @@ The concept `GeneralizedMapItems` allows to customize a <I>d</I>D generalized ma
template < class GMap >
struct GDart_wrapper
{
typedef CGAL::GDart<4, GMap> GDart;
typedef CGAL::GDart<4, GMap> Dart;
typedef CGAL::cpp11::tuple<> Attributes;
};
};
@ -29,7 +29,7 @@ The concept `GeneralizedMapItems` allows to customize a <I>d</I>D generalized ma
template < class GMap >
struct GDart_wrapper
{
typedef CGAL::GDart<3, GMap> GDart;
typedef CGAL::GDart<3, GMap> Dart;
typedef CGAL::Cell_attribute<GMap, int> Edge_attrib;
typedef CGAL::cpp11::tuple<void,Edge_attrib> Attributes;
};
@ -43,7 +43,7 @@ public:
Wrapper class defining type of darts and types of attributes.
The class `%GDart_wrapper<GMap>` must provide:
- `%GDart_wrapper<GMap>::%GDart`, the type of dart, a model of the `GDart` concept.
- `%GDart_wrapper<GMap>::%Dart`, the type of dart, a model of the `GDart` concept.
- `%GDart_wrapper<GMap>::%Attributes` The tuple of attributes, containing at most \ref GeneralizedMap::dimension "GMap::dimension+1" types (one for each possible cell of the generalized map). Each type of the tuple must be either a model of the `CellAttribute` concept or `void`. The first type corresponds to 0-attributes, the second to 1-attributes and so on. If the \f$ i^{\mbox{th}}\f$ type in the tuple is `void`, (<I>i</I>-1)-attributes are disabled. Otherwise, (<I>i</I>-1)-attributes are enabled and have the given type. If the size of the tuple is <I>k</I>, with <I>k</I><\ref GeneralizedMap::dimension "GMap::dimension+1", \f$ \forall\f$<I>i</I>: <I>k</I>\f$ \leq\f$<I>i</I>\f$ \leq\f$\ref GeneralizedMap::dimension "GMap::dimension", <I>i</I>-attributes are disabled.
\note It can be implemented using a nested template class.