diff --git a/.gitignore b/.gitignore index 1afe2ca9314..c70c750c675 100644 --- a/.gitignore +++ b/.gitignore @@ -106,7 +106,6 @@ Circular_kernel_3/test/Circular_kernel_3/test_Spherical_kernel_basics Circular_kernel_3/test/Circular_kernel_3/test_Spherical_kernel_with_core Distance_3/include Documentation/log -Documentation/log/* Documentation/output Documentation/tags/*.* Generator/examples/Generator/CMakeLists.txt diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h index dd28e088b03..13b82df3bb3 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h @@ -7,8 +7,7 @@ The concept `AABBPrimitive` describes the requirements for the primitives stored \sa `AABB_tree` -Example --------------- +### Example ### The `Primitive` type can be, e.g., a wrapper around a `Handle`. Assume for instance that the input objects are the triangle faces of a mesh stored as a `CGAL::Polyhedron`. The `Datum` would be a `Triangle_3` and the `Id` would be a polyhedron `Face_handle`. Method `datum()` can return either a `Triangle_3` constructed on the fly from the face handle or a `Triangle_3` stored internally. This provides a way for the user to trade memory for efficiency. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h index e8e97d7656f..7ff6a93222b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/EuclideanRing.h @@ -20,8 +20,7 @@ Moreover, `CGAL::Algebraic_structure_traits< EuclideanRing >` is a model of - `CGAL::Algebraic_structure_traits< EuclideanRing >::Div_mod` -Remarks --------------- +### Remarks ### The most prominent example of a Euclidean ring are the integers. Whenever both \f$ x\f$ and \f$ y\f$ are positive, then it is conventional to choose diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h index 0ef99f21861..b019db776d3 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h @@ -16,8 +16,7 @@ and the \f$ k\f$-dimensional faces of the triangulation. Note that this class is at the same time used for basic and for weighted Alpha Shapes. -Parameters --------------- +### Parameters ### The template parameter `Dt` has to be either `Delaunay_triangulation_2` or `Regular_triangulation_2`. Note that `DT::Geom_traits`, `DT::Vertex` and `DT::Face` must model the concepts `AlphaShapeTraits_2`, @@ -30,8 +29,7 @@ kernel. By default the `ExactAlphaComparisonTag` is set to `CGAL::Tag_false` as overhead. Note that since such a strategy does not make sense if used together with a traits class with exact constructions, the tag `ExactAlphaComparisonTag` is not taken into account if `Dt::Geom_traits::FT` is not a floating point number type. -Inherits From --------------- +### Inherits From ### Inherits from `Dt`. @@ -40,14 +38,12 @@ This class is the underlying triangulation class. The modifying functions `insert` and `remove` will overwrite the inherited functions. At the moment, only the static version is implemented. -I/O --------------- +### I/O ### The I/O operators are defined for `std::iostream`. The format for the iostream is an internal format. -Implementation --------------- +### Implementation ### The set of intervals associated with the \f$ k\f$-dimensional faces of the underlying triangulation are diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h index a4ec27aac63..09bb9e9d2f9 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_face_base_2.h @@ -6,8 +6,7 @@ namespace CGAL { The class `Alpha_shape_face_base_2` is the default model for the concept `AlphaShapeFace_2`. -Parameters --------------- +### Parameters ### The template parameter `Traits` has to be a model of `AlphaShapeTraits_2`. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h index ae2af18c378..115d1972c31 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/CGAL/Alpha_shape_vertex_base_2.h @@ -7,8 +7,7 @@ namespace CGAL { The class `Alpha_shape_vertex_base_2` is the default model for the concept `AlphaShapeVertex_2`. -Parameters --------------- +### Parameters ### The template parameter `Traits` has to be a model of `AlphaShapeTraits_2`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h index 042cb53fabc..5b6d7878a41 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h @@ -19,8 +19,7 @@ the tag `ExactAlphaComparisonTag` is not taken into account if `Dt::Geom_traits: Note that this class is at the same time used for basic and for weighted Alpha Shapes. -Inherits From --------------- +### Inherits From ### Inherits from `Dt`. @@ -29,15 +28,13 @@ This class is the underlying triangulation class. The modifying functions `insert` and `remove` will overwrite the inherited functions. At the moment, only the static version is implemented. -I/O --------------- +### I/O ### The I/O operators are defined for `iostream`, and for the window stream provided by \cgal. The format for the iostream is an internal format. -Implementation --------------- +### Implementation ### In GENERAL mode, the alpha intervals of each triangulation face is computed and stored at initialization time. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h index cb6e71d0cbd..fae0ab35de6 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h @@ -15,8 +15,7 @@ a classification that specifies its status in the alpha complex, alpha being fix Note that this class can be used at the same time to build a basic or a weighted Alpha Shape. -Inherits From --------------- +### Inherits From ### Inherits from `Dt`. @@ -25,8 +24,7 @@ This class is the underlying triangulation class. The modifying functions `insert` and `remove` will overwrite the inherited functions. -I/O --------------- +### I/O ### The I/O operators are defined for `iostream`, and for the window stream provided by \cgal. The format for the iostream diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h index 6a40f29bd58..6799c629e20 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_2.h @@ -13,15 +13,13 @@ The second template argument defaults to `CGAL::Triangulation_data_structure_2< CGAL::Apollonius_graph_vertex_base_2, CGAL::Triangulation_face_base_2 >`. \models ::DelaunayGraph_2 -Traversal of the Apollonius Graph --------------- +### Traversal of the Apollonius Graph ### An Apollonius graph can be seen as a container of faces and vertices. Therefore the Apollonius graph provides several iterators and circulators that allow to traverse it (completely or partially). -Traversal of the Convex Hull ----------------------------- +### Traversal of the Convex Hull ### Applied on the `infinite_vertex` the `incident_*` functions allow to visit the vertices on the convex hull and the infinite edges and diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h index ee786c35d09..8483da6f33a 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_2.h @@ -38,8 +38,7 @@ The `Apollonius_graph_hierarchy_2` class derives publicly from the the same with its base class. In the sequel only the methods overridden are documented. -Types --------------- +### Types ### `Apollonius_graph_hierarchy_2` does not introduce other types than those introduced by its base class `Apollonius_graph_2`. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h index 95e50a489b2..d286d2c20ee 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_site_2.h @@ -10,14 +10,12 @@ The class `Apollonius_site_2` is a model for the concept \models ::ApolloniusSite_2 -Types --------------- +### Types ### The class `Apollonius_site_2` does not introduce any types in addition to the concept `ApolloniusSite_2`. -I/O --------------- +### I/O ### The I/O operators are defined for `iostream`. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h index d190990687a..c3dfae5b76a 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphHierarchyVertexBase_2.h @@ -14,8 +14,7 @@ next and previous level graphs. \refines ::ApolloniusGraphVertexBase_2 -Types --------------- +### Types ### `ApolloniusGraphHierarchyVertexBase_2` does not introduce any types in addition to those of `ApolloniusGraphVertexBase_2`. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h index f10f34f7517..d116028598b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_batched_point_location.h @@ -14,8 +14,7 @@ pairs in the output sequence are sorted in increasing \f$ xy\f$-lexicographical order of the query points. The function returns a past-the-end iterator of the output sequence. -Requirements --------------- +### Requirements ###
  • `InputIterator::value_type` must be `Traits::Point_2`. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h index 318b72ed681..50b6bc18569 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_conic_traits_2.h @@ -77,8 +77,7 @@ supports the merging of curves of opposite directions. \models ::ArrangementLandmarkTraits_2 \models ::ArrangementDirectionalXMonotoneTraits_2 -Types --------------- +### Types ### */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h index da1e58ed289..23ac4408a21 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_curve_data_traits_2.h @@ -53,8 +53,7 @@ is associated with the output of this functor. \models ::ArrangementTraits_2 -Inherits From --------------- +### Inherits From ### CONVERROR Inherits From must be handled manually, e.g. adjust the class decl`Base_traits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h index a14ecf95d8a..6198d94a837 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_extended_dcel.h @@ -35,8 +35,7 @@ The default values follow: \models ::ArrangementDcelWithRebind -Inherits From --------------- +### Inherits From ### CONVERROR Inherits From must be handled manually, e.g. adjust the class decl
    diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h index 7ab55fcd745..46d8b12b424 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_iostream.h @@ -6,8 +6,7 @@ namespace CGAL { The function `read` reads a given arrangement from a given input stream using a specific input format. -Requirements --------------- +### Requirements ###
    • The instantiated `Formatter` class must model the @@ -44,8 +43,7 @@ std::istream& read (Arrangement_2& arr, The function `write` writes a given arrangement into a given output stream using a specific output format. -Requirements --------------- +### Requirements ###
      • The instantiated `Formatter` class must model the diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h index e33b6b64f3a..729e29cd370 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_non_caching_segment_traits_2.h @@ -36,8 +36,7 @@ supports the merging of curves of opposite directions. \models ::ArrangementLandmarkTraits_2 \models ::ArrangementDirectionalXMonotoneTraits_2 -Inherits From --------------- +### Inherits From ### CONVERROR Inherits From must be handled manually, e.g. adjust the class decl`Arr_non_caching_segment_basic_traits_2` diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h index 8e283db7087..67d0b902e6a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertical_decomposition_2.h @@ -42,8 +42,7 @@ is no feature above it.
      The function returns a past-the-end iterator for its output sequence. -Requirements --------------- +### Requirements ### `OutputIterator::value_type` must be `pair >`. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h index 67f53403dc2..f8d3b5bac94 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d.h @@ -102,10 +102,8 @@ requires a number type `ET` that provides exact arithmetic. (Both these aspects are discussed in the documentation of the concept `ApproximateMinEllipsoid_d_Traits_d`.) -Requirements --------------- -The template parameter `Traits` is a model for +\tparam Traits must be a model for `ApproximateMinEllipsoid_d_Traits_d`. We provide the model diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h index 28b90c5b6e0..0db62296489 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_2.h @@ -11,12 +11,9 @@ an exact number-type `ET` has to be provided which `Approximate_min_ellipsoid_d` will use for its internal exact computations. -Requirements --------------- +\tparam K must be a model for concept `Kernel`. -The template parameter `K` must be a model for concept -`Kernel`. The template parameter `ET` must be a model for concept -`RingNumberType` with exact arithmetic operations, i.e., the type +\tparam ET must be a model for concept `RingNumberType` with exact arithmetic operations, i.e., the type `CGAL::Number_type_traits::Has_exact_ring_operations` must be `CGAL::Tag_true`. In addition, `ET` must be able to exactly represent any finite `double` value. (Examples of such a diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h index 68b9698295a..39ccf1b03d7 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_3.h @@ -11,11 +11,9 @@ an exact number-type `ET` has to be provided which `Approximate_min_ellipsoid_d` will use for its internal exact computations. -Requirements --------------- +\tparam K must be a model for `Kernel`. -The template parameter `K` must be a model for concept -`Kernel`. The template parameter `ET` must be a model for concept +\tparam ET must be a model for concept `RingNumberType` with exact arithmetic operations, i.e., the type `CGAL::Number_type_traits::Has_exact_ring_operations` must be `CGAL::Tag_true`. In addition, `ET` must be able to exactly diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h index 8b9b6e5502d..2b55fcffa76 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Approximate_min_ellipsoid_d_traits_d.h @@ -11,11 +11,8 @@ an exact number-type `ET` has to be provided which `Approximate_min_ellipsoid_d` will use for its internal exact computations. -Requirements --------------- - -The template parameter `K` must be a model for concept -`Kernel`. The template parameter `ET` must be a model for concept +\tparam K must be a model for concept `Kernel`. +\tparam `ET` must be a model for concept `RingNumberType` with exact arithmetic operations, i.e., the type `CGAL::Number_type_traits::Has_exact_ring_operations` must be `CGAL::Tag_true`. In addition, `ET` must be able to exactly diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h index 1bade1d15c0..f2e653a8db5 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h @@ -24,10 +24,7 @@ The underlying algorithm can cope with all kinds of input, e.g. \f$ P\f$ may be empty or points may occur more than once. The algorithm computes a support set \f$ S\f$ which remains fixed until the next set, insert, or clear operation. -Requirements --------------- - -The template parameter `Traits` is a model for `OptimisationDTraits`. +\tparam Traits must be a model for `OptimisationDTraits`. We provide the models `Optimisation_d_traits_2`, `Optimisation_d_traits_3`, and `Optimisation_d_traits_d` using the @@ -39,8 +36,7 @@ two-, three-, and \f$ d\f$-dimensional \cgal kernel, respectively. \sa `CGAL::Optimisation_d_traits_d` \sa `OptimisationDTraits` -Implementation --------------- +### Implementation ### The problem of finding the smallest enclosing annulus of a finite point set can be formulated as an optimization problem with linear constraints and a @@ -272,8 +268,7 @@ FT squared_outer_radius( ) const; returns an iterator referring to the first coordinate of the center of `min_annulus`. -Note --------------- +### Note ### The coordinates have a rational representation, i.e. the first \f$ d\f$ elements of the iterator diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h index 2283ba8f3d5..f46aaff02c1 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h @@ -38,10 +38,8 @@ case the algorithm is division-free. Thus, `Min_circle_2` might still be an option in case your input number type cannot (efficiently) divide. -Requirements --------------- -The template parameter `Traits` is a model for `MinCircle2Traits`. +\tparam Traits must be a model for `MinCircle2Traits`. We provide the model `CGAL::Min_circle_2_traits_2` using the two-dimensional \cgal kernel. diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h index 02f4fe813c4..6b20a382b3b 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2_traits_2.h @@ -7,10 +7,7 @@ namespace CGAL { The class `Min_circle_2_traits_2` is a traits class for `Min_circle_2` using the two-dimensional \cgal kernel. -Requirements --------------- - -The template parameter `K` is a model for `Kernel`. +\tparam K must be a model for `Kernel`. \models ::MinCircle2Traits diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h index 42ea296c5b4..5581260b93f 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h @@ -23,10 +23,7 @@ The underlying algorithm can cope with all kinds of input, e.g. \f$ P\f$ may be empty or points may occur more than once. The algorithm computes a support set \f$ S\f$ which remains fixed until the next insert or clear operation. -Requirements --------------- - -The template parameter `Traits` is a model for `MinEllipse2Traits`. +\tparam Traits must be a model for `MinEllipse2Traits`. We provide the model `CGAL::Min_ellipse_2_traits_2` using the two-dimensional \cgal kernel. @@ -35,8 +32,7 @@ two-dimensional \cgal kernel. \sa `CGAL::Min_ellipse_2_traits_2` \sa `MinEllipse2Traits` -Implementation --------------- +### Implementation ### We implement the incremental algorithm of Welzl, with move-to-front heuristic \cite w-sedbe-91a, using the primitives as described @@ -50,8 +46,7 @@ take up to linear time, but substantially less than computing the new smallest enclosing ellipse from scratch. The clear operation and the check for validity each takes linear time. -Example --------------- +### Example ### To illustrate the usage of `Min_ellipse_2` and to show that randomization can be useful in certain cases, we give an example. The example also diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h index b83911f57aa..2e0720be338 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2_traits_2.h @@ -7,10 +7,7 @@ namespace CGAL { The class `Min_ellipse_2_traits_2` is a traits class for `CGAL::Min_ellipse_2` using the two-di-men-sional \cgal kernel. -Requirements --------------- - -The template parameter `K` is a model for `Kernel`. +The template parameter `K` must be a model for `Kernel`. \models ::MinEllipse2Traits diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h index e97c0384588..d1cf5e5f233 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_quadrilateral_traits_2.h @@ -8,11 +8,7 @@ The class `Min_quadrilateral_default_traits_2` is a traits class for the functions `min_rectangle_2`, `min_parallelogram_2` and `min_strip_2` using a two-dimensional \cgal kernel. -Requirements --------------- - -The template parameter `K` is a model for -`Kernel`. +\tparam K must be a model for `Kernel`. \models ::MinQuadrilateralTraits_2 diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h index ef1d88d001f..ff250b14f01 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_2.h @@ -7,13 +7,8 @@ namespace CGAL { The class `Min_sphere_annulus_d_traits_2` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the two-dimensional \cgal kernel. -Requirements --------------- - -The template parameter `K` is a model for `Kernel`. Template -parameters `ET` and `NT` are models for `RingNumberType`. - -The second and third template parameter have default type `K::RT`. +\tparam K must bea model for `Kernel`. +\tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. \models ::MinSphereAnnulusDTraits diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h index 8fd1e884025..dd2417777bf 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_3.h @@ -7,13 +7,8 @@ namespace CGAL { The class `Min_sphere_annulus_d_traits_3` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the three-dimensional \cgal kernel. -Requirements --------------- - -The template parameter `K` is a model for `Kernel`. Template -parameters `ET` and `NT` are models for `RingNumberType`. - -The second and third template parameter have default type `K::RT`. +\tparam K must be a model for `Kernel`. +\tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. \models ::MinSphereAnnulusDTraits diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h index e88075910c6..dacadb67164 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_annulus_d_traits_d.h @@ -7,13 +7,8 @@ namespace CGAL { The class `Min_sphere_annulus_d_traits_d` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel. -Requirements --------------- - -The template parameter `K` is a model for `Kernel`. Template -parameters `ET` and `NT` are models for `RingNumberType`. - -The second and third template parameter have default type `K::RT`. +\tparam K must be a model for `Kernel`. +\tparam ET NT are models for `RingNumberType`. Their default type is `K::RT`. \models ::MinSphereAnnulusDTraits diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h index 357e87c5ffa..8ceed3802d1 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h @@ -36,11 +36,10 @@ case the algorithm is division-free. Thus, `Min_sphere_d` might still be an option in case your input number type cannot (efficiently) divide. -Requirements --------------- -The class `Min_sphere_d` expects a model of the concept +\tparam Traits must be a model of the concept `OptimisationDTraits` as its template argument. + We provide the models `CGAL::Optimisation_d_traits_2`, `CGAL::Optimisation_d_traits_3` and `CGAL::Optimisation_d_traits_d` @@ -54,8 +53,7 @@ for two-, three-, and \f$ d\f$-dimensional points respectively. \sa `CGAL::Min_sphere_of_spheres_d` \sa `CGAL::Min_annulus_d` -Implementation --------------- +### Implementation ### We implement the algorithm of Welzl with move-to-front heuristic \cite w-sedbe-91a for small point sets, combined with a new @@ -68,8 +66,7 @@ but substantially less than computing the new smallest enclosing sphere from scratch. The clear operation and the check for validity each take linear time. -Example --------------- +### Example ### \cgalexample{min_sphere_d.cpp} @@ -129,7 +126,7 @@ Min_sphere_d (const Traits& traits = Traits()); creates a variable `min_sphere` of type `Min_sphere_d`. It is initialized to \f$ ms(P)\f$ with \f$ P\f$ being the set of points in the range [`first`,`last`). -\require The value type of `first` and `last` is `Point`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. \pre All points have the same dimension. +\requires The value type of `first` and `last` is `Point`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. \pre All points have the same dimension. */ template < class InputIterator > Min_sphere_d( InputIterator first, @@ -262,7 +259,7 @@ void clear (); sets `min_sphere` to the \f$ ms(P)\f$, where \f$ P\f$ is the set of points in the range [`first`,`last`). -\require The value type of `first` and `last` is `Point`. +\requires The value type of `first` and `last` is `Point`. \pre All points have the same dimension. */ template < class InputIterator > @@ -284,7 +281,7 @@ void insert( const Point& p); inserts the points in the range [`first`,`last`) into `min_sphere` and recomputes the smallest enclosing sphere, by calling `insert` for all points in the range. -\require The value type of `first` and `last` is `Point`. +\requires The value type of `first` and `last` is `Point`. \pre All points have the same dimension. If `min_sphere` is not empty, this dimension must be equal to `ambient_dimension()`. */ template < class InputIterator > @@ -334,7 +331,7 @@ const Traits& traits( ) const; /*! writes `min_sphere` to output stream `os`. -\require The output operator is defined for `Point`. +\requires The output operator is defined for `Point`. \relates Min_sphere_d */ std::ostream& operator << ( std::ostream& os, @@ -344,7 +341,7 @@ min_sphere); /*! reads `min_sphere` from input stream `is`. -\require The input operator is defined for `Point`. +\requires The input operator is defined for `Point`. \relates Min_sphere_d */ std::istream& operator >> ( std::istream& is, diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h index a0857d3f468..e70efe259c7 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_2.h @@ -10,23 +10,23 @@ type `Point_2` to represent circles. \models ::MinSphereOfSpheresTraits -\name Parameters -The last two template parameters, `UseSqrt` and `Algorithm`, have -default arguments, namely `CGAL::Tag_false` and -`CGAL::Default_algorithm`, respectively. The template parameters -of class `Min_sphere_of_points_d_traits_2` -must fulfill the following requirements: -\tparam K is a model for `Kernel`. + +\tparam K must be a model for `Kernel`. + \tparam FT is a number type, which fulfills the requirements of type `FT` of concept `MinSphereOfSpheresTraits`: It must be either `double` or `float`, or an exact number type. + \tparam UseSqrt fulfills the requirements of type `Use_square_roots` of concept -`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`. +`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`, +and it is by default `CGAL::Tag_false`. + \tparam Algorithm fulfills the requirements of type `Algorithm` of concept `MinSphereOfSpheresTraits`: It must be either -`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`. +`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`, +and it is by default `CGAL::Default_algorithm`. */ template< typename K, typename FT, typename UseSqrt, typename Algorithm > diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h index 9df443dd386..7ae06f2aefb 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_d.h @@ -10,25 +10,22 @@ a model for concept `MinSphereOfSpheresTraits`. It uses the \models ::MinSphereOfSpheresTraits -Parameters ----------- - -The last two template parameters, `UseSqrt` and `Algorithm`, have -default arguments, namely `CGAL::Tag_false` and -`CGAL::Default_algorithm`, respectively. The template parameters -of class `Min_sphere_of_points_d_traits_2` -must fulfill the following requirements: \tparam K is a model for `Kernel`. + \tparam FT is a number type, which fulfills the requirements of type `FT` of concept `MinSphereOfSpheresTraits`: It must be either `double` or `float`, or an exact number type. + \tparam UseSqrt fulfills the requirements of type `Use_square_roots` of concept -`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`. +`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`, +and its default is `Tag_false`. + \tparam Algorithm fulfills the requirements of type `Algorithm` of concept `MinSphereOfSpheresTraits`: It must be either -`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`. +`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`, +and its default is `Default_algorithm`. */ template< typename K, typename FT, typename Dim, typename UseSqrt, typename Algorithm > diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h index 6b70b6b9a20..e0436e57932 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d.h @@ -64,17 +64,13 @@ algorithm is division-free. Thus, `CGAL::Min_sphere_d` might still be an option in case your input number type cannot (efficiently) divide. -Requirements --------------- - -The class `Min_sphere_of_spheres_d` expects a model of the concept +\tparam Traits must be a model of the concept `MinSphereOfSpheresTraits` as its template argument. \sa `CGAL::Min_sphere_d` \sa `CGAL::Min_circle_2` -Implementation --------------- +### Implementation ### We implement two algorithms, the LP-algorithm and a heuristic \cite msw-sblp-92. As described in the documentation of @@ -97,8 +93,7 @@ not supported at this time. Also, the current implementation only handles spheres with Cartesian coordinates; homogenous representation is not supported yet. -Example --------------- +### Example ### \cgalexample{min_sphere_of_spheres_d_d.cpp} @@ -181,7 +176,7 @@ creates a variable `minsphere` of type `Min_sphere_of_spheres_d` and inserts (cf. `insert()`) the spheres from the range [`first`,`last`). -\require The value type of `first` and `last` is `Sphere`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. +\requires The value type of `first` and `last` is `Sphere`. If the traits parameter is not supplied, the class `Traits` must provide a default constructor. */ template < typename InputIterator > Min_sphere_of_spheres_d( InputIterator first, @@ -269,7 +264,7 @@ void clear (); sets `minsphere` to the \f$ ms(S)\f$, where \f$ S\f$ is the set of spheres in the range [`first`,`last`). -\require The value type of `first` and `last` is `Sphere`. +\requires The value type of `first` and `last` is `Sphere`. */ template < class InputIterator > void set( InputIterator first, InputIterator last ); @@ -284,7 +279,7 @@ void insert( const Sphere& s ); inserts the spheres in the range [`first`,`last`) into the set \f$ S\f$ of instance `minsphere`. -\require The value type of `first` and `last` is `Sphere`. +\requires The value type of `first` and `last` is `Sphere`. */ template < class InputIterator > void insert( InputIterator first, InputIterator last ); diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h index d2672018c4f..2634154ec54 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_2.h @@ -10,8 +10,6 @@ type `Point_2` to represent circles. \models ::MinSphereOfSpheresTraits -Parameters ----------- The last two template parameters, `UseSqrt` and `Algorithm`, have default arguments, namely `CGAL::Tag_false` and @@ -19,16 +17,21 @@ default arguments, namely `CGAL::Tag_false` and of class `Min_sphere_of_points_d_traits_2` must fulfill the following requirements: -\tparam K is a model for `Kernel`. +\tparam K must be a model for `Kernel`. + \tparam FT is a number type, which fulfills the requirements of type `FT` of concept `MinSphereOfSpheresTraits`: It must be either `double` or `float`, or an exact number type. + \tparam UseSqrt fulfills the requirements of type `Use_square_roots` of concept -`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`. +`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`, +and its default is `Tag_false`. + \tparam Algorithm fulfills the requirements of type `Algorithm` of concept `MinSphereOfSpheresTraits`: It must be either -`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`. +`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`, +and its default is `Default_algorithm`. */ template< typename K, typename FT, typename UseSqrt, typename Algorithm > class Min_sphere_of_spheres_d_traits_2 { diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h index b313c90866e..d4123fd283a 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_3.h @@ -10,22 +10,20 @@ type `Point_3` to represent circles. \models ::MinSphereOfSpheresTraits -Parameters ----------- -The last two template parameters, `UseSqrt` and `Algorithm`, have -default arguments, namely `CGAL::Tag_false` and -`CGAL::Default_algorithm`, respectively. +\tparam K must be a model for `Kernel`. -\tparam K is a model for `Kernel`. \tparam FT is a number type, which fulfills the requirements of type `FT` of concept `MinSphereOfSpheresTraits`: It must be either `double` or `float`, or an exact number type. + \tparam UseSqrt fulfills the requirements of type `Use_square_roots` of concept -`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`. +`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`, +and it defaults to `Tag_false`. + \tparam Algorithm fulfills the requirements of type -`Algorithm` of concept `MinSphereOfSpheresTraits`: It must be either `Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`. +`Algorithm` of concept `MinSphereOfSpheresTraits`: It must be either `Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`, and it defaults to `Default_algorithm`. */ template< typename K, typename FT, typename UseSqrt, typename Algorithm > diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h index e5e3f98935e..77e2f7b93b2 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_spheres_d_traits_d.h @@ -10,25 +10,22 @@ a model for concept `MinSphereOfSpheresTraits`. It uses the \models ::MinSphereOfSpheresTraits -Parameters ----------- - -The last two template parameters, `UseSqrt` and `Algorithm`, have -default arguments, namely `CGAL::Tag_false` and -`CGAL::Default_algorithm`, respectively. The template parameters -of class `Min_sphere_of_points_d_traits_2` -must fulfill the following requirements: \tparam K is a model for `Kernel`. + \tparam FT is a number type, which fulfills the requirements of type `FT` of concept `MinSphereOfSpheresTraits`: It must be either `double` or `float`, or an exact number type. + \tparam UseSqrt fulfills the requirements of type `Use_square_roots` of concept -`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false`. +`MinSphereOfSpheresTraits`: It must be either `Tag_true` or `Tag_false` +and it defaults to `Tag_false`. + \tparam Algorithm fulfills the requirements of type `Algorithm` of concept `MinSphereOfSpheresTraits`: It must be either -`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`. +`Default_algorithm`, `LP_algorithm` or `Farthest_first_heuristic`, +and it defaults to `Default_algorithm`. */ template< typename K, typename FT, typename Dim, typename UseSqrt, typename Algorithm > diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h index 98566116293..bb98d5fc437 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/min_quadrilateral_2.h @@ -184,15 +184,13 @@ is `CGAL::Point_2` for some kernel `K`. \sa `MinQuadrilateralTraits_2` \sa `CGAL::Min_quadrilateral_default_traits_2` -Implementation --------------- +### Implementation ### We use a rotating caliper algorithm \cite t-sgprc-83 with worst case running time linear in the number of input points. -Example --------------- +### Example ### The following code generates a random convex polygon `P` with 20 vertices and computes the minimum enclosing diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h index 5768460bf87..5c6fea22230 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/rectangular_p_center_2.h @@ -7,11 +7,8 @@ The class `Rectangular_p_center_default_traits_2` defines types and operations needed to compute rectilinear \f$ p\f$-centers of a planar point set using the function `rectangular_p_center_2`. -Requirements --------------- -The template parameter `K` is a model for -`Kernel`. +\tparam K must be a model for `Kernel`. \models ::RectangularPCenterTraits_2 @@ -245,8 +242,7 @@ is a model for `RectangularPCenterTraits_2`. \sa `CGAL::Rectangular_p_center_default_traits_2` \sa `CGAL::sorted_matrix_search` -Implementation --------------- +### Implementation ### The runtime is linear for \f$ p \in \{2,\,3\}\f$ and \f$ \mathcal{O}(n \cdot \log n)\f$ for \f$ p = 4\f$ where \f$ n\f$ is the number of @@ -256,8 +252,7 @@ algorithm uses a prune-and-search technique described in search \cite fj-fkppc-83, \cite fj-gsrsm-84 and fast algorithms for piercing rectangles \cite sw-rpppp-96. -Example --------------- +### Example ### The following code generates a random set of ten points and computes its two-centers. diff --git a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h index 7c450245f40..f1d3a4c306d 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h +++ b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h @@ -16,15 +16,13 @@ The only function that needs to be defined in a derived class is the name of the function suggests that the ipelet may throw exceptions that will be caught by a function of the class `Ipelet_base` avoiding Ipe to crash. -Parameters --------------- +### Parameters ### The `Kernel` template parameter determines the kernel that will be used in the ipelet. This parameter must be set according to the algorithm to be used. The integer `nbf` indicates the number of functions defined by the ipelet. -Readable and Drawable Object ----------------------------- +### Readable and Drawable Object ### The set of `read objects` is defined as the set of objects of type `Point_2`, `Segment_2`, `Polygon_2`, `Circular_arc_2` or diff --git a/Circulator/doc/Circulator/CGAL/circulator.h b/Circulator/doc/Circulator/CGAL/circulator.h index 42622969a62..e59758dd693 100644 --- a/Circulator/doc/Circulator/CGAL/circulator.h +++ b/Circulator/doc/Circulator/CGAL/circulator.h @@ -194,13 +194,11 @@ requirements for container (i.e.\ to have a `begin()` and an `reference`, `const_reference`, `value_type`, `size_type`, and `difference_type`). -Types --------------- +### Types ### All types required for circulators are provided. -Operations --------------- +### Operations ### The adaptor conforms to the requirements of the corresponding circulator category. An additional member function @@ -211,8 +209,7 @@ the same position as the circulator does. \sa `Circulator_from_iterator` \sa `Circulator` -Example --------------- +### Example ### The following program composes two adaptors - from a container to a circulator and back to an iterator. It applies an \stl sort algorithm @@ -270,8 +267,7 @@ category. The circulator will be mutable or non-mutable according to the iterator. Iterators provide no `size_type`. This adapter assumes `std::size_t` instead. -Operations --------------- +### Operations ### The adaptor conforms to the requirements of the respective circulator category. An additional member function `current_iterator()` @@ -282,8 +278,7 @@ circulator does. \sa `Circulator_from_container` \sa `Circulator` -Example --------------- +### Example ### The following program composes two adaptors - from an iterator to a circulator and back to an iterator. It applies an \stl sort algorithm @@ -393,8 +388,7 @@ circulator category for iterators, i.e.\ one of `Forward_circulator_tag`, `Bidirectional_circulator_tag`, or `Random_access_circulator_tag`. -Example --------------- +### Example ### A generic function `bar` that distinguishes between a call with a circulator range and a call with an iterator range: @@ -466,8 +460,7 @@ otherwise. \sa `Circulator_from_container` \sa `Circulator` -Example --------------- +### Example ### The generic reverse() algorithm from the \stl can be used with an adaptor if at least a bidirectional circulator c is given. @@ -480,8 +473,7 @@ reverse( container.begin(), container.end()); \endcode -Implementation --------------- +### Implementation ### The iterator adaptor keeps track of the number of rounds a circulator has done around the ring-like data structure (a kind of winding @@ -634,8 +626,7 @@ the range is empty or not. \pre `IC` is either a circulator or an iterator type. The range [`i, j`) is valid. -Example --------------- +### Example ### The following function `process_all` accepts a range \f$ \left[i, j\right)\f$ of an iterator or circulator `IC` and processes each diff --git a/Circulator/doc/Circulator/CGAL/circulator_bases.h b/Circulator/doc/Circulator/CGAL/circulator_bases.h index 71874f6c988..5e3fe0599a2 100644 --- a/Circulator/doc/Circulator/CGAL/circulator_bases.h +++ b/Circulator/doc/Circulator/CGAL/circulator_bases.h @@ -18,8 +18,7 @@ To use the tags or base classes only it is sufficient to include: \sa `is_empty_range` \sa `Circulator` -Example --------------- +### Example ### The above declarations can be used to distinguish between iterators and circulators and between different circulator categories. The @@ -29,8 +28,7 @@ example program illustrates both. \cgalexample{circulator_prog3.cpp} -Implementation --------------- +### Implementation ### Since not all current compilers can eliminate the space needed for the compile time tags even when deriving from them, we implement a variant diff --git a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h index a1aeeb474a7..871b0cb9bb2 100644 --- a/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h +++ b/Combinatorial_map/doc/Combinatorial_map/CGAL/Combinatorial_map_min_items.h @@ -12,8 +12,7 @@ In this class, no attribute is enabled. \models ::CombinatorialMapItems -Example --------------- +### Example ### The following example shows the implementation of the `CGAL::Combinatorial_map_min_items` class. diff --git a/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h b/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h index 0db6beae002..d2428a57991 100644 --- a/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h +++ b/Combinatorial_map/doc/Combinatorial_map/CGAL/Dart.h @@ -13,15 +13,11 @@ non void i-attribute. \models ::Dart -Parameters --------------- +\tparam d an integer for the dimension of the dart. -`d` an integer for the dimension of the dart. +\tparam CMap must be a model of the `CombinatorialMap` concept. -`CMap` must be a model of the `CombinatorialMap` concept. - -Complexity --------------- +###Complexity ### Each \f$ \beta_i\f$ link is initialized to `CMap::null_dart_handle`, and each attribute handle of non void i-attribute is initialized to `NULL` diff --git a/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h b/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h index 408c3993efd..9859acf0c43 100644 --- a/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h +++ b/Combinatorial_map/doc/Combinatorial_map/Concepts/CombinatorialMapItems.h @@ -9,8 +9,7 @@ attributes. For that, it defines an inner class template named of the `CombinatorialMap` concept. This inner class must define two types: `Dart` and `Attributes`. -Example --------------- +### Example ### The following examples show two possible models of the `CombinatorialMapItems` concept: the first one for a 4D diff --git a/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h b/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h index 0e7a3cf10ea..46805afc161 100644 --- a/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h +++ b/Combinatorial_map/doc/Combinatorial_map/Concepts/Dart.h @@ -8,8 +8,7 @@ stores handles to the darts linked with itself by \f$ \beta_i\f$, \f$ \forall\f$ 0\f$ \leq\f$i\f$ \leq\f$d. Moreover, it stores also handles to each non void attribute associated with itself. -Creation --------------- +### Creation ### A dart `d0` is never constructed directly, but always created within a combinatorial map `cm` by using the method diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h index 52d42077017..663400f5772 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_akl_toussaint.h @@ -13,8 +13,7 @@ cyclic sequence of extreme points is cut into a linear sequence. The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
      1. `ForwardIterator::value_type` and @@ -39,8 +38,7 @@ functions that return instances of these types: \sa `CGAL::ch_melkman` \sa `CGAL::convex_hull_2` -Implementation --------------- +### Implementation ### This function uses the algorithm of Akl and Toussaint \cite at-fcha-78 that requires \f$ O(n \log n)\f$ time for \f$ n\f$ input diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h index c10f79a5747..5cd818c13bc 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_bykat.h @@ -14,8 +14,7 @@ cyclic sequence of extreme points is cut into a linear sequence. The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
        1. `InputIterator::value_type` and @@ -40,8 +39,7 @@ functions that return instances of these types: \sa `CGAL::ch_melkman` \sa `CGAL::convex_hull_2` -Implementation --------------- +### Implementation ### This function implements the non-recursive variation of Eddy's algorithm \cite e-nchap-77 described in \cite b-chfsp-78. diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h index 3174df4061a..8fce4e17a67 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_eddy.h @@ -14,8 +14,7 @@ cyclic sequence of extreme points is cut into a linear sequence. The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
          1. `InputIterator::value_type` and @@ -40,8 +39,7 @@ functions that return instances of these types: \sa `CGAL::ch_melkman` \sa `CGAL::convex_hull_2` -Implementation --------------- +### Implementation ### This function implements Eddy's algorithm \cite e-nchap-77, which is the two-dimensional version of the quickhull diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h index 77412e61650..351db824f8f 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_graham_andrew.h @@ -15,8 +15,7 @@ cyclic sequence of extreme points is cut into a linear sequence. The default traits class `Default_traits` is the kernel in which the type `InputIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
            1. `InputIterator::value_type` and @@ -43,8 +42,7 @@ functions that return instances of these types: \sa `CGAL::lower_hull_points_2` \sa `CGAL::upper_hull_points_2` -Implementation --------------- +### Implementation ### This function implements Andrew's variant of the Graham scan algorithm \cite a-aeach-79 and follows the presentation of Mehlhorn @@ -74,8 +72,7 @@ by the first and last points in this sequence. The default traits class `Default_traits` is the kernel in which the type `BidirectionalIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
              1. `BidirectionalIterator::value_type` and @@ -94,15 +91,13 @@ functions that return instances of these types: \sa `CGAL::lower_hull_points_2` \sa `CGAL::upper_hull_points_2` -Implementation --------------- +### Implementation ### The function uses Andrew's variant of the Graham scan algorithm \cite a-aeach-79. This algorithm requires \f$ O(n \log n)\f$ time in the worst case for \f$ n\f$ input points. -Example --------------- +### Example ### In the following example `::ch_graham_andrew_scan` is used to realize Anderson's variant \cite a-readc-78 of the Graham Scan diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h index 72210f79748..f19773033ca 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_jarvis.h @@ -14,8 +14,7 @@ cyclic sequence of extreme points is cut into a linear sequence. The default traits class `Default_traits` is the kernel in which the type `InputIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
                1. `InputIterator::value_type` and @@ -40,8 +39,7 @@ functions that return instances of these types: \sa `CGAL::ch_melkman` \sa `CGAL::convex_hull_2` -Implementation --------------- +### Implementation ### This function uses the Jarvis march (gift-wrapping) algorithm \cite j-ichfs-73. This algorithm requires \f$ O(n h)\f$ time @@ -69,8 +67,7 @@ points from a given set of input points that line between two input points. The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
                  1. `ForwardIterator::value_type` and @@ -90,8 +87,7 @@ functions that return instances of these types: \sa `CGAL::lower_hull_points_2` \sa `CGAL::upper_hull_points_2` -Implementation --------------- +### Implementation ### The function uses the Jarvis march (gift-wrapping) algorithm \cite j-ichfs-73. This algorithm requires \f$ O(n h)\f$ time in the worst diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h index 75240b3b56c..425b54d12e5 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_melkman.h @@ -13,8 +13,7 @@ the resulting sequence is returned. The default traits class `Default_traits` is the kernel in which the type `InputIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
                    1. `InputIterator::value_type` and `OutputIterator::value_type` @@ -38,8 +37,7 @@ functions that return instances of these types: \sa `CGAL::ch_melkman` \sa `CGAL::convex_hull_2` -Implementation --------------- +### Implementation ### It uses an implementation of Melkman's algorithm \cite m-olcch-87. Running time of this is linear. diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h index 9eab1fa1080..2c5c49f996a 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/ch_selected_extreme_points_2.h @@ -14,8 +14,7 @@ After execution, the value of The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ### `Traits` defines a type `Traits::Less_xy_2` as described in the concept `ConvexHullTraits_2` and the corresponding member @@ -54,8 +53,7 @@ After execution, the value of The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ### `Traits` defines the type `Traits::Less_yx_2` as specified in the concept `ConvexHullTraits_2` and the corresponding member @@ -96,8 +94,7 @@ holds for all iterators in the range. The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ### `Traits` defines the type `Traits::Less_yx_2` as specified in the concept `ConvexHullTraits_2` and the corresponding member @@ -140,8 +137,7 @@ After execution, the value of \f$ \ge_{xy}\f$ `*it` hold for all iterators `it` in the range. -Requirements --------------- +### Requirements ### `Traits` contains the following subset of types from the concept `ConvexHullTraits_2` and their corresponding member @@ -190,8 +186,7 @@ After execution, the value of The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ### `Traits` defines the type `Traits::Less_yx_2` as specified in the concept `ConvexHullTraits_2` and the corresponding member @@ -232,8 +227,7 @@ holds for all iterators in the range. The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ### `Traits` defines the type `Traits::Less_xy_2` as specified in the concept `ConvexHullTraits_2` and the corresponding member @@ -270,8 +264,7 @@ After execution, the value of `w` is an iterator in the range such that `*w` \f$ \le_{xy}\f$ `*it` for all iterators `it` in the range. -Requirements --------------- +### Requirements ### `Traits` defines the type `Traits::Less_xy_2` as specified in the concept `ConvexHullTraits_2` and the corresponding member diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h index 18409ede4f9..58552a78d5e 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_2.h @@ -17,8 +17,7 @@ cyclic sequence of extreme points is cut into a linear sequence. The default traits class `Default_traits` is the kernel in which the type `InputIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
                      1. `InputIterator::value_type` and `OutputIterator::value_type` @@ -43,8 +42,7 @@ functions that return instances of these types: \sa `CGAL::ch_jarvis` \sa `CGAL::ch_melkman` -Implementation --------------- +### Implementation ### One of two algorithms is used, depending on the type of iterator used to specify the input points. For @@ -91,8 +89,7 @@ The different treatment by `::upper_hull_points_2` of the case that all points are equal ensures that concatenation of lower and upper hull points gives the sequence of extreme points. -Requirements --------------- +### Requirements ###
                        1. `InputIterator::value_type` and `OutputIterator::value_type` @@ -113,8 +110,7 @@ functions that return instances of these types: \sa `CGAL::ch_graham_andrew_scan` \sa `CGAL::upper_hull_points_2` -Implementation --------------- +### Implementation ### This function uses Andrew's variant of Graham's scan algorithm \cite a-aeach-79, \cite m-mdscg-84. The algorithm has worst-case running time @@ -157,8 +153,7 @@ The different treatment by `::lower_hull_points_2` of the case that all points are equal ensures that concatenation of lower and upper hull points gives the sequence of extreme points. -Requirements --------------- +### Requirements ###
                          1. `InputIterator::value_type` and `OutputIterator::value_type` @@ -179,8 +174,7 @@ functions that return instances of these types: \sa `CGAL::ch_graham_andrew_scan` \sa `CGAL::lower_hull_points_2` -Implementation --------------- +### Implementation ### This function uses Andrew's variant of Graham's scan algorithm \cite a-aeach-79, \cite m-mdscg-84. The algorithm diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h index ab56705a788..695576751af 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convexity_check_2.h @@ -16,8 +16,7 @@ if it consists of only extreme points The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ### `Traits` contains the following subset of types from the concept `ConvexHullTraits_2` and their corresponding member @@ -31,8 +30,7 @@ functions that return instances of these types: \sa `CGAL::is_cw_strongly_convex_2` \sa `CGAL::is_strongly_convex_3` -Implementation --------------- +### Implementation ### The algorithm requires \f$ O(n)\f$ time for a set of \f$ n\f$ input points. @@ -67,8 +65,7 @@ if it consists of only extreme points The default traits class `Default_traits` is the kernel in which the type `ForwardIterator::value_type` is defined. -Requirements --------------- +### Requirements ### `Traits` contains the following subset of types from the concept `ConvexHullTraits_2` and their corresponding member @@ -82,8 +79,7 @@ functions that return instances of these types: \sa `CGAL::is_ccw_strongly_convex_2` \sa `CGAL::is_strongly_convex_3` -Implementation --------------- +### Implementation ### The algorithm requires \f$ O(n)\f$ time for a set of \f$ n\f$ input points. diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h index 22519b9aa5c..ce7f2602117 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_3.h @@ -17,8 +17,7 @@ are available. The first can be used when it is known that the result will be a polyhedron and the second when a degenerate hull may also be possible. -Requirements --------------- +### Requirements ### Both functions require the following:
                              @@ -50,14 +49,12 @@ then the default traits class of `::convex_hull_3` is `Convex_hull_traits_3`, \sa `CGAL::ch_eddy` \sa `CGAL::convex_hull_2` -Implementation --------------- +### Implementation ### The algorithm implemented by these functions is the quickhull algorithm of Barnard et al. \cite bdh-qach-96. -Example --------------- +### Example ### The following program computes the convex hull of a set of 250 random points chosen from a sphere of radius 100. It then determines if the resulting diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h index cd232347522..21cdaa0148b 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convex_hull_incremental_3.h @@ -15,8 +15,7 @@ purposes. When an efficient incremental implementation is needed, using `CGAL::Delaunay_triangulation_3` together with `CGAL::convex_hull_3_to_polyhedron_3` is highly recommended. -Requirements --------------- +### Requirements ###
                              1. `Polyhedron` must provide a type `Polyhedron::Traits` @@ -34,8 +33,7 @@ the representation class `R` required by \sa `CGAL::convex_hull_3` \sa `CGAL::convex_hull_2` -Implementation --------------- +### Implementation ### This function uses the \f$ d\f$-dimensional convex hull incremental construction algorithm \cite cms-frric-93 @@ -44,8 +42,7 @@ worst case and \f$ O(n \log n)\f$ expected time. \sa `CGAL::Convex_hull_d` -Example --------------- +### Example ### The following example computes the convex hull of a set of 250 random points chosen uniformly in a sphere of radius 100. diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h index f754f7bedb2..b8783a522fa 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/convexity_check_3.h @@ -11,8 +11,7 @@ vertices of the convex hull). The default traits class is the kernel in which the type `Polyhedron_3::Point_3` is defined. -Requirements --------------- +### Requirements ###
                                1. `Polyhedron_3::Point_3` is equivalent to `Traits::Point_3`. @@ -37,8 +36,7 @@ the facet type must be `ConvexHullPolyhedronFacet_3`. \sa `CGAL::is_ccw_strongly_convex_2` \sa `CGAL::is_cw_strongly_convex_2` -Implementation --------------- +### Implementation ### This function implements the tests described in \cite mnssssu-cgpvg-96 to determine convexity and requires \f$ O(e + f)\f$ time for a polyhedron with diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h index f4b5db85900..9e387224ccb 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d.h @@ -44,13 +44,11 @@ C.index_of_vertex_in_opposite_facet(f,i)`. Then `f = C.opposite_facet(g,j)` and `i = C.index_of_vertex_in_opposite_facet(g,j)`. -Requirements --------------- +### Requirements ### `R` is a model of the concept `ConvexHullTraits_d`. -Iteration Statements --------------- +### Iteration Statements ### forall_ch_vertices(\f$ v,C\f$) \f$ \{\f$ the vertices of \f$ C\f$ are successively assigned to \f$ v\f$ \f$ \}\f$ @@ -61,8 +59,8 @@ successively assigned to \f$ s\f$ \f$ \}\f$ forall_ch_facets(\f$ f,C\f$) \f$ \{\f$ the facets of \f$ C\f$ are successively assigned to \f$ f\f$ \f$ \}\f$ -Implementation --------------- +### Implementation ### + The implementation of type `Convex_hull_d` is based on \cite cms-frric-93 and \cite bms-dgc-94. The details of the implementation can be found in the implementation document diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h index 78ace8da1f8..8fc1eb22909 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Delaunay_d.h @@ -53,16 +53,14 @@ belongs to the nearest site triangulation and the test `DT.simplex_of_furthest(dt_simplex s)` returns true if `s` belongs to the furthest site triangulation. -Requirements --------------- +### Requirements ### `R` is a model of the concept `DelaunayTraits_d` c. `Lifted_R` is a model of the concept `DelaunayLiftedTraits_d` c. -Implementation --------------- +### Implementation ### The data type is derived from `Convex_hull_d` via the lifting map. For a point \f$ x\f$ in \f$ d\f$-dimensional space let @@ -78,8 +76,7 @@ The space requirement is the same as for convex hulls. The time requirement for an insert is the time to insert the lifted point into the convex hull of the lifted points. -Example --------------- +### Example ### The abstract data type `Delaunay_d` has a default instantiation by means of the \f$ d\f$-dimensional geometric kernel. @@ -104,8 +101,7 @@ Vertex_handle v1 = T.insert(Point_d(2,11)); } \endcode -Traits requirements --------------- +### Traits Requirements ### `Delaunay_d< R, Lifted_R >` requires the following types from the kernel traits `Lifted_R`: diff --git a/Generator/doc/Generator/CGAL/Random.h b/Generator/doc/Generator/CGAL/Random.h index f67801208a1..5188424e7ea 100644 --- a/Generator/doc/Generator/CGAL/Random.h +++ b/Generator/doc/Generator/CGAL/Random.h @@ -21,8 +21,7 @@ It can be very useful, e.g. for debugging, to reproduce a sequence of random numbers. This can be done by either initialising with a fixed seed, or by using the state functions as described below. -Implementation --------------- +### Implementation ### We use the boost random library function `boost::rand48` to generate the random numbers. diff --git a/Generator/doc/Generator/CGAL/point_generators_2.h b/Generator/doc/Generator/CGAL/point_generators_2.h index ee379f28398..204ee093a81 100644 --- a/Generator/doc/Generator/CGAL/point_generators_2.h +++ b/Generator/doc/Generator/CGAL/point_generators_2.h @@ -12,6 +12,7 @@ The function `perturb_points_2` perturbs each point in a given range of points b a random amount. ###Requires ### + - `Creator` must be a function object accepting two `double` values \f$ x\f$ and \f$ y\f$ and returning an initialized point `(x,y)` of type `P`. diff --git a/Generator/doc/Generator/CGAL/point_generators_d.h b/Generator/doc/Generator/CGAL/point_generators_d.h index 558afb904fd..b4ea209e54e 100644 --- a/Generator/doc/Generator/CGAL/point_generators_d.h +++ b/Generator/doc/Generator/CGAL/point_generators_d.h @@ -14,8 +14,7 @@ within the hypercube \f$ [-a,a]^{dim}\f$. \returns the value of \f$ o\f$ after inserting the \f$ n\f$ points. -Requirements --------------- +### Requirements ###
                                  • `Creator` must be a functor accepting an integer (the dimension) diff --git a/Generator/doc/Generator/CGAL/random_convex_set_2.h b/Generator/doc/Generator/CGAL/random_convex_set_2.h index 93ad2237a1d..c9bdcc16153 100644 --- a/Generator/doc/Generator/CGAL/random_convex_set_2.h +++ b/Generator/doc/Generator/CGAL/random_convex_set_2.h @@ -13,8 +13,7 @@ The function `random_convex_set_2` computes a random convex planar point set of given size where the points are drawn from a specific domain. -Requirements --------------- +### Requirements ###
                                    1. `PointGenerator` is a model of the concept PointGenerator @@ -33,16 +32,14 @@ The default traits class `Default_traits` is \sa `CGAL::Random_points_in_square_2` \sa `CGAL::Random_points_in_disc_2` -Implementation --------------- +### Implementation ### The implementation uses the centroid method described in \cite cgal:s-zkm-96 and has a worst case running time of \f$ O(r \cdot n + n \cdot \log n)\f$, where \f$ r\f$ is the time needed by `pg` to generate a random point. -Example --------------- +### Example ### The following program displays a random convex 500-gon where the points are drawn uniformly from the unit square centered at the diff --git a/Generator/doc/Generator/CGAL/random_polygon_2.h b/Generator/doc/Generator/CGAL/random_polygon_2.h index 3e386e389fe..162c0509e8e 100644 --- a/Generator/doc/Generator/CGAL/random_polygon_2.h +++ b/Generator/doc/Generator/CGAL/random_polygon_2.h @@ -15,8 +15,7 @@ points has a non-zero probability of being constructed, some polygons may have higher probabilities than others. The overall distribution of the generated polygons is not known since it depends on the generated points. -Requirements --------------- +### Requirements ###
                                      1. `Traits` is a model of the concept RandomPolygonTraits_2 @@ -30,8 +29,7 @@ The default traits class `Default_traits` is the kernel in which \sa `CGAL::Random_points_in_disc_2` \sa `CGAL::Random_points_in_square_2` -Implementation --------------- +### Implementation ### The implementation is based on the method of eliminating self-intersections in a polygon by using so-called "2-opt" moves. Such a move eliminates an @@ -42,8 +40,7 @@ Intersecting edges are detected using a simple sweep through the vertices and then one intersection is chosen at random to eliminate after each sweep. The worse-case running time is therefore \f$ O(n^4 \log n)\f$. -Example --------------- +### Example ### The following program displays a random simple polygon with up to 100 vertices, where the vertex coordinates are drawn uniformly from the diff --git a/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h b/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h index 6b9dffed998..d35ea13c4fb 100644 --- a/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h +++ b/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h @@ -7,8 +7,7 @@ class used by the function `random_polygon_2`. \hasModel \cgal kernels. -Operations --------------- +### Operations ### The following two member functions returning instances of the above predicate object types are required. diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h index fdfcea67a5c..358c83dc890 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h @@ -5,11 +5,7 @@ namespace Qt { An object of type `CircularArcGraphicsItem` is a graphics item that encapsulates a circular arc. -Parameters --------------- - -The template parameter of `CircularArcGraphicsItem` must be a -\cgal `CircularKernel`. +\tparam CK must be a \cgal `CircularKernel`. */ template< typename CK > diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h index 446e58dbf3e..3b2821f2744 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h @@ -5,11 +5,8 @@ namespace Qt { An object of type `ConstrainedTriangulationGraphicsItem` is a graphics item that encapsulates a constrained triangulation. -Parameters --------------- -The template parameter of `ConstrainedTriangulationGraphicsItem` must be a -\cgal 2D constrained triangulation class. +\tparam CT must be a \cgal 2D constrained triangulation class. */ template< typename CT > diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h index 2dbb306e875..38043b7e294 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h @@ -9,10 +9,9 @@ vertex is inserted every time the left mouse button is released. The `Del` key removes the last entered point. The `Esc` key removes all entered points. -Parameters --------------- -The template parameter of `GraphicsViewCircleInput` must be a \cgal `Kernel`. + +\tparam K must be a \cgal `Kernel`. */ template< typename K > diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h index 4e3e317f063..46c0e23192b 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h @@ -8,10 +8,7 @@ vertex is inserted every time the left mouse button is released. The `Del` key removes the last entered point. The `Esc` key removes all entered points. -Parameters --------------- - -The template parameter of `GraphicsViewCircularArcInput` must be a \cgal `CircularKernel`. +\tparam K must be a \cgal `CircularKernel`. */ template< typename K > diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h index 6a1922377f7..83fe26151cb 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h @@ -5,10 +5,7 @@ namespace Qt { An object of type `GraphicsViewIsoRectangleInput` creates an axis parallel rectangle. -Parameters --------------- - -The template parameter of `GraphicsViewIsoRectangleInput` must be a \cgal `Kernel`. +\tparam K must be a \cgal `Kernel`. */ template< typename K > diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h index 3233b43aff8..92c096cd6f9 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h @@ -18,10 +18,7 @@ For polylines the segment between the last entered point and the current mouse position is only drawn correctly when mouse tracking is enabled in the graphics view. The same holds for closed polygons. -Parameters --------------- - -The template parameter of `GraphicsViewPolylineInput` must be a \cgal `Kernel`. +\tparam K must be a \cgal `Kernel`. */ template< typename K > diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h index 042433c65d7..507a0584361 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h @@ -5,11 +5,7 @@ namespace Qt { An object of type `TriangulationGraphicsItem` is a graphics item that encapsulates a 2D triangulation. -Parameters --------------- - -The template parameter of `TriangulationGraphicsItem` must be a -\cgal 2D triangulation class. +\tparam K must be a \cgal 2D triangulation class. */ template< typename T > diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h index 4c0e97b228a..a0ca022d319 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h @@ -7,11 +7,7 @@ An object of type `VoronoiGraphicsItem` is a graphics item that encapsulates a Delaunay triangulation in order to draw its dual, the Voronoi diagram. -Parameters --------------- - -The template parameter `DT` of `VoronoiGraphicsItem` must be a -\cgal 2D Delaunay triangulation class. +\tparam DT must be a \cgal 2D Delaunay triangulation class. */ template< typename DT > diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h index ead91c00bc6..68cb215800c 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h @@ -24,8 +24,7 @@ actions. If a particular feature is not supported nothing is done. Note that for example the creation of new halfedges is mandatory for all halfedge data structures and will not appear here again. -Example --------------- +### Example ### The following program fragment illustrates the implementation of a `is_valid()` member function for a simplified polyhedron class. diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h index f9afd08cdb1..e0dfe42ded2 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h @@ -26,8 +26,7 @@ all halfedge data structures and will not appear here again. \sa `CGAL::HalfedgeDS_items_decorator` \sa `CGAL::HalfedgeDS_const_decorator` -Example --------------- +### Example ### The following program fragment illustrates the implementation of the Euler operator `split_vertex()` for a simplified polyhedron class. @@ -117,10 +116,7 @@ Halfedge_handle create_segment(); removes the first vertex if vertices are supported. -Requirement --------------- -`Supports_removal` \f$ \equiv\f$ -`CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void vertices_pop_front(); @@ -134,10 +130,7 @@ void vertices_pop_back(); removes the vertex `v` if vertices are supported. -Requirement --------------- -`Supports_removal` \f$ \equiv\f$ -`CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void vertices_erase( Vertex_handle v); @@ -145,9 +138,7 @@ void vertices_erase( Vertex_handle v); removes the range `[first,last)` if vertices are supported. -Requirement --------------- -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void vertices_erase( Vertex_handle first, Vertex_handle last); @@ -155,9 +146,7 @@ void vertices_erase( Vertex_handle first, Vertex_handle last); removes the first face if faces are supported. -Requirement --------------- -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void faces_pop_front(); @@ -171,9 +160,7 @@ void faces_pop_back(); removes the face `f` if faces are supported. -Requirement --------------- -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void faces_erase( Face_handle f); @@ -181,9 +168,7 @@ void faces_erase( Face_handle f); removes the range `[first,last)` if faces are supported. -Requirement --------------- -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void faces_erase( Face_handle first, Face_handle last); @@ -196,9 +181,7 @@ creates isolated vertices they get removed as well. See `make_hole(h)` for a more specialized variant. \pre `h->is_border() == false`. -Requirement --------------- -If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void erase_face( Halfedge_handle h); @@ -206,9 +189,7 @@ void erase_face( Halfedge_handle h); removes the vertices, halfedges, and faces that belong to the connected component of `h`. \pre For all halfedges `g` in the connected component `g.next() != Halfedge_handle()`. -Requirement --------------- -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void erase_connected_component( Halfedge_handle h); @@ -217,9 +198,7 @@ Erases the small connected components and the isolated vertices. Keep `nb_components_to_keep` largest connected components. Returns the number of connected components erased (ignoring isolated vertices). -Requirement --------------- -supports vertices, halfedges, and removal operation. */ +\requires supports vertices, halfedges, and removal operation. */ unsigned int keep_largest_connected_components(unsigned int nb_components_to_keep); /// @} @@ -231,9 +210,7 @@ unsigned int keep_largest_connected_components(unsigned int nb_components_to_kee removes the face incident to `h` from `hds` and creates a hole. \pre `h != Halfedge_handle()` and `!(h->is_border())`. -Requirement --------------- -If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires If faces are supported, `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void make_hole( Halfedge_handle h); @@ -317,10 +294,7 @@ holes. Returns the predecessor of `h` around the face. The invariant the data structure unchanged. The time is proportional to the size of the face removed and the time to compute `h->prev()`. -Requirement --------------- - -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image latex euler_hds \image html euler_face.gif @@ -350,10 +324,7 @@ and keeps the polyhedron unchanged. The time is proportional to the degree of the vertex removed and the time to compute `h->prev()` and `h->opposite()->prev()`. -Requirement --------------- - -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_vertex.gif @@ -387,10 +358,7 @@ create_center_vertex(h))` holds if `h` is not a border halfedge. The time is proportional to the sum of the size of all incident faces. \pre None of the incident faces of `g->vertex()` is a hole. There are at least two distinct faces incident to the faces that are incident to `g->vertex()`. (This prevents the operation from collapsing a volume into two faces glued together with opposite orientations, such as would happen with any vertex of a tetrahedron.) -Requirement --------------- - -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image latex euler_center \image html euler_center.gif @@ -425,10 +393,7 @@ by `g` gets removed. Both faces may be holes. The invariant data structure unchanged. \pre The faces denoted by `h` and `g` are different and have equal degree (i.e., number of edges). -Requirement --------------- - -`Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. +\requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image latex euler_loop \image html euler_loop.gif diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h index 58d5fef40b9..bf528a93210 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h @@ -21,8 +21,7 @@ removal. \sa `CGAL::HalfedgeDS_decorator` \sa `CGAL::HalfedgeDS_const_decorator` -Implementation --------------- +### Implementation ### Currently, `HalfedgeDS_default` is derived from `CGAL::HalfedgeDS_list`. The copy constructor and the assignment operator need \f$ O(n)\f$ time with diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h index 0c140f91655..86e50da6c0a 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_2.h @@ -19,8 +19,7 @@ is the template argument of the corresponding `HalfedgeDS`. \sa `CGAL::HalfedgeDS_halfedge_base` \sa `CGAL::HalfedgeDS_face_base` -Example --------------- +### Example ### The following example shows the canonical implementation of the `HalfedgeDS_items_2` class. It uses the base classes for the item types that diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h index dcf8046d07a..7b75e33cada 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h @@ -26,8 +26,7 @@ all halfedge data structures and will not appear here again. \sa `CGAL::HalfedgeDS_decorator` \sa `CGAL::HalfedgeDS_const_decorator` -Example --------------- +### Example ### The following program fragment illustrates how a refined halfedge class for a polyhedron can make use of the `find_prev()` member diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h index 80ba1241772..3673f22ca4f 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h @@ -17,8 +17,7 @@ iterators that supports removal. \sa `CGAL::HalfedgeDS_decorator` \sa `CGAL::HalfedgeDS_const_decorator` -Implementation --------------- +### Implementation ### `HalfedgeDS_list` uses internally the `CGAL::In_place_list` container class. The copy constructor and the assignment operator need \f$ O(n)\f$ time with diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h index 62689e219af..218447ccf0a 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_min_items.h @@ -19,8 +19,7 @@ halfedges. \sa `CGAL::HalfedgeDS_halfedge_min_base` \sa `CGAL::HalfedgeDS_face_min_base` -Example --------------- +### Example ### The following example shows the canonical implementation of the `CGAL::HalfedgeDS_min_items` class. It uses the base classes for the diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h index 219dcedc02e..a1538c170fd 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h @@ -17,8 +17,7 @@ access iterators that does not support removal. \sa `CGAL::HalfedgeDS_decorator` \sa `CGAL::HalfedgeDS_const_decorator` -Implementation --------------- +### Implementation ### `HalfedgeDS_vector` uses internally the \stl `std::vector` container class. We require that we can create a `std::vector::iterator` diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h index 7e454ff2445..6dcc1ed42c4 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDS.h @@ -48,8 +48,7 @@ dangling handles), it must be called explicitly in advance for a Classes built on top of a `HalfedgeDS` are advised to call the `reserve()` member function before creating new items. -Parameters --------------- +### Parameters ### A `HalfedgeDS` is a class template and will be used as argument for other class templates, for example `CGAL::Polyhedron_3`. The diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h index ca486012e81..345461180c5 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h @@ -30,8 +30,7 @@ page \ref HalfedgeDSFace respectively. \sa `CGAL::HalfedgeDS_halfedge_base` \sa `CGAL::HalfedgeDS_face_base` -Example --------------- +### Example ### The following example shows the canonical implementation of the `CGAL::HalfedgeDS_min_items` class. It uses the base classes for the diff --git a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h index 9df06ddb2d2..c4cd3baa09c 100644 --- a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h +++ b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h @@ -13,8 +13,7 @@ whether the retrieval was successful. This class can be used to provide the values and gradients of the interpolation functions. -Parameters --------------- +### Parameters ### The class `Data_access` has the container type `Map` as template parameter. @@ -69,15 +68,13 @@ computed by Farin's interpolant \cite f-sodt-90. The function `farin_c1_interpolation` interpolates the function values and the gradients that are provided by functors using the method described in \cite f-sodt-90. -Parameters --------------- +### Parameters ### `RandomAccessIterator::value_type` is a pair associating a point to a (non-normalized) barycentric coordinate. See `CGALL::sibson_c1_interpolation` for the other parameters. -Requirements --------------- +### Requirements ### Same requirements as for `sibson_c1_interpolation` only the iterator must provide random access and `Traits::FT` does not need @@ -121,8 +118,7 @@ corresponding to each point of the point/coordinate pairs in the range \f$ \left[\right.\f$`first`, `beyond`\f$ \left.\right)\f$. \pre `norm` \f$ \neq0\f$. `function_value(p).second == true` for all points `p` of the point/coordinate pairs in the range \f$ \left[\right.\f$`first`, `beyond`\f$ \left.\right)\f$. -Requirements --------------- +### Requirements ###
                                        1. `ForwardIterator::value_type` is a pair of @@ -170,13 +166,11 @@ pairs in the range \f$ \left[\right.\f$ `first`, `beyond`\f$ \left.\right)\f$. See also `sibson_c1_interpolation`. \pre `norm` \f$ \neq0\f$ `function_value(p).second == true` for all points `p` of the point/coordinate pairs in the range \f$ \left[\right.\f$`first`, `beyond`\f$ \left.\right)\f$. -Parameters --------------- +### Parameters ### See `sibson_c1_interpolation`. -Requirements --------------- +### Requirements ### Same requirements as for `sibson_c1_interpolation` only that `Traits::FT` does not need @@ -221,8 +215,7 @@ interpolated function value as first and `true` as second value. \pre `p` of the point/coordinate pairs in the range \f$\left[\right.\f$`first`, `beyond`\f$ \left.\right)\f$. -Parameters --------------- +### Parameters ### The template parameter `Traits` is to be instantiated with a model of `InterpolationTraits`. @@ -235,8 +228,7 @@ coordinates for the query point `p`. The functor function given a point. `function_gradient` allows to access the function gradient given a point. -Requirements --------------- +### Requirements ###
                                          1. `Traits` is a model of the concept diff --git a/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h b/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h index fbc65a2979e..3acdcdc3cf1 100644 --- a/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h +++ b/Interpolation/doc/Interpolation/CGAL/natural_neighbor_coordinates_2.h @@ -9,8 +9,7 @@ called Sibson's coordinates, for \f$ 2D\f$ points provided a two-dimensional triangulation and a query point in the convex hull of the vertices of the triangulation. -Requirements --------------- +### Requirements ###
                                            1. `Dt` are equivalent to the class @@ -31,8 +30,7 @@ the traits class of the `polygon_area_2` function. associating a point and its natural neighbor coordinate.
                                            -Implementation --------------- +### Implementation ### This function computes the area of the sub-cells stolen from the Voronoi cells of the points in `dt` when inserting diff --git a/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h b/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h index ad8adff8967..3fadce12a5f 100644 --- a/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h +++ b/Interpolation/doc/Interpolation/CGAL/regular_neighbor_coordinates_2.h @@ -10,8 +10,7 @@ two-dimensional regular triangulation and a (weighted) query point inside the convex hull of the vertices of the triangulation. We call these coordinates regular neighbor coordinates. -Requirements --------------- +### Requirements ###
                                            1. `Rt` are equivalent to the class @@ -27,8 +26,7 @@ meet the requirements for the traits class of the associating a point and its regular neighbor coordinate.
                                            -Implementation --------------- +### Implementation ### This function computes the areas stolen from the Voronoi cells of points in `rt` by the insertion of `p`. The diff --git a/Interpolation/doc/Interpolation/CGAL/sibson_gradient_fitting.h b/Interpolation/doc/Interpolation/CGAL/sibson_gradient_fitting.h index 9ade096965b..8ed401cf168 100644 --- a/Interpolation/doc/Interpolation/CGAL/sibson_gradient_fitting.h +++ b/Interpolation/doc/Interpolation/CGAL/sibson_gradient_fitting.h @@ -12,8 +12,7 @@ gradient for all data points that lie inside the convex hull of the data points. One function exists for each type of natural neighbor coordinates. -Requirements --------------- +### Requirements ###
                                            1. `ForwardIterator::value_type` is a pair of point/coordinate @@ -39,8 +38,7 @@ provide a multiplication and addition operation with the type \sa CGAL::regular_neighbor_coordinates_2 \sa CGAL::surface_neighbor_coordinates_3 -Implementation --------------- +### Implementation ### This function implements Sibson's gradient estimation method based on natural neighbor coordinates diff --git a/Interpolation/doc/Interpolation/CGAL/surface_neighbor_coordinates_3.h b/Interpolation/doc/Interpolation/CGAL/surface_neighbor_coordinates_3.h index c1358185298..bceef663df6 100644 --- a/Interpolation/doc/Interpolation/CGAL/surface_neighbor_coordinates_3.h +++ b/Interpolation/doc/Interpolation/CGAL/surface_neighbor_coordinates_3.h @@ -24,8 +24,7 @@ the range \f$ \left[\right.\f$`first`, `beyond`\f$ k\f$-nearest neighbor or a range search query, this permits to check whether the neighborhood which has been considered is large enough. -Requirements --------------- +### Requirements ###
                                              1. `Dt` is equivalent to the class @@ -42,8 +41,7 @@ associating a point and its natural neighbor coordinate. \sa CGAL::Voronoi_intersection_2_traits_3 \sa CGAL::surface_neighbors_3 -Implementation --------------- +### Implementation ### This functions construct the regular triangulation of the input points instantiated with `Voronoi_intersection_2_traits_3` or `ITraits` if provided. diff --git a/Interpolation/doc/Interpolation/CGAL/surface_neighbors_3.h b/Interpolation/doc/Interpolation/CGAL/surface_neighbors_3.h index 937a5df6cb3..5b5445aa983 100644 --- a/Interpolation/doc/Interpolation/CGAL/surface_neighbors_3.h +++ b/Interpolation/doc/Interpolation/CGAL/surface_neighbors_3.h @@ -25,8 +25,7 @@ points are collected by a \f$ k\f$-nearest neighbor or a range search query, this permits to verify that a large enough neighborhood has been considered. -Requirements --------------- +### Requirements ###
                                                1. `Dt` is equivalent to the class @@ -39,8 +38,7 @@ Requirements \sa CGAL::Voronoi_intersection_2_traits_3 \sa CGAL::surface_neighbor_coordinates_3 -Implementation --------------- +### Implementation ### These functions compute the regular triangulation of the sample points and the point `p` using a traits class diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h index 0c45738f737..388c2558dc1 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h @@ -6,8 +6,7 @@ namespace CGAL { The class `Interval_skip_list` is a dynamic data structure that allows to find all members of a set of intervals that overlap a point. -Implementation --------------- +### Implementation ### The insertion and deletion of a segment in the interval skip list takes expected time \f$ O(\log^2 n)\f$, if the segment endpoints are diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h index 0e52ae45ddb..2ea3cfd6235 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h @@ -7,8 +7,7 @@ The class `Interval_skip_list_interval` represents intervals with lower and uppe bound of type `Value`. These intervals can be opened or closed at each endpoint. -I/O --------------- +### I/O ### The output operator is defined for `std::ostream`. diff --git a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h index 0e7d4c68ffe..dd6b6422021 100644 --- a/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h @@ -6,8 +6,7 @@ namespace CGAL { The class `Level_interval` represents intervals for the minimum and maximum value of the `z`-coordinate of a face of a triangulation. -Requirements --------------- +### Requirements ### The `value_type` of `FaceHandle` must be `Face`, which must have a nested type `Vertex`, which must have a nested type `Point`, diff --git a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h index fe24df90e93..b9e9761f66c 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/CGAL/Monge_via_jet_fitting.h @@ -16,8 +16,7 @@ The default for the template `LocalKernel` is `Cartesian` and the default for `SvdTraits` is `Eigen_svd` if `CGAL_EIGEN3_ENABLED` is defined and `Lapack_svd` otherwise. -Parameters --------------- +### Parameters ### The class `Monge_via_jet_fitting` has three template parameters. Parameter `DataKernel` provides the geometric classes and tools diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h index 7e92c69104e..117631d0322 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h @@ -8,8 +8,7 @@ fulfilled by any class used to instantiate first template parameter of the class `CGAL::Monge_via_jet_fitting`. -Operations --------------- +### Operations ### Only constructors (from 3 scalars and copy constructors) and access methods to coordinates `x()`, `y()`, `z()` are needed. diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h index 3881387d65e..5b294277fb7 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h @@ -12,8 +12,7 @@ This concept provides the geometric primitives used for the computations in the class `CGAL::Monge_via_jet_fitting`. -Requirements --------------- +### Requirements ### In the class `CGAL::Monge_via_jet_fitting` the scalar type, `LocalKernel::FT`, must be the same as that of the `SvdTraits` @@ -21,8 +20,7 @@ concept : `SvdTraits::FT`. The type `LocalKernel::FT` is a model of the FieldWithSqrt concept. -Operations --------------- +### Operations ### The scalar type `LocalKernel::FT` must be a field type with a square root. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_2.h b/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_2.h index 121b8862cd3..bec84a25580 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_2.h @@ -40,8 +40,7 @@ therefore do not appear in the constructors. \sa `Translation` \sa `rational_rotation_approximation` -Example --------------- +### Example ### \code typedef Cartesian K; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h b/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h index 74fb9100acc..e9355b60f66 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h @@ -16,8 +16,7 @@ the kernel is only an approximation of Euclidean geometry. \models ::Kernel -Implementation --------------- +### Implementation ### All geometric objects in `Cartesian` are reference counted. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h b/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h index 875ff53a070..7181cd97a44 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h @@ -17,8 +17,7 @@ provide `K2::FT operator()(K1::FT n)` that converts `n` to an The default value of this parameter is `CGAL::NT_converter`. -Example --------------- +### Example ### In the following example, we compute exactly the intersection point between a line and a triangle, diff --git a/Kernel_23/doc/Kernel_23/CGAL/Dimension.h b/Kernel_23/doc/Kernel_23/CGAL/Dimension.h index dd92d65edf0..425e110eb41 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Dimension.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Dimension.h @@ -10,13 +10,11 @@ namespace CGAL { The class `Ambient_dimension` allows to retrieve the dimension of the ambient space of a type `T` in a kernel `K`. -Parameters --------------- +### Parameters ### The parameter `K` has the default value `Kernel_traits::Kernel>`. -Example --------------- +### Example ### The following retrieves the dimension of a point type. @@ -69,8 +67,7 @@ for dispatching functions based on the dimension of an object, as provided by the `dim` parameter. It is useful in cases where it is not more practical to pass the dimension as a template parameter directly. -Example --------------- +### Example ### The following code declares two functions constructing two points at the origin, either in 2D or in 3D. @@ -111,8 +108,7 @@ for dispatching functions based on the dimension of an object. `Dynamic_dimension_tag` indicates that the dimension is not known at compile-time. `Dimension_tag` is the tag class dealing with compile-time dimensions. -Example --------------- +### Example ### The following code declares two functions constructing two points at the origin, either in 2D or in 3D. @@ -143,13 +139,11 @@ public: The class `Feature_dimension` allows to retrieve the geometric dimension of a type `T` in a kernel `K`. -Parameters --------------- +### Parameters ### The parameter `K` has the default value `Kernel_traits::Kernel`. -Example --------------- +### Example ### The following retrieves the dimension of a point type. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h b/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h index 084c26e1f31..bc64783ddb9 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h @@ -15,8 +15,7 @@ the global functions are those of `CK`. \models ::Kernel -Example --------------- +### Example ### The following example shows how to produce a kernel whose geometric objects and constructions are those of `Simple_cartesian` @@ -62,8 +61,7 @@ techniques from \cite cgal:mp-fcafg-05. The geometric constructions are exactly those of the kernel `CK`, which means that they are not necessarily exact. -Parameters --------------- +### Parameters ### The first parameter, `CK`, is the "Construction Kernel", namely the kernel from which are taken the types of the geometric objects as well as the @@ -77,8 +75,7 @@ production use for deactivating static filters. \models ::Kernel -Example --------------- +### Example ### The following example shows how to produce a kernel whose geometric objects and constructions are those of `Simple_cartesian` @@ -92,8 +89,7 @@ typedef CGAL::Simple_cartesian CK; typedef CGAL::Filtered_kernel K; \endcode -Implementation --------------- +### Implementation ### The implementation uses `CGAL::Filtered_predicate` over each predicate of the kernel traits interface. Additionally, faster static diff --git a/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h b/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h index 34f01bf7f40..bdf4fe946f4 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h @@ -18,8 +18,7 @@ To convert the geometric objects that are the arguments of the predicate, we use the function objects `C2E` and `C2F`, which must be of the form `Cartesian_converter` or `Homogeneous_converter`. -Example --------------- +### Example ### The following example defines an efficient and exact version of the orientation predicate over three points using the Cartesian representation diff --git a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h index f8f96bf3168..0b96f7cc057 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h @@ -16,8 +16,7 @@ the kernel is only an approximation of Euclidean geometry. \models ::Kernel -Implementation --------------- +### Implementation ### This model of a kernel uses reference counting. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Line_2.h b/Kernel_23/doc/Kernel_23/CGAL/Line_2.h index ea6293c5579..40432ed8658 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Line_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Line_2.h @@ -17,8 +17,7 @@ on the negative side of `l`, iff \f$ a\, px + b\, py +c < 0\f$. The positive side is to the left of `l`. -Example --------------- +### Example ### Let us first define two %Cartesian two-dimensional points in the Euclidean plane \f$ \E^2\f$. Their diff --git a/Kernel_23/doc/Kernel_23/CGAL/Origin.h b/Kernel_23/doc/Kernel_23/CGAL/Origin.h index 41e9787bfaf..3df69da1f75 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Origin.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Origin.h @@ -47,8 +47,7 @@ public: A symbolic constant which denotes the point at the origin. This constant is used in the conversion between points and vectors. -Example --------------- +### Example ### \code Point_2< Cartesian > p(1.0, 1.0), q; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Point_2.h b/Kernel_23/doc/Kernel_23/CGAL/Point_2.h index d7b1b53a6dd..b89e810054c 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Point_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Point_2.h @@ -13,13 +13,11 @@ kernel model `Homogeneous`, `Kernel::RT` is equal to `T`, and `Kernel::FT` is equal to `Quotient`. -Operators --------------- +### Operators ### The following operations can be applied on points: -Example --------------- +### Example ### The following declaration creates two points with %Cartesian double coordinates. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Point_3.h b/Kernel_23/doc/Kernel_23/CGAL/Point_3.h index 7677a840c76..e455ba7a1d3 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Point_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Point_3.h @@ -13,8 +13,7 @@ kernel model `Homogeneous`, `Kernel::RT` is equal to `T`, and `Kernel::FT` is equal to `Quotient`. -Operators --------------- +### Operators ### The following operations can be applied on points: diff --git a/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h b/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h index 2e84a666c43..866b18ab072 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Projection_traits_xy_3.h @@ -13,8 +13,7 @@ deal with projections on the `zx`- and the `zy`-plane, respectively. -Parameters --------------- +### Parameters ### The template parameter `K` has to be instantiated by a model of the `Kernel` concept. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h b/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h index 9e6ffce42b0..9a382af7c9f 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h @@ -16,8 +16,7 @@ the kernel is only an approximation of Euclidean geometry. \models ::Kernel -Implementation --------------- +### Implementation ### In contrast to `Cartesian`, no reference counting is used internally. This eases debugging, but may slow down algorithms diff --git a/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h b/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h index 46abc5cebbe..eee0679f863 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h @@ -16,8 +16,7 @@ the kernel is only an approximation of Euclidean geometry. \models ::Kernel -Implementation --------------- +### Implementation ### In contrast to `Homogeneous`, no reference counting is used internally. This eases debugging, but may slow down algorithms diff --git a/Kernel_23/doc/Kernel_23/CGAL/enum.h b/Kernel_23/doc/Kernel_23/CGAL/enum.h index 35131c1a2e2..97f2185b5de 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/enum.h +++ b/Kernel_23/doc/Kernel_23/CGAL/enum.h @@ -139,8 +139,7 @@ const Null_vector NULL_VECTOR; A symbolic constant which denotes the point at the origin. This constant is used in the conversion between points and vectors. -Example --------------- +### Example ### \code Point_2< Cartesian > p(1.0, 1.0), q; diff --git a/Kernel_23/doc/Kernel_23/CGAL/intersections.h b/Kernel_23/doc/Kernel_23/CGAL/intersections.h index dc04379790e..2c1a7a5bb2c 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/intersections.h +++ b/Kernel_23/doc/Kernel_23/CGAL/intersections.h @@ -138,8 +138,7 @@ global function are available. \brief -Example --------------- +### Example ### The following example demonstrates the most common use of `intersection` routines with the 2D and 3D Linear %Kernel. diff --git a/Kernel_23/doc/Kernel_23/CGAL/rational_rotation.h b/Kernel_23/doc/Kernel_23/CGAL/rational_rotation.h index 7d9805bd8f5..2073a10f49c 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/rational_rotation.h +++ b/Kernel_23/doc/Kernel_23/CGAL/rational_rotation.h @@ -14,8 +14,7 @@ that `sin_num`/`denom` approximates the sine of direction the approximating rational is bounded by `eps_num`/`eps_den`. \pre `eps_num` \f$ \neq0\f$. -Implementation --------------- +### Implementation ### The approximation is based on Farey sequences as described in the rational rotation method presented by Canny and Ressler at the diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h index c539590ed78..5d4da558fc7 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_face_base_2.h @@ -15,15 +15,12 @@ specific application. -Parameters --------------- - -
                                                    -
                                                  • The first parameter `Traits` is the geometric traits class. It must +\tparam Traits is the geometric traits class. It must be the same as the one used for the Delaunay mesh. -
                                                  • The second parameter `Fb` is the base class from which `Delaunay_mesh_face_base_2` + +\tparam Fb is the base class from which `Delaunay_mesh_face_base_2` derives. It must be a model of the `TriangulationFaceBase_2` concept. -
                                                  + \models ::DelaunayMeshFaceBase_2 diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h index 7e1f3976f14..65cb42caa41 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h @@ -8,24 +8,18 @@ namespace CGAL { This class implements a 2D mesh generator. - -Parameters --------------- - -The template parameter `CDT` should be a model of the +\tparam CDT must be a model of the concept `ConstrainedDelaunayTriangulation_2`, and type `CDT::Face` should be a model of the concept `MeshFaceBase_2`. - The geometric traits class of the instance of `CDT` has to be a model of the concept `DelaunayMeshTraits_2`. -The template parameter `Criteria` should be a model of the concept +\tparam Criteria must be a model of the concept `MeshingCriteria_2`. This traits class defines the shape and size criteria for the triangles of the mesh. `Criteria::Face_handle` has to be the same as `CDT::Face_handle`. -Using this class --------------- +### Using This Class ### The constructor of the class `Delaunay_mesher_2` takes a reference to a `CDT` as an argument. A call to the refinement method `refine_mesh()` will @@ -36,8 +30,7 @@ modified, any further call to its member methods may crash. Consider constructing a new `Delaunay_mesher_2` object if the triangulation has been modified. -Meshing domain --------------- +### Meshing Domain ### The domain to be mesh is defined by the constrained edges and a set of seed points. The constrained edges divides the plane into several connected diff --git a/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h b/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h index 22ce03bb9e5..9669658651b 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h @@ -8,8 +8,9 @@ namespace CGAL { Refines the constrained Delaunay triangulation `t` into a conforming Delaunay triangulation. After a call to this function, all edges of `t` are Delaunay edges. -\requires The template parameter `CDT` should be a model of the concept `ConstrainedDelaunayTriangulation_2`. -\requires The geometric traits class of into the constrained Delaunay triangulation must be a model of `ConformingDelaunayTriangulationTraits_2`. + +\tparam CDT must be a model of the concept `ConstrainedDelaunayTriangulation_2`. +The geometric traits class of into the constrained Delaunay triangulation must be a model of `ConformingDelaunayTriangulationTraits_2`. */ template void make_conforming_Delaunay_2 (CDT &t); @@ -27,8 +28,8 @@ conforming Gabriel triangulation. After a call to this function, all constrained edges of `t` have the Gabriel property: the circle that has \f$ e\f$ as diameter does not contain any vertex from the triangulation. -\requires The template parameter `CDT` should be a model of the concept `ConstrainedDelaunayTriangulation_2`. -\requires The geometric traits class of the constrained Delaunay triangulation must be a model of `ConformingDelaunayTriangulationTraits_2`. + +\tparam CDT must be a model of the concept `ConstrainedDelaunayTriangulation_2`. The geometric traits class of the constrained Delaunay triangulation must be a model of `ConformingDelaunayTriangulationTraits_2`. */ template void make_conforming_Gabriel_2 (CDT &t); @@ -49,18 +50,11 @@ functions `make_conforming_Gabriel_2` and `make_conforming_Delaunay_2`. - -Parameters --------------- - -The template parameter `CDT` should be a model of the concept -`ConstrainedDelaunayTriangulation_2`. - -The geometric traits class of the instance of `CDT` has to be +\tparam CDT must be a model of the concept +`ConstrainedDelaunayTriangulation_2`. The geometric traits class of the instance of `CDT` has to be a model of the concept `ConformingDelaunayTriangulationTraits_2`. -Using this class --------------- +### Using This Class ### The constructor of the class `Triangulation_conformer_2` takes a reference to a `CDT` as an argument. A call to the method `make_conforming_Delaunay()` or diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h index 04a2d1614d7..5bc5689226a 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_constant_domain_field_3.h @@ -10,9 +10,6 @@ The class `Mesh_constant_domain_field_3` can also be customized through `set_siz a piecewise constant field, i.e. a sizing field with a constant size on each subpart of the domain. -Parameters --------------- - \tparam Gt is the geometric traits class. It must match the type `Triangulation::Geom_traits`, where `Triangulation` is the nested type of the model of `MeshComplex_3InTriangulation_3` used in the meshing process. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h index 0f271eae2a4..69368d259a2 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h @@ -21,8 +21,7 @@ and `C3T3::Triangulation` its nested triangulation type. \models ::MeshCriteria_3 -Example --------------- +### Example ### \code{.cpp} diff --git a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h index 97dfcf93d9d..8c57c8b761e 100644 --- a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h +++ b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h @@ -14,8 +14,7 @@ return a unique address. \sa `CGAL::Unique_hash_map` -Implementation --------------- +### Implementation ### Plain type cast of `&*key` to `std::size_t` and devided by the size of the `std::iterator_traits::value_type` to @@ -45,8 +44,7 @@ Handle_hash_function(); returns unique hash value for any `Handle` type for which `&*key` gives a unique address. -Requirement --------------- +### Requirement ### The type `std::iterator_traits::value_type` has to be defined diff --git a/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h b/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h index 9ed74637139..08b431bb438 100644 --- a/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h +++ b/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h @@ -9,8 +9,7 @@ Both the virtual memory size and the resident size are available (the resident size does not account for swapped out memory nor for the memory which is not yet paged-in). -Implementation --------------- +### Implementation ### Accessing this information requires the use of non-portable code. Currently, there is support for Linux platforms, the Microsoft and Intel diff --git a/Miscellany/doc/Miscellany/CGAL/Modifier_base.h b/Miscellany/doc/Miscellany/CGAL/Modifier_base.h index 66e40398aa0..7e0026325da 100644 --- a/Miscellany/doc/Miscellany/CGAL/Modifier_base.h +++ b/Miscellany/doc/Miscellany/CGAL/Modifier_base.h @@ -13,8 +13,7 @@ function `operator()`, which accepts a single reference parameter `R&` on which the modifier is allowed to work. `R` is the type of the internal representation that is to be modified. -Example --------------- +### Example ### The following fragment defines a class A with an internal representation i of type int. It provides a member diff --git a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h index 17180e9ad5a..01d5791df1a 100644 --- a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h +++ b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h @@ -13,8 +13,7 @@ string passed to the constructor. The macro ::CGAL_PROFILER can be used to conveniently place these counters anywhere. They are disabled by default and activated by the global macro ::CGAL_PROFILE. -Operations --------------- +### Operations ### If `CGAL_PROFILE` is not defined, then `CGAL_PROFILER` is defined to an empty statement. Otherwise, it is defined to diff --git a/Miscellany/doc/Miscellany/CGAL/Real_timer.h b/Miscellany/doc/Miscellany/CGAL/Real_timer.h index 75a901437da..402a8e70de5 100644 --- a/Miscellany/doc/Miscellany/CGAL/Real_timer.h +++ b/Miscellany/doc/Miscellany/CGAL/Real_timer.h @@ -15,8 +15,7 @@ counts the number of calls of the `Real_timer::start()` member function since th last reset. If the reset occures while the timer is running it counts as the first interval. -Implementation --------------- +### Implementation ### The timer class is based in the C function `gettimeofday()` on POSIX systems and the C function `_ftime()` on MS Visual C++. diff --git a/Miscellany/doc/Miscellany/CGAL/Timer.h b/Miscellany/doc/Miscellany/CGAL/Timer.h index 3b40379c290..7e5392f437f 100644 --- a/Miscellany/doc/Miscellany/CGAL/Timer.h +++ b/Miscellany/doc/Miscellany/CGAL/Timer.h @@ -15,8 +15,7 @@ counts the number of calls of the `Timer::start()` member function since the last reset. If the reset occures while the timer is running it counts as the first interval. -Implementation --------------- +### Implementation ### The timer class is based in the C function `std::clock()` on PC systems and the C function `getrusage()` on standard diff --git a/Miscellany/doc/Miscellany/CGAL/Union_find.h b/Miscellany/doc/Miscellany/CGAL/Union_find.h index 4d1d5eccecf..2408aa55900 100644 --- a/Miscellany/doc/Miscellany/CGAL/Union_find.h +++ b/Miscellany/doc/Miscellany/CGAL/Union_find.h @@ -9,8 +9,7 @@ partition of values of type `T` into disjoint sets. The template parameter `A` has to be a model of the allocator concept as defined in the C++ standard. It has a default argument `CGAL_ALLOCATOR(T)`. -Implementation --------------- +### Implementation ### `Union_find` is implemented with union by rank and path compression. The running time for \f$ m\f$ set operations on \f$ n\f$ elements diff --git a/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h b/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h index 465100282e6..4cb72d625c2 100644 --- a/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h +++ b/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h @@ -21,8 +21,7 @@ of type `Data` specified in the definition of `map`. \sa `UniqueHashFunction` \sa `CGAL::Handle_hash_function` -Implementation --------------- +### Implementation ### `Unique_hash_map` is implemented via a chained hashing scheme. Access operations `map``[i]` take expected time \f$ O(1)\f$. The `table_size` diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h index b7a79e13cb6..324b7367d75 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h @@ -10,15 +10,13 @@ representation based on a field number type `FT`. \models ::ExtendedKernelTraits_2 -Requirements --------------- +### Requirements ### To make a field number type `FT_model` work with this class, you must provide a traits class for this number type: `CGAL::Number_type_traits` (See the support library manual.) -Operations --------------- +### Operations ### Fits all operation requirements of the concept. diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h index 09bf0a55463..21eb3a4d95f 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h @@ -10,8 +10,7 @@ representation based on a Euclidean ring number type `RT`. \models ::ExtendedKernelTraits_2 -Requirements --------------- +### Requirements ### To make an Euclidean ring number type `RT_model` work with this class the number type must support @@ -21,8 +20,7 @@ your number type is not one of the built-in number types, one of the number types distrubuted with \cgal or one of the \leda number types. -Operations --------------- +### Operations ### Fits all operation requirements of the concept. diff --git a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h index 8f80ede048c..88c12620533 100644 --- a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h @@ -10,8 +10,7 @@ representation based on a ring number type `RT`. \models ::ExtendedKernelTraits_2 -Operations --------------- +### Operations ### Fits all operation requirements of the concept. diff --git a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h index fdbf772abdf..2212fd12272 100644 --- a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h +++ b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h @@ -16,8 +16,7 @@ The template parameter `T` is specified via an extended kernel concept. `T` must be a model of the concept `ExtendedKernelTraits_2`. -Exploration - Point location - Ray shooting --------------- +### Exploration - Point location - Ray shooting ### As Nef polyhedra are the result of forming complements and intersections starting from a set `H` of halfspaces that are @@ -26,8 +25,7 @@ an attributed plane map \f$ M = (V,E,F)\f$. For topological queries within `M` the following types and operations allow exploration access to this structure. -Implementation --------------- +### Implementation ### Nef polyhedra are implemented on top of a halfedge data structure and use linear space in the number of vertices, edges and facets. @@ -58,8 +56,7 @@ the minimum weight triangulation is conjectured to be NP hard). Thus we have no runtime guarantee but a strong experimental motivation for its approximation. -Example --------------- +### Example ### Nef polyhedra are parameterized by a so-called extended geometric kernel. There are three kernels, one based on a homogeneous @@ -702,8 +699,7 @@ topologically closed by the frame edges. No standard point can be placed outside the frame. -Creation --------------- +### Creation ### `Explorer` is copy constructable and assignable. An object can be obtained via the `Nef_polyhedron_2::explorer()` method of diff --git a/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h b/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h index 418da481a8f..78293321e95 100644 --- a/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h +++ b/Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h @@ -14,15 +14,13 @@ In addition to the functions inherited from the Qt class `OGLWidget` via, constructor. For the usage of `Qt_widget_Nef_3` see the example below. -Parameters --------------- +### Parameters ### The template parameter expects an instantiation of `Nef_polyhedron_3`. \sa `CGAL::Nef_polyhedron_3` -Example --------------- +### Example ### This example reads a 3D Nef polyhedron from standard input and displays it in a Qt widget. diff --git a/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h b/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h index d725ba11cab..d48ce95ee38 100644 --- a/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h +++ b/Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h @@ -13,26 +13,11 @@ three-dimensional space is helpful. To allow saving memory space, the sorting is left to the user. This way the user can generate the polyhedra in a sorted way and add them one by one to `Nef_nary_union_3`. -Parameters --------------- -
                                                  -`template <` - -`class Nef_polyhedron_3,` -
                                                  -`class Nef_nary_union_3;` +\tparam NefPolyhedron_3 must be an instantiation of the class template `Nef_polyhedron_3`. -
                                                  -As a template parameter an instantiation of the template class Nef -polyhedra is needed. - -Member Functions --------------- - -`CGAL::Nef_polyhedron_3` */ template< typename Nef_polyhedron_3 > @@ -45,7 +30,7 @@ public: /*! initialization only. */ -Nef_nary_union_3(); +Nef_nary_union_3(); /// @} @@ -55,12 +40,12 @@ Nef_nary_union_3(); /*! returns the union of the polyhedra previously added to the class. */ -Nef_polyhedron_3 get_union() const; +NefPolyhedron_3 get_union() const; /*! adds a polyhedron. */ -void add_polyhedron(const Nef_polyhedron_3& N); +void add_polyhedron(const NefPolyhedron_3& N); /// @} diff --git a/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h b/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h index 9054f793d14..1cc3b38cae2 100644 --- a/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h +++ b/Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h @@ -15,15 +15,13 @@ In addition to the functions inherited from the Qt class `QGLWidget`, constructor. For the usage of `Qt_widget_Nef_S2` see the example below. -Parameters --------------- +### Parameters ### The template parameter expects an instantiation of `Nef_polyhedron_S2`. \sa `CGAL::Nef_polyhedron_S2` -Example --------------- +### Example ### This example creates some random `Sphere_segments` and distributes them on two `Nef_polyhedron_2`. The two Nef polyhedra are combined by a symmetric diff --git a/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h b/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h index a55658f6dad..96fe0b85fc8 100644 --- a/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h +++ b/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h @@ -13,8 +13,7 @@ operations `intersection`, `union`, `difference`, `complement` and under the topological operations `boundary`, `closure`, and `interior`. -Parameters --------------- +### Parameters ### \code template< class Nef_polyhedronTraits_S2, @@ -35,8 +34,7 @@ Neither `Nef_polyhedronItems_S2` nor `Nef_polyhedronMarks` is specifed, yet. Do not use other than the default types for these two template parameters. -Exploration - Point location - Ray shooting --------------- +### Exploration - Point location - Ray shooting ### As Nef polyhedra are the result of forming complements and intersections @@ -46,15 +44,13 @@ plane map \f$ M = (V,E,F)\f$. For topological queries within `M` the following types and operations allow exploration access to this structure. -Input and Output --------------- +### Input and Output ### A Nef polyhedron `N` can be visualized in an open GL window. The output operator is defined in the file `CGAL/IO/Nef_-poly-hedron_2_-Win-dow_-stream.h`. -Implementation --------------- +### Implementation ### Nef polyhedra are implemented on top of a halfedge data structure and use linear space in the number of vertices, edges and facets. @@ -183,8 +179,7 @@ surface of a unit sphere. Such points correspond to the nontrivial directions in space and similarly to the equivalence classes of all nontrivial vectors under normalization. -Operations --------------- +### Operations ### Access to the coordinates is provided by the following operations. Note that the vector \f$ (x,y,z)\f$ is not normalized. @@ -485,8 +480,7 @@ Additionally, `Nef_polyhedron_S2` provides the macro `SFace_cycle_const_iterator` and represent either a shalfedge, a shalfloop, or a svertex. -Creation --------------- +### Creation ### There is no need for a user to create a `SFace` explicitly. The class `Nef_polyhedron_S2` manages the needed sfaces internally. @@ -587,8 +581,7 @@ used as a shortcut. A const circulator is provided for each of the two circular orders. The circulators are bidirectional and assignable to `SHalfedge_const_handle`. -Creation --------------- +### Creation ### There is no need for a user to create a `SHalfedge` explicitly. The class `Nef_polyhedron_S2` manages the needed shalfedges internally. @@ -717,8 +710,7 @@ depicts the relationship between a shalfloop and sfaces on a sphere map. \anchor figureNefS2SHalfloopIncidences \image html shalfloopB.gif "Incidences of an SHalfloop " -Creation --------------- +### Creation ### There is no need for a user to create a `SHalfloop` explicitly. The class `Nef_polyhedron_S2` manages the needed shalfloops internally. @@ -793,8 +785,7 @@ The member function `out_sedge` returns the first outgoing shalfedge, and `incident_sface` returns the incident sface. -Creation --------------- +### Creation ### There is no need for a user to create a `SVertex` explicitly. The class `Nef_polyhedron_S2` manages the needed svertices internally. diff --git a/Number_types/doc/Number_types/CGAL/FPU.h b/Number_types/doc/Number_types/CGAL/FPU.h index 4b904cc3f73..82ad12ec792 100644 --- a/Number_types/doc/Number_types/CGAL/FPU.h +++ b/Number_types/doc/Number_types/CGAL/FPU.h @@ -48,8 +48,7 @@ rounding mode restoration when the `Protect_FPU_rounding` object is destroyed. Therefore, for this configuration, some explicit code has to be added. -Parameters --------------- +### Parameters ### The template parameter `Protected` is a Boolean parameter, which defaults to `true`. It follows the same parameter of the `Interval_nt` class. diff --git a/Number_types/doc/Number_types/CGAL/Gmpfi.h b/Number_types/doc/Number_types/CGAL/Gmpfi.h index 04f100a9be5..d4a78dec6c4 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpfi.h +++ b/Number_types/doc/Number_types/CGAL/Gmpfi.h @@ -21,8 +21,7 @@ and long double. \models ::FieldWithKthRoot \models ::RealEmbeddable -Implementation --------------- +### Implementation ### All interval operations are performed by the Mpfi library. The class `Gmpfi` is not reference counted, but its members are. diff --git a/Number_types/doc/Number_types/CGAL/Gmpfr.h b/Number_types/doc/Number_types/CGAL/Gmpfr.h index 1d1a2e30374..41a0a6ce52d 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpfr.h +++ b/Number_types/doc/Number_types/CGAL/Gmpfr.h @@ -26,8 +26,7 @@ This type is `ImplicitInteroperable` with `Gmpz`, long, \models ::FieldWithKthRoot \models ::RealEmbeddable -Comparisons --------------- +### Comparisons ### Comparison operators `==`, `!=`, `>`, `<`, `>=` and `<=` are also overloaded. A `Gmpfr` can @@ -37,8 +36,7 @@ be compared with other `Gmpfr`, as well as with a `Gmpz`, converted nor rounded before comparison. In the case where one of the compared numbers is `NaN`, the `erange` flag is set. -Implementation --------------- +### Implementation ### Since the Mpfr library can be compiled to be thread-safe, this interface is designed to keep the thread-safety. diff --git a/Number_types/doc/Number_types/CGAL/Gmpq.h b/Number_types/doc/Number_types/CGAL/Gmpq.h index d53c1bdbb62..8a9b48d36b6 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpq.h +++ b/Number_types/doc/Number_types/CGAL/Gmpq.h @@ -11,8 +11,7 @@ number based on the Gnu Multiple Precision Arithmeti \models ::RealEmbeddable \models ::Fraction -Implementation --------------- +### Implementation ### `Gmpq`s are reference counted. diff --git a/Number_types/doc/Number_types/CGAL/Gmpzf.h b/Number_types/doc/Number_types/CGAL/Gmpzf.h index 54ae3237b41..c1c4f1c4f28 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpzf.h +++ b/Number_types/doc/Number_types/CGAL/Gmpzf.h @@ -14,8 +14,7 @@ functionality very similar to `MP_Float` but is generally faster. \models ::EuclideanRing \models ::RealEmbeddable -Implementation --------------- +### Implementation ### The significand \f$ m\f$ of a `Gmpzf` is a `Gmpz` and is reference counted. The exponent \f$ e\f$ of a `Gmpzf` is a long. diff --git a/Number_types/doc/Number_types/CGAL/Interval_nt.h b/Number_types/doc/Number_types/CGAL/Interval_nt.h index 84c790c1464..e31e3165a52 100644 --- a/Number_types/doc/Number_types/CGAL/Interval_nt.h +++ b/Number_types/doc/Number_types/CGAL/Interval_nt.h @@ -33,8 +33,7 @@ real, \f$ X\f$ and \f$ Y\f$ are intervals, \f$ \mathcal{OP}\f$ is an arithmetic For example, if the final result of a sequence of arithmetic operations is an interval that does not contain zero, then you can safely determine its sign. -Parameters --------------- +### Parameters ### The template parameter `Protected` is a Boolean parameter, which defaults to `true`. It provides a way to select faster computations by avoiding @@ -48,8 +47,7 @@ doing any computations with the interval class. He can do so using the \models ::FieldWithSqrt \models ::RealEmbeddable -Example --------------- +### Example ### Protecting an area of code that uses operations on the class `Interval_nt_advanced` can be done in the following way: diff --git a/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h b/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h index 03a0e00e462..169d02e3566 100644 --- a/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h +++ b/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h @@ -23,8 +23,7 @@ using `Filtered_predicate` and `Filtered_kernel`. \models ::RealEmbeddable \models ::Fraction, if NT is a ::Fraction -Example --------------- +### Example ### \code #include diff --git a/Number_types/doc/Number_types/CGAL/MP_Float.h b/Number_types/doc/Number_types/CGAL/MP_Float.h index 814a63678e6..192da8f7d1b 100644 --- a/Number_types/doc/Number_types/CGAL/MP_Float.h +++ b/Number_types/doc/Number_types/CGAL/MP_Float.h @@ -21,8 +21,7 @@ plan to also have a multiprecision exponent to fix this issue. \models `EuclideanRing` \models ::RealEmbeddable -Implementation --------------- +### Implementation ### The implementation of `MP_Float` is simple but provides a quadratic complexity for multiplications. This can be a problem for large operands. diff --git a/Number_types/doc/Number_types/CGAL/Number_type_checker.h b/Number_types/doc/Number_types/CGAL/Number_type_checker.h index 3678c5290ef..f1d07fc27c5 100644 --- a/Number_types/doc/Number_types/CGAL/Number_type_checker.h +++ b/Number_types/doc/Number_types/CGAL/Number_type_checker.h @@ -11,8 +11,7 @@ the instances after each modification, as well as for each comparison. This is a debugging tool which is useful when dealing with number types. -Parameters --------------- +### Parameters ### `NT1` must be a model of some algebraic structure concept. `NT2` must be a model of the same algebraic structure concept. @@ -25,8 +24,7 @@ the two arguments. \models `IntegralDomainWithoutDivision` (same as `NT1`) \models ::RealEmbeddable -Operations --------------- +### Operations ### Some operations have a particular behavior documented here. diff --git a/Number_types/doc/Number_types/CGAL/Quotient.h b/Number_types/doc/Number_types/CGAL/Quotient.h index c7fbdd0b756..da257ebf5a0 100644 --- a/Number_types/doc/Number_types/CGAL/Quotient.h +++ b/Number_types/doc/Number_types/CGAL/Quotient.h @@ -21,8 +21,7 @@ A `Quotient` `q` is represented as a pair of \models ::RealEmbeddable \models ::Fraction -Operations --------------- +### Operations ### There are two access functions, namely to the numerator and the denominator of a quotient. diff --git a/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h b/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h index 1db043c6b64..2d593030276 100644 --- a/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h +++ b/Number_types/doc/Number_types/CGAL/simplest_rational_in_interval.h @@ -9,8 +9,7 @@ interval `[d1,d2]`. The function `simplest_rational_in_interval` computes the simplest rational number in an interval of two `double` values. -Implementation --------------- +### Implementation ### See Knuth, "Seminumerical algorithms", page 654, answer to exercise 4.53-39. diff --git a/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h b/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h index 6047d1d05be..da15b96264b 100644 --- a/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h +++ b/Partition_2/doc/Partition_2/CGAL/Partition_is_valid_traits_2.h @@ -14,8 +14,7 @@ in terms of a supplied template parameter. \sa `CGAL::Is_y_monotone_2` \sa `CGAL::Partition_traits_2` -Example --------------- +### Example ### See the example presented with the function `optimal_convex_partition_2` for an illustration of the use of this traits class. diff --git a/Partition_2/doc/Partition_2/CGAL/partition_2.h b/Partition_2/doc/Partition_2/CGAL/partition_2.h index 27971dfbef6..2e4836521c7 100644 --- a/Partition_2/doc/Partition_2/CGAL/partition_2.h +++ b/Partition_2/doc/Partition_2/CGAL/partition_2.h @@ -15,8 +15,7 @@ no more than four times the minimal number. \pre The points in the range [`first`, `beyond`) define a simple counterclockwise-oriented polygon. -Requirements --------------- +### Requirements ###
                                                  1. `Traits` is a model of the concept @@ -42,8 +41,7 @@ with the representation type determined by `InputIterator1::value_type`. \sa `CGAL::Partition_is_valid_traits_2` \sa `CGAL::y_monotone_partition_2` -Implementation --------------- +### Implementation ### This function implements the algorithm of Hertel and Mehlhorn \cite hm-ftsp-83 and is based on the class @@ -51,8 +49,7 @@ This function implements the algorithm of Hertel and Mehlhorn the polygon, the function requires \f$ O(n)\f$ time and space for a polygon with \f$ n\f$ vertices. -Example --------------- +### Example ### The following program computes an approximately optimal convex partitioning of a polygon using the default @@ -88,8 +85,7 @@ the resulting sequence of polygons is returned. \pre The points in the range [`first`, `beyond`) define a simple, counterclockwise-oriented polygon. -Requirements --------------- +### Requirements ###
                                                    1. `Traits` is a model of the concepts `PartitionTraits_2` @@ -118,8 +114,7 @@ with the representation type determined by `InputIterator::value_type`. \sa `CGAL::partition_is_valid_2` \sa `CGAL::y_monotone_partition_2` -Implementation --------------- +### Implementation ### This function implements the approximation algorithm of Greene \cite g-dpcp-83 and requires \f$ O(n \log n)\f$ time and \f$ O(n)\f$ space @@ -127,8 +122,7 @@ to produce a convex partitioning given a \f$ y\f$-monotone partitioning of a polygon with \f$ n\f$ vertices. The function `y_monotone_partition_2` is used to produce the monotone partition. -Example --------------- +### Example ### The following program computes an approximately optimal convex partitioning of a polygon using the default @@ -164,8 +158,7 @@ the resulting sequence of polygons is returned. \pre The points in the range [`first`, `beyond`) define a simple, counterclockwise-oriented polygon. -Requirements --------------- +### Requirements ###
                                                      1. `Traits` is a model of the concept `OptimalConvexPartitionTraits_2`. @@ -189,15 +182,13 @@ with the representation type determined by `InputIterator::value_type`. \sa `CGAL::partition_is_valid_2` \sa `CGAL::Partition_is_valid_traits_2` -Implementation --------------- +### Implementation ### This function implements the dynamic programming algorithm of Greene \cite g-dpcp-83, which requires \f$ O(n^4)\f$ time and \f$ O(n^3)\f$ space to produce a partitioning of a polygon with \f$ n\f$ vertices. -Example --------------- +### Example ### The following program computes an optimal convex partitioning of a polygon using the default @@ -238,8 +229,7 @@ the resulting sequence of polygons is returned. \pre The points in the range [`first`, `beyond`) define a simple, counterclockwise-oriented polygon. -Requirements --------------- +### Requirements ###
                                                        1. `Traits` is a model of the concept @@ -263,15 +253,13 @@ with the representation type determined by `InputIterator::value_type`. \sa `CGAL::partition_is_valid_2` \sa `CGAL::y_monotone_partition_is_valid_2` -Implementation --------------- +### Implementation ### This function implements the algorithm presented by de Berg et al. \cite bkos-cgaa-97 which requires \f$ O(n \log n)\f$ time and \f$ O(n)\f$ space for a polygon with \f$ n\f$ vertices. -Example --------------- +### Example ### The following program computes a \f$ y\f$-monotone partitioning of a polygon using the default diff --git a/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h b/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h index 5f622b0f914..a63bb97104b 100644 --- a/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h +++ b/Partition_2/doc/Partition_2/CGAL/partition_is_valid_2.h @@ -37,8 +37,7 @@ with the representation type determined by `InputIterator::value_type`. \sa `CGAL::partition_is_valid_2` \sa `CGAL::is_convex_2` -Implementation --------------- +### Implementation ### This function calls `::partition_is_valid_2` using the function object `Is_convex_2` to determine the convexity of each partition polygon. @@ -46,8 +45,7 @@ Thus the time required by this function is \f$ O(n \log n + e \log e)\f$ where \f$ n\f$ is the total number of vertices in the partition polygons and \f$ e\f$ the total number of edges. -Example --------------- +### Example ### See the example presented with the function `approx_convex_partition_2` for an illustration of the use of this function. @@ -103,16 +101,14 @@ with the representation type determined by `InputIterator::value_type`. \sa `CGAL::y_monotone_partition_2` \sa `CGAL::is_convex_2` -Implementation --------------- +### Implementation ### This function requires \f$ O(n \log n + e \log e + \Sigma_{i=1}^p m_i)\f$ where \f$ n\f$ is the total number of vertices of the \f$ p\f$ partition polygons, \f$ e\f$ is the total number of edges of the partition polygons and \f$ m_i\f$ is the time required by `Traits::Is_valid()` to test if partition polygon \f$ p_i\f$ is valid. -Example --------------- +### Example ### See the example presented with the function `optimal_convex_partition_2` for an illustration of the use of this function. @@ -162,8 +158,7 @@ with the representation type determined by `InputIterator::value_type`. \sa `CGAL::partition_is_valid_2` \sa `CGAL::Partition_is_valid_traits_2` -Implementation --------------- +### Implementation ### This function uses the function `::partition_is_valid_2` together with the function object `Is_y_monotone_2` to determine if each polygon @@ -171,8 +166,7 @@ is \f$ y\f$-monotone or not. Thus the time required is \f$ O(n \log n + e \log e where \f$ n\f$ is the total number of vertices of the partition polygons and \f$ e\f$ is the total number of edges. -Example --------------- +### Example ### See the example presented with the function `y_monotone_partition_2` for an illustration of the use of this function. diff --git a/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h b/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h index 93cafbe37b2..67b48fee40c 100644 --- a/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h +++ b/Point_set_2/doc/Point_set_2/CGAL/nearest_neighbor_delaunay_2.h @@ -6,8 +6,7 @@ namespace CGAL { computes a handle to a vertex `w` of `delau` that is closest to `v`. If `v` is the only vertex in `delau`, `NULL` is returned. -Requirements --------------- +### Requirements ### `Dt` is a \cgal Delaunay triangulation and contains the following subset of types from the concept `PointSetTraits` and from the Delaunay triangulation data type: @@ -42,8 +41,7 @@ neighbors search on Delaunay triangulations. There are two versions of this function, one taking a point of the Delaunay triangulation and the other taking a vertex handle. -Requirements --------------- +### Requirements ### `Dt` is a \cgal Delaunay triangulation and contains the following subset of types from the concept `PointSetTraits` and from the Delaunay triangulation data type: @@ -79,8 +77,7 @@ neighbors search on Delaunay triangulations. There are two versions of this function, one taking a point of the Delaunay triangulation and the other taking a vertex handle. -Requirements --------------- +### Requirements ### `Dt` is a \cgal Delaunay triangulation and contains the following subset of types from the concept `PointSetTraits` and from the Delaunay triangulation data type: diff --git a/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h b/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h index 9abdae1e8bd..c8b823e5622 100644 --- a/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h +++ b/Point_set_2/doc/Point_set_2/CGAL/range_search_delaunay_2.h @@ -29,8 +29,7 @@ returns an output iterator pointing to the position beyond the end of the sequence. `delau`$ is the \cgal Delaunay triangulation on which we perform the range search operation. -Requirements --------------- +### Requirements ###
                                                          • `Dt` is a \cgal Delaunay triangulation and contains the following subset of types from the concept `PointSetTraits` and from @@ -65,8 +64,7 @@ returns an output iterator pointing to the position beyond the end of the sequence. `delau` is the \cgal Delaunay triangulation on which we perform the range search operation. -Requirements --------------- +### Requirements ### `Dt` is a \cgal Delaunay triangulation and contains the following subset of types from the concept `PointSetTraits` and from the Delaunay triangulation data type: @@ -101,8 +99,7 @@ which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end of the sequence. `delau` is the \cgal Delaunay triangulation on which we perform the range search operation. -Requirements --------------- +### Requirements ### `Dt` is a \cgal Delaunay triangulation and contains the following subset of types from the concept `PointSetTraits` and from the Delaunay triangulation data type: @@ -137,8 +134,7 @@ of the sequence. ` pred` controls the search operation. If `return_if_succeded` is `true`, we will end the search after the first success of the predicate, otherwise we will continue till the search is finished. -Requirements --------------- +### Requirements ### For the requirements of `Dt` see the description for the non-predicate version. @@ -173,8 +169,7 @@ of the sequence. `pred` controls the search operation. If `return_if_succeded` is `true`, we will end the search after the first success of the predicate, otherwise we will continue till the search is finished. -Requirements --------------- +### Requirements ### For the requirements of `Dt` see the description for the non-predicate version. @@ -199,8 +194,7 @@ of the sequence. `delau` is the \cgal Delaunay triangulation on which we perform `pred` controls the search operation. If `return_if_succeded` is `true`, we will end the search after the first success of the predicate, otherwise we will continue till the search is finished. -Requirements --------------- +### Requirements ### For the requirements of `Dt` see the description for the non-predicate version. diff --git a/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h b/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h index a1ead813668..b0b2a014d7b 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h +++ b/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h @@ -22,8 +22,7 @@ format automatically and can read both. \sa operator<<(std::ostream&, CGAL::Polyhedron_3&) -Implementation --------------- +### Implementation ### This operator is implemented using the modifier mechanism for polyhedral surfaces and the `CGAL::Polyhedron_incremental_builder_3` diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h index 4f4a8acab01..8aa0d88c89a 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h @@ -60,8 +60,7 @@ namespace CGAL { modifications. There is no automatic caching done for auxiliary information. - Parameters - -------------- +### Parameters ### The full template declaration of `Polyhedron_3` states four template parameters: @@ -101,8 +100,7 @@ class Polyhedron_3; \sa `CGAL::Polyhedron_incremental_builder_3` \sa `CGAL::Modifier_base`. - Example - -------------- +### Example ### This example program instantiates a polyhedron using the default traits class and creates a tetrahedron. @@ -157,8 +155,7 @@ public: \sa `CGAL::Polyhedron_3::Facet` \sa `CGAL::Polyhedron_3` - Implementation - -------------- +### Implementation ### The member functions `prev()` and `prev_on_vertex()` work in constant time if `Supports_halfedge_prev` \f$ \equiv\f$ @@ -437,10 +434,6 @@ public: argument provides a member function `prev()`, otherwise it is of the forward category. - Operations available if `Supports_facet_plane` \f$ \equiv\f$ `CGAL::Tag_true` - -------------- - - Operations available if `Supports_facet_halfedge` \f$ \equiv\f$ \sa `CGAL::Polyhedron_3::Vertex` \sa `CGAL::Polyhedron_3::Halfedge` \sa `CGAL::Polyhedron_3` @@ -453,6 +446,12 @@ public: /// \name Types /// @{ + + /*! + type of incident vertices. + */ + typedef Hidden_type Vertex; + /*! type of incident halfedges. */ @@ -1230,10 +1229,7 @@ public: facet removed and the time to compute `h->prev()`. \pre The degree of both vertices incident to `h` is at least three (no antennas). - Requirement - -------------- - - `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_facet.gif @@ -1257,8 +1253,7 @@ public: \image euler_vertex.gif - Note - -------------- +### Note ### A special application of the split is `split_vertex(h,h->next()->opposite())` which is equivalent to an @@ -1279,10 +1274,7 @@ public: the time to compute `h->prev()` and `h->opposite()->prev()`. \pre The size of both facets incident to `h` is at least four (no multi-edges). - Requirement - -------------- - - `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image euler_vertex.gif */ @@ -1334,10 +1326,7 @@ public: The time is proportional to the sum of the size of all incident facets. \pre None of the incident facets of `g->vertex()` is a hole. There are at least two distinct facets incident to the facets that are incident to `g->vertex()`. (This prevents the operation from collapsing a volume into two facets glued together with opposite orientations, such as would happen with any vertex of a tetrahedron.) - Requirement - -------------- - - `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image euler_center.gif */ @@ -1372,11 +1361,7 @@ public: polyhedron unchanged. \pre The facets denoted by `h` and `g` are different and have equal degree (i.e., number of edges). - Requirement - -------------- - - `Supports_removal` \f$ \equiv\f$ - `CGAL::Tag_true`. + \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html euler_loop.gif @@ -1395,11 +1380,7 @@ public: See `erase_facet(h)` for a more generalized variant. \pre None of the incident halfedges of the facet is a border edge. - Requirement - -------------- - - `Supports_removal` \f$ \equiv\f$ - `CGAL::Tag_true`. + \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ Halfedge_handle make_hole( Halfedge_handle h); @@ -1451,10 +1432,8 @@ public: If this creates isolated vertices they get removed as well. See `make_hole(h)` for a more specialized variant. \pre `h->is_border() == false`. - Requirement - -------------- - `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. + \requirement `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. \image html add_facet1.gif @@ -1466,11 +1445,7 @@ public: removes the vertices, halfedges, and facets that belong to the connected component of `h`. - Requirement - -------------- - - `Supports_removal` \f$ \equiv\f$ - `CGAL::Tag_true`. + \requires `Supports_removal` \f$ \equiv\f$ `CGAL::Tag_true`. */ void erase_connected_component( Halfedge_handle h); @@ -1479,10 +1454,7 @@ public: Keep `nb_components_to_keep` largest connected components. Returns the number of connected components erased (ignoring isolated vertices). - Requirement - -------------- - - supports vertices, halfedges, and removal operation. + \requires supports vertices, halfedges, and removal operation. */ unsigned int keep_largest_connected_components(unsigned int nb_components_to_keep); diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h index 873b1b51ecc..5e07c1e0115 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h @@ -52,8 +52,7 @@ vertices when creating new facets. \sa \ref ::HalfedgeDS \sa `CGAL::Modifier_base`. -Example --------------- +### Example ### A modifier class creates a new triangle in the halfedge data structure using the incremental builder. diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h index 4703c68359e..d606b11701a 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h @@ -18,8 +18,7 @@ halfedge. \sa `CGAL::HalfedgeDS_min_items` \sa `CGAL::HalfedgeDS_items_2` -Example --------------- +### Example ### The following example program defines a new face class based on the `CGAL::HalfedgeDS_face_base` and adds a new color member variable. diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h index e24a6706423..eaeafa667fa 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h @@ -14,16 +14,14 @@ it suitable for kernels with local state. \sa `CGAL::Polyhedron_traits_with_normals_3` -Implementation --------------- +### Implementation ### Since the `PolyhedronTraits_3` concept is a subset of the concept Kernel, this class just forwards the relevant types and access member functions from its template argument. However, it is useful for testing sufficiency of requirements. -Example --------------- +### Example ### Instantiation of a polyhedral surface with the %Cartesian kernel based on double coordinates. diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h index 28761a44277..66a1e247e1e 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h @@ -16,8 +16,7 @@ with local state. \sa \ref ::CGAL::Polyhedron_traits_3 -Example --------------- +### Example ### We use this traits class to instantiate a polyhedral surface with a normal vector and no plane equation for each facet. We compute the diff --git a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h index 309e9f4b059..11e74e6b9fa 100644 --- a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h +++ b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronItems_3.h @@ -24,8 +24,7 @@ polyhedral surface renames faces to facets. \sa `CGAL::HalfedgeDS_halfedge_base` \sa `CGAL::HalfedgeDS_face_base` -Example --------------- +### Example ### We define our own items class based on the available `CGAL::HalfedgeDS_face_base` base class for faces. We derive the diff --git a/Polynomial/doc/Polynomial/CGAL/Polynomial.h b/Polynomial/doc/Polynomial/CGAL/Polynomial.h index 30c6b1d9d1e..4e283460ed4 100644 --- a/Polynomial/doc/Polynomial/CGAL/Polynomial.h +++ b/Polynomial/doc/Polynomial/CGAL/Polynomial.h @@ -39,8 +39,7 @@ model of `Modularizable`, where the homomorphic map on the polynomials is simply defined as the canonical extension of the homomorphic map which is defined on the coefficient type. -Implementation --------------- +### Implementation ### Inexact and limited-precision types can be used as coefficients, but at the user's risk. The algorithms implemented were written with diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h index 4eaaf5dad7e..00b0880381d 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h @@ -11,8 +11,7 @@ iterator range, where begin refers the value for the innermost variable. \refines CopyConstructible \refines DefaultConstructible -Types --------------- +### Types ### Note that the `result_type` is the coercion type of the value type of the given iterator range and `PolynomialTraits_d::Innermost_coefficient_type`. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h index b97c97df211..af265badc4c 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h @@ -17,8 +17,7 @@ polynomial \f$ p(x_0,x_1,w) = x_0^2x_1^3+x_1^4w^1\f$. \refines CopyConstructible \refines DefaultConstructible -Types --------------- +### Types ### Note that the `result_type` is the coercion type of the value type of the given iterator range and `PolynomialTraits_d::Innermost_coefficient_type`. diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h index 1923cdb7dc9..422ba89e742 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d.h @@ -28,10 +28,8 @@ algorithm computes a pair of support sets \f$ S_P\f$ and \f$ S_Q\f$ with realizi points \f$ p\f$ and \f$ q\f$ which remain fixed until the next set, insert, or clear operation. -Requirements --------------- -The template parameter `Traits` is a model for `OptimisationDTraits`. +\tparam Traits must be a model for `OptimisationDTraits`. We provide the models `Optimisation_d_traits_2`, `Optimisation_d_traits_3`, and `Optimisation_d_traits_d` using the @@ -42,8 +40,7 @@ two-, three-, and \f$ d\f$-dimensional \cgal kernel, respectively. \sa `CGAL::Optimisation_d_traits_d` \sa `OptimisationDTraits` -Implementation --------------- +### Implementation ### The problem of finding the distance between two convex polytopes given as the convex hulls of two finite point sets can be formulated as an @@ -299,8 +296,7 @@ FT squared_distance( ) const; returns an iterator referring to the first coordinate of the realizing point of \f$ P\f$. -Note --------------- +### Note ### The coordinates have a rational representation, i.e. the first \f$ d\f$ elements of the iterator @@ -322,8 +318,7 @@ realizing_point_p_coordinates_end() const; returns an iterator referring to the first coordinate of the realizing point of \f$ Q\f$. -Note --------------- +### Note ### The coordinates have a rational representation, i.e. the first \f$ d\f$ elements of the iterator diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h index 53e32d8b0e6..a18a4ae0ed5 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_2.h @@ -7,13 +7,10 @@ namespace CGAL { The class `Polytope_distance_d_traits_2` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the two-dimensional \cgal kernel. -Requirements --------------- -The template parameter `K` is a model for `Kernel`. Template -parameters `ET` and `NT` are models for `RingNumberType`. +\tparam K must be a model for `Kernel`. -The second and third template parameter have default type `K::RT`. +\tparam ET NT must be models for `RingNumberType`. Their default is `K::RT`. \models ::PolytopeDistanceDTraits diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h index 6630f60e683..8cf2b13ddb9 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_3.h @@ -7,13 +7,11 @@ namespace CGAL { The class `Polytope_distance_d_traits_3` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the three-dimensional \cgal kernel. -Requirements --------------- -The template parameter `K` is a model for `Kernel`. Template -parameters `ET` and `NT` are models for `RingNumberType`. +\tparam K must be a model for `Kernel`. + +\tparam ET NT must be models for `RingNumberType`. Their default is `K::RT`. -The second and third template parameter have default type `K::RT`. \models ::PolytopeDistanceDTraits diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h index 26568736e07..85b347978aa 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Polytope_distance_d_traits_d.h @@ -7,13 +7,11 @@ namespace CGAL { The class `Polytope_distance_d_traits_d` is a traits class for the \f$ d\f$-dimensional optimisation algorithms using the \f$ d\f$-dimensional \cgal kernel. -Requirements --------------- -The template parameter `K` is a model for `Kernel`. Template -parameters `ET` and `NT` are models for `RingNumberType`. +\tparam K must be a model for `Kernel`. + +\tparam ET NT must be models for `RingNumberType`. Their default is `K::RT`. -The second and third template parameter have default type `K::RT`. \models ::PolytopeDistanceDTraits diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h index 279a5845da7..99860700989 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_3.h @@ -29,18 +29,15 @@ width-planes. neither the width-planes nor the direction \f$ \mathbf{d}_{opt}\f$ are unique - only the width is. -Requirements --------------- +\tparam Traits must be a model for `WidthTraits_3`. -The template parameter `Traits` is a model for `WidthTraits_3`. We provide the model `Width_default_traits_3` based on a three-dimensional \cgal kernel. \sa `CGAL::Width_default_traits_3` \sa `WidthTraits_3` -Implementation --------------- +### Implementation ### Since the width of the point set \f$ \mathcal{S}\f$ and the width of the convex hull of \f$ \mathcal{S}\f$ (\f$ \mathit{conv(\mathcal{S})}\f$) is the same, the @@ -75,8 +72,7 @@ from 0 (no output) to 1 (output available). But then it is required that the \f$ <\!<\f$-operator has to been overloaded for `Point_3`, `Plane_3`, `Vector_3` and `RT`. -Example --------------- +### Example ### \cgalexample{width_simplex.cpp} @@ -130,11 +126,7 @@ creates a variable `width` initialized to the width of \f$ \mathcal{S}\f$ - with \f$ \mathcal{S}\f$ being the set of points in the range [`first`,`beyond`). -Requirement --------------- - -The value type of `InputIterator` -is `Point_3`. +\requires The value type of `InputIterator` is `Point_3`. */ template < class InputIterator > Width_3( InputIterator first, InputIterator beyond); @@ -145,10 +137,7 @@ the width of the polyhedron \f$ P\f$. Note that the vertex point coordinates are altered! \pre \f$ P\f$ is a convex polyhedron. -Requirement --------------- - -`Polyhedron` is a +\requires `Polyhedron` is a `CGAL::Polyhedron_3` with facets supporting plane equations where `Polyhedron::Point_3` \f$ \equiv\f$ `Point_3` and `Polyhedron::Plane_3` \f$ \equiv\f$ `Plane_3`. diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h index b41a0580019..f683bad4938 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/Width_default_traits_3.h @@ -7,10 +7,7 @@ namespace CGAL { The class `Width_default_traits_3` is a traits class for `Width_3` using the three-dimensional \cgal kernel. -Requirements --------------- - -The template parameter `K` is a model for `Kernel` +\tparam K must be a model for `Kernel`. \models ::WidthTraits_3 diff --git a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h index 87a1b94b63a..1901b3f2582 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/CGAL/all_furthest_neighbors_2.h @@ -23,7 +23,8 @@ can be omitted if `RandomAccessIterator` refers to a point type from a `Kernel`. In this case, the kernel is used as default traits class. -***Requires*** +###Requires### +
                                                            1. If `t` is specified explicitly, `Traits` is a model for `AllFurthestNeighborsTraits_2`. @@ -36,15 +37,13 @@ for `AllFurthestNeighborsTraits_2`. \sa `AllFurthestNeighborsTraits_2` \sa `CGAL::monotone_matrix_search` -Implementation --------------- +### Implementation ### The implementation uses monotone matrix search \cite akmsw-gamsa-87. Its runtime complexity is linear in the number of vertices of \f$ P\f$. -Example --------------- +### Example ### The following code generates a random convex polygon `p` with ten vertices, computes all furthest neighbors and diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h index 6a794a1e366..5f398cc20ac 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/AllFurthestNeighborsTraits_2.h @@ -14,8 +14,7 @@ convex polygon using the function `all_furthest_neighbors_2`. \sa `CGAL::all_furthest_neighbors_2` -Notes --------------- +### Notes ###
                                                              • `AllFurthestNeighborsTraits_2``::Less_xy_2` and diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h index 933da5918e1..494420e7a80 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/WidthTraits_3.h @@ -6,8 +6,7 @@ This concept defines the requirements for traits classes of `Width_3`. -Operations --------------- +### Operations ### Whatever the coordinates of the points are, it is required for the width-algorithm to have access to the homogeneous representation of diff --git a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_2.h b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_2.h index 63e85ba8587..0244734ea33 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_2.h +++ b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_2.h @@ -13,8 +13,7 @@ The tag `tag` identifies the dimension to be considered from the objects. For po The class `K` is the kernel in which the type `InputIterator::value_type` is defined. It can be omitted and deduced automatically from the value type. -Requirements --------------- +### Requirements ###
                                                                1. `InputIterator::value_type` is equivalent to `K::Point_2` or diff --git a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h index f78f393f5bc..ae9bcf181af 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h +++ b/Principal_component_analysis/doc/Principal_component_analysis/CGAL/linear_least_squares_fitting_3.h @@ -65,8 +65,7 @@ The class `K` is the kernel in which the type `InputIterator::value_type` is defined. It can be omitted and deduced automatically from the value type. -Requirements --------------- +### Requirements ###
                                                                  1. `InputIterator::value_type` can be either `K::Point_3`, @@ -102,8 +101,7 @@ The class `K` is the kernel in which the type automatically from the value type. The tag `tag` identifies the dimension to be considered from the objects (see above). -Requirements --------------- +### Requirements ###
                                                                    1. `InputIterator::value_type` can either be `K::Point_3`, diff --git a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h index 5f124a269d5..34c4f455ac3 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h @@ -99,8 +99,7 @@ using the `iterator_to` and `s_iterator_to` functions. -Parameters --------------- +### Parameters ### The parameter `T` is required to have a copy constructor and an assignment operator. It also needs to provide access to an internal @@ -738,8 +737,7 @@ types `T` to make them usable with the default `Compact_container_traits`. -Parameters --------------- +### Parameters ### `T` is any type providing the following member functions: diff --git a/STL_Extension/doc/STL_Extension/CGAL/Default.h b/STL_Extension/doc/STL_Extension/CGAL/Default.h index 252e77ce90e..7f00835f5a5 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Default.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Default.h @@ -34,8 +34,7 @@ way to extract the desired type for a template parameter which may be defaulted using `Default`. It is enough to fetch the type as `Default::Get::type`, as in the example program below. -Example --------------- +### Example ### \cgalexample{STL_Extension/Default.cpp} diff --git a/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h b/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h index 4833ac3c971..57eb29920b4 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h +++ b/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h @@ -80,8 +80,7 @@ deletes all items. Note that these two possible versions of `In_place_list` are not assignable to each other to avoid confusions between the different storage responsibilities. -Parameters --------------- +### Parameters ### The full class name is `In_place_list`. @@ -94,8 +93,7 @@ relational order require the operators `==` and `<` for \f$ T\f$ respectively. These operators must not compare the pointers in `T`. -Example --------------- +### Example ### \cgalexample{STL_Extension/in_place_list_prog.cpp} diff --git a/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h b/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h index 74aa0069daa..454927146b5 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Location_policy.h @@ -66,8 +66,7 @@ For example, passing `Location_policy` as parameter to -Parameters --------------- +### Parameters ### `Tag` can only be either `Fast` or `Compact` currently. diff --git a/STL_Extension/doc/STL_Extension/CGAL/Multiset.h b/STL_Extension/doc/STL_Extension/CGAL/Multiset.h index 880f9faa1e0..a230c86fdf6 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Multiset.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Multiset.h @@ -55,8 +55,7 @@ second function splits `s` into two sets, one containing all the elements that are less than a given key, and the other contains all elements greater than (or equal to) this key. -Parameters --------------- +### Parameters ### The `Multiset` class-template has three parameters:
                                                                        @@ -74,15 +73,13 @@ less-than operator (`operator<`). `CGAL_ALLOCATOR` is used by default.
                                                                      -Assertions --------------- +### Assertions ### The assertion and precondition flags for the `Multiset` class use `MULTISET` in their names (i.e., `CGAL_MULTISET_NO_ASSERTIONS` and `CGAL_MULTISET_NO_PRECONDITIONS`). -Implementation --------------- +### Implementation ### `Multiset` uses a proprietary implementation of a red-black tree data-structure. The red-black tree invariants guarantee that the height of a diff --git a/STL_Extension/doc/STL_Extension/CGAL/Object.h b/STL_Extension/doc/STL_Extension/CGAL/Object.h index eb929b4edf9..b2fd469e258 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Object.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Object.h @@ -21,8 +21,7 @@ encapsulation mechanism requires the use of `assign` or This class is similar in spirit to `boost::any`. -Example --------------- +### Example ### In the following example, the object class is used as return value for the intersection computation, as there are possibly different return values. diff --git a/STL_Extension/doc/STL_Extension/CGAL/Threetuple.h b/STL_Extension/doc/STL_Extension/CGAL/Threetuple.h index dc5865182d4..89d61aed3e5 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Threetuple.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Threetuple.h @@ -16,8 +16,7 @@ accessing the elements of a container. -Requirements --------------- +### Requirements ### `T` must be `Assignable`. diff --git a/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h b/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h index 3e4d9544b8d..3b139e2494d 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h @@ -35,8 +35,7 @@ It can also be used in other contexts as well, as it is a general tool. This can be seen as support for non-deterministic programming. Finally, note that this class has some common points with `boost::tribool`. -Parameters --------------- +### Parameters ### The parameter `T` can either be `bool` or one of the three-valued (-1, 0, 1) enumeration types: `Sign`, `Comparison_result`, diff --git a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h index 2cbcc991165..3b9778c9711 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/algorithm.h +++ b/STL_Extension/doc/STL_Extension/CGAL/algorithm.h @@ -44,8 +44,7 @@ maximal element of a range. It is modeled after the STL functions one only iterates once over the sequence. This is more efficient especially for large and/or complex sequences. -Example --------------- +### Example ### The following example program computes the minimal and maximal element of the sequence \f$ (3,\,6,\,5)\f$. Hence the output is @@ -74,8 +73,7 @@ maximal element of a range. It is modeled after the STL functions one only iterates once over the sequence. This is more efficient especially for large and/or complex sequences. -Example --------------- +### Example ### The following example program computes the minimal and maximal element of the sequence \f$ (3,\,6,\,5)\f$. Hence the output is diff --git a/STL_Extension/doc/STL_Extension/CGAL/array.h b/STL_Extension/doc/STL_Extension/CGAL/array.h index 4492ad4a570..d968d9826d0 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/array.h +++ b/STL_Extension/doc/STL_Extension/CGAL/array.h @@ -18,14 +18,12 @@ is taken from Boost. -Parameters --------------- +### Parameters ### The parameter `T` is the value type. The second parameter is the dimension of the array. -Construction functions --------------- +### Construction Functions ### The array class does not provide a constructor which can be used to initialize data members. \cgal therefore provides a `make_array` function for diff --git a/STL_Extension/doc/STL_Extension/CGAL/iterator.h b/STL_Extension/doc/STL_Extension/CGAL/iterator.h index 135403658e6..f29bdbfa89a 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/iterator.h +++ b/STL_Extension/doc/STL_Extension/CGAL/iterator.h @@ -59,8 +59,7 @@ from input iterators. \models ::InputIterator -Requirements --------------- +### Requirements ### `Iterator` is a model for `InputIterator`. @@ -116,8 +115,7 @@ among those based on the type of the value type which is put in it. Other types are also accepted, and the object is simply discarded in this case. It also inherits from `O`, which makes it easy to treat like a tuple. -Parameters --------------- +### Parameters ### `V` must be a `CGAL::cpp0x::tuple<...>` of the types of values to be accepted and dispatched. `O` must be a `CGAL::cpp0x::tuple<...>` of the types of corresponding output iterators. @@ -199,8 +197,7 @@ The class `Dispatch_output_iterator` defines an among those based on the type of the value type which is put in it. It also inherits from `O`, which makes it easy to treat like a tuple. -Parameters --------------- +### Parameters ### `V` must be a `CGAL::cpp0x::tuple<...>` of the types of values to be accepted and dispatched. `O` must be a `CGAL::cpp0x::tuple<...>` of the types of corresponding output iterators. @@ -448,8 +445,7 @@ with opaque values will not work. -Implementation --------------- +### Implementation ### For random access iterators or circulators, it is done in constant time by subtracting \f$ i\f$. For other iterator categories, an \stl diff --git a/STL_Extension/doc/STL_Extension/CGAL/tuple.h b/STL_Extension/doc/STL_Extension/CGAL/tuple.h index eb466e95dd2..eb29e8611d2 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/tuple.h +++ b/STL_Extension/doc/STL_Extension/CGAL/tuple.h @@ -18,13 +18,11 @@ is taken from Boost. -Parameters --------------- +### Parameters ### The parameters `...` are the value types. -Free functions and helper classes --------------- +### Free functions and helper classes ### Some free functions part of the standard interface of `tuple` are also brought in namespace `CGAL::cpp11` with using declarations, these are `make_tuple`, diff --git a/STL_Extension/doc/STL_Extension/CGAL/utility.h b/STL_Extension/doc/STL_Extension/CGAL/utility.h index 408c13c0dca..16118774591 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/utility.h +++ b/STL_Extension/doc/STL_Extension/CGAL/utility.h @@ -18,8 +18,7 @@ container. -Requirements --------------- +### Requirements ### `T1`, `T2`, `T3` and `T4` must be `Assignable`. Additional operations have additional requirements. @@ -240,8 +239,7 @@ accessing the elements of a container. -Requirements --------------- +### Requirements ### `T1`, `T2` and `T3` must be `Assignable`. Additional operations have additional requirements. diff --git a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h index 715c1eaf460..2e32aac88ba 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h @@ -7,8 +7,7 @@ namespace CGAL { \brief A \f$ d\f$-dimensional range tree stores points and can be used to determine all points that lie inside a given \f$ d\f$-dimensional interval. -Implementation --------------- +### Implementation ### The construction of a \f$ d\f$-dimensional range tree takes \f$ {O}(n\log n^{d-1})\f$ time. The points in diff --git a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h index 89ae7102fc9..476989894d3 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h @@ -21,8 +21,7 @@ RangeSegmentTreeTraits_d defines the requirements that range tree traits classes must fulfill. This allows the advanced user to develop further range tree traits classes. -Example --------------- +### Example ### The following example program uses the predefined `Range_tree_2` data structure together with the predefined traits class `Range_tree_map_traits_2` which has two template diff --git a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h index 4bda0f7a94a..024d51dbe13 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h @@ -6,8 +6,7 @@ namespace CGAL { \brief A \f$ d\f$-dimensional segment tree stores \f$ d\f$-dimensional intervals and can be used to find all intervals that enclose, partially overlap, or contain a query interval, which may be a point. -Implementation --------------- +### Implementation ### A \f$ d\f$-dimensional segment tree is constructed in \f$ {O}(n\log n^d)\f$ time. An inverse range query is performed in time \f$ {O}(k+{\log}^d n )\f$, where \f$ k\f$ diff --git a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h index de7b64c0fd1..1fdcc052940 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h @@ -28,8 +28,7 @@ RangeSegmentTreeTraits_d defines the requirements that segment tree traits classes must fulfill. This allows the advanced user to develop further segment tree traits classes. -Example --------------- +### Example ### This example illustrates the use of the predefined segment tree on 3-dimensional interval data (with no value associated). After diff --git a/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h b/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h index 6c911ad7cdf..b1bc6c88b18 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h @@ -11,8 +11,7 @@ classes. Therefore, instantiate `Sublayer_type` of `Range_tree_d` (`Segment_tree_d` respectively) with `Tree_anchor` and the container classes for the data items (`Data` and `Window`). -Example --------------- +### Example ### The following figures show a number of rectangles and a 2-dimensional segment tree built on them. diff --git a/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h b/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h index e62c756092a..caee3b48208 100644 --- a/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h +++ b/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h @@ -8,8 +8,7 @@ type information of the keys and intervals. Further more, they define function o the keys and intervals, and provide comparison functions that are needed for window queries. -Example --------------- +### Example ### The following piece of code gives an example of how a traits class might look like, if you have keys that are of the type `int` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h index 5606ec37b86..6aecf513ca4 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_2.h @@ -14,15 +14,13 @@ which must be a model of `SegmentDelaunayGraphDataStructure_2`. The second template argument defaults to `CGAL::Triangulation_data_structure_2< CGAL::Segment_Delaunay_graph_vertex_base_2, CGAL::Triangulation_face_base_2 >`. -Traversal of the Segment Delaunay Graph --------------- +### Traversal of the Segment Delaunay Graph ### A segment Delaunay graph can be seen as a container of faces and vertices. Therefore the `Segment_Delaunay_graph_2` class provides several iterators and circulators that allow to traverse it (completely or partially). -Traversal of the Convex Hull ----------------------------- +### Traversal of the Convex Hull ### Applied on the `infinite_vertex` the above methods allow to visit the vertices on the convex hull and the infinite edges and diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h index 800e1c3f212..016ddbb6caf 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphHierarchyVertexBase_2.h @@ -14,15 +14,13 @@ next and previous level graphs. \refines ::SegmentDelaunayGraphVertexBase_2 -Types --------------- +### Types ### `SegmentDelaunayGraphHierarchyVertexBase_2` does not introduce any types in addition to those of `SegmentDelaunayGraphVertexBase_2`. -Creation --------------- +### Creation ### The `SegmentDelaunayGraphHierarchyVertexBase_2` concept does not introduce any constructors in addition to those of the diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h index b1f083e665f..5e18d3a7868 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h @@ -7,8 +7,7 @@ The class `Euclidean_distance` provides an implementation of the concept `Orthog Euclidean distance (\f$ l_2\f$ metric). To optimize distance computations squared distances are used. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h index d8dff4e082e..aefd53e37ba 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance_sphere_point.h @@ -9,8 +9,7 @@ metric) between a \f$ d\f$-dimensional sphere and a point, and the Euclidean distance between a \f$ d\f$-dimensional sphere and a \f$ d\f$-dimensional iso-rectangle defined as a \f$k\f$-\f$d\f$ tree rectangle. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Cartesian_d`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h index 6cbbc560317..f9cab874dab 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h @@ -8,8 +8,7 @@ fuzzy iso box with fuzziness value \f$ \epsilon\f$ has as outer approximation a box dilated, and as inner approximation a box eroded by a \f$ d\f$-dim square with side length \f$ \epsilon\f$. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h index 38c3dd057e2..f84d43e0908 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h @@ -8,8 +8,7 @@ A fuzzy sphere with radius \f$ r\f$ and fuzziness value \f$ \epsilon\f$ has as outer approximation a sphere with radius \f$ r+\epsilon\f$ and as inner approximation a sphere with radius \f$ r-\epsilon\f$. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Cartesian_d`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h index fddaded2c87..12f4d106212 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h @@ -6,8 +6,7 @@ namespace CGAL { The class `Incremental_neighbor_search` implements incremental nearest and furthest neighbor searching on a tree. The tree may have extended or unextended nodes. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h index c6571a244ca..1613b5053c0 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h @@ -7,8 +7,7 @@ The class `K_neighbor_search` implements approximate \f$ k\f$-nearest and \f$ k\ using standard search on a tree using a general distance class. The tree may be built with extended or unextended nodes. -Parameters --------------- +### Parameters ### Expects for the first template argument an implementation of the concept `SearchTraits`, for example `CGAL::Cartesian_d`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h index 3d67120e0b6..dcdaf1ebb10 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h @@ -5,8 +5,7 @@ namespace CGAL { The class `Kd_tree` defines a \f$ k\f$-\f$ d\f$ tree. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h index 1a0013b8671..3ec2cdcf4d8 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h @@ -12,8 +12,7 @@ upper child, and a pointer to its separator. An extended internal node is an internal node containing the lower and upper limit of an extended node's rectangle along the node's cutting dimension. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`, or `CGAL::Cartesian_d`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h b/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h index a4ac6c46849..e79f5c25f7f 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Manhattan_distance_iso_box_point.h @@ -10,8 +10,7 @@ between a \f$ d\f$-dimensional iso-box and a \f$ d\f$-dimensional point and the Manhattan distance between a \f$ d\f$-dimensional iso-box and a \f$ d\f$-dimensional iso-box defined as a \f$ k\f$-\f$d\f$ tree rectangle. -Parameters --------------- +### Parameters ### Expects for the template argument a model for the concept `SearchTraits`, for example `CGAL::Search_traits_3 >`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h index aeffccee84a..b1fd7d78dcf 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_incremental_neighbor_search.h @@ -5,8 +5,7 @@ namespace CGAL { The class `Orthogonal_incremental_neighbor_search` implements incremental nearest and furthest neighbor searching on a tree. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h index 3c31537e06f..f2a47551cb1 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Orthogonal_k_neighbor_search.h @@ -7,8 +7,7 @@ The class `Orthogonal_k_neighbor_search` implements approximate \f$ k\f$-nearest \f$ k\f$-furthest neighbor searching on a tree using an orthogonal distance class. -Parameters --------------- +### Parameters ### Expects for the first template argument an implementation of the concept `SearchTraits`, for example `CGAL::Search_traits_2 >`. @@ -85,7 +84,7 @@ SpatialTree Tree; Constructor for searching approximately \f$ k\f$ neighbors of the query item `query` in the points stored in `tree` using distance `d` and approximation factor `eps`.`sorted` indicates -if the computed sequence of \f$ k\f$-nearest neighbors needs to be sorted. +if the computed sequence of \f$ k\f$w-nearest neighbors needs to be sorted. */ Orthogonal_k_neighbor_search(SpatialTree tree, Query_item query, unsigned int k=1, FT eps=FT(0.0), bool search_nearest=true, diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h index 00d846023f3..55ad01768a5 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h @@ -10,8 +10,7 @@ rectangle is called the associated rectangle. Provides a method to split a container and a number of methods to support the implementation of splitting rules. -Parameters --------------- +### Parameters ### Expects for the template argument an implementation for \f$ d\f$-dimensional points of the concept `SearchTraits`, for example diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h index 455afb09312..d6b43716e78 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h @@ -6,8 +6,7 @@ namespace CGAL { The class `Search_traits_2` can be used as a template parameter of the kd tree and the search classes. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `Kernel`, for example `CGAL::Cartesian` or `CGAL::Simple_cartesian`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h index 1a59e98c348..a7717be498e 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h @@ -6,8 +6,7 @@ namespace CGAL { The class `Search_traits_3` can be used as a template parameter of the kd tree and the search classes. `Kernel` must be a \cgal kernel. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `Kernel`, for example `CGAL::Cartesian` or `CGAL::Simple_cartesian`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h index 166552b1dfb..dc9d9aec7b1 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h @@ -8,8 +8,7 @@ key as point type. When using `Search_traits_adapter` in a nearest neighbor search algorithm, this class must be used as distance. -Parameters --------------- +### Parameters ### `Key` is a type that is associated to a point of type `Base_distance::Point_d`. @@ -81,8 +80,7 @@ and the search classes. When using this traits class in a nearest neighbor searc `Distance_for_point_adapter` must be used as distance. -Parameters --------------- +### Parameters ### `Key` is a type that is associated to a point of type `Base_distance::Point_d`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h index e1b279e9095..329c9b3d449 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h @@ -8,8 +8,7 @@ and the search classes. `Kernel` must be a \cgal kernel. `Kernel` must be a d-dimensional \cgal kernel. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `Kernel_d`, for example `CGAL::Cartesian_d` or `CGAL::Homogeneous_d`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h index 7ca63b55d2d..c8949844602 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h @@ -14,8 +14,7 @@ which the points have the largest spread. It then splits the points in the most even manner possible, subject to maintaining the bound on the ratio of the resulting rectangles. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, @@ -73,8 +72,7 @@ The splitting dimension is the dimension of the longest side of the rectangle. The splitting value is defined by the median of the coordinates of the data points along this dimension. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example @@ -121,8 +119,7 @@ The splitting dimension is the dimension of the longest side of the rectangle. The splitting value is defined by the median of the coordinates of the data points along this dimension. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example @@ -168,8 +165,7 @@ Implements the midpoint of max spread splitting rule. A rectangle is cut through \f$ (Mind+Maxd)/2\f$ orthogonal to the dimension with the maximum point spread \f$ [Mind,Maxd]\f$. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example @@ -214,8 +210,7 @@ namespace CGAL { Implements the midpoint of rectangle splitting rule. A rectangles is cut through its midpoint orthogonal to the longest side. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example @@ -278,8 +273,7 @@ to one side of this cut, then we slide the cut until it hits the first point. This may violate the aspect ratio bound, but will never generate empty cells. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, @@ -352,8 +346,7 @@ the midpoint of rectangle rule. If the data points lie only on one side it avoids this by sliding the separator, computed by the midpoint of rectangle rule, to the nearest data point. -Parameters --------------- +### Parameters ### Expects for the first template argument a model of the concept `SearchTraits`, for example `CGAL::Cartesian_d`. diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h b/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h index cd97bbe3ff6..c638c324671 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h @@ -10,8 +10,7 @@ defined by \f$ l_{\infty}(w)(r,q)=max \{w_i |r_i-q_i| \mid 1 \leq i \leq d\}\f$. For the purpose of the distance computations it is more efficient to compute the transformed distance \f$ {\sigma_{i=1}^{i=d} \, w_i(r_i-q_i)^p}\f$ instead of the actual distance. -Parameters --------------- +### Parameters ### Expects for the template argument a model of the concept `SearchTraits`, for example `CGAL::Search_traits_2`. diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h index dd30a48a4ca..fcd3f8f108e 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_policy_tags.h @@ -13,8 +13,7 @@ can be passed to as parameter to `hilbert_sort` to choose the sorting policy. -Parameters --------------- +### Parameters ### `Tag` can only be either `Median` or `Middle` currently. diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h index 9c27761c7ee..401722b9b1a 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h @@ -8,8 +8,7 @@ The function object `Hilbert_sort_2` sorts iterator ranges of at the median or the middle depending on the `PolicyTag`. -Requirements --------------- +### Requirements ### `Traits` is a model for `SpatialSortingTraits`. diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h index 2c30b5d4c42..9c7e66663ae 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h @@ -7,8 +7,7 @@ The function object `Hilbert_sort_3` sorts iterator ranges of `Traits::Point_3` along a Hilbert curve by recursively subdividing at the median or the middle depending on the `PolicyTag`. -Requirements --------------- +### Requirements ### `Traits` is a model for `SpatialSortingTraits_3`. diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h index 9f688f13f2a..01d3f595c95 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h @@ -7,8 +7,7 @@ The function object `Hilbert_sort_d` sorts iterator ranges of `Traits::Point_d` along a Hilbert curve by recursively subdividing at the median or the middle depending on the `PolicyTag`. -Requirements --------------- +### Requirements ### `Traits` is a model for `SpatialSortingTraits_d`. diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h index 4a5ede1a1c6..d40ee2833a5 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_2.h @@ -8,8 +8,7 @@ reorder of the keys instead of the points, the comparisons being done on the ass In other words, the traits provides to a spatial sort algorithm a point type which is a key, while the actual point type is `Base_traits::Point_2`. -Requirements --------------- +### Requirements ### `Base_traits` is a model for `SpatialSortingTraits_2`. `PointPropertyMap` is a model of boost::ReadablePropertyMap diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h index 7ee68f5e3ee..896f20a866b 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_3.h @@ -8,8 +8,7 @@ reorder of the keys instead of the points, the comparisons being done on the ass In other words, the traits provides to a spatial sort algorithm a point type which is a key, while the actual point type is `Base_traits::Point_3`. -Requirements --------------- +### Requirements ### `Base_traits` is a model for `SpatialSortingTraits_3`. `PointPropertyMap` is a model of boost::ReadablePropertyMap diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h index 178d9784c53..30158520849 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Spatial_sort_traits_adapter_d.h @@ -8,8 +8,7 @@ reorder of the keys instead of the points, the comparisons being done on the ass In other words, the traits provides to a spatial sort algorithm a point type which is a key, while the actual point type is `Base_traits::Point_d`. -Requirements --------------- +### Requirements ### `Base_traits` is a model for `SpatialSortingTraits_d`. `PointPropertyMap` is a model of boost::ReadablePropertyMap diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h index b03c1298ebc..f3433fdf4b9 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/hilbert_sort.h @@ -13,8 +13,7 @@ The default traits class `Default_traits` is the kernel in which the type The default policy is `Hilbert_sort_median_policy()` and the other option is `Hilbert_sort_middle_policy()`. -Requirements --------------- +### Requirements ###
                                                                      1. `RandomAccessIterator::value_type` is convertible to @@ -23,8 +22,7 @@ Requirements `SpatialSortingTraits_3`, or `SpatialSortingTraits_d`.
                                                                      -Implementation --------------- +### Implementation ### Creates an instance of `Hilbert_sort_2`, diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h index 5a60fe175a9..15f59d512f7 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/spatial_sort.h @@ -18,8 +18,7 @@ other option is `Hilbert_sort_middle_policy()`. The default values for the thresholds and the ratio depends on the dimension. -Requirements --------------- +### Requirements ###
                                                                      1. `RandomAccessIterator::value_type` is convertible to @@ -28,8 +27,7 @@ Requirements `SpatialSortingTraits_3`, or `SpatialSortingTraits_d`.
                                                                      -Implementation --------------- +### Implementation ### Creates an instance of `Multiscale_sort` where `Hilbert_sort` is an Hilbert sorting object, diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h index cb7014b6e23..cf4d8cae505 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_builder_2.h @@ -33,8 +33,7 @@ namespace CGAL { The class `Straight_skeleton_builder_2` encapsulates the construction of the 2D straight skeleton in the interior of a polygon with holes. Its first template parameter, `Gt`, must be a model of the `StraightSkeletonBuilderTraits_2` concept, its second template parameter, `Ss`, must be a model of the `StraightSkeleton_2` concept, and its third template paramter, `Visitor`, must be a model of the `StraightSkeletonBuilder_2_Visitor` concept. If this last parameter is ommitted, the class `CGAL::Dummy_straight_skeleton_builder_2_visitor` is used. -Algorithm --------------- +### Algorithm ### The implemented algorithm is closely based on \cite cgal:fo-ss-98 with the addition of vertex events as described in \cite cgal:ee-rrccpp-98. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/arrange_offset_polygons_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/arrange_offset_polygons_2.h index 2da530f1c8d..b82f0a340fc 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/arrange_offset_polygons_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/arrange_offset_polygons_2.h @@ -11,8 +11,7 @@ A `CLOCKWISE` oriented polygon \f$ H\f$ is a hole of a `COUNTERCLOCKWISE` polygo This function should not be used to arrange arbitrary polygons into polygons with holes unless they meet the requirements specified below. -Requirements --------------- +### Requirements ###
                                                                      1. `K` is any \cgal kernel. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/compute_outer_frame_margin.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/compute_outer_frame_margin.h index 3489bcae6c4..40c281c2560 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/compute_outer_frame_margin.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/compute_outer_frame_margin.h @@ -35,8 +35,7 @@ The default traits class `Default_traits` is an instance of the class `Polygon_offset_builder_traits_2` parameterized on the kernel in which the type `InputIterator::value_type` is defined. -Requirements --------------- +### Requirements ###
                                                                        1. `InputIterator::value_type` diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_offset_polygons_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_offset_polygons_2.h index c9ec5f8f504..42fc907a3f7 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_offset_polygons_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_offset_polygons_2.h @@ -14,8 +14,7 @@ instead. The exterior skeleton is limited by an outer rectangular frame placed at a margin sufficiently large to allow the offset polygons to be constructed. -Requirements --------------- +### Requirements ### 1. `OffsettingK` is the \cgal kernel used to instantiate `Polygon_offset_builder_traits_2` for constructing diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_straight_skeleton_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_straight_skeleton_2.h index d6b8044f091..c5b27501d10 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_straight_skeleton_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/create_straight_skeleton_2.h @@ -11,8 +11,7 @@ The outer boundary \f$ F\f$ is constructed by enlarging the bounding box of \f$ \f$ d\f$ is a margin sufficiently large to allow an outer offset at dinstance `max_offset` to be obtained from this exterior skeleton, as computed by the function `compute_outer_frame_margin` -Requirements --------------- +### Requirements ###
                                                                          1. `K` is any \cgal kernel. @@ -43,8 +42,8 @@ The function returns a new `Straight_skeleton_2` in the limited exteriorlimited exterior of \f$ P\f$ is the skeleton in the interior of a polygon \f$ Q\f$ with \f$ P\f$ as its hole and a rectangular frame \f$ F\f$ as outer boundary. The outer boundary \f$ F\f$ is constructed by enlarging the bounding box of \f$ P\f$ a distance \f$ d\f$. \f$ d\f$ is a margin sufficiently large to allow an outer offset at dinstance `max_offset` to be obtained from this exterior skeleton, as computed by the function `compute_outer_frame_margin` -Requirements --------------- + +### Requirements ###
                                                                            1. `K` is any \cgal kernel. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h index e4cf84aff6c..4a808a5f0b8 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/VertexContainer_2.h @@ -2,8 +2,7 @@ \ingroup PkgStraightSkeleton2Concepts \cgalconcept -Introduction --------------- +### Introduction ### A model for the `VertexContainer_2` concept defines the requirements for a resizable container of 2D points. It is used to output the offset polygons generated by the `Polygon_offset_builder_2` class. diff --git a/Stream_support/doc/IOstream/CGAL/IO/Istream_iterator.h b/Stream_support/doc/IOstream/CGAL/IO/Istream_iterator.h index 8a937743f58..ba105facbe1 100644 --- a/Stream_support/doc/IOstream/CGAL/IO/Istream_iterator.h +++ b/Stream_support/doc/IOstream/CGAL/IO/Istream_iterator.h @@ -8,8 +8,7 @@ The class `Istream_iterator` is an input iterator adaptor for the input stream class `Stream` and value type `T`. It is particularly useful for classes that are similar but not compatible to `std::istream`. -Operations --------------- +### Operations ### `i` fulfills the requirements for an input iterator. diff --git a/Stream_support/doc/IOstream/CGAL/IO/Ostream_iterator.h b/Stream_support/doc/IOstream/CGAL/IO/Ostream_iterator.h index 13effdf1e4f..bb3d198c1c1 100644 --- a/Stream_support/doc/IOstream/CGAL/IO/Ostream_iterator.h +++ b/Stream_support/doc/IOstream/CGAL/IO/Ostream_iterator.h @@ -5,15 +5,13 @@ namespace CGAL { \ingroup PkgIOstreams The class `Ostream_iterator` is an output iterator adaptor for the -output stream class `Stream` and value type \f$ T\f$. +output stream class `Stream` and value type `T`. -Operations --------------- +### Operations ### `o` fulfills the requirements for an output iterator. -Implementation --------------- +### Implementation ### The `operator*()` in class `Ostream_iterator` uses a proxy class. @@ -27,7 +25,7 @@ public: /*! creates an output -iterator `o` writing to \f$ s\f$. +iterator `o` writing to `s`. */ Ostream_iterator( Stream& s); diff --git a/Stream_support/doc/IOstream/CGAL/IO/Verbose_ostream.h b/Stream_support/doc/IOstream/CGAL/IO/Verbose_ostream.h index e4728f70ba8..cd69db1a925 100644 --- a/Stream_support/doc/IOstream/CGAL/IO/Verbose_ostream.h +++ b/Stream_support/doc/IOstream/CGAL/IO/Verbose_ostream.h @@ -11,8 +11,7 @@ output is active or not. If the state is active, the stream output operator `<<` uses the internal stream to output its argument. If the state is inactive, nothing happens. -Example --------------- +### Example ### The class `Verbose_ostream` can be conveniently used to implement for example the `is_valid()` member function for triangulations or diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h index 303a4c37675..dc840af0ea8 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h @@ -14,8 +14,7 @@ It can have any number of connected components, boundaries \refines ::HalfedgeGraph -Valid Expressions --------------- +### Valid Expressions ### The mesh simplification algorithm requires the free function `collapse_triangulation_edge()`. diff --git a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h index bd9d2adc1be..c482f1566a4 100644 --- a/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h +++ b/Triangulation_2/doc/TDS_2/CGAL/Triangulation_data_structure_2.h @@ -16,16 +16,14 @@ additional template parameters. \models ::TriangulationDataStructure_2 -Modifiers --------------- +### Modifiers ### In addition to the modifiers required by the `TriangulationDataStructure_2` concept, the `Triangulation_data_structure_2` class supports also the modifiers below. Note also that the modifiers below guarantee the combinatorial validity of the resulting data structure. -Illustrations ---------------- +### Illustrations ### \anchor figtdssplitjoin \image html join_split.gif "The join and split operations." diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h index 1001eee44af..94cea3eb4bf 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h @@ -45,8 +45,7 @@ Insertion of a new vertex in a given face, or in a given edge, suppression of a vertex of degree three, flip of two edges are examples of combinatorial operations. -I/O --------------- +### I/O ### The information output in the `iostream` is: the dimension, the number of (finite) vertices, @@ -89,8 +88,7 @@ when using the triangulation data structure class alone. They became required when the triangulation data structure is plugged into a triangulation. -Creation --------------- +### Creation ### In order to obtain new vertices or destruct unused vertices, the user must call the `create_vertex()` and `delete_vertex()` methods of the @@ -198,15 +196,13 @@ of maximal dimension of the complex Only vertices and neighbors with index \f$ 0\f$ are set in the first case, only vertices and neighbors with index \f$ 0\f$ or \f$ 1\f$ are set in the second case. -Types --------------- +### Types ### The class `TriangulationDataStructure_2::Face` defines the same types as the triangulation data structure except the iterators and the circulators. -Creation --------------- +### Creation ### The methods `create_face` and `delete_face()` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h index a3716354d87..bccb149d4c9 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_Delaunay_triangulation_2.h @@ -87,8 +87,8 @@ triangulation data structure parameter is the class `CGAL::Triangulation_data_structure_2< CGAL::Triangulation_vertex_base_2, CGAL::Constrained_triangulation_face_base_2 >`. The default intersection tag is `CGAL::No_intersection_tag`. -Types --------------- +### Types ### + All types used in this class are inherited from the base class `Constrained_triangulation_2`. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h index 7c7d1148022..37317b41850 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h @@ -113,8 +113,7 @@ The default intersection tag is `CGAL::No_intersection_tag`. \sa `ConstrainedTriangulationTraits_2` \sa `ConstrainedTriangulationFaceBase_2` -Implementation --------------- +### Implementation ### The insertion of a constrained edge runs in time proportional to the number of triangles intersected by this edge. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h index 2a762baa173..64c8fb0a13a 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_face_base_2.h @@ -10,8 +10,7 @@ of constrained triangulations. \models ::ConstrainedTriangulationFaceBase_2 -Parameters --------------- +### Parameters ### The first template parameter is a geometric traits. @@ -19,11 +18,10 @@ The second template parameter has to be a model of the concept `TriangulationFaceBase_2`. Its default is `CGAL::Triangulation_face_base_2` -Inherits From --------------- +### Inherits From ### The class `Constrained_triangulation_face_base_2` derives from its -parameter `Fb`. and add three Boolean to deal with information about +parameter `Fb`. It adds three Boolean to deal with information about constrained edges. The member functions `cw(int i)`, `ccw(int i)` diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h index e06ded0f119..82ff1038971 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h @@ -17,8 +17,7 @@ of more than three points, the Delaunay triangulation is unique, it is the dual of the Voronoi diagram of the points. -Parameters --------------- +### Parameters ### The template parameter `Tds` is to be instantiated with a model of @@ -55,13 +54,11 @@ instantiated with `Delaunay_triangulation_2`. The triangulation hierarchy will then offer the same functionalities but be much more for efficient for locations and insertions. -Types --------------- +### Types ### Inherits all the types defined in `Triangulation_2`. -Implementation --------------- +### Implementation ### Insertion is implemented by inserting in the triangulation, then performing a sequence of Delaunay flips. The number of flips is \f$ O(d)\f$ diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h index a0822ca1fa4..23366af1b78 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h @@ -107,8 +107,7 @@ the list of hidden vertices whose points are located in the facet. When a facet is removed, points hidden by this facet are reinserted in the triangulation. -Parameters --------------- +### Parameters ### The geometric traits parameter `Traits` has to be instantiated with a model of the concept diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h index fa93751aa48..e4e215092ff 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_face_base_2.h @@ -8,8 +8,7 @@ The class `Regular_triangulation_face_base_2` is a model of the concept `RegularTriangulationFaceBase_2`. It is the default face base class of regular triangulations. -Parameters --------------- +### Parameters ### The template parameters `Traits` has to be a model of `RegularTriangulationTraits_2`. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h index 1fc46494349..c4908af8efc 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_vertex_base_2.h @@ -8,8 +8,7 @@ The class `Regular_triangulation_vertex_base_2` is a model of the concept `RegularTriangulationVertexBase_2`. It is the default vertex base class of regular triangulations. -Parameters --------------- +### Parameters ### The template parameters `Traits` has to be a model of `RegularTriangulationTraits_2`. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h index 75fbaa9fd6f..da7b83c32b8 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h @@ -70,8 +70,7 @@ of `f` (see Figure \ref Triangulation_ref_Fig_neighbors). \anchor Triangulation_ref_Fig_neighbors \image html neighbors.gif "Vertices and neighbors." -Parameters --------------- +### Parameters ### The class `Triangulation_2` has two template parameters. The first one `Traits` is the geometric traits, it is to be instantiated by @@ -83,15 +82,13 @@ it has to be instantiated by a model of the concept By default, the triangulation data structure is instantiated by `CGAL::Triangulation_data_structure_2 < CGAL::Triangulation_vertex_base_2, CGAL::Triangulation_face_base_2 >`. -Traversal of the Triangulation --------------- +### Traversal of the Triangulation ### A triangulation can be seen as a container of faces and vertices. Therefore the triangulation provides several iterators and circulators that allow to traverse it (completely or partially). -Traversal of the Convex Hull ----------------------------- +### Traversal of the Convex Hull ### Applied on the `infinite_vertex` the above functions allow to visit the vertices on the convex hull and the infinite edges and faces. Note @@ -111,8 +108,7 @@ Vertex_circulator incident_vertices(t.infinite_vertex() v) ; Vertex_circulator incident_vertices(t.infinite_vertex(), f) ; \endcode -I/O --------------- +### I/O ### The I/O operators are defined for `iostream`. The format for the iostream @@ -138,8 +134,7 @@ the rank of this item in the output order. When dimension \f$ <\f$ 2, the same information is output for faces of maximal dimension instead of faces. -Implementation --------------- +### Implementation ### Locate is implemented by a line walk from a vertex of the face given as optional parameter (or from a finite vertex of diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_xy_3.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_xy_3.h index c3589ecbeed..e1856c10514 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_xy_3.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_euclidean_traits_xy_3.h @@ -23,16 +23,14 @@ except that it does not provide the type and constructors required to build the dual Voronoi diagram. The class is also a model of the concept `ConstrainedTriangulationTraits_2`. -Parameters --------------- +### Parameters ### The template parameter `K` has to be instantiated by a model of the `Kernel` concept. `Triangulation_euclidean_traits_xy_3` uses types and predicates defined in `K`. -Access to predicate objects --------------- +### Access to Predicate Objects ### The following access functions are provided diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h index c3e830c56cf..59d37ac72d0 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_2.h @@ -12,8 +12,7 @@ These default base class can be used directly or can serve as a base to derive other base classes with some additional attribute (a color for example) tuned for specific applications. -Parameters --------------- +### Parameters ### The first template parameter of `Triangulation_face_base_2` is a geometric traits class. The geometric traits is actually not used by the class. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h index 4cbe91c929e..ce331ae7300 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_face_base_with_info_2.h @@ -10,8 +10,7 @@ triangulation data structure of a triangulation class. It provides an easy way to add some user defined information in the faces of a triangulation. -Parameters --------------- +### Parameters ### The first template argument is the information the user would like to add to a face. It has to be `DefaultConstructible` and `Assignable`. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h index 72615c43cd9..603ea69aa64 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_hierarchy_2.h @@ -34,8 +34,7 @@ The class `Triangulation_hierarchy_2` is templated by a parameter which is to be instantiated by anyone of the \cgal triangulation classes. -Types --------------- +### Types ### The class `Triangulation_hierarchy_2` inherits the types from its base triangulation class `Tr`. diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h index 0632fdbe2e1..88d1533a89f 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_2.h @@ -12,8 +12,7 @@ structure of a triangulation, or used as a base class to derive other base vertex classes tuned for specific applications. -Parameters --------------- +### Parameters ### `Triangulation_vertex_base_2` is templated by a geometric traits class which provide the type `Point`. It is strongly recommended to instantiate this diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h index 6a5ead2b89e..c25f8147eb6 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_vertex_base_with_info_2.h @@ -7,8 +7,7 @@ namespace CGAL { The class `Triangulation_vertex_base_with_info_2` is designed to be used as a base vertex class of a triangulation. It provides an easy way to add some user defined information in vertices. -Parameters --------------- +### Parameters ### The first template parameter is the information the user would like to add to a vertex. It has to be `DefaultConstructible` and `Assignable`. diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h index 14fd041480d..a46b13ee0d7 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h @@ -64,8 +64,7 @@ this use as a template parameter of `Triangulation_3`.
                                                                              A class that satisfies the requirements for a triangulation data structure class must provide the following types and operations. -I/O --------------- +### I/O ### The information stored in the `iostream` is: the dimension, the number of vertices, the number of cells, @@ -96,8 +95,7 @@ when using the triangulation data structure class alone. They become compulsory when the triangulation data structure is used as a layer for the geometric triangulation class. (See Section \ref TDS3secdesign.) -Creation --------------- +### Creation ### In order to obtain new vertices or destruct unused vertices, the user must call the `create_vertex()` and `delete_vertex()` methods of the @@ -202,8 +200,7 @@ facet of index 3, and 3 edges \f$ (0,1)\f$, \f$ (1,2)\f$ and \f$ (2,0)\f$; in dimension 1, each cell represents one edge \f$ (0,1)\f$. (See also Section \ref TDS3secintro.) -Creation --------------- +### Creation ### In order to obtain new cells or destruct unused cells, the user must call the `create_cell()` and `delete_cell()` methods of the triangulation data diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h index b76cab14cac..a85fe913098 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h @@ -7,8 +7,7 @@ namespace CGAL { The class `Delaunay_triangulation_3` represents a three-dimensional Delaunay triangulation. -Parameters --------------- +### Parameters ### The first template argument must be a model of the `DelaunayTriangulationTraits_3` concept. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h index 78f0c010ffa..ac12cc6c8e1 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h @@ -27,8 +27,7 @@ the power sphere. A sphere \f$ {z}^{(w)}\f$ is said to be A triangulation of \f$ {S}^{(w)}\f$ is regular if the power spheres of all simplices are regular. -Parameters --------------- +### Parameters ### The first template argument must be a model of the `RegularTriangulationTraits_3` concept. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h index 4b79b393331..cc3f2779f49 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_cell_base_3.h @@ -8,8 +8,7 @@ The class `Regular_triangulation_cell_base_3` is a model of the concept `RegularTriangulationCellBase_3`. It is the default face base class of regular triangulations. -Parameters --------------- +### Parameters ### The template parameters `Traits` has to be a model of `RegularTriangulationTraits_3`. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h index fadf5cefea9..d31aaee79ed 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_euclidean_traits_3.h @@ -26,8 +26,7 @@ of that class is set to `true`. \models ::RegularTriangulationTraits_3 -Operations --------------- +### Operations ### The following functions give access to the predicate and constructor functors. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h index 1b3c9ff1fda..b7bd4834678 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h @@ -7,8 +7,7 @@ namespace CGAL { The class `Triangulation_3` represents a 3-dimensional tetrahedralization of points. -Parameters --------------- +### Parameters ### The first template argument must be a model of the `TriangulationTraits_3` concept. @@ -17,8 +16,7 @@ The second template argument must be a model of the `TriangulationDataStructure_3` concept. It has the default value `Triangulation_data_structure_3< Triangulation_vertex_base_3,Triangulation_cell_base_3 >`. -Traversal of the Triangulation --------------- +### Traversal of the Triangulation ### The triangulation class provides several iterators and circulators that allow one to traverse it (completely or partially). diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h index 7a605759d3e..063357c7169 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_3.h @@ -11,8 +11,7 @@ This class can be used directly or can serve as a base to derive other classes with some additional attributes (a color for example) tuned for a specific application. -Parameters --------------- +### Parameters ### The first template argument is the geometric traits class `TriangulationTraits_3`. It is actually not used by this class. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h index 982d9598bb4..5dec73fd468 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_circumcenter_3.h @@ -13,8 +13,7 @@ Note that input/output operators discard this additional information. All functions modifying the vertices of the cell, invalidate the cached circumcenter. -Parameters --------------- +### Parameters ### The first template argument is the geometric traits class `DelaunayTriangulationTraits_3`. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h index 634c6f7e70b..8434469adee 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_cell_base_with_info_3.h @@ -9,8 +9,7 @@ The class `Triangulation_cell_base_with_info_3` is a model of the concept It provides an easy way to add some user defined information in cells. Note that input/output operators discard this additional information. -Parameters --------------- +### Parameters ### The first template argument is the information the user would like to add to a cell. It has to be `DefaultConstructible` and `Assignable`. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_3.h index 5a2ff4f02ef..64c48ec36fc 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_3.h @@ -14,8 +14,7 @@ with a data structure which allows fast point location queries. As proved in \cite cgal:d-dh-02, this structure has an optimal behavior when it is built for Delaunay triangulations. It can however be used for other triangulations. -Parameters --------------- +### Parameters ### It is templated by a parameter which must be instantiated by one of the \cgal triangulation classes. In the current implementation, only `Delaunay_triangulation_3` is supported for `Tr`. @@ -39,8 +38,7 @@ hierarchy into a file will lose the hierarchic structure and reading it from the file will result in an ordinary triangulation whose efficiency will be the same as `Tr`. -Implementation --------------- +### Implementation ### The data structure is a hierarchy of triangulations. The triangulation at the lowest level is diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h index 4f0fb1cddbe..b1d00b80e80 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_hierarchy_vertex_base_3.h @@ -19,8 +19,7 @@ requirements in order to match the concept provided by \cgal, or a user customized vertex base with additional functionalities. -Parameters --------------- +### Parameters ### It is parameterized by a model of the concept `TriangulationVertexBase_3`. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_simplex_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_simplex_3.h index e24ff752adf..f5704a34de5 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_simplex_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_simplex_3.h @@ -12,8 +12,7 @@ operator less such that simplices can be stored in a `map` or a `set` of simplices. The simplex is invalidated by any change in the triangulation. -Parameters --------------- +### Parameters ### It is parameterized by the triangulation it derives the simplices from. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h index d03d6302962..a63134dc62a 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_3.h @@ -12,8 +12,7 @@ This class can be used directly or can serve as a base to derive other classes with some additional attributes (a color for example) tuned for a specific application. -Parameters --------------- +### Parameters ### The first template argument is the geometric traits class `TriangulationTraits_3` which provides the point type, `Point_3`. diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h index 45b5f14f149..d0c198e8feb 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_vertex_base_with_info_3.h @@ -9,8 +9,7 @@ The class `Triangulation_vertex_base_with_info_3` is a model of the concept It provides an easy way to add some user defined information in vertices. Note that input/output operators discard this additional information. -Parameters --------------- +### Parameters ### The first template argument is the information the user would like to add to a vertex. It has to be `DefaultConstructible` and `Assignable`. diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h index d8b9d7c4dbb..8719781c214 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/DelaunayGraph_2.h @@ -11,8 +11,7 @@ that the Voronoi diagram adaptor can adapt it. \refines ::DefaultConstructible, \refines ::CopyConstructible, \refines ::Assignable -Traversal of the Delaunay graph --------------- +### Traversal of the Delaunay graph ### A model of the `DelaunayGraph_2` concept must provide several iterators and circulators that allow to traverse it (completely or