use \PkgXXX instead of \PkgXXXSummary

This commit is contained in:
Sébastien Loriot 2018-09-04 11:20:02 +02:00
parent a2e8a1c68f
commit ea240cfac5
137 changed files with 261 additions and 261 deletions

View File

@ -5,7 +5,7 @@
/*! /*!
\addtogroup PkgAABB_treeRef \addtogroup PkgAABB_treeRef
\cgalPkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABB_treeSummary} \cgalPkgDescriptionBegin{3D Fast Intersection and Distance Computation,PkgAABB_tree}
\cgalPkgPicture{aabb-teaser-thumb.png} \cgalPkgPicture{aabb-teaser-thumb.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pierre Alliez, Stéphane Tayeb, Camille Wormser} \cgalPkgAuthors{Pierre Alliez, Stéphane Tayeb, Camille Wormser}

View File

@ -3,7 +3,7 @@
/*! /*!
\addtogroup PkgAdvancingFrontSurfaceReconstructionRef \addtogroup PkgAdvancingFrontSurfaceReconstructionRef
\cgalPkgDescriptionBegin{Advancing Front Surface Reconstruction,PkgAdvancingFrontSurfaceReconstructionSummary} \cgalPkgDescriptionBegin{Advancing Front Surface Reconstruction,PkgAdvancingFrontSurfaceReconstruction}
\cgalPkgPicture{afsr-detail.png} \cgalPkgPicture{afsr-detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Tran Kai Frank Da, David Cohen-Steiner} \cgalPkgAuthors{Tran Kai Frank Da, David Cohen-Steiner}
@ -16,7 +16,7 @@ of topological singularities. }
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.7} \cgalPkgSince{4.7}
\cgalPkgDependsOn{\ref PkgTriangulation3Summary} \cgalPkgDependsOn{\ref PkgTriangulation3}
\cgalPkgBib{cgal:dc-afsr} \cgalPkgBib{cgal:dc-afsr}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd

View File

@ -7,7 +7,7 @@
\addtogroup PkgAlgebraicFoundationsRef \addtogroup PkgAlgebraicFoundationsRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Algebraic Foundations,PkgAlgebraicFoundationsSummary} \cgalPkgDescriptionBegin{Algebraic Foundations,PkgAlgebraicFoundations}
\cgalPkgPicture{Algebraic_foundations2.png} \cgalPkgPicture{Algebraic_foundations2.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Michael Hemmer} \cgalPkgAuthor{Michael Hemmer}

View File

@ -17,7 +17,7 @@
/*! /*!
\addtogroup PkgAlgebraicKerneldRef \addtogroup PkgAlgebraicKerneldRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Algebraic Kernel,PkgAlgebraicKerneldSummary} \cgalPkgDescriptionBegin{Algebraic Kernel,PkgAlgebraicKerneld}
\cgalPkgPicture{Algebraic_kernel_d.png} \cgalPkgPicture{Algebraic_kernel_d.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Eric Berberich, Michael Hemmer, Michael Kerber, Sylvain Lazard, Luis Peñaranda, and Monique Teillaud} \cgalPkgAuthors{Eric Berberich, Michael Hemmer, Michael Kerber, Sylvain Lazard, Luis Peñaranda, and Monique Teillaud}

View File

@ -5,7 +5,7 @@
/*! /*!
\addtogroup PkgAlphaShape2Ref \addtogroup PkgAlphaShape2Ref
\cgalPkgDescriptionBegin{2D Alpha Shapes,PkgAlphaShape2Summary} \cgalPkgDescriptionBegin{2D Alpha Shapes,PkgAlphaShape2}
\cgalPkgPicture{alpha-detail.png} \cgalPkgPicture{alpha-detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Tran Kai Frank Da} \cgalPkgAuthors{Tran Kai Frank Da}
@ -14,7 +14,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{2.1} \cgalPkgSince{2.1}
\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgTriangulation2}
\cgalPkgBib{cgal:d-as2} \cgalPkgBib{cgal:d-as2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{2D Alpha Shapes,alpha_shapes_2.zip} \cgalPkgDemo{2D Alpha Shapes,alpha_shapes_2.zip}

View File

@ -3,7 +3,7 @@
/// \ingroup PkgAlphaShapes3Ref /// \ingroup PkgAlphaShapes3Ref
/*! /*!
\addtogroup PkgAlphaShapes3Ref \addtogroup PkgAlphaShapes3Ref
\cgalPkgDescriptionBegin{3D Alpha Shapes,PkgAlphaShapes3Summary} \cgalPkgDescriptionBegin{3D Alpha Shapes,PkgAlphaShapes3}
\cgalPkgPicture{alpha_shapes_3_small.png} \cgalPkgPicture{alpha_shapes_3_small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Tran Kai Frank Da, Sébastien Loriot, and Mariette Yvinec} \cgalPkgAuthors{Tran Kai Frank Da, Sébastien Loriot, and Mariette Yvinec}
@ -12,7 +12,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{2.3} \cgalPkgSince{2.3}
\cgalPkgDependsOn{\ref PkgTriangulation3Summary} \cgalPkgDependsOn{\ref PkgTriangulation3}
\cgalPkgBib{cgal:dy-as3} \cgalPkgBib{cgal:dy-as3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{3D Alpha Shapes,alpha_shape_3.zip} \cgalPkgDemo{3D Alpha Shapes,alpha_shape_3.zip}

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgApolloniusGraph2Ref \addtogroup PkgApolloniusGraph2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Apollonius Graphs (Delaunay Graphs of Disks),PkgApolloniusGraph2Summary} \cgalPkgDescriptionBegin{2D Apollonius Graphs (Delaunay Graphs of Disks),PkgApolloniusGraph2}
\cgalPkgPicture{CircleVoronoi.png} \cgalPkgPicture{CircleVoronoi.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Menelaos Karavelas and Mariette Yvinec} \cgalPkgAuthors{Menelaos Karavelas and Mariette Yvinec}
@ -13,7 +13,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.0} \cgalPkgSince{3.0}
\cgalPkgDependsOn{\ref PkgTDS2Summary} \cgalPkgDependsOn{\ref PkgTDS2}
\cgalPkgBib{cgal:ky-ag2} \cgalPkgBib{cgal:ky-ag2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{2D Apollonius Graph,apollonius_graph_2.zip} \cgalPkgDemo{2D Apollonius Graph,apollonius_graph_2.zip}

View File

@ -58,7 +58,7 @@ namespace ArrTraits {}
/*! /*!
\addtogroup PkgArrangement2Ref \addtogroup PkgArrangement2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Arrangements,PkgArrangement2Summary} \cgalPkgDescriptionBegin{2D Arrangements,PkgArrangement2}
\cgalPkgPicture{Arrangement_2.png} \cgalPkgPicture{Arrangement_2.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Ron Wein, Eric Berberich, Efi Fogel, Dan Halperin, Michael Hemmer, Oren Salzman, and Baruch Zukerman} \cgalPkgAuthors{Ron Wein, Eric Berberich, Efi Fogel, Dan Halperin, Michael Hemmer, Oren Salzman, and Baruch Zukerman}

View File

@ -22,7 +22,7 @@ Furthermore, this package extends the \sc{Bgl}
by introducing concepts such as `HalfedgeGraph` and `FaceGraph` by introducing concepts such as `HalfedgeGraph` and `FaceGraph`
allowing to handle *halfedges* and *faces*. allowing to handle *halfedges* and *faces*.
These concepts reflect the design of the halfedge data structure described These concepts reflect the design of the halfedge data structure described
in Chapter \ref PkgHDSSummary, with opposite halfedges and circular in Chapter \ref PkgHDS, with opposite halfedges and circular
sequences of halfedges around vertices and around faces. sequences of halfedges around vertices and around faces.
This chapter is organized as follows: This chapter is organized as follows:
@ -31,10 +31,10 @@ This chapter is organized as follows:
different libraries. different libraries.
- The four following sections give examples on how to use CGAL graph and mesh data structures - The four following sections give examples on how to use CGAL graph and mesh data structures
such as such as
\link PkgSurfaceMeshSummary Surface_mesh \endlink, \link PkgSurfaceMesh Surface_mesh \endlink,
\link PkgPolyhedronSummary Polyhedron \endlink, \link PkgPolyhedron Polyhedron \endlink,
\link PkgArrangement2Summary Arrangement_2 \endlink, and the \link PkgArrangement2 Arrangement_2 \endlink, and the
\link PkgTriangulation2Summary 2D triangulation \endlink classes as models of the \sc{Bgl} concepts. \link PkgTriangulation2 2D triangulation \endlink classes as models of the \sc{Bgl} concepts.
- Starting with Section \ref BGLExtensions, we introduce new graph concepts, classes, - Starting with Section \ref BGLExtensions, we introduce new graph concepts, classes,
and functions that extend the functionalities of the \sc{Bgl}. and functions that extend the functionalities of the \sc{Bgl}.
@ -127,7 +127,7 @@ The data itself may be stored in the vertex or the edge, or it may
be stored in an external data structure, or it may be computed on be stored in an external data structure, or it may be computed on
the fly. This is an implementation detail of a particular property map. the fly. This is an implementation detail of a particular property map.
See also Chapter \ref PkgProperty_mapSummary. See also Chapter \ref PkgProperty_map.
\subsection BGLVisitors Visitors \subsection BGLVisitors Visitors
@ -218,7 +218,7 @@ the concepts provided by \cgal to implement a simple algorithm.
The following example program computes the minimum spanning tree on a surface mesh. The following example program computes the minimum spanning tree on a surface mesh.
More examples can be found in Chapters More examples can be found in Chapters
\ref PkgSurfaceMeshSimplificationSummary, \ref PkgSurfaceSegmentationSummary, and \ref PkgSurfaceMeshDeformationSummary. \ref PkgSurfaceMeshSimplification, \ref PkgSurfaceSegmentation, and \ref PkgSurfaceMeshDeformation.
The surface mesh class uses integer indices to address vertices and edges, The surface mesh class uses integer indices to address vertices and edges,
and it comes with a built-in property mechanism that maps nicely on the \sc{Bgl}. and it comes with a built-in property mechanism that maps nicely on the \sc{Bgl}.
@ -237,7 +237,7 @@ the concepts provided by \cgal to implement a simple algorithm.
The following example program computes the minimum spanning tree on a polyhedral surface. The following example program computes the minimum spanning tree on a polyhedral surface.
More examples can be found in the Chapter More examples can be found in the Chapter
\ref PkgSurfaceMeshSimplificationSummary. \ref PkgSurfaceMeshSimplification.
\cgalExample{BGL_polyhedron_3/kruskal.cpp} \cgalExample{BGL_polyhedron_3/kruskal.cpp}
@ -423,7 +423,7 @@ by the functionalities of the \sc{Bgl}.
\subsection BGLExtensionsGraphConcepts Graph concepts \subsection BGLExtensionsGraphConcepts Graph concepts
In order to match \ref PkgHDSSummary more closely and to enable writing generic algorithms In order to match \ref PkgHDS more closely and to enable writing generic algorithms
which operate on data structures that have faces and halfedges, we define which operate on data structures that have faces and halfedges, we define
a set of new concepts to extend the <a href="https://www.boost.org/libs/graph/doc/graph_concepts.html">graph concepts of the BGL</a>: a set of new concepts to extend the <a href="https://www.boost.org/libs/graph/doc/graph_concepts.html">graph concepts of the BGL</a>:
@ -636,7 +636,7 @@ Vertices of the seam mesh that are linked by a green dashed segment correspond
to the same vertex in the underlying mesh. to the same vertex in the underlying mesh.
\cgalFigureEnd \cgalFigureEnd
Seam meshes are for example used in Chapter \ref PkgSurfaceParameterizationSummary Seam meshes are for example used in Chapter \ref PkgSurfaceParameterization
to parameterize a topological sphere by first virtually cutting it into a topological to parameterize a topological sphere by first virtually cutting it into a topological
disk. disk.

View File

@ -542,7 +542,7 @@ Methods to read and write graphs.
/*! /*!
\addtogroup PkgBGLRef \addtogroup PkgBGLRef
\cgalPkgDescriptionBegin{CGAL and the Boost Graph Library,PkgBGLSummary} \cgalPkgDescriptionBegin{CGAL and the Boost Graph Library,PkgBGL}
\cgalPkgPicture{emst-detail.png} \cgalPkgPicture{emst-detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Andreas Fabri, Fernando Cacciola, Philipp Moeller, and Ron Wein} \cgalPkgAuthors{Andreas Fabri, Fernando Cacciola, Philipp Moeller, and Ron Wein}

View File

@ -10,7 +10,7 @@ namespace CGAL {
\section gbc_introduction Introduction \section gbc_introduction Introduction
The package <em>2D Generalized Barycentric Coordinates</em> offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbour coordinates from the package \ref PkgInterpolation2Summary "2D and Surface Function Interpolation". The package <em>2D Generalized Barycentric Coordinates</em> offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbour coordinates from the package \ref PkgInterpolation2 "2D and Surface Function Interpolation".
In particular, the package includes an implementation of \ref wp_example "Wachspress", \ref mv_example "mean value", and \ref dh_example "discrete harmonic" coordinates and provides some extra functions to compute barycentric coordinates with respect to segments (\ref seg_example "segment coordinates") and triangles (\ref tri_example "triangle coordinates"). The section \ref gbc_theory gives a short introduction to the topic of barycentric coordinates. In particular, the package includes an implementation of \ref wp_example "Wachspress", \ref mv_example "mean value", and \ref dh_example "discrete harmonic" coordinates and provides some extra functions to compute barycentric coordinates with respect to segments (\ref seg_example "segment coordinates") and triangles (\ref tri_example "triangle coordinates"). The section \ref gbc_theory gives a short introduction to the topic of barycentric coordinates.
@ -85,7 +85,7 @@ This is an advanced example that shows how to use generalized barycentric coordi
A 2D polygon with 50 vertices representing a piece of terrain with convex and concave parts. The height is not shown. A 2D polygon with 50 vertices representing a piece of terrain with convex and concave parts. The height is not shown.
\cgalFigureEnd \cgalFigureEnd
In this example we project a three-dimensional polygon orthogonally onto the two-dimensional plane using the class `CGAL::Projection_traits_xy_3`, triangulate its interior using the class `CGAL::Delaunay_mesher_2`, and compute mean value coordinates for all the obtained points with respect to all the polygon's vertices. Finally, we interpolate the height data from the polygon's boundary to its interior using the computed coordinates and the global interpolation function from the package \ref PkgInterpolation2Summary "2D and Surface Function Interpolation". In this example we project a three-dimensional polygon orthogonally onto the two-dimensional plane using the class `CGAL::Projection_traits_xy_3`, triangulate its interior using the class `CGAL::Delaunay_mesher_2`, and compute mean value coordinates for all the obtained points with respect to all the polygon's vertices. Finally, we interpolate the height data from the polygon's boundary to its interior using the computed coordinates and the global interpolation function from the package \ref PkgInterpolation2 "2D and Surface Function Interpolation".
\cgalExample{Barycentric_coordinates_2/Terrain_height_modeling.cpp} \cgalExample{Barycentric_coordinates_2/Terrain_height_modeling.cpp}
@ -256,7 +256,7 @@ Analogously to the previous cases, we want to plot the Wachspress coordinates an
The Wachspress coordinate function with respect to the indicated vertex with values from zero to one as the colour bar indicates. The Wachspress coordinate function with respect to the indicated vertex with values from zero to one as the colour bar indicates.
\cgalFigureEnd \cgalFigureEnd
Another type of generalized barycentric coordinates goes back to Pinkall and Polthier in 1993 \cite cgal:pp-cdmsc-93 and Eck et al. in 1995 \cite cgal:bc:eddhls-maam-95 in the context of \ref PkgSurfaceParameterizationSummary "triangle mesh parameterization". They are called discrete harmonic coordinates. \ref gbc_deg_discrete_harmonic_coordinates "These coordinates" are well-defined, similarly to Wachspress coordinates, for arbitrary <em>strictly convex polygons</em> and inherit all the properties of triangle coordinates <em>apart from the positivity inside a polygon</em> because they can take on negative values \ref gbc_deg_discrete_harmonic_coordinates "for some polygons". Another interesting property of these coordinate functions is that they coincide with Wachspress coordinates for any polygon whose vertices lie on a common circle. Another type of generalized barycentric coordinates goes back to Pinkall and Polthier in 1993 \cite cgal:pp-cdmsc-93 and Eck et al. in 1995 \cite cgal:bc:eddhls-maam-95 in the context of \ref PkgSurfaceParameterization "triangle mesh parameterization". They are called discrete harmonic coordinates. \ref gbc_deg_discrete_harmonic_coordinates "These coordinates" are well-defined, similarly to Wachspress coordinates, for arbitrary <em>strictly convex polygons</em> and inherit all the properties of triangle coordinates <em>apart from the positivity inside a polygon</em> because they can take on negative values \ref gbc_deg_discrete_harmonic_coordinates "for some polygons". Another interesting property of these coordinate functions is that they coincide with Wachspress coordinates for any polygon whose vertices lie on a common circle.
To plot discrete harmonic coordinates we take \ref wp_plot "the same polygon" as for Wachspress coordinates and plot the coordinate function with respect to the same vertex. Again, we get a smooth function, which is linear along all edges and grows from zero to one. Isolines in the plot show the difference between discrete harmonic and Wachspress coordinates for the chosen polygon and vertex. To plot discrete harmonic coordinates we take \ref wp_plot "the same polygon" as for Wachspress coordinates and plot the coordinate function with respect to the same vertex. Again, we get a smooth function, which is linear along all edges and grows from zero to one. Isolines in the plot show the difference between discrete harmonic and Wachspress coordinates for the chosen polygon and vertex.
@ -265,7 +265,7 @@ To plot discrete harmonic coordinates we take \ref wp_plot "the same polygon" as
The discrete harmonic coordinate function with respect to the indicated vertex with values from zero to one as the colour bar indicates. The discrete harmonic coordinate function with respect to the indicated vertex with values from zero to one as the colour bar indicates.
\cgalFigureEnd \cgalFigureEnd
The last type of generalized barycentric coordinates that we discuss are mean value coordinates \cite cgal:f-mvc-03 proposed by M. Floater in 2003. Based on the <a href="http://en.wikipedia.org/wiki/Mean_value_theorem">mean value theorem</a>, \ref gbc_deg_mean_value_coordinates "these coordinates", unlike Wachspress and discrete harmonic coordinates, are well-defined for arbitrary <em>simple polygons</em>, inherit all the properties of triangle coordinates for any convex polygon, and <em>lack only the positivity property for general concave polygons</em>. Hormann and Floater prove in \cite cgal:bc:hf-mvcapp-06 that these coordinates are positive inside the kernel of a <a href="https://en.wikipedia.org/wiki/Star-shaped_polygon">star-shaped polygon</a>. They are also positive in the closure of any quadrilateral. Like discrete harmonic weights, mean value weights are often used in the context of \ref PkgSurfaceParameterizationSummary "triangle mesh parameterization." The last type of generalized barycentric coordinates that we discuss are mean value coordinates \cite cgal:f-mvc-03 proposed by M. Floater in 2003. Based on the <a href="http://en.wikipedia.org/wiki/Mean_value_theorem">mean value theorem</a>, \ref gbc_deg_mean_value_coordinates "these coordinates", unlike Wachspress and discrete harmonic coordinates, are well-defined for arbitrary <em>simple polygons</em>, inherit all the properties of triangle coordinates for any convex polygon, and <em>lack only the positivity property for general concave polygons</em>. Hormann and Floater prove in \cite cgal:bc:hf-mvcapp-06 that these coordinates are positive inside the kernel of a <a href="https://en.wikipedia.org/wiki/Star-shaped_polygon">star-shaped polygon</a>. They are also positive in the closure of any quadrilateral. Like discrete harmonic weights, mean value weights are often used in the context of \ref PkgSurfaceParameterization "triangle mesh parameterization."
In order to show the particular behaviour of mean value coordinates with an application to concave polygons, we take \ref fig__mv__example "a star-shaped polygon" with ten vertices \f$[v_0, \dots, v_9]\f$, sample its interior and boundary, and plot the coordinate function with respect to the fourth vertex \f$v_3\f$. As the colour bar indicates, the obtained function grows from a slightly negative value to one at the chosen vertex. It is also smooth inside the polygon and linear along all edges. In order to show the particular behaviour of mean value coordinates with an application to concave polygons, we take \ref fig__mv__example "a star-shaped polygon" with ten vertices \f$[v_0, \dots, v_9]\f$, sample its interior and boundary, and plot the coordinate function with respect to the fourth vertex \f$v_3\f$. As the colour bar indicates, the obtained function grows from a slightly negative value to one at the chosen vertex. It is also smooth inside the polygon and linear along all edges.

View File

@ -6,11 +6,11 @@
/*! /*!
\addtogroup PkgBarycentric_coordinates_2Ref \addtogroup PkgBarycentric_coordinates_2Ref
\cgalPkgDescriptionBegin{2D Generalized Barycentric Coordinates, PkgBarycentric_coordinates_2Summary} \cgalPkgDescriptionBegin{2D Generalized Barycentric Coordinates, PkgBarycentric_coordinates_2}
\cgalPkgPicture{barcoord_thumb.png} \cgalPkgPicture{barcoord_thumb.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Dmitry Anisimov, David Bommes, Kai Hormann, and Pierre Alliez} \cgalPkgAuthors{Dmitry Anisimov, David Bommes, Kai Hormann, and Pierre Alliez}
\cgalPkgDesc{The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbor coordinates from the Package \ref PkgInterpolation2Summary.} \cgalPkgDesc{The package 2D Generalized Barycentric Coordinates offers an efficient and robust implementation of two-dimensional closed-form generalized barycentric coordinates defined for simple two-dimensional polygons. If coordinates with respect to multivariate scattered points instead of a polygon are required, please refer to natural neighbor coordinates from the Package \ref PkgInterpolation2.}
\cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentric_coordinates_2Ref} \cgalPkgManuals{Chapter_2D_Generalized_Barycentric_Coordinates, PkgBarycentric_coordinates_2Ref}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin

View File

@ -23,7 +23,7 @@ intersection predicates, and point containment predicates.
Ordinary Boolean set-operations, which distinguish between the Ordinary Boolean set-operations, which distinguish between the
interior and the boundary of a polygon, are not implemented within this interior and the boundary of a polygon, are not implemented within this
package. The Chapter \ref PkgNef2Summary supports these operations for (linear) package. The Chapter \ref PkgNef2 supports these operations for (linear)
polygons. polygons.
In the rest of this chapter we use, unless otherwise stated, the In the rest of this chapter we use, unless otherwise stated, the

View File

@ -9,7 +9,7 @@ namespace ArrDirectionalTraits {}
/*! /*!
\addtogroup PkgBooleanSetOperations2Ref \addtogroup PkgBooleanSetOperations2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Regularized Boolean Set-Operations,PkgBooleanSetOperations2Summary} \cgalPkgDescriptionBegin{2D Regularized Boolean Set-Operations,PkgBooleanSetOperations2}
\cgalPkgPicture{Boolean_set_operations_2.png} \cgalPkgPicture{Boolean_set_operations_2.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Efi Fogel, Ophir Setter, Ron Wein, Guy Zucker, Baruch Zukerman, and Dan Halperin} \cgalPkgAuthors{Efi Fogel, Ophir Setter, Ron Wein, Guy Zucker, Baruch Zukerman, and Dan Halperin}
@ -18,7 +18,7 @@ namespace ArrDirectionalTraits {}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.2} \cgalPkgSince{3.2}
\cgalPkgDependsOn{\ref PkgArrangement2Summary} \cgalPkgDependsOn{\ref PkgArrangement2}
\cgalPkgBib{cgal:fwzh-rbso2} \cgalPkgBib{cgal:fwzh-rbso2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Boolean operations,boolean_operations_2.zip} \cgalPkgDemo{Boolean operations,boolean_operations_2.zip}

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgBoundingVolumesRef \addtogroup PkgBoundingVolumesRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Bounding Volumes,PkgBoundingVolumesSummary} \cgalPkgDescriptionBegin{Bounding Volumes,PkgBoundingVolumes}
\cgalPkgPicture{minCircle.png} \cgalPkgPicture{minCircle.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} \cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr}

View File

@ -22,7 +22,7 @@
\todo de-math and change D to d for the dimension \todo de-math and change D to d for the dimension
\cgalPkgDescriptionBegin{Intersecting Sequences of dD Iso-oriented Boxes,PkgBoxIntersectionDSummary} \cgalPkgDescriptionBegin{Intersecting Sequences of dD Iso-oriented Boxes,PkgBoxIntersectionD}
\cgalPkgPicture{box_inters-small.png} \cgalPkgPicture{box_inters-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Lutz Kettner, Andreas Meyer, and Afra Zomorodian} \cgalPkgAuthors{Lutz Kettner, Andreas Meyer, and Afra Zomorodian}

View File

@ -1,7 +1,7 @@
/// \defgroup PkgCGALIpeletsRef CGAL Ipelets Reference /// \defgroup PkgCGALIpeletsRef CGAL Ipelets Reference
/*! /*!
\addtogroup PkgCGALIpeletsRef \addtogroup PkgCGALIpeletsRef
\cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpeletsSummary} \cgalPkgDescriptionBegin{CGAL Ipelets,PkgCGALIpelets}
\cgalPkgPicture{ipeico.jpg} \cgalPkgPicture{ipeico.jpg}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Olivier Devillers, Sébastien Loriot, and Sylvain Pion} \cgalPkgAuthors{Olivier Devillers, Sébastien Loriot, and Sylvain Pion}

View File

@ -23,7 +23,7 @@
/*! /*!
\addtogroup PkgCircularKernel2Ref \addtogroup PkgCircularKernel2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Circular Geometry Kernel,PkgCircularKernel2Summary} \cgalPkgDescriptionBegin{2D Circular Geometry Kernel,PkgCircularKernel2}
\cgalPkgPicture{Boolean_operation_detail.png} \cgalPkgPicture{Boolean_operation_detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pedro Machado Manhães de Castro, Sylvain Pion, and Monique Teillaud} \cgalPkgAuthors{Pedro Machado Manhães de Castro, Sylvain Pion, and Monique Teillaud}

View File

@ -20,7 +20,7 @@
/*! /*!
\addtogroup PkgSphericalKernel3Ref \addtogroup PkgSphericalKernel3Ref
\cgalPkgDescriptionBegin{3D Spherical Geometry Kernel,PkgSphericalKernel3Summary} \cgalPkgDescriptionBegin{3D Spherical Geometry Kernel,PkgSphericalKernel3}
\cgalPkgPicture{segment_sphere_intersection_detail.png} \cgalPkgPicture{segment_sphere_intersection_detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pedro Machado Manhães de Castro, Frédéric Cazals, Sébastien Loriot, and Monique Teillaud} \cgalPkgAuthors{Pedro Machado Manhães de Castro, Frédéric Cazals, Sébastien Loriot, and Monique Teillaud}

View File

@ -22,7 +22,7 @@
/*! /*!
\addtogroup PkgHandlesAndCirculatorsRef \addtogroup PkgHandlesAndCirculatorsRef
\cgalPkgDescriptionBegin{Handles and Circulators,PkgHandlesAndCirculatorsSummary} \cgalPkgDescriptionBegin{Handles and Circulators,PkgHandlesAndCirculators}
\cgalPkgPicture{circulator.png} \cgalPkgPicture{circulator.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Olivier Devillers, Lutz Kettner, Sylvain Pion, Michael Seel, and Mariette Yvinec} \cgalPkgAuthors{Olivier Devillers, Lutz Kettner, Sylvain Pion, Michael Seel, and Mariette Yvinec}

View File

@ -51,7 +51,7 @@ Data structures specialized to classify clusters.
\addtogroup PkgClassificationRef \addtogroup PkgClassificationRef
\cgalPkgDescriptionBegin{Classification, PkgClassificationSummary} \cgalPkgDescriptionBegin{Classification, PkgClassification}
\cgalPkgPicture{data_classif.png} \cgalPkgPicture{data_classif.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
@ -62,7 +62,7 @@ Data structures specialized to classify clusters.
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.12} \cgalPkgSince{4.12}
\cgalPkgDependsOn{\ref PkgSolverSummary, \ref PkgSpatialSearchingDSummary, [Boost Serialization](http://www.boost.org/libs/serialization) and \cgalPkgDependsOn{\ref PkgSolver, \ref PkgSpatialSearchingD, [Boost Serialization](http://www.boost.org/libs/serialization) and
[Boost IO Streams](http://www.boost.org/libs/iostreams)} [Boost IO Streams](http://www.boost.org/libs/iostreams)}
\cgalPkgBib{cgal:lm-clscm-12} \cgalPkgBib{cgal:lm-clscm-12}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}

View File

@ -25,7 +25,7 @@
/*! /*!
\addtogroup PkgCombinatorialMapsRef \addtogroup PkgCombinatorialMapsRef
\cgalPkgDescriptionBegin{Combinatorial Maps,PkgCombinatorialMapsSummary} \cgalPkgDescriptionBegin{Combinatorial Maps,PkgCombinatorialMaps}
\cgalPkgPicture{cmap_logo.png} \cgalPkgPicture{cmap_logo.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Guillaume Damiand} \cgalPkgAuthor{Guillaume Damiand}

View File

@ -5,7 +5,7 @@
/*! /*!
\addtogroup PkgConeBasedSpannersRef \addtogroup PkgConeBasedSpannersRef
\cgalPkgDescriptionBegin{Cone-Based Spanners,PkgConeBasedSpannersSummary} \cgalPkgDescriptionBegin{Cone-Based Spanners,PkgConeBasedSpanners}
\cgalPkgPicture{Logo-ConeSpanners.png} \cgalPkgPicture{Logo-ConeSpanners.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin

View File

@ -2,7 +2,7 @@
/*! /*!
\addtogroup PkgConvexDecomposition3Ref \addtogroup PkgConvexDecomposition3Ref
\cgalPkgDescriptionBegin{Convex Decomposition of Polyhedra,PkgConvexDecomposition3Summary} \cgalPkgDescriptionBegin{Convex Decomposition of Polyhedra,PkgConvexDecomposition3}
\cgalPkgPicture{Convex_decomposition_3/fig/Convex_decomposition_3-teaser.png} \cgalPkgPicture{Convex_decomposition_3/fig/Convex_decomposition_3-teaser.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Peter Hachenberger} \cgalPkgAuthor{Peter Hachenberger}

View File

@ -21,7 +21,7 @@
/*! /*!
\addtogroup PkgConvexHull2Ref \addtogroup PkgConvexHull2Ref
\cgalPkgDescriptionBegin{2D Convex Hulls and Extreme Points,PkgConvexHull2Summary} \cgalPkgDescriptionBegin{2D Convex Hulls and Extreme Points,PkgConvexHull2}
\cgalPkgPicture{Convex_hull_2/fig/convex_hull.png} \cgalPkgPicture{Convex_hull_2/fig/convex_hull.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Susan Hert and Stefan Schirra} \cgalPkgAuthors{Susan Hert and Stefan Schirra}

View File

@ -23,7 +23,7 @@ degenerate hull may also be possible.
\addtogroup PkgConvexHull3Ref \addtogroup PkgConvexHull3Ref
\todo fix or keep the `Default_traits` \todo fix or keep the `Default_traits`
\cgalPkgDescriptionBegin{3D Convex Hulls,PkgConvexHull3Summary} \cgalPkgDescriptionBegin{3D Convex Hulls,PkgConvexHull3}
\cgalPkgPicture{Convex_hull_3/fig/bunny.png} \cgalPkgPicture{Convex_hull_3/fig/bunny.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Susan Hert and Stefan Schirra} \cgalPkgAuthors{Susan Hert and Stefan Schirra}
@ -32,7 +32,7 @@ degenerate hull may also be possible.
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{1.1} \cgalPkgSince{1.1}
\cgalPkgDependsOn{The dynamic algorithms depend on \ref PkgTriangulation3Summary "3D Triangulations".} \cgalPkgDependsOn{The dynamic algorithms depend on \ref PkgTriangulation3 "3D Triangulations".}
\cgalPkgBib{cgal:hs-ch3} \cgalPkgBib{cgal:hs-ch3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -3,7 +3,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgConvexHullDRef \ingroup PkgConvexHullDRef
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
An instance `C` of type `Convex_hull_d<R>` is the convex hull An instance `C` of type `Convex_hull_d<R>` is the convex hull
of a multi-set `S` of points in \f$ d\f$-dimensional space. We call of a multi-set `S` of points in \f$ d\f$-dimensional space. We call

View File

@ -1,7 +1,7 @@
namespace CGAL { namespace CGAL {
/*! /*!
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
converts the convex hull `C` to polyhedral surface stored in converts the convex hull `C` to polyhedral surface stored in
`P`. `P`.
@ -13,7 +13,7 @@ template <class R, class T, class HDS>
void convex_hull_d_to_polyhedron_3( const Convex_hull_d<R>& C, Polyhedron_3<T,HDS>& P) ; void convex_hull_d_to_polyhedron_3( const Convex_hull_d<R>& C, Polyhedron_3<T,HDS>& P) ;
/*! /*!
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead
constructs the representation of the surface of `C` as a constructs the representation of the surface of `C` as a
bidirected LEDA graph `G`. bidirected LEDA graph `G`.

View File

@ -3,7 +3,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgConvexHullDRef \ingroup PkgConvexHullDRef
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
<A NAME="Index_anchor_0"></A> <A NAME="Index_anchor_0"></A>

View File

@ -3,7 +3,7 @@ namespace CGAL {
/*! /*!
\ingroup PkgConvexHullDRef \ingroup PkgConvexHullDRef
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
An instance `DT` of type `Delaunay_d< R, Lifted_R >` is the An instance `DT` of type `Delaunay_d< R, Lifted_R >` is the
nearest and furthest site Delaunay triangulation of a set `S` of nearest and furthest site Delaunay triangulation of a set `S` of

View File

@ -2,7 +2,7 @@
\ingroup PkgConvexHullDConcepts \ingroup PkgConvexHullDConcepts
\cgalConcept \cgalConcept
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
Requirements of the traits class to be used with the Requirements of the traits class to be used with the
class `CGAL::Convex_hull_d`. class `CGAL::Convex_hull_d`.

View File

@ -2,7 +2,7 @@
\ingroup PkgConvexHullDConcepts \ingroup PkgConvexHullDConcepts
\cgalConcept \cgalConcept
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
Requirements of the second traits class to be used with the Requirements of the second traits class to be used with the
class `CGAL::Delaunay_d`. class `CGAL::Delaunay_d`.

View File

@ -2,7 +2,7 @@
\ingroup PkgConvexHullDConcepts \ingroup PkgConvexHullDConcepts
\cgalConcept \cgalConcept
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
Requirements of the first traits class to be used with the Requirements of the first traits class to be used with the
class `CGAL::Delaunay_d`. class `CGAL::Delaunay_d`.

View File

@ -7,7 +7,7 @@ namespace CGAL {
\anchor chapconvexhulld \anchor chapconvexhulld
\authors Susan Hert and Michael Seel \authors Susan Hert and Michael Seel
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
\section Convex_hull_dIntroduction Introduction \section Convex_hull_dIntroduction Introduction

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgConvexHullDRef \addtogroup PkgConvexHullDRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{dD Convex Hulls and Delaunay Triangulations,PkgConvexHullDSummary} \cgalPkgDescriptionBegin{dD Convex Hulls and Delaunay Triangulations,PkgConvexHullD}
\cgalPkgPicture{convex_hull_d-teaser.png} \cgalPkgPicture{convex_hull_d-teaser.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Susan Hert and Michael Seel} \cgalPkgAuthors{Susan Hert and Michael Seel}
@ -18,7 +18,7 @@
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd \cgalPkgDescriptionEnd
\deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulationsSummary should be used instead. \deprecated This package is deprecated since the version 4.6 of \cgal. The package \ref PkgTriangulations should be used instead.
A subset \f$ S \subseteq \mathbb{R}^d\f$ is convex if for any two points \f$ p\f$ and \f$ q\f$ A subset \f$ S \subseteq \mathbb{R}^d\f$ is convex if for any two points \f$ p\f$ and \f$ q\f$
in the set the line segment with endpoints \f$ p\f$ and \f$ q\f$ is contained in the set the line segment with endpoints \f$ p\f$ and \f$ q\f$ is contained

View File

@ -19,15 +19,15 @@ Iterators are widely used in \cgal too.
\cgal extends the idea of the iterator, which works for linear data \cgal extends the idea of the iterator, which works for linear data
structures, to circular data structures by defining the concept of structures, to circular data structures by defining the concept of
a circulator. a circulator.
\ref PkgHandlesAndCirculatorsSummary "Circulators" are quite similar to iterators, with the \ref PkgHandlesAndCirculators "Circulators" are quite similar to iterators, with the
major difference being the absence of a past-the-end position in a sequence. major difference being the absence of a past-the-end position in a sequence.
Note that circulators are NOT part of the \stl, but of \cgal. Note that circulators are NOT part of the \stl, but of \cgal.
In \cgal, we also define the concept of \ref PkgHandlesAndCirculatorsSummary "handle", In \cgal, we also define the concept of \ref PkgHandlesAndCirculators "handle",
which behaves roughly which behaves roughly
like a pointer to an object without an increment or decrement operation. like a pointer to an object without an increment or decrement operation.
More details about handles and their requirements can be found in More details about handles and their requirements can be found in
the \ref PkgHandlesAndCirculatorsSummary "chapter Circulators and Handles" the \ref PkgHandlesAndCirculators "chapter Circulators and Handles"
of the Support Library part of \cgal manual. of the Support Library part of \cgal manual.
Section \ref sechandle_vs_it_vs_circ below discusses when handles Section \ref sechandle_vs_it_vs_circ below discusses when handles
should be used in your code. should be used in your code.
@ -35,7 +35,7 @@ should be used in your code.
The concepts of iterators is relatively well described in textbooks such as The concepts of iterators is relatively well described in textbooks such as
Stroustrup's book (<I>The C++ Programming Language</I> \cgalCite{cgal:s-cpl-97}) Stroustrup's book (<I>The C++ Programming Language</I> \cgalCite{cgal:s-cpl-97})
and Austern's book (<I>Generic Programming and the \stl</I> \cgalCite{cgal:a-gps-98}) and Austern's book (<I>Generic Programming and the \stl</I> \cgalCite{cgal:a-gps-98})
and in chapter \ref PkgHandlesAndCirculatorsSummary "Handles and Circulators" and in chapter \ref PkgHandlesAndCirculators "Handles and Circulators"
of the <I>Support Library</I> part of the \cgal manual. of the <I>Support Library</I> part of the \cgal manual.
which also presents the concepts of handles and circulators. which also presents the concepts of handles and circulators.
Thus we will not give a full description of these concept here Thus we will not give a full description of these concept here
@ -325,7 +325,7 @@ over either a linear or circular sequence:
- `CGAL_For_all( ic1, ic2)` - `CGAL_For_all( ic1, ic2)`
- `CGAL_For_all_backwards( ic1, ic2)`. - `CGAL_For_all_backwards( ic1, ic2)`.
See the chapter \ref PkgHandlesAndCirculatorsSummary "Handles and Circulators" See the chapter \ref PkgHandlesAndCirculators "Handles and Circulators"
in the <I>Support Library</I> part of \cgal manual in the <I>Support Library</I> part of \cgal manual
for more information and examples. for more information and examples.

View File

@ -601,7 +601,7 @@ and designed to partition graphs and produce fill-reducing matrix orderings.
\cgal offers wrappers around some of the methods of the \sc{METIS} library \cgal offers wrappers around some of the methods of the \sc{METIS} library
to allow the partitioning of graphs that are models of the concepts of the to allow the partitioning of graphs that are models of the concepts of the
<A HREF="http://www.boost.org/libs/graph/doc/index.html">Boost Graph Library</A>, <A HREF="http://www.boost.org/libs/graph/doc/index.html">Boost Graph Library</A>,
and, by extension, of surface meshes (see Section \ref BGLPartitioning of the package \ref PkgBGLSummary). and, by extension, of surface meshes (see Section \ref BGLPartitioning of the package \ref PkgBGL).
More information is available on the METIS library More information is available on the METIS library
at <A HREF="http://glaros.dtc.umn.edu/gkhome/metis/metis/overview">`http://glaros.dtc.umn.edu/gkhome/metis/metis/overview`</A>. at <A HREF="http://glaros.dtc.umn.edu/gkhome/metis/metis/overview">`http://glaros.dtc.umn.edu/gkhome/metis/metis/overview`</A>.

View File

@ -318,7 +318,7 @@ This function only compiles if the `operator<(..)` is defined for the type used
and we say that the type must be a model of `LessThanComparable`. and we say that the type must be a model of `LessThanComparable`.
An example for a concept with required free functions is the `HalfedgeListGraph` in the An example for a concept with required free functions is the `HalfedgeListGraph` in the
\cgal package \ref PkgBGLSummary. In order to be a model of `HalfedgeListGraph` a class `G` \cgal package \ref PkgBGL. In order to be a model of `HalfedgeListGraph` a class `G`
there must be a global function `halfedges(const G&)`, etc. there must be a global function `halfedges(const G&)`, etc.
An example for a concept with a required traits class is `InputIterator`. An example for a concept with a required traits class is `InputIterator`.

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgEnvelope2Ref \addtogroup PkgEnvelope2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Envelopes,PkgEnvelope2Summary} \cgalPkgDescriptionBegin{2D Envelopes,PkgEnvelope2}
\cgalPkgPicture{Envelope_2/fig/Envelope_2.png} \cgalPkgPicture{Envelope_2/fig/Envelope_2.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Ron Wein} \cgalPkgAuthor{Ron Wein}
@ -13,7 +13,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.3} \cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgArrangement2Summary} \cgalPkgDependsOn{\ref PkgArrangement2}
\cgalPkgBib{cgal:w-e2} \cgalPkgBib{cgal:w-e2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgEnvelope3Ref \addtogroup PkgEnvelope3Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{3D Envelopes,PkgEnvelope3Summary} \cgalPkgDescriptionBegin{3D Envelopes,PkgEnvelope3}
\cgalPkgPicture{Envelope_3/fig/Envelope_3.png} \cgalPkgPicture{Envelope_3/fig/Envelope_3.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman} \cgalPkgAuthors{Dan Halperin, Michal Meyerovitch, Ron Wein, and Baruch Zukerman}
@ -13,7 +13,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.3} \cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgArrangement2Summary} \cgalPkgDependsOn{\ref PkgArrangement2}
\cgalPkgBib{cgal:mwz-e3} \cgalPkgBib{cgal:mwz-e3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{3D Envelopes,envelope_3.zip,L1 Voronoi Diagram,l1_voronoi_diagram_2.zip} \cgalPkgDemo{3D Envelopes,envelope_3.zip,L1 Voronoi Diagram,l1_voronoi_diagram_2.zip}

View File

@ -8,7 +8,7 @@
/*! /*!
\addtogroup PkgGeneralizedMapsRef \addtogroup PkgGeneralizedMapsRef
\cgalPkgDescriptionBegin{Generalized Maps,PkgGeneralizedMapsSummary} \cgalPkgDescriptionBegin{Generalized Maps,PkgGeneralizedMaps}
\cgalPkgPicture{gmap_logo.png} \cgalPkgPicture{gmap_logo.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Guillaume Damiand} \cgalPkgAuthor{Guillaume Damiand}

View File

@ -3,7 +3,7 @@
/// \ingroup PkgGeneratorsRef /// \ingroup PkgGeneratorsRef
/*! /*!
\addtogroup PkgGeneratorsRef \addtogroup PkgGeneratorsRef
\cgalPkgDescriptionBegin{Geometric Object Generators,PkgGeneratorsSummary} \cgalPkgDescriptionBegin{Geometric Object Generators,PkgGenerators}
\cgalPkgPicture{dice.png} \cgalPkgPicture{dice.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pedro M. M. de Castro, Olivier Devillers, Susan Hert, Michael Hoffmann, Lutz Kettner, Sven Schönherr, Alexandru Tifrea, and Maxime Gimeno} \cgalPkgAuthors{Pedro M. M. de Castro, Olivier Devillers, Susan Hert, Michael Hoffmann, Lutz Kettner, Sven Schönherr, Alexandru Tifrea, and Maxime Gimeno}

View File

@ -2,7 +2,7 @@
/*! /*!
\addtogroup PkgGeomviewRef \addtogroup PkgGeomviewRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Geomview,PkgGeomviewSummary} \cgalPkgDescriptionBegin{Geomview,PkgGeomview}
\cgalPkgPicture{geomview.png} \cgalPkgPicture{geomview.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Andreas Fabri and Sylvain Pion} \cgalPkgAuthors{Andreas Fabri and Sylvain Pion}

View File

@ -9,7 +9,7 @@
/*! /*!
\addtogroup PkgGraphicsViewRef \addtogroup PkgGraphicsViewRef
\cgalPkgDescriptionBegin{CGAL and the Qt Graphics View Framework,PkgGraphicsViewSummary} \cgalPkgDescriptionBegin{CGAL and the Qt Graphics View Framework,PkgGraphicsView}
\cgalPkgPicture{detail.png} \cgalPkgPicture{detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Andreas Fabri and Laurent Rineau} \cgalPkgAuthors{Andreas Fabri and Laurent Rineau}

View File

@ -20,7 +20,7 @@
/*! /*!
\addtogroup PkgHDSRef \addtogroup PkgHDSRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Halfedge Data Structures,PkgHDSSummary} \cgalPkgDescriptionBegin{Halfedge Data Structures,PkgHDS}
\cgalPkgPicture{HalfedgeDS/fig/HalfedgeDS-teaser-small.png} \cgalPkgPicture{HalfedgeDS/fig/HalfedgeDS-teaser-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Lutz Kettner} \cgalPkgAuthor{Lutz Kettner}

View File

@ -6,7 +6,7 @@
/*! /*!
\addtogroup PkgInscribedAreasRef \addtogroup PkgInscribedAreasRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Inscribed Areas,PkgInscribedAreasSummary} \cgalPkgDescriptionBegin{Inscribed Areas,PkgInscribedAreas}
\cgalPkgPicture{ler-detail.png} \cgalPkgPicture{ler-detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Michael Hoffmann and Eli Packer} \cgalPkgAuthors{Michael Hoffmann and Eli Packer}

View File

@ -95,7 +95,7 @@ diagrams, also known as <em>power diagrams</em>, are obtained by considering wei
defined between two weighted points \f$ (p, \omega_p) \f$ and \f$ (q, \omega_q) \f$ by defined between two weighted points \f$ (p, \omega_p) \f$ and \f$ (q, \omega_q) \f$ by
\f$ \Pi( (p, \omega_p), (q, \omega_q) ) = pq^2 - \omega_p - \omega_q \f$. \f$ \Pi( (p, \omega_p), (q, \omega_q) ) = pq^2 - \omega_p - \omega_q \f$.
See \link Subsection_2D_Triangulations_Regular_Description this section \endlink See \link Subsection_2D_Triangulations_Regular_Description this section \endlink
of the package \ref PkgTriangulation2Summary for an in-depth description of power diagrams. of the package \ref PkgTriangulation2 for an in-depth description of power diagrams.
\cgalFigureBegin{figrn_coords, rn_coords.svg} \cgalFigureBegin{figrn_coords, rn_coords.svg}
Illustration of regular neighbor coordinates. The point set is the same Illustration of regular neighbor coordinates. The point set is the same

View File

@ -14,7 +14,7 @@
/*! /*!
\addtogroup PkgInterpolation2Ref \addtogroup PkgInterpolation2Ref
\cgalPkgDescriptionBegin{2D and Surface Function Interpolation,PkgInterpolation2Summary} \cgalPkgDescriptionBegin{2D and Surface Function Interpolation,PkgInterpolation2}
\cgalPkgPicture{interpolation.png} \cgalPkgPicture{interpolation.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Julia Flötotto} \cgalPkgAuthor{Julia Flötotto}

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgIntervalSkipListRef \addtogroup PkgIntervalSkipListRef
\cgalPkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary} \cgalPkgDescriptionBegin{Interval Skip List,PkgIntervalSkipList}
\cgalPkgPicture{Interval_skip_list/fig/query.png} \cgalPkgPicture{Interval_skip_list/fig/query.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Andreas Fabri} \cgalPkgAuthor{Andreas Fabri}

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgJet_fitting_3Ref \addtogroup PkgJet_fitting_3Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Estimation of Local Differential Properties of Point-Sampled Surfaces,PkgJet_fitting_3Summary} \cgalPkgDescriptionBegin{Estimation of Local Differential Properties of Point-Sampled Surfaces,PkgJet_fitting_3}
\cgalPkgPicture{DavidDetail.png} \cgalPkgPicture{DavidDetail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Marc Pouget and Frédéric Cazals} \cgalPkgAuthors{Marc Pouget and Frédéric Cazals}
@ -13,7 +13,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.3} \cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgSolverSummary and \ref thirdpartyEigen} \cgalPkgDependsOn{\ref PkgSolver and \ref thirdpartyEigen}
\cgalPkgBib{cgal:pc-eldp} \cgalPkgBib{cgal:pc-eldp}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -35,7 +35,7 @@
/*! /*!
\addtogroup PkgKernel23Ref \addtogroup PkgKernel23Ref
\cgalPkgDescriptionBegin{2D and 3D Linear Geometry Kernel,PkgKernel23Summary} \cgalPkgDescriptionBegin{2D and 3D Linear Geometry Kernel,PkgKernel23}
\cgalPkgPicture{pointSegmentTriangle.png} \cgalPkgPicture{pointSegmentTriangle.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Hervé Brönnimann, Andreas Fabri, Geert-Jan Giezeman, Susan Hert, Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Stefan Schirra} \cgalPkgAuthors{Hervé Brönnimann, Andreas Fabri, Geert-Jan Giezeman, Susan Hert, Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Stefan Schirra}

View File

@ -22,7 +22,7 @@
/*! /*!
\addtogroup PkgKernelDRef \addtogroup PkgKernelDRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{dD Geometry Kernel,PkgKernelDSummary} \cgalPkgDescriptionBegin{dD Geometry Kernel,PkgKernelD}
\cgalPkgPicture{hypercube.png} \cgalPkgPicture{hypercube.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Michael Seel} \cgalPkgAuthor{Michael Seel}

View File

@ -30,7 +30,7 @@
/*! /*!
\addtogroup PkgLinearCellComplexRef \addtogroup PkgLinearCellComplexRef
\cgalPkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplexSummary} \cgalPkgDescriptionBegin{Linear Cell Complex,PkgLinearCellComplex}
\cgalPkgPicture{lcc_logo.png} \cgalPkgPicture{lcc_logo.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Guillaume Damiand} \cgalPkgAuthor{Guillaume Damiand}
@ -39,8 +39,8 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.0} \cgalPkgSince{4.0}
\cgalPkgDependsOn{\ref PkgCombinatorialMapsSummary} \cgalPkgDependsOn{\ref PkgCombinatorialMaps}
\cgalPkgDependsOn{\ref PkgGeneralizedMapsSummary} \cgalPkgDependsOn{\ref PkgGeneralizedMaps}
\cgalPkgBib{cgal:d-lcc-12} \cgalPkgBib{cgal:d-lcc-12}
\cgalPkgLicense{\ref licensesLGPL "LGPL"} \cgalPkgLicense{\ref licensesLGPL "LGPL"}
\cgalPkgDemo{3D Linear Cell Complex,linear_cell_complex_3.zip} \cgalPkgDemo{3D Linear Cell Complex,linear_cell_complex_3.zip}

View File

@ -6,7 +6,7 @@
/*! /*!
\addtogroup PkgMatrixSearchRef \addtogroup PkgMatrixSearchRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Monotone and Sorted Matrix Search,PkgMatrixSearchSummary} \cgalPkgDescriptionBegin{Monotone and Sorted Matrix Search,PkgMatrixSearch}
\cgalPkgPicture{matrix.png} \cgalPkgPicture{matrix.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Michael Hoffmann} \cgalPkgAuthor{Michael Hoffmann}

View File

@ -13,7 +13,7 @@
/*! /*!
\addtogroup PkgMesh2Ref \addtogroup PkgMesh2Ref
\cgalPkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2Summary} \cgalPkgDescriptionBegin{2D Conforming Triangulations and Meshes,PkgMesh2}
\cgalPkgPicture{Mesh_2/fig/delaunaymesh-small.png} \cgalPkgPicture{Mesh_2/fig/delaunaymesh-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Laurent Rineau} \cgalPkgAuthor{Laurent Rineau}
@ -27,7 +27,7 @@ The package can handle intersecting input constraints and set no restriction on
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.1} \cgalPkgSince{3.1}
\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgTriangulation2}
\cgalPkgBib{cgal:r-ctm2} \cgalPkgBib{cgal:r-ctm2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{2D Mesh Generator,constrained_delaunay_triangulation_2.zip} \cgalPkgDemo{2D Mesh Generator,constrained_delaunay_triangulation_2.zip}

View File

@ -34,7 +34,7 @@
/*! /*!
\addtogroup PkgMesh_3Ref \addtogroup PkgMesh_3Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{3D Mesh Generation,PkgMesh_3Summary} \cgalPkgDescriptionBegin{3D Mesh Generation,PkgMesh_3}
\cgalPkgPicture{Mesh_3/fig/multilabel_mesher_small.jpg} \cgalPkgPicture{Mesh_3/fig/multilabel_mesher_small.jpg}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pierre Alliez, Clément Jamin, Laurent Rineau, Stéphane Tayeb, Jane Tournois, Mariette Yvinec} \cgalPkgAuthors{Pierre Alliez, Clément Jamin, Laurent Rineau, Stéphane Tayeb, Jane Tournois, Mariette Yvinec}
@ -43,7 +43,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.5} \cgalPkgSince{3.5}
\cgalPkgDependsOn{\ref PkgTriangulation3Summary and \ref thirdpartyEigen} \cgalPkgDependsOn{\ref PkgTriangulation3 and \ref thirdpartyEigen}
\cgalPkgBib{cgal:rty-m3} \cgalPkgBib{cgal:rty-m3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -5,7 +5,7 @@
/*! /*!
\addtogroup PkgMinkowskiSum2Ref \addtogroup PkgMinkowskiSum2Ref
\cgalPkgDescriptionBegin{2D Minkowski Sums,PkgMinkowskiSum2Summary} \cgalPkgDescriptionBegin{2D Minkowski Sums,PkgMinkowskiSum2}
\cgalPkgPicture{Minkowski_sum_2/fig/Minkowski_sum_2.png} \cgalPkgPicture{Minkowski_sum_2/fig/Minkowski_sum_2.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Ron Wein, Alon Baram, Eyal Flato, Efi Fogel, Michael Hemmer, Sebastian Morr} \cgalPkgAuthor{Ron Wein, Alon Baram, Eyal Flato, Efi Fogel, Michael Hemmer, Sebastian Morr}
@ -14,7 +14,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.3} \cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgArrangement2Summary, \ref PkgAABB_treeSummary, \ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgArrangement2, \ref PkgAABB_tree, \ref PkgTriangulation2}
\cgalPkgBib{cgal:w-rms2} \cgalPkgBib{cgal:w-rms2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd

View File

@ -3,7 +3,7 @@
/*! /*!
\addtogroup PkgMinkowskiSum3Ref \addtogroup PkgMinkowskiSum3Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{3D Minkowski Sum of Polyhedra,PkgMinkowskiSum3Summary} \cgalPkgDescriptionBegin{3D Minkowski Sum of Polyhedra,PkgMinkowskiSum3}
\cgalPkgPicture{Minkowski_sum_3/fig/Minkowski_sum_3_teaser.png} \cgalPkgPicture{Minkowski_sum_3/fig/Minkowski_sum_3_teaser.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Peter Hachenberger} \cgalPkgAuthor{Peter Hachenberger}
@ -12,7 +12,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.5} \cgalPkgSince{3.5}
\cgalPkgDependsOn{\ref PkgNef3Summary\, \ref PkgConvexDecomposition3Summary} \cgalPkgDependsOn{\ref PkgNef3\, \ref PkgConvexDecomposition3}
\cgalPkgBib{cgal:h-msp3} \cgalPkgBib{cgal:h-msp3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -3,7 +3,7 @@
/// \ingroup PkgProfilingToolsRef /// \ingroup PkgProfilingToolsRef
/*! /*!
\addtogroup PkgProfilingToolsRef \addtogroup PkgProfilingToolsRef
\cgalPkgDescriptionBegin{Profiling tools\, Hash Map\, Union-find\, Modifiers,PkgProfilingToolsSummary} \cgalPkgDescriptionBegin{Profiling tools\, Hash Map\, Union-find\, Modifiers,PkgProfilingTools}
\cgalPkgPicture{stopwatch.png} \cgalPkgPicture{stopwatch.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Lutz Kettner, Sylvain Pion, and Michael Seel} \cgalPkgAuthors{Lutz Kettner, Sylvain Pion, and Michael Seel}

View File

@ -3,7 +3,7 @@
/// \ingroup PkgModularArithmeticRef /// \ingroup PkgModularArithmeticRef
/*! /*!
\addtogroup PkgModularArithmeticRef \addtogroup PkgModularArithmeticRef
\cgalPkgDescriptionBegin{Modular Arithmetic,PkgModularArithmeticSummary} \cgalPkgDescriptionBegin{Modular Arithmetic,PkgModularArithmetic}
\cgalPkgPicture{Modular_arithmetic.png} \cgalPkgPicture{Modular_arithmetic.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Michael Hemmer and Sylvain Pion} \cgalPkgAuthors{Michael Hemmer and Sylvain Pion}

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgNef2Ref \addtogroup PkgNef2Ref
\cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons,PkgNef2Summary} \cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons,PkgNef2}
\cgalPkgPicture{complex-teaser.png} \cgalPkgPicture{complex-teaser.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Michael Seel} \cgalPkgAuthor{Michael Seel}

View File

@ -7,7 +7,7 @@
/*! /*!
\addtogroup PkgNef3Ref \addtogroup PkgNef3Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{3D Boolean Operations on Nef Polyhedra,PkgNef3Summary} \cgalPkgDescriptionBegin{3D Boolean Operations on Nef Polyhedra,PkgNef3}
\cgalPkgPicture{Nef_3-teaser.png} \cgalPkgPicture{Nef_3-teaser.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Peter Hachenberger and Lutz Kettner} \cgalPkgAuthors{Peter Hachenberger and Lutz Kettner}
@ -16,7 +16,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.1} \cgalPkgSince{3.1}
\cgalPkgDependsOn{\ref PkgNef2Summary\, \ref PkgNefS2Summary} \cgalPkgDependsOn{\ref PkgNef2\, \ref PkgNefS2}
\cgalPkgBib{cgal:hk-bonp3} \cgalPkgBib{cgal:hk-bonp3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -2,7 +2,7 @@
/*! /*!
\addtogroup PkgNefS2Ref \addtogroup PkgNefS2Ref
\cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons Embedded on the Sphere,PkgNefS2Summary} \cgalPkgDescriptionBegin{2D Boolean Operations on Nef Polygons Embedded on the Sphere,PkgNefS2}
\cgalPkgPicture{Nef_S2-teaser-small.png} \cgalPkgPicture{Nef_S2-teaser-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Peter Hachenberger and Lutz Kettner} \cgalPkgAuthors{Peter Hachenberger and Lutz Kettner}
@ -11,7 +11,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.1} \cgalPkgSince{3.1}
\cgalPkgDependsOn{\ref PkgNef2Summary} \cgalPkgDependsOn{\ref PkgNef2}
\cgalPkgBib{cgal:hk-bonpes2} \cgalPkgBib{cgal:hk-bonpes2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd

View File

@ -34,7 +34,7 @@
/*! /*!
\addtogroup PkgNumberTypesRef \addtogroup PkgNumberTypesRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Number Types,PkgNumberTypesSummary} \cgalPkgDescriptionBegin{Number Types,PkgNumberTypes}
\cgalPkgPicture{illustration.png} \cgalPkgPicture{illustration.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Michael Hemmer, Susan Hert, Sylvain Pion, and Stefan Schirra} \cgalPkgAuthors{Michael Hemmer, Susan Hert, Sylvain Pion, and Stefan Schirra}

View File

@ -9,7 +9,7 @@
/*! /*!
\addtogroup PkgOptimalTransportationReconstruction2Ref \addtogroup PkgOptimalTransportationReconstruction2Ref
\cgalPkgDescriptionBegin{Optimal Transportation Curve Reconstruction, PkgOptimalTransportationReconstruction2Summary} \cgalPkgDescriptionBegin{Optimal Transportation Curve Reconstruction, PkgOptimalTransportationReconstruction2}
\cgalPkgPicture{RS_2_small.png} \cgalPkgPicture{RS_2_small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Pierre Alliez, David Cohen-Steiner, Fernando de Goes, Clément Jamin, Ivo Vigan} \cgalPkgAuthor{Pierre Alliez, David Cohen-Steiner, Fernando de Goes, Clément Jamin, Ivo Vigan}
@ -18,7 +18,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.8} \cgalPkgSince{4.8}
\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgTriangulation2}
\cgalPkgBib{cgal:gavj-rs} \cgalPkgBib{cgal:gavj-rs}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{2D Optimal Transportation Curve Reconstruction,otr2.zip} \cgalPkgDemo{2D Optimal Transportation Curve Reconstruction,otr2.zip}

View File

@ -8,7 +8,7 @@
/*! /*!
\addtogroup PkgPolygonPartitioning2Ref \addtogroup PkgPolygonPartitioning2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Polygon Partitioning,PkgPolygonPartitioning2Summary} \cgalPkgDescriptionBegin{2D Polygon Partitioning,PkgPolygonPartitioning2}
\cgalPkgPicture{Partition_2/fig/Partition_2-teaser-small.png} \cgalPkgPicture{Partition_2/fig/Partition_2-teaser-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Susan Hert} \cgalPkgAuthor{Susan Hert}

View File

@ -18,7 +18,7 @@
/*! /*!
\addtogroup PkgPeriodic2Triangulation2Ref \addtogroup PkgPeriodic2Triangulation2Ref
\cgalPkgDescriptionBegin{2D Periodic Triangulations,PkgPeriodic2Triangulation2Summary} \cgalPkgDescriptionBegin{2D Periodic Triangulations,PkgPeriodic2Triangulation2}
\cgalPkgPicture{Periodic_2_triangulation_2/fig/p2Delaunay2_thumb.png} \cgalPkgPicture{Periodic_2_triangulation_2/fig/p2Delaunay2_thumb.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
@ -29,7 +29,7 @@
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.3} \cgalPkgSince{4.3}
\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgTriangulation2}
\cgalPkgBib{cgal:k-pt2-13} \cgalPkgBib{cgal:k-pt2-13}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Periodic Delaunay Triangulation,Periodic_2_Delaunay_triangulation_2.zip} \cgalPkgDemo{Periodic Delaunay Triangulation,Periodic_2_Delaunay_triangulation_2.zip}

View File

@ -24,19 +24,19 @@
/*! /*!
\addtogroup PkgPeriodic_3_mesh_3Ref \addtogroup PkgPeriodic_3_mesh_3Ref
\cgalPkgDescriptionBegin{3D Periodic Mesh Generation,PkgPeriodic_3_mesh_3Summary} \cgalPkgDescriptionBegin{3D Periodic Mesh Generation,PkgPeriodic_3_mesh_3}
\cgalPkgPicture{periodic_mesher_small.png} \cgalPkgPicture{periodic_mesher_small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Mikhail Bogdanov, Aymeric Pellé, Mael Rouxel-Labbé, and Monique Teillaud} \cgalPkgAuthors{Mikhail Bogdanov, Aymeric Pellé, Mael Rouxel-Labbé, and Monique Teillaud}
\cgalPkgDesc{This package is devoted to the generation of isotropic simplicial meshes \cgalPkgDesc{This package is devoted to the generation of isotropic simplicial meshes
discretizing periodic 3D domains. The domain to be meshed is a region of discretizing periodic 3D domains. The domain to be meshed is a region of
the three-dimensional flat torus. The periodic mesh generator provides users with the same the three-dimensional flat torus. The periodic mesh generator provides users with the same
flexibility that is offered in the \ref PkgMesh_3Summary package.} flexibility that is offered in the \ref PkgMesh_3 package.}
\cgalPkgManuals{Chapter_3D_Periodic_Mesh_Generation,PkgPeriodic_3_mesh_3Ref} \cgalPkgManuals{Chapter_3D_Periodic_Mesh_Generation,PkgPeriodic_3_mesh_3Ref}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.13} \cgalPkgSince{4.13}
\cgalPkgDependsOn{\ref PkgPeriodic3Triangulation3Summary, \ref PkgMesh_3Summary, and \ref thirdpartyEigen} \cgalPkgDependsOn{\ref PkgPeriodic3Triangulation3, \ref PkgMesh_3, and \ref thirdpartyEigen}
\cgalPkgBib{cgal:btprl-p3m3} \cgalPkgBib{cgal:btprl-p3m3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd
@ -49,14 +49,14 @@ manipulating duplicate points, well-chosen "dummy" points are inserted
at the beginning of the meshing process, thus ensuring that the underlying periodic at the beginning of the meshing process, thus ensuring that the underlying periodic
triangulation forms at all times a simplicial complex within a single copy of the periodic space \f$ \mathbb T_c^3\f$ triangulation forms at all times a simplicial complex within a single copy of the periodic space \f$ \mathbb T_c^3\f$
(see Sections \ref P3Triangulation3secspace and \ref P3Triangulation3secintro (see Sections \ref P3Triangulation3secspace and \ref P3Triangulation3secintro
of the package \ref PkgPeriodic3Triangulation3Summary). of the package \ref PkgPeriodic3Triangulation3).
By identifying a single copy of the flat torus \f$ \mathbb T_c^3\f$ (where `c` By identifying a single copy of the flat torus \f$ \mathbb T_c^3\f$ (where `c`
denotes the period) with a cube of side `c` in \f$ \mathbb R^3\f$, the meshing process denotes the period) with a cube of side `c` in \f$ \mathbb R^3\f$, the meshing process
can be exclusively conducted within a cube of side `c`. can be exclusively conducted within a cube of side `c`.
The mesh within a single copy is created using %CGAL's \ref PkgMesh_3Summary package, but The mesh within a single copy is created using %CGAL's \ref PkgMesh_3 package, but
because %CGAL's \ref PkgMesh_3Summary package aims to mesh traditional (non-periodic) because %CGAL's \ref PkgMesh_3 package aims to mesh traditional (non-periodic)
domains, an interface is necessary between %CGAL's \ref PkgMesh_3Summary package domains, an interface is necessary between %CGAL's \ref PkgMesh_3 package
and %CGAL's \ref PkgPeriodic3Triangulation3Summary. and %CGAL's \ref PkgPeriodic3Triangulation3.
This package offers these interfaces. This package offers these interfaces.
\cgalClassifedRefPages \cgalClassifedRefPages
@ -64,9 +64,9 @@ This package offers these interfaces.
## Concepts ## ## Concepts ##
This package relies entirely on the \ref PkgMesh_3Concepts This package relies entirely on the \ref PkgMesh_3Concepts
and the \ref PkgMesh_3SecondaryConcepts described in the \ref PkgMesh_3Summary package. and the \ref PkgMesh_3SecondaryConcepts described in the \ref PkgMesh_3 package.
The following concepts are essentially identical to the concepts `MeshDomain_3` The following concepts are essentially identical to the concepts `MeshDomain_3`
and `MeshDomainWithFeatures_3` in the package \ref PkgMesh_3Summary : and `MeshDomainWithFeatures_3` in the package \ref PkgMesh_3 :
- `Periodic_3MeshDomain_3` - `Periodic_3MeshDomain_3`
- `Periodic_3MeshDomainWithFeatures_3` - `Periodic_3MeshDomainWithFeatures_3`
@ -97,7 +97,7 @@ The following functions handle the generation of a periodic mesh:
## Classes and Functions of `Mesh_3` ## ## Classes and Functions of `Mesh_3` ##
Many classes and functions used by this package are defined within the package Many classes and functions used by this package are defined within the package
\ref PkgMesh_3Summary, see \ref PkgMesh_3MeshClasses, \ref PkgMesh_3Domains, \ref PkgMesh_3, see \ref PkgMesh_3MeshClasses, \ref PkgMesh_3Domains,
and \ref PkgMesh_3Parameters. and \ref PkgMesh_3Parameters.
## Input/Output Functions ## ## Input/Output Functions ##

View File

@ -20,7 +20,7 @@ A cut view of a periodic mesh.
This package is devoted to the generation of isotropic simplicial This package is devoted to the generation of isotropic simplicial
meshes discretizing periodic 3D domains. meshes discretizing periodic 3D domains.
The domain to be meshed is a subset of the three-dimensional flat torus The domain to be meshed is a subset of the three-dimensional flat torus
(see Section \ref P3Triangulation3secspace of the package \ref PkgPeriodic3Triangulation3Summary). (see Section \ref P3Triangulation3secspace of the package \ref PkgPeriodic3Triangulation3).
The domain may be connected or composed of multiple components The domain may be connected or composed of multiple components
and/or subdivided in several subdomains. and/or subdivided in several subdomains.
The current implementation provides classes to represent The current implementation provides classes to represent
@ -60,24 +60,24 @@ by a mesh optimization phase to remove slivers and provide a good quality mesh.
\subsection Periodic_3_mesh_3Mesh_3 Relation to the 3D Mesh Generation and 3D Periodic Triangulations Packages \subsection Periodic_3_mesh_3Mesh_3 Relation to the 3D Mesh Generation and 3D Periodic Triangulations Packages
This package is fundamentally linked to the package \ref PkgMesh_3Summary, This package is fundamentally linked to the package \ref PkgMesh_3,
which is devoted to the generation of isotropic simplicial which is devoted to the generation of isotropic simplicial
meshes discretizing (non-periodic) 3D domains and to the \ref PkgPeriodic3Triangulation3Summary of %CGAL, meshes discretizing (non-periodic) 3D domains and to the \ref PkgPeriodic3Triangulation3 of %CGAL,
which are used as underlying triangulation structures of the mesh. which are used as underlying triangulation structures of the mesh.
A periodic mesh extends, by definition, infinitely in space. We consider the flat torus \f$ \mathbb T_c^3\f$, A periodic mesh extends, by definition, infinitely in space. We consider the flat torus \f$ \mathbb T_c^3\f$,
whose <I>canonical cube</I> has side length `c` (this canonical cube is named <I>original domain</I> whose <I>canonical cube</I> has side length `c` (this canonical cube is named <I>original domain</I>
in Chapter \ref PkgPeriodic3Triangulation3Summary; we rename it here to avoid the confusion in Chapter \ref PkgPeriodic3Triangulation3; we rename it here to avoid the confusion
with the domain defined in Chapter \ref PkgMesh_3Summary). Well-chosen "dummy" points with the domain defined in Chapter \ref PkgMesh_3). Well-chosen "dummy" points
are inserted at the beginning of the meshing process, ensuring that the projection are inserted at the beginning of the meshing process, ensuring that the projection
of the periodic triangulation into the flat torus \f$ \mathbb T_c^3\f$ forms at all times a simplicial complex of the periodic triangulation into the flat torus \f$ \mathbb T_c^3\f$ forms at all times a simplicial complex
(see Sections \ref P3Triangulation3secspace and \ref P3Triangulation3secintro (see Sections \ref P3Triangulation3secspace and \ref P3Triangulation3secintro
of the manual of 3D periodic triangulations). of the manual of 3D periodic triangulations).
Thanks to this construction, the meshing process can be exclusively conducted Thanks to this construction, the meshing process can be exclusively conducted
within the canonical cube. within the canonical cube.
The mesh can then be created using the \ref PkgMesh_3Summary package of %CGAL. The mesh can then be created using the \ref PkgMesh_3 package of %CGAL.
As this package originally aims to mesh non-periodic domains of \f$ \mathbb R^3\f$, an interface As this package originally aims to mesh non-periodic domains of \f$ \mathbb R^3\f$, an interface
is necessary between the packages \ref PkgMesh_3Summary and \ref PkgPeriodic3Triangulation3Summary. is necessary between the packages \ref PkgMesh_3 and \ref PkgPeriodic3Triangulation3.
This package provides this interface. This package provides this interface.
\subsection Periodic_3_mesh_3InputDomain Input Domain \subsection Periodic_3_mesh_3InputDomain Input Domain
@ -227,7 +227,7 @@ and to guarantee that the refinement process terminates
whatever may be the dihedral angles formed by input surface patches incident to a whatever may be the dihedral angles formed by input surface patches incident to a
given 1-feature or the angles formed by two 1-features incident to a 0-feature. given 1-feature or the angles formed by two 1-features incident to a 0-feature.
See Section \ref Mesh_3Protectionof0and1dimensionalExposed in the documentation See Section \ref Mesh_3Protectionof0and1dimensionalExposed in the documentation
of the package \ref PkgMesh_3Summary for further information. of the package \ref PkgMesh_3 for further information.
Section \ref Periodic_3_mesh_3MeshingDomainswithSharpFeatures details how Section \ref Periodic_3_mesh_3MeshingDomainswithSharpFeatures details how
to prescribe sharp features and examples of periodic meshes with features. to prescribe sharp features and examples of periodic meshes with features.
@ -236,7 +236,7 @@ to prescribe sharp features and examples of periodic meshes with features.
The optimization phase is a succession of optimization processes which aim to The optimization phase is a succession of optimization processes which aim to
improve the quality of the mesh in terms of shape of its elements. improve the quality of the mesh in terms of shape of its elements.
All the optimizers offered by the package \ref PkgMesh_3Summary are also available All the optimizers offered by the package \ref PkgMesh_3 are also available
for periodic mesh generation: for periodic mesh generation:
- The Lloyd and ODT-smoother are global optimizers, moving the mesh vertices - The Lloyd and ODT-smoother are global optimizers, moving the mesh vertices
@ -245,7 +245,7 @@ to minimize a mesh energy.
the worst mesh elements. the worst mesh elements.
See Sections \ref Mesh_3OptimizationPhase, \ref Mesh_3TheOptimizationParameters, See Sections \ref Mesh_3OptimizationPhase, \ref Mesh_3TheOptimizationParameters,
and \ref Mesh_3TuningMeshOptimization in the documentation of the package \ref PkgMesh_3Summary and \ref Mesh_3TuningMeshOptimization in the documentation of the package \ref PkgMesh_3
for further information. for further information.
\section Periodic_3_mesh_3_section_interface Interface \section Periodic_3_mesh_3_section_interface Interface
@ -416,7 +416,7 @@ This section presents various use cases of the periodic mesh generator.
\subsection Periodic_3_mesh_3SubMultipleCopies Visualizing Multiple Copies of a Periodic Mesh \subsection Periodic_3_mesh_3SubMultipleCopies Visualizing Multiple Copies of a Periodic Mesh
Generated meshes can be output to the `.mesh` file format, which can be visualized with the demo Generated meshes can be output to the `.mesh` file format, which can be visualized with the demo
of the package \ref PkgPolyhedronSummary. The function \link PkgPeriodic_3_mesh_3IOFunctions `CGAL::output_periodic_mesh_to_medit()` \endlink of the package \ref PkgPolyhedron. The function \link PkgPeriodic_3_mesh_3IOFunctions `CGAL::output_periodic_mesh_to_medit()` \endlink
takes a stream, a mesh complex, and - optionally - the number of periodic copies that should be drawn, takes a stream, a mesh complex, and - optionally - the number of periodic copies that should be drawn,
making it easier to observe the periodicity of the result. making it easier to observe the periodicity of the result.
\cgalFigureRef{Periodic_3_mesh_3Periodic_copies} illustrates the different output \cgalFigureRef{Periodic_3_mesh_3Periodic_copies} illustrates the different output
@ -674,16 +674,16 @@ A periodic mesh without (left) and with (right) sharp features protection.
Advanced use cases of the 3D mesh generator with implicit domains, its optimizers, Advanced use cases of the 3D mesh generator with implicit domains, its optimizers,
and protection mechanisms can be found in Section \ref Mesh_3_section_examples and protection mechanisms can be found in Section \ref Mesh_3_section_examples
of the package \ref PkgMesh_3Summary. of the package \ref PkgMesh_3.
\section Periodic_3_mesh_3DesignAndImpl Design and Implementation History \section Periodic_3_mesh_3DesignAndImpl Design and Implementation History
\subsection Periodic_3_mesh_3TheoreticalFoundations Theoretical Foundations \subsection Periodic_3_mesh_3TheoreticalFoundations Theoretical Foundations
Theoretical foundations of periodic meshes are explained in detail in the package Theoretical foundations of periodic meshes are explained in detail in the package
\ref PkgPeriodic3Triangulation3Summary. \ref PkgPeriodic3Triangulation3.
For the theoretical foundations of the mesh generation process, see Section For the theoretical foundations of the mesh generation process, see Section
\ref Mesh_3TheoreticalFoundations of the package \ref PkgMesh_3Summary. \ref Mesh_3TheoreticalFoundations of the package \ref PkgMesh_3.
\subsection Periodic_3_mesh_3ImplementationHistory Implementation History \subsection Periodic_3_mesh_3ImplementationHistory Implementation History

View File

@ -12,7 +12,7 @@
/*! /*!
\addtogroup PkgPeriodic3Triangulation3Ref \addtogroup PkgPeriodic3Triangulation3Ref
\cgalPkgDescriptionBegin{3D Periodic Triangulations,PkgPeriodic3Triangulation3Summary} \cgalPkgDescriptionBegin{3D Periodic Triangulations,PkgPeriodic3Triangulation3}
\cgalPkgPicture{p3Delaunay3_small.jpg} \cgalPkgPicture{p3Delaunay3_small.jpg}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Manuel Caroli, Aymeric Pellé, Mael Rouxel-Labbé, and Monique Teillaud} \cgalPkgAuthors{Manuel Caroli, Aymeric Pellé, Mael Rouxel-Labbé, and Monique Teillaud}
@ -25,7 +25,7 @@ nearest neighbor queries and primitives to build the dual Voronoi diagrams.}
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.5} \cgalPkgSince{3.5}
\cgalPkgDependsOn{\ref PkgTDS3Summary} \cgalPkgDependsOn{\ref PkgTDS3}
\cgalPkgBib{cgal:ct-pt3} \cgalPkgBib{cgal:ct-pt3}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{3D Periodic Delaunay Triangulation,periodic_3_triangulation_3.zip,3D Periodic Lloyd,periodic_3_lloyd.zip} \cgalPkgDemo{3D Periodic Delaunay Triangulation,periodic_3_triangulation_3.zip,3D Periodic Lloyd,periodic_3_lloyd.zip}

View File

@ -11,7 +11,7 @@
/*! /*!
\addtogroup PkgPointSet2Ref \addtogroup PkgPointSet2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Range and Neighbor Search,PkgPointSet2Summary} \cgalPkgDescriptionBegin{2D Range and Neighbor Search,PkgPointSet2}
\cgalPkgPicture{Point_set_2/fig/point_set.png} \cgalPkgPicture{Point_set_2/fig/point_set.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Matthias Bäsken} \cgalPkgAuthor{Matthias Bäsken}
@ -20,7 +20,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{2.1} \cgalPkgSince{2.1}
\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgTriangulation2}
\cgalPkgBib{cgal:b-ss2} \cgalPkgBib{cgal:b-ss2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd

View File

@ -1,7 +1,7 @@
/*! /*!
\defgroup PkgPointSet3Ref 3D Point Set Reference \defgroup PkgPointSet3Ref 3D Point Set Reference
\cgalPkgDescriptionBegin{3D Point Set, PkgPointSet3Summary} \cgalPkgDescriptionBegin{3D Point Set, PkgPointSet3}
\cgalPkgPicture{point_set_3.png} \cgalPkgPicture{point_set_3.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Simon Giraudot} \cgalPkgAuthors{Simon Giraudot}
@ -25,7 +25,7 @@
\ingroup PkgPointSet3Ref \ingroup PkgPointSet3Ref
\brief This module offers convenience overloads of input/ouput \brief This module offers convenience overloads of input/ouput
functions available in the \ref PkgPointSetProcessingSummary package. functions available in the \ref PkgPointSetProcessing package.
These overloads, available after including `CGAL/Point_set_3/IO.h`, These overloads, available after including `CGAL/Point_set_3/IO.h`,
allow the user to call point set processing algorithms without having allow the user to call point set processing algorithms without having
to handle manually property maps and iterators. to handle manually property maps and iterators.

View File

@ -27,7 +27,7 @@ Read and write points (with or without additional properties) in LAS
format. format.
\addtogroup PkgPointSetProcessingRef \addtogroup PkgPointSetProcessingRef
\cgalPkgDescriptionBegin{Point Set Processing,PkgPointSetProcessingSummary} \cgalPkgDescriptionBegin{Point Set Processing,PkgPointSetProcessing}
\cgalPkgPicture{point_set_processing_detail.png} \cgalPkgPicture{point_set_processing_detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pierre Alliez, Simon Giraudot, Clément Jamin, Florent Lafarge, Quentin Mérigot, Jocelyn Meyron, Laurent Saboret, Nader Salman, Shihao Wu} \cgalPkgAuthors{Pierre Alliez, Simon Giraudot, Clément Jamin, Florent Lafarge, Quentin Mérigot, Jocelyn Meyron, Laurent Saboret, Nader Salman, Shihao Wu}
@ -36,7 +36,7 @@ format.
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.5} \cgalPkgSince{3.5}
\cgalPkgDependsOn{\ref PkgSolverSummary} \cgalPkgDependsOn{\ref PkgSolver}
\cgalPkgBib{cgal:ass-psp} \cgalPkgBib{cgal:ass-psp}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -80,7 +80,7 @@ as, e.g., a class derived from the \cgal 3D point, or as a
`std::pair<Point_3<K>, Vector_3<K>>`, or as a `std::pair<Point_3<K>, Vector_3<K>>`, or as a
`boost::tuple<..,Point_3<K>, ..., Vector_3<K> >`. `boost::tuple<..,Point_3<K>, ..., Vector_3<K> >`.
The following classes described in Chapter \ref PkgProperty_mapSummary The following classes described in Chapter \ref PkgProperty_map
provide property maps for the implementations of points with normals provide property maps for the implementations of points with normals
listed above: listed above:
@ -584,7 +584,7 @@ points that are on sharp edges:
The function `structure_point_set()` generates a structured version of The function `structure_point_set()` generates a structured version of
the input point set assigned to a set of planes. Such an input can be the input point set assigned to a set of planes. Such an input can be
produced by a shape detection algorithm (see \ref produced by a shape detection algorithm (see \ref
PkgPointSetShapeDetection3Summary). Point set structuring is based on PkgPointSetShapeDetection3). Point set structuring is based on
the article \cgalCite{cgal:la-srpss-13}. the article \cgalCite{cgal:la-srpss-13}.
- __Planes__: inliers of each detected plane are replaced by sets of - __Planes__: inliers of each detected plane are replaced by sets of

View File

@ -11,7 +11,7 @@
\addtogroup PkgPointSetShapeDetection3Ref \addtogroup PkgPointSetShapeDetection3Ref
\cgalPkgDescriptionBegin{Point Set Shape Detection, PkgPointSetShapeDetection3Summary} \cgalPkgDescriptionBegin{Point Set Shape Detection, PkgPointSetShapeDetection3}
\cgalPkgPicture{shapes_detail.png} \cgalPkgPicture{shapes_detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin

View File

@ -1,7 +1,7 @@
/// \defgroup PkgPoissonSurfaceReconstructionRef Poisson Surface Reconstruction Reference /// \defgroup PkgPoissonSurfaceReconstructionRef Poisson Surface Reconstruction Reference
/*! /*!
\addtogroup PkgPoissonSurfaceReconstructionRef \addtogroup PkgPoissonSurfaceReconstructionRef
\cgalPkgDescriptionBegin{Poisson Surface Reconstruction,PkgPoissonSurfaceReconstructionSummary} \cgalPkgDescriptionBegin{Poisson Surface Reconstruction,PkgPoissonSurfaceReconstruction}
\cgalPkgPicture{surface_reconstruction_points_detail.png} \cgalPkgPicture{surface_reconstruction_points_detail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pierre Alliez, Laurent Saboret, Gaël Guennebaud} \cgalPkgAuthors{Pierre Alliez, Laurent Saboret, Gaël Guennebaud}
@ -10,7 +10,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.5} \cgalPkgSince{3.5}
\cgalPkgDependsOn{\ref PkgSolverSummary} \cgalPkgDependsOn{\ref PkgSolver}
\cgalPkgBib{cgal:asg-srps} \cgalPkgBib{cgal:asg-srps}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -9,7 +9,7 @@
/*! /*!
\addtogroup PkgPolygon2Ref \addtogroup PkgPolygon2Ref
\cgalPkgDescriptionBegin{2D Polygons,PkgPolygon2Summary} \cgalPkgDescriptionBegin{2D Polygons,PkgPolygon2}
\cgalPkgPicture{polygon.png} \cgalPkgPicture{polygon.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Geert-Jan Giezeman and Wieger Wesselink} \cgalPkgAuthors{Geert-Jan Giezeman and Wieger Wesselink}

View File

@ -19,7 +19,7 @@ the type is more specific:
predicates evaluated. Everywhere in this package, a \cgal `Kernel` fulfills the requirements.</li> predicates evaluated. Everywhere in this package, a \cgal `Kernel` fulfills the requirements.</li>
</ul> </ul>
The following named parameters, offered by the package \ref PkgBGLSummary The following named parameters, offered by the package \ref PkgBGL
(see \ref bgl_namedparameters), are used in this package: (see \ref bgl_namedparameters), are used in this package:
\cgalNPTableBegin \cgalNPTableBegin

View File

@ -61,7 +61,7 @@
/*! /*!
\addtogroup PkgPolygonMeshProcessingRef \addtogroup PkgPolygonMeshProcessingRef
\cgalPkgDescriptionBegin{Polygon Mesh Processing, PkgPolygonMeshProcessingSummary} \cgalPkgDescriptionBegin{Polygon Mesh Processing, PkgPolygonMeshProcessing}
\cgalPkgPicture{hole_filling_ico.png} \cgalPkgPicture{hole_filling_ico.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
@ -74,7 +74,7 @@ ranging from basic operations on simplices, to complex geometry processing algor
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.7} \cgalPkgSince{4.7}
\cgalPkgDependsOn{documented for each function; \ref PkgSolverSummary} \cgalPkgDependsOn{documented for each function; \ref PkgSolver}
\cgalPkgBib{cgal:lty-pmp} \cgalPkgBib{cgal:lty-pmp}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -27,7 +27,7 @@ A polygon mesh can have any number of connected components, and also some self-i
In this package, a polygon mesh is considered to have the topology of a 2-manifold. In this package, a polygon mesh is considered to have the topology of a 2-manifold.
\subsection PMPAPI API \subsection PMPAPI API
This package follows the BGL API described in \ref PkgBGLSummary. This package follows the BGL API described in \ref PkgBGL.
It can thus be used either with `Polyhedron_3`, `Surface_mesh`, or It can thus be used either with `Polyhedron_3`, `Surface_mesh`, or
any class model of the concept `FaceGraph`. Each function or class of this package any class model of the concept `FaceGraph`. Each function or class of this package
details the requirements on the input polygon mesh. details the requirements on the input polygon mesh.
@ -229,7 +229,7 @@ centered in the output volume is a topological ball. At the surface level this m
that no non-manifold vertex or edge is allowed in the output. For example, it that no non-manifold vertex or edge is allowed in the output. For example, it
is not possible to compute the union of two cubes that are disjoint but sharing an edge. is not possible to compute the union of two cubes that are disjoint but sharing an edge.
In case you have to deal with such scenarios, you should consider using the In case you have to deal with such scenarios, you should consider using the
package \ref PkgNef3Summary. package \ref PkgNef3.
It is possible to update the input so that it contains the result (in-place operation). It is possible to update the input so that it contains the result (in-place operation).
In that case the whole mesh will not be copied and only the region around the In that case the whole mesh will not be copied and only the region around the
@ -710,7 +710,7 @@ In the following example, a mesh is isotropically remeshed and the approximate d
\subsection PoissonDistanceExample Max Distance Between Point Set and Surface Example \subsection PoissonDistanceExample Max Distance Between Point Set and Surface Example
In \ref Poisson_surface_reconstruction_3/poisson_reconstruction_example.cpp, In \ref Poisson_surface_reconstruction_3/poisson_reconstruction_example.cpp,
a triangulated surface mesh is constructed from a point set using the a triangulated surface mesh is constructed from a point set using the
\link PkgPoissonSurfaceReconstructionSummary Poisson reconstruction algorithm \endlink, \link PkgPoissonSurfaceReconstruction Poisson reconstruction algorithm \endlink,
and the distance between the point set and the reconstructed surface is computed and the distance between the point set and the reconstructed surface is computed
with the following code: with the following code:

View File

@ -359,7 +359,7 @@ struct Throw_at_first_output {
// Note this is not officially documented // Note this is not officially documented
/* /*
* reports all the pairs of faces intersecting between two triangulated surface meshes. * reports all the pairs of faces intersecting between two triangulated surface meshes.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \pre `CGAL::is_triangle_mesh(tm1)` * \pre `CGAL::is_triangle_mesh(tm1)`
* \pre `CGAL::is_triangle_mesh(tm2)` * \pre `CGAL::is_triangle_mesh(tm2)`
@ -478,7 +478,7 @@ compute_face_face_intersection(const FaceRange& face_range1,
* a triangulated surface mesh and a polyline. * a triangulated surface mesh and a polyline.
* \attention If a polyline vertex intersects a face, the intersection will * \attention If a polyline vertex intersects a face, the intersection will
* be reported twice (even more if it is on a vertex, edge, or point). * be reported twice (even more if it is on a vertex, edge, or point).
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \pre `CGAL::is_triangle_mesh(tm)` * \pre `CGAL::is_triangle_mesh(tm)`
* *
@ -603,7 +603,7 @@ compute_face_polyline_intersection( const FaceRange& face_range,
* a triangulated surface mesh and a range of polylines. * a triangulated surface mesh and a range of polylines.
* \attention If a polyline vertex intersects a face, the intersection will * \attention If a polyline vertex intersects a face, the intersection will
* be reported twice (even more if it is on a vertex, edge, or point). * be reported twice (even more if it is on a vertex, edge, or point).
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \pre `CGAL::is_triangle_mesh(tm)` * \pre `CGAL::is_triangle_mesh(tm)`
* *
@ -732,7 +732,7 @@ compute_face_polylines_intersection(const FaceRange& face_range,
// Note this is not officially documented // Note this is not officially documented
/* /*
* detects and records intersections between two polylines. * detects and records intersections between two polylines.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* \attention If a polyline vertex intersects another polyline, the intersection will * \attention If a polyline vertex intersects another polyline, the intersection will
* be reported twice (even more if it is on a vertex). * be reported twice (even more if it is on a vertex).
* \tparam Polyline a `RandomAccessRange` of points. * \tparam Polyline a `RandomAccessRange` of points.
@ -815,7 +815,7 @@ compute_polyline_polyline_intersection(const Polyline& polyline1,
* detects and records intersections between two ranges of polylines. * detects and records intersections between two ranges of polylines.
* \attention If a polyline vertex intersects another polyline, the intersection will * \attention If a polyline vertex intersects another polyline, the intersection will
* be reported twice (even more if it is on a vertex). * be reported twice (even more if it is on a vertex).
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \tparam PolylineRange a `RandomAccessRange` of `RandomAccessRange` of points. * \tparam PolylineRange a `RandomAccessRange` of `RandomAccessRange` of points.
* \tparam OutputIterator a model of `OutputIterator` holding objects of type * \tparam OutputIterator a model of `OutputIterator` holding objects of type
@ -915,7 +915,7 @@ compute_polylines_polylines_intersection(const PolylineRange& polylines1,
// Note this is not officially documented // Note this is not officially documented
/* /*
* reports all the pairs of faces intersecting between two triangulated surface meshes. * reports all the pairs of faces intersecting between two triangulated surface meshes.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* @pre `CGAL::is_triangle_mesh(tm1)` * @pre `CGAL::is_triangle_mesh(tm1)`
* @pre `CGAL::is_triangle_mesh(tm2)` * @pre `CGAL::is_triangle_mesh(tm2)`
@ -960,7 +960,7 @@ compute_face_face_intersection(const TriangleMesh& tm1,
* and a polyline. * and a polyline.
* \attention If a polyline vertex intersects a face or another polyline, the intersection will * \attention If a polyline vertex intersects a face or another polyline, the intersection will
* be reported twice (even more if it is on a vertex, edge, or point). * be reported twice (even more if it is on a vertex, edge, or point).
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \pre `CGAL::is_triangle_mesh(tm)` * \pre `CGAL::is_triangle_mesh(tm)`
* *
@ -1081,7 +1081,7 @@ bool is_mesh2_in_mesh1(const TriangleMesh& tm1,
* \ingroup PMP_predicates_grp * \ingroup PMP_predicates_grp
* returns `true` if any segment of any polyline of `polylines1` intersects * returns `true` if any segment of any polyline of `polylines1` intersects
* any segment of any polyline of `polylines2`, and `false` otherwise. * any segment of any polyline of `polylines2`, and `false` otherwise.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \tparam PolylineRange a `RandomAccessRange` of `RandomAccessRange` of points. * \tparam PolylineRange a `RandomAccessRange` of `RandomAccessRange` of points.
* The point type must be from a 3D point from a \cgal Kernel. * The point type must be from a 3D point from a \cgal Kernel.
@ -1123,7 +1123,7 @@ bool do_intersect(const PolylineRange& polylines1,
/** /**
* \ingroup PMP_predicates_grp * \ingroup PMP_predicates_grp
* returns `true` if any segment of `polyline1` intersects any segment of `polyline2`, and `false` otherwise. * returns `true` if any segment of `polyline1` intersects any segment of `polyline2`, and `false` otherwise.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \tparam Polyline a `RandomAccessRange` of points. * \tparam Polyline a `RandomAccessRange` of points.
* The point type must be from a 3D point type from \cgal Kernel. * The point type must be from a 3D point type from \cgal Kernel.
@ -1169,7 +1169,7 @@ bool do_intersect(const Polyline& polyline1,
* \ingroup PMP_predicates_grp * \ingroup PMP_predicates_grp
* returns `true` if any face of `tm1` intersects any face of `tm2`, and `false` otherwise. * returns `true` if any face of `tm1` intersects any face of `tm2`, and `false` otherwise.
* If `do_overlap_test_of_bounded_sides` is set to `true`, the overlap of bounded sides are tested as well. In that case, the meshes must be closed. * If `do_overlap_test_of_bounded_sides` is set to `true`, the overlap of bounded sides are tested as well. In that case, the meshes must be closed.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* @pre `CGAL::is_triangle_mesh(tm1)` * @pre `CGAL::is_triangle_mesh(tm1)`
* @pre `CGAL::is_triangle_mesh(tm2)` * @pre `CGAL::is_triangle_mesh(tm2)`
@ -1257,7 +1257,7 @@ bool do_intersect(const TriangleMesh& tm1,
/** /**
* \ingroup PMP_predicates_grp * \ingroup PMP_predicates_grp
* returns `true` if any face of `tm` and any segment of any polyline of `polylines` intersects, and `false` otherwise. * returns `true` if any face of `tm` and any segment of any polyline of `polylines` intersects, and `false` otherwise.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* @pre `CGAL::is_triangle_mesh(tm)` * @pre `CGAL::is_triangle_mesh(tm)`
* *
* \tparam TriangleMesh a model of `FaceListGraph` * \tparam TriangleMesh a model of `FaceListGraph`
@ -1313,7 +1313,7 @@ bool do_intersect(const TriangleMesh& tm,
/** /**
* \ingroup PMP_predicates_grp * \ingroup PMP_predicates_grp
* returns `true` if any face of `tm` and any segment of `polyline` intersects, and `false` otherwise. * returns `true` if any face of `tm` and any segment of `polyline` intersects, and `false` otherwise.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* @pre `CGAL::is_triangle_mesh(tm)` * @pre `CGAL::is_triangle_mesh(tm)`
* *
* \tparam TriangleMesh a model of `FaceListGraph` * \tparam TriangleMesh a model of `FaceListGraph`
@ -1529,7 +1529,7 @@ struct Mesh_callback
* A pair of meshes intersecting is put in the output iterator `out` as a `std::pair<std::size_t, std::size_t>`, * A pair of meshes intersecting is put in the output iterator `out` as a `std::pair<std::size_t, std::size_t>`,
* each index refering to the index of the triangle mesh in the input range. * each index refering to the index of the triangle mesh in the input range.
* If `do_overlap_test_of_bounded_sides` is `true`, the overlap of bounded sides are tested as well. In that case, the meshes must be closed. * If `do_overlap_test_of_bounded_sides` is `true`, the overlap of bounded sides are tested as well. In that case, the meshes must be closed.
* This function depends on the package \ref PkgBoxIntersectionDSummary. * This function depends on the package \ref PkgBoxIntersectionD.
* *
* \tparam TriangleMeshRange a model of `RandomAccessRange` of triangulated surface meshes model of `FaceListGraph`. * \tparam TriangleMeshRange a model of `RandomAccessRange` of triangulated surface meshes model of `FaceListGraph`.
* \tparam OutputIterator an output iterator in which `std::pair<std::size_t, std::size_t>` can be put. * \tparam OutputIterator an output iterator in which `std::pair<std::size_t, std::size_t>` can be put.

View File

@ -235,7 +235,7 @@ self_intersections( const FaceRange& face_range,
/** /**
* \ingroup PMP_intersection_grp * \ingroup PMP_intersection_grp
* detects and records self-intersections of a triangulated surface mesh. * detects and records self-intersections of a triangulated surface mesh.
* This function depends on the package \ref PkgBoxIntersectionDSummary * This function depends on the package \ref PkgBoxIntersectionD
* @pre `CGAL::is_triangle_mesh(tmesh)` * @pre `CGAL::is_triangle_mesh(tmesh)`
* *
* @tparam TriangleMesh a model of `FaceListGraph` * @tparam TriangleMesh a model of `FaceListGraph`
@ -391,7 +391,7 @@ OutputIterator self_intersections(const FaceRange& face_range,
/** /**
* \ingroup PMP_intersection_grp * \ingroup PMP_intersection_grp
* tests if a triangulated surface mesh self-intersects. * tests if a triangulated surface mesh self-intersects.
* This function depends on the package \ref PkgBoxIntersectionDSummary * This function depends on the package \ref PkgBoxIntersectionD
* @pre `CGAL::is_triangle_mesh(tmesh)` * @pre `CGAL::is_triangle_mesh(tmesh)`
* *
* @tparam TriangleMesh a model of `FaceListGraph` * @tparam TriangleMesh a model of `FaceListGraph`
@ -431,7 +431,7 @@ bool does_self_intersect(const TriangleMesh& tmesh
/** /**
* \ingroup PMP_intersection_grp * \ingroup PMP_intersection_grp
* tests if a set of faces of a triangulated surface mesh self-intersects. * tests if a set of faces of a triangulated surface mesh self-intersects.
* This function depends on the package \ref PkgBoxIntersectionDSummary * This function depends on the package \ref PkgBoxIntersectionD
* @pre `CGAL::is_triangle_mesh(tmesh)` * @pre `CGAL::is_triangle_mesh(tmesh)`
* *
* @tparam FaceRange a range of `face_descriptor` * @tparam FaceRange a range of `face_descriptor`

View File

@ -400,7 +400,7 @@ public:
/** /**
* \ingroup PMP_meshing_grp * \ingroup PMP_meshing_grp
* triangulates a single face of a polygon mesh. This function depends on the package \ref PkgTriangulation2Summary * triangulates a single face of a polygon mesh. This function depends on the package \ref PkgTriangulation2
* @tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph` * @tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* @tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters" * @tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters"
* *
@ -449,7 +449,7 @@ bool triangulate_face(typename boost::graph_traits<PolygonMesh>::face_descriptor
/** /**
* \ingroup PMP_meshing_grp * \ingroup PMP_meshing_grp
* triangulates given faces of a polygon mesh. This function depends on the package \ref PkgTriangulation2Summary * triangulates given faces of a polygon mesh. This function depends on the package \ref PkgTriangulation2
* *
* @tparam FaceRange range of `boost::graph_traits<PolygonMesh>::%face_descriptor`, * @tparam FaceRange range of `boost::graph_traits<PolygonMesh>::%face_descriptor`,
model of `Range`. model of `Range`.
@ -501,7 +501,7 @@ bool triangulate_faces(FaceRange face_range, PolygonMesh& pmesh)
/** /**
* \ingroup PMP_meshing_grp * \ingroup PMP_meshing_grp
* triangulates all faces of a polygon mesh. This function depends on the package \ref PkgTriangulation2Summary * triangulates all faces of a polygon mesh. This function depends on the package \ref PkgTriangulation2
* @tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph` * @tparam PolygonMesh a model of `FaceListGraph` and `MutableFaceGraph`
* @tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters" * @tparam NamedParameters a sequence of \ref pmp_namedparameters "Named Parameters"
* *

View File

@ -63,7 +63,7 @@ namespace CGAL {
/// orthogonal to a frame axis, the non-null coefficient being 1 or -1. /// orthogonal to a frame axis, the non-null coefficient being 1 or -1.
/// The default is `true`. /// The default is `true`.
/// ///
/// The implemenation of this class depends on the package \ref PkgAABB_treeSummary. /// The implemenation of this class depends on the package \ref PkgAABB_tree.
/// \todo Shall we document more in details what is required? /// \todo Shall we document more in details what is required?
/// `Traits` must provide: /// `Traits` must provide:
/// - `Plane_3` /// - `Plane_3`

View File

@ -55,7 +55,7 @@ namespace CGAL {
* will return in turns `CGAL::ON_BOUNDED_SIDE` and `CGAL::ON_UNBOUNDED_SIDE`, * will return in turns `CGAL::ON_BOUNDED_SIDE` and `CGAL::ON_UNBOUNDED_SIDE`,
* following the aforementioned parity criterion. * following the aforementioned parity criterion.
* *
* This class depends on the package \ref PkgAABB_treeSummary. * This class depends on the package \ref PkgAABB_tree.
* *
* @tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph` * @tparam TriangleMesh a triangulated surface mesh, model of `FaceListGraph`
* @tparam GeomTraits a geometric traits class, model of `Kernel` * @tparam GeomTraits a geometric traits class, model of `Kernel`

View File

@ -16,7 +16,7 @@
/*! /*!
\addtogroup PkgPolyhedronRef \addtogroup PkgPolyhedronRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{3D Polyhedral Surface,PkgPolyhedronSummary} \cgalPkgDescriptionBegin{3D Polyhedral Surface,PkgPolyhedron}
\cgalPkgPicture{Polyhedron-teaser-small.png} \cgalPkgPicture{Polyhedron-teaser-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Lutz Kettner} \cgalPkgAuthor{Lutz Kettner}
@ -25,7 +25,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{1.0} \cgalPkgSince{1.0}
\cgalPkgDependsOn{\ref PkgHDSSummary} \cgalPkgDependsOn{\ref PkgHDS}
\cgalPkgBib{cgal:k-ps} \cgalPkgBib{cgal:k-ps}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Polyhedron demo,polyhedron_3.zip}

View File

@ -13,7 +13,7 @@
/*! /*!
\addtogroup PkgPolylineSimplification2Ref \addtogroup PkgPolylineSimplification2Ref
\cgalPkgDescriptionBegin{2D Polyline Simplification,PkgPolylineSimplification2Summary} \cgalPkgDescriptionBegin{2D Polyline Simplification,PkgPolylineSimplification2}
\cgalPkgPicture{PolylineSimplification-small.png} \cgalPkgPicture{PolylineSimplification-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Andreas Fabri} \cgalPkgAuthor{Andreas Fabri}
@ -22,7 +22,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.6} \cgalPkgSince{4.6}
\cgalPkgDependsOn{\ref PkgTriangulation2Summary} \cgalPkgDependsOn{\ref PkgTriangulation2}
\cgalPkgBib{cgal:f-ps2} \cgalPkgBib{cgal:f-ps2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Polyline Simplification,polyline_simplification_2.zip} \cgalPkgDemo{Polyline Simplification,polyline_simplification_2.zip}

View File

@ -46,7 +46,7 @@ true, for instance, upon reaching a desired number of vertices or
reaching a maximum simplification error. reaching a maximum simplification error.
The polyline simplification algorithm operates on a triangulation The polyline simplification algorithm operates on a triangulation
class from Chapter \ref PkgTriangulation2Summary, namely class from Chapter \ref PkgTriangulation2, namely
`Constrained_triangulation_plus_2`. This data structure allows to `Constrained_triangulation_plus_2`. This data structure allows to
remove vertices of a polyline constraint, while keeping the points of remove vertices of a polyline constraint, while keeping the points of
the removed vertices of the polyline constraint. The fact that it is a the removed vertices of the polyline constraint. The fact that it is a

View File

@ -10,7 +10,7 @@
/*! /*!
\addtogroup PkgPolynomialRef \addtogroup PkgPolynomialRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Polynomial,PkgPolynomialSummary} \cgalPkgDescriptionBegin{Polynomial,PkgPolynomial}
\cgalPkgPicture{Polynomial.png} \cgalPkgPicture{Polynomial.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Michael Hemmer} \cgalPkgAuthor{Michael Hemmer}

View File

@ -5,7 +5,7 @@
/*! /*!
\addtogroup PkgOptimalDistancesRef \addtogroup PkgOptimalDistancesRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Optimal Distances,PkgOptimalDistancesSummary} \cgalPkgDescriptionBegin{Optimal Distances,PkgOptimalDistances}
\cgalPkgPicture{dist.png} \cgalPkgPicture{dist.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr} \cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Thomas Herrmann, Michael Hoffmann, and Sven Schönherr}

View File

@ -18,7 +18,7 @@
/*! /*!
\addtogroup PkgPrincipalComponentAnalysisDRef \addtogroup PkgPrincipalComponentAnalysisDRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Principal Component Analysis,PkgPrincipalComponentAnalysisDSummary} \cgalPkgDescriptionBegin{Principal Component Analysis,PkgPrincipalComponentAnalysisD}
\cgalPkgPicture{teaserLeastSquaresFitting.png} \cgalPkgPicture{teaserLeastSquaresFitting.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Pierre Alliez, Sylvain Pion and Ankit Gupta} \cgalPkgAuthors{Pierre Alliez, Sylvain Pion and Ankit Gupta}
@ -27,7 +27,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.2} \cgalPkgSince{3.2}
\cgalPkgDependsOn{\ref PkgSolverSummary} \cgalPkgDependsOn{\ref PkgSolver}
\cgalPkgBib{cgal:ap-pcad} \cgalPkgBib{cgal:ap-pcad}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgDemo{Principal Component Analysis,pca.zip,Operations on Polygons,polygon.zip,Polyhedron demo,polyhedron_3.zip} \cgalPkgDemo{Principal Component Analysis,pca.zip,Operations on Polygons,polygon.zip,Polyhedron demo,polyhedron_3.zip}

View File

@ -3,7 +3,7 @@
/*! /*!
\addtogroup PkgProperty_mapRef \addtogroup PkgProperty_mapRef
\cgalPkgDescriptionBegin{CGAL and Boost Property Maps,PkgProperty_mapSummary} \cgalPkgDescriptionBegin{CGAL and Boost Property Maps,PkgProperty_map}
\cgalPkgPicture{property_map.png} \cgalPkgPicture{property_map.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Andreas Fabri and Laurent Saboret} \cgalPkgAuthors{Andreas Fabri and Laurent Saboret}

View File

@ -73,7 +73,7 @@ Programs can be written to an output stream in MPSFormat, using one of the follo
/*! /*!
\addtogroup PkgQPSolverRef \addtogroup PkgQPSolverRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Linear and Quadratic Programming Solver,PkgQPSolverSummary} \cgalPkgDescriptionBegin{Linear and Quadratic Programming Solver,PkgQPSolver}
\cgalPkgPicture{qp.png} \cgalPkgPicture{qp.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Sven Schönherr, and Frans Wessendorp} \cgalPkgAuthors{Kaspar Fischer, Bernd Gärtner, Sven Schönherr, and Frans Wessendorp}

View File

@ -6,7 +6,7 @@
/*! /*!
\addtogroup PkgRidges_3Ref \addtogroup PkgRidges_3Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{Approximation of Ridges and Umbilics on Triangulated Surface Meshes,PkgRidges_3Summary} \cgalPkgDescriptionBegin{Approximation of Ridges and Umbilics on Triangulated Surface Meshes,PkgRidges_3}
\cgalPkgPicture{RidgesMechPartDetail.png} \cgalPkgPicture{RidgesMechPartDetail.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Marc Pouget and Frédéric Cazals} \cgalPkgAuthors{Marc Pouget and Frédéric Cazals}
@ -15,7 +15,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.3} \cgalPkgSince{3.3}
\cgalPkgDependsOn{\ref PkgSolverSummary} \cgalPkgDependsOn{\ref PkgSolver}
\cgalPkgBib{cgal:cp-arutsm} \cgalPkgBib{cgal:cp-arutsm}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd

View File

@ -26,7 +26,7 @@ analysis. Based on the results of the article
different parts of this singular ridge curve as well as umbilics on a different parts of this singular ridge curve as well as umbilics on a
surface given as a triangulated surface mesh. Differential quantities surface given as a triangulated surface mesh. Differential quantities
associated to the mesh vertices are assumed to be given for these associated to the mesh vertices are assumed to be given for these
algorithms; such quantities may be computed by the package \ref PkgJet_fitting_3Summary. algorithms; such quantities may be computed by the package \ref PkgJet_fitting_3.
Note that this package needs the third party library \ref thirdpartyEigen for linear algebra operations. Note that this package needs the third party library \ref thirdpartyEigen for linear algebra operations.
@ -404,7 +404,7 @@ neighborhood.
\subsection Ridges_3Exampleprogram Example Program \subsection Ridges_3Exampleprogram Example Program
The following program computes ridges and umbilics from an off The following program computes ridges and umbilics from an off
file.\cgalFootnote{Model data may be downloaded via ftp://ftp.mpi-sb.mpg.de/pub/outgoing/CGAL/Ridges_3_datafiles.tgz . The mechanical part model has been provided courtesy of Dassault System to produce \cgalFigureRef{figmechanical_crest_filteredintro}, due to copyright issues the available model is not the same, it is provided by the AIM\@SHAPE Shape Repository.} It uses the package \ref PkgJet_fitting_3Summary to estimate the differential file.\cgalFootnote{Model data may be downloaded via ftp://ftp.mpi-sb.mpg.de/pub/outgoing/CGAL/Ridges_3_datafiles.tgz . The mechanical part model has been provided courtesy of Dassault System to produce \cgalFigureRef{figmechanical_crest_filteredintro}, due to copyright issues the available model is not the same, it is provided by the AIM\@SHAPE Shape Repository.} It uses the package \ref PkgJet_fitting_3 to estimate the differential
quantities. quantities.
The default output file gives rough data for visualization purpose, a The default output file gives rough data for visualization purpose, a
verbose output file may also be asked for. Parameters are verbose output file may also be asked for. Parameters are

View File

@ -12,7 +12,7 @@
/*! /*!
\addtogroup PkgStlExtensionRef \addtogroup PkgStlExtensionRef
\cgalPkgDescriptionBegin{STL Extensions for CGAL,PkgStlExtensionSummary} \cgalPkgDescriptionBegin{STL Extensions for CGAL,PkgStlExtension}
\cgalPkgPicture{plusplus.png} \cgalPkgPicture{plusplus.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Ron Wein} \cgalPkgAuthors{Michael Hoffmann, Lutz Kettner, Sylvain Pion, and Ron Wein}

View File

@ -9,7 +9,7 @@
/*! /*!
\addtogroup PkgScaleSpaceReconstruction3Ref \addtogroup PkgScaleSpaceReconstruction3Ref
\cgalPkgDescriptionBegin{Scale-Space Surface Reconstruction,PkgScaleSpaceReconstruction3Summary} \cgalPkgDescriptionBegin{Scale-Space Surface Reconstruction,PkgScaleSpaceReconstruction3}
\cgalPkgPicture{knot_thumb.png} \cgalPkgPicture{knot_thumb.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthors{Thijs van Lankveld} \cgalPkgAuthors{Thijs van Lankveld}
@ -20,7 +20,7 @@
\cgalPkgSince{4.6} \cgalPkgSince{4.6}
\cgalPkgBib{cgal:ssr3} \cgalPkgBib{cgal:ssr3}
\cgalPkgLicense{\ref licensesGPL "GPL" } \cgalPkgLicense{\ref licensesGPL "GPL" }
\cgalPkgDependsOn{\ref PkgAlphaShapes3Summary, \ref PkgSpatialSearchingDSummary, \ref PkgSolverSummary} \cgalPkgDependsOn{\ref PkgAlphaShapes3, \ref PkgSpatialSearchingD, \ref PkgSolver}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd \cgalPkgDescriptionEnd

View File

@ -11,7 +11,7 @@
/*! /*!
\addtogroup PkgRangeSegmentTreesDRef \addtogroup PkgRangeSegmentTreesDRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{dD Range and Segment Trees,PkgRangeSegmentTreesDSummary} \cgalPkgDescriptionBegin{dD Range and Segment Trees,PkgRangeSegmentTreesD}
\cgalPkgPicture{segment_tree.png} \cgalPkgPicture{segment_tree.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Gabriele Neyer} \cgalPkgAuthor{Gabriele Neyer}

View File

@ -4,7 +4,7 @@
/*! /*!
\addtogroup PkgSegmentDelaunayGraph2Ref \addtogroup PkgSegmentDelaunayGraph2Ref
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{2D Segment Delaunay Graphs,PkgSegmentDelaunayGraph2Summary} \cgalPkgDescriptionBegin{2D Segment Delaunay Graphs,PkgSegmentDelaunayGraph2}
\cgalPkgPicture{svd.png} \cgalPkgPicture{svd.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
\cgalPkgAuthor{Menelaos Karavelas} \cgalPkgAuthor{Menelaos Karavelas}
@ -13,7 +13,7 @@
\cgalPkgSummaryEnd \cgalPkgSummaryEnd
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{3.1} \cgalPkgSince{3.1}
\cgalPkgDependsOn{\ref PkgTDS2Summary} \cgalPkgDependsOn{\ref PkgTDS2}
\cgalPkgBib{cgal:k-sdg2} \cgalPkgBib{cgal:k-sdg2}
\cgalPkgLicense{\ref licensesGPL} \cgalPkgLicense{\ref licensesGPL}
\cgalPkgDemo{2D Segment Voronoi Diagram,segment_voronoi_diagram_2.zip} \cgalPkgDemo{2D Segment Voronoi Diagram,segment_voronoi_diagram_2.zip}

View File

@ -6,7 +6,7 @@
\addtogroup PkgSDGLinfRef \addtogroup PkgSDGLinfRef
\todo check generated documentation \todo check generated documentation
\cgalPkgDescriptionBegin{L Infinity Segment Delaunay Graphs,PkgSDGLinfSummary} \cgalPkgDescriptionBegin{L Infinity Segment Delaunay Graphs,PkgSDGLinf}
\cgalPkgPicture{sdglinf-small.png} \cgalPkgPicture{sdglinf-small.png}
\cgalPkgSummaryBegin \cgalPkgSummaryBegin
@ -19,7 +19,7 @@ the Voronoi diagram of a set of points and segments under the
\cgalPkgShortInfoBegin \cgalPkgShortInfoBegin
\cgalPkgSince{4.7} \cgalPkgSince{4.7}
\cgalPkgDependsOn{\ref PkgSegmentDelaunayGraph2Summary} \cgalPkgDependsOn{\ref PkgSegmentDelaunayGraph2}
\cgalPkgBib{cgal:cdp-sdglinf2} \cgalPkgBib{cgal:cdp-sdglinf2}
\cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgLicense{\ref licensesGPL "GPL"}
\cgalPkgShortInfoEnd \cgalPkgShortInfoEnd

Some files were not shown because too many files have changed in this diff Show More