From 95f76980496d37da4b22f7d7824ecc96844dca5c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Mon, 25 Jul 2016 11:42:15 +0200 Subject: [PATCH] require validity of the input in the doc + improve changes --- .../doc/Generator/CGAL/point_generators_2.h | 6 +++-- .../doc/Generator/CGAL/point_generators_3.h | 7 ++++-- Installation/changes.html | 25 +++++++++++-------- 3 files changed, 23 insertions(+), 15 deletions(-) diff --git a/Generator/doc/Generator/CGAL/point_generators_2.h b/Generator/doc/Generator/CGAL/point_generators_2.h index e3347988b93..051bea7f5db 100644 --- a/Generator/doc/Generator/CGAL/point_generators_2.h +++ b/Generator/doc/Generator/CGAL/point_generators_2.h @@ -354,6 +354,7 @@ typedef const Point_2& reference; The class `Random_points_in_triangle_mesh_2` is an input iterator creating points uniformly distributed inside a 2D domain represented by a 2D triangulation. Triangulation must be a \cgal triangulation with a face model of `DelaunayMeshFaceBase_2`. The sampled model is the union of the faces for which `DelaunayMeshFaceBase_2::is_in_domain()` returns `true`. + The triangulation must be valid and unchanged while the iterator is used. \cgalModels `InputIterator` @@ -420,9 +421,10 @@ default_random); }; /* end Random_points_in_triangle_mesh_2 */ - /*! +/*! - The class `Random_points_in_triangles_2` is an input iterator creating points uniformly distributed inside a range of `Triangle_2`. The range must remain valid. + The class `Random_points_in_triangles_2` is an input iterator creating points uniformly distributed inside a range of `Triangle_2`. + The triangle range must be valid and unchanged while the iterator is used. \cgalModels `InputIterator` diff --git a/Generator/doc/Generator/CGAL/point_generators_3.h b/Generator/doc/Generator/CGAL/point_generators_3.h index cc15c553bff..d38f0e954a8 100644 --- a/Generator/doc/Generator/CGAL/point_generators_3.h +++ b/Generator/doc/Generator/CGAL/point_generators_3.h @@ -335,7 +335,8 @@ namespace CGAL { /*! -The class `Random_points_in_triangles_3` is an input iterator creating points uniformly distributed inside a range of `Triangle_3`. The range must remain valid. +The class `Random_points_in_triangles_3` is an input iterator creating points uniformly distributed inside a range of `Triangle_3`. +The triangle range must be valid and unchanged while the iterator is used. \cgalModels `InputIterator` @@ -409,6 +410,7 @@ namespace CGAL { The class `Random_points_on_triangle_mesh_3` is an input iterator creating points uniformly distributed inside the faces of a triangle mesh model of `FaceListGraph`. +The triangle mesh must be valid and unchanged while the iterator is used. \cgalModels `InputIterator` \cgalModels `PointGenerator` @@ -482,6 +484,7 @@ namespace CGAL { The class `Random_points_on_tetrahedral_mesh_boundary_3` is an input iterator creating points uniformly distributed on the boundary of a tetrahedral mesh of type `Mesh_complex_3_in_triangulation_3`. +The tetrahedral mesh must be valid and unchanged while the iterator is used. C3T3 is a model of `Mesh_complex_3_in_triangulation_3` \cgalModels `InputIterator` @@ -554,7 +557,7 @@ namespace CGAL { The class `Random_points_in_tetrahedral_mesh_3` is an input iterator creating points uniformly distributed inside a tetrahedral mesh of type `Mesh_complex_3_in_triangulation_3`. - +The tetrahedral mesh must be valid and unchanged while the iterator is used. C3T3 is a model of `Mesh_complex_3_in_triangulation_3` \cgalModels `InputIterator` diff --git a/Installation/changes.html b/Installation/changes.html index eb1f847bca0..3e40ee68c67 100644 --- a/Installation/changes.html +++ b/Installation/changes.html @@ -158,11 +158,14 @@ and src/ directories).

Random Point Generators

@@ -983,15 +986,15 @@ and src/ directories). longer supported since CGAL-4.5. -
  • Since CGAL version 4.0, Eigen was the recommended third-party +
  • Since CGAL version 4.0, Eigen was the recommended third-party library to use with Planar Parameterization of Triangulated Surface Meshes, Surface Reconstruction from Point Sets, Approximation of Ridges and Umbilics on Triangulated Surface Meshes, and Estimation of Local Differential Properties of Point-Sampled Surfaces packages. From CGAL - version 4.5, Taucs, Blas and Lapack are no longer supported. + version 4.5, Taucs, Blas and Lapack are no longer supported.
    • -
  • CGAL is now compatible with the new CMake version 3.0.
    • +
  • CGAL is now compatible with the new CMake version 3.0.
    • @@ -1184,7 +1187,7 @@ and src/ directories).
  • Additional supported platforms: @@ -1358,7 +1361,7 @@ and src/ directories). constructor added to CGAL::Object. However, it is recommended to upgrade your code. The previous behavior can be restored by defining the - macro CGAL_INTERSECTION_VERSION to 1. + macro CGAL_INTERSECTION_VERSION to 1.

    • 2D Arrangements

    @@ -1682,7 +1685,7 @@ and src/ directories).
  • Additional supported platforms:
  • Improved configuration for essential and optional external third party software