diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt index 1d0458662e1..65f3c2b2171 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/PackageDescription.txt @@ -32,4 +32,23 @@ radius, and for insetting a polygon (namely computing its inner offset). It is possible to compute the exact representation of the offset (or the inset), or to approximate it with guaranteed error bounds, in order to speed up the computation time. + +\cgalClassifedRefPages + +## Functions ## +- `CGAL::minkowski_sum_2()` +- `CGAL::approximated_offset_2()` +- `CGAL::approximated_inset_2()` +- `CGAL::offset_polygon_2()` +- `CGAL::inset_polygon_2()` + +## Concepts ## +- `PolygonConvexDecomposition_2` + +## Classes ## +- `CGAL::Small_side_angle_bisector_decomposition_2` +- `CGAL::Optimal_convex_decomposition_2` +- `CGAL::Hertel_Mehlhorn_convex_decomposition_2` +- `CGAL::Greene_convex_decomposition_2` + */ diff --git a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt index 7cea4186020..9eae49820cd 100644 --- a/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt +++ b/Minkowski_sum_3/doc/Minkowski_sum_3/PackageDescription.txt @@ -18,5 +18,11 @@ \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Functions ## +- `CGAL::minkowski_sum_3()` + */ diff --git a/Miscellany/doc/Miscellany/PackageDescription.txt b/Miscellany/doc/Miscellany/PackageDescription.txt index fef902332fa..4e1880df2de 100644 --- a/Miscellany/doc/Miscellany/PackageDescription.txt +++ b/Miscellany/doc/Miscellany/PackageDescription.txt @@ -17,6 +17,23 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages + +## Concepts ## +- `UniqueHashFunction` + +## Classes ## +- `CGAL::Timer` +- `CGAL::Real_timer` +- `CGAL::Memory_sizer` +- `CGAL::Profile_counter` + +- `CGAL::Unique_hash_map` +- `CGAL::Handle_hash_function` + +- `CGAL::Union_find` + +- `CGAL::Modifier_base` */ diff --git a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt index 1344d585162..d8e0e08bb58 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt +++ b/Modular_arithmetic/doc/Modular_arithmetic/PackageDescription.txt @@ -17,5 +17,17 @@ \cgalPkgLicense{\ref licensesLGPL "LGPL"} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd -*/ +\cgalClassifedRefPages + +## Concepts ## +- `Modularizable` +- `ModularTraits` +- `ModularTraits::ModularImage` +- `ModularTraits::ModularImageRepresentative` + +## Types ## +- `CGAL::Residue` +- `CGAL::Modular_traits` + +*/ diff --git a/Nef_2/doc/Nef_2/PackageDescription.txt b/Nef_2/doc/Nef_2/PackageDescription.txt index 5a9c9bca900..0ba157bc7bb 100644 --- a/Nef_2/doc/Nef_2/PackageDescription.txt +++ b/Nef_2/doc/Nef_2/PackageDescription.txt @@ -19,5 +19,18 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages + +## Concepts ## +- `ExtendedKernelTraits_2` + +## Classes ## +- `CGAL::Extended_cartesian` +- `CGAL::Extended_homogeneous` +- `CGAL::Filtered_extended_homogeneous` +- `CGAL::Nef_polyhedron_2` +- \link CGAL::Nef_polyhedron_2::Explorer `CGAL::Nef_polyhedron_2::Explorer` \endlink +- \link CGAL::Nef_polyhedron_2::Topological_explorer `CGAL::Nef_polyhedron_2::Topological_explorer` \endlink + */ diff --git a/Nef_3/doc/Nef_3/CGAL/IO/Nef_polyhedron_iostream_3.h b/Nef_3/doc/Nef_3/CGAL/IO/Nef_polyhedron_iostream_3.h index ff58364fd7b..b0b4a81f7f9 100644 --- a/Nef_3/doc/Nef_3/CGAL/IO/Nef_polyhedron_iostream_3.h +++ b/Nef_3/doc/Nef_3/CGAL/IO/Nef_polyhedron_iostream_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgNef3 +\ingroup PkgNef3IOFunctions This operator reads a Nef polyhedron, which is given in the proprietary file format written by the input operator in and assigns it to N. It includes the @@ -25,7 +25,7 @@ istream& operator>>( std::istream& in, CGAL::Nef_polyhedron_3& N); /*! -\ingroup PkgNef3 +\ingroup PkgNef3IOFunctions This operator writes the Nef polyhedron `N` to the output stream `out` using a proprietary file format. It includes the complete incidence diff --git a/Nef_3/doc/Nef_3/CGAL/OFF_to_nef_3.h b/Nef_3/doc/Nef_3/CGAL/OFF_to_nef_3.h index 9e394a314cb..e549dcf3997 100644 --- a/Nef_3/doc/Nef_3/CGAL/OFF_to_nef_3.h +++ b/Nef_3/doc/Nef_3/CGAL/OFF_to_nef_3.h @@ -1,7 +1,7 @@ namespace CGAL { /*! -\ingroup PkgNef3 +\ingroup PkgNef3IOFunctions This function creates a 3D Nef polyhedron from an OFF file which is read from input stream `in`. The purpose of `OFF_to_nef_3` diff --git a/Nef_3/doc/Nef_3/PackageDescription.txt b/Nef_3/doc/Nef_3/PackageDescription.txt index a9fad64c6c9..13b8f04a7f8 100644 --- a/Nef_3/doc/Nef_3/PackageDescription.txt +++ b/Nef_3/doc/Nef_3/PackageDescription.txt @@ -1,6 +1,11 @@ /// \defgroup PkgNef3 3D Boolean Operations on Nef Polyhedra Reference /// \defgroup PkgNef3Concepts Concepts /// \ingroup PkgNef3 +/// +/// \defgroup PkgNef3IOFunctions I/O Functions +/// \ingroup PkgNef3 + + /*! \addtogroup PkgNef3 \todo check generated documentation @@ -40,5 +45,24 @@ elements and their connectivity. We provide affine (rigid) tranformations and a point location query operation. We have a custom file format for storing and reading Nef polyhedra from files. We offer a simple OpenGL visualization for debugging and illustrations. + +\cgalClassifedRefPages + +## Classes ## +- `CGAL::Nef_polyhedron_3` +- \link CGAL::Nef_polyhedron_3::Vertex `CGAL::Nef_polyhedron_3::Vertex` \endlink +- \link CGAL::Nef_polyhedron_3::Halfedge `CGAL::Nef_polyhedron_3::Halfedge` \endlink +- \link CGAL::Nef_polyhedron_3::Halffacet `CGAL::Nef_polyhedron_3::Halffacet` \endlink +- \link CGAL::Nef_polyhedron_3::Volume `CGAL::Nef_polyhedron_3::Volume` \endlink +- \link CGAL::Nef_polyhedron_3::SHalfedge `CGAL::Nef_polyhedron_3::SHalfedge` \endlink +- \link CGAL::Nef_polyhedron_3::SHalfloop `CGAL::Nef_polyhedron_3::SHalfloop` \endlink +- \link CGAL::Nef_polyhedron_3::SFace `CGAL::Nef_polyhedron_3::SFace` \endlink +- \link CGAL::Nef_polyhedron_3::SFace_cycle_iterator `CGAL::Nef_polyhedron_3::SFace_cycle_iterator` \endlink + +## Functions ## +- `CGAL::OFF_to_nef_3()` +- \link PkgNef3IOFunctions `CGAL::operator<<()` \endlink +- \link PkgNef3IOFunctions `CGAL::operator>>()` \endlink + */ diff --git a/Nef_S2/doc/Nef_S2/PackageDescription.txt b/Nef_S2/doc/Nef_S2/PackageDescription.txt index 8b56d607d24..d5a2141c82d 100644 --- a/Nef_S2/doc/Nef_S2/PackageDescription.txt +++ b/Nef_S2/doc/Nef_S2/PackageDescription.txt @@ -47,5 +47,7 @@ items are denoted as \em svertex, \em shalfedge and \em sface, analogous to their counterparts in `CGAL::Nef_polyhedron_2`. Additionally, there is the shalfloop representing the great circles. +\cgalClassifedRefPages + */ diff --git a/Number_types/doc/Number_types/PackageDescription.txt b/Number_types/doc/Number_types/PackageDescription.txt index 77a97ce3dc3..678060fb0e7 100644 --- a/Number_types/doc/Number_types/PackageDescription.txt +++ b/Number_types/doc/Number_types/PackageDescription.txt @@ -48,6 +48,8 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages + ## Number Type Classes and Concepts ## - \link int.h `int` \endlink diff --git a/Partition_2/doc/Partition_2/PackageDescription.txt b/Partition_2/doc/Partition_2/PackageDescription.txt index 18073443b1f..7ea2dfd67f7 100644 --- a/Partition_2/doc/Partition_2/PackageDescription.txt +++ b/Partition_2/doc/Partition_2/PackageDescription.txt @@ -67,5 +67,39 @@ and validity of the partition (i.e., the partition polygons are nonoverlapping and the union of these polygons is the same as the original polygon). +\cgalClassifedRefPages + +## Concepts ## +- `ConvexPartitionIsValidTraits_2` +- `IsYMonotoneTraits_2` +- `OptimalConvexPartitionTraits_2` +- `PartitionTraits_2` +- `PartitionIsValidTraits_2` +- `YMonotonePartitionIsValidTraits_2` +- `YMonotonePartitionTraits_2` + +## Function Object Concepts ## +- `PolygonIsValid` + +## Classes ## +- `CGAL::Partition_is_valid_traits_2` +- `CGAL::Partition_traits_2` + + +## Function Object Classes ## +- `CGAL::Is_convex_2` +- `CGAL::Is_vacuously_valid` +- `CGAL::Is_y_monotone_2` + +## Functions ## +- `CGAL::approx_convex_partition_2()` +- `CGAL::convex_partition_is_valid_2()` +- `CGAL::greene_approx_convex_partition_2()` +- `CGAL::is_y_monotone_2()` +- `CGAL::optimal_convex_partition_2()` +- `CGAL::partition_is_valid_2()` +- `CGAL::y_monotone_partition_2()` +- `CGAL::y_monotone_partition_is_valid_2()` + */ diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt index 1c4b3711c8b..6c4d3a5daa9 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/PackageDescription.txt @@ -65,6 +65,8 @@ both inside and outside the original domain we store an additional offset information in each vertex of a cell. These offsets are models of the concept `Periodic_3Offset_3`. +\cgalClassifedRefPages + ## Concepts ## - `Periodic_3DelaunayTriangulationTraits_3` diff --git a/Point_set_2/doc/Point_set_2/PackageDescription.txt b/Point_set_2/doc/Point_set_2/PackageDescription.txt index 0c696216efb..dfaa3b58a2b 100644 --- a/Point_set_2/doc/Point_set_2/PackageDescription.txt +++ b/Point_set_2/doc/Point_set_2/PackageDescription.txt @@ -38,6 +38,18 @@ templated by the type of a \cgal Delaunay triangulation and provide functionality similar to the corresponding member functions of the point set class. +\cgalClassifedRefPages + +## Concepts ## +- `PointSetTraits` + +## Classes ## +- `CGAL::Point_set_2` + +## Functions ## +- `CGAL::nearest_neighbor()` +- `CGAL::nearest_neighbors()` +- `CGAL::range_search()` */ diff --git a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt index 53be31076f2..deb7c517af7 100644 --- a/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt +++ b/Point_set_processing_3/doc/Point_set_processing_3/PackageDescription.txt @@ -19,7 +19,22 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages +## Functions ## + +- `CGAL::read_off_points()` +- `CGAL::read_xyz_points()` +- `CGAL::compute_average_spacing()` +- `CGAL::remove_outliers()` +- `CGAL::grid_simplify_point_set()` +- `CGAL::random_simplify_point_set()` +- `CGAL::jet_smooth_point_set()` +- `CGAL::jet_estimate_normals()` +- `CGAL::pca_estimate_normals()` +- `CGAL::mst_orient_normals()` +- `CGAL::write_off_points()` +- `CGAL::write_xyz_points()` */ diff --git a/Polygon/doc/Polygon/PackageDescription.txt b/Polygon/doc/Polygon/PackageDescription.txt index 6bb4d38b4dd..ae51ecd824e 100644 --- a/Polygon/doc/Polygon/PackageDescription.txt +++ b/Polygon/doc/Polygon/PackageDescription.txt @@ -28,5 +28,28 @@ The assertion flags for the polygons and polygon operations use `POLYGON` in their names (e.g., `CGAL_POLYGON_NO_ASSERTIONS`). + +\cgalClassifedRefPages + +## Concepts ## +- `PolygonTraits_2` + +## Classes ## +- `CGAL::Polygon_2` + +## Global Functions ## +- `CGAL::area_2()` +- `CGAL::bbox_2()` +- `CGAL::bottom_vertex_2()` +- `CGAL::bounded_side_2()` +- `CGAL::is_convex_2()` +- `CGAL::is_simple_2()` +- `CGAL::left_vertex_2()` +- `CGAL::orientation_2()` +- `CGAL::oriented_side_2()` +- `CGAL::polygon_area_2()` +- `CGAL::right_vertex_2()` +- `CGAL::top_vertex_2()` + */ diff --git a/Polygon/include/CGAL/Polygon_2/Polygon_2_algorithms_impl.h b/Polygon/include/CGAL/Polygon_2/Polygon_2_algorithms_impl.h index 86e182724b5..980708e74a8 100644 --- a/Polygon/include/CGAL/Polygon_2/Polygon_2_algorithms_impl.h +++ b/Polygon/include/CGAL/Polygon_2/Polygon_2_algorithms_impl.h @@ -29,6 +29,8 @@ #include #include +/// \cond SKIP_IN_MANUAL + namespace CGAL { @@ -439,3 +441,5 @@ Orientation orientation_2(ForwardIterator first, } } //namespace CGAL + +/// \endcond diff --git a/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h b/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h index 20283a5800f..a2d0225b974 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h +++ b/Polyhedron/doc/Polyhedron/CGAL/IO/Polyhedron_iostream.h @@ -2,6 +2,7 @@ namespace CGAL { /*! \relates Polyhedron_3 +\ingroup PkgPolyhedronIOFunc This operator reads a polyhedral surface in Object File Format, OFF, with file extension .off, which is also understood by @@ -35,6 +36,8 @@ std::istream& operator>>( std::istream& in, CGAL::Polyhedron_3.off, which is also understood by GeomView \cite cgal:p-gmgv16-96. The diff --git a/Polyhedron/doc/Polyhedron/PackageDescription.txt b/Polyhedron/doc/Polyhedron/PackageDescription.txt index e39bb1dbcea..99315ba912b 100644 --- a/Polyhedron/doc/Polyhedron/PackageDescription.txt +++ b/Polyhedron/doc/Polyhedron/PackageDescription.txt @@ -1,6 +1,9 @@ /// \defgroup PkgPolyhedron 3D Polyhedral Surface Reference /// \defgroup PkgPolyhedronConcepts Concepts /// \ingroup PkgPolyhedron + +/// \defgroup PkgPolyhedronIOFunc I/O Functions +/// \ingroup PkgPolyhedron /*! \addtogroup PkgPolyhedron \todo check generated documentation @@ -37,5 +40,26 @@ design of the halfedge data structure, see the reference for or \cite k-ugpdd-99, but the default instantiation of the polyhedral surface can be used without knowing the halfedge data structure. +\cgalClassifedRefPages + +## Concepts ## +- `PolyhedronTraits_3` +- `PolyhedronItems_3` + +## Classes ## +- `CGAL::Polyhedron_3` +- \link CGAL::Polyhedron_3::Vertex `CGAL::Polyhedron_3::Vertex` \endlink +- \link CGAL::Polyhedron_3::Halfedge `CGAL::Polyhedron_3::Halfedge` \endlink +- \link CGAL::Polyhedron_3::Facet `CGAL::Polyhedron_3::Facet` \endlink +- `CGAL::Polyhedron_traits_3` +- `CGAL::Polyhedron_traits_with_normals_3` +- `CGAL::Polyhedron_items_3` +- `CGAL::Polyhedron_min_items_3` +- `CGAL::Polyhedron_incremental_builder_3` + +## Functions ## +- \link PkgPolyhedronIOFunc `CGAL::operator<<()` \endlink +- \link PkgPolyhedronIOFunc `CGAL::operator>>()` \endlink + */ diff --git a/Polynomial/doc/Polynomial/PackageDescription.txt b/Polynomial/doc/Polynomial/PackageDescription.txt index e032075119e..e8ea1ffb953 100644 --- a/Polynomial/doc/Polynomial/PackageDescription.txt +++ b/Polynomial/doc/Polynomial/PackageDescription.txt @@ -24,6 +24,8 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages + ## Concepts ## - `Polynomial_d` diff --git a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt index 58c51d73110..9a2c5e08468 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt +++ b/Polytope_distance_d/doc/Polytope_distance_d/PackageDescription.txt @@ -25,6 +25,8 @@ e.g. defining the compiler flag `CGAL_OPTIMISATION_NO_PRECONDITIONS` switches precondition checking off, cf. Section \ref secchecks. +\cgalClassifedRefPages + ## All furthest neighbors ## - `CGAL::all_furthest_neighbors_2` diff --git a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt index 69cf9443c20..14e57da5e66 100644 --- a/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt +++ b/Principal_component_analysis/doc/Principal_component_analysis/PackageDescription.txt @@ -35,5 +35,13 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd -*/ +\cgalClassifedRefPages +## Functions ## +- `CGAL::barycenter()` +- `CGAL::bounding_box()` +- `CGAL::centroid()` +- `CGAL::linear_least_squares_fitting_2()` +- `CGAL::linear_least_squares_fitting_3()` + +*/ diff --git a/QP_solver/doc/QP_solver/PackageDescription.txt b/QP_solver/doc/QP_solver/PackageDescription.txt index 2121afe4bba..f561ad8af08 100644 --- a/QP_solver/doc/QP_solver/PackageDescription.txt +++ b/QP_solver/doc/QP_solver/PackageDescription.txt @@ -87,6 +87,8 @@ Programs can be written to an output stream in MPSFormat, using one of the follo \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages + ## Concepts ## - `QuadraticProgram` (for quadratic programs with variable bounds l <= x <= u) - `LinearProgram` (for linear programs with variable bounds l <= x <= u) diff --git a/Ridges_3/doc/Ridges_3/PackageDescription.txt b/Ridges_3/doc/Ridges_3/PackageDescription.txt index d5e1858a7fc..f714f74b0e0 100644 --- a/Ridges_3/doc/Ridges_3/PackageDescription.txt +++ b/Ridges_3/doc/Ridges_3/PackageDescription.txt @@ -23,5 +23,30 @@ \cgalPkgLicense{\ref licensesGPL "GPL"} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Concepts ## +- `TriangulatedSurfaceMesh` +- `Vertex2FTPropertyMap` +- `Vertex2VectorPropertyMap` + +## Enums ## +- `CGAL::Ridge_type` +- `CGAL::Ridge_order` +- `CGAL::Umbilic_type` + +## Classes ## +- `CGAL::Ridge_line` +- `CGAL::Umbilic` +- `CGAL::Ridge_approximation` +- `CGAL::Umbilic_approximation` + +## Global Functions ## +- `CGAL::compute_max_ridges()` +- `CGAL::compute_min_ridges()` +- `CGAL::compute_crest_ridges()` +- `CGAL::compute_umbilics()` + */ diff --git a/STL_Extension/doc/STL_Extension/PackageDescription.txt b/STL_Extension/doc/STL_Extension/PackageDescription.txt index 0872b355918..f634c5391b1 100644 --- a/STL_Extension/doc/STL_Extension/PackageDescription.txt +++ b/STL_Extension/doc/STL_Extension/PackageDescription.txt @@ -25,5 +25,94 @@ \cgalPkgLicense{\ref licensesLGPL "LGPL"} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Doubly-Connected List Managing Items in Place ## +- `CGAL::In_place_list` +- `CGAL::In_place_list_base` + +## Compact Container ## +- `CGAL::Compact_container` +- `CGAL::Compact_container_traits` +- `CGAL::Compact_container_base` + +## Multiset with Extended Functionality ## +- `CGAL::Multiset` + +## Generic Algorithms ## +- `CGAL::cpp11::copy_n` +- `CGAL::copy_n` +- `CGAL::min_max_element` +- `CGAL::cpp11::next` +- `CGAL::cpp11::prev` +- `CGAL::predecessor` +- `CGAL::successor` + +## Iterators and Iterator/Circulator Adaptors ## +- `CGAL::Dispatch_output_iterator` +- `CGAL::Dispatch_or_drop_output_iterator` +- `CGAL::Emptyset_iterator` +- `CGAL::Oneset_iterator` +- `CGAL::Insert_iterator` +- `CGAL::Counting_iterator` +- `CGAL::N_step_adaptor` +- `CGAL::Filter_iterator` +- `CGAL::Join_input_iterator_1` +- `CGAL::Inverse_index` +- `CGAL::Random_access_adaptor` +- `CGAL::Random_access_value_adaptor` + +## Projection Function Objects ## +- `CGAL::Identity` +- `CGAL::Dereference` +- `CGAL::Get_address` +- `CGAL::Cast_function_object` +- `CGAL::Project_vertex` +- `CGAL::Project_facet` +- `CGAL::Project_point` +- `CGAL::Project_normal` +- `CGAL::Project_plane` +- `CGAL::Project_next` +- `CGAL::Project_prev` +- `CGAL::Project_next_opposite` +- `CGAL::Project_opposite_prev` + +## Creator Function Objects ## +- `CGAL::Creator_1` +- `CGAL::Creator_2` +- `CGAL::Creator_3` +- `CGAL::Creator_4` +- `CGAL::Creator_5` +- `CGAL::Creator_uniform_2` +- `CGAL::Creator_uniform_3` +- `CGAL::Creator_uniform_4` +- `CGAL::Creator_uniform_5` +- `CGAL::Creator_uniform_6` +- `CGAL::Creator_uniform_7` +- `CGAL::Creator_uniform_8` +- `CGAL::Creator_uniform_9` +- `CGAL::Creator_uniform_d` + +## Utilities ## +- `CGAL::Twotuple` +- `CGAL::Threetuple` +- `CGAL::Fourtuple` +- `CGAL::Sixtuple` +- `CGAL::Triple` +- `CGAL::Quadruple` +- `CGAL::Boolean_tag` +- `CGAL::Tag_true` +- `CGAL::Tag_false` +- `CGAL::Null_tag` +- `CGAL::Null_functor` +- `CGAL::Uncertain` +- `CGAL::Default` +- `CGAL::Fast` +- `CGAL::Compact` +- `CGAL::Location_policy` +- `CGAL::Fast_location` +- `CGAL::Compact_location` + */ diff --git a/SearchStructures/doc/SearchStructures/PackageDescription.txt b/SearchStructures/doc/SearchStructures/PackageDescription.txt index 779c84ca3d3..e6f3cd1a575 100644 --- a/SearchStructures/doc/SearchStructures/PackageDescription.txt +++ b/SearchStructures/doc/SearchStructures/PackageDescription.txt @@ -33,6 +33,8 @@ However, the range tree as implemented in \cgal is more flexible than the \f$ Kd\f$-tree implementation, in that it enables to layer together range trees and segment trees in the same data structure. +\cgalClassifedRefPages + ## Concepts ## - `RangeSegmentTreeTraits_k` diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt index 44f2605cf7e..ad569d97e61 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/PackageDescription.txt @@ -38,6 +38,8 @@ the class `CGAL::Triangulation_data_structure_2` is a model of the `SegmentDelaunayGraphDataStructure_2` concept. +\cgalClassifedRefPages + ## Concepts ## - `SegmentDelaunayGraphSite_2` diff --git a/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h b/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h index 9428f4698a6..85c3ef465fa 100644 --- a/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/CGAL/subdivide_skin_surface_mesh_3.h @@ -15,10 +15,9 @@ the new vertices are moved towards the skin surface. \tparam Polyhedron must be an instance of `Polyhedron_3`. */ -void -subdivide_skin_surface_mesh_3 (const -SkinSurface_3 &skin_surface, Polyhedron &p, int nSubdiv = -1); +template +void subdivide_skin_surface_mesh_3 (const +SkinSurface_3 &skin_surface, Polyhedron &p, int nSubdiv = 1); } /* namespace CGAL */ diff --git a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt index 1020451fb7b..bb541cb99ae 100644 --- a/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt +++ b/Skin_surface_3/doc/Skin_surface_3/PackageDescription.txt @@ -20,6 +20,22 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages + +## Concepts ## +- `SkinSurface_3` +- `SkinSurfaceTraits_3` + +## Classes ## +- `CGAL::Skin_surface_3` +- `CGAL::Union_of_balls_3` + +- `CGAL::Skin_surface_traits_3` + +## Functions ## +- `CGAL::make_skin_surface_mesh_3()` +- `CGAL::mesh_skin_surface_3()` +- `CGAL::subdivide_skin_surface_mesh_3()` */ diff --git a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt index 769d390df04..908837d8052 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt +++ b/Snap_rounding_2/doc/Snap_rounding_2/PackageDescription.txt @@ -19,5 +19,6 @@ \cgalPkgDemo{2D Snap Rounding,snap_rounding_2.zip} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + */ diff --git a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt index 0a21b3cfcad..204472d6842 100644 --- a/Spatial_searching/doc/Spatial_searching/PackageDescription.txt +++ b/Spatial_searching/doc/Spatial_searching/PackageDescription.txt @@ -53,5 +53,58 @@ supporting The spatial searching package consists of the following concepts and classes that are described in the reference pages. + +\cgalClassifedRefPages + +## Search Classes ## +- `CGAL::K_neighbor_search` +- `CGAL::Incremental_neighbor_search` +- `CGAL::Orthogonal_incremental_neighbor_search` +- `CGAL::Orthogonal_k_neighbor_search` +- `CGAL::Kd_tree` + +## Range Query Item Classes ## +- `CGAL::Fuzzy_iso_box` +- `CGAL::Fuzzy_sphere` + +## Search Traits Classes ## +- `CGAL::Search_traits_2` +- `CGAL::Search_traits_3` +- `CGAL::Search_traits_d` +- `CGAL::Search_traits` +- `CGAL::Search_traits_adapter` + +## Distance Classes ## +- `CGAL::Euclidean_distance` +- `CGAL::Euclidean_distance_sphere_point` +- `CGAL::Manhattan_distance_iso_box_point` +- `CGAL::Weighted_Minkowski_distance` +- `CGAL::Distance_for_point_adapter` + +## %Splitter Classes ## +- `CGAL::Sliding_midpoint` +- `CGAL::Sliding_fair` +- `CGAL::Fair` +- `CGAL::Median_of_max_spread` +- `CGAL::Median_of_rectangle` +- `CGAL::Midpoint_of_max_spread` +- `CGAL::Midpoint_of_rectangle` + +## Advanced Classes ## +- `CGAL::Kd_tree_node` +- `CGAL::Kd_tree_rectangle` +- `CGAL::Plane_separator` +- `CGAL::Point_container` + +## Concepts ## +- `FuzzyQueryItem` +- `GeneralDistance` +- `OrthogonalDistance` +- `SearchTraits` +- `RangeSearchTraits` +- `SpatialSeparator` +- `SpatialTree` +- `Splitter` + */ diff --git a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt index b0b43a76cce..e2f53b0fdab 100644 --- a/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt +++ b/Spatial_sorting/doc/Spatial_sorting/PackageDescription.txt @@ -32,5 +32,34 @@ \cgalPkgLicense{\ref licensesLGPL "LGPL"} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Functions ## +- `CGAL::spatial_sort()` +- `CGAL::hilbert_sort()` + +## Function Objects ## +- `CGAL::Multiscale_sort` +- `CGAL::Hilbert_sort_2` +- `CGAL::Hilbert_sort_3` +- `CGAL::Hilbert_sort_d` + +## Traits classes ## +- `CGAL::Spatial_sort_traits_adapter_2` +- `CGAL::Spatial_sort_traits_adapter_3` +- `CGAL::Spatial_sort_traits_adapter_d` + +## Concepts ## +- `SpatialSortingTraits_2` +- `SpatialSortingTraits_3` +- `SpatialSortingTraits_d` + +## Utilities ## +- `CGAL::Median` +- `CGAL::Middle` +- `CGAL::Hilbert_policy` +- `CGAL::Hilbert_sort_median_policy` +- `CGAL::Hilbert_sort_middle_policy` */ diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt index 915cb3a4f60..ae753e0162d 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/PackageDescription.txt @@ -30,5 +30,39 @@ \cgalPkgDemo{Operations on Polygons,polygon.zip} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Concepts ## +- `StraightSkeletonVertex_2` +- `StraightSkeletonHalfedge_2` +- `StraightSkeletonFace_2` +- `StraightSkeleton_2` +- `StraightSkeletonBuilder_2_Visitor` +- `StraightSkeletonBuilderTraits_2` +- `StraightSkeletonItemsConverter_2` +- `PolygonOffsetBuilderTraits_2` +- `VertexContainer_2` + +## Classes ## +- `CGAL::Straight_skeleton_vertex_base_2` +- `CGAL::Straight_skeleton_halfedge_base_2` +- `CGAL::Straight_skeleton_face_base_2` +- `CGAL::Straight_skeleton_2` +- `CGAL::create_interior_straight_skeleton_2` +- `CGAL::create_exterior_straight_skeleton_2` +- `CGAL::Straight_skeleton_builder_traits_2` +- `CGAL::Straight_skeleton_builder_2` +- `CGAL::Straight_skeleton_items_converter_2` +- `CGAL::Straight_skeleton_converter_2` +- `CGAL::convert_straight_skeleton_2` +- `CGAL::create_offset_polygons_2` +- `CGAL::arrange_offset_polygons_2` +- `CGAL::create_interior_skeleton_and_offset_polygons_2` +- `CGAL::create_exterior_skeleton_and_offset_polygons_2` +- `CGAL::Polygon_offset_builder_traits_2` +- `CGAL::Polygon_offset_builder_2` +- `CGAL::Dummy_straight_skeleton_builder_2_visitor` + */ diff --git a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt index 2e4a9eb99c7..ce85d714f8b 100644 --- a/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt +++ b/Stream_lines_2/doc/Stream_lines_2/PackageDescription.txt @@ -49,5 +49,20 @@ operations on them, and should be instantiated by a model of the concept function object that ensures the numerical integration used to construct the streamlines, and should be instantiated by a model of the concept `Integrator_2`. + +\cgalClassifedRefPages + +## Concepts ## +- `StreamLinesTraits_2` +- `Integrator_2` +- `VectorField_2` + +## Classes ## +- `CGAL::Stream_lines_2` +- `CGAL::Euler_integrator_2` +- `CGAL::Runge_kutta_integrator_2` +- `CGAL::Regular_grid_2` +- `CGAL::Triangular_field_2` + */ diff --git a/Stream_support/doc/IOstream/CGAL/IO/io.h b/Stream_support/doc/IOstream/CGAL/IO/io.h index f4f39e5e4e2..4cddda4be9c 100644 --- a/Stream_support/doc/IOstream/CGAL/IO/io.h +++ b/Stream_support/doc/IOstream/CGAL/IO/io.h @@ -256,14 +256,14 @@ The output operator is defined for all classes in the \cgal `Kernel` and for the \sa `CGAL::is_ascii()` \sa `CGAL::is_binary()` \sa `CGAL::is_pretty()` -\sa \ref op_right_shift "CGAL::operator>>" +\sa \ref PkgIOstreams_op_right_shift "CGAL::operator>>" */ ostream& operator<<(ostream& os, Class c); /*! \ingroup PkgIOstreams -\anchor op_right_shift +\anchor PkgIOstreams_op_right_shift \brief \cgal defines input operators for classes that are derived from the class `istream`. This allows to read from istreams diff --git a/Stream_support/doc/IOstream/PackageDescription.txt b/Stream_support/doc/IOstream/PackageDescription.txt index 0aa852cb54d..03df5858b27 100644 --- a/Stream_support/doc/IOstream/PackageDescription.txt +++ b/Stream_support/doc/IOstream/PackageDescription.txt @@ -20,5 +20,33 @@ IO streams. \cgal provides three different printing mode, defined in the enum `Mode`, as well as different functions to set and get the printing mode. + +\cgalClassifedRefPages + +## Enum ## +- `CGAL::Mode` + +## Functions ## +- `CGAL::get_mode()` +- `CGAL::is_ascii()` +- `CGAL::is_binary()` +- `CGAL::is_pretty()` +- `CGAL::set_mode()` +- `CGAL::set_ascii_mode()` +- `CGAL::set_binary_mode()` +- `CGAL::set_pretty_mode()` +- \link PkgIOstreams_op_right_shift `CGAL::operator>>()` \endlink +- \link PkgIOstreams_op_left_shift `CGAL::operator<<()` \endlink +- `CGAL::iformat()` +- `CGAL::oformat()` + +## Classes ## +- `CGAL::Color` +- `CGAL::Istream_iterator` +- `CGAL::Ostream_iterator` +- `CGAL::Verbose_ostream` +- `CGAL::Input_rep` +- `CGAL::Output_rep` + */ diff --git a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt index cf3016a856c..890bad46cee 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt +++ b/Subdivision_method_3/doc/Subdivision_method_3/PackageDescription.txt @@ -24,6 +24,20 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd +\cgalClassifedRefPages + +## Concepts ## +- `PQQMask_3` +- `PTQMask_3` +- `DQQMask_3` +- `Sqrt3Mask_3` + +## Classes ## +- `CGAL::Subdivision_method_3` +- `CGAL::CatmullClark_mask_3` +- `CGAL::Loop_mask_3` +- `CGAL::DooSabin_mask_3` +- `CGAL::Sqrt3_mask_3` */ diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt index 8b45fc4a9c8..59f94fa9a8c 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/PackageDescription.txt @@ -19,13 +19,125 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd -Output ----------------- +\cgalClassifedRefPages + +## Main Function ## + +- `CGAL::parameterize()` + +## Concepts ## + +- `ParameterizerTraits_3` +- `BorderParameterizer_3` +- `ParameterizationMesh_3` +- `ParameterizationPatchableMesh_3` +- `SparseLinearAlgebraTraits_d` +- `PolyhedronTraitsWithKernel_3` + +## Surface Parameterization Methods ## + +This \cgal package implements several parameterization methods: + + - Fixed border: + - Tutte Barycentric Mapping \cite t-hdg-63. + One-to-one mapping is guaranteed for convex border. + - Floater Mean Value Coordinates \cite cgal:f-mvc-03. + One-to-one mapping is guaranteed for convex border. + - Discrete Conformal Map \cite cgal:eddhls-maam-95. + Conditionally guaranteed if all weights are positive and border is convex. + - Discrete Authalic parameterization \cite cgal:dma-ipsm-02. + Conditionally guaranteed if all weights are positive and border is convex. + - Free border: + - Least Squares Conformal Maps \cite cgal:lprm-lscm-02. + +- `CGAL::Parameterizer_traits_3` +- `CGAL::Fixed_border_parameterizer_3` +- `CGAL::Barycentric_mapping_parameterizer_3` +- `CGAL::Discrete_authalic_parameterizer_3` +- `CGAL::Discrete_conformal_map_parameterizer_3` +- `CGAL::LSCM_parameterizer_3` +- `CGAL::Mean_value_coordinates_parameterizer_3` + +## Border Parameterization Methods ## + +Border parameterization methods define a +set of constraints (a constraint specifies two (u,v) coordinates for +each instance of a vertex along the border). + +This package implements all common border parameterization methods: + - For fixed border methods: + - the user can select a border + parameterization among two common methods: uniform or + arc-length parameterizations. + - one convex shape specified by: + - one shape among a set of standard ones (circle, square). + - For free border methods: at least two constraints (the pinned +vertices). + +- `CGAL::Circular_border_arc_length_parameterizer_3` +- `CGAL::Circular_border_uniform_parameterizer_3` +- `CGAL::Square_border_arc_length_parameterizer_3` +- `CGAL::Square_border_uniform_parameterizer_3` +- `CGAL::Two_vertices_parameterizer_3` + +## Mesh ## + +The general definition of input meshes handled directly by `CGAL::parameterize()` is: + + - Model of `ParameterizationMesh_3`. + - Triangulated. + - 2-manifold. + - Oriented. + - Homeomorphic to a disc (may have holes). + +This package provides a model of the `ParameterizationMesh_3` concept +to access `CGAL::Polyhedron_3`: + +- `CGAL::Parameterization_polyhedron_adaptor_3` + +The meshes supported indirectly by the package can be of any genus and +have any number of connected components. If it is not a topological +disc, the input mesh has to come with a description of a cutting path (an oriented list of +vertices) which is the border of a topological disc. If no cutting path is +given as input, we assume that the surface border is the longest border already +in the input mesh (the other borders will be considered as holes). + +The `CGAL::Parameterization_mesh_patch_3` +class is responsible for virtually cutting +a patch in a `ParameterizationPatchableMesh_3` mesh. +The resulting patch is a topological +disk (if the input cutting path is correct) +and provides a `ParameterizationMesh_3` interface. It can be used as +parameter of `CGAL::parameterize()`. + +Note that this way the user is responsible for cutting a closed mesh of +arbitrary genus (even a topological disc with an intricate seam +cut), as long as this condition is fulfilled. + +The package provides an interface with `CGAL::Polyhedron_3`: + +- `CGAL::Parameterization_polyhedron_adaptor_3` + +## Output ## A `(u,v)` pair is computed for each inner vertex (i.e. its halfedges share the same `(u,v)` pair), while a `(u,v)` pair is computed for each border halfedge. The user must iterate over the mesh halfedges to get the result. -Checks and Assertions ----------------- +## Sparse Linear Algebra ## + +Since parameterizing meshes requires +efficient representation of sparse matrices and efficient iterative or +direct linear solvers, we provide an interface to several +sparse linear solvers: + - Eigen 3.1 (or greater) is the library recommended by %CGAL solving sparse systems. + - OpenNL (authored by Bruno Lévy) is shipped with %CGAL is the default solver. + - `OpenNL::DefaultLinearSolverTraits` in OpenNL package + - `OpenNL::SymmetricLinearSolverTraits` in OpenNL package + +## Helper Classes ## + +- `CGAL::Parameterization_mesh_feature_extractor` + +## Checks and Assertions ## The package performs the next checks: @@ -47,6 +159,7 @@ For free border parameterizations: Assertions are optional checks. The assertion flags for the package use `SURFACE_MESH_PARAMETERIZATION` in their names (e.g. `CGAL_SURFACE_MESH_PARAMETERIZATION_NO_ASSERTIONS`). + */ /// \defgroup PkgSurfaceParameterizationMainFunction Main Function diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt index 588a6a7093a..6c778a8ea5d 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/PackageDescription.txt @@ -20,5 +20,29 @@ \cgalPkgDemo{Operations on Polyhedra,polyhedron_3.zip} \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd + +\cgalClassifedRefPages + +## Concepts ## +- `EdgeCollapsableMesh` +- `EdgeProfile` +- `StopPredicate` +- `GetCost` +- `GetPlacement` +- `EdgeCollapseSimplificationVisitor` + +## Functions ## +- `CGAL::Surface_mesh_simplification::edge_collapse()` + +## Classes ## +- `CGAL::Surface_mesh_simplification::Edge_collapse_visitor_base` +- `CGAL::Surface_mesh_simplification::Edge_profile` +- `CGAL::Surface_mesh_simplification::Count_stop_predicate` +- `CGAL::Surface_mesh_simplification::Count_ratio_stop_predicate` +- `CGAL::Surface_mesh_simplification::Edge_length_cost` +- `CGAL::Surface_mesh_simplification::Midpoint_placement` +- `CGAL::Surface_mesh_simplification::LindstromTurk_cost` +- `CGAL::Surface_mesh_simplification::LindstromTurk_placement` + */ diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_off.h b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_off.h index 1892c9f50df..157bec48164 100755 --- a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_off.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_off.h @@ -20,9 +20,7 @@ In case the surface is manifold the triangles can be oriented. \returns `true` if the surface could be written to the stream. -\relates Surface_mesh_complex_2_in_triangulation_3 - -\sa `output_surface_facets_to_polyhedron()` +\sa `CGAL::output_surface_facets_to_polyhedron()` */ template diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h index e2d373b7fba..e127f4e8883 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/IO/output_surface_facets_to_polyhedron.h @@ -18,9 +18,7 @@ converts a manifold surface reconstructed by `make_surface_mesh()` to a `Polyhed \param c2t3 Input surface. \param output_polyhedron Output polyhedron. -\relates Surface_mesh_complex_2_in_triangulation_3 - -\sa `output_surface_facets_to_off()` +\sa `CGAL::output_surface_facets_to_off()` */ template bool output_surface_facets_to_polyhedron(const SurfaceMeshComplex_2InTriangulation_3& c2t3, Polyhedron& output_polyhedron); diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h index fff62729b3f..52d3258574e 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_complex_2_in_triangulation_3.h @@ -25,7 +25,9 @@ respectively.) \cgalModels `SurfaceMeshComplex_2InTriangulation_3` \sa `make_surface_mesh` -\sa `SurfaceMeshTriangulation_3` +\sa `SurfaceMeshTriangulation_3` +\sa `CGAL::output_surface_facets_to_off()` +\sa `CGAL::output_surface_facets_to_polyhedron()` */ template< typename Tr, typename Edge_info = void > diff --git a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt index 79f5665a46d..a675d0f22a3 100644 --- a/Surface_mesher/doc/Surface_mesher/PackageDescription.txt +++ b/Surface_mesher/doc/Surface_mesher/PackageDescription.txt @@ -30,7 +30,7 @@ \cgalPkgPicture{segmented_head-small.png} \cgalPkgSummaryBegin \cgalPkgAuthors{Laurent Rineau and Mariette Yvinec} -\cgalPkgDesc{This package provides functions to generate surface meshes that interpolate smooth surfaces. The meshing algorithm is based on Delaunay refinement and provides some guarantees on the resulting mesh: the user is able to control the size and shape of the mesh elements and the accuracy of the surface approximation. There is no restriction on the topology and number of components of input surfaces. The surface mesh generator may also be used for non smooth surfaces but without guarantee. Currently, implementations are provided for implicit surfaces described as the zero level set of some function and surfaces described as a gray level set in a three-dimensional image.} +\cgalPkgDesc{This package provides functions to generate surface meshes that interpolate smooth surfaces. The meshing algorithm is based on Delaunay refinement and provides some guarantees on the resulting mesh: the user is able to control the size and shape of the mesh elements and the accuracy of the surface approximation. There is no restriction on the topology and number of components of input surfaces. The surface mesh generator may also be used for non smooth surfaces but without guarantee. Currently, implementations are provided for implicit surfaces described as the zero level set of some function and surfaces described as a gray level set in a three-dimensional image.} \cgalPkgManuals{Chapter_3D_Surface_Mesh_Generation,PkgSurfaceMesher3} \cgalPkgSummaryEnd \cgalPkgShortInfoBegin @@ -74,5 +74,37 @@ the type and values of the given criteria. The behavior of the refinement process can also be influenced through a tag, which allows for instance to enforce the manifold property of the output mesh while avoiding an over-refinement of the mesh. + +\cgalClassifedRefPages + +## Concepts ## +- `SurfaceMeshComplex_2InTriangulation_3` +- `SurfaceMeshTraits_3` +- `SurfaceMeshFacetsCriteria_3` +- `SurfaceMeshCellBase_3` +- `SurfaceMeshVertexBase_3` +- `SurfaceMeshTriangulation_3` +- `ImplicitFunction` +- `ImplicitSurfaceTraits_3` + +## Classes ## +- `CGAL::Surface_mesh_complex_2_in_triangulation_3` +- `CGAL::Surface_mesh_vertex_base_3` +- `CGAL::Surface_mesh_cell_base_3` +- `CGAL::Surface_mesh_default_criteria_3` +- `CGAL::Surface_mesh_default_triangulation_3` +- `CGAL::Surface_mesh_traits_generator_3` +- `CGAL::Implicit_surface_3` +- `CGAL::Gray_level_image_3` + +## Tag Classes ## +- `CGAL::Manifold_tag` +- `CGAL::Manifold_with_boundary_tag` +- `CGAL::Non_manifold_tag` + +## Function Templates ## +- `CGAL::make_surface_mesh()` +- `CGAL::output_surface_facets_to_polyhedron()` + */ diff --git a/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt b/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt index 42de1abd620..dde7f60e0eb 100644 --- a/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt +++ b/Surface_reconstruction_points_3/doc/Surface_reconstruction_points_3/PackageDescription.txt @@ -17,8 +17,9 @@ \cgalPkgShortInfoEnd \cgalPkgDescriptionEnd - - +\cgalClassifedRefPages +## Classes ## +- `CGAL::Poisson_reconstruction_function` */ diff --git a/Triangulation_2/doc/TDS_2/PackageDescription.txt b/Triangulation_2/doc/TDS_2/PackageDescription.txt index 987174fb035..35ca4dbe5e7 100644 --- a/Triangulation_2/doc/TDS_2/PackageDescription.txt +++ b/Triangulation_2/doc/TDS_2/PackageDescription.txt @@ -47,5 +47,22 @@ class, the parameters have to be instantiated by models of different refining concepts according to the actual type of the triangulation. These refining concepts and their models are described in Chapter \ref Chapter_2D_Triangulations "2D Triangulations". -*/ +\cgalClassifedRefPages +## Concepts ## +- `TriangulationDataStructure_2` +- `TriangulationDataStructure_2::Face` +- `TriangulationDataStructure_2::Vertex` + +- `TriangulationDSFaceBase_2` +- `TriangulationDSVertexBase_2` + +## Classes ## +- `CGAL::Triangulation_data_structure_2` +- `CGAL::Triangulation_ds_face_base_2` +- `CGAL::Triangulation_ds_vertex_base_2` + +- `CGAL::Triangulation_cw_ccw_2` + + +*/ diff --git a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt index a548f1c9295..80826465f28 100644 --- a/Triangulation_2/doc/Triangulation_2/PackageDescription.txt +++ b/Triangulation_2/doc/Triangulation_2/PackageDescription.txt @@ -61,5 +61,53 @@ structure acting as a container for faces and vertices while taking care of the combinatorial aspects of the triangulation. The concepts and models relative to the triangulation data structure are described in Chapter \ref PkgTDS2 "2D Triangulation Data Structure". + +\cgalClassifedRefPages + +## Concepts ## +- `TriangulationTraits_2` +- `DelaunayTriangulationTraits_2` +- `RegularTriangulationTraits_2` +- `ConstrainedTriangulationTraits_2` +- `ConstrainedDelaunayTriangulationTraits_2` + +- `TriangulationFaceBase_2` +- `TriangulationVertexBase_2` +- `ConstrainedTriangulationFaceBase_2` +- `RegularTriangulationFaceBase_2` +- `RegularTriangulationVertexBase_2` +- `TriangulationHierarchyVertexBase_2` +- `TriangulationVertexBaseWithInfo_2` + +## Classes ## + +- `CGAL::Triangulation_2` +- `CGAL::Delaunay_triangulation_2` +- `CGAL::Regular_triangulation_2` +- `CGAL::Constrained_triangulation_2` +- `CGAL::Constrained_Delaunay_triangulation_2` +- `CGAL::Constrained_triangulation_plus_2` +- `CGAL::Triangulation_hierarchy_2` + +- `CGAL::Triangulation_euclidean_traits_2` +- `CGAL::Triangulation_euclidean_traits_xy_3` +- `CGAL::Regular_triangulation_euclidean_traits_2` +- `CGAL::Regular_triangulation_filtered_traits_2` + +- `CGAL::Triangulation_face_base_2` +- `CGAL::Triangulation_vertex_base_2` +- `CGAL::Regular_triangulation_face_base_2` +- `CGAL::Regular_triangulation_vertex_base_2` +- `CGAL::Constrained_triangulation_face_base_2` +- `CGAL::Triangulation_vertex_base_with_info_2` +- `CGAL::Triangulation_face_base_with_info_2` +- `CGAL::Triangulation_hierarchy_vertex_base_2` + +- `CGAL::Weighted_point` +- `CGAL::Triangulation_cw_ccw_2` + +## Enum ## +- \link CGAL::Triangulation_2::Locate_type `CGAL::Triangulation_2::Locate_type` \endlink + */ diff --git a/Triangulation_3/doc/TDS_3/PackageDescription.txt b/Triangulation_3/doc/TDS_3/PackageDescription.txt index 8eb8f14d785..9ee56487db2 100644 --- a/Triangulation_3/doc/TDS_3/PackageDescription.txt +++ b/Triangulation_3/doc/TDS_3/PackageDescription.txt @@ -44,6 +44,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 Section \ref TDS3secintro.) +\cgalClassifedRefPages ## Concepts ## diff --git a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt index f94907c9614..636e0bfb2b5 100644 --- a/Triangulation_3/doc/Triangulation_3/PackageDescription.txt +++ b/Triangulation_3/doc/Triangulation_3/PackageDescription.txt @@ -65,6 +65,8 @@ indexed with 0, 1, 2, 3 in such a way that the neighbor indexed by `i` is opposite to the vertex with the same index. See Figure \cgalFigureRef{Triangulation3figorient}. +\cgalClassifedRefPages + ## Concepts ## - `TriangulationTraits_3`