add classified reference manual pages

This commit is contained in:
Sébastien Loriot 2013-03-12 15:07:19 +01:00
parent 2061069310
commit 3c7ad8410c
9 changed files with 145 additions and 0 deletions

View File

@ -16,5 +16,11 @@
\cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
## Functions ##
- `CGAL::convex_decomposition_3(Nef_polyhedron_3& N)`
*/

View File

@ -32,5 +32,18 @@ and arbitrary dimensions as well as functions for testing if a given set of
points in is strongly convex or not. This chapter describes the class
available for arbitrary dimensions and its companion class for
computing the nearest and furthest site Delaunay triangulation.
\cgalClassifedRefPages
## Concepts #
- `ConvexHullTraits_d`
- `DelaunayLiftedTraits_d`
- `DelaunayTraits_d`
## Classes ##
- `CGAL::Convex_hull_d_traits_3<R>`
- `CGAL::Convex_hull_d<R>`
- `CGAL::Delaunay_d< R, Lifted_R > `
*/

View File

@ -25,4 +25,20 @@ represented as an envelope diagram, namely a subdivision of the
\f$ x\f$-axis into intervals, such that the identity of the curves that
induce the envelope over each interval is unique.
\cgalClassifedRefPages
## Functions ##
- `CGAL::lower_envelope_2`
- `CGAL::upper_envelope_2`
- `CGAL::lower_envelope_x_monotone_2`
- `CGAL::upper_envelope_x_monotone_2`
## Concepts ##
- `EnvelopeDiagram_1`
- `EnvelopeDiagramVertex`
- `EnvelopeDiagramEdge`
## Classes ##
- `CGAL::Envelope_diagram_1<Traits> `
*/

View File

@ -27,5 +27,24 @@ represented as an 2D envelope diagram - a planar subdivision such
that the identity of the surfaces that induce the envelope over each
diagram cell is unique.
\cgalClassifedRefPages
## Functions ##
- `CGAL::lower_envelope_3`
- `CGAL::upper_envelope_3`
- `CGAL::lower_envelope_xy_monotone_3`
- `CGAL::upper_envelope_xy_monotone_3`
## Concepts ##
- `EnvelopeTraits_3`
## Classes ##
- `CGAL::Envelope_diagram_2<EnvTraits>`
- `CGAL::Env_triangle_traits_3<Kernel>`
- `CGAL::Env_sphere_traits_3<ConicTraits>`
- `CGAL::Env_plane_traits_3<Kernel>`
- `CGAL::Env_surface_data_traits_3<Traits,XyData,SData,Cnv>`
*/

View File

@ -17,5 +17,11 @@
\cgalPkgLicense{\ref licensesLGPL "LGPL"}
\cgalPkgShortInfoEnd
\cgalPkgDescriptionEnd
\cgalClassifedRefPages
## Classes ##
- `CGAL::Geomview_stream`
*/

View File

@ -29,5 +29,26 @@ This package provides some classes which allow to use \cgal classes in
HREF="http://doc.qt.digia.com/latest/graphicsview.html">Qt Graphics
View Framework</A>.
\cgalClassifedRefPages
## GraphicsItem Classes ##
- `CGAL::Qt::GraphicsItem`
- `CGAL::Qt::TriangulationGraphicsItem<T>`
- `CGAL::Qt::ConstrainedTriangulationGraphicsItem<CT>`
- `CGAL::Qt::VoronoiGraphicsItem<DT>`
## Input Classes ##
- `CGAL::Qt::GraphicsViewInput`
- `CGAL::Qt::GraphicsViewCircleInput<K>`
- `CGAL::Qt::GraphicsViewCircularArcInput<K>`
- `CGAL::Qt::GraphicsViewIsoRectangleInput<K>`
- `CGAL::Qt::GraphicsViewPolylineInput<K>`
## Miscellaneous Classes ##
- `CGAL::Qt::Converter<K>`
- `CGAL::Qt::PainterOstream<K>`
- `CGAL::Qt::GraphicsViewNavigation`
*/

View File

@ -58,6 +58,34 @@ overview and comparison of these different data structures together
with a thorough description of the design implemented here can be
found in \cite k-ugpdd-99.
\cgalClassifedRefPages
## Concepts ##
- `HalfedgeDS<Traits,Items,Alloc>`
- `HalfedgeDSItems`
- `HalfedgeDSVertex`
- `HalfedgeDSHalfedge`
- `HalfedgeDSFace`
## Classes ##
- `CGAL::HalfedgeDS_default<Traits,HalfedgeDSItems,Alloc>`
- `CGAL::HalfedgeDS_list<Traits,HalfedgeDSItems,Alloc>`
- `CGAL::HalfedgeDS_vector<Traits,HalfedgeDSItems,Alloc>`
- `CGAL::HalfedgeDS_min_items`
- `CGAL::HalfedgeDS_items_2`
- `CGAL::HalfedgeDS_vertex_base<Refs>`
- `CGAL::HalfedgeDS_halfedge_base<Refs>`
- `CGAL::HalfedgeDS_face_base<Refs>`
- `CGAL::HalfedgeDS_vertex_min_base<Refs>`
- `CGAL::HalfedgeDS_halfedge_min_base<Refs>`
- `CGAL::HalfedgeDS_face_min_base<Refs>`
- `CGAL::HalfedgeDS_items_decorator<HDS>`
- `CGAL::HalfedgeDS_decorator<HDS>`
- `CGAL::HalfedgeDS_const_decorator<HDS>`
*/

View File

@ -29,5 +29,17 @@ The optimization code uses infix `OPTIMISATION` in the assertions,
e.g. defining the compiler flag
`CGAL_OPTIMISATION_NO_PRECONDITIONS` switches precondition
checking off, cf. Section \ref secchecks.
\cgalClassifedRefPages
- `CGAL::maximum_area_inscribed_k_gon_2`
- `CGAL::maximum_perimeter_inscribed_k_gon_2`
- `CGAL::extremal_polygon_2`
- `CGAL::Largest_empty_iso_rectangle_2<T>`
- `CGAL::Extremal_polygon_area_traits_2<K>`
- `CGAL::Extremal_polygon_perimeter_traits_2<K>`
- `ExtremalPolygonTraits_2`
- `LargestEmptyIsoRectangleTraits_2`
*/

View File

@ -73,6 +73,30 @@ approximately barycentric, see \cite bf-lcss-02.
For a more thorough introduction see the user manual.
\cgalClassifedRefPages
## Concepts ##
- `InterpolationTraits`
- `GradientFittingTraits`
## Interpolation Functions ##
- `CGAL::linear_interpolation`
- `CGAL::sibson_c1_interpolation`
- `CGAL::farin_c1_interpolation`
- `CGAL::quadratic_interpolation`
- `CGAL::sibson_gradient_fitting`
- `CGAL::Interpolation_traits_2<K>`
- `CGAL::Interpolation_gradient_fitting_traits_2<K>`
## Natural neighbor coordinate computation ##
- `CGAL::natural_neighbor_coordinates_2`
- `CGAL::regular_neighbor_coordinates_2`
## Surface neighbor and surface neighbor coordinate computation ##
- `CGAL::Voronoi_intersection_2_traits_3<K>`
- `CGAL::surface_neighbor_coordinates_3`
- `CGAL::surface_neighbors_3`
*/