From 2dfe8a3d7337e69b61d3bfdf809fc5d134d75ff6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Loriot?= Date: Thu, 25 Jul 2013 14:58:53 +0200 Subject: [PATCH] workaround for a doxygen bug: remove space after /!* to avoid a verbatim env this happens if you have an empty line or the text directly after /!* to find them in the generated documentation, grep for "pre class=\"fragment\"" (a few of them are legitimate however) --- .../doc/AABB_tree/Concepts/AABBGeomTraits.h | 28 +- .../doc/AABB_tree/Concepts/AABBPrimitive.h | 12 +- AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h | 50 +- .../CGAL/Coercion_traits.h | 8 +- .../Concepts/AlgebraicStructureTraits--Div.h | 10 +- .../AlgebraicStructureTraits--DivMod.h | 14 +- .../AlgebraicStructureTraits--Divides.h | 10 +- .../Concepts/AlgebraicStructureTraits--Gcd.h | 10 +- ...gebraicStructureTraits--IntegralDivision.h | 10 +- .../AlgebraicStructureTraits--Inverse.h | 6 +- .../AlgebraicStructureTraits--IsOne.h | 6 +- .../AlgebraicStructureTraits--IsSquare.h | 10 +- .../AlgebraicStructureTraits--IsZero.h | 6 +- .../AlgebraicStructureTraits--KthRoot.h | 8 +- .../Concepts/AlgebraicStructureTraits--Mod.h | 10 +- .../AlgebraicStructureTraits--RootOf.h | 4 +- .../AlgebraicStructureTraits--Simplify.h | 6 +- .../Concepts/AlgebraicStructureTraits--Sqrt.h | 6 +- .../AlgebraicStructureTraits--Square.h | 6 +- .../AlgebraicStructureTraits--UnitPart.h | 6 +- .../Concepts/AlgebraicStructureTraits.h | 42 +- .../Algebraic_foundations/Concepts/Field.h | 4 +- .../Concepts/FractionTraits.h | 26 +- .../Concepts/FromDoubleConstructible.h | 2 +- .../Concepts/FromIntConstructible.h | 2 +- .../Concepts/IntegralDomainWithoutDivision.h | 20 +- .../Concepts/RealEmbeddable.h | 12 +- .../Concepts/RealEmbeddableTraits--Abs.h | 6 +- .../Concepts/RealEmbeddableTraits--Compare.h | 10 +- .../RealEmbeddableTraits--IsNegative.h | 6 +- .../RealEmbeddableTraits--IsPositive.h | 6 +- .../Concepts/RealEmbeddableTraits--IsZero.h | 6 +- .../Concepts/RealEmbeddableTraits--Sgn.h | 6 +- .../Concepts/RealEmbeddableTraits--ToDouble.h | 6 +- .../RealEmbeddableTraits--ToInterval.h | 6 +- .../Concepts/RealEmbeddableTraits.h | 26 +- .../CGAL/Algebraic_kernel_d_1.h | 10 +- .../CGAL/Algebraic_kernel_d_2.h | 10 +- .../CGAL/Algebraic_kernel_rs_gmpq_d_1.h | 10 +- .../CGAL/Algebraic_kernel_rs_gmpz_d_1.h | 10 +- ...gebraicKernel_d_1--ApproximateAbsolute_1.h | 8 +- ...gebraicKernel_d_1--ApproximateRelative_1.h | 8 +- .../AlgebraicKernel_d_1--BoundBetween_1.h | 8 +- .../Concepts/AlgebraicKernel_d_1--Compare_1.h | 14 +- ...AlgebraicKernel_d_1--ComputePolynomial_1.h | 6 +- ...raicKernel_d_1--ConstructAlgebraicReal_1.h | 12 +- .../AlgebraicKernel_d_1--IsCoprime_1.h | 8 +- .../AlgebraicKernel_d_1--IsSquareFree_1.h | 6 +- .../AlgebraicKernel_d_1--IsZeroAt_1.h | 8 +- .../Concepts/AlgebraicKernel_d_1--Isolate_1.h | 8 +- .../AlgebraicKernel_d_1--MakeCoprime_1.h | 4 +- .../AlgebraicKernel_d_1--MakeSquareFree_1.h | 6 +- ...AlgebraicKernel_d_1--NumberOfSolutions_1.h | 6 +- .../Concepts/AlgebraicKernel_d_1--SignAt_1.h | 8 +- .../Concepts/AlgebraicKernel_d_1--Solve_1.h | 8 +- ...gebraicKernel_d_1--SquareFreeFactorize_1.h | 2 +- .../Concepts/AlgebraicKernel_d_1.h | 44 +- ...ebraicKernel_d_2--ApproximateAbsoluteX_2.h | 8 +- ...ebraicKernel_d_2--ApproximateAbsoluteY_2.h | 8 +- ...ebraicKernel_d_2--ApproximateRelativeX_2.h | 8 +- ...ebraicKernel_d_2--ApproximateRelativeY_2.h | 8 +- .../AlgebraicKernel_d_2--BoundBetweenX_2.h | 8 +- .../AlgebraicKernel_d_2--BoundBetweenY_2.h | 8 +- .../AlgebraicKernel_d_2--CompareXY_2.h | 14 +- .../AlgebraicKernel_d_2--CompareX_2.h | 16 +- .../AlgebraicKernel_d_2--CompareY_2.h | 16 +- ...lgebraicKernel_d_2--ComputePolynomialX_2.h | 6 +- ...lgebraicKernel_d_2--ComputePolynomialY_2.h | 6 +- .../AlgebraicKernel_d_2--ComputeX_2.h | 6 +- .../AlgebraicKernel_d_2--ComputeY_2.h | 6 +- ...raicKernel_d_2--ConstructAlgebraicReal_2.h | 14 +- .../AlgebraicKernel_d_2--IsCoprime_2.h | 8 +- .../AlgebraicKernel_d_2--IsSquareFree_2.h | 6 +- .../AlgebraicKernel_d_2--IsZeroAt_2.h | 8 +- .../AlgebraicKernel_d_2--IsolateX_2.h | 8 +- .../AlgebraicKernel_d_2--IsolateY_2.h | 8 +- .../AlgebraicKernel_d_2--MakeCoprime_2.h | 4 +- .../AlgebraicKernel_d_2--MakeSquareFree_2.h | 6 +- ...AlgebraicKernel_d_2--NumberOfSolutions_2.h | 8 +- .../Concepts/AlgebraicKernel_d_2--SignAt_2.h | 8 +- .../Concepts/AlgebraicKernel_d_2--Solve_2.h | 4 +- ...gebraicKernel_d_2--SquareFreeFactorize_2.h | 2 +- .../Concepts/AlgebraicKernel_d_2.h | 52 +- .../doc/Alpha_shapes_2/CGAL/Alpha_shape_2.h | 72 +- .../Concepts/AlphaShapeFace_2.h | 18 +- .../Concepts/AlphaShapeTraits_2.h | 8 +- .../Concepts/AlphaShapeVertex_2.h | 12 +- .../doc/Alpha_shapes_3/CGAL/Alpha_shape_3.h | 74 +- .../CGAL/Alpha_shape_cell_base_3.h | 22 +- .../Alpha_shapes_3/CGAL/Fixed_alpha_shape_3.h | 40 +- .../Concepts/AlphaShapeCell_3.h | 18 +- .../Concepts/AlphaShapeTraits_3.h | 8 +- .../Concepts/AlphaShapeVertex_3.h | 12 +- .../Concepts/FixedAlphaShapeCell_3.h | 14 +- .../Concepts/FixedAlphaShapeTraits_3.h | 8 +- .../Concepts/FixedAlphaShapeVertex_3.h | 16 +- .../FixedWeightedAlphaShapeTraits_3.h | 8 +- .../Concepts/WeightedAlphaShapeTraits_3.h | 8 +- .../CGAL/Apollonius_graph_2.h | 174 ++-- .../CGAL/Apollonius_graph_filtered_traits_2.h | 6 +- .../CGAL/Apollonius_graph_hierarchy_2.h | 34 +- ...Apollonius_graph_hierarchy_vertex_base_2.h | 6 +- .../CGAL/Apollonius_graph_traits_2.h | 6 +- .../CGAL/Apollonius_graph_vertex_base_2.h | 6 +- .../CGAL/Apollonius_site_2.h | 10 +- .../Concepts/ApolloniusGraphDataStructure_2.h | 4 +- .../ApolloniusGraphHierarchyVertexBase_2.h | 14 +- .../Concepts/ApolloniusGraphTraits_2.h | 78 +- .../Concepts/ApolloniusGraphVertexBase_2.h | 40 +- .../Concepts/ApolloniusSite_2.h | 16 +- .../CGAL/Arr_Bezier_curve_traits_2.h | 46 +- .../CGAL/Arr_accessor.h | 62 +- .../CGAL/Arr_algebraic_segment_traits_2.h | 62 +- .../CGAL/Arr_circle_segment_traits_2.h | 76 +- .../CGAL/Arr_conic_traits_2.h | 58 +- .../Arr_consolidated_curve_data_traits_2.h | 34 +- .../CGAL/Arr_curve_data_traits_2.h | 34 +- .../CGAL/Arr_extended_dcel.h | 18 +- .../CGAL/Arr_face_index_map.h | 2 +- .../CGAL/Arr_linear_traits_2.h | 38 +- .../CGAL/Arr_observer.h | 142 +-- .../CGAL/Arr_polyline_traits_2.h | 28 +- .../CGAL/Arr_rational_function_traits_2.h | 178 ++-- .../CGAL/Arr_trapezoid_ric_point_location.h | 6 +- .../CGAL/Arr_vertex_index_map.h | 2 +- .../CGAL/Arrangement_2.h | 192 ++-- .../CGAL/Arrangement_with_history_2.h | 56 +- .../Concepts/ArrTraits--Approximate_2.h | 2 +- .../Concepts/ArrTraits--AreMergeable_2.h | 2 +- .../Concepts/ArrTraits--CompareXAtLimit_2.h | 4 +- .../Concepts/ArrTraits--CompareXNearLimit_2.h | 2 +- .../Concepts/ArrTraits--CompareX_2.h | 2 +- .../Concepts/ArrTraits--CompareXy_2.h | 2 +- .../Concepts/ArrTraits--CompareYAtXLeft_2.h | 2 +- .../Concepts/ArrTraits--CompareYAtXRight_2.h | 2 +- .../Concepts/ArrTraits--CompareYAtX_2.h | 2 +- .../ArrTraits--CompareYNearBoundary_2.h | 2 +- .../ArrTraits--ConstructMaxVertex_2.h | 2 +- .../ArrTraits--ConstructMinVertex_2.h | 2 +- .../ArrTraits--ConstructXMonotoneCurve_2.h | 2 +- .../Concepts/ArrTraits--Equal_2.h | 4 +- .../Concepts/ArrTraits--Intersect_2.h | 2 +- .../Concepts/ArrTraits--IsVertical_2.h | 2 +- .../Concepts/ArrTraits--MakeXMonotone_2.h | 2 +- .../Concepts/ArrTraits--Merge_2.h | 2 +- .../Concepts/ArrTraits--ParameterSpaceInX_2.h | 2 +- .../Concepts/ArrTraits--ParameterSpaceInY_2.h | 2 +- .../Concepts/ArrTraits--Split_2.h | 2 +- .../Concepts/ArrangementBasicTraits_2.h | 50 +- .../Concepts/ArrangementDcel.h | 82 +- .../Concepts/ArrangementDcelFace.h | 40 +- .../Concepts/ArrangementDcelHalfedge.h | 48 +- .../Concepts/ArrangementDcelHole.h | 14 +- .../Concepts/ArrangementDcelIsolatedVertex.h | 14 +- .../Concepts/ArrangementDcelVertex.h | 32 +- .../Concepts/ArrangementDcelWithRebind.h | 4 +- .../Concepts/ArrangementInputFormatter.h | 86 +- .../Concepts/ArrangementLandmarkTraits_2.h | 10 +- .../ArrangementOpenBoundaryTraits_2.h | 28 +- .../Concepts/ArrangementOutputFormatter.h | 82 +- .../Concepts/ArrangementPointLocation_2.h | 14 +- .../Concepts/ArrangementTraits_2.h | 6 +- .../Concepts/ArrangementVerticalRayShoot_2.h | 16 +- .../ArrangementWithHistoryInputFormatter.h | 18 +- .../ArrangementWithHistoryOutputFormatter.h | 18 +- .../Concepts/ArrangementXMonotoneTraits_2.h | 20 +- .../Concepts/OverlayTraits.h | 38 +- .../CGAL/HalfedgeDS_face_max_base_with_id.h | 6 +- .../HalfedgeDS_halfedge_max_base_with_id.h | 6 +- .../CGAL/HalfedgeDS_vertex_max_base_with_id.h | 6 +- BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h | 2 +- .../Triangulation_vertex_base_with_id_2.h | 4 +- .../boost/graph/graph_traits_Arrangement_2.h | 22 +- .../boost/graph/graph_traits_Polyhedron_3.h | 22 +- .../graph/graph_traits_Triangulation_2.h | 18 +- .../halfedge_graph_traits_Polyhedron_3.h | 4 +- BGL/doc/BGL/Concepts/HalfedgeGraph.h | 12 +- .../Gps_default_dcel.h | 2 +- .../CGAL/General_polygon_2.h | 12 +- .../CGAL/General_polygon_set_2.h | 112 +- .../CGAL/General_polygon_with_holes_2.h | 2 +- .../CGAL/Gps_segment_traits_2.h | 2 +- .../ArrDirectionalTraits--AreMergeable_2.h | 2 +- ...rDirectionalTraits--CompareEndpointsXy_2.h | 2 +- ...rrDirectionalTraits--ConstructOpposite_2.h | 2 +- .../ArrDirectionalTraits--Intersect_2.h | 2 +- .../Concepts/ArrDirectionalTraits--Merge_2.h | 2 +- .../Concepts/ArrDirectionalTraits--Split_2.h | 2 +- .../ArrangementDirectionalXMonotoneTraits_2.h | 22 +- .../Concepts/GeneralPolygonSetDcel.h | 62 +- .../Concepts/GeneralPolygonSetDcelFace.h | 12 +- .../Concepts/GeneralPolygonSetTraits_2.h | 34 +- .../Concepts/GeneralPolygonWithHoles_2.h | 22 +- .../Concepts/GeneralPolygon_2.h | 24 +- .../CGAL/Approximate_min_ellipsoid_d.h | 48 +- .../Approximate_min_ellipsoid_d_traits_2.h | 8 +- .../Approximate_min_ellipsoid_d_traits_3.h | 8 +- .../Approximate_min_ellipsoid_d_traits_d.h | 8 +- .../doc/Bounding_volumes/CGAL/Min_annulus_d.h | 90 +- .../doc/Bounding_volumes/CGAL/Min_circle_2.h | 60 +- .../CGAL/Min_circle_2_traits_2.h | 10 +- .../doc/Bounding_volumes/CGAL/Min_ellipse_2.h | 64 +- .../CGAL/Min_ellipse_2_traits_2.h | 12 +- .../CGAL/Min_quadrilateral_traits_2.h | 58 +- .../CGAL/Min_sphere_annulus_d_traits_2.h | 28 +- .../CGAL/Min_sphere_annulus_d_traits_3.h | 28 +- .../CGAL/Min_sphere_annulus_d_traits_d.h | 28 +- .../doc/Bounding_volumes/CGAL/Min_sphere_d.h | 60 +- .../CGAL/Min_sphere_of_points_d_traits_2.h | 20 +- .../CGAL/Min_sphere_of_points_d_traits_3.h | 20 +- .../CGAL/Min_sphere_of_points_d_traits_d.h | 20 +- .../CGAL/Min_sphere_of_spheres_d.h | 42 +- .../CGAL/Min_sphere_of_spheres_d_traits_2.h | 20 +- .../CGAL/Min_sphere_of_spheres_d_traits_3.h | 20 +- .../CGAL/Min_sphere_of_spheres_d_traits_d.h | 20 +- .../CGAL/rectangular_p_center_2.h | 46 +- .../ApproximateMinEllipsoid_d_Traits_d.h | 12 +- .../doc/Bounding_volumes/Concepts/Circle.h | 2 +- .../Concepts/MinCircle2Traits.h | 12 +- .../Concepts/MinEllipse2Traits.h | 10 +- .../Concepts/MinQuadrilateralTraits_2.h | 58 +- .../Concepts/MinSphereAnnulusDTraits.h | 28 +- .../Concepts/MinSphereOfSpheresTraits.h | 16 +- .../Concepts/RectangularPCenterTraits_2.h | 46 +- .../CGAL/Box_intersection_d/Box_d.h | 34 +- .../CGAL/Box_intersection_d/Box_traits_d.h | 2 +- .../Box_intersection_d/Box_with_handle_d.h | 32 +- .../Concepts/BoxIntersectionBox_d.h | 12 +- .../Concepts/BoxIntersectionTraits_d.h | 14 +- .../doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h | 62 +- .../Circular_kernel_2/CGAL/Circular_arc_2.h | 34 +- .../CGAL/Circular_arc_point_2.h | 26 +- .../CGAL/Circular_kernel_2.h | 10 +- .../doc/Circular_kernel_2/CGAL/Line_arc_2.h | 28 +- .../AlgebraicKernelForCircles--CompareX.h | 2 +- .../AlgebraicKernelForCircles--CompareXY.h | 2 +- .../AlgebraicKernelForCircles--CompareY.h | 2 +- ...rcles--ConstructPolynomialForCircles_2_2.h | 2 +- ...ernelForCircles--ConstructPolynomial_1_2.h | 2 +- ...rnelForCircles--PolynomialForCircles_2_2.h | 2 +- ...raicKernelForCircles--RootForCircles_2_2.h | 2 +- .../AlgebraicKernelForCircles--SignAt.h | 4 +- .../AlgebraicKernelForCircles--Solve.h | 8 +- ...gebraicKernelForCircles--XCriticalPoints.h | 4 +- ...gebraicKernelForCircles--YCriticalPoints.h | 4 +- .../Concepts/AlgebraicKernelForCircles.h | 30 +- .../Concepts/CircularKernel--BoundedSide_2.h | 2 +- .../Concepts/CircularKernel--CompareXY_2.h | 2 +- .../Concepts/CircularKernel--CompareX_2.h | 2 +- .../Concepts/CircularKernel--CompareY_2.h | 2 +- .../Concepts/CircularKernel--CompareYatX_2.h | 4 +- .../CircularKernel--CompareYtoRight_2.h | 8 +- .../CircularKernel--ComputeCircularX_2.h | 2 +- .../CircularKernel--ComputeCircularY_2.h | 2 +- .../CircularKernel--ConstructBbox_2.h | 6 +- .../CircularKernel--ConstructCircle_2.h | 4 +- ...cularKernel--ConstructCircularArcPoint_2.h | 4 +- .../CircularKernel--ConstructCircularArc_2.h | 10 +- ...ularKernel--ConstructCircularMaxVertex_2.h | 4 +- ...ularKernel--ConstructCircularMinVertex_2.h | 4 +- ...rKernel--ConstructCircularSourceVertex_2.h | 4 +- ...rKernel--ConstructCircularTargetVertex_2.h | 4 +- .../CircularKernel--ConstructLineArc_2.h | 10 +- .../CircularKernel--ConstructLine_2.h | 4 +- .../Concepts/CircularKernel--DoIntersect_2.h | 2 +- .../Concepts/CircularKernel--DoOverlap_2.h | 4 +- .../Concepts/CircularKernel--Equal_2.h | 6 +- .../Concepts/CircularKernel--GetEquation.h | 4 +- .../CircularKernel--HasOnBoundedSide_2.h | 2 +- .../CircularKernel--HasOnUnboundedSide_2.h | 2 +- .../Concepts/CircularKernel--HasOn_2.h | 8 +- .../Concepts/CircularKernel--InXRange_2.h | 4 +- .../Concepts/CircularKernel--Intersect_2.h | 2 +- .../Concepts/CircularKernel--IsVertical_2.h | 4 +- .../Concepts/CircularKernel--IsXMonotone_2.h | 4 +- .../Concepts/CircularKernel--IsYMonotone_2.h | 4 +- .../CircularKernel--MakeXMonotone_2.h | 2 +- .../CircularKernel--MakeXYMonotone_2.h | 2 +- .../Concepts/CircularKernel--Split_2.h | 4 +- .../Concepts/CircularKernel.h | 94 +- .../Circular_kernel_3/CGAL/Circular_arc_3.h | 30 +- .../CGAL/Circular_arc_point_3.h | 28 +- .../doc/Circular_kernel_3/CGAL/Line_arc_3.h | 26 +- .../CGAL/Spherical_kernel_3.h | 10 +- .../AlgebraicKernelForSpheres--CompareX.h | 2 +- .../AlgebraicKernelForSpheres--CompareXY.h | 2 +- .../AlgebraicKernelForSpheres--CompareXYZ.h | 2 +- .../AlgebraicKernelForSpheres--CompareY.h | 2 +- .../AlgebraicKernelForSpheres--CompareZ.h | 2 +- ...heres--ConstructPolynomialForSpheres_2_3.h | 2 +- ...ernelForSpheres--ConstructPolynomial_1_3.h | 2 +- ...rSpheres--ConstructPolynomialsForLines_3.h | 2 +- ...rnelForSpheres--PolynomialForSpheres_2_3.h | 2 +- ...raicKernelForSpheres--RootForSpheres_2_3.h | 2 +- .../AlgebraicKernelForSpheres--SignAt.h | 4 +- .../AlgebraicKernelForSpheres--Solve.h | 2 +- ...gebraicKernelForSpheres--XCriticalPoints.h | 4 +- ...gebraicKernelForSpheres--YCriticalPoints.h | 4 +- ...gebraicKernelForSpheres--ZCriticalPoints.h | 4 +- .../Concepts/AlgebraicKernelForSpheres.h | 40 +- .../Concepts/SphericalKernel--BoundedSide_3.h | 4 +- .../SphericalKernel--CompareThetaZ_3.h | 2 +- .../SphericalKernel--CompareTheta_3.h | 8 +- .../Concepts/SphericalKernel--CompareXYZ_3.h | 2 +- .../Concepts/SphericalKernel--CompareXY_3.h | 2 +- .../Concepts/SphericalKernel--CompareX_3.h | 2 +- .../Concepts/SphericalKernel--CompareY_3.h | 2 +- .../SphericalKernel--CompareZAtTheta_3.h | 4 +- .../SphericalKernel--CompareZToRight_3.h | 2 +- .../Concepts/SphericalKernel--CompareZ_3.h | 2 +- ...hericalKernel--ComputeApproximateAngle_3.h | 2 +- ...ernel--ComputeApproximateSquaredLength_3.h | 2 +- .../SphericalKernel--ComputeCircularX_3.h | 2 +- .../SphericalKernel--ComputeCircularY_3.h | 2 +- .../SphericalKernel--ComputeCircularZ_3.h | 2 +- .../SphericalKernel--ConstructBbox_3.h | 6 +- .../SphericalKernel--ConstructCircle_3.h | 4 +- ...ricalKernel--ConstructCircularArcPoint_3.h | 4 +- .../SphericalKernel--ConstructCircularArc_3.h | 6 +- ...icalKernel--ConstructCircularMaxVertex_3.h | 2 +- ...icalKernel--ConstructCircularMinVertex_3.h | 2 +- ...lKernel--ConstructCircularSourceVertex_3.h | 4 +- ...lKernel--ConstructCircularTargetVertex_3.h | 4 +- .../SphericalKernel--ConstructLineArc_3.h | 6 +- .../SphericalKernel--ConstructLine_3.h | 4 +- .../SphericalKernel--ConstructPlane_3.h | 4 +- .../SphericalKernel--ConstructSphere_3.h | 4 +- .../Concepts/SphericalKernel--DoIntersect_3.h | 2 +- .../Concepts/SphericalKernel--DoOverlap_3.h | 4 +- .../Concepts/SphericalKernel--Equal_3.h | 6 +- .../Concepts/SphericalKernel--GetEquation.h | 8 +- .../SphericalKernel--HasOnBoundedSide_3.h | 4 +- .../SphericalKernel--HasOnUnboundedSide_3.h | 4 +- .../Concepts/SphericalKernel--HasOn_3.h | 2 +- .../SphericalKernel--IsThetaMonotone_3.h | 2 +- .../SphericalKernel--MakeThetaMonotone_3.h | 4 +- .../Concepts/SphericalKernel--Split_3.h | 4 +- .../Concepts/SphericalKernel.h | 124 +-- .../doc/Circulator/Concepts/Circulator.h | 2 +- .../doc/Circulator/Concepts/ConstRange.h | 12 +- Circulator/doc/Circulator/Concepts/Handle.h | 4 +- Circulator/doc/Circulator/Concepts/Range.h | 18 +- .../CGAL/Convex_hull_projective_xy_traits_2.h | 28 +- .../CGAL/Convex_hull_projective_xz_traits_2.h | 28 +- .../CGAL/Convex_hull_projective_yz_traits_2.h | 28 +- .../CGAL/convex_hull_constructive_traits_2.h | 28 +- .../Convex_hull_2/CGAL/convex_hull_traits_2.h | 28 +- .../Concepts/ConvexHullTraits_2.h | 28 +- .../Convex_hull_3/CGAL/Convex_hull_traits_3.h | 90 +- .../Concepts/ConvexHullPolyhedronFacet_3.h | 16 +- .../Concepts/ConvexHullPolyhedronHalfedge_3.h | 16 +- .../Concepts/ConvexHullPolyhedronVertex_3.h | 6 +- .../Concepts/ConvexHullPolyhedron_3.h | 40 +- .../Concepts/ConvexHullTraits_3.h | 34 +- .../Concepts/IsStronglyConvexTraits_3.h | 24 +- .../CGAL/Convex_hull_d_to_polyhedron_3.h | 4 +- .../CGAL/Convex_hull_d_traits_3.h | 2 +- .../Concepts/ConvexHullTraits_d.h | 36 +- .../Concepts/DelaunayLiftedTraits_d.h | 42 +- .../Convex_hull_d/Concepts/DelaunayTraits_d.h | 18 +- .../Envelope_2/Concepts/EnvelopeDiagramEdge.h | 34 +- .../Concepts/EnvelopeDiagramVertex.h | 38 +- .../Envelope_2/Concepts/EnvelopeDiagram_1.h | 42 +- .../CGAL/Env_surface_data_traits_3.h | 32 +- Envelope_3/doc/Envelope_3/CGAL/envelope_3.h | 34 +- .../Envelope_3/Concepts/EnvelopeTraits_3.h | 34 +- Generator/doc/Generator/CGAL/Random.h | 32 +- .../CGAL/Random_convex_set_traits_2.h | 16 +- .../doc/Generator/Concepts/PointGenerator.h | 4 +- .../Concepts/RandomConvexSetTraits_2.h | 14 +- .../Concepts/RandomPolygonTraits_2.h | 12 +- .../CGAL/Qt/CircularArcGraphicsItem.h | 8 +- .../Qt/ConstrainedTriangulationGraphicsItem.h | 6 +- .../doc/GraphicsView/CGAL/Qt/Converter.h | 26 +- .../doc/GraphicsView/CGAL/Qt/GraphicsItem.h | 2 +- .../CGAL/Qt/GraphicsViewCircleInput.h | 4 +- .../CGAL/Qt/GraphicsViewCircularArcInput.h | 4 +- .../GraphicsView/CGAL/Qt/GraphicsViewInput.h | 2 +- .../CGAL/Qt/GraphicsViewIsoRectangleInput.h | 4 +- .../CGAL/Qt/GraphicsViewNavigation.h | 4 +- .../CGAL/Qt/GraphicsViewPolylineInput.h | 4 +- .../doc/GraphicsView/CGAL/Qt/PainterOstream.h | 26 +- .../CGAL/Qt/TriangulationGraphicsItem.h | 18 +- .../CGAL/Qt/VoronoiGraphicsItem.h | 10 +- .../CGAL/HalfedgeDS_const_decorator.h | 6 +- .../HalfedgeDS/CGAL/HalfedgeDS_decorator.h | 64 +- .../doc/HalfedgeDS/CGAL/HalfedgeDS_default.h | 4 +- .../HalfedgeDS/CGAL/HalfedgeDS_face_base.h | 10 +- .../CGAL/HalfedgeDS_face_min_base.h | 2 +- .../CGAL/HalfedgeDS_halfedge_base.h | 2 +- .../CGAL/HalfedgeDS_halfedge_min_base.h | 2 +- .../CGAL/HalfedgeDS_items_decorator.h | 88 +- .../doc/HalfedgeDS/CGAL/HalfedgeDS_list.h | 10 +- .../doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h | 4 +- .../HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h | 10 +- .../CGAL/HalfedgeDS_vertex_min_base.h | 2 +- .../doc/HalfedgeDS/Concepts/HalfedgeDSFace.h | 30 +- .../HalfedgeDS/Concepts/HalfedgeDSHalfedge.h | 62 +- .../doc/HalfedgeDS/Concepts/HalfedgeDSItems.h | 6 +- .../HalfedgeDS/Concepts/HalfedgeDSVertex.h | 30 +- .../CGAL/Extremal_polygon_traits_2.h | 44 +- .../CGAL/Largest_empty_iso_rectangle_2.h | 40 +- .../Concepts/ExtremalPolygonTraits_2.h | 22 +- .../LargestEmptyIsoRectangleTraits_2.h | 26 +- .../Interpolation_gradient_fitting_traits_2.h | 36 +- .../CGAL/Interpolation_traits_2.h | 18 +- .../CGAL/Voronoi_intersection_2_traits_3.h | 36 +- .../CGAL/interpolation_functions.h | 8 +- .../Concepts/GradientFittingTraits.h | 32 +- .../Concepts/InterpolationTraits.h | 20 +- .../CGAL/Interval_skip_list.h | 26 +- .../CGAL/Interval_skip_list_interval.h | 10 +- .../Interval_skip_list/CGAL/Level_interval.h | 10 +- .../Interval_skip_list/Concepts/Interval.h | 16 +- .../CGAL/Monge_via_jet_fitting.h | 42 +- .../doc/Jet_fitting_3/Concepts/DataKernel.h | 6 +- .../doc/Jet_fitting_3/Concepts/LocalKernel.h | 6 +- .../doc/Jet_fitting_3/Concepts/SvdTraits.h | 26 +- .../doc/Kernel_23/CGAL/Aff_transformation_2.h | 48 +- .../doc/Kernel_23/CGAL/Aff_transformation_3.h | 42 +- Kernel_23/doc/Kernel_23/CGAL/Bbox_2.h | 22 +- Kernel_23/doc/Kernel_23/CGAL/Bbox_3.h | 26 +- Kernel_23/doc/Kernel_23/CGAL/Cartesian.h | 4 +- .../doc/Kernel_23/CGAL/Cartesian_converter.h | 4 +- Kernel_23/doc/Kernel_23/CGAL/Circle_2.h | 40 +- Kernel_23/doc/Kernel_23/CGAL/Circle_3.h | 36 +- Kernel_23/doc/Kernel_23/CGAL/Dimension.h | 10 +- Kernel_23/doc/Kernel_23/CGAL/Direction_2.h | 36 +- Kernel_23/doc/Kernel_23/CGAL/Direction_3.h | 28 +- .../doc/Kernel_23/CGAL/Filtered_kernel.h | 6 +- .../doc/Kernel_23/CGAL/Filtered_predicate.h | 8 +- Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h | 4 +- .../Kernel_23/CGAL/Homogeneous_converter.h | 4 +- Kernel_23/doc/Kernel_23/CGAL/Iso_cuboid_3.h | 52 +- .../doc/Kernel_23/CGAL/Iso_rectangle_2.h | 48 +- Kernel_23/doc/Kernel_23/CGAL/Kernel_traits.h | 2 +- Kernel_23/doc/Kernel_23/CGAL/Line_2.h | 54 +- Kernel_23/doc/Kernel_23/CGAL/Line_3.h | 32 +- Kernel_23/doc/Kernel_23/CGAL/Plane_3.h | 64 +- Kernel_23/doc/Kernel_23/CGAL/Point_2.h | 56 +- Kernel_23/doc/Kernel_23/CGAL/Point_3.h | 60 +- .../Kernel_23/CGAL/Projection_traits_xy_3.h | 16 +- Kernel_23/doc/Kernel_23/CGAL/Ray_2.h | 36 +- Kernel_23/doc/Kernel_23/CGAL/Ray_3.h | 30 +- Kernel_23/doc/Kernel_23/CGAL/Segment_2.h | 44 +- Kernel_23/doc/Kernel_23/CGAL/Segment_3.h | 38 +- .../doc/Kernel_23/CGAL/Simple_cartesian.h | 4 +- .../doc/Kernel_23/CGAL/Simple_homogeneous.h | 4 +- Kernel_23/doc/Kernel_23/CGAL/Sphere_3.h | 48 +- Kernel_23/doc/Kernel_23/CGAL/Tetrahedron_3.h | 34 +- Kernel_23/doc/Kernel_23/CGAL/Triangle_2.h | 36 +- Kernel_23/doc/Kernel_23/CGAL/Triangle_3.h | 22 +- Kernel_23/doc/Kernel_23/CGAL/Vector_2.h | 72 +- Kernel_23/doc/Kernel_23/CGAL/Vector_3.h | 74 +- .../Concepts/FunctionObjectConcepts.h | 956 +++++++++--------- Kernel_23/doc/Kernel_23/Concepts/Kernel.h | 434 ++++---- .../CGAL/Kernel_d/Aff_transformation_d.h | 28 +- .../doc/Kernel_d/CGAL/Kernel_d/Direction_d.h | 38 +- .../doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h | 46 +- .../doc/Kernel_d/CGAL/Kernel_d/Iso_box_d.h | 22 +- Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Line_d.h | 32 +- Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h | 50 +- Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Ray_d.h | 30 +- .../doc/Kernel_d/CGAL/Kernel_d/Segment_d.h | 48 +- .../doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h | 46 +- .../doc/Kernel_d/CGAL/Kernel_d/Vector_d.h | 74 +- .../Kernel_d/Concepts/Kernel--Affine_rank_d.h | 2 +- .../Concepts/Kernel--Affinely_independent_d.h | 2 +- .../Concepts/Kernel--Center_of_sphere_d.h | 2 +- .../Kernel--Compare_lexicographically_d.h | 2 +- .../Concepts/Kernel--Component_accessor_d.h | 6 +- .../Concepts/Kernel--Compute_coordinate_d.h | 2 +- ...ernel--ConstructCartesianConstIterator_d.h | 4 +- .../Kernel--Contained_in_affine_hull_d.h | 2 +- .../Kernel--Contained_in_linear_hull_d.h | 2 +- .../Concepts/Kernel--Contained_in_simplex_d.h | 2 +- .../doc/Kernel_d/Concepts/Kernel--Equal_d.h | 2 +- .../Concepts/Kernel--Has_on_positive_side_d.h | 2 +- .../Kernel_d/Concepts/Kernel--Intersect_d.h | 2 +- .../Concepts/Kernel--Less_coordinate_d.h | 2 +- .../Kernel--Less_lexicographically_d.h | 2 +- ...ernel--Less_or_equal_lexicographically_d.h | 2 +- .../Concepts/Kernel--Lift_to_paraboloid_d.h | 2 +- .../Kernel_d/Concepts/Kernel--Linear_base_d.h | 2 +- .../Kernel_d/Concepts/Kernel--Linear_rank_d.h | 2 +- .../Concepts/Kernel--Linearly_independent_d.h | 2 +- .../Kernel_d/Concepts/Kernel--Midpoint_d.h | 2 +- .../Kernel_d/Concepts/Kernel--Orientation_d.h | 2 +- .../Concepts/Kernel--Oriented_side_d.h | 2 +- .../Concepts/Kernel--Orthogonal_vector_d.h | 2 +- .../Concepts/Kernel--Point_dimension_d.h | 2 +- .../Concepts/Kernel--Point_of_sphere_d.h | 2 +- .../Concepts/Kernel--Point_to_vector_d.h | 2 +- .../Concepts/Kernel--Project_along_d_axis_d.h | 2 +- .../Kernel--Side_of_bounded_sphere_d.h | 2 +- .../Kernel--Side_of_oriented_sphere_d.h | 2 +- .../Concepts/Kernel--Squared_distance_d.h | 2 +- .../Kernel_d/Concepts/Kernel--Value_at_d.h | 2 +- .../Concepts/Kernel--Vector_to_point_d.h | 2 +- Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h | 120 +-- .../Kernel_d/Concepts/LinearAlgebraTraits_d.h | 36 +- Kernel_d/doc/Kernel_d/Concepts/Matrix.h | 92 +- Kernel_d/doc/Kernel_d/Concepts/Vector.h | 48 +- .../CGAL/Kinetic/Delaunay_triangulation_2.h | 14 +- .../CGAL/Kinetic/Delaunay_triangulation_3.h | 14 +- ...nay_triangulation_recent_edges_visitor_2.h | 10 +- .../Delaunay_triangulation_visitor_base_2.h | 2 +- .../Delaunay_triangulation_visitor_base_3.h | 2 +- .../CGAL/Kinetic/Enclosing_box_2.h | 4 +- .../CGAL/Kinetic/Enclosing_box_3.h | 4 +- .../CGAL/Kinetic/Erase_event.h | 2 +- .../CGAL/Kinetic/IO/Qt_moving_points_2.h | 2 +- .../CGAL/Kinetic/IO/Qt_triangulation_2.h | 2 +- .../CGAL/Kinetic/IO/Qt_widget_2.h | 2 +- .../CGAL/Kinetic/Insert_event.h | 2 +- .../Regular_triangulation_visitor_base_3.h | 2 +- .../CGAL/Kinetic/Sort.h | 24 +- .../CGAL/Kinetic/Sort_visitor_base.h | 2 +- .../Concepts/DelaunayTriangulationVisitor_2.h | 18 +- .../Concepts/DelaunayTriangulationVisitor_3.h | 22 +- .../Concepts/EventLogVisitor.h | 6 +- .../Concepts/RegularTriangulationVisitor_3.h | 4 +- .../Concepts/SortVisitor.h | 14 +- .../CGAL/Kinetic/Cartesian.h | 38 +- .../Kinetic/Default_instantaneous_kernel.h | 32 +- .../CGAL/Kinetic/Default_simulator.h | 2 +- .../Kinetic_framework/CGAL/Kinetic/Listener.h | 10 +- .../CGAL/Kinetic/Ref_counted.h | 6 +- .../CGAL/Kinetic/Simulator_objects_listener.h | 2 +- .../CGAL/Kinetic/listeners.h | 2 +- .../Concepts/ActiveObjectsTable.h | 36 +- .../Concepts/CertificateGenerator.h | 4 +- .../Kinetic_framework/Concepts/EvenQueue.h | 26 +- .../Concepts/FunctionKernel.h | 26 +- .../Concepts/InstantaneousKernel.h | 16 +- .../doc/Kinetic_framework/Concepts/Key.h | 6 +- .../Concepts/Kinetic--Certificate.h | 6 +- .../Concepts/KineticKernel.h | 8 +- .../Kinetic_framework/Concepts/RootStack.h | 14 +- .../Concepts/SimulationTraits.h | 22 +- .../Kinetic_framework/Concepts/Simulator.h | 76 +- .../doc/Matrix_search/CGAL/Dynamic_matrix.h | 14 +- .../Sorted_matrix_search_traits_adaptor.h | 16 +- .../doc/Matrix_search/Concepts/BasicMatrix.h | 8 +- .../Concepts/MonotoneMatrixSearchTraits.h | 14 +- .../Concepts/SortedMatrixSearchTraits.h | 14 +- .../Mesh_2/CGAL/Delaunay_mesh_criteria_2.h | 4 +- .../CGAL/Delaunay_mesh_size_criteria_2.h | 4 +- Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h | 30 +- .../Mesh_2/CGAL/Triangulation_conformer_2.h | 20 +- .../ConformingDelaunayTriangulationTraits_2.h | 28 +- .../Mesh_2/Concepts/DelaunayMeshFaceBase_2.h | 4 +- .../Mesh_2/Concepts/DelaunayMeshTraits_2.h | 8 +- .../doc/Mesh_2/Concepts/MeshingCriteria_2.h | 8 +- .../doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h | 2 +- .../Mesh_3/CGAL/Labeled_image_mesh_domain_3.h | 2 +- Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h | 6 +- .../CGAL/Mesh_complex_3_in_triangulation_3.h | 12 +- .../CGAL/Mesh_constant_domain_field_3.h | 10 +- Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h | 12 +- .../Mesh_domain_with_polyline_features_3.h | 10 +- Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h | 6 +- .../doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h | 6 +- Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_topology.h | 2 +- Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h | 2 +- .../Mesh_3/CGAL/Polyhedral_mesh_domain_3.h | 2 +- .../Polyhedral_mesh_domain_with_features_3.h | 8 +- Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h | 6 +- .../Concepts/BisectionGeometricTraits_3.h | 58 +- .../Concepts/IntersectionGeometricTraits_3.h | 14 +- Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h | 18 +- Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h | 24 +- .../doc/Mesh_3/Concepts/MeshCellCriteria_3.h | 8 +- ...shComplexWithFeatures_3InTriangulation_3.h | 58 +- .../Concepts/MeshComplex_3InTriangulation_3.h | 90 +- .../Concepts/MeshCriteriaWithFeatures_3.h | 4 +- Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h | 8 +- .../doc/Mesh_3/Concepts/MeshDomainField_3.h | 8 +- .../doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h | 10 +- .../doc/Mesh_3/Concepts/MeshFacetCriteria_3.h | 12 +- Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h | 8 +- Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h | 16 +- .../doc/Mesh_3/Concepts/TriangleAccessor_3.h | 14 +- .../Concepts/PolygonConvexDecomposition_2.h | 10 +- .../Miscellany/CGAL/Handle_hash_function.h | 4 +- Miscellany/doc/Miscellany/CGAL/Memory_sizer.h | 8 +- .../doc/Miscellany/CGAL/Modifier_base.h | 4 +- .../doc/Miscellany/CGAL/Profile_counter.h | 6 +- Miscellany/doc/Miscellany/CGAL/Real_timer.h | 18 +- Miscellany/doc/Miscellany/CGAL/Timer.h | 18 +- Miscellany/doc/Miscellany/CGAL/Union_find.h | 40 +- .../doc/Miscellany/CGAL/Unique_hash_map.h | 26 +- .../Miscellany/Concepts/UniqueHashFunction.h | 8 +- .../doc/Modular_arithmetic/CGAL/Residue.h | 38 +- .../Concepts/ModularTraits--ModularImage.h | 6 +- ...odularTraits--ModularImageRepresentative.h | 6 +- .../Concepts/ModularTraits.h | 10 +- Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h | 2 +- Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h | 2 +- .../CGAL/Filtered_extended_homogeneous.h | 2 +- Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h | 166 +-- .../Nef_2/Concepts/ExtendedKernelTraits_2.h | 88 +- Nef_3/doc/Nef_3/CGAL/IO/Qt_widget_Nef_3.h | 2 +- Nef_3/doc/Nef_3/CGAL/Nef_nary_union_3.h | 6 +- Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h | 380 +++---- Nef_S2/doc/Nef_S2/CGAL/IO/Qt_widget_Nef_S2.h | 2 +- Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h | 278 ++--- Number_types/doc/Number_types/CGAL/FPU.h | 10 +- Number_types/doc/Number_types/CGAL/Gmpfi.h | 64 +- Number_types/doc/Number_types/CGAL/Gmpfr.h | 90 +- Number_types/doc/Number_types/CGAL/Gmpq.h | 30 +- Number_types/doc/Number_types/CGAL/Gmpz.h | 48 +- Number_types/doc/Number_types/CGAL/Gmpzf.h | 18 +- .../doc/Number_types/CGAL/Interval_nt.h | 56 +- .../doc/Number_types/CGAL/Lazy_exact_nt.h | 22 +- Number_types/doc/Number_types/CGAL/MP_Float.h | 20 +- .../doc/Number_types/CGAL/NT_converter.h | 2 +- .../Number_types/CGAL/Number_type_checker.h | 22 +- Number_types/doc/Number_types/CGAL/Quotient.h | 24 +- .../doc/Number_types/CGAL/Rational_traits.h | 14 +- .../doc/Number_types/CGAL/Root_of_traits.h | 4 +- .../doc/Number_types/CGAL/Sqrt_extension.h | 62 +- Number_types/doc/Number_types/CGAL/double.h | 2 +- Number_types/doc/Number_types/CGAL/float.h | 2 +- .../doc/Number_types/CGAL/long_double.h | 2 +- .../doc/Number_types/CGAL/utils_classes.h | 14 +- .../doc/Number_types/Concepts/RootOf_2.h | 8 +- .../CGAL/Partition_is_valid_traits_2.h | 14 +- .../doc/Partition_2/CGAL/Partition_traits_2.h | 54 +- .../CGAL/polygon_function_objects.h | 12 +- .../Concepts/ConvexPartitionIsValidTraits_2.h | 6 +- .../Concepts/IsYMonotoneTraits_2.h | 8 +- .../Concepts/OptimalConvexPartitionTraits_2.h | 28 +- .../Concepts/PartitionIsValidTraits_2.h | 22 +- .../Partition_2/Concepts/PartitionTraits_2.h | 32 +- .../doc/Partition_2/Concepts/PolygonIsValid.h | 4 +- .../YMonotonePartitionIsValidTraits_2.h | 6 +- .../Concepts/YMonotonePartitionTraits_2.h | 18 +- .../CGAL/Periodic_2_triangulation_2.h | 4 +- .../Periodic_3_Delaunay_triangulation_3.h | 58 +- .../CGAL/Periodic_3_triangulation_3.h | 262 ++--- .../Periodic_3DelaunayTriangulationTraits_3.h | 66 +- .../Concepts/Periodic_3Offset_3.h | 34 +- .../Periodic_3TriangulationDSCellBase_3.h | 4 +- .../Periodic_3TriangulationDSVertexBase_3.h | 10 +- .../doc/Point_set_2/CGAL/Point_set_2.h | 38 +- .../doc/Point_set_2/Concepts/PointSetTraits.h | 22 +- .../doc/Polygon/Concepts/PolygonTraits_2.h | 38 +- Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h | 368 +++---- .../CGAL/Polyhedron_incremental_builder_3.h | 42 +- .../doc/Polyhedron/CGAL/Polyhedron_items_3.h | 10 +- .../Polyhedron/CGAL/Polyhedron_min_items_3.h | 8 +- .../doc/Polyhedron/CGAL/Polyhedron_traits_3.h | 14 +- .../CGAL/Polyhedron_traits_with_normals_3.h | 14 +- .../Polyhedron/Concepts/PolyhedronTraits_3.h | 12 +- .../doc/Polynomial/CGAL/Exponent_vector.h | 34 +- Polynomial/doc/Polynomial/CGAL/Polynomial.h | 24 +- .../CGAL/Polynomial_type_generator.h | 2 +- .../PolynomialTraits_d--Canonicalize.h | 6 +- .../Concepts/PolynomialTraits_d--Compare.h | 8 +- ...--ConstructCoefficientConstIteratorRange.h | 6 +- ...ctInnermostCoefficientConstIteratorRange.h | 6 +- .../PolynomialTraits_d--ConstructPolynomial.h | 14 +- .../Concepts/PolynomialTraits_d--Degree.h | 8 +- .../PolynomialTraits_d--DegreeVector.h | 6 +- .../PolynomialTraits_d--Differentiate.h | 8 +- .../Concepts/PolynomialTraits_d--Evaluate.h | 8 +- .../PolynomialTraits_d--EvaluateHomogeneous.h | 4 +- ...olynomialTraits_d--GcdUpToConstantFactor.h | 8 +- .../PolynomialTraits_d--GetCoefficient.h | 8 +- ...ynomialTraits_d--GetInnermostCoefficient.h | 8 +- ...ialTraits_d--InnermostLeadingCoefficient.h | 6 +- ...ts_d--IntegralDivisionUpToConstantFactor.h | 8 +- .../Concepts/PolynomialTraits_d--Invert.h | 8 +- .../PolynomialTraits_d--IsSquareFree.h | 6 +- .../Concepts/PolynomialTraits_d--IsZeroAt.h | 4 +- .../PolynomialTraits_d--IsZeroAtHomogeneous.h | 4 +- .../PolynomialTraits_d--LeadingCoefficient.h | 6 +- .../PolynomialTraits_d--MakeSquareFree.h | 6 +- ...lynomialTraits_d--MonomialRepresentation.h | 2 +- .../Concepts/PolynomialTraits_d--Move.h | 4 +- .../PolynomialTraits_d--MultivariateContent.h | 6 +- .../Concepts/PolynomialTraits_d--Negate.h | 8 +- .../Concepts/PolynomialTraits_d--Permute.h | 4 +- ...ynomialTraits_d--PolynomialSubresultants.h | 4 +- ..._d--PolynomialSubresultantsWithCofactors.h | 4 +- ...lTraits_d--PrincipalSturmHabichtSequence.h | 4 +- ...lynomialTraits_d--PrincipalSubresultants.h | 4 +- .../PolynomialTraits_d--PseudoDivision.h | 4 +- ...lynomialTraits_d--PseudoDivisionQuotient.h | 8 +- ...ynomialTraits_d--PseudoDivisionRemainder.h | 8 +- .../Concepts/PolynomialTraits_d--Resultant.h | 8 +- .../Concepts/PolynomialTraits_d--Scale.h | 10 +- .../PolynomialTraits_d--ScaleHomogeneous.h | 6 +- .../Concepts/PolynomialTraits_d--Shift.h | 10 +- .../Concepts/PolynomialTraits_d--SignAt.h | 4 +- .../PolynomialTraits_d--SignAtHomogeneous.h | 4 +- .../PolynomialTraits_d--SquareFreeFactorize.h | 4 +- ...d--SquareFreeFactorizeUpToConstantFactor.h | 2 +- ...PolynomialTraits_d--SturmHabichtSequence.h | 4 +- ...its_d--SturmHabichtSequenceWithCofactors.h | 4 +- .../Concepts/PolynomialTraits_d--Substitute.h | 2 +- ...olynomialTraits_d--SubstituteHomogeneous.h | 2 +- .../Concepts/PolynomialTraits_d--Swap.h | 4 +- .../PolynomialTraits_d--TotalDegree.h | 6 +- .../Concepts/PolynomialTraits_d--Translate.h | 10 +- ...PolynomialTraits_d--TranslateHomogeneous.h | 6 +- .../PolynomialTraits_d--UnivariateContent.h | 6 +- ...s_d--UnivariateContentUpToConstantFactor.h | 6 +- .../Polynomial/Concepts/PolynomialTraits_d.h | 110 +- .../CGAL/Polytope_distance_d.h | 106 +- .../CGAL/Polytope_distance_d_traits_2.h | 28 +- .../CGAL/Polytope_distance_d_traits_3.h | 28 +- .../CGAL/Polytope_distance_d_traits_d.h | 28 +- .../doc/Polytope_distance_d/CGAL/Width_3.h | 28 +- .../CGAL/Width_default_traits_3.h | 38 +- .../Concepts/AllFurthestNeighborsTraits_2.h | 16 +- .../Concepts/PolytopeDistanceDTraits.h | 28 +- .../Concepts/WidthTraits_3.h | 38 +- QP_solver/doc/QP_solver/CGAL/QP_models.h | 68 +- QP_solver/doc/QP_solver/CGAL/QP_options.h | 14 +- QP_solver/doc/QP_solver/CGAL/QP_solution.h | 88 +- .../doc/QP_solver/Concepts/LinearProgram.h | 38 +- .../Concepts/NonnegativeLinearProgram.h | 22 +- .../Concepts/NonnegativeQuadraticProgram.h | 26 +- .../doc/QP_solver/Concepts/QuadraticProgram.h | 42 +- Ridges_3/doc/Ridges_3/CGAL/Ridges.h | 40 +- Ridges_3/doc/Ridges_3/CGAL/Umbilics.h | 16 +- .../Concepts/TriangulatedSurfaceMesh.h | 60 +- .../STL_Extension/CGAL/Compact_container.h | 106 +- .../doc/STL_Extension/CGAL/Default.h | 2 +- .../doc/STL_Extension/CGAL/Fourtuple.h | 14 +- .../doc/STL_Extension/CGAL/In_place_list.h | 114 +-- .../doc/STL_Extension/CGAL/Multiset.h | 80 +- STL_Extension/doc/STL_Extension/CGAL/Object.h | 20 +- .../doc/STL_Extension/CGAL/Sixtuple.h | 18 +- .../doc/STL_Extension/CGAL/Twotuple.h | 10 +- .../doc/STL_Extension/CGAL/Uncertain.h | 128 +-- STL_Extension/doc/STL_Extension/CGAL/array.h | 2 +- .../doc/STL_Extension/CGAL/function_objects.h | 236 ++--- STL_Extension/doc/STL_Extension/CGAL/tags.h | 2 +- .../Concepts/Projection_object.h | 10 +- .../CGAL/Range_segment_tree_traits.h | 24 +- .../doc/SearchStructures/CGAL/Range_tree_d.h | 18 +- .../doc/SearchStructures/CGAL/Range_tree_k.h | 14 +- .../SearchStructures/CGAL/Segment_tree_d.h | 20 +- .../SearchStructures/CGAL/Segment_tree_k.h | 16 +- .../doc/SearchStructures/CGAL/Tree_base.h | 16 +- .../doc/SearchStructures/CGAL/Tree_traits.h | 50 +- .../Concepts/RangeSegmentTreeTraits_k.h | 14 +- .../CGAL/Segment_Delaunay_graph_2.h | 176 ++-- ...Segment_Delaunay_graph_filtered_traits_2.h | 48 +- .../CGAL/Segment_Delaunay_graph_hierarchy_2.h | 12 +- .../CGAL/Segment_Delaunay_graph_site_2.h | 2 +- .../Segment_Delaunay_graph_storage_site_2.h | 2 +- .../CGAL/Segment_Delaunay_graph_traits_2.h | 12 +- .../SegmentDelaunayGraphDataStructure_2.h | 4 +- ...egmentDelaunayGraphHierarchyVertexBase_2.h | 8 +- .../Concepts/SegmentDelaunayGraphSite_2.h | 58 +- .../SegmentDelaunayGraphStorageSite_2.h | 50 +- .../Concepts/SegmentDelaunayGraphTraits_2.h | 76 +- .../SegmentDelaunayGraphVertexBase_2.h | 30 +- .../Concepts/SkinSurfaceTraits_3.h | 10 +- .../Skin_surface_3/Concepts/SkinSurface_3.h | 14 +- .../Concepts/SnapRoundingTraits_2.h | 42 +- .../CGAL/Euclidean_distance.h | 20 +- .../CGAL/Euclidean_distance_sphere_point.h | 18 +- .../Spatial_searching/CGAL/Fuzzy_iso_box.h | 14 +- .../doc/Spatial_searching/CGAL/Fuzzy_sphere.h | 14 +- .../CGAL/Incremental_neighbor_search.h | 22 +- .../CGAL/K_neighbor_search.h | 22 +- .../doc/Spatial_searching/CGAL/Kd_tree.h | 45 +- .../doc/Spatial_searching/CGAL/Kd_tree_node.h | 40 +- .../CGAL/Kd_tree_rectangle.h | 24 +- .../CGAL/Manhattan_distance_iso_box_point.h | 18 +- .../Orthogonal_incremental_neighbor_search.h | 22 +- .../CGAL/Orthogonal_k_neighbor_search.h | 22 +- .../Spatial_searching/CGAL/Plane_separator.h | 16 +- .../Spatial_searching/CGAL/Point_container.h | 66 +- .../Spatial_searching/CGAL/Search_traits.h | 12 +- .../Spatial_searching/CGAL/Search_traits_2.h | 22 +- .../Spatial_searching/CGAL/Search_traits_3.h | 20 +- .../CGAL/Search_traits_adapter.h | 22 +- .../Spatial_searching/CGAL/Search_traits_d.h | 16 +- .../doc/Spatial_searching/CGAL/Splitters.h | 34 +- .../CGAL/Weighted_Minkowski_distance.h | 20 +- .../Concepts/FuzzyQueryItem.h | 10 +- .../Concepts/GeneralDistance.h | 16 +- .../Concepts/OrthogonalDistance.h | 20 +- .../Concepts/RangeSearchTraits.h | 14 +- .../Spatial_searching/Concepts/SearchTraits.h | 10 +- .../Concepts/SpatialSeparator.h | 14 +- .../Spatial_searching/Concepts/SpatialTree.h | 32 +- .../doc/Spatial_searching/Concepts/Splitter.h | 12 +- .../doc/Spatial_sorting/CGAL/Hilbert_sort_2.h | 4 +- .../doc/Spatial_sorting/CGAL/Hilbert_sort_3.h | 4 +- .../doc/Spatial_sorting/CGAL/Hilbert_sort_d.h | 4 +- .../Spatial_sorting/CGAL/Multiscale_sort.h | 4 +- .../CGAL/Spatial_sort_traits_adapter_2.h | 8 +- .../CGAL/Spatial_sort_traits_adapter_3.h | 8 +- .../CGAL/Spatial_sort_traits_adapter_d.h | 8 +- .../Concepts/SpatialSortingTraits_2.h | 20 +- .../Concepts/SpatialSortingTraits_3.h | 28 +- .../Concepts/SpatialSortingTraits_d.h | 16 +- .../CGAL/Polygon_offset_builder_2.h | 12 +- .../CGAL/Straight_skeleton_builder_2.h | 12 +- .../CGAL/Straight_skeleton_converter_2.h | 12 +- .../Concepts/PolygonOffsetBuilderTraits_2.h | 22 +- .../StraightSkeletonBuilderTraits_2.h | 34 +- .../StraightSkeletonBuilder_2_Visitor.h | 40 +- .../Concepts/StraightSkeletonFace_2.h | 6 +- .../Concepts/StraightSkeletonHalfedge_2.h | 12 +- .../StraightSkeletonItemsConverter_2.h | 18 +- .../Concepts/StraightSkeletonVertex_2.h | 40 +- .../Concepts/StraightSkeleton_2.h | 6 +- .../Concepts/VertexContainer_2.h | 10 +- .../Stream_lines_2/CGAL/Euler_integrator_2.h | 2 +- .../doc/Stream_lines_2/CGAL/Regular_grid_2.h | 14 +- .../CGAL/Runge_kutta_integrator_2.h | 2 +- .../doc/Stream_lines_2/CGAL/Stream_lines_2.h | 30 +- .../Stream_lines_2/CGAL/Triangular_field_2.h | 8 +- .../Stream_lines_2/Concepts/Integrator_2.h | 16 +- .../Concepts/StreamLinesTraits_2.h | 6 +- .../Stream_lines_2/Concepts/VectorField_2.h | 18 +- .../doc/Stream_support/CGAL/IO/Color.h | 28 +- .../Stream_support/CGAL/IO/Istream_iterator.h | 4 +- .../Stream_support/CGAL/IO/Ostream_iterator.h | 2 +- .../Stream_support/CGAL/IO/Verbose_ostream.h | 4 +- .../CGAL/Subdivision_mask_3.h | 28 +- .../CGAL/Subdivision_method_3.h | 16 +- .../Subdivision_method_3/Concepts/DQQMask_3.h | 2 +- .../Subdivision_method_3/Concepts/PQQMask_3.h | 8 +- .../Subdivision_method_3/Concepts/PTQMask_3.h | 6 +- .../Concepts/Sqrt3Mask_3.h | 4 +- .../Concepts/BorderParameterizer_3.h | 8 +- .../Concepts/ParameterizationMesh_3.h | 112 +- .../ParameterizationPatchableMesh_3.h | 24 +- .../Concepts/ParameterizerTraits_3.h | 4 +- .../Concepts/PolyhedronTraitsWithKernel_3.h | 2 +- .../Concepts/SparseLinearAlgebraTraits_d.h | 38 +- .../include/CGAL/Eigen_matrix.h | 4 +- .../include/CGAL/Eigen_solver_traits.h | 8 +- .../include/CGAL/Eigen_vector.h | 2 +- .../Count_ratio_stop_predicate.h | 4 +- .../Edge_collapse/Count_stop_predicate.h | 4 +- .../Policies/Edge_collapse/Edge_length_cost.h | 4 +- .../Edge_collapse/LindstromTurk_cost.h | 4 +- .../Edge_collapse/LindstromTurk_placement.h | 4 +- .../Edge_collapse/Midpoint_placement.h | 4 +- .../Concepts/EdgeCollapsableMesh.h | 2 +- .../EdgeCollapseSimplificationVisitor.h | 24 +- .../Concepts/EdgeProfile.h | 40 +- .../Concepts/GetCost.h | 10 +- .../Concepts/GetPlacement.h | 8 +- .../Concepts/StopPredicate.h | 10 +- .../Surface_mesher/CGAL/Gray_level_image_3.h | 6 +- .../Surface_mesher/CGAL/Implicit_surface_3.h | 2 +- .../CGAL/Surface_mesh_default_criteria_3.h | 4 +- .../CGAL/Surface_mesh_traits_generator_3.h | 2 +- .../Concepts/ImplicitFunction.h | 6 +- .../Concepts/ImplicitSurfaceTraits_3.h | 58 +- .../Concepts/SurfaceMeshCellBase_3.h | 14 +- .../SurfaceMeshComplex_2InTriangulation_3.h | 82 +- .../Concepts/SurfaceMeshFacetsCriteria_3.h | 6 +- .../Concepts/SurfaceMeshTraits_3.h | 18 +- .../Concepts/SurfaceMeshTriangulation_3.h | 68 +- .../Concepts/SurfaceMeshVertexBase_3.h | 8 +- .../doc/Surface_mesher/Concepts/Surface_3.h | 2 +- .../CGAL/Triangulation_data_structure_2.h | 26 +- .../Concepts/TriangulationDSFaceBase_2.h | 56 +- .../Concepts/TriangulationDSVertexBase_2.h | 16 +- .../Concepts/TriangulationDataStructure_2.h | 212 ++-- .../Constrained_Delaunay_triangulation_2.h | 40 +- .../CGAL/Constrained_triangulation_2.h | 42 +- .../CGAL/Constrained_triangulation_plus_2.h | 62 +- .../CGAL/Delaunay_triangulation_2.h | 42 +- .../CGAL/Regular_triangulation_2.h | 80 +- .../Triangulation_2/CGAL/Triangulation_2.h | 220 ++-- .../Triangulation_euclidean_traits_xy_3.h | 54 +- .../Triangulation_face_base_with_info_2.h | 6 +- .../Triangulation_vertex_base_with_info_2.h | 6 +- .../doc/Triangulation_2/CGAL/Weighted_point.h | 16 +- .../ConstrainedTriangulationFaceBase_2.h | 14 +- .../ConstrainedTriangulationTraits_2.h | 16 +- .../Concepts/DelaunayTriangulationTraits_2.h | 30 +- .../Concepts/RegularTriangulationFaceBase_2.h | 4 +- .../Concepts/RegularTriangulationTraits_2.h | 26 +- .../RegularTriangulationVertexBase_2.h | 4 +- .../TriangulationHierarchyVertexBase_2.h | 8 +- .../Concepts/TriangulationTraits_2.h | 44 +- .../TriangulationVertexBaseWithInfo_2.h | 6 +- .../Concepts/TriangulationVertexBase_2.h | 14 +- .../CGAL/Triangulation_data_structure_3.h | 12 +- .../doc/TDS_3/CGAL/Triangulation_utils_3.h | 8 +- .../Concepts/TriangulationDSCellBase_3.h | 58 +- .../Concepts/TriangulationDSVertexBase_3.h | 26 +- .../Concepts/TriangulationDataStructure_3.h | 258 ++--- .../CGAL/Delaunay_triangulation_3.h | 76 +- .../CGAL/Regular_triangulation_3.h | 66 +- ...Regular_triangulation_euclidean_traits_3.h | 44 +- .../Triangulation_3/CGAL/Triangulation_3.h | 298 +++--- ...angulation_cell_base_with_circumcenter_3.h | 2 +- .../Triangulation_cell_base_with_info_3.h | 6 +- .../CGAL/Triangulation_simplex_3.h | 60 +- .../CGAL/Triangulation_vertex_base_3.h | 2 +- .../Triangulation_vertex_base_with_info_3.h | 6 +- .../Concepts/DelaunayTriangulationTraits_3.h | 34 +- .../Concepts/RegularTriangulationCellBase_3.h | 10 +- .../Concepts/RegularTriangulationTraits_3.h | 38 +- .../Concepts/TriangulationCellBase_3.h | 2 +- .../TriangulationHierarchyVertexBase_3.h | 8 +- .../Concepts/TriangulationTraits_3.h | 36 +- .../TriangulationVertexBaseWithInfo_3.h | 6 +- .../Concepts/TriangulationVertexBase_3.h | 14 +- .../Triangulation_3/Concepts/WeightedPoint.h | 12 +- .../Apollonius_graph_adaptation_policies_2.h | 4 +- .../Apollonius_graph_adaptation_traits_2.h | 2 +- ...unay_triangulation_adaptation_policies_2.h | 4 +- ...launay_triangulation_adaptation_traits_2.h | 2 +- .../CGAL/Identity_policy_2.h | 2 +- ...ular_triangulation_adaptation_policies_2.h | 4 +- ...egular_triangulation_adaptation_traits_2.h | 2 +- ...ent_Delaunay_graph_adaptation_policies_2.h | 4 +- ...gment_Delaunay_graph_adaptation_traits_2.h | 2 +- .../CGAL/Voronoi_diagram_2.h | 274 ++--- .../Concepts/AdaptationPolicy_2.h | 38 +- .../Concepts/AdaptationTraits_2.h | 26 +- .../Concepts/DelaunayGraph_2.h | 108 +- 928 files changed, 10797 insertions(+), 10796 deletions(-) diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h index fe328f66294..11c86b33e0b 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBGeomTraits.h @@ -17,17 +17,17 @@ public: /// \name Types /// @{ -/*! +/*! Sphere type, that should be consistent with the distance function chosen for the distance queries, namely the `Squared_distance_3` functor. */ typedef unspecified_type Sphere_3; -/*! +/*! Point type. */ typedef unspecified_type Point_3; -/*! +/*! A functor object to detect intersections between two geometric objects. Provides the operators: `bool operator()(const Type_1& type_1, const Type_2& type_2);` @@ -36,7 +36,7 @@ among `Ray_3`, `Segment_3`, `Line_3`, `Triangle_3`, `Plane_3` and `Bbox_3`. Rele */ typedef unspecified_type Do_intersect_3; -/*! +/*! A functor object to construct the intersection between two geometric objects. This functor must support the result_of protocol, that is the return type of the `operator()(A, B)` is `CGAL::cpp11::result`. @@ -51,26 +51,26 @@ A model of `Kernel::Intersect_3` fulfills those requirements. */ typedef unspecified_type Intersect_3; -/*! +/*! A functor object to construct the sphere centered at one point and passing through another one. Provides the operator: `Sphere_3 operator()(const Point_3& p, const Point_3 & q);` which returns the sphere centered at `p` and passing through `q`. */ typedef unspecified_type Construct_sphere_3; -/*! +/*! A functor object to compute the point on a geometric primitive which is closest from a query. Provides the operator: `Point_3 operator()(const Point_3& p, const Type_2& type_2);` where `Type_2` is any type among `Segment_3` and `Triangle_3`. The operator returns the point on `type_2` which is closest to `p`. */ typedef unspecified_type Compute_closest_point_3; -/*! +/*! A functor object to detect if a point lies inside a sphere or not. Provides the operator: `bool operator()(const Sphere_3& s, const Point_3& p);` which returns `true` iff the closed volume bounded by `s` contains `p`. */ typedef unspecified_type Has_on_bounded_side_3; -/*! +/*! A functor object to compute the squared radius of a sphere. Provides the operator: `FT operator()(const Sphere_3& s);` which returns the squared radius of `s`. */ @@ -88,32 +88,32 @@ typedef unspecified_type Compute_squared_distance_3; /// \name Operations /// @{ -/*! +/*! Returns the intersection detection functor. */ Do_intersect_3 do_intersect_3_object(); -/*! +/*! Returns the intersection constructor. */ Intersect_3 intersect_3_object(); -/*! +/*! Returns the distance comparison functor. */ Construct_sphere_3 construct_sphere_3_object(); -/*! +/*! Returns the closest point constructor. */ Compute_closest_point_3 compute_closest_point_3_object(); -/*! +/*! Returns the closest point constructor. */ Has_on_bounded_side_3 has_on_bounded_side_3_object(); -/*! +/*! Returns the squared radius functor. */ Compute_squared_radius_3 compute_squared_radius_3_object(); diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h index 05ddf7a58cb..bd9a022855d 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBPrimitive.h @@ -25,12 +25,12 @@ public: /// \name Types /// @{ -/*! +/*! 3D point type. */ typedef unspecified_type Point; -/*! +/*! Type of input datum. */ typedef unspecified_type Datum; @@ -45,7 +45,7 @@ Datum reference type returned by the function `datum()`. It is convertible to th */ typedef unspecified_type Datum_reference; -/*! +/*! Type of identifiers through which the input objects are referred to. It must be a model of the concepts DefaultConstructible and Assignable. */ typedef unspecified_type Id; @@ -55,17 +55,17 @@ typedef unspecified_type Id; /// \name Operations /// @{ -/*! +/*! Returns the datum (geometric object) represented by the primitive. */ Datum_reference datum(); -/*! +/*! Returns the corresponding identifier. This identifier is only used as a reference for the objects in the output of the `AABB_tree` methods. */ Id id(); -/*! +/*! Returns a 3D point located on the geometric object represented by the primitive. This function is used to sort the primitives during the AABB tree construction as well as to construct the search KD-tree internal to the AABB tree used to accelerate distance queries. */ Point_reference reference_point(); diff --git a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h index b2a37c88fe4..e17c0d9dad2 100644 --- a/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h +++ b/AABB_tree/doc/AABB_tree/Concepts/AABBTraits.h @@ -18,28 +18,28 @@ public: /// \name Types /// @{ -/*! +/*! Value type of the `Squared_distance` functor. */ typedef unspecified_type FT; -/*! +/*! Type of a 3D point. */ typedef unspecified_type Point_3; -/*! +/*! Type of primitive. Must be a model of the concepts `AABBPrimitive` or `AABBPrimitiveWithSharedData`. */ typedef unspecified_type Primitive; -/*! +/*! Bounding box type. */ typedef unspecified_type Bounding_box; - /*! + /*! */ enum Axis { X_AXIS, @@ -47,12 +47,12 @@ typedef unspecified_type Bounding_box; Z_AXIS }; -/*! +/*! */ typedef std::pair Point_and_primitive_id; -/*! +/*! \deprecated */ typedef std::pair Object_and_primitive_id; @@ -74,23 +74,23 @@ The type of the pair is given by the nested type `Type`. /// \f$ y\f$ or \f$ z\f$ coordinate axis: /// @{ -/*! +/*! A functor object to split a range of primitives into two sub-ranges along the X-axis. Provides the operator: `void operator()(InputIterator first, InputIterator beyond);` %Iterator type `InputIterator` must be a model of RandomAccessIterator and have `Primitive` as value type. The operator is used for determining the primitives assigned to the two children nodes of a given node, assuming that the goal is to split the X-dimension of the bounding box of the node. The primitives assigned to this node are passed as argument to the operator. It should modify the iterator range in such a way that its first half and its second half correspond to the two children nodes. */ typedef unspecified_type Split_primitives_along_x_axis; -/*! +/*! A functor object to split a range of primitives into two sub-ranges along the Y-axis. See `Split_primitives_along_x_axis` for the detailed description. */ typedef unspecified_type Split_primitives_along_y_axis; -/*! +/*! A functor object to split a range of primitives into two sub-ranges along the Z-axis. See `Split_primitives_along_x_axis` for the detailed description. */ typedef unspecified_type Split_primitives_along_z_axis; -/*! +/*! A functor object to compute the bounding box of a set of primitives. Provides the operator: `Bounding_box operator()(Input_iterator begin, Input_iterator beyond);` %Iterator type `InputIterator` must have `Primitive` as value type. */ @@ -113,13 +113,13 @@ typedef unspecified_type Compute_bbox; /// detection or computation query. /// @{ -/*! +/*! A functor object to compute intersection predicates between the query and the nodes of the tree. Provides the operators: `bool operator()(const Query & q, const Bounding_box & box);` which returns `true` iff the query intersects the bounding box, and `bool operator()(const Query & q, const Primitive & primitive);` which returns `true` iff the query intersects the primitive. */ typedef unspecified_type Do_intersect; -/*! +/*! A functor object to compute the intersection of a query and a primitive. Provides the operator: `boost::optional::%Type > operator()(const Query & q, const Primitive& primitive);` which returns the intersection as a pair composed of an object and a primitive id, iff the query intersects the primitive. \cgalHeading{Note on Backward Compatibility} @@ -133,19 +133,19 @@ typedef unspecified_type Intersect; /// distance query. /// @{ -/*! +/*! A functor object to compute distance comparisons between the query and the nodes of the tree. Provides the operators: `bool operator()(const Query & query, const Bounding_box& box, const Point & closest);` which returns `true` iff the bounding box is closer to `query` than `closest` is, and `bool operator()(const Query & query, const Primitive & primitive, const Point & closest);` which returns `true` iff `primitive` is closer to the `query` than `closest` is. */ typedef unspecified_type Compare_distance; -/*! +/*! A functor object to compute closest point from the query on a primitive. Provides the operator: `Point_3 operator()(const Query& query, const Primitive& primitive, const Point_3 & closest);` which returns the closest point to `query`, among `closest` and all points of the primitive. */ typedef unspecified_type Closest_point; -/*! +/*! A functor object to compute the squared distance between two points. Provides the operator: `FT operator()(const Point& query, const Point_3 & p);` which returns the squared distance between `p` and `q`. */ @@ -156,47 +156,47 @@ typedef unspecified_type Squared_distance; /// \name Operations /// @{ -/*! +/*! Returns the primitive splitting functor for the X axis. */ Split_primitives_along_x_axis split_primitives_along_x_axis_object(); -/*! +/*! Returns the primitive splitting functor for the Y axis. */ Split_primitives_along_y_axis split_primitives_along_y_axis_object(); -/*! +/*! Returns the primitive splitting functor for the Z axis. */ Split_primitives_along_z_axis split_primitives_along_z_axis_object(); -/*! +/*! Returns the bounding box constructor. */ Compute_bbox compute_bbox_object(); -/*! +/*! Returns the intersection detection functor. */ Do_intersect do_intersect_object(); -/*! +/*! Returns the intersection constructor. */ Intersect intersect_object(); -/*! +/*! Returns the distance comparison functor. */ Compare_distance compare_distance_object(); -/*! +/*! Returns the closest point constructor. */ Closest_point closest_point_object(); -/*! +/*! Returns the squared distance functor. */ Squared_distance squared_distance_object(); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h index a7005b34e71..074344d1a84 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/CGAL/Coercion_traits.h @@ -18,28 +18,28 @@ public: /// \name Types /// @{ -/*! +/*! Tag indicating whether the two types A and B are a model of `ExplicitInteroperable` This is either `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Are_explicit_interoperable; -/*! +/*! Tag indicating whether the two types A and B are a model of `ImplicitInteroperable` This is either `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Are_implicit_interoperable; -/*! +/*! The coercion type of `A` and `B`. In case A and B are not `ExplicitInteroperable` this is undefined. */ typedef unspecified_type Type; -/*! +/*! A model of the `AdaptableFunctor` concept, providing the conversion of `A` or `B` to `Type`. In case A and B are not `ExplicitInteroperable` this is undefined. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h index 6f2570e013d..9c14942316f 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Div.h @@ -22,17 +22,17 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type first_argument; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type second_argument; @@ -42,13 +42,13 @@ typedef unspecified_type second_argument; /// \name Operations /// @{ -/*! +/*! */ result_type operator()(first_argument_type x, second_argument_type y); -/*! +/*! This operator is defined if `NT1` and `NT2` are `ExplicitInteroperable` with coercion type `AlgebraicStructureTraits::Type`. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h index 66d0457e246..f974221b8ea 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--DivMod.h @@ -203,27 +203,27 @@ public: /// \name Types /// @{ -/*! +/*! Is void. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type first_argument_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type second_argument_type; -/*! +/*! Is `AlgebraicStructureTraits::Type&`. */ typedef unspecified_type third_argument_type; -/*! +/*! Is `AlgebraicStructureTraits::Type&`. */ typedef unspecified_type fourth_argument_type; @@ -233,7 +233,7 @@ typedef unspecified_type fourth_argument_type; /// \name Operations /// @{ -/*! +/*! computes the quotient \f$ q\f$ and remainder \f$ r\f$, such that \f$ x = q*y + r\f$ and \f$ r\f$ minimal with respect to the Euclidean Norm on @@ -244,7 +244,7 @@ second_argument_type y, third_argument_type q, fourth_argument_type r); -/*! +/*! This operator is defined if `NT1` and `NT2` are `ExplicitInteroperable` with coercion type `AlgebraicStructureTraits::Type`. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h index 8e0170f02c3..ef8896bbda0 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Divides.h @@ -29,17 +29,17 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Boolean`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type first_argument; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type second_argument; @@ -49,13 +49,13 @@ typedef unspecified_type second_argument; /// \name Operations /// @{ -/*! +/*! Computes whether \f$ d\f$ divides \f$ n\f$. */ result_type operator()(first_argument_type d, second_argument_type n); -/*! +/*! Computes whether \f$ d\f$ divides \f$ n\f$. Moreover it computes \f$ c\f$ if \f$ d\f$ divides \f$ n\f$, diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h index 5432d2de62d..ae00a2fdffc 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Gcd.h @@ -29,17 +29,17 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type first_argument; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type second_argument; @@ -49,13 +49,13 @@ typedef unspecified_type second_argument; /// \name Operations /// @{ -/*! +/*! returns \f$ gcd(x,y)\f$. */ result_type operator()(first_argument_type x, second_argument_type y); -/*! +/*! This operator is defined if `NT1` and `NT2` are `ExplicitInteroperable` with coercion type `AlgebraicStructureTraits::Type`. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h index d7c936a9528..17f054df6dc 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IntegralDivision.h @@ -26,17 +26,17 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type first_argument; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type second_argument; @@ -46,13 +46,13 @@ typedef unspecified_type second_argument; /// \name Operations /// @{ -/*! +/*! returns \f$ x/y\f$, this is an integral division. */ result_type operator()(first_argument_type x, second_argument_type y); -/*! +/*! This operator is defined if `NT1` and `NT2` are `ExplicitInteroperable` with coercion type `AlgebraicStructureTraits::Type`. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h index 0918d804b5c..e24b955b2ac 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Inverse.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type argument_type; @@ -35,7 +35,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns the inverse element of \f$ x\f$ with respect to multiplication. \pre \f$ x \neq0\f$. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h index 6891a0d0199..9ac402f0e70 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsOne.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Boolean`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type argument_type; @@ -35,7 +35,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns true in case \f$ x\f$ is the one of the ring. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h index 85219a5d189..90e7e1a1776 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsSquare.h @@ -25,17 +25,17 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Boolean`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type first_argument; -/*! +/*! Is `AlgebraicStructureTraits::Type&`. */ typedef unspecified_type second_argument; @@ -45,7 +45,7 @@ typedef unspecified_type second_argument; /// \name Operations /// @{ -/*! +/*! returns true in case \f$ x\f$ is a square, i.e.\ \f$ x = y*y\f$. \post \f$ unit\_part(y) == 1\f$. @@ -53,7 +53,7 @@ returns true in case \f$ x\f$ is a square, i.e.\ \f$ x = y*y\f$. result_type operator()(first_argument_type x, second_argument_type y); -/*! +/*! returns true in case \f$ x\f$ is a square. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h index 3ad04b42bee..00d41328ec5 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--IsZero.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Boolean`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type argument_type; @@ -35,7 +35,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns true in case \f$ x\f$ is the zero element of the ring. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h index 800b9266854..1869799f46c 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--KthRoot.h @@ -20,17 +20,17 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is int. */ typedef unspecified_type first_argument; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type second_argument; @@ -40,7 +40,7 @@ typedef unspecified_type second_argument; /// \name Operations /// @{ -/*! +/*! returns the \f$ k\f$-th root of \f$ x\f$. \pre \f$ k \geq1\f$ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h index 2f51b351a08..cf06f2aa619 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Mod.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type first_argument; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type second_argument; @@ -41,13 +41,13 @@ typedef unspecified_type second_argument; /// \name Operations /// @{ -/*! +/*! */ result_type operator()(first_argument_type x, second_argument_type y); -/*! +/*! This operator is defined if `NT1` and `NT2` are `ExplicitInteroperable` with coercion type `AlgebraicStructureTraits::Type`. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h index 72e6ce71d27..6473628a887 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--RootOf.h @@ -21,7 +21,7 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; @@ -31,7 +31,7 @@ typedef unspecified_type result_type; /// \name Operations /// @{ -/*! +/*! returns the k-th real root of the univariate polynomial, which is defined by the iterator range, where begin refers to the constant term. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h index 0d90ebbd1fb..0d74c3c45ce 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Simplify.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! Is void. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type argument_type; @@ -34,7 +34,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! may simplify \f$ x\f$. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h index 6725f790152..d8dbb3502ff 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Sqrt.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type argument_type; @@ -34,7 +34,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns \f$ \sqrt{x}\f$. */ result_type operator()(argument_type x) const; diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h index c101bcdba91..fcfb1fd8332 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--Square.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type argument_type; @@ -34,7 +34,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns the square of \f$ x\f$. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h index db40d5afbfe..8851cccce7a 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits--UnitPart.h @@ -34,12 +34,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `AlgebraicStructureTraits::Type`. */ typedef unspecified_type argument_type; @@ -49,7 +49,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns the unit part of \f$ x\f$. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h index 95f7f8418aa..54f3ed47af7 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/AlgebraicStructureTraits.h @@ -39,12 +39,12 @@ public: /// A model of `AlgebraicStructureTraits` is supposed to provide: /// @{ -/*! +/*! The associated type. */ typedef unspecified_type Type; -/*! +/*! Tag indicating the algebraic structure of the associated type. @@ -106,7 +106,7 @@ no algebraic concept */ typedef unspecified_type Algebraic_category; -/*! +/*! Tag indicating whether `Type` is exact. This is either `CGAL::Tag_true` or `CGAL::Tag_false`. @@ -123,7 +123,7 @@ is not exact. */ typedef unspecified_type Is_exact; -/*! +/*! Tag indicating whether `Type` is numerical sensitive. This is either `CGAL::Tag_true` or `CGAL::Tag_false`. @@ -135,7 +135,7 @@ number of an algorithm. */ typedef unspecified_type Is_numerical_sensitive; -/*! +/*! This type specifies the return type of the predicates provided by this traits. The type must be convertible to `bool` and typically the type indeed maps to `bool`. However, there are also @@ -151,7 +151,7 @@ typedef unspecified_type Boolean; /// In case a functor is not provided, it is set to `CGAL::Null_functor`. /// @{ -/*! +/*! A model of `AlgebraicStructureTraits_::IsZero`. @@ -162,7 +162,7 @@ model of `RealEmbeddableTraits_::IsZero`. */ typedef unspecified_type Is_zero; -/*! +/*! A model of `AlgebraicStructureTraits_::IsOne`. @@ -171,7 +171,7 @@ Required by the concept `IntegralDomainWithoutDivision`. */ typedef unspecified_type Is_one; -/*! +/*! A model of `AlgebraicStructureTraits_::Square`. @@ -180,7 +180,7 @@ Required by the concept `IntegralDomainWithoutDivision`. */ typedef unspecified_type Square; -/*! +/*! A model of `AlgebraicStructureTraits_::Simplify`. @@ -189,7 +189,7 @@ Required by the concept `IntegralDomainWithoutDivision`. */ typedef unspecified_type Simplify; -/*! +/*! A model of `AlgebraicStructureTraits_::UnitPart`. @@ -198,7 +198,7 @@ Required by the concept `IntegralDomainWithoutDivision`. */ typedef unspecified_type Unit_part; -/*! +/*! A model of `AlgebraicStructureTraits_::IntegralDivision`. @@ -207,7 +207,7 @@ Required by the concept `IntegralDomain`. */ typedef unspecified_type Integral_division; -/*! +/*! A model of `AlgebraicStructureTraits_::Divides`. @@ -216,7 +216,7 @@ Required by the concept `IntegralDomain`. */ typedef unspecified_type Divides; -/*! +/*! A model of `AlgebraicStructureTraits_::IsSquare`. @@ -225,7 +225,7 @@ Required by the concept `IntegralDomainWithoutDivision`. */ typedef unspecified_type Is_square; -/*! +/*! A model of `AlgebraicStructureTraits_::Gcd`. @@ -234,7 +234,7 @@ Required by the concept `UniqueFactorizationDomain`. */ typedef unspecified_type Gcd; -/*! +/*! A model of `AlgebraicStructureTraits_::Mod`. @@ -243,7 +243,7 @@ Required by the concept `EuclideanRing`. */ typedef unspecified_type Mod; -/*! +/*! A model of `AlgebraicStructureTraits_::Div`. @@ -252,7 +252,7 @@ Required by the concept `EuclideanRing`. */ typedef unspecified_type Div; -/*! +/*! A model of `AlgebraicStructureTraits_::DivMod`. @@ -261,7 +261,7 @@ Required by the concept `EuclideanRing`. */ typedef unspecified_type Div_mod; -/*! +/*! A model of `AlgebraicStructureTraits_::Inverse`. @@ -270,7 +270,7 @@ Required by the concept `Field`. */ typedef unspecified_type Inverse; -/*! +/*! A model of `AlgebraicStructureTraits_::Sqrt`. @@ -279,7 +279,7 @@ Required by the concept `FieldWithSqrt`. */ typedef unspecified_type Sqrt; -/*! +/*! A model of `AlgebraicStructureTraits_::KthRoot`. @@ -288,7 +288,7 @@ Required by the concept `FieldWithKthRoot`. */ typedef unspecified_type Kth_root; -/*! +/*! A model of `AlgebraicStructureTraits_::RootOf`. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h index ea9efb02968..852b4a77d14 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/Field.h @@ -36,13 +36,13 @@ public: /// \name Operations /// @{ -/*! +/*! */ Field operator/(const Field &a, const Field &b); -/*! +/*! */ Field operator/=(const Field &b); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h index a3e9be7432d..c0698528987 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FractionTraits.h @@ -21,12 +21,12 @@ public: /// \name Types /// @{ -/*! +/*! The associated type */ typedef unspecified_type Type; -/*! +/*! Tag indicating whether the associated type is a fraction and can be decomposed into a numerator and denominator. @@ -35,13 +35,13 @@ This is either `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Is_fraction; -/*! +/*! The type to represent the numerator. This is undefined in case the associated type is not a fraction. */ typedef unspecified_type Numerator_type ; -/*! +/*! The (simpler) type to represent the denominator. This is undefined in case the associated type is not a fraction. */ @@ -96,7 +96,7 @@ public: /// \name Operations /// @{ -/*! +/*! decompose \f$ f\f$ into numerator \f$ n\f$ and denominator \f$ d\f$. */ void operator()( FractionTraits::Type f, @@ -128,17 +128,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef FractionTraits::Type result_type; -/*! +/*! */ typedef FractionTraits::Numerator_type first_argument_type; -/*! +/*! */ typedef FractionTraits::Denominator_type second_argument_type; @@ -148,7 +148,7 @@ typedef FractionTraits::Denominator_type second_argument_type; /// \name Operations /// @{ -/*! +/*! return the fraction \f$ n/d\f$. */ result_type operator()(first_argument_type n, second_argument_type d); @@ -184,17 +184,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef FractionTraits::Denominator_type result_type; -/*! +/*! */ typedef FractionTraits::Denominator_type first_argument_type; -/*! +/*! */ typedef FractionTraits::Denominator_type second_argument_type; @@ -204,7 +204,7 @@ typedef FractionTraits::Denominator_type second_argument_type; /// \name Operations /// @{ -/*! +/*! return a great common factor of \f$ d1\f$ and \f$ d2\f$. Note: operator()(0,0) = 0 diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h index 2c1987fc422..18c34eea653 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromDoubleConstructible.h @@ -17,7 +17,7 @@ public: /// \name Creation /// @{ -/*! +/*! conversion constructor from double. diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h index cd9e9187b62..1a5bcfac2e1 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/FromIntConstructible.h @@ -18,7 +18,7 @@ public: /// \name Creation /// @{ -/*! +/*! */ FromIntConstructible(int& i); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h index 1c3288d6bcf..5c1cef11fa3 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/IntegralDomainWithoutDivision.h @@ -53,33 +53,33 @@ public: /// \name Operations /// @{ -/*! +/*! unary plus */ IntegralDomainWithoutDivision operator+(const IntegralDomainWithoutDivision &a); -/*! +/*! unary minus */ IntegralDomainWithoutDivision operator-(const IntegralDomainWithoutDivision &a); -/*! +/*! */ IntegralDomainWithoutDivision operator+(const IntegralDomainWithoutDivision &a, const IntegralDomainWithoutDivision &b); -/*! +/*! */ IntegralDomainWithoutDivision operator-(const IntegralDomainWithoutDivision &a, const IntegralDomainWithoutDivision &b); -/*! +/*! */ IntegralDomainWithoutDivision @@ -87,31 +87,31 @@ operator*(const IntegralDomainWithoutDivision &a, const IntegralDomainWithoutDivision &b); -/*! +/*! */ IntegralDomainWithoutDivision operator+=(const IntegralDomainWithoutDivision &b); -/*! +/*! */ IntegralDomainWithoutDivision operator-=(const IntegralDomainWithoutDivision &b); -/*! +/*! */ IntegralDomainWithoutDivision operator*=(const IntegralDomainWithoutDivision &b); -/*! +/*! The `result_type` is convertible to `bool`. */ result_type operator==(const IntegralDomainWithoutDivision &a, const IntegralDomainWithoutDivision &b); -/*! +/*! The `result_type` is convertible to `bool`. */ result_type diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h index cea8511420e..c22e4f65e9d 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddable.h @@ -51,39 +51,39 @@ public: /// \name Operations /// @{ -/*! +/*! */ bool operator==(const RealEmbeddable &a, const RealEmbeddable &b); -/*! +/*! */ bool operator!=(const RealEmbeddable &a, const RealEmbeddable &b); -/*! +/*! */ bool operator< (const RealEmbeddable &a, const RealEmbeddable &b); -/*! +/*! */ bool operator<=(const RealEmbeddable &a, const RealEmbeddable &b); -/*! +/*! */ bool operator> (const RealEmbeddable &a, const RealEmbeddable &b); -/*! +/*! \relates RealEmbeddable */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h index e036c79f1fd..f68ecd3ae0c 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Abs.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type argument_type; @@ -34,7 +34,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! computes the absolute value of \f$ x\f$. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h index ba24537fc4c..07e7139544d 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Compare.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Comparison_result`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type first_argument_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type second_argument_type; @@ -39,13 +39,13 @@ typedef unspecified_type second_argument_type; /// \name Operations /// @{ -/*! +/*! compares \f$ x\f$ with respect to \f$ y\f$. */ result_type operator()(first_argument_type x, second_argument_type y); -/*! +/*! This operator is defined if `NT1` and `NT2` are `ExplicitInteroperable` with coercion type diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h index 5c6d54b7a6d..76eab24473b 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsNegative.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `bool`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type argument_type; @@ -34,7 +34,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns true in case \f$ x\f$ is negative. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h index 464b2107a59..622badab9cb 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsPositive.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `bool`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type argument_type; @@ -34,7 +34,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns true in case \f$ x\f$ is positive. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h index 19010c8251c..afa24fc5417 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--IsZero.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `bool`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type argument_type; @@ -35,7 +35,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! returns true in case \f$ x\f$ is the zero element of the ring. */ diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h index ccc7cfe15da..259ae2dfbb6 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--Sgn.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Sign`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type argument_type; @@ -34,7 +34,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! Computes the sign of \f$ x\f$. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h index 2c4cd89c927..0d5284fe8c3 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToDouble.h @@ -23,12 +23,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `double`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type argument_type; @@ -38,7 +38,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! computes a double approximation of a real embeddable number. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h index b857acbef85..aca844f0f7e 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits--ToInterval.h @@ -21,12 +21,12 @@ public: /// \name Types /// @{ -/*! +/*! Is `std::pair`. */ typedef unspecified_type result_type; -/*! +/*! Is `RealEmbeddableTraits::Type`. */ typedef unspecified_type argument_type; @@ -36,7 +36,7 @@ typedef unspecified_type argument_type; /// \name Operations /// @{ -/*! +/*! computes a double interval containing \f$ x\f$. */ result_type operator()(argument_type x); diff --git a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h index b176b847b69..f246c99637c 100644 --- a/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h +++ b/Algebraic_foundations/doc/Algebraic_foundations/Concepts/RealEmbeddableTraits.h @@ -17,19 +17,19 @@ public: /// A model of `RealEmbeddableTraits` is supposed to provide: /// @{ -/*! +/*! The associated number type. */ typedef unspecified_type Type; -/*! +/*! Tag indicating whether the associated type is real embeddable. This is either \link Tag_true `Tag_true`\endlink or \link Tag_false `Tag_false`\endlink. */ typedef unspecified_type Is_real_embeddable; -/*! +/*! This type specifies the return type of the predicates provided by this traits. The type must be convertible to `bool` and typically the type indeed maps to `bool`. However, there are also @@ -39,7 +39,7 @@ or some similar type. */ typedef unspecified_type Boolean; -/*! +/*! This type specifies the return type of the `Sgn` functor. The type must be convertible to `CGAL::Sign` and typically the type indeed maps to `CGAL::Sign`. However, there are also @@ -49,7 +49,7 @@ or some similar type. */ typedef unspecified_type Sign; -/*! +/*! This type specifies the return type of the `Compare` functor. The type must be convertible to `CGAL::Comparison_result` and typically the type indeed maps to `CGAL::Comparison_result`. However, there are also @@ -67,7 +67,7 @@ typedef unspecified_type Comparison_result; /// `CGAL::Null_functor`. /// @{ -/*! +/*! A model of `RealEmbeddableTraits_::IsZero` In case `Type` is also model of `IntegralDomainWithoutDivision` @@ -75,37 +75,37 @@ this is a model of `AlgebraicStructureTraits_::IsZero`. */ typedef unspecified_type Is_zero; -/*! +/*! A model of `RealEmbeddableTraits_::Abs` */ typedef unspecified_type Abs; -/*! +/*! A model of `RealEmbeddableTraits_::Sgn` */ typedef unspecified_type Sgn; -/*! +/*! A model of `RealEmbeddableTraits_::IsPositive` */ typedef unspecified_type Is_positive; -/*! +/*! A model of `RealEmbeddableTraits_::IsNegative` */ typedef unspecified_type Is_negative; -/*! +/*! A model of `RealEmbeddableTraits_::Compare` */ typedef unspecified_type Compare; -/*! +/*! A model of `RealEmbeddableTraits_::ToDouble` */ typedef unspecified_type To_double; -/*! +/*! A model of `RealEmbeddableTraits_::ToInterval` */ typedef unspecified_type To_interval; diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h index 57ba86bc4b1..d89652397d5 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_1.h @@ -43,22 +43,22 @@ public: /// \name Types /// @{ -/*! +/*! Same type as the template argument `Coeff`. */ typedef unspecified_type Coefficient; -/*! +/*! A model of `AlgebraicKernel_d_1::Polynomial_1`. */ typedef unspecified_type Polynomial_1; -/*! +/*! A model of `AlgebraicKernel_d_1::AlgebraicReal_1`. */ typedef unspecified_type Algebraic_real_1; -/*! +/*! The choice of `Coeff` also determines the provided bound, type. In case of `Coeff` is: @@ -70,7 +70,7 @@ In case of `Coeff` is: */ typedef unspecified_type Bound; -/*! +/*! The multiplicity type is `int`. */ typedef unspecified_type Multiplicity_type; diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h index ee79ece435e..78b0e054ba0 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_d_2.h @@ -59,22 +59,22 @@ public: /// \name Types /// @{ -/*! +/*! Same type as the template argument `Coeff`. */ typedef unspecified_type Coefficient; -/*! +/*! A model of `AlgebraicKernel_d_2::Polynomial_2` */ typedef unspecified_type Polynomial_2; -/*! +/*! A model of `AlgebraicKernel_d_2::AlgebraicReal_2` */ typedef unspecified_type Algebraic_real_2; -/*! +/*! The choice of `Coeff` also determines the provided bound, type. In case of `Coeff` is - `Gmpz` or `Gmpq` this is `Gmpq` @@ -86,7 +86,7 @@ In case of `Coeff` is */ typedef unspecified_type Bound; -/*! +/*! The multiplicity type is `int`. */ typedef unspecified_type Multiplicity_type; diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h index f03915bde15..653c7f56cb3 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpq_d_1.h @@ -24,17 +24,17 @@ public: /// \name Types /// @{ -/*! +/*! It is a typedef to `CGAL::Gmpq`. */ typedef unspecified_type Coefficient; -/*! +/*! It is defined as `CGAL::Polynomial`. */ typedef unspecified_type Polynomial_1; -/*! +/*! Type that represents the real roots of integer univariate polynomials, containing a pointer to the polynomial of which the represented algebraic number is root and and a `CGAL::Gmpfi` @@ -42,13 +42,13 @@ isolating interval. */ typedef unspecified_type Algebraic_real_1; -/*! +/*! Since the isolating intervals of the roots have type `CGAL::Gmpfi`, the bounds have type `CGAL::Gmpfr`. */ typedef unspecified_type Bound; -/*! +/*! The multiplicity is an `int`. */ typedef unspecified_type Multiplicity_type; diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h index 34ccc39ca50..70fdccc2963 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/CGAL/Algebraic_kernel_rs_gmpz_d_1.h @@ -22,17 +22,17 @@ public: /// \name Types /// @{ -/*! +/*! It is a typedef to `CGAL::Gmpz`. */ typedef unspecified_type Coefficient; -/*! +/*! It is defined as `CGAL::Polynomial`. */ typedef unspecified_type Polynomial_1; -/*! +/*! Type that represents the real roots of integer univariate polynomials, containing a pointer to the polynomial of which the represented algebraic number is root and and a `CGAL::Gmpfi` @@ -40,13 +40,13 @@ isolating interval. */ typedef unspecified_type Algebraic_real_1; -/*! +/*! Since the isolating intervals of the roots have type `CGAL::Gmpfi`, the bounds have type `CGAL::Gmpfr`. */ typedef unspecified_type Bound; -/*! +/*! The multiplicity is an `int`. */ typedef unspecified_type Multiplicity_type; diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h index e437969c036..2896acf2af3 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateAbsolute_1.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 first_argument_type; -/*! +/*! */ typedef int second_argument_type; @@ -39,7 +39,7 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! The function computes a pair \f$ p\f$ of `AlgebraicKernel_d_1::Bound`, where \f$ p.first\f$ represents the lower approximation and \f$ p.second\f$ represents diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h index adcd9cbba70..3a2cf52c468 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ApproximateRelative_1.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 first_argument_type; -/*! +/*! */ typedef int second_argument_type; @@ -39,7 +39,7 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! The function computes a pair \f$ p\f$ of `AlgebraicKernel_d_1::Bound`, where \f$ p.first\f$ represents the lower approximation and \f$ p.second\f$ represents diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h index b11fa1c9f62..5af5cb25f25 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--BoundBetween_1.h @@ -17,17 +17,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Bound result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; @@ -37,7 +37,7 @@ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes a value \f$ r\f$, which is between \f$ a\f$ and \f$ b\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h index 44436ced5d6..5d7e8b3c53f 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Compare_1.h @@ -14,17 +14,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Comparison_result` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; @@ -36,22 +36,22 @@ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; /// required: /// @{ -/*! +/*! Compares `a` and `b`. */ result_type operator()(AlgebraicKernel_d_1::Algebraic_real_1 a, AlgebraicKernel_d_1::Algebraic_real_1 b); -/*! +/*! Compares `a` and `b`. */ result_type operator()(AlgebraicKernel_d_1::Algebraic_real_1 a, int b); -/*! +/*! Compares `a` and `b`. */ result_type operator()(AlgebraicKernel_d_1::Algebraic_real_1 a, AlgebraicKernel_d_1::Bound b); -/*! +/*! Compares `a` and `b`. */ result_type operator()(AlgebraicKernel_d_1::Algebraic_real_1 a, AlgebraicKernel_d_1::Coefficient b); diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h index 31542291b49..afc9fea9e3b 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ComputePolynomial_1.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 argument_type; @@ -33,7 +33,7 @@ typedef AlgebraicKernel_d_1::Algebraic_real_1 argument_type; /// \name Operations /// @{ -/*! +/*! Computes a square free polynomial \f$ p\f$, such that \f$ x\f$ is a real root of \f$ p\f$. */ result_type operator()(argument_type x); diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h index 8a450b2ff33..ec36d8c0991 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--ConstructAlgebraicReal_1.h @@ -17,7 +17,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 result_type; @@ -27,22 +27,22 @@ typedef AlgebraicKernel_d_1::Algebraic_real_1 result_type; /// \name Operations /// @{ -/*! +/*! introduces an `AlgebraicKernel_d_1::Algebraic_real_1` initialized to \f$ a\f$. */ result_type operator()(int a); -/*! +/*! introduces an `AlgebraicKernel_d_1::Algebraic_real_1` initialized to \f$ a\f$. */ result_type operator()(AlgebraicKernel_d_1::Bound a); -/*! +/*! introduces an `AlgebraicKernel_d_1::Algebraic_real_1` initialized to \f$ a\f$. */ result_type operator()(AlgebraicKernel_d_1::Coefficient a); -/*! +/*! introduces an `AlgebraicKernel_d_1::Algebraic_real_1` initialized to the \f$ i\f$-th real root of \f$ p\f$. The index starts at \f$ 0\f$, that is, \f$ p\f$ must have at least \f$ i+1\f$ real roots. \pre \f$ p\f$ is square free. @@ -51,7 +51,7 @@ The index starts at \f$ 0\f$, that is, \f$ p\f$ must have at least \f$ i+1\f$ re */ result_type operator()(AlgebraicKernel_d_1::Polynomial_1 p, AlgebraicKernel_d_1::size_type i); -/*! +/*! introduces an `AlgebraicKernel_d_1::Algebraic_real_1` initialized to the only real root of \f$ p\f$ in the open interval \f$ I = (l,u)\f$. \pre \f$ l < u\f$ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h index 1320354d0c6..25e71199630 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsCoprime_1.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 second_argument_type; @@ -38,7 +38,7 @@ typedef AlgebraicKernel_d_1::Polynomial_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns true if `p1` and `p2` are coprime. */ result_type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h index 9b0c7099a91..ca73f908aa3 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsSquareFree_1.h @@ -19,12 +19,12 @@ public: /// A model of this type must provide: /// @{ -/*! +/*! */ typedef bool result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 argument_type; @@ -34,7 +34,7 @@ typedef AlgebraicKernel_d_1::Polynomial_1 argument_type; /// \name Operations /// @{ -/*! +/*! Returns true if \f$ p\f$ is square free. */ result_type operator()(argument_type p); diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h index cf5b07fc5b2..d9ab0797c85 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--IsZeroAt_1.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `bool` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; @@ -38,7 +38,7 @@ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes whether \f$ p\f$ is zero at \f$ x\f$. */ result_type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h index 36e4bd1a76a..6ddac9ad06a 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Isolate_1.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 second_argument_type; @@ -38,7 +38,7 @@ typedef AlgebraicKernel_d_1::Polynomial_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes an open isolating interval \f$ I=(l,u)\f$ for \f$ a\f$ with respect to the real roots of \f$ p\f$. It is not required that \f$ a\f$ is a root of \f$ p\f$. \post \f$ a \in I\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h index 07f0883f063..fa95de42270 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeCoprime_1.h @@ -28,7 +28,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; @@ -38,7 +38,7 @@ typedef bool result_type; /// \name Operations /// @{ -/*! +/*! Computes \f$ g, q_1, q_2\f$ as described above. Returns whether \f$ p_1\f$ and \f$ p_2\f$ where already coprime. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h index aeab2ccf05c..2b60ca4d321 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--MakeSquareFree_1.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 argument_type; @@ -33,7 +33,7 @@ typedef AlgebraicKernel_d_1::Polynomial_1 argument_type; /// \name Operations /// @{ -/*! +/*! Returns a square free part of \f$ p\f$ */ result_type operator()(argument_type p); diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h index 140fc806bda..8dd23b95d6d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--NumberOfSolutions_1.h @@ -18,12 +18,12 @@ public: /// A model of this type must provide: /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::size_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 argument_type; @@ -33,7 +33,7 @@ typedef AlgebraicKernel_d_1::Polynomial_1 argument_type; /// \name Operations /// @{ -/*! +/*! Returns the number of real solutions of \f$ p\f$. \pre \f$ p\f$ is square free. */ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h index 2e3e0726857..c79e3136e8a 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SignAt_1.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Sign` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; @@ -39,7 +39,7 @@ typedef AlgebraicKernel_d_1::Algebraic_real_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes the sign of \f$ p\f$ at \f$ x\f$. */ result_type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h index f50edb3cc6a..18e71de141c 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--Solve_1.h @@ -17,7 +17,7 @@ public: /// A model of this type must provide: /// @{ -/*! +/*! Computes all real solutions of \f$ p\f$ with multiplicity, and copies them as objects of type `std::pair` in `res`. */ @@ -26,7 +26,7 @@ OutputIterator operator()( AlgebraicKernel_d_1::Polynomial_1 p, OutputIterator res); -/*! +/*! Computes all real solutions of \f$ p\f$, and copies them as objects of type `AlgebraicKernel_d_1::Algebraic_real_1` in `res`. The `bool` `known_to_be_square_free` indicates whether \f$ p\f$ is known to be square free. @@ -39,7 +39,7 @@ AlgebraicKernel_d_1::Polynomial_1 p, bool known_to_be_square_free, OutputIterator res ); -/*! +/*! Computes all real solutions of \f$ p\f$ in the closed interval \f$ [l,u]\f$ with multiplicity, and copies them as objects of type `std::pair` in `res`. */ @@ -48,7 +48,7 @@ OutputIterator operator()( AlgebraicKernel_d_1::Polynomial_1 p, AlgebraicKernel_d_1::Bound l, AlgebraicKernel_d_1::Bound u, OutputIterator res); -/*! +/*! Computes all real solutions of \f$ p\f$ in the closed interval \f$ [l,u]\f$, and copies them as objects of type `AlgebraicKernel_d_1::Algebraic_real_1` in `res`. The `bool` `known_to_be_square_free` indicates whether \f$ p\f$ is known to be square free. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h index 2bbdd3b687f..d50560b29a9 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1--SquareFreeFactorize_1.h @@ -28,7 +28,7 @@ public: /// \name Operations /// @{ -/*! +/*! Copies in the output iterator the factors of a square free factorization of \f$ p\f$, with their multiplicity, as objects of type `std::pair`. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h index 5befb549bdd..70660d6abc1 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_1.h @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! A model of `IntegralDomain` and `RealEmbeddable`. @@ -32,7 +32,7 @@ A model of `IntegralDomain` and `RealEmbeddable`. */ typedef unspecified_type Coefficient; -/*! +/*! A univariate polynomial that is a model of `Polynomial_d`, where \link PolynomialTraits_d::Innermost_coefficient_type `CGAL::Polynomial_traits_d::Innermost_coefficient_type` \endlink @@ -41,7 +41,7 @@ is `AlgebraicKernel_d_1::Coefficient`. */ typedef unspecified_type Polynomial_1; -/*! +/*! A type that is used to represent real roots of univariate polynomials. The type must be a model of `DefaultConstructible`, @@ -50,7 +50,7 @@ The type must be a model of `DefaultConstructible`, */ typedef unspecified_type Algebraic_real_1; -/*! +/*! A type to represent upper and lower bounds of `AlgebraicKernel_d_1::Algebraic_real_1`. @@ -61,12 +61,12 @@ The type is `ExplicitInteroperable` with */ typedef unspecified_type Bound; -/*! +/*! Size type (unsigned integral type). */ typedef unspecified_type size_type; -/*! +/*! Multiplicity type (unsigned integral type). */ typedef unspecified_type Multiplicity_type; @@ -76,77 +76,77 @@ typedef unspecified_type Multiplicity_type; /// \name Functors /// @{ -/*! +/*! A model of `AlgebraicKernel_d_1::ConstructAlgebraicReal_1`. */ typedef unspecified_type Construct_algebraic_real_1; -/*! +/*! A model of `AlgebraicKernel_d_1::ComputePolynomial_1`. */ typedef unspecified_type Compute_polynomial_1; -/*! +/*! A model of `AlgebraicKernel_d_1::Isolate_1`. */ typedef unspecified_type Isolate_1; -/*! +/*! A model of `AlgebraicKernel_d_1::IsSquareFree_1`. */ typedef unspecified_type Is_square_free_1; -/*! +/*! A model of `AlgebraicKernel_d_1::MakeSquareFree_1`. */ typedef unspecified_type Make_square_free_1; -/*! +/*! A model of `AlgebraicKernel_d_1::SquareFreeFactorize_1`. */ typedef unspecified_type Square_free_factorize_1; -/*! +/*! A model of `AlgebraicKernel_d_1::IsCoprime_1`. */ typedef unspecified_type Is_coprime_1; -/*! +/*! A model of `AlgebraicKernel_d_1::MakeCoprime_1`. */ typedef unspecified_type Make_coprime_1; -/*! +/*! A model of `AlgebraicKernel_d_1::Solve_1`. */ typedef unspecified_type Solve_1; -/*! +/*! A model of `AlgebraicKernel_d_1::NumberOfSolutions_1`. */ typedef unspecified_type Number_of_solutions_1; -/*! +/*! A model of `AlgebraicKernel_d_1::SignAt_1`. */ typedef unspecified_type Sign_at_1; -/*! +/*! A model of `AlgebraicKernel_d_1::Compare_1`. */ typedef unspecified_type Compare_1; -/*! +/*! A model of `AlgebraicKernel_d_1::BoundBetween_1`. */ typedef unspecified_type Bound_between_1; -/*! +/*! A model of `AlgebraicKernel_d_1::ApproximateAbsolute_1`. */ typedef unspecified_type Approximate_absolute_1; -/*! +/*! A model of `AlgebraicKernel_d_1::ApproximateRelative_1`. */ typedef unspecified_type Approximate_relative_1; @@ -163,7 +163,7 @@ typedef unspecified_type Approximate_relative_1; /// function must exist: /// @{ -/*! +/*! */ AlgebraicKernel_d_1::Bound_between_1 bound_between_1_object() const; diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h index 8e657c88390..dfbd40c5c29 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteX_2.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef int second_argument_type; @@ -41,7 +41,7 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! The function computes a pair \f$ p\f$ of `AlgebraicKernel_d_1::Bound`, where \f$ p.first\f$ represents the lower approximation and \f$ p.second\f$ represents diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h index ad32ef1d647..9d4a8b94834 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateAbsoluteY_2.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef int second_argument_type; @@ -41,7 +41,7 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! The function computes a pair \f$ p\f$ of `AlgebraicKernel_d_1::Bound`, where \f$ p.first\f$ represents the lower approximation and \f$ p.second\f$ represents diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h index 5e468c486ae..965db4cb55c 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeX_2.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef int second_argument_type; @@ -41,7 +41,7 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! The function computes a pair \f$ p\f$ of `AlgebraicKernel_d_1::Bound`, where \f$ p.first\f$ represents the lower approximation and \f$ p.second\f$ represents diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h index 3418c37677e..fcec3b5cb92 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ApproximateRelativeY_2.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef int second_argument_type; @@ -41,7 +41,7 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! The function computes a pair \f$ p\f$ of `AlgebraicKernel_d_1::Bound`, where \f$ p.first\f$ represents the lower approximation and \f$ p.second\f$ represents diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h index 05178705b84..bf11f493b57 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenX_2.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Bound result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; @@ -39,7 +39,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes a number of type `AlgebraicKernel_d_1::Bound` in-between the first coordinates of \f$ a\f$ and \f$ b\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h index 6d03f1e80df..3f6709c4455 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--BoundBetweenY_2.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Bound result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; @@ -39,7 +39,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes a number of type `AlgebraicKernel_d_1::Bound` in-between the second coordinates of \f$ a\f$ and \f$ b\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h index 7362f919b91..cfdefc0a995 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareXY_2.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Comparison_result` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; @@ -38,17 +38,17 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; /// \name Operations /// @{ -/*! +/*! Compares \f$ a\f$ and \f$ b\f$ lexicographically. */ result_type operator()(const first_argument_type & a, const second_argument_type & b); -/*! +/*! Compares \f$ a\f$ with \f$ (x,y)\f$ lexicographically. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, int x, int y); -/*! +/*! Compares \f$ a\f$ with \f$ (x,y)\f$ lexicographically. */ result_type operator()( @@ -56,7 +56,7 @@ AlgebraicKernel_d_2::Algebraic_real_2 a, AlgebraicKernel_d_2::Bound x, AlgebraicKernel_d_2::Bound y); -/*! +/*! Compares \f$ a\f$ with \f$ (x,y)\f$ lexicographically. */ result_type operator()( diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h index b6483487a2c..620bb133b08 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareX_2.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Comparison_result` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; @@ -39,27 +39,27 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; /// The following operators and their symmetric counterparts are required: /// @{ -/*! +/*! Compares the first coordinates of \f$ a\f$ and \f$ b\f$. */ result_type operator()(const first_argument_type & a, const second_argument_type & b); -/*! +/*! Compares the first coordinate of \f$ a\f$ with \f$ x\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, int x); -/*! +/*! Compares the first coordinate of \f$ a\f$ with \f$ x\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, AlgebraicKernel_d_2::Bound x); -/*! +/*! Compares the first coordinate of \f$ a\f$ with \f$ x\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, AlgebraicKernel_d_2::Coefficient x); -/*! +/*! Compares the first coordinate of \f$ a\f$ with \f$ x\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, AlgebraicKernel_d_2::Algebraic_real_1 x); diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h index ce39de7b46a..9d6b3483103 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--CompareY_2.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Comparison_result` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; @@ -39,27 +39,27 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; /// The following operators and their symmetric counterparts are required: /// @{ -/*! +/*! Compares the second coordinates of \f$ a\f$ and \f$ b\f$. */ result_type operator()(const first_argument_type & a, const second_argument_type & b); -/*! +/*! Compares the second coordinate of \f$ a\f$ with \f$ y\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, int y); -/*! +/*! Compares the second coordinate of \f$ a\f$ with \f$ y\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, AlgebraicKernel_d_2::Bound y); -/*! +/*! Compares the second coordinate of \f$ a\f$ with \f$ y\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, AlgebraicKernel_d_2::Coefficient y); -/*! +/*! Compares the second coordinate of \f$ a\f$ with \f$ y\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_2 a, AlgebraicKernel_d_2::Algebraic_real_1 y); diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h index 4fccd7b919d..e972739323b 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialX_2.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_1 result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; @@ -33,7 +33,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; /// \name Operations /// @{ -/*! +/*! Computes a univariate square free polynomial \f$ p\f$, such that the first coordinate of \f$ a\f$ is a real root of \f$ p\f$. */ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h index 7631af87f71..8625e4c0ae5 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputePolynomialY_2.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_1 result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; @@ -33,7 +33,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; /// \name Operations /// @{ -/*! +/*! Computes a univariate square free polynomial \f$ p\f$, such that the second coordinate of \f$ a\f$ is a real root of \f$ p\f$. */ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h index ae8ddd9b5ad..d23478e27ee 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeX_2.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_1 result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; @@ -34,7 +34,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; /// A model of this type must provide: /// @{ -/*! +/*! Computes the first coordinate of \f$ a\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h index 5e258be8a8d..de9c9f0556b 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ComputeY_2.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_1 result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; @@ -34,7 +34,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 argument_type; /// A model of this type must provide: /// @{ -/*! +/*! Computes the second coordinate of \f$ a\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h index e1a547d1031..c43f2f0664a 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--ConstructAlgebraicReal_2.h @@ -17,7 +17,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 result_type; @@ -27,27 +27,27 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 result_type; /// \name Operations /// @{ -/*! +/*! introduces an `AlgebraicKernel_d_2::Algebraic_real_2` initialized to \f$ (x,y)\f$. */ result_type operator()(int x, int y); -/*! +/*! introduces an `AlgebraicKernel_d_2::Algebraic_real_2` initialized to \f$ (x,y)\f$. */ result_type operator()(AlgebraicKernel_d_2::Bound x,AlgebraicKernel_d_2::Bound y); -/*! +/*! introduces an `AlgebraicKernel_d_2::Algebraic_real_2` initialized to \f$ (x,y)\f$. */ result_type operator()(AlgebraicKernel_d_2::Coefficient x,AlgebraicKernel_d_2::Coefficient y); -/*! +/*! introduces an `AlgebraicKernel_d_2::Algebraic_real_2` initialized to \f$ (x,y)\f$. */ result_type operator()(AlgebraicKernel_d_2::Algebraic_real_1 x,AlgebraicKernel_d_2::Algebraic_real_1 y); -/*! +/*! introduces an `AlgebraicKernel_d_2::Algebraic_real_2` initialized to the \f$ i\f$-th real common solution of \f$ f\f$ and \f$ g\f$, @@ -63,7 +63,7 @@ AlgebraicKernel_d_2::Polynomial_2 f, AlgebraicKernel_d_2::Polynomial_2 g, AlgebraicKernel_d_2::size_type i); -/*! +/*! introduces an `AlgebraicKernel_d_2::Algebraic_real_2` initialized to the only real intersection of \f$ f\f$ and \f$ g\f$ in the open box \f$ B = (x_l,x_u)\times(y_l,y_u)\f$. \pre \f$ x_l < x_u\f$ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h index aee97b833a1..70d7cabfeb6 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsCoprime_2.h @@ -17,17 +17,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 second_argument_type; @@ -37,7 +37,7 @@ typedef AlgebraicKernel_d_2::Polynomial_2 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes whether \f$ f\f$ and \f$ g\f$ are coprime. */ result_type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h index 357a3834600..a73d574680e 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsSquareFree_2.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 argument_type; @@ -33,7 +33,7 @@ typedef AlgebraicKernel_d_2::Polynomial_2 argument_type; /// \name Operations /// @{ -/*! +/*! Computes whether \f$ p\f$ is square free. */ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h index f87faea1108..7add7a0ba30 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsZeroAt_2.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `bool` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; @@ -39,7 +39,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes whether \f$ p\f$ is zero at \f$ a\f$. */ result_type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h index a15715afed8..1c8d09dbaad 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateX_2.h @@ -20,17 +20,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_1 second_argument_type; @@ -40,7 +40,7 @@ typedef AlgebraicKernel_d_2::Polynomial_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes an open isolating interval \f$ I=(l,u)\f$ for the first coordinate \f$ x\f$ of \f$ a\f$ with respect to the real roots of \f$ p\f$. It is not required that \f$ x\f$ is a root of \f$ p\f$. \post \f$ x \in I\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h index 6085fd2ece0..09d35efb5db 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--IsolateY_2.h @@ -20,17 +20,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_1 second_argument_type; @@ -40,7 +40,7 @@ typedef AlgebraicKernel_d_2::Polynomial_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes an open isolating interval \f$ I=(l,u)\f$ for the second coordinate \f$ y\f$ of \f$ a\f$ with respect to the real roots of \f$ p\f$. It is not required that \f$ x\f$ is a root of \f$ p\f$. \post \f$ y \in I\f$. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h index 7120e919966..d5ac00efc69 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeCoprime_2.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; @@ -35,7 +35,7 @@ typedef bool result_type; /// \name Operations /// @{ -/*! +/*! Computes \f$ g, q_1, q_2\f$ as described above. Returns whether \f$ p_1\f$ and \f$ p_2\f$ where already coprime. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h index 2ee76f6c017..f9175866e5d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--MakeSquareFree_2.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 argument_type; @@ -33,7 +33,7 @@ typedef AlgebraicKernel_d_2::Polynomial_2 argument_type; /// \name Operations /// @{ -/*! +/*! Returns a square free part of \f$ p\f$. */ diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h index b4dbdde96f4..be42927f55e 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--NumberOfSolutions_2.h @@ -18,17 +18,17 @@ public: /// A model of this type must provide: /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_2::size_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 second_argument_type; @@ -38,7 +38,7 @@ typedef AlgebraicKernel_d_2::Polynomial_2 second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns the number of real solutions of the bivariate polynomial system \f$ (f,g)\f$. \pre \f$ f\f$ is square free. \pre \f$ g\f$ is square free. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h index 27f0151a872..1848718d807 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SignAt_2.h @@ -20,17 +20,17 @@ public: /// \name Types /// @{ -/*! +/*! Type convertible to `CGAL::Sign` */ typedef unspecified_type result_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Polynomial_2 first_argument_type; -/*! +/*! */ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; @@ -40,7 +40,7 @@ typedef AlgebraicKernel_d_2::Algebraic_real_2 second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes the sign of a bivariate polynomial \f$ p\f$ evaluated at \f$ a\f$. */ result_type diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h index 0f8d948905a..50541524b2d 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--Solve_2.h @@ -16,7 +16,7 @@ public: /// A model of this type must provide: /// @{ -/*! +/*! Computes all common solutions of \f$ f\f$ and \f$ g\f$ with multiplicity, and copies them as objects of type `std::pair` in `res`. \pre \f$ f\f$ is square free. @@ -31,7 +31,7 @@ AlgebraicKernel_d_2::Polynomial_2 f, AlgebraicKernel_d_2::Polynomial_2 g, OutputIterator res ); -/*! +/*! Computes all common solutions of \f$ f\f$ and \f$ g\f$ in the closed box \f$ [xl,xu]\times[yl,yu]\f$, and copies them as objects of type `std::pair` in `res`. \pre \f$ f\f$ is square free. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h index 6de724a2b83..e0e754c0adb 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2--SquareFreeFactorize_2.h @@ -28,7 +28,7 @@ public: /// \name Operations /// @{ -/*! +/*! Copies in the output iterator the factors of a square free factorization of \f$ p\f$, with their multiplicity, as objects of type `std::pair`. diff --git a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h index 53460cd1949..758d153c06f 100644 --- a/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h +++ b/Algebraic_kernel_d/doc/Algebraic_kernel_d/Concepts/AlgebraicKernel_d_2.h @@ -20,7 +20,7 @@ public: /// \name Types /// @{ -/*! +/*! A bivariate polynomial that is a model of `Polynomial_d`, where \link PolynomialTraits_d::Innermost_coefficient_type `CGAL::Polynomial_traits_d::Innermost_coefficient_type` \endlink @@ -29,7 +29,7 @@ is `AlgebraicKernel_d_1::Coefficient`. */ typedef unspecified_type Polynomial_2; -/*! +/*! A type that is used to represent real solutions of bivariate zero dimensional polynomial systems. A model of `DefaultConstructible`, `CopyConstructible` and @@ -43,117 +43,117 @@ typedef unspecified_type Algebraic_real_2; /// \name Functors /// @{ -/*! +/*! A model of `AlgebraicKernel_d_2::ConstructAlgebraicReal_2`. */ typedef unspecified_type Construct_algebraic_real_2; -/*! +/*! A model of `AlgebraicKernel_d_2::ComputePolynomialX_2`. */ typedef unspecified_type Compute_polynomial_x_2; -/*! +/*! A model of `AlgebraicKernel_d_2::ComputePolynomialY_2`. */ typedef unspecified_type Compute_polynomial_y_2; -/*! +/*! A model of `AlgebraicKernel_d_2::Isolate_2`. */ typedef unspecified_type Isolate_2; -/*! +/*! A model of `AlgebraicKernel_d_2::IsolateX_2`. */ typedef unspecified_type Isolate_x_2; -/*! +/*! A model of `AlgebraicKernel_d_2::IsolateY_2`. */ typedef unspecified_type Isolate_y_2; -/*! +/*! A model of `AlgebraicKernel_d_2::IsSquareFree_2`. */ typedef unspecified_type Is_square_free_2; -/*! +/*! A model of `AlgebraicKernel_d_2::MakeSquareFree_2`. */ typedef unspecified_type Make_square_free_2; -/*! +/*! A model of `AlgebraicKernel_d_2::SquareFreeFactorize_2`. */ typedef unspecified_type Square_free_factorize_2; -/*! +/*! A model of `AlgebraicKernel_d_2::IsCoprime_2`. */ typedef unspecified_type Is_coprime_2; -/*! +/*! A model of `AlgebraicKernel_d_2::MakeCoprime_2`. */ typedef unspecified_type Make_coprime_2; -/*! +/*! A model of `AlgebraicKernel_d_2::Solve_2`. */ typedef unspecified_type Solve_2; -/*! +/*! A model of `AlgebraicKernel_d_2::NumberOfSolutions_2`. */ typedef unspecified_type Number_of_solutions_2; -/*! +/*! A model of `AlgebraicKernel_d_2::SignAt_2`. */ typedef unspecified_type Sign_at_2; -/*! +/*! A model of `AlgebraicKernel_d_2::CompareX_2`. */ typedef unspecified_type Compare_x_2; -/*! +/*! A model of `AlgebraicKernel_d_2::CompareY_2`. */ typedef unspecified_type Compare_y_2; -/*! +/*! A model of `AlgebraicKernel_d_2::CompareXY_2`. */ typedef unspecified_type Compare_xy_2; -/*! +/*! A model of `AlgebraicKernel_d_2::BoundBetweenX_2`. */ typedef unspecified_type Bound_between_x_2; -/*! +/*! A model of `AlgebraicKernel_d_2::BoundBetweenY_2`. */ typedef unspecified_type Bound_between_y_2; -/*! +/*! A model of `AlgebraicKernel_d_2::ApproximateAbsoluteX_2`. */ typedef unspecified_type Approximate_absolute_x_2; -/*! +/*! A model of `AlgebraicKernel_d_2::ApproximateAbsoluteY_2`. */ typedef unspecified_type Approximate_absolute_y_2; -/*! +/*! A model of `AlgebraicKernel_d_2::ApproximateRelativeX_2`. */ typedef unspecified_type Approximate_relative_x_2; -/*! +/*! A model of `AlgebraicKernel_d_2::ApproximateRelativeY_2`. */ typedef unspecified_type Approximate_relative_y_2; @@ -170,7 +170,7 @@ typedef unspecified_type Approximate_relative_y_2; /// function must exist: /// @{ -/*! +/*! */ AlgebraicKernel_d_2::Bound_between_x_2 bound_between_x_2_object() const; 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 026b2f9b15c..e268a0044f0 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 @@ -67,13 +67,13 @@ public: /// \name Types /// @{ -/*! +/*! the alpha shape traits type. it has to derive from a triangulation traits class. For example `Dt::Point` is a point class. */ typedef unspecified_type Gt; -/*! +/*! the number type of alpha values. In case `ExactAlphaComparisonTag` is `CGAL::Tag_false`, it is Gt::FT. @@ -92,33 +92,33 @@ For convenience, classical comparison operators are provided for the type `FT`. */ typedef Gt::FT FT; -/*! +/*! The size type. */ typedef unspecified_type size_type; -/*! +/*! A bidirectional and non-mutable iterator that allow to traverse the increasing sequence of different \f$ \alpha\f$-values. \pre Its `value_type` is `FT`. */ typedef unspecified_type Alpha_iterator; -/*! +/*! A bidirectional and non-mutable iterator that allow to traverse the vertices which belongs to the \f$ \alpha\f$-shape for the current \f$ \alpha\f$. \pre Its `value_type` is `Dt::Vertex_handle`. */ typedef unspecified_type Alpha_shape_vertices_iterator; -/*! +/*! A bidirectional and non-mutable iterator that allow to traverse the edges which belongs to the \f$ \alpha\f$-shape for the current \f$ \alpha\f$. \pre Its `value_type` is `Dt::Edge`. */ typedef unspecified_type Alpha_shape_edges_iterator; -/*! +/*! Distinguishes the different cases for classifying a \f$ k\f$-dimensional face of the underlying triangulation of the \f$ \alpha\f$-shape. */ @@ -131,7 +131,7 @@ of the underlying triangulation of the \f$ \alpha\f$-shape. not belong to the boundary of the alpha-shape. */ }; -/*! +/*! In general, an alpha shape can be disconnected and contain many singular edges or vertices. Its regularized version is formed by the set of regular edges and their vertices. @@ -144,7 +144,7 @@ enum Mode {GENERAL, /// \name Creation /// @{ -/*! +/*! Introduces an empty alpha-shape for a positive \f$ \alpha\f$-value `alpha`. \pre `alpha` \f$ \geq~0\f$. @@ -152,7 +152,7 @@ Introduces an empty alpha-shape for a positive \f$ \alpha\f$-value Alpha_shape_2(FT alpha = 0, Mode m = GENERAL); -/*! +/*! Builds an alpha shape of mode `m` from the triangulation `dt` for a positive \f$ \alpha\f$-value `alpha`. \attention This operation destroys the triangulation. @@ -163,7 +163,7 @@ Dt& dt, FT alpha = 0, Mode m = GENERAL); -/*! +/*! Initializes the family of alpha-shapes with the points in the range `[first,last)` and introduces an \f$ \alpha\f$-shape for a positive \f$ \alpha\f$-value @@ -183,7 +183,7 @@ Mode m = GENERAL); /// \name Operations /// @{ -/*! +/*! Initialize the family of alpha-shapes with the points in the range `[first,last)`. Returns the number of inserted points. @@ -196,13 +196,13 @@ std::ptrdiff_t make_alpha_shape( InputIterator first, InputIterator last); -/*! +/*! Clears the structure. */ void clear(); -/*! +/*! Sets the \f$ \alpha\f$-value to `alpha`. Returns the previous \f$ \alpha\f$-value. \pre `alpha` \f$ \geq0\f$. @@ -210,48 +210,48 @@ Returns the previous \f$ \alpha\f$-value. FT set_alpha(const FT& alpha); -/*! +/*! Returns the current \f$ \alpha\f$-value. */ const FT& get_alpha(void) const; -/*! +/*! Returns the `n`-th \f$\alpha\f$-value, sorted in an increasing order. \pre `n` \f$ <\f$ number of alphas. */ const FT& get_nth_alpha(size_type n) const; -/*! +/*! Returns the number of different alpha-values. */ size_type number_of_alphas() const; -/*! +/*! Sets the mode to its general or regularized version. Returns the previous mode. */ Mode set_mode(Mode m = GENERAL ); -/*! +/*! Returns the mode, that is either `GENERAL` or `REGULARIZED`. */ Mode get_mode(void) const; -/*! +/*! Starts at an arbitrary finite vertex which belongs to the \f$ \alpha\f$-shape for the current \f$ \alpha\f$. */ Alpha_shape_vertices_iterator alpha_shape_vertices_begin(); -/*! +/*! Past-the-end iterator. */ Alpha_shape_vertices_iterator alpha_shape_vertices_end(); -/*! +/*! Starts at an arbitrary finite edge which belongs to the \f$ \alpha\f$-shape for the current \f$ \alpha\f$. In regularized mode, edges are represented as a pair (f,i), where f is @@ -259,7 +259,7 @@ an interior face of the \f$ \alpha\f$-shape. */ Alpha_shape_edges_iterator alpha_shape_edges_begin(); -/*! +/*! Past-the-end iterator. */ Alpha_shape_edges_iterator alpha_shape_edges_end(); @@ -269,7 +269,7 @@ Alpha_shape_edges_iterator alpha_shape_edges_end(); /// \name Predicates /// @{ -/*! +/*! Locates a point `p` in the underlying triangulation and Classifies the associated k-face with respect to the alpha shape. */ @@ -277,19 +277,19 @@ Classification_type classify(const Point& p, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the face `f` of the underlying triangulation with respect to the alpha shape. */ Classification_type classify(Face_handle f, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the edge `e` of the underlying triangulation with respect to the alpha shape. */ Classification_type classify(Edge e, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the edge of the face `f` opposite to the vertex with index `i` of the underlying triangulation with respect to the alpha shape. @@ -297,7 +297,7 @@ of the underlying triangulation with respect to the alpha shape. Classification_type classify(Face_handle f, int i, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the vertex `v` of the underlying triangulation with respect to the alpha shape. */ Classification_type @@ -308,31 +308,31 @@ classify(Vertex_handle v, const FT& alpha = get_alpha()) const; /// \name Traversal of the alpha-Values /// @{ -/*! +/*! Returns an iterator that allows to traverse the sorted sequence of \f$ \alpha\f$-values of the family of alpha shapes. */ Alpha_iterator alpha_begin() const; -/*! +/*! Returns the corresponding past-the-end iterator. */ Alpha_iterator alpha_end() const; -/*! +/*! Returns an iterator pointing to an element with \f$ \alpha\f$-value `alpha`, or the corresponding past-the-end iterator if such an element is not found. */ Alpha_iterator alpha_find(const FT& alpha) const; -/*! +/*! Returns an iterator pointing to the first element with \f$ \alpha\f$-value not less than `alpha`. */ Alpha_iterator alpha_lower_bound(const FT& alpha) const; -/*! +/*! Returns an iterator pointing to the first element with \f$ \alpha\f$-value greater than `alpha`. */ @@ -343,13 +343,13 @@ Alpha_iterator alpha_upper_bound(const FT& alpha) const; /// \name Operations /// @{ -/*! +/*! Returns the number of solid components of the alpha shape, that is, the number of components of its regularized version. */ size_type number_of_solid_components(const FT& alpha = get_alpha()) const; -/*! +/*! Returns an iterator pointing to the first element with \f$ \alpha\f$-value such that the alpha shape satisfies the following two properties: @@ -361,7 +361,7 @@ If no such value is found, the iterator points to the first element with */ Alpha_iterator find_optimal_alpha(size_type nb_components) const; -/*! +/*! Inserts the alpha shape for the current \f$ \alpha\f$-value into the stream `os`. \pre CGAL/IO/io.h must be included. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h index e07cf40bedf..e1c6f2c3023 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeFace_2.h @@ -15,13 +15,13 @@ public: /// \name Types /// @{ -/*! +/*! A container type to get (and put) the three special values (\f$ \alpha_1, \alpha_2, \alpha_3\f$) associated with an alpha shape edge. */ typedef unspecified_type Interval_3; -/*! +/*! A coordinate type. The type must provide a copy constructor, assignment, comparison operators, negation, multiplication, division and allow the @@ -36,17 +36,17 @@ typedef unspecified_type FT; /// \name Creation /// @{ -/*! +/*! default constructor. */ AlphaShapeFace_2(); -/*! +/*! constructor setting the incident vertices. */ AlphaShapeFace_2(const Vertex_handle& v0, const Vertex_handle& v1, const Vertex_handle& v2); -/*! +/*! constructor setting the incident vertices and the neighboring faces. */ AlphaShapeFace_2(const Vertex_handle& v0, const Vertex_handle& v1, const Vertex_handle& v2, const Face_handle& n0, const Face_handle& n1, const Face_handle& n2); @@ -56,7 +56,7 @@ AlphaShapeFace_2(const Vertex_handle& v0, const Vertex_handle& v1, const Vertex_ /// \name Access Functions /// @{ -/*! +/*! returns the interval associated with the edge indexed with \f$ i\f$, which contains three alpha values \f$ \alpha_1 \leq\alpha_2 \leq\alpha_3\f$, such as for @@ -67,7 +67,7 @@ greater than \f$ \alpha_3\f$, the edge is interior. */ Interval_3 get_ranges(const int& i); -/*! +/*! return the alpha value, under which the alpha shape contains the face. */ @@ -78,7 +78,7 @@ FT get_alpha(); /// \name Modifiers /// @{ -/*! +/*! sets the interval associated with the edge indexed with \f$ i\f$, which contains three alpha values \f$ \alpha_1 \leq\alpha_2 \leq\alpha_3\f$, such as for @@ -89,7 +89,7 @@ greater than \f$ \alpha_3\f$, the edge is interior. */ void set_ranges(const int& i, const Interval_3& V); -/*! +/*! sets the alpha value, under which the alpha shape contains the face. */ diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h index b6ef17e5a45..4b4155205c6 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeTraits_2.h @@ -22,7 +22,7 @@ public: /// \name Types /// @{ -/*! +/*! A coordinate type. The type must provide a copy constructor, assignment, comparison operators, negation, multiplication, division and allow the @@ -38,7 +38,7 @@ typedef unspecified_type FT; /// Only a default constructor is required. Note that further constructors can be provided. /// @{ -/*! +/*! A default constructor. */ AlphaShapeTraits_2(); @@ -48,7 +48,7 @@ A default constructor. /// \name Constructions by function objects /// @{ -/*! +/*! Returns an object, which has to be able to compute the squared radius of the circle of the points `p0, p1, p2` or the squared radius of smallest circle of the points `p0, p1`, as `FT` associated with the metric used @@ -61,7 +61,7 @@ Compute_squared_radius_2 compute_squared_radius_2_object(); /// \name Predicate by function object /// @{ -/*! +/*! Returns an object, which has to be able to compute the relative position of point `test` to the smallest circle of the points `p0, p1`, using the same metric as `Dt`. diff --git a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h index 77b2c735bb4..630e4a2481b 100644 --- a/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h +++ b/Alpha_shapes_2/doc/Alpha_shapes_2/Concepts/AlphaShapeVertex_2.h @@ -13,7 +13,7 @@ public: /// \name Types /// @{ -/*! +/*! A coordinate type. The type must provide a copy constructor, assignment, comparison operators, negation, multiplication, division and allow the @@ -28,18 +28,18 @@ typedef unspecified_type FT; /// \name Creation /// @{ -/*! +/*! default constructor. */ AlphaShapeVertex_2(); -/*! +/*! constructor setting the point. */ AlphaShapeVertex_2(Point p); -/*! +/*! constructor setting the point associated to and an incident face. */ AlphaShapeVertex_2(Point p, const Face_handle& ff); @@ -49,7 +49,7 @@ AlphaShapeVertex_2(Point p, const Face_handle& ff); /// \name Access Functions /// @{ -/*! +/*! returns two alpha values \f$ \alpha_1 \leq\alpha_2\f$, such as for \f$ \alpha\f$ between \f$ \alpha_1\f$ and \f$ \alpha_2\f$, the vertex is attached but singular, and for \f$ \alpha\f$ upper \f$ \alpha_2\f$, the vertex is regular. @@ -61,7 +61,7 @@ std::pair< FT, FT > get_range(); /// \name Modifiers /// @{ -/*! +/*! sets the alpha values \f$ \alpha_1 \leq\alpha_2\f$, such as for \f$ \alpha\f$ between \f$ \alpha_1\f$ and \f$ \alpha_2\f$, the vertex is attached but singular, and for \f$ \alpha\f$ upper \f$ \alpha_2\f$, the vertex is regular. 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 dc1ca8edf7b..dda73942b2e 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 @@ -60,13 +60,13 @@ public: /// \name Types /// @{ -/*! +/*! the alpha shape traits type. It has to derive from a triangulation traits class. For example `Dt::Point` is a point class. */ typedef unspecified_type Gt; -/*! +/*! the number type of alpha values. In case `ExactAlphaComparisonTag` is `CGAL::Tag_false`, it is Gt::FT. @@ -85,19 +85,19 @@ For convenience, classical comparison operators are provided for the type `FT`. */ typedef unspecified_type FT; -/*! +/*! The size type. */ typedef unspecified_type size_type; -/*! +/*! A bidirectional and non-mutable iterator that allow to traverse the increasing sequence of different alpha values. \pre Its `value_type` is `FT`. */ typedef unspecified_type Alpha_iterator; -/*! +/*! In GENERAL mode, In REGULARIZED mode, */ @@ -110,7 +110,7 @@ enum Mode {GENERAL, /**< the alpha complex can have singular faces, of the triangulation and the subfaces of those cells. */ }; -/*! +/*! Enum to classify the faces of the underlying triangulation with respect to the alpha shape. @@ -136,13 +136,13 @@ enum Classification_type {EXTERIOR, SINGULAR, REGULAR, INTERIOR}; /// \name Creation /// @{ -/*! +/*! Introduces an empty alpha shape, sets the current alpha value to `alpha` and the mode to `m`. */ Alpha_shape_3(FT alpha = 0, Mode m = REGULARIZED); -/*! +/*! Builds an alpha shape of mode `m` from the triangulation `dt`. \attention This operation destroys the triangulation `dt`. @@ -151,7 +151,7 @@ Alpha_shape_3(Dt& dt, FT alpha = 0, Mode m = REGULARIZED); -/*! +/*! Builds an alpha shape of mode `m` for the points in the range `[first,last)` and set the current alpha value to `alpha`. \tparam InputIterator must be an input iterator with value type `Point` (the point type of the underlying triangulation.) @@ -168,7 +168,7 @@ Mode m = REGULARIZED); /// \name Modifiers /// @{ -/*! +/*! Initialize the alpha shape data structure for points in the range `[first,last)`. Returns the number of data points inserted in the underlying @@ -183,13 +183,13 @@ std::ptrdiff_t make_alpha_shape( InputIterator first, InputIterator last); -/*! +/*! Clears the structure. */ void clear(); -/*! +/*! Sets the \f$ \alpha\f$-value to `alpha`. Returns the previous \f$ \alpha\f$-value. \pre `alpha` \f$ \geq0\f$. @@ -197,7 +197,7 @@ Returns the previous \f$ \alpha\f$-value. FT set_alpha(const FT& alpha); -/*! +/*! Sets the mode of the alpha shape to `GENERAL` or `REGULARIZED`. Returns the previous mode. Changing the mode of an alpha shape @@ -211,30 +211,30 @@ set_mode(Mode m = REGULARIZED ); /// \name Query Functions /// @{ -/*! +/*! Returns whether the alpha shape is general or regularized. */ Mode get_mode(void) const; -/*! +/*! Returns the current \f$ \alpha\f$-value. */ const FT& get_alpha(void) const; -/*! +/*! Returns the `n`-th `alpha`-value, sorted in an increasing order. \pre `n` < number of alphas. */ const FT& get_nth_alpha(int n) const; -/*! +/*! Returns the number of different alpha-values. */ size_type number_of_alphas() const; -/*! +/*! Locates a point `p` in the underlying triangulation and Classifies the associated k-face with respect to `alpha`. */ @@ -242,7 +242,7 @@ Classification_type classify(const Point& p, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the cell `f` of the underlying triangulation with respect to `alpha`. @@ -250,14 +250,14 @@ to `alpha`. Classification_type classify(Cell_handle f, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the facet `f` of the underlying triangulation with respect to `alpha`. */ Classification_type classify(Facet f, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the facet of the cell `f` opposite to the vertex with index `i` of the underlying triangulation with respect to `alpha`. @@ -265,19 +265,19 @@ of the underlying triangulation with respect to `alpha`. Classification_type classify(Cell_handle f, int i, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the edge `e` with respect to `alpha` . */ Classification_type classify(const Edge& e, const FT& alpha = get_alpha()) const; -/*! +/*! Classifies the vertex `v` of the underlying triangulation with respect to `alpha`. */ Classification_type classify(Vertex_handle v, const FT& alpha = get_alpha()) const; -/*! +/*! Write the cells which are of type `type` for the alpha value `alpha` to the sequence pointed to by the output iterator `it`. Returns past the end @@ -288,7 +288,7 @@ OutputIterator get_alpha_shape_cells(OutputIterator it, Classification_type type, const FT& alpha = get_alpha()); -/*! +/*! Write the facets which are of type `type` for the alpha value `alpha` to the sequence pointed to by the output iterator `it`. Returns past the end @@ -299,7 +299,7 @@ OutputIterator get_alpha_shape_facets(OutputIterator it, Classification_type type, const FT& alpha= get_alpha()); -/*! +/*! Write the edges which are of type `type` for the alpha value `alpha` to the sequence pointed to by the output iterator `it`. Returns past the end @@ -310,7 +310,7 @@ OutputIterator get_alpha_shape_edges(OutputIterator it, Classification_type type, const FT& alpha = get_alpha()); -/*! +/*! Write the vertices which are of type `type` for the alpha value `alpha` to the sequence pointed to by the output iterator `it`. Returns past the end @@ -321,7 +321,7 @@ OutputIterator get_alpha_shape_vertices(OutputIterator it, Classification_type type, const FT& alpha); -/*! +/*! Output all the faces of the triangulation in increasing order of the alpha value for which they appear in the alpha complex. In case of equal alpha value @@ -337,31 +337,31 @@ OutputIterator filtration(OutputIterator it); /// \name Traversal of the alpha-Values /// @{ -/*! +/*! Returns an iterator that allows to traverse the sorted sequence of \f$ \alpha\f$-values of the family of alpha shapes. */ Alpha_iterator alpha_begin() const; -/*! +/*! Returns the corresponding past-the-end iterator. */ Alpha_iterator alpha_end() const; -/*! +/*! Returns an iterator pointing to an element with \f$ \alpha\f$-value `alpha`, or the corresponding past-the-end iterator if such an element is not found. */ Alpha_iterator alpha_find(const FT& alpha) const; -/*! +/*! Returns an iterator pointing to the first element with \f$ \alpha\f$-value not less than `alpha`. */ Alpha_iterator alpha_lower_bound(const FT& alpha) const; -/*! +/*! Returns an iterator pointing to the first element with \f$ \alpha\f$-value greater than `alpha`. */ @@ -372,13 +372,13 @@ Alpha_iterator alpha_upper_bound(const FT& alpha) const; /// \name Operations /// @{ -/*! +/*! Returns the number of solid components of the alpha shape, that is, the number of components of its regularized version. */ size_type number_of_solid_components(const FT& alpha = get_alpha()) const; -/*! +/*! Returns an iterator pointing to smallest \f$ \alpha\f$ value such that the alpha shape satisfies the following two properties: @@ -395,7 +395,7 @@ Alpha_iterator find_optimal_alpha(size_type nb_components) const; }; /* end Alpha_shape_3 */ -/*! +/*! Inserts the alpha shape `A` for the current alpha value into the stream `os`. Defined in `CGAL/IO/io.h` @@ -406,7 +406,7 @@ Defined in `CGAL/IO/io.h` ostream& operator<<(std::ostream& os, const Alpha_shape_3& A); -/*! +/*! Inserts the alpha shape `A` for the current alpha value into the Geomview stream `W`. \pre The insert operator must be defined for `GT::Point` and `GT::Triangle`. diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h index 7f3f76210f3..a0d7cb15cc5 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/CGAL/Alpha_shape_cell_base_3.h @@ -64,7 +64,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Alpha_status(); @@ -74,27 +74,27 @@ Alpha_status(); /// \name Modifiers /// @{ -/*! +/*! sets Gabriel marker. */ void set_is_Gabriel(bool yesorno); -/*! +/*! sets convex hull marker. */ void set_is_on_chull(bool yesorno); -/*! +/*! sets `alpha_min`. */ void set_alpha_min(NT alpha); -/*! +/*! sets `alpha_mid`. */ void set_alpha_mid(NT alpha); -/*! +/*! sets `alpha_max`. */ void set_alpha_max(NT alpha); @@ -104,28 +104,28 @@ void set_alpha_max(NT alpha); /// \name Access Functions /// @{ -/*! +/*! Returns true for Gabriel faces. */ bool is_Gabriel() const ; -/*! +/*! Returns true for convex hull faces. */ bool is_on_chull() const; -/*! +/*! Returns the `alpha_min`. \pre `is_Gabriel()` returns false; */ NT alpha_min() const; -/*! +/*! Returns the `alpha_mid`. */ NT alpha_mid() const; -/*! +/*! Returns `alpha_max`. \pre `is_on_chull()` returns `false`. */ 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 14c58174fdd..c934f147545 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 @@ -38,18 +38,18 @@ public: /// \name Types /// @{ -/*! +/*! the alpha shape traits type. It has to derive from a triangulation traits class. For example `Dt::Point` is a Point class. */ typedef unspecified_type Gt; -/*! +/*! the number type of alpha. */ typedef Gt::FT FT; -/*! +/*! Enum to classify the simplices of the underlying triangulation with respect to a given alpha value. @@ -68,19 +68,19 @@ enum Classification_type {EXTERIOR, SINGULAR, REGULAR, INTERIOR}; /// \name Creation /// @{ -/*! +/*! Introduces an empty fixed alpha shape and sets the alpha value to `alpha`. */ Fixed_alpha_shape_3(FT alpha = 0); -/*! +/*! Builds a fixed alpha shape from the triangulation `dt`, and sets the alpha value to `alpha`. \attention This operation destroys the triangulation. */ Fixed_alpha_shape_3(Dt& dt,FT alpha = 0); -/*! +/*! Builds a fixed alpha shape for the points in the range `[first,last)` and sets the alpha value to `alpha`. \tparam InputIterator must be an input iterator with value type `Point` (the type point of the underlying triangulation.) @@ -96,7 +96,7 @@ const FT& alpha = 0); /// \name Modifiers /// @{ -/*! +/*! Inserts point p in the underlying triangulation and returns the corresponding vertex. The optional argument `start` is used as a starting place for the search. @@ -106,7 +106,7 @@ to the new ones are updated. */ Vertex_handle insert (Point p,Cell_handle start = Cell_handle()); -/*! +/*! Removes the vertex v from the underlying triangulation. The classification types of new simplices and their incident faces are set or reset. @@ -114,7 +114,7 @@ The classification types of new simplices and their incident faces are set or re */ void remove (Vertex_handle v); -/*! +/*! Clears the structure. */ void @@ -125,40 +125,40 @@ clear(); /// \name Query Functions /// @{ -/*! +/*! Returns the \f$ \alpha\f$-value. */ const FT& get_alpha(void) const; -/*! +/*! Classifies the cell `c` of the underlying triangulation in the alpha complex. */ Classification_type classify(Cell_handle c) const; -/*! +/*! Classifies the facet `f` of the underlying triangulation in the alpha complex. */ Classification_type classify(Facet f) const; -/*! +/*! Classifies the facet of the cell `f` opposite to the vertex with index `i` of the underlying triangulation in the alpha complex. */ Classification_type classify(Cell_handle f, int i) const; -/*! +/*! Classifies the edge `e` of the underlying triangulation in the alpha complex. */ Classification_type classify(const Edge& e) const; -/*! +/*! Classifies the vertex `v` of the underlying triangulation in the alpha complex. */ Classification_type classify(Vertex_handle v) const; -/*! +/*! Writes the cells which are of type `type` in the alpha complex to the sequence pointed to by the output iterator `it`. Returns past the end @@ -167,7 +167,7 @@ of the output sequence. template OutputIterator get_alpha_shape_cells(OutputIterator it, Classification_type type); -/*! +/*! Writes the facets which are of type `type` in the alpha complex to the sequence pointed to by the output iterator `it`. Returns past the end of the output sequence. @@ -175,7 +175,7 @@ of the output sequence. template OutputIterator get_alpha_shape_facets(OutputIterator it, Classification_type type); -/*! +/*! Writes the edges which are of type `type` in the alpha complex to the sequence pointed to by the output iterator `it`. Returns past the end @@ -184,7 +184,7 @@ of the output sequence. template OutputIterator get_alpha_shape_edges(OutputIterator it, Classification_type type); -/*! +/*! Writes the vertices which are of type `type` in the alpha complex to the sequence pointed to by the output iterator `it`. Returns past the end of the output sequence. @@ -196,7 +196,7 @@ OutputIterator get_alpha_shape_vertices(OutputIterator it, Classification_type t }; /* end Fixed_alpha_shape_3 */ -/*! +/*! Inserts the fixed alpha shape `A` into the stream `os`. Defined in `CGAL/IO/io.h` diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h index bca30893619..0ee05efeb84 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeCell_3.h @@ -18,13 +18,13 @@ public: /// \name Types /// @{ -/*! +/*! A number type. Must be the same as the number type used in the traits class of the triangulation underlying the alpha shape. */ typedef unspecified_type NT; -/*! +/*! An iterator with value type `CGAL::Alpha_status`. */ typedef unspecified_type Alpha_status_iterator; @@ -34,17 +34,17 @@ typedef unspecified_type Alpha_status_iterator; /// \name Creation /// @{ -/*! +/*! default constructor. */ AlphaShapeCell_3(); -/*! +/*! constructor setting the incident vertices. */ AlphaShapeCell_3(const Vertex_handle& v0, const Vertex_handle& v1, const Vertex_handle& v2, const Vertex_handle& v3); -/*! +/*! constructor setting the incident vertices and the neighboring cells. */ AlphaShapeCell_3(const Vertex_handle& v0, const Vertex_handle& v1, const Vertex_handle& v2, const Vertex_handle& v3, @@ -55,12 +55,12 @@ const Cell_handle& n0, const Cell_handle& n1, const Cell_handle& n2, const Cell_ /// \name Access Functions /// @{ -/*! +/*! Returns the alpha value of the cell. */ NT get_alpha(); -/*! +/*! Returns an iterator on the `CGAL::Alpha_status` of the facet `i` of the cell. */ @@ -71,12 +71,12 @@ Alpha_status_iterator get_facet_status(int i); /// \name Modifiers /// @{ -/*! +/*! Sets the critical value of the cell. */ void set_alpha(const NT & alpha); -/*! +/*! Sets the iterator pointing to the `CGAL::Alpha_status` of the facet `i` of the cell. */ diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h index fa6e996936d..681e0edda1a 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeTraits_3.h @@ -31,13 +31,13 @@ public: /// \name Types /// @{ -/*! +/*! A number type compatible with the type used for the points coordinate. */ typedef unspecified_type FT; -/*! +/*! An object constructor able to compute: - the squared radius of the @@ -56,7 +56,7 @@ typedef unspecified_type Compute_squared_radius_3; /// \name Creation /// @{ -/*! +/*! Default constructor. */ AlphaShapeTraits_3(); @@ -66,7 +66,7 @@ AlphaShapeTraits_3(); /// \name Access Functions /// @{ -/*! +/*! */ Compute_squared_radius_3 compute_squared_radius_3_object(); diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h index af3c702413c..f092a020ad5 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/AlphaShapeVertex_3.h @@ -20,13 +20,13 @@ public: /// \name Types /// @{ -/*! +/*! Must be the same as the point type provided by the geometric traits class of the triangulation. */ typedef unspecified_type Point; -/*! +/*! Must be `CGAL::Alpha_status` where `NT` is the number type used in the geometric traits class of the triangulation. @@ -38,17 +38,17 @@ typedef unspecified_type Alpha_status; /// \name Creation /// @{ -/*! +/*! default constructor. */ AlphaShapeVertex_3(); -/*! +/*! constructor setting the point. */ AlphaShapeVertex_3(Point p); -/*! +/*! constructor setting the point and an incident cell. */ AlphaShapeVertex_3(Point p, const Cell_handle& c); @@ -58,7 +58,7 @@ AlphaShapeVertex_3(Point p, const Cell_handle& c); /// \name Modifiers /// @{ -/*! +/*! Returns a pointer the alpha status of the vertex. */ Alpha_status* get_alpha_status(); diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h index e88a746c10a..a694e496255 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeCell_3.h @@ -17,17 +17,17 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ FixedAlphaShapeCell_3(); -/*! +/*! constructor setting the incident vertices. */ FixedAlphaShapeCell_3(const Vertex_handle& v0, const Vertex_handle& v1, const Vertex_handle& v2, const Vertex_handle& v3); -/*! +/*! constructor setting the incident vertices and the neighboring cells. */ FixedAlphaShapeCell_3(const Vertex_handle& v0, const Vertex_handle& v1, const Vertex_handle& v2, const Vertex_handle& v3, @@ -38,12 +38,12 @@ const Cell_handle& n0, const Cell_handle& n1, const Cell_handle& n2, const Cell_ /// \name Access Functions /// @{ -/*! +/*! Returns the classification of the cell. */ Classification_type get_classification_type(); -/*! +/*! Returns the classification of the i-th facet of the cell. */ Classification_type get_facet_classification_type(int i); @@ -53,12 +53,12 @@ Classification_type get_facet_classification_type(int i); /// \name Modifiers /// @{ -/*! +/*! Sets the classification of the cell. */ void set_classification_type(Classification_type type); -/*! +/*! Sets the classification of the i-th facet of the cell. */ void set_facet_classification_type(int i, Classification_type type); diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h index 8932f73a705..4149dc915e0 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeTraits_3.h @@ -31,12 +31,12 @@ public: /// \name Types /// @{ -/*! +/*! `CGAL::Comparison_result` or `Uncertain` */ typedef unspecified_type Comparison_result; -/*! +/*! An object constructor able to compare the squared radius of the smallest circumscribing sphere of either four, three, two or one point(s) with a given value of alpha. @@ -54,7 +54,7 @@ typedef unspecified_type Compare_squared_radius_3; /// \name Creation /// @{ -/*! +/*! Default constructor. */ FixedAlphaShapeTraits_3(); @@ -64,7 +64,7 @@ FixedAlphaShapeTraits_3(); /// \name Access Functions /// @{ -/*! +/*! */ Compare_squared_radius_3 compare_squared_radius_3_object(); diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h index eb3bea65d5d..14a6e26e0a6 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedAlphaShapeVertex_3.h @@ -17,7 +17,7 @@ public: /// \name Types /// @{ -/*! +/*! Must be the same as the point type provided by the geometric traits class of the triangulation. */ @@ -28,17 +28,17 @@ typedef unspecified_type Point; /// \name Creation /// @{ -/*! +/*! default constructor. */ FixedAlphaShapeVertex_3(); -/*! +/*! constructor setting the point. */ FixedAlphaShapeVertex_3(Point p); -/*! +/*! constructor setting the point and an incident cell. */ FixedAlphaShapeVertex_3(Point p, const Cell_handle& c); @@ -48,12 +48,12 @@ FixedAlphaShapeVertex_3(Point p, const Cell_handle& c); /// \name Access Functions /// @{ -/*! +/*! Returns a boolean indicating whether the point is on the convex hull of the point of the triangulation. */ bool is_on_chull(); -/*! +/*! Returns the classification of the vertex. */ Classification_type get_classification_type(); @@ -63,12 +63,12 @@ Classification_type get_classification_type(); /// \name Modifiers /// @{ -/*! +/*! Sets the classification of the vertex. */ void set_classification_type(Classification_type type); -/*! +/*! Sets whether the vertex is on the convex hull. */ void is_on_chull(bool b); diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h index 96483a3e62c..46ee964c4ee 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/FixedWeightedAlphaShapeTraits_3.h @@ -23,12 +23,12 @@ public: /// \name Types /// @{ -/*! +/*! `CGAL::Comparison_result` or `Uncertain` */ typedef unspecified_type Comparison_result; -/*! +/*! An object constructor able to compare the squared radius of the smallest sphere orthogonal to either four, three, two or one weighted point(s) to a given value of alpha. @@ -46,7 +46,7 @@ typedef unspecified_type Compare_weighted_squared_radius_3; /// \name Creation /// @{ -/*! +/*! default constructor. */ FixedWeightedAlphaShapeTraits_3(); @@ -56,7 +56,7 @@ FixedWeightedAlphaShapeTraits_3(); /// \name Access Functions /// @{ -/*! +/*! */ Compare_weighted_squared_radius_3 compare_weighted_squared_radius_3_object(); diff --git a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h index 89ba2f5199a..290abe37aa6 100644 --- a/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h +++ b/Alpha_shapes_3/doc/Alpha_shapes_3/Concepts/WeightedAlphaShapeTraits_3.h @@ -24,13 +24,13 @@ public: /// \name Types /// @{ -/*! +/*! A number type compatible with the type used for the points coordinates. */ typedef unspecified_type FT; -/*! +/*! An object constructor able to compute the squared radius of the smallest sphere orthogonal to four weighted points `p0, p1, p2, p3`, and the squared radius of the @@ -47,7 +47,7 @@ typedef unspecified_type Compute_squared_radius_smallest_orthogonal_sphere_3; /// \name Creation /// @{ -/*! +/*! default constructor. */ WeightedAlphaShapeTraits_3(); @@ -57,7 +57,7 @@ WeightedAlphaShapeTraits_3(); /// \name Access Functions /// @{ -/*! +/*! */ Compute_squared_radius_smallest_orthogonal_sphere_3 compute_squared_radius_smallest_orthogonal_sphere_3_object(); 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 15352d3c0a3..27bb8401c69 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 @@ -59,31 +59,31 @@ public: /// \name Types /// @{ -/*! +/*! A type for the underlying data structure. */ typedef Agds Data_structure; -/*! +/*! Same as the `Data_structure` type. This type has been introduced in order for the `Apollonius_graph_2` class to be a model of the `DelaunayGraph_2` concept. */ typedef Data_structure Triangulation_data_structure; -/*! +/*! A type for the geometric traits. */ typedef Gt Geom_traits; -/*! +/*! A type for the point defined in the geometric traits. */ typedef Gt::Point_2 Point_2; -/*! +/*! A type for the Apollonius site, defined in the geometric traits. */ typedef Gt::Site_2 Site_2; @@ -108,7 +108,7 @@ typedef Gt::Site_2 Site_2; /// infinite and finite features. /// @{ -/*! +/*! the edge type. The `Edge(f,i)` is the edge common to faces `f` and `f.neighbor(i)`. It is also the edge joining the vertices @@ -117,75 +117,75 @@ The `Edge(f,i)` is the edge common to faces `f` and */ typedef Data_structure::Edge Edge; -/*! +/*! A type for a vertex. */ typedef Data_structure::Vertex Vertex; -/*! +/*! A type for a face. */ typedef Data_structure::Face Face; -/*! +/*! A type for a handle to a vertex. */ typedef Data_structure::Vertex_handle Vertex_handle; -/*! +/*! A type for a handle to a face. */ typedef Data_structure::Face_handle Face_handle; -/*! +/*! A type for a circulator over vertices incident to a given vertex. */ typedef Data_structure::Vertex_circulator Vertex_circulator; -/*! +/*! A type for a circulator over faces incident to a given vertex. */ typedef Data_structure::Face_circulator Face_circulator; -/*! +/*! A type for a circulator over edges incident to a given vertex. */ typedef Data_structure::Edge_circulator Edge_circulator; -/*! +/*! A type for an iterator over all vertices. */ typedef Data_structure::Vertex_iterator All_vertices_iterator; -/*! +/*! A type for an iterator over all faces. */ typedef Data_structure::Face_iterator All_faces_iterator; -/*! +/*! A type for an iterator over all edges. */ typedef Data_structure::Edge_iterator All_edges_iterator; -/*! +/*! An unsigned integral type. */ typedef Data_structure::size_type size_type; -/*! +/*! A type for an iterator over finite vertices. */ typedef unspecified_type Finite_vertices_iterator; -/*! +/*! A type for an iterator over finite faces. */ typedef unspecified_type Finite_faces_iterator; -/*! +/*! A type for an iterator over finite edges. */ typedef unspecified_type Finite_edges_iterator; @@ -199,17 +199,17 @@ typedef unspecified_type Finite_edges_iterator; /// visible sites of the Apollonius graph. /// @{ -/*! +/*! A type for an iterator over all sites. */ typedef unspecified_type Sites_iterator; -/*! +/*! A type for an iterator over all visible sites. */ typedef unspecified_type Visible_sites_iterator; -/*! +/*! A type for an iterator over all hidden sites. */ typedef unspecified_type Hidden_sites_iterator; @@ -219,13 +219,13 @@ typedef unspecified_type Hidden_sites_iterator; /// \name Creation /// @{ -/*! +/*! Creates an Apollonius graph `ag` using `gt` as geometric traits. */ Apollonius_graph_2(Gt gt=Gt()); -/*! +/*! Creates an Apollonius graph `ag` using `gt` as geometric traits and inserts all sites in the range [`first`, `beyond`). @@ -235,7 +235,7 @@ template< class Input_iterator > Apollonius_graph_2(Input_iterator first, Input_iterator beyond, Gt gt=Gt()); -/*! +/*! Copy constructor. All faces and vertices are duplicated. After the construction, `ag` and `other` refer to two different Apollonius graphs : if @@ -243,7 +243,7 @@ construction, */ Apollonius_graph_2(const Apollonius_graph_2& other); -/*! +/*! Assignment. If `ag` and `other` are the same object nothing is done. Otherwise, all the vertices and faces are duplicated. After the assignment, `ag` and `other` refer to @@ -258,62 +258,62 @@ operator=(const Apollonius_graph_2& other); /// \name Access Functions /// @{ -/*! +/*! Returns a reference to the Apollonius graph traits object. */ Geom_traits geom_traits(); -/*! +/*! Returns a reference to the underlying data structure. */ Data_structure data_structure(); -/*! +/*! Same as `data_structure()`. This method has been added in compliance with the `DelaunayGraph_2` concept. */ Data_structure tds(); -/*! +/*! Returns the dimension of the Apollonius graph. */ int dimension(); -/*! +/*! Returns the number of finite vertices. */ size_type number_of_vertices(); -/*! +/*! Returns the number of visible sites. */ size_type number_of_visible_sites(); -/*! +/*! Returns the number of hidden sites. */ size_type number_of_hidden_sites(); -/*! +/*! Returns the number of faces (both finite and infinite) of the Apollonius graph. */ size_type number_of_faces(); -/*! +/*! Returns a face incident to the `infinite_vertex`. */ Face_handle infinite_face(); -/*! +/*! Returns the `infinite_vertex`. */ Vertex_handle infinite_vertex(); -/*! +/*! Returns a vertex distinct from the `infinite_vertex`. \pre The number of (visible) vertices in the Apollonius graph must be at least one. */ @@ -334,63 +334,63 @@ Vertex_handle finite_vertex(); /// change in the Apollonius graph. /// @{ -/*! +/*! Starts at an arbitrary finite vertex. */ Finite_vertices_iterator finite_vertices_begin(); -/*! +/*! Past-the-end iterator. */ Finite_vertices_iterator finite_vertices_end(); -/*! +/*! Starts at an arbitrary finite edge. */ Finite_edges_iterator finite_edges_begin(); -/*! +/*! Past-the-end iterator. */ Finite_edges_iterator finite_edges_end(); -/*! +/*! Starts at an arbitrary finite face. */ Finite_faces_iterator finite_faces_begin(); -/*! +/*! Past-the-end iterator. */ Finite_faces_iterator finite_faces_end() const; -/*! +/*! Starts at an arbitrary vertex. */ All_vertices_iterator all_vertices_begin(); -/*! +/*! Past-the-end iterator. */ All_vertices_iterator all_vertices_end(); -/*! +/*! Starts at an arbitrary edge. */ All_edges_iterator all_edges_begin(); -/*! +/*! Past-the-end iterator. */ All_edges_iterator all_edges_end(); -/*! +/*! Starts at an arbitrary face. */ All_faces_iterator all_faces_begin(); -/*! +/*! Past-the-end iterator. */ All_faces_iterator all_faces_end(); @@ -404,32 +404,32 @@ All_faces_iterator all_faces_end(); /// are all invalidated by any change in the Apollonius graph. /// @{ -/*! +/*! Starts at an arbitrary site. */ Sites_iterator sites_begin(); -/*! +/*! Past-the-end iterator. */ Sites_iterator sites_end(); -/*! +/*! Starts at an arbitrary visible site. */ Visible_sites_iterator visible_sites_begin(); -/*! +/*! Past-the-end iterator. */ Visible_sites_iterator visible_sites_end(); -/*! +/*! Starts at an arbitrary hidden site. */ Hidden_sites_iterator hidden_sites_begin(); -/*! +/*! Past-the-end iterator. */ Hidden_sites_iterator hidden_sites_end(); @@ -450,38 +450,38 @@ Hidden_sites_iterator hidden_sites_end(); /// to. /// @{ -/*! +/*! Starts at an arbitrary face incident to `v`. */ Face_circulator incident_faces(Vertex_handle v); -/*! +/*! Starts at face `f`. \pre Face `f` is incident to vertex `v`. */ Face_circulator incident_faces(Vertex_handle v, Face_handle f); -/*! +/*! Starts at an arbitrary edge incident to `v`. */ Edge_circulator incident_edges(Vertex_handle v); -/*! +/*! Starts at the first edge of `f` incident to `v`, in counterclockwise order around `v`. \pre Face `f` is incident to vertex `v`. */ Edge_circulator incident_edges(Vertex_handle v, Face_handle f); -/*! +/*! Starts at an arbitrary vertex incident to `v`. */ Vertex_circulator incident_vertices(Vertex_handle v); -/*! +/*! Starts at the first vertex of `f` adjacent to `v` in counterclockwise order around `v`. \pre Face `f` is incident to vertex `v`. @@ -495,30 +495,30 @@ Vertex_circulator incident_vertices(Vertex_handle v, Face_handle f); /// or infinite character of any feature. /// @{ -/*! +/*! `true`, iff `v` is the `infinite_vertex`. */ bool is_infinite(Vertex_handle v) const; -/*! +/*! `true`, iff face `f` is infinite. */ bool is_infinite(Face_handle f) const; -/*! +/*! `true`, iff edge `(f,i)` is infinite. */ bool is_infinite(Face_handle f, int i) const; -/*! +/*! `true`, iff edge `e` is infinite. */ bool is_infinite(Edge e) const; -/*! +/*! `true`, iff edge `*ec` is infinite. */ bool @@ -529,7 +529,7 @@ is_infinite(Edge_circulator ec) const; /// \name Insertion /// @{ -/*! +/*! Inserts the sites in the range [`first`,`beyond`). The number of sites in the range [`first`, `beyond`) is returned. @@ -538,7 +538,7 @@ Inserts the sites in the range template< class Input_iterator > unsigned int insert(Input_iterator first, Input_iterator beyond); -/*! +/*! Inserts the site `s` in the Apollonius graph. If `s` is visible then the vertex handle of `s` is returned, otherwise @@ -546,7 +546,7 @@ vertex handle of `s` is returned, otherwise */ Vertex_handle insert(Site_2 s); -/*! +/*! Inserts `s` in the Apollonius graph using the site associated with `vnear` as an estimate for the nearest neighbor of the center of `s`. If `s` is visible then the vertex handle of @@ -561,7 +561,7 @@ vnear); /// \name Removal /// @{ -/*! +/*! Removes the site associated to the vertex handle `v` from the Apollonius graph. @@ -574,7 +574,7 @@ void remove(Vertex_handle v); /// \name Nearest Neighbor Location /// @{ -/*! +/*! Finds the nearest neighbor of the point `p`. In other words it finds the site whose Apollonius cell contains `p`. Ties are broken arbitrarily and one of the nearest neighbors of `p` is @@ -583,7 +583,7 @@ returned. If there are no visible sites in the Apollonius diagram */ Vertex_handle nearest_neighbor(Point_2 p); -/*! +/*! Finds the nearest neighbor of the point `p` using the site associated with `vnear` as an estimate for the nearest neighbor of `p`. Ties are broken @@ -609,21 +609,21 @@ Vertex_handle vnear); /// finite or infinite, respectively. /// @{ -/*! +/*! Returns the dual corresponding to the face handle `f`. The returned object can be assignable to one of the following: `Site_2`, `Gt::Line_2`. */ Gt::Object_2 dual(Face_handle f) const; -/*! +/*! Returns the dual of the face to which `it` points to. The returned object can be assignable to one of the following: `Site_2`, `Gt::Line_2`. */ Gt::Object_2 dual(All_faces_iterator it) const; -/*! +/*! Returns the dual of the face to which `it` points to. The returned object can be assignable to one of the following: `Site_2`, @@ -636,7 +636,7 @@ Gt::Object_2 dual(Finite_faces_iterator it) const; /// \name I/O /// @{ -/*! +/*! Draws the Apollonius graph to the stream `str`. \pre The following operators must be defined: @@ -647,7 +647,7 @@ the stream `str`. template< class Stream > Stream& draw_primal(Stream& str); -/*! +/*! Draws the dual of the Apollonius graph, i.e., the Apollonius diagram, to the stream `str`. @@ -660,7 +660,7 @@ Apollonius graph, i.e., the Apollonius diagram, to the stream template < class Stream > Stream& draw_dual(Stream& str); -/*! +/*! Draws the edge `e` of the Apollonius graph to the stream `str`. \pre The following operators must be defined: @@ -671,7 +671,7 @@ Draws the edge template< class Stream > Stream& draw_primal_edge(Edge e, Stream& str); -/*! +/*! Draws the dual of the edge `e` to the stream `str`. The dual of `e` is an edge of the Apollonius diagram. @@ -684,7 +684,7 @@ of the Apollonius diagram. template< class Stream > Stream& draw_dual_edge(Edge e, Stream& str); -/*! +/*! Writes the current state of the Apollonius graph to an output stream. In particular, all visible and hidden sites are written as well as the @@ -692,19 +692,19 @@ underlying combinatorial data structure. */ void file_output(std::ostream& os); -/*! +/*! Reads the state of the Apollonius graph from an input stream. */ void file_input(std::istream& is); -/*! +/*! Writes the current state of the Apollonius graph to an output stream. */ std::ostream& operator<<(std::ostream& os, Apollonius_graph_2 ag); -/*! +/*! Reads the state of the Apollonius graph from an input stream. */ std::istream& operator>>(std::istream& is, @@ -715,7 +715,7 @@ Apollonius_graph_2 ag); /// \name Validity Check /// @{ -/*! +/*! Checks the validity of the Apollonius graph. If `verbose` is `true` a short message is sent to `std::cerr`. If `level` is 0, only the data structure is validated. If `level` is 1, then @@ -730,12 +730,12 @@ bool is_valid(bool verbose = false, int level = 1); /// \name Miscellaneous /// @{ -/*! +/*! Clears all contents of the Apollonius graph. */ void clear(); -/*! +/*! The Apollonius graphs `other` and `ag` are swapped. `ag`.`swap(other)` should be preferred to `ag`` = other` or to `ag``(other)` if diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h index 1e4c21ab477..8ece98dc24b 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_filtered_traits_2.h @@ -54,19 +54,19 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Apollonius_graph_filtered_traits_2(); -/*! +/*! Copy constructor. */ Apollonius_graph_filtered_traits_2 (Apollonius_graph_filtered_traits_2 other); -/*! +/*! Assignment operator. */ 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 d8579d50d7a..073d13ade6e 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 @@ -57,14 +57,14 @@ public: /// \name Creation /// @{ -/*! +/*! Creates an hierarchy of Apollonius graphs using `gt` as geometric traits. */ Apollonius_graph_hierarchy_2(Gt gt=Gt()); -/*! +/*! Creates an Apollonius graph hierarchy using `gt` as geometric traits and inserts all sites in the range [`first`, `beyond`). @@ -73,7 +73,7 @@ template< class Input_iterator > Apollonius_graph_hierarchy_2(Input_iterator first, Input_iterator beyond, Gt gt=Gt()); -/*! +/*! Copy constructor. All faces, vertices and inter-level pointers are duplicated. After the construction, `agh` and `other` refer to two different Apollonius graph hierarchies: if @@ -82,7 +82,7 @@ to two different Apollonius graph hierarchies: if Apollonius_graph_hierarchy_2 (Apollonius_graph_hierarchy_2 other); -/*! +/*! Assignment. All faces, vertices and inter-level pointers are duplicated. After the construction, `agh` and `other` refer to two different Apollonius graph hierarchies: if @@ -97,7 +97,7 @@ other); /// \name Insertion /// @{ -/*! +/*! Inserts the sites in the range [`first`,`beyond`). The number of sites in the range [`first`, `beyond`) is returned. @@ -106,7 +106,7 @@ Inserts the sites in the range template< class Input_iterator > unsigned int insert(Input_iterator first, Input_iterator beyond); -/*! +/*! Inserts the site `s` in the Apollonius graph hierarchy. If `s` is visible then the vertex handle of `s` is returned, otherwise @@ -114,7 +114,7 @@ is visible then the vertex handle of `s` is returned, otherwise */ Vertex_handle insert(Site_2 s); -/*! +/*! Inserts `s` in the Apollonius graph hierarchy using the site associated with `vnear` as an estimate for the nearest neighbor of the center of `s`. @@ -132,7 +132,7 @@ vnear); /// \name Removal /// @{ -/*! +/*! Removes the site associated to the vertex handle `v` from the Apollonius graph hierarchy. @@ -145,7 +145,7 @@ void remove(Vertex_handle v); /// \name Nearest Neighbor Location /// @{ -/*! +/*! Finds the nearest neighbor of the point `p`. In other words it finds the site whose Apollonius cell contains `p`. Ties are broken arbitrarily and one of the nearest neighbors of `p` is @@ -154,7 +154,7 @@ returned. If there are no visible sites in the Apollonius diagram */ Vertex_handle nearest_neighbor(Point p); -/*! +/*! Finds the nearest neighbor of the point `p`. If there are no visible sites in the Apollonius diagram `Vertex_handle(NULL)` is returned. @@ -171,7 +171,7 @@ Vertex_handle vnear); /// \name I/O /// @{ -/*! +/*! Writes the current state of the Apollonius graph hierarchy to an output stream. In particular, all visible and hidden sites are written as well as the @@ -179,19 +179,19 @@ underlying combinatorial hierarchical data structure. */ void file_output(std::ostream& os); -/*! +/*! Reads the state of the Apollonius graph hierarchy from an input stream. */ void file_input(std::istream& is); -/*! +/*! Writes the current state of the Apollonius graph hierarchy to an output stream. */ std::ostream& operator<<(std::ostream& os, Apollonius_graph_hierarchy_2 agh); -/*! +/*! Reads the state of the Apollonius graph hierarchy from an input stream. */ std::istream& operator>>(std::istream& is, Apollonius_graph_hierarchy_2 agh); @@ -201,7 +201,7 @@ std::istream& operator>>(std::istream& is, Apollonius_graph_hierarchy_2 /// \name Validity Check /// @{ -/*! +/*! Checks the validity of the Apollonius graph hierarchy. If `verbose` is `true` a short message is sent to `std::cerr`. If `level` is 0, the data structure at all levels @@ -219,13 +219,13 @@ bool is_valid(bool verbose = false, int level = 1) const; /// \name Miscellaneous /// @{ -/*! +/*! Clears all contents of the Apollonius graph hierarchy. */ void clear(); -/*! +/*! The Apollonius graph hierarchies `other` and `agh` are swapped. `agh`.`swap(other)` should be preferred to `agh`` = other` or to `agh``(other)` if `other` is deleted afterwards. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h index b897faacb14..d04be3c9250 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_hierarchy_vertex_base_2.h @@ -25,18 +25,18 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Apollonius_graph_hierarchy_vertex_base_2(); -/*! +/*! Constructs a vertex associated with the site `s` and embedded at the center of `s`. */ Apollonius_graph_hierarchy_vertex_base_2(Site_2 s); -/*! +/*! Constructs a vertex associated with the site `s`, embedded at the center of `s`, and pointing to the face associated with the face diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h index f2863206e2d..b351b44498a 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_traits_2.h @@ -37,17 +37,17 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Apollonius_graph_traits_2(); -/*! +/*! Copy constructor. */ Apollonius_graph_traits_2(Apollonius_graph_traits_2 other); -/*! +/*! Assignment operator. */ Apollonius_graph_traits_2 diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h index a08d0803f2e..a1ab5ac7b74 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/CGAL/Apollonius_graph_vertex_base_2.h @@ -34,18 +34,18 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Apollonius_graph_bertex_base_2(); -/*! +/*! Constructs a vertex associated with the site `s` and embedded at the center of `s`. */ Apollonius_graph_vertex_base_2(Site_2 s); -/*! +/*! Constructs a vertex associated with the site `s`, embedded at the center of `s`, and pointing to the face associated with the face 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 603f759d3ca..fe4ddc0de0d 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 @@ -36,12 +36,12 @@ public: /// \name Creation /// @{ -/*! +/*! */ Apollonius_site_2(Point_2 p=Point_2(), Weight w= Weight(0)); -/*! +/*! Copy constructor. */ Apollonius_site_2(Apollonius_site_2 other); @@ -50,7 +50,7 @@ Apollonius_site_2(Apollonius_site_2 other); }; /* end Apollonius_site_2 */ -/*! +/*! Inserts the Apollonius site `s` into the stream `os`. \note Included through `CGAL/IO/Qt_widget_Apollonius_site_2.h`. @@ -60,7 +60,7 @@ Apollonius site `s` into the stream `os`. std::ostream& operator<<(std::ostream& os, const Apollonius_site_2& s); -/*! +/*! Reads an Apollonius site from the stream `is` and assigns it to `s`. \note Included through `CGAL/IO/Qt_widget_Apollonius_site_2.h`. @@ -70,7 +70,7 @@ to `s`. std::istream& operator>>(std::istream& is, const Apollonius_site_2& s); -/*! +/*! Inserts the Apollonius site `s` into the `Qt_widget` stream `w`. \note Included through `CGAL/IO/Qt_widget_Apollonius_site_2.h`. \pre The insert operator must be defined for `K::Circle_2`. diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h index a49c37eff3e..c6d622d4e81 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphDataStructure_2.h @@ -40,7 +40,7 @@ public: /// \name Insertion /// @{ -/*! +/*! Inserts a degree two vertex and two faces adjacent to it that have two common edges. The edge defined by the face handle `f` and the integer @@ -53,7 +53,7 @@ Vertex_handle insert_degree_2(Face_handle f, int i); /// \name Removal /// @{ -/*! +/*! Removes a degree 2 vertex and the two faces adjacent to it. The two edges of the star of `v` that are not incident to it are collapsed. 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 930f79c7beb..15444778196 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 @@ -36,19 +36,19 @@ public: /// \name Creation /// @{ -/*! +/*! Default constructor. */ ApolloniusGraphHierarchyVertexBase_2(); -/*! +/*! Constructs a vertex associated with the site `s` and embedded at the center of `s`. */ ApolloniusGraphHierarchyVertexBase_2(Site_2 s).; -/*! +/*! Constructs a vertex associated with the site `s`, embedded at the center of `s`, and pointing to face `f`. @@ -60,26 +60,26 @@ ApolloniusGraphHierarchyVertexBase_2(Site_2 s, Face_handle f).; /// \name Operations /// @{ -/*! +/*! Returns a handle to the corresponding vertex of the next level Apollonius graph. If such a vertex does not exist `Vertex_handle(NULL)` is returned. */ Vertex_handle up(); -/*! +/*! Returns a handle to the corresponding vertex of the previous level Apollonius graph. */ Vertex_handle down(); -/*! +/*! Sets the handle for the vertex of the next level Apollonius graph. */ void set_up(Vertex_handle u); -/*! +/*! Sets the handle for the vertex of the previous level Apollonius graph; */ diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h index d4ede517853..9f88a02b231 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphTraits_2.h @@ -25,56 +25,56 @@ public: /// \name Types /// @{ -/*! +/*! A type for a point. */ typedef unspecified_type Point_2; -/*! +/*! A type for an Apollonius site. Must be a model of the concept `ApolloniusSite_2`. */ typedef unspecified_type Site_2; -/*! +/*! A type for a line. Only required if access to the dual of the Apollonius graph is required or if the primal or dual diagram are inserted in a stream. */ typedef unspecified_type Line_2; -/*! +/*! A type for a ray. Only required if access to the dual of the Apollonius graph is required or if the primal or dual diagram are inserted in a stream. */ typedef unspecified_type Ray_2; -/*! +/*! A type for a segment. Only required if access to the dual of the Apollonius graph is required or if the primal or dual diagram are inserted in a stream. */ typedef unspecified_type Segment_2; -/*! +/*! A type representing different types of objects in two dimensions, namely: `Point_2`, `Site_2`, `Line_2`, `Ray_2` and `Segment_2`. */ typedef unspecified_type Object_2; -/*! +/*! A type for the field number type of sites. */ typedef unspecified_type FT; -/*! +/*! A type for the ring number type of sites. */ typedef unspecified_type RT; -/*! +/*! Must provide `template bool operator() ( T& t, Object_2 o)` which assigns `o` to `t` if `o` was constructed from an object of type `T`. Returns @@ -82,14 +82,14 @@ constructed from an object of type `T`. Returns */ typedef unspecified_type Assign_2; -/*! +/*! Must provide `template Object_2 operator()( T t)` that constructs an object of type `Object_2` that contains `t` and returns it. */ typedef unspecified_type Construct_object_2; -/*! +/*! A constructor for a point of the Apollonius diagram equidistant from three sites. Must provide @@ -100,7 +100,7 @@ constructs a point equidistant from the sites `s1`, `s2` and */ typedef unspecified_type Construct_Apollonius_vertex_2; -/*! +/*! A constructor for a dual Apollonius site (a site whose center is a vertex of the Apollonius diagram and its weight is the common @@ -120,7 +120,7 @@ and its weight is infinite. */ typedef unspecified_type Construct_Apollonius_site_2; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()(Site_2 s1, Site_2 s2)`, which compares the \f$ x\f$-coordinates of the centers of @@ -128,7 +128,7 @@ Site_2 s2)`, which compares the \f$ x\f$-coordinates of the centers of */ typedef unspecified_type Compare_x_2; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()(Site_2 s1, Site_2 s2)`, which compares the \f$ y\f$-coordinates of the centers of @@ -136,7 +136,7 @@ Site_2 s2)`, which compares the \f$ y\f$-coordinates of the centers of */ typedef unspecified_type Compare_y_2; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()(Site_2 s1, Site_2 s2)`, which compares the weights of `s1` @@ -144,7 +144,7 @@ and `s2`. */ typedef unspecified_type Compare_weight_2; -/*! +/*! A predicate object type. Must provide `Orientation operator()(Site_2 s1, Site_2 s2, Site_2 s3)`, which performs the @@ -160,7 +160,7 @@ which performs the usual orientation test for the Apollonius vertex of */ typedef unspecified_type Orientation_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2)`, which returns `true` if the circle @@ -169,7 +169,7 @@ corresponding to `s1`, `false` otherwise. */ typedef unspecified_type Is_hidden_2; -/*! +/*! A predicate object type. Must provide `Oriented_side operator()(Site_2 s1, Site_2 s2, Point_2 p)`, which returns @@ -182,7 +182,7 @@ lies on the bisector of `s1` and `s2`. */ typedef unspecified_type Oriented_side_of_bisector_2; -/*! +/*! A predicate object type. Must provide `Sign operator()(Site_2 s1, Site_2 s2, Site_2 s3, Site_2 q)`, which @@ -197,7 +197,7 @@ dual Apollonius site, with its center at infinity). */ typedef unspecified_type Vertex_conflict_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2, Site_2 s3, Site_2 s4, Site_2 q, bool b)`. The sites `s1`, `s2`, `s3` and `s4` define an Apollonius edge that lies on the @@ -248,7 +248,7 @@ Apollonius edge. */ typedef unspecified_type Finite_edge_interior_conflict_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2, Site_2 s3, Site_2 q, bool b)`. The @@ -267,7 +267,7 @@ Apollonius edge. */ typedef unspecified_type Infinite_edge_interior_conflict_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2, Site_2 s3, Site_2 s4)`. It returns `true` if @@ -283,17 +283,17 @@ typedef unspecified_type Is_degenerate_edge_2; /// \name Creation /// @{ -/*! +/*! Default constructor. */ ApolloniusGraphTraits_2(); -/*! +/*! Copy constructor. */ ApolloniusGraphTraits_2(ApolloniusGraphTraits_2 other); -/*! +/*! Assignment operator. */ ApolloniusGraphTraits_2 operator=(ApolloniusGraphTraits_2 other); @@ -303,55 +303,55 @@ ApolloniusGraphTraits_2 operator=(ApolloniusGraphTraits_2 other); /// \name Access to predicate objects /// @{ -/*! +/*! */ Compare_x_2 compare_x_2_object(); -/*! +/*! */ Compare_y_2 compare_y_2_object(); -/*! +/*! */ Compare_weight_2 compare_weight_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); -/*! +/*! */ Is_hidden_2 is_hidden_2_object(); -/*! +/*! */ Oriented_side_of_bisector_2 oriented_side_of_bisector_test_2_object(); -/*! +/*! */ Vertex_conflict_2 vertex_conflict_2_object(); -/*! +/*! */ Finite_edge_interior_conflict_2 finite_edge_interior_conflict_2_object(); -/*! +/*! */ Infinite_edge_interior_conflict_2 infinite_edge_interior_conflict_2_object(); -/*! +/*! */ Is_degenerate_edge_2 is_degenerate_edge_2_object(); @@ -361,19 +361,19 @@ Is_degenerate_edge_2 is_degenerate_edge_2_object(); /// \name Access to constructor objects /// @{ -/*! +/*! */ Construct_object_2 construct_object_2_object(); -/*! +/*! */ Construct_Apollonius_vertex_2 construct_Apollonius_vertex_2_object(); -/*! +/*! */ Construct_Apollonius_site_2 @@ -384,7 +384,7 @@ construct_Apollonius_site_2_object(); /// \name Access to other objects /// @{ -/*! +/*! */ Assign_2 assign_2_object(); diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h index 3ec63794b53..2d840929568 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusGraphVertexBase_2.h @@ -24,44 +24,44 @@ public: /// \name Types /// @{ -/*! +/*! A type for the geometric traits that defines the site stored. \pre The type `Geom_traits` must define the type `Site_2`. */ typedef unspecified_type Geom_traits; -/*! +/*! A Boolean that indicates if hidden sites are actually stored or not. Its value is `true` if hidden sites are stored, `false` otherwise. */ typedef unspecified_type Store_hidden; -/*! +/*! A type for the site stored. \pre This type must coincide with the type `Geom_traits::Site_2`. */ typedef unspecified_type Site_2; -/*! +/*! A type for the Apollonius graph data structure, to which the vertex belongs to. */ typedef unspecified_type Apollonius_graph_data_structure_2; -/*! +/*! A type for the vertex handle of the Apollonius graph data structure. */ typedef unspecified_type Vertex_handle; -/*! +/*! A type for the face handle of the Apollonius graph data structure. */ typedef unspecified_type Face_handle; -/*! +/*! An iterator that iterates over the hidden sites in the hidden sites container of the vertex. @@ -74,18 +74,18 @@ typedef unspecified_type Hidden_sites_iterator; /// \name Creation /// @{ -/*! +/*! Default constructor. */ ApolloniusGraphVertexBase_2(); -/*! +/*! Constructs a vertex associated with the Apollonius site `s` and embedded at the center of `s`. */ ApolloniusGraphVertexBase_2(Site_2 s); -/*! +/*! Constructs a vertex associated with the site `s`, embedded at the center of `s`, and pointing to the face associated with the face handle `f`. @@ -98,29 +98,29 @@ Face_handle f); /// \name Access Functions /// @{ -/*! +/*! Returns the Apollonius site. */ Site_2 site(); -/*! +/*! Returns a handle to an incident face. */ Face_handle face(); -/*! +/*! Returns the number of hidden sites in the hidden sites container. */ unsigned int number_of_hidden_sites(); -/*! +/*! Starts at an arbitrary hidden site. */ Hidden_sites_iterator hidden_sites_begin(); -/*! +/*! Past-the-end iterator. */ Hidden_sites_iterator hidden_sites_end(); @@ -130,22 +130,22 @@ Hidden_sites_iterator hidden_sites_end(); /// \name Setting and unsetting /// @{ -/*! +/*! Sets the Apollonius site. */ void set_site(Site_2 s); -/*! +/*! Sets the incident face. */ void set_face(Face_handle f); -/*! +/*! Adds a hidden site to the container of hidden sites. */ void add_hidden_site(Site_2 s); -/*! +/*! Clears the container of hidden sites. */ void clear_hidden_sites_container(); @@ -155,7 +155,7 @@ void clear_hidden_sites_container(); /// \name Checking /// @{ -/*! +/*! Performs any required tests on a vertex. */ bool is_valid(bool verbose, int level) const; diff --git a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h index 4bc9d68845c..ee5b64bc667 100644 --- a/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h +++ b/Apollonius_graph_2/doc/Apollonius_graph_2/Concepts/ApolloniusSite_2.h @@ -19,22 +19,22 @@ public: /// \name Types /// @{ -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The field number type. */ typedef unspecified_type FT; -/*! +/*! The ring number type. */ typedef unspecified_type RT; -/*! +/*! The weight type. \pre It must be the same as `FT`. */ @@ -45,12 +45,12 @@ typedef unspecified_type Weight; /// \name Creation /// @{ -/*! +/*! */ ApolloniusSite2(Point_2 p=Point_2(), Weight w= Weight(0)); -/*! +/*! Copy constructor. */ ApolloniusSite_2(ApolloniusSite_2 other); @@ -60,13 +60,13 @@ ApolloniusSite_2(ApolloniusSite_2 other); /// \name Access Functions /// @{ -/*! +/*! Returns the center of the Apollonius site. */ Point_2 point() const; -/*! +/*! Returns the weight of the Apollonius site. */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h index e7c74c015ef..d43afebcfbc 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_Bezier_curve_traits_2.h @@ -64,13 +64,13 @@ public: /// \name Types /// @{ -/*! +/*! the `NtTraits::Rational` type (and also the `RatKernel::FT` type). */ typedef unspecified_type Rational; -/*! +/*! the `NtTraits::Algebraic` type (and also the `AlgKernel::FT` type). */ @@ -96,12 +96,12 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Curve_2 (); -/*! +/*! constructs a Bézier curve as defined by the given range of control points. The value-type of `InputIterator` is `RatKernel::Point_2`. \pre The input range must contain at least two control points. @@ -115,12 +115,12 @@ Curve_2 (InputIterator pts_begin, InputIterator pts_end); /// \name Access Functions /// @{ -/*! +/*! returns the number of control points that define `B`. */ size_t number_of_control_points () const; -/*! +/*! returns the \f$ k\f$th control point. Note that the first control point equals the curve source, while the last control point equals its target. The rest of the control points do not lie on the curve. @@ -128,13 +128,13 @@ of the control points do not lie on the curve. */ typename RatKernel::Point_2 control_point (size_t k) const; -/*! +/*! returns the point \f$ B(t)\f$ on the curve that corresponds to the given rational parameter value. */ typename RatKernel::Point_2 operator() (const Rational& t) const; -/*! +/*! returns the point \f$ B(t)\f$ on the curve that corresponds to the given algebraic parameter value. */ @@ -167,18 +167,18 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Point_2 (); -/*! +/*! constructs the point \f$ B(t_0)\f$ on the given curve. As \f$ t_0\f$ is an algebraic number, the point has algebraic coordinates. */ Point_2 (const Curve_2& B, const Algebraic& t_0); -/*! +/*! constructs the point \f$ B(t_0)\f$ on the given curve. As \f$ t_0\f$ is a rational number, the point has rational coordinates. */ @@ -189,34 +189,34 @@ Point_2 (const Curve_2& B, const Rational& t_0); /// \name Access Functions /// @{ -/*! +/*! returns the approximated coordinates of `p`. */ std::pair approximate () const; -/*! +/*! returns whether the coordinates of `p` are computed in an exact manner. */ bool is_exact () const; -/*! +/*! returns the \f$ x\f$-coordinate of `p`. \pre `p` is exactly computed. */ Algebraic x () const; -/*! +/*! returns the \f$ y\f$-coordinate of `p`. \pre `p` is exactly computed. */ Algebraic y () const; -/*! +/*! returns whether the coordinates of `p` are rational numbers. */ bool is_rational () const; -/*! +/*! casts `p` to a point with rational coordinates. \pre `p` has rational coordinates. */ @@ -248,32 +248,32 @@ public: /// \name Access Functions /// @{ -/*! +/*! returns the supporting Bézier curve of `b`. */ Curve_2 supporting_curve () const; -/*! +/*! returns the source point of `b`. */ Point_2 source () const; -/*! +/*! returns the target point of `b`. */ Point_2 target () const; -/*! +/*! returns the left (\f$ xy\f$-lexicographically smaller) endpoint of `b`. */ Point_2 left () const; -/*! +/*! returns the right (\f$ xy\f$-lexicographically smaller) endpoint of `b`. */ Point_2 right () const; -/*! +/*! return the approximate parameter range defining the subcurve `b`. */ std::pair parameter_range () const; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h index 82ea833b74e..dca400a71f3 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_accessor.h @@ -25,37 +25,37 @@ public: /// \name Types /// @{ -/*! +/*! the type of the associated arrangement. */ typedef unspecified_type Arrangement_2; -/*! +/*! the point type. */ typedef typename Arrangement_2::Point_2 Point_2; -/*! +/*! the \f$ x\f$-monotone curve type. */ typedef typename Arrangement_2::X_monotone_curve_2 X_monotone_curve_2; -/*! +/*! */ typedef typename Arrangement_2::Vertex_handle Vertex_handle; -/*! +/*! */ typedef typename Arrangement_2::Halfedge_handle Halfedge_handle; -/*! +/*! */ typedef typename Arrangement_2::Face_handle Face_handle; -/*! +/*! represents the boundary of a connected component (CCB). */ typedef typename Arrangement_2::Ccb_halfedge_circulator Ccb_halfedge_circulator; @@ -65,7 +65,7 @@ typedef typename Arrangement_2::Ccb_halfedge_circulator Ccb_halfedge_circulator; /// \name Creation /// @{ -/*! +/*! constructs an accessor attached to the given arrangement `arr`. */ @@ -77,14 +77,14 @@ Arr_accessor(Arrangement_2& arr); /// @{ -/*! +/*! notifies the arrangement observer that a global change is going to take place (for the usage of the global functions that operate on arrangements). */ void notify_before_global_change (); -/*! +/*! notifies the arrangement observer that a global change has taken place (for the usage of the global functions that operate on arrangements). @@ -96,7 +96,7 @@ void notify_after_global_change (); /// \name Arrangement Predicates /// @{ -/*! +/*! locates a place for the curve `c` around the vertex `v` and returns a halfedge whose target is `v`, where c should be inserted between this halfedge and the next halfedge around `v` @@ -106,7 +106,7 @@ Halfedge_handle locate_around_vertex (Vertex_handle v, const X_monotone_curve_2& c) const; -/*! +/*! counts the number of edges along the path from `e1` to `e2`. In case the two halfedges do not belong to the same connected component, the function returns (-1). @@ -114,7 +114,7 @@ the function returns (-1). int halfedge_distance (Halfedge_const_handle e1, Halfedge_const_handle e2) const; -/*! +/*! determines whether a new halfedge we are about to create, which is to be associated with the curve `c` and directed from `pred1->target()` to `pred2->target()`, lies on the inner CCB of the new face that will be created, @@ -126,7 +126,7 @@ bool is_inside_new_face (Halfedge_handle pred1, Halfedge_handle pred2, const X_monotone_curve_2& c) const; -/*! +/*! determines whether a given point lies within the region bounded by a boundary of the connected component that `he` belongs to. Note that if the function returns `true`, then `p` is contained within @@ -136,13 +136,13 @@ face, or it may coincide with an isolated vertex in this face. bool point_is_in (const Point_2& p, Halfedge_const_handle he) const; -/*! +/*! determines whether `he` lies on the outer boundary of its incident face. */ bool is_on_outer_boundary (Halfedge_const_handle he) const; -/*! +/*! determines whether `he` lies on the inner boundary of its incident face (that is, whether it lies on the boundary of one of the holes in this face). @@ -154,14 +154,14 @@ bool is_on_inner_boundary (Halfedge_const_handle he) const; /// \name Arrangement Modifiers /// @{ -/*! +/*! creates a new vertex an associates it with the point `p`. It is the user's responsibility that there is no existing vertex already associated with `p`. */ Vertex_handle create_vertex (const Point_2& p); -/*! +/*! inserts the curve `c` as a new hole (inner component) of the face `f`, connecting the two isolated vertices `v1` and `v2`. `res` is the comparison result between these two end-vertices. @@ -175,7 +175,7 @@ Vertex_handle v1, Vertex_handle v2, Comparison_result res); -/*! +/*! inserts the curve `c` into the arrangement, such that one of its endpoints corresponds to an arrangement, which is the target vertex of the halfedge `pred`, such that `c` is inserted @@ -192,7 +192,7 @@ Halfedge_handle pred, Vertex_handle v, Comparison_result res); -/*! +/*! inserts the curve `c` into the arrangement, such that both `c`'s endpoints correspond to existing arrangement vertices, given by `pred1->target()` and `pred2->target()`. `res` is the comparison @@ -211,13 +211,13 @@ Halfedge_handle pred2, Comparison_result res, bool& new_face); -/*! +/*! inserts `v` as an isolated vertex inside `f`. \pre It is the user's responsibility that `v->point()` is contained in the interior of the given face. */ void insert_isolated_vertex (Face_handle f, Vertex_handle v); -/*! +/*! moves the given hole from the interior of the face `f1` inside the face `f2`. \pre It is the user's responsibility that `hole` is currently contained in `f1` and should be moved to `f2`. @@ -225,7 +225,7 @@ face `f2`. void move_hole (Face_handle f1, Face_handle f2, Ccb_halfedge_circulator hole); -/*! +/*! moves the given isolated vertex from the interior of the face `f1` inside the face `f2`. \pre It is the user's responsibility that `v` is indeed an isolated vertex currently contained in `f1` and should be moved to `f2`. @@ -233,7 +233,7 @@ inside the face `f2`. bool move_isolated_vertex (Face_handle f1, Face_handle f2, Vertex_handle v); -/*! +/*! relocates all holes and isolated vertices to their proper position immediately after a face has split due to the insertion of a new halfedge, namely after `insert_at_vertices_ex()` was invoked and indicated that @@ -244,17 +244,17 @@ such that `he->twin()->face` is the face that has just been split and */ void relocate_in_new_face (Halfedge_handle he); -/*! +/*! relocates all holes in a new face, as detailed above. */ void relocate_holes_in_new_face (Halfedge_handle he); -/*! +/*! relocates all isolated vertices in a new face, as detailed above. */ void relocate_isolated_vertices_in_new_face (Halfedge_handle he); -/*! +/*! modifies the point associated with the vertex `v` (the point may be geometrically different than the one currently associated with `v`). The function returns a handle to the modified vertex (same as `v`). @@ -263,7 +263,7 @@ The function returns a handle to the modified vertex (same as `v`). Vertex_handle modify_vertex_ex (Vertex_handle v, const Point_2& p); -/*! +/*! modifies the \f$ x\f$-monotone curve associated with the edge `e` (the curve `c` may be geometrically different than the one currently associated with `e`). @@ -273,7 +273,7 @@ The function returns a handle to the modified edge (same as `e`). Halfedge_handle modify_edge_ex (Halfedge_handle e, const X_monotone_curve_2& c); -/*! +/*! splits a given edge into two at the split point `p`, and associate the x-monotone curves `c1` and `c2` with the resulting edges, such that `c1` connects `he->source()` with `p` and `c2` connects @@ -286,7 +286,7 @@ const Point_2& p, const X_monotone_curve_2& c1, const X_monotone_curve_2& c2); -/*! +/*! splits a given edge into two at by the vertex `v`, and associate the x-monotone curves `c1` and `c2` with the resulting edges, such that `c1` connects `he->source()` with `v` and `c2` connects @@ -299,7 +299,7 @@ Vertex_handle v, const X_monotone_curve_2& c1, const X_monotone_curve_2& c2); -/*! +/*! removes the edge `he` from the arrangement, such that if the edge removal causes the creation of a new hole, `he->target()` lies on the boundary of this hole. The flags `remove_source` and `remove_target` indicate whether the end-vertices diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h index de577fc9d52..125252aebcc 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_algebraic_segment_traits_2.h @@ -33,14 +33,14 @@ public: /// \name Types /// @{ -/*! +/*! Value to specify whether a point should be in the interior of a segment, or its minimal point, or its maximal point in lexicographic order. */ enum Site_of_point { POINT_IN_INTERIOR = 0, MIN_ENDPOINT = -1, MAX_ENDPOINT = 1 }; -/*! +/*! the type for bivariate polynomials, with innermost coefficient type `Coefficient`. Constitutes a model of the concept `Polynomial_d` @@ -50,19 +50,19 @@ with two variables. */ typedef unspecified_type Polynomial_2; -/*! +/*! model for the concept `AlgebraicKernel_1` */ typedef unspecified_type Algebraic_kernel_1; -/*! +/*! represents coordinates of points. Typedef from `Algebraic_kernel_1::Algebraic_real_1` */ typedef unspecified_type Algebraic_real_1; -/*! +/*! Typedef from `Algebraic_kernel_1::Bound` */ typedef unspecified_type Bound; @@ -72,17 +72,17 @@ typedef unspecified_type Bound; /// \name Accessing functor objects /// @{ -/*! +/*! */ Construct_curve_2 construct_curve_2_object() const; -/*! +/*! */ Construct_point_2 construct_point_2_object() const; -/*! +/*! */ Construct_x_monotone_segment_2 construct_x_monotone_segment_2_object() const; @@ -99,13 +99,13 @@ public: /// \name Object Creation Functors /// @{ -/*! +/*! Returns a `Curve_2` object that represents the curve defined by the polynomial `p` */ Curve_2 operator() (Polynomial_2 p); -/*! +/*! Returns a `Curve_2` object specified by `s`. The passed string represents the defining polynomial of the curve and must be given in a MAPLE-readable format using "x" as first @@ -130,7 +130,7 @@ public: /// \name Object Creation Functors /// @{ -/*! +/*! Returns a `Point_2` object that represents the `arcno`-th point in the fiber of `cv` at \f$ x\f$-coordinate `x`, counted from the bottom, starting with zero. @@ -140,29 +140,29 @@ in the fiber of `cv` at `x`.) */ Point_2 operator() (Algebraic_real_1 x, Curve_2 cv, int arcno); -/*! +/*! Returns a `Point_2` object that represents the point on `xcv` at \f$ x\f$-coordinate `x` \pre (`x` is in the \f$ x\f$-range of `xcv`.) */ Point_2 operator() (Algebraic_real_1 x, X_monotone_curve_2 xcv); -/*! +/*! Returns a `Point_2` object that represents (x,y) */ Point_2 operator() (Algebraic_real_1 x, Algebraic_real_1 y); -/*! +/*! Returns a `Point_2` object that represents (x,y) */ Point_2 operator() (Coefficient x, Coefficient y); -/*! +/*! Returns a `Point_2` object that represents (x,y) */ Point_2 operator() (Bound x, Bound y); -/*! +/*! Returns a `Point_2` object that represents (x,y) */ Point_2 operator() (int x, int y); @@ -181,7 +181,7 @@ public: /// \name Object Creation Functors /// @{ -/*! +/*! Writes a sequence of `X_monotone_curve_2` objects (terminal segments) into `out`. These terminal segments compose an \f$ x\f$-monotone (or vertical) segment of the curve `cv` that @@ -196,7 +196,7 @@ template OutputIterator operator() (Curve_2 cv, Point_2 end_min, Point_2 end_max, OutputIterator out); -/*! +/*! Writes a sequence of `X_monotone_curve_2` objects into `out`. These segments form an \f$ x\f$-monotone (or vertical) segment of the curve `cv`. @@ -220,7 +220,7 @@ operator() (Curve_2 cv, Point_2 p, Site_of_point site_of_p, OutputIterator out); -/*! +/*! Writes a sequence of `X_monotone_curve_2` objects into `out`. These segments form a straight-line segment connecting the points `p` and `q`. If `p` and `q` share the @@ -256,7 +256,7 @@ public: /// \name Modifiers /// @{ -/*! +/*! returns the defining polynomial of the curve. */ Polynomial_2 polynomial () const; @@ -295,12 +295,12 @@ public: /// \name Modifiers /// @{ -/*! +/*! returns the \f$ x\f$-coordinate of `p`. */ Algebraic_real_1 x () const; -/*! +/*! returns the \f$ y\f$-coordinates of `p`. Attention: As described above, points are not stored @@ -311,17 +311,17 @@ recommended to avoid to call this function as much as possible. */ Algebraic_real_1 y () const; -/*! +/*! returns a `Curve_2` instance that `p`is part of. */ Curve_2 curve () const; -/*! +/*! returns the arc number of `p`. */ int arcno () const; -/*! +/*! returns double-approximations of the \f$ x\f$- and \f$ y\f$-coordinates. */ std::pair to_double () const; @@ -359,33 +359,33 @@ public: /// \name Modifiers /// @{ -/*! +/*! returns the supporting algebraic curve of `s`. */ Curve_2 curve () const; -/*! +/*! returns whether `s` is a vertical segment. */ bool is_vertical () const; -/*! +/*! returns whether `s` has a finite endpoint on the left */ bool is_finite (CGAL::Arr_curve_end ce) const; -/*! +/*! \pre (The corresponding curve end is finite) */ Point_2 curve_end (CGAL::Arr_curve_end ce) const; -/*! +/*! returns the arc number of the segment. \pre (The segment is non-vertical) */ int arcno () const; -/*! +/*! returns the \f$ x\f$-coordinate of a vertical segment. \pre (The segment is vertical) */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h index 0322cd0d924..0586694fadd 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_circle_segment_traits_2.h @@ -44,7 +44,7 @@ template< typename Kernel > class Arr_circle_segment_traits_2 { public: -/*! +/*! The `Curve_2` class nested within the traits class can represent arbitrary circular arcs, full circles and line segments and support their construction in various ways. @@ -59,19 +59,19 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an curve corresponding to the line segment `seg`. */ Curve_2 (const typename Kernel::Segment_2& seg); -/*! +/*! constructs an curve corresponding to the line segment directed from `source` to `target`, both having rational coordinates. */ Curve_2 (const typename Kernel::Point_2& source, const typename Kernel::Point_2& target); -/*! +/*! constructs an curve corresponding to the line segment supported by the given line, directed from `source` to `target`. Note that the two endpoints may have one-root coordinates. @@ -81,14 +81,14 @@ Curve_2 (const typename Kernel::Line_2& line, const Point_2& source, const Point_2& target); -/*! +/*! constructs an curve corresponding to the given circle. `circ` has a center point with rational coordinates and its squared radius is rational. */ Curve_2 (const typename Kernel::Circle_2& circ); -/*! +/*! constructs an curve corresponding to a circle centered at the rational point `c` whose radius `r` is rational. */ @@ -96,7 +96,7 @@ Curve_2 (const typename Kernel::Point_2& c, const typename Kernel::FT& r, Orientation orient = COUNTERCLOCKWISE); -/*! +/*! constructs a circular arc supported by `circ`, which has a center point with rational coordinates and whose squared radius is rational, with the given endpoints. The orientation of the @@ -106,7 +106,7 @@ arc is the same as the orientation of `circ`. Curve_2 (const typename Kernel::Circle_2& circ, const Point_2& source, const Point_2& target); -/*! +/*! constructs a circular arc supported by a circle centered at the rational point `c` whose radius `r` is rational, directed from `source` to `target` with the given orientation. @@ -117,7 +117,7 @@ const typename Kernel::FT& r, Orientation orient, const Point_2& source, const Point_2& target); -/*! +/*! constructs an circular arc whose endpoints are `source` and `target` that passes through `mid`. All three points have rational coordinates. @@ -132,46 +132,46 @@ const typename Kernel::Point_2& target); /// \name Access Functions /// @{ -/*! +/*! indicates whether the curve represents a full circle. */ bool is_full() const; -/*! +/*! returns the source point. \pre `cv` is not a full circle. */ const Point_2& source() const; -/*! +/*! returns the target point. \pre `cv` is not a full circle. */ const Point_2& target() const; -/*! +/*! returns the orientation of the curve (`COLLINEAR` in case of line segments). */ Orientation orientation() const; -/*! +/*! determines whether `cv` is a line segment. */ bool is_linear () const; -/*! +/*! determines whether `cv` is a circular arc. */ bool is_circular () const; -/*! +/*! returns the supporting line of `cv`. \pre `cv` is a line segment. */ typename Kernel::Line_2 supporting_line() const; -/*! +/*! returns the supporting circle of `cv`. \pre `cv` is a circular arc. */ @@ -194,12 +194,12 @@ public: /// \name Types /// @{ -/*! +/*! the `Kernel::FT` type. */ typedef unspecified_type Rational; -/*! +/*! the algebraic number-type. */ typedef unspecified_type CoordNT; @@ -209,17 +209,17 @@ typedef unspecified_type CoordNT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Point_2 (); -/*! +/*! creates the point \f$ (x,y)\f$. */ Point_2 (const Rational& x, const Rational& y); -/*! +/*! creates the point \f$ (x,y)\f$. */ Point_2 (const CoordNT& x, const CoordNT& y); @@ -229,12 +229,12 @@ Point_2 (const CoordNT& x, const CoordNT& y); /// \name Access Functions /// @{ -/*! +/*! returns the \f$ x\f$-coordinate. */ CoordNT x () const; -/*! +/*! returns the \f$ y\f$-coordinate. */ CoordNT y () const; @@ -258,14 +258,14 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an curve corresponding to the line segment directed from `source` to `target`, both having rational coordinates. */ X_monotone_curve_2 (const typename Kernel::Point_2& source, const typename Kernel::Point_2& target); -/*! +/*! constructs an curve corresponding to the line segment supported by the given line, directed from `source` to `target`. Note that the two endpoints may have one-root coordinates. @@ -275,7 +275,7 @@ X_monotone_curve_2 (const typename Kernel::Line_2& line, const Point_2& source, const Point_2& target); -/*! +/*! constructs a circular arc supported by `circ`, which has a center point with rational coordinates and whose squared radius is rational, with the given endpoints. The orientation of the @@ -292,60 +292,60 @@ Orientation orient); /// \name Access Functions /// @{ -/*! +/*! returns the source point of `xcv`. */ const Point_2& source() const; -/*! +/*! returns the target point of `xcv`. */ const Point_2& target() const; -/*! +/*! returns true if `xcv` is directed right, false otherwise. */ bool is_directed_right () const; -/*! +/*! returns the left (lexicographically smaller) endpoint of `xcv`. */ const Point_2& left() const; -/*! +/*! returns the right (lexicographically larger) endpoint of `xcv`. */ const Point_2& right() const; -/*! +/*! returns the orientation of the curve (`COLLINEAR` in case of line segments). */ Orientation orientation() const; -/*! +/*! determines whether `xcv` is a line segment. */ bool is_linear () const; -/*! +/*! determines whether `xcv` is a circular arc. */ bool is_circular () const; -/*! +/*! returns the supporting line of `xcv`. \pre `xcv` is a line segment. */ typename Kernel::Line_2 supporting_line() const; -/*! +/*! returns the supporting circle of `xcv`. \pre `xcv` is a circular arc. */ typename Kernel::Circle_2 supporting_circle() const; -/*! +/*! returns a bounding box of the arc `xcv`. */ Bbox_2 bbox() const; 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 3d89eddf098..c6b268bd8c2 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 @@ -88,13 +88,13 @@ public: /// \name Types /// @{ -/*! +/*! the `NtTraits::Rational` type (and also the `RatKernel::FT` type). */ typedef unspecified_type Rational; -/*! +/*! the `NtTraits::Algebraic` type (and also the `AlgKernel::FT` type). */ @@ -120,19 +120,19 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an arc corresponding to the line segment `seg`. */ Curve_2 (const typename RatKernel::Segment_2& seg); -/*! +/*! constructs an arc corresponding to the full circle `circ` (note that this circle has a center point with rational coordinates and rational squared radius). */ Curve_2 (const typename RatKernel::Circle_2& circ); -/*! +/*! constructs a circular arc supported by the circle `circ`, going in the given orientation `o` from the source point `ps` to its target point `pt`. @@ -144,7 +144,7 @@ Orientation o, const Point_2& ps, const Point_2& pt); -/*! +/*! constructs a circular arc going from `p1` (its source point) through `p2` to `p3` (its target point). Note that all three points have rational coordinates. The orientation of the arc is @@ -155,7 +155,7 @@ Curve_2 (const typename RatKernel::Point_2& p1, const typename RatKernel::Point_2& p2, const typename RatKernel::Point_2& p3); -/*! +/*! constructs a conic arc that corresponds to the full conic curve \f$ r x^2 + s y^2 + t x y + u x + v y + w = 0\f$. \pre As a conic arc must be bounded, the given curve must be an ellipse, that is \f$ 4 r s - t^2 > 0\f$. @@ -164,7 +164,7 @@ Curve_2 (const Rational& r, const Rational& s, const Rational& t, const Rational& u, const Rational& v, const Rational& w); -/*! +/*! constructs a conic arc supported by the conic curve \f$ r x^2 + s y^2 + t x y + u x + v y + w = 0\f$, going in the given orientation `o` from the source point `ps` to @@ -179,7 +179,7 @@ Orientation o, const Point_2& ps, const Point_2& pt); -/*! +/*! constructs a conic arc going from `p1` (its source point) through `p2`, `p3` and `p4` (in this order) to `p5` (its target point). Note that all five points have rational coordinates. @@ -193,7 +193,7 @@ const typename RatKernel::Point_2& p3, const typename RatKernel::Point_2& p4, const typename RatKernel::Point_2& p5); -/*! +/*! constructs a conic arc supported by the conic curve \f$ r x^2 + s y^2 + t x y + u x + v y + w = 0\f$, going in the given orientation `o` from its source point to its target @@ -225,7 +225,7 @@ const Rational& v2, const Rational& w2); /// @{ -/*! +/*! indicates whether `a` is a valid conic arc. As the precondition to some of the constructor listed above are quite complicated, their violation does not cause the program to abort. Instead, the constructed @@ -236,21 +236,21 @@ program to abort. */ bool is_valid() const; -/*! +/*! determines whether the arc is \f$ x\f$-monotone, namely each vertical line intersects it at most once. A vertical line segment is also considered (weakly) \f$ x\f$-monotone. */ bool is_x_monotone() const; -/*! +/*! determines whether the arc is \f$ y\f$-monotone, namely each horizontal line intersects it at most once. A horizontal line segment is also considered (weakly) \f$ x\f$-monotone. */ bool is_y_monotone() const; -/*! +/*! indicates whether the arc represents a full conic curve (en ellipse or a circle). */ @@ -264,54 +264,54 @@ The six following methods return the coefficients of the supported conic, after */ /// @{ -/*! +/*! returns the coefficient of \f$ x^2\f$. */ const typename NtTraits::Integer& r() const; -/*! +/*! returns the coefficient of \f$ t^2\f$. */ const typename NtTraits::Integer& s() const; -/*! +/*! returns the coefficient of \f$ x y\f$. */ const typename NtTraits::Integer& t() const; -/*! +/*! returns the coefficient of \f$ x\f$. */ const typename NtTraits::Integer& u() const; -/*! +/*! returns the coefficient of \f$ y\f$. */ const typename NtTraits::Integer& v() const; -/*! +/*! returns the free coefficient. */ const typename NtTraits::Integer& w() const; -/*! +/*! returns the source point of the arc. \pre `a` is not a full conic curve. */ const Point_2& source() const; -/*! +/*! returns the target point of the arc. \pre `a` is not a full conic curve. */ const Point_2& target() const; -/*! +/*! returns the orientation of the arc. */ Orientation orientation() const; -/*! +/*! return a bounding box of the arc `a`. */ Bbox_2 bbox() const; @@ -321,13 +321,13 @@ Bbox_2 bbox() const; /// \name Operations /// @{ -/*! +/*! sets a new source point for the conic arc. \pre `ps` lies on the supporting conic of `a`. */ void set_source (const Point_2 & ps); -/*! +/*! sets a new target point for the conic arc. \pre `pt` lies on the supporting conic of `a`. */ @@ -356,7 +356,7 @@ public: /// \name Creation /// @{ -/*! +/*! converts the given arc to an \f$ x\f$-monotone arc. \pre `arc` is \f$ x\f$-monotone. */ @@ -367,12 +367,12 @@ X_monotone_curve_2 (const Curve_2& arc); /// \name Access Functions /// @{ -/*! +/*! returns the left (lexicographically smaller) endpoint of `xa`. */ const Point_2& left() const; -/*! +/*! returns the right (lexicographically larger) endpoint of `xa`. */ const Point_2& right() const; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h index 74fb06871ff..4c939f85c5d 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_consolidated_curve_data_traits_2.h @@ -35,27 +35,27 @@ public: /// \name Types /// @{ -/*! +/*! the base traits-class. */ typedef Traits Base_traits_2; -/*! +/*! the base curve. */ typedef typename Base_traits_2::Curve_2 Base_curve_2; -/*! +/*! the base \f$ x\f$-monotone curve curve. */ typedef typename Base_traits_2::X_monotone_curve_2 Base_x_monotone_curve_2; -/*! +/*! a set of data objects that is associated with an \f$ x\f$-monotone curve. */ typedef unspecified_type typedef Data_container; -/*! +/*! a non-mutable iterator for the data objects in the data container. */ typedef unspecified_type typedef Data_iterator; @@ -80,12 +80,12 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Data_container (); -/*! +/*! constructs set containing a single `data` object. */ Data_container (const Data& data); @@ -95,28 +95,28 @@ Data_container (const Data& data); /// \name Access Functions /// @{ -/*! +/*! returns the number of data objects in the set. */ std::size_t size () const; -/*! +/*! returns an iterator pointing to the first data object. */ Data_iterator begin () const; -/*! +/*! returns a past-the-end iterator for the data objects. */ Data_iterator end () const; -/*! +/*! returns the first data object inserted into the set. \pre The number of data objects is not \f$ 0\f$. */ const Data& front () const; -/*! +/*! returns the last data object inserted into the set. \pre The number of data objects is not \f$ 0\f$. */ @@ -127,12 +127,12 @@ const Data& back () const; /// \name Predicates /// @{ -/*! +/*! check if the two sets contain the same data objects (regardless of order). */ bool operator== (const Data_container& other) const; -/*! +/*! find the given `data` object in the set and returns an iterator for this object, or `end()` if it is not found. */ @@ -143,19 +143,19 @@ Data_iterator find (const Data& data); /// \name Modifiers /// @{ -/*! +/*! inserts the given `data` object into the set. Returns `true` on success, or `false` if the set already contains the object. */ bool insert (const Data& data); -/*! +/*! erases the given `data` object from the set. Returns `true` on success, or `false` if the set does not contain the object. */ bool erase (const Data& data); -/*! +/*! clears the set. */ void clear (); 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 8508a4cc00b..8199dd7d2de 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 @@ -62,37 +62,37 @@ public: /// \name Types /// @{ -/*! +/*! the base traits-class. */ typedef Tr Base_traits_2; -/*! +/*! the base curve. */ typedef typename Base_traits_2::Curve_2 Base_curve_2; -/*! +/*! the base \f$ x\f$-monotone curve curve. */ typedef typename Base_traits_2::X_monotone_curve_2 Base_x_monotone_curve_2; -/*! +/*! the merge functor. */ typedef Mrg Merge; -/*! +/*! the conversion functor. */ typedef Cnv Convert; -/*! +/*! the type of data associated with curves. */ typedef CData Curve_data; -/*! +/*! the type of data associated with \f$ x\f$-monotone curves. */ typedef XData X_monotone_curve_data; @@ -116,18 +116,18 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Curve_2 (); -/*! +/*! constructs curve from the given `base` curve with uninitialized data field. */ Curve_2 (const Base_curve_2& base); -/*! +/*! constructs curve from the given `base` curve with an attached `data` field. */ @@ -138,13 +138,13 @@ Curve_2 (const Base_curve_2& base, const Data& data); /// \name Access Functions /// @{ -/*! +/*! returns the data field (a non-const version, which returns a reference to the data object, is also available). */ const Curve_data& data () const; -/*! +/*! sets the data field. */ void set_data (const Curve_data& data); @@ -166,18 +166,18 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ X_monotone_curve_2 (); -/*! +/*! constructs an \f$ x\f$-monotone curve from the given `base` curve with uninitialized data field. */ X_monotone_curve_2 (const Base_x_monotone_curve_2& base); -/*! +/*! constructs an \f$ x\f$-monotone curve from the given `base` \f$ x\f$-monotone curve with an attached `data` field. */ @@ -189,13 +189,13 @@ const X_monotone_curve_data& data); /// \name Access Functions /// @{ -/*! +/*! returns the field (a non-const version, which returns a reference to the data object, is also available). */ const X_monotone_curve_data& data () const; -/*! +/*! sets the data field. */ void set_data (const X_monotone_curve_data& data); 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 d1874b95a6e..6fb986d3c09 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 @@ -69,7 +69,7 @@ public: /// \name Creation /// @{ -/*! +/*! assigns `f` with the contents of the `other` vertex. */ void assign (const Self & other); @@ -79,7 +79,7 @@ void assign (const Self & other); /// \name Access Functions /// @{ -/*! +/*! obtains the auxiliary data (a non-const version, returning a reference to a mutable data object is also available). */ @@ -90,7 +90,7 @@ const FData & data () const; /// \name Modifiers /// @{ -/*! +/*! sets the auxiliary data. */ void set_data (const FData & data); @@ -121,7 +121,7 @@ public: /// \name Creation /// @{ -/*! +/*! assigns `he` with the contents of the `other` vertex. */ void assign (const Self & other); @@ -131,7 +131,7 @@ void assign (const Self & other); /// \name Access Functions /// @{ -/*! +/*! obtains the auxiliary data (a non-const version, returning a reference to a mutable data object is also available). */ @@ -142,7 +142,7 @@ const HData & data () const; /// \name Modifiers /// @{ -/*! +/*! sets the auxiliary data. */ void set_data (const HData & data); @@ -174,7 +174,7 @@ public: /// \name Creation /// @{ -/*! +/*! assigns `v` with the contents of the `other` vertex. */ void assign (const Self & other); @@ -184,7 +184,7 @@ void assign (const Self & other); /// \name Access Functions /// @{ -/*! +/*! obtains the auxiliary data (a non-const version, returning a reference to a mutable data object is also available). */ @@ -195,7 +195,7 @@ const VData & data () const; /// \name Modifiers /// @{ -/*! +/*! sets the auxiliary data. */ void set_data (const VData & data); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h index 1838b35c124..c816ecd0a52 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_face_index_map.h @@ -35,7 +35,7 @@ public: /// \name Types /// @{ -/*! +/*! the type of the attached arrangement. */ typedef Arrangement Arrangement_2; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h index 392aa74e30a..704186f50e4 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_linear_traits_2.h @@ -44,22 +44,22 @@ public: /// \name Types /// @{ - /*! + /*! */ typedef typename Kernel::Point_2 Point_2; - /*! + /*! */ typedef typename Kernel::Segment_2 Segment_2; - /*! + /*! */ typedef typename Kernel::Ray_2 Ray_2; - /*! + /*! */ typedef typename Kernel::Line_2 Line_2; @@ -69,22 +69,22 @@ public: /// \name Creation /// @{ - /*! + /*! constructs an degenerate curve equivalent to the point `p`. */ Curve_2 (const Point_2& p); - /*! + /*! constructs an line segment. */ Curve_2 (const Segment_2& seg); - /*! + /*! constructs a ray. */ Curve_2 (const Ray_2& ray); - /*! + /*! constructs a line. */ Curve_2 (const Line_2& ln); @@ -94,64 +94,64 @@ public: /// \name Access Functions /// @{ - /*! + /*! returns whether `c` is a point (a degenerate curve). */ bool is_point() const; - /*! + /*! returns a point object equivalent to `c`. \pre `c` is a point. */ Point_2 point() const; - /*! + /*! returns whether `c` is a segment (has two bounded endpoints). */ bool is_segment() const; - /*! + /*! returns a segment object equivalent to `c`. \pre `c` is a segment. */ Segment_2 segment() const; - /*! + /*! returns whether `c` is a ray (has a bounded source point and its other end is unbounded). */ bool is_ray() const; - /*! + /*! returns a ray object equivalent to `c`. \pre `c` is a ray. */ Ray_2 ray() const; - /*! + /*! returns whether `c` is a line (has only unbounded ends). */ bool is_line() const; - /*! + /*! returns a line object equivalent to `c`. \pre `c` is a line. */ Line_2 line() const; - /*! + /*! returns the supporting line of `c`. \pre `c` is not a point (a degenerate curve). */ Line_2 supporting_line() const; - /*! + /*! returns `c`'s source point. \pre `c` is a point, a segment or a ray. */ Point_2 source() const; - /*! + /*! returns `c`'s target point. \pre `c` is a point or a segment. */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h index 69e2d01d859..20c9cfbecb7 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_observer.h @@ -32,37 +32,37 @@ public: /// \name Types /// @{ -/*! +/*! the type of the associated arrangement. */ typedef unspecified_type Arrangement_2; -/*! +/*! the point type. */ typedef typename Arrangement_2::Point_2 Point_2; -/*! +/*! the \f$ x\f$-monotone curve type. */ typedef typename Arrangement_2::X_monotone_curve_2 X_monotone_curve_2; -/*! +/*! */ typedef typename Arrangement_2::Vertex_handle Vertex_handle; -/*! +/*! */ typedef typename Arrangement_2::Halfedge_handle Halfedge_handle; -/*! +/*! */ typedef typename Arrangement_2::Face_handle Face_handle; -/*! +/*! represents the boundary of a connected component (CCB). In particular, holes are represented by a circulator for their outer CCB. */ @@ -73,12 +73,12 @@ typedef typename Arrangement_2::Ccb_halfedge_circulator Ccb_halfedge_circulator; /// \name Creation /// @{ -/*! +/*! constructs an observer that is unattached to any arrangement instance. */ Arr_observer(); -/*! +/*! constructs an observer and attaches it to the given arrangement `arr`. */ @@ -89,12 +89,12 @@ Arr_observer(Arrangement_2& arr); /// \name Modifiers /// @{ -/*! +/*! attaches the observer to the given arrangement `arr`. */ void attach (Arrangement_2& arr); -/*! +/*! detaches the observer from its arrangement. */ void detach (); @@ -104,30 +104,30 @@ void detach (); /// \name Notifications on Global Arrangement Operations /// @{ -/*! +/*! issued just before the attached arrangement is assigned with the contents of another arrangement `arr`. */ virtual void before_assign (const Arrangement_2& arr); -/*! +/*! issued immediately after the attached arrangement has been assigned with the contents of another arrangement. */ virtual void after_assign (); -/*! +/*! issued just before the attached arrangement is cleared. */ virtual void before_clear (); -/*! +/*! issued immediately after the attached arrangement has been cleared, so it now consists only of a the unbounded face `uf`. */ virtual void after_clear (Face_handle uf); -/*! +/*! issued just before a global function starts to modify the attached arrangement. It is guaranteed that no queries (especially no point-location queries) are issued until the termination of the global @@ -135,7 +135,7 @@ function is indicated by `after_global_change()`. */ virtual void before_global_change (); -/*! +/*! issued immediately after a global function has stopped modifying the attached arrangement. */ @@ -146,24 +146,24 @@ virtual void after_global_change (); /// \name Notifications on Attachment or Detachment /// @{ -/*! +/*! issued just before the observer is attached to the arrangement instance `arr`. */ virtual void before_attach (const Arrangement_2& arr); -/*! +/*! issued immediately after the observer has been attached to an arrangement instance. */ virtual void after_attach (); -/*! +/*! issued just before the observer is detached from its arrangement instance. */ virtual void before_detach (); -/*! +/*! issued immediately after the observer has been detached from its arrangement instance. */ @@ -174,20 +174,20 @@ virtual void after_attach (); /// \name Notifications on Local Changes in the Arrangement /// @{ -/*! +/*! issued just before a new vertex that corresponds to the point `p` is created. */ virtual void before_create_vertex (const Point_2& p); -/*! +/*! issued immediately after a new vertex `v` has been created. Note that the vertex still has no incident edges and is not connected to any other vertex. */ virtual void after_create_vertex (Vertex_handle v); -/*! +/*! issued just before a new vertex at infinity is created, `cv` is the curve incident to the surface boundary, `ind` is the relevant curve-end, `ps_x` is the boundary condition of the vertex in \f$ x\f$ and `ps_y` @@ -198,14 +198,14 @@ Arr_curve_end ind , Arr_parameter_space ps_x , Arr_parameter_space ps_y ); -/*! +/*! issued immediately after a new vertex `v` has been created. Note that the vertex still has no incident edges and is not connected to any other vertex. */ virtual void after_create_boundary_vertex (Vertex_handle v); -/*! +/*! issued just before a new edge that corresponds to the \f$ x\f$-monotone curve `c` and connects the vertices `v1` and `v2` is created. */ @@ -213,38 +213,38 @@ virtual void before_create_edge (const X_monotone_curve_2& c, Vertex_handle v1, Vertex_handle v2); -/*! +/*! issued immediately after a new edge `e` has been created. The halfedge that is sent to this function is always directed from `v1` to `v2` (see above). */ virtual void after_create_edge (Halfedge_handle e); -/*! +/*! issued just before a vertex `v` is modified to be associated with the point `p`. */ virtual void before_modify_vertex (Vertex_handle v, const Point_2& p); -/*! +/*! issued immediately after an existing vertex `v` has been modified. */ virtual void after_modify_vertex (Vertex_handle v); -/*! +/*! issued just before an edge `e` is modified to be associated with the \f$ x\f$-monotone curve `c`. */ virtual void before_modify_edge (Halfedge_handle e, const X_monotone_curve_2& c); -/*! +/*! issued immediately after an existing edge `e` has been modified. */ virtual void after_modify_edge (Halfedge_handle e); -/*! +/*! issued just before an edge `e` is split into two edges that should be associated with the \f$ x\f$-monotone curves `c1` and `c2`. The vertex `v` corresponds to the split point, and will be used to @@ -255,14 +255,14 @@ Vertex_handle v, const X_monotone_curve_2& c1, const X_monotone_curve_2& c2); -/*! +/*! issued immediately after an existing edge has been split into the two given edges `e1` and `e2`. */ virtual void after_split_edge (Halfedge_handle e1, Halfedge_handle e2); -/*! +/*! issued just before a fictitious edge `e` is split into two. The vertex at infinity `v` corresponds to the split point, and will be used to separate the two resulting edges. @@ -270,21 +270,21 @@ used to separate the two resulting edges. virtual void before_split_fictitious_edge (Halfedge_handle e, Vertex_handle v); -/*! +/*! issued immediately after an existing fictitious edge has been split into the two given fictitious edges `e1` and `e2`. */ virtual void after_split_fictitious_edge (Halfedge_handle e1, Halfedge_handle e2); -/*! +/*! issued just before a face `f` is split into two, as a result of the insertion of the edge `e` into the arrangement. */ virtual void before_split_face (Face_handle f, Halfedge_handle e); -/*! +/*! issued immediately after the existing face `f1` has been split, such that a portion of it now forms a new face `f2`. The flag `is_hole` designates whether `f2` forms a hole inside `f1`. @@ -293,7 +293,7 @@ virtual void after_split_face (Face_handle f1, Face_handle f2, bool is_hole); -/*! +/*! issued just before outer ccb `h` inside a face `f` is split into two, as a result of the removal of the edge `e` from the arrangement. */ @@ -301,7 +301,7 @@ virtual void before_split_outer_ccb (Face_handle f, Ccb_halfedge_circulator h, Halfedge_handle e); -/*! +/*! issued immediately after outer ccb the face `f` has been split, resulting in the two holes `h1` and `h2`. */ @@ -309,7 +309,7 @@ virtual void after_split_outer_ccb (Face_handle f, Ccb_halfedge_circulator h1, Ccb_halfedge_circulator h2); -/*! +/*! issued just before inner ccb `h` inside a face `f` is split into two, as a result of the removal of the edge `e` from the arrangement. */ @@ -317,7 +317,7 @@ virtual void before_split_inner_ccb (Face_handle f, Ccb_halfedge_circulator h, Halfedge_handle e); -/*! +/*! issued immediately after inner ccb the face `f` has been split, resulting in the two holes `h1` and `h2`. */ @@ -325,46 +325,46 @@ virtual void after_split_inner_ccb (Face_handle f, Ccb_halfedge_circulator h1, Ccb_halfedge_circulator h2); -/*! +/*! issued just before the edge `e` is inserted as a new outer ccb inside the face `f`. */ virtual void before_add_outer_ccb (Face_handle f, Halfedge_handle e); -/*! +/*! issued immediately after a new outer ccb `h` has been created. The outer ccb always consists of a single pair of twin halfedges. */ virtual void after_add_outer_ccb (Ccb_halfedge_circulator h); -/*! +/*! issued just before the edge `e` is inserted as a new inner ccb inside the face `f`. */ virtual void before_add_inner_ccb (Face_handle f, Halfedge_handle e); -/*! +/*! issued immediately after a new inner ccb `h` has been created. The inner ccb always consists of a single pair of twin halfedges. */ virtual void after_add_inner_ccb (Ccb_halfedge_circulator h); -/*! +/*! issued just before the vertex `v` is inserted as an isolated vertex inside the face `f`. */ virtual void before_add_isolated_vertex (Face_handle f, Vertex_handle v); -/*! +/*! issued immediately after the vertex `v` has been set as an isolated vertex. */ virtual void after_add_isolated_vertex (Vertex_handle v); -/*! +/*! issued just before the two edges `e1` and `e2` are merged to form a single edge that will be associated with the \f$ x\f$-monotone curve `c`. @@ -373,26 +373,26 @@ virtual void before_merge_edge (Halfedge_handle e1, Halfedge_handle e2, const X_monotone_curve_2& c); -/*! +/*! issued immediately after two edges have been merged to form the edge `e`. */ virtual void after_merge_edge (Halfedge_handle e); -/*! +/*! issued just before the two fictitious edges `e1` and `e2` are merged to form a single fictitious edge. */ virtual void before_merge_fictitious_edge (Halfedge_handle e1, Halfedge_handle e2); -/*! +/*! issued immediately after two fictitious edges have been merged to form the fictitious edge `e`. */ virtual void after_merge_fictitious_edge (Halfedge_handle e); -/*! +/*! issued just before the two edges `f1` and `f2` are merged to form a single face, following the removal of the edge `e` from the arrangement. @@ -401,13 +401,13 @@ virtual void before_merge_face (Face_handle f1, Face_handle f2, Halfedge_handle e); -/*! +/*! issued immediately after two faces have been merged to form the face `f`. */ virtual void after_merge_face (Face_handle f); -/*! +/*! issued just before two outer ccbs `h1` and `h2` inside the face `f` are merged to form a single connected component, following the insertion of the edge `e` into the arrangement. @@ -417,14 +417,14 @@ Ccb_halfedge_circulator h1, Ccb_halfedge_circulator h2, Halfedge_handle e); -/*! +/*! issued immediately after two outer ccbs have been merged to form a single outer ccb `h` inside the face `f`. */ virtual void after_merge_outer_ccb (Face_handle f, Ccb_halfedge_circulator h); -/*! +/*! issued just before two inner ccbs `h1` and `h2` inside the face `f` are merged to form a single connected component, following the insertion of the edge `e` into the arrangement. @@ -434,14 +434,14 @@ Ccb_halfedge_circulator h1, Ccb_halfedge_circulator h2, Halfedge_handle e); -/*! +/*! issued immediately after two inner ccbs have been merged to form a single inner ccb `h` inside the face `f`. */ virtual void after_merge_inner_ccb (Face_handle f, Ccb_halfedge_circulator h); -/*! +/*! issued just before the outer ccb `h` is moved from one face to another. This can happen if the face `to_f` containing the outer ccb has just been split from `from_f`. @@ -450,12 +450,12 @@ virtual void before_move_outer_ccb (Face_handle from_f, Face_handle to_f, Ccb_halfedge_circulator h); -/*! +/*! issued immediately after the outer ccb `h` has been moved to a new face. */ virtual void after_move_outer_ccb (Ccb_halfedge_circulator h); -/*! +/*! issued just before the inner ccb `h` is moved from one face to another. This can happen if the face `to_f` containing the inner ccb has just been split from `from_f`. @@ -464,12 +464,12 @@ virtual void before_move_inner_ccb (Face_handle from_f, Face_handle to_f, Ccb_halfedge_circulator h); -/*! +/*! issued immediately after the inner ccb `h` has been moved to a new face. */ virtual void after_move_inner_ccb (Ccb_halfedge_circulator h); -/*! +/*! issued just before the isolated vertex `v` is moved from one face to another. This can happen if the face `to_f` containing the isolated vertex @@ -479,55 +479,55 @@ virtual void before_move_isolated_vertex (Face_handle from_f, Face_handle to_f, Vertex_handle v); -/*! +/*! issued immediately after the isolated vertex `v` has been moved to a new face. */ virtual void after_move_isolated_vertex (Vertex_handle v); -/*! +/*! issued just before the vertex `v` is removed from the arrangement. */ virtual void before_remove_vertex (Vertex_handle v); -/*! +/*! issued immediately after a vertex has been removed (and deleted) from the arrangement. */ virtual void after_remove_vertex (); -/*! +/*! issued just before the edge `e` is removed from the arrangement. */ virtual void before_remove_edge (Halfedge_handle e); -/*! +/*! issued immediately after an edge has been removed (and deleted) from the arrangement. */ virtual void after_remove_edge (); -/*! +/*! issued just before the outer ccb `f` is removed from inside the face `f`. */ virtual void before_remove_outer_ccb (Face_handle f, Ccb_halfedge_circulator h); -/*! +/*! issued immediately after a outer ccb has been removed (and deleted) from inside the face `f`. */ virtual void after_remove_outer_ccb (Face_handle f); -/*! +/*! issued just before the inner ccb `f` is removed from inside the face `f`. */ virtual void before_remove_inner_ccb (Face_handle f, Ccb_halfedge_circulator h); -/*! +/*! issued immediately after a inner ccb has been removed (and deleted) from inside the face `f`. */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h index d0ff14ec313..5bfb9ff86e0 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_polyline_traits_2.h @@ -53,13 +53,13 @@ public: /// \name Types /// @{ -/*! +/*! A bidirectional iterator that allows traversing the points that comprise a polyline curve. */ typedef unspecified_type const_iterator; -/*! +/*! A bidirectional iterator that allows traversing the points that comprise a polyline curve. */ @@ -70,12 +70,12 @@ typedef unspecified_type const_reverse_iterator; /// \name Creation /// @{ -/*! +/*! default constructor that constructs an empty polyline. */ Curve_2 (); -/*! +/*! constructs a polyline defined by the given range of points `[first, last)` (the value-type of `InputIterator` must be `SegmentTraits::Point_2`. @@ -94,47 +94,47 @@ Curve_2 (Iterator first, Iterator last); /// \name Access Functions /// @{ -/*! +/*! returns the number of points that comprise the polyline. Note that if there are \f$ n\f$ points in the polyline, it is comprised of \f$ (n - 1)\f$ segments. */ size_t points() const; -/*! +/*! returns an iterator pointing at the source point of the polyline. */ const_iterator begin() const; -/*! +/*! returns an iterator pointing after the end of the polyline. */ const_iterator end() const; -/*! +/*! returns an iterator pointing at the target point of the polyline. */ const_iterator rbegin() const; -/*! +/*! returns an iterator pointing before the beginning of the polyline. */ const_iterator rend() const; -/*! +/*! returns the number of line segments comprising the polyline (equivalent to `pi.points() - 1`). */ size_t size() const; -/*! +/*! returns the \f$ k\f$th segment of the polyline. \pre `k` is not greater or equal to `pi.size() - 1`. */ typename SegmentTraits::X_monotone_curve_2 operator[] (size_t k) const; -/*! +/*! return a bounding box of the polyline `pi`. */ Bbox_2 bbox() const; @@ -144,13 +144,13 @@ Bbox_2 bbox() const; /// \name Operations /// @{ -/*! +/*! adds a new point to the polyline, which becomes the new target point of `pi`. */ void push_back (const Point_2 & p); -/*! +/*! resets the polyline. */ void clear(); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h index 83819d29c8a..db330187157 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_rational_function_traits_2.h @@ -63,27 +63,27 @@ public: /// \name Types /// @{ - /*! + /*! */ typedef AlgebraicKernel_d_1 Algebraic_kernel_d_1; - /*! + /*! */ typedef AlgebraicKernel_d_1::Coefficient Coefficient; - /*! + /*! */ typedef AlgebraicKernel_d_1::Polynomial_1 Polynomial_1; - /*! + /*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 Algebraic_real_1; - /*! + /*! */ typedef AlgebraicKernel_d_1::Bound Bound; @@ -93,7 +93,7 @@ public: /// \name Creation /// @{ - /*! + /*! constructs an empty traits that uses the kernel pointed by `kernel` for performing algebraic operations. */ @@ -104,22 +104,22 @@ public: /// \name Operations /// @{ - /*! + /*! Returns an instance of `Construct_curve_2`. */ Construct_curve_2 construct_curve_2_object() const; - /*! + /*! Returns an instance of `Construct_x_monotone_curve_2`. */ Construct_x_monotone_curve_2 construct_x_monotone_curve_2_object() const; - /*! + /*! Deletes all curves from the cache that exist only there. */ void cleanup_cache() const; - /*! + /*! Returns a pointer to the used algerbaic kernel object. */ const Algebraic_kernel_d_1* algebraic_kernel_d_1() const; @@ -146,32 +146,32 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 Polynomial_1; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 Algebraic_real_1; -/*! +/*! */ typedef Arr_rational_function_traits_2::Curve_2 result_type; -/*! +/*! */ typedef Polynomial_1 argument_type; -/*! +/*! */ typedef Polynomial_1 first_argument_type; -/*! +/*! */ typedef Polynomial_1 second_argument_type; @@ -181,50 +181,50 @@ typedef Polynomial_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Constructs a curve representing the polynomial function \f$ y = P(x)\f$. */ Curve_2 operator()(Polynomial_1 P) const; -/*! +/*! Constructs a curve representing the polynomial function \f$ y = P(x)\f$. The function is defined over the interval \f$ [x,+\infty)\f$ if \f$ right\f$ is true and \f$ (-\infty,x]\f$ otherwise. */ Curve_2 operator()(Polynomial_1 P, const Algebraic_real_1& x, bool right) const; -/*! +/*! Constructs a curve representing the polynomial function \f$ y = P(x)\f$. The function is defined over the interval \f$ [lower,upper]\f$. */ Curve_2 operator()(Polynomial_1 P, const Algebraic_real_1& lower, const Algebraic_real_1& upper) const; -/*! +/*! Constructs a curve representing the rational function \f$ y = P(x)/Q(x)\f$. */ Curve_2 operator()(Polynomial_1 P, Polynomial_1 Q) const; -/*! +/*! Constructs a curve representing the rational function \f$ y = P(x)/Q(x)\f$. The function is defined over the interval \f$ I=[x,+\infty)\f$ if \f$ right\f$ is true and \f$ I=(-\infty,x]\f$ otherwise. */ Curve_2 operator()(Polynomial_1 P, Polynomial_1 Q, const Algebraic_real_1& x, bool right) const; -/*! +/*! Constructs a curve representing the rational function \f$ y = P(x)/Q(x)\f$. The function is defined over the interval \f$ I=[lower,upper]\f$. */ Curve_2 operator()(Polynomial_1 P, Polynomial_1 Q, const Algebraic_real_1& lower, const Algebraic_real_1& upper) const; -/*! +/*! Constructs a curve representing the polynomial function \f$ y = P(x)\f$, where the coefficients of \f$ P\f$ are given in the range `[begin,end)`. */ template Curve_2 operator()(InputIterator begin, InputIterator end) const; -/*! +/*! Constructs a curve representing the polynomial function \f$ y = P(x)\f$, where the coefficients of \f$ P\f$ are given in the range `[begin,end)`. The function is defined over the interval \f$ [x,+\infty)\f$ if \f$ right\f$ is true @@ -234,7 +234,7 @@ template Curve_2 operator()(InputIterator begin, InputIterator end, const Algebraic_real_1& x, bool right) const; -/*! +/*! Constructs a curve representing the polynomial function \f$ y = P(x)\f$, where the coefficients of \f$ P\f$ are given in the range `[begin,end)`. The function is defined over the interval \f$ [lower,upper]\f$. @@ -244,7 +244,7 @@ Curve_2 operator()(InputIterator begin, InputIterator end, const Algebraic_real_1& lower, const Algebraic_real_1& upper) const; -/*! +/*! Constructs a curve representing the rational function \f$ y = P(x)/Q(x)\f$, where the coefficients of \f$ P\f$ and \f$ Q\f$ are given in the ranges `[begin_numer,end_numer)` and `[begin_denom,end_denom)`, @@ -254,7 +254,7 @@ template Curve_2 operator()(InputIterator begin_numer, InputIterator end_numer, InputIterator begin_denom, InputIterator end_denom) const; -/*! +/*! Constructs a curve representing the rational function \f$ y = P(x)/Q(x)\f$, where the coefficients of \f$ P\f$ and \f$ Q\f$ are given in the ranges `[begin_numer,end_numer)` and `[begin_denom,end_denom)`, @@ -266,7 +266,7 @@ Curve_2 operator()(InputIterator begin_numer, InputIterator end_numer, InputIterator begin_denom, InputIterator end_denom, const Algebraic_real_1& x, bool right) const; -/*! +/*! Constructs a curve representing the rational function \f$ y = P(x)/Q(x)\f$, where the coefficients of \f$ P\f$ and \f$ Q\f$ are given in the ranges `[begin_numer,end_numer)` and `[begin_denom,end_denom)`, @@ -301,32 +301,32 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 Polynomial_1; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 Algebraic_real_1; -/*! +/*! */ typedef Arr_rational_function_traits_2::X_monotone_curve_2 result_type; -/*! +/*! */ typedef Polynomial_1 argument_type; -/*! +/*! */ typedef Polynomial_1 first_argument_type; -/*! +/*! */ typedef Polynomial_1 second_argument_type; @@ -336,13 +336,13 @@ typedef Polynomial_1 second_argument_type; /// \name Operations /// @{ -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the polynomial function \f$ y = P(x)\f$. */ X_monotone_curve_2 operator()(Polynomial_1 P) const; -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the polynomial function \f$ y = P(x)\f$. The function is defined over the interval \f$ [x,+\infty)\f$ if \f$ right\f$ is true and \f$ (-\infty,x]\f$ otherwise. @@ -351,7 +351,7 @@ X_monotone_curve_2 operator()(Polynomial_1 P, const Algebraic_real_1& x, bool right) const; -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the polynomial function \f$ y = P(x)\f$. The function is defined over the interval \f$ [lower,upper]\f$. */ @@ -359,14 +359,14 @@ X_monotone_curve_2 operator()(Polynomial_1 P, const Algebraic_real_1& lower, const Algebraic_real_1& upper); const -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the rational function \f$ y = P(x)/Q(x)\f$. \pre \f$ Q\f$ has no real roots. */ X_monotone_curve_2 operator()(Polynomial_1 P, Polynomial_1 Q); const -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the rational function \f$ y = P(x)/Q(x)\f$. The function is defined over the interval \f$ I=[x,+\infty)\f$ if \f$ right\f$ is true and \f$ I=(-\infty,x]\f$ otherwise. @@ -376,7 +376,7 @@ X_monotone_curve_2 operator()(Polynomial_1 P, Polynomial_1 Q, const Algebraic_real_1& x, bool right); const -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the rational function \f$ y = P(x)/Q(x)\f$. The function is defined over the interval \f$ I=[lower,upper]\f$. \pre \f$ Q\f$ has no real roots in the interior of \f$ I\f$. @@ -385,7 +385,7 @@ X_monotone_curve_2 operator()(Polynomial_1 P, Polynomial_1 Q, const Algebraic_real_1& lower, const Algebraic_real_1& upper); const -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the polynomial function \f$ y = P(x)\f$, where the coefficients of \f$ P\f$ are given in the range `[begin,end)`. @@ -393,7 +393,7 @@ Constructs an \f$ x\f$-monotone curve supported by the polynomial function template X_monotone_curve_2 operator()(InputIterator begin, InputIterator end) const; -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the polynomial function \f$ y = P(x)\f$, where the coefficients of \f$ P\f$ are given in the range `[begin,end)`. The function is defined over the interval \f$ [x,+\infty)\f$ @@ -403,7 +403,7 @@ template X_monotone_curve_2 operator()(InputIterator begin, InputIterator end, const Algebraic_real_1& x, bool right) const; -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the polynomial function \f$ y = P(x)\f$, where the coefficients of \f$ P\f$ are given in the range `[begin,end)`. The function is defined over the interval @@ -414,7 +414,7 @@ X_monotone_curve_2 operator()(InputIterator begin, InputIterator end const Algebraic_real_1& lower, const Algebraic_real_1& upper); const -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the rational function \f$ y = P(x)/Q(x)\f$, where the coefficients of \f$ P\f$ and \f$ Q\f$ are given in the ranges `[begin_numer,end_numer)` and `[begin_denom,end_denom)`, @@ -425,7 +425,7 @@ template X_monotone_curve_2 operator()(InputIterator begin_numer, InputIterator end_numer, InputIterator begin_denom, InputIterator end_denom); const -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the rational function \f$ y = P(x)/Q(x)\f$, where the coefficients of \f$ P\f$ and \f$ Q\f$ are given in the ranges `[begin_numer,end_numer)` and `[begin_denom,end_denom)`, @@ -438,7 +438,7 @@ X_monotone_curve_2 operator()(InputIterator begin_numer, InputIterator end_numer InputIterator begin_denom, InputIterator end_denom, const Algebraic_real_1& x, bool right); const -/*! +/*! Constructs an \f$ x\f$-monotone curve supported by the rational function \f$ y = P(x)/Q(x)\f$, where the coefficients of \f$ P\f$ and \f$ Q\f$ are given in the ranges `[begin_numer,end_numer)` and `[begin_denom,end_denom)`, @@ -469,12 +469,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 Polynomial_1; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 Algebraic_real_1; @@ -484,41 +484,41 @@ typedef AlgebraicKernel_d_1::Algebraic_real_1 Algebraic_real_1; /// \name Operations /// @{ -/*! +/*! returns the numerator of the supporting rational function. */ const Polynomial_1& numerator () const; -/*! +/*! returns the denominator of the supporting rational function. */ const Polynomial_1& denominator () const; -/*! +/*! returns whether çurve is continuous, namely whether it does not contains any vertical asymptotes in its interior. */ bool is_continuous() const; -/*! +/*! returns whether the \f$ x\f$-coordinate of çurve's left end is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space left_parameter_space_in_x () const; -/*! +/*! returns whether the \f$ x\f$-coordinate of çurve's right end is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space right_parameter_space_in_x () const; -/*! +/*! returns the \f$ x\f$-coordinate of the left end. \pre left_boundary_in_x()==ARR_INTERIOR */ Algebraic_real_1 left_x() const; -/*! +/*! returns the \f$ x\f$-coordinate of the right end. \pre right_boundary_in_x()==ARR_INTERIOR */ @@ -540,17 +540,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 Polynomial_1; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 Algebraic_real_1; -/*! +/*! */ typedef AlgebraicKernel_d_1::Bound Bound; @@ -560,27 +560,27 @@ typedef AlgebraicKernel_d_1::Bound Bound; /// \name Operations /// @{ -/*! +/*! returns the numerator of the supporting rational function. */ Polynomial_1 numerator () const; -/*! +/*! returns the denominator of the supporting rational function. */ Polynomial_1 denominator () const; -/*! +/*! returns double-approximations of the x- and y-coordinates. */ std::pair to_double() const; -/*! +/*! returns the \f$ x\f$-coordinate of the point. */ Algebraic_real_1 x() const; -/*! +/*! obtains the y-coordinates of the point. Attention: As described above, points are not stored by their y-coordinate in `Algebraic_real_1` representation. In fact, this representation must be computed on demand, and @@ -590,7 +590,7 @@ possible. */ Algebraic_real_1 y() const; -/*! +/*! Computes a pair \f$ p\f$ approximating the \f$ x\f$-coordinate with respect to the given absolute precision \f$ a\f$. \post \f$ p.first \leq x \leq p.second \f$ @@ -598,7 +598,7 @@ respect to the given absolute precision \f$ a\f$. */ std::pair approximate_absolute_x(int a) const; -/*! +/*! Computes a pair \f$ p\f$ approximating the \f$ y\f$-coordinate with respect to the given absolute precision \f$ a\f$. \post \f$ p.first \leq y \leq p.second \f$ @@ -606,7 +606,7 @@ respect to the given absolute precision \f$ a\f$. */ std::pair approximate_absolute_y(int a) const; -/*! +/*! Computes a pair \f$ p\f$ approximating the \f$ x\f$-coordinate with respect to the given relative precision \f$ r\f$. \post \f$ p.first \leq x \leq p.second \f$ @@ -614,7 +614,7 @@ respect to the given relative precision \f$ r\f$. */ std::pair approximate_relative_x(int r) const; -/*! +/*! Computes a pair \f$ p\f$ approximating the \f$ y\f$-coordinate with respect to the given relative precision \f$ r\f$. \post \f$ p.first \leq y \leq p.second \f$ @@ -642,17 +642,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef AlgebraicKernel_d_1::Polynomial_1 Polynomial_1; -/*! +/*! */ typedef AlgebraicKernel_d_1::Algebraic_real_1 Algebraic_real_1; -/*! +/*! */ typedef Arr_rational_function_traits_2::Point_2 Point_2; @@ -662,113 +662,113 @@ typedef Arr_rational_function_traits_2::Point_2 Point_2; /// \name Operations /// @{ -/*! +/*! returns the numerator of the supporting rational function. */ const Polynomial_1& numerator () const; -/*! +/*! returns the denominator of the supporting rational function. */ const Polynomial_1& denominator () const; -/*! +/*! returns whether the \f$ x\f$-coordinate of the source is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space source_parameter_space_in_x () const; -/*! +/*! returns whether the \f$ y\f$-coordinate of the source is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space source_parameter_space_in_y () const; -/*! +/*! returns the source point of the arc. \pre Both the \f$ x\f$- and \f$ y\f$-coordinates of the source point is finite. */ const Point_2& source() const; -/*! +/*! returns the \f$ x\f$-coordinate of the source point. \pre The \f$ x\f$-coordinate of the source point is finite. */ Algebraic_real_1 source_x() const; -/*! +/*! returns whether the \f$ x\f$-coordinate of the target is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space target_parameter_space_in_x () const; -/*! +/*! returns whether the \f$ y\f$-coordinate of the target is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space target_parameter_space_in_y () const; -/*! +/*! returns the target point of the arc. \pre Both the \f$ x\f$- and \f$ y\f$-coordinates of the target point is finite. */ const Point_2& target() const; -/*! +/*! returns the \f$ x\f$-coordinate of the target point. \pre The \f$ x\f$-coordinate of the target point is finite. */ Algebraic_real_1 target_x() const; -/*! +/*! returns whether the \f$ x\f$-coordinate of the left curve end is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space left_parameter_space_in_x () const; -/*! +/*! returns whether the \f$ y\f$-coordinate of the left curve end is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space left_parameter_space_in_y () const; -/*! +/*! returns the left point of the arc. \pre Both the \f$ x\f$- and \f$ y\f$-coordinates of the left point is finite. */ const Point_2& left() const; -/*! +/*! returns the \f$ x\f$-coordinate of the left point. \pre The \f$ x\f$-coordinate of the left point is finite. */ Algebraic_real_1 left_x() const; -/*! +/*! returns whether the \f$ x\f$-coordinate of the right curve end is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space right_parameter_space_in_x () const; -/*! +/*! returns whether the \f$ y\f$-coordinate of the right curve end is finite or whether it is \f$ \pm\infty\f$. */ Arr_parameter_space right_parameter_space_in_y () const; -/*! +/*! returns the right point of the arc. \pre Both the \f$ x\f$- and \f$ y\f$-coordinates of The right point is finite. */ const Point_2& right() const; -/*! +/*! returns the \f$ x\f$-coordinate of the right point. \pre The \f$ x\f$-coordinate of the right point is finite. */ Algebraic_real_1 right_x() const; -/*! +/*! returns whether the curve is oriented from left to right. */ bool is_left_to_right () const; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h index 9a561424e3f..2056a6211bf 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_trapezoid_ric_point_location.h @@ -42,12 +42,12 @@ public: /// \name Creation /// @{ -/*! +/*! If with_guarantees is set to true, the cunstruction performs rebuilds in order to guarantee a resulting structure with linear size and logarithmic query time. Otherwise the structure has expected linear size and expected logarithmic query time. */ Arr_trapezoid_ric_point_location (bool with_guarantees = true); -/*! +/*! Constructs a point location search structure for the given arrangement. If with_guarantees is set to true, the cunstruction performs rebuilds in order to guarantee a resulting structure with linear size and logarithmic query time. Otherwise the structure has expected linear size and expected logarithmic query time. */ Arr_trapezoid_ric_point_location (const Arrangement& arr, bool with_guarantees = true); @@ -57,7 +57,7 @@ Arr_trapezoid_ric_point_location (const Arrangement& arr, bool with_guarantees = /// \name Modifiers /// @{ -/*! +/*! If with_guarantees is set to true, the structure will guarantee linear size and logarithmic query time, that is, this function may cause a reconstruction of the data structure. */ void with_guarantees (bool with_guarantees); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h index aeff3bb8682..c00dd12499a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arr_vertex_index_map.h @@ -35,7 +35,7 @@ public: /// \name Types /// @{ -/*! +/*! the type of the attached arrangement. */ typedef Arrangement Arrangement_2; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h index a6726817e61..38bacb7bb42 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_2.h @@ -60,32 +60,32 @@ public: /// @{ - /*! + /*! a private type used as an abbreviation of the `Arrangement_2` type hereafter. */ typedef Arrangement_2 Self; - /*! + /*! the traits class in use. */ typedef unspecified_type Traits_2; - /*! + /*! the Dcel representation of the arrangement. */ typedef unspecified_type Dcel; - /*! + /*! the point type, as defined by the traits class. */ typedef typename Traits_2::Point_2 Point_2; - /*! + /*! the \f$ x\f$-monotone curve type, as defined by the traits class. */ typedef typename Traits_2::X_monotone_curve_2 X_monotone_curve_2; - /*! + /*! the size type (equivalent to `size_t`). */ typedef typename Dcel::Size Size; @@ -101,7 +101,7 @@ public: /// \name Creation /// @{ - /*! + /*! default constructor. */ Vertex(); @@ -113,23 +113,23 @@ public: /// that return constant handles, iterators or circulators: /// @{ - /*! + /*! checks whether the vertex lies at infinity and not associated with a point with bounded coordinates. */ bool is_at_open_boundary() const; - /*! + /*! checks whether the vertex is isolated (i.e., has no incident edges). */ bool is_isolated() const; - /*! + /*! returns the number of edges incident to `v`. */ Size degree() const; - /*! + /*! returns a circulator circulator that allows going over the halfedges incident to `v` (that have `v` as their target). The edges are traversed in a clockwise direction around `v`. @@ -137,26 +137,26 @@ public: */ Halfedge_around_vertex_circulator incident_halfedges(); - /*! + /*! returns a handle to the face that contains `v` in its interior. \pre `v` is an isolated vertex. */ Face_handle face(); - /*! + /*! returns the point associated with the vertex. \pre `v` is not a vertex at infinity. */ const typename Traits::Point_2& point() const; - /*! + /*! returns the placement of the \f$ x\f$-coordinate in the parameter space, that is, either the left boundary-side, the interior, or the right boundary-side. */ Arr_parameter_space parameter_space_in_x () const; - /*! + /*! returns the placement of the \f$ y\f$-coordinate in the parameter space, that is, either the bottom boundary-side, the interior, or the top boundary-side. @@ -187,7 +187,7 @@ public: /// \name Creation /// @{ - /*! + /*! default constructor. */ Halfedge(); @@ -199,23 +199,23 @@ public: /// that return constant handles, iterators or circulators: /// @{ - /*! + /*! returns whether the halfedge is fictitious (i.e., connects two vertices at infinity and is not associated with a valid curve). */ bool is_fictitious () const; - /*! + /*! returns a handle for the source vertex of `e`. */ Vertex_handle source(); - /*! + /*! returns a handle for the target vertex of `e`. */ Vertex_handle target(); - /*! + /*! returns the direction of the halfedge: `ARR_LEFT_TO_RIGHT` if `e`'s source vertex is lexicographically smaller than it target (so the halfedge is directed from left to right), and @@ -224,35 +224,35 @@ public: */ Arr_halfedge_direction direction() const; - /*! + /*! returns the face that `e` is incident to (The face lies to the left of `e`). */ Face_handle face(); - /*! + /*! returns the twin halfedge. */ Halfedge_handle twin(); - /*! + /*! returns `e`'s predecessor in the connected component it belongs to. */ Halfedge_handle prev(); - /*! + /*! returns `e`'s successor in the connected component it belongs to. */ Halfedge_handle next(); - /*! + /*! returns a circulator that allows traversing the halfedges of the connected component boundary (CCB) that contains `e`. The circulator is initialized to point to `e`. */ Ccb_halfedge_circulator ccb(); - /*! + /*! returns the \f$ x\f$-monotone curve associated with `e`. \pre `e` is not a fictitious halfedge. */ @@ -287,7 +287,7 @@ public: /// \name Creation /// @{ - /*! + /*! default constructor. */ Face(); @@ -299,7 +299,7 @@ public: /// that return constant handles, iterators or circulators: /// @{ - /*! + /*! returns a Boolean indicating whether this is the fictitious face, which contain the entire arrangement (and does not have an outer CCB). An arrangement that supports only bounded curves does not have a @@ -307,19 +307,19 @@ public: */ bool is_fictitious () const; - /*! + /*! returns a Boolean indicating whether the face is unbounded. */ bool is_unbounded() const; - /*! + /*! returns a Boolean indicating whether the face has an outer CCB. (The fictitious face and the unbounded face of an arrangement that does not have a fictitious face do not have outer CCBs.) */ bool has_outer_ccb() const; - /*! + /*! returns a circulator that enables traversing the outer boundary of `f`. The edges along the CCB are traversed in a counterclockwise direction. @@ -327,24 +327,24 @@ public: */ Ccb_halfedge_circulator outer_ccb(); - /*! + /*! returns an iterator for traversing all the holes (inner CCBs) of `f`. */ Hole_iterator holes_begin(); - /*! + /*! returns a past-the-end iterator for the holes of `f`. */ Hole_iterator holes_end(); - /*! + /*! returns an iterator for traversing all the isolated vertices contained in the interior of `f`. */ Isolated_vertex_iterator isolated_vertices_begin(); - /*! + /*! returns a past-the-end iterator for the isolated vertices contained inside `f`. */ @@ -374,61 +374,61 @@ iterators can be passed as well. /// @{ - /*! + /*! a handle for an arrangement vertex. */ typedef unspecified_type Vertex_handle; - /*! + /*! a handle for a halfedge. The halfedge and its twin form together an arrangement edge. */ typedef unspecified_type Halfedge_handle; - /*! + /*! a handle for an arrangement face. */ typedef unspecified_type Face_handle; - /*! + /*! a bidirectional iterator over the vertices of the arrangement. Its value-type is `Vertex`. */ typedef unspecified_type Vertex_iterator; - /*! + /*! a bidirectional iterator over the halfedges of the arrangement. Its value-type is `Halfedge`. */ typedef unspecified_type Halfedge_iterator; - /*! + /*! a bidirectional iterator over the edges of the arrangement. (That is, it skips every other halfedge.) Its value-type is `Halfedge`. */ typedef unspecified_type Edge_iterator; - /*! + /*! a bidirectional iterator over the faces of arrangement. Its value-type is `Face`. */ typedef unspecified_type Face_iterator; - /*! + /*! a bidirectional iterator over the unbounded faces of arrangement. Its value-type is `Face`. */ typedef unspecified_type Unbounded_face_iterator; - /*! + /*! a bidirectional circulator over the halfedges that have a given vertex as their target. Its value-type is `Halfedge`. */ typedef unspecified_type Halfedge_around_vertex_circulator; - /*! + /*! a bidirectional circulator over the halfedges of a CCB (connected component of the boundary). Its value-type is `Halfedge`. Each @@ -437,14 +437,14 @@ iterators can be passed as well. */ typedef unspecified_type Ccb_halfedge_circulator; - /*! + /*! a bidirectional iterator over the holes (i.e., inner CCBs) contained inside a given face. Its value type is `Ccb_halfedge_circulator`. */ typedef unspecified_type Hole_iterator; - /*! + /*! a bidirectional iterator over the isolated vertices contained inside a given face. Its value type is `Vertex`. @@ -456,18 +456,18 @@ iterators can be passed as well. /// \name Creation /// @{ - /*! + /*! constructs an empty arrangement containing one unbounded face, which corresponds to the entire plane. */ Arrangement_2(); - /*! + /*! copy constructor. */ Arrangement_2(const Self& other); - /*! + /*! constructs an empty arrangement that uses the given `traits` instance for performing the geometric predicates. */ @@ -478,17 +478,17 @@ iterators can be passed as well. /// \name Assignment Methods /// @{ - /*! + /*! assignment operator. */ Self& operator= (other); - /*! + /*! assigns the contents of another arrangement. */ void assign (const Self& other); - /*! + /*! clears the arrangement. */ void clear (); @@ -499,13 +499,13 @@ iterators can be passed as well. /// @{ - /*! + /*! returns the traits object used by the arrangement instance. A `const` version is also available. */ Traits_2* get_traits(); - /*! + /*! determines whether the arrangement is empty (contains only the unbounded face, with no vertices or edges). */ @@ -521,27 +521,27 @@ returning constant iterators instead of mutable ones. */ /// @{ - /*! + /*! returns the number of vertices in the arrangement. */ Size number_of_vertices() const; - /*! + /*! returns the total number of isolated vertices in the arrangement. */ Size number_of_isolated_vertices() const; - /*! + /*! returns the begin-iterator of the vertices in the arrangement. */ Vertex_iterator vertices_begin(); - /*! + /*! returns the past-the-end iterator of the vertices in the arrangement. */ Vertex_iterator vertices_end(); - /*! + /*! returns the number of arrangement vertices that lie at infinity and are not associated with valid points. Such vertices are not considered to be regular arrangement vertices and `arr.number_of_vertices()` @@ -559,33 +559,33 @@ returning constant iterators instead of mutable ones. */ /// @{ - /*! + /*! returns the number of halfedges in the arrangement. */ Size number_of_halfedges() const; - /*! + /*! returns the begin-iterator of the halfedges in the arrangement. */ Halfedge_iterator halfedges_begin(); - /*! + /*! returns the past-the-end iterator of the halfedges in the arrangement. */ Halfedge_iterator halfedges_end(); - /*! + /*! returns the number of edges in the arrangement (equivalent to `arr.number_of_halfedges() / 2`). */ Size number_of_edges() const; - /*! + /*! returns the begin-iterator of the edges in the arrangement. */ Edge_iterator edges_begin(); - /*! + /*! returns the past-the-end iterator of the edges in the arrangement. */ Edge_iterator edges_end(); @@ -600,7 +600,7 @@ returning constant iterators instead of mutable ones. */ /// @{ - /*! + /*! returns a handle for an unbounded face of the arrangement. In case the arrangement comprises only bounded curves, there is a single unbounded face and the function returns a handle to it. Otherwise, a @@ -608,40 +608,40 @@ returning constant iterators instead of mutable ones. */ Face_handle unbounded_face(); - /*! + /*! returns the number of faces in the arrangement. */ Size number_of_faces() const; - /*! + /*! returns the begin-iterator of the faces in the arrangement. */ Face_iterator faces_begin(); - /*! + /*! returns the past-the-end iterator of the faces in the arrangement. */ Face_iterator faces_end(); - /*! + /*! returns the number of unbounded faces in the arrangement. Note `arr.number_of_faces()` also counts the unbounded faces of the arrangement. */ Size number_of_unbounded_faces() const; - /*! + /*! returns the begin-iterator of the unbounded faces in the arrangement. */ Unbounded_face_iterator unbounded_faces_begin(); - /*! + /*! returns the past-the-end iterator of the unbounded faces in the arrangement. */ Unbounded_face_iterator unbounded_faces_end(); - /*! + /*! returns a handle to the fictitious face of the arrangement. If the arrangement is not unbounded, there is no fictitious face. In this case the result is not deterministic. A const @@ -664,17 +664,17 @@ edge, we first need to cast away its "constness". /// @{ - /*! + /*! casts the given constant vertex handle to an equivalent mutable handle. */ Vertex_handle non_const_handle (Vertex_const_handle v); - /*! + /*! casts the given constant halfedge handle to an equivalent mutable handle. */ Halfedge_handle non_const_handle (Halfedge_const_handle e); - /*! + /*! casts the given constant face handle to an equivalent mutable handle. */ Face_handle non_const_handle (Face_const_handle f); @@ -685,7 +685,7 @@ edge, we first need to cast away its "constness". /// @{ - /*! + /*! inserts the point `p` into the arrangement as an isolated vertex in the interior of the face `f` and returns a handle for the newly created vertex. @@ -694,7 +694,7 @@ edge, we first need to cast away its "constness". Vertex_handle insert_in_face_interior (const Point_2& p, Face_handle f); - /*! + /*! inserts the curve `c` that is entirely contained in the interior of a given face `f`. If `c` is a bounded curve two new vertices that correspond to `c`'s endpoints are created and connected with a @@ -712,7 +712,7 @@ edge, we first need to cast away its "constness". (const X_monotone_curve_2& c, Face_handle f); - /*! + /*! inserts the curve `c` into the arrangement, such that its left endpoint corresponds to a given arrangement vertex. As a result, a new vertex that correspond to `c`'s right endpoint is created and @@ -730,7 +730,7 @@ edge, we first need to cast away its "constness". (const X_monotone_curve_2& c, Vertex_handle v); - /*! + /*! inserts the curve `c` into the arrangement, such that its right endpoint corresponds to a given arrangement vertex. As a result, a new vertex that correspond to `c`'s left endpoint is created and @@ -748,7 +748,7 @@ edge, we first need to cast away its "constness". (const X_monotone_curve_2& c, Vertex_handle v); - /*! + /*! inserts the curve `c` into the arrangement, such that both `c`'s endpoints correspond to existing arrangement vertices, given by `v1` and `v2`. The function creates a new halfedge pair that connects the @@ -763,7 +763,7 @@ edge, we first need to cast away its "constness". Vertex_handle v1, Vertex_handle v2); - /*! + /*! inserts an unbounded curve `c` into the arrangement, such that `c` is entirely contained within a single unbounded face of the arrangement. `fict_pred1` specifies the fictitious halfedge that should contain the @@ -780,7 +780,7 @@ edge, we first need to cast away its "constness". Halfedge_handle fict_pred1, Halfedge_handle fict_pred2 = Halfedge_handle()); - /*! + /*! inserts the curve `c` into the arrangement, such that its left endpoint corresponds to a given arrangement vertex. This vertex is the target vertex of the halfedge `pred`, such that `c` is inserted @@ -795,7 +795,7 @@ edge, we first need to cast away its "constness". (const X_monotone_curve_2& c, Halfedge_handle pred); - /*! + /*! inserts an unbounded curve `c` into the arrangement, such that its left endpoint is bounded and corresponds to a given arrangement vertex. This vertex is the target vertex of the halfedge `pred`, such that `c` @@ -814,7 +814,7 @@ edge, we first need to cast away its "constness". Halfedge_handle pred, Halfedge_handle fict_pred); - /*! + /*! inserts the curve `c` into the arrangement, such that its right endpoint corresponds to a given arrangement vertex. This vertex is the target vertex of the halfedge `pred`, such that `c` is inserted @@ -829,7 +829,7 @@ edge, we first need to cast away its "constness". (const X_monotone_curve_2& c, Halfedge_handle pred); - /*! + /*! inserts an unbounded curve `c` into the arrangement, such that its right endpoint is bounded and corresponds to a given arrangement vertex. This vertex is the target vertex of the halfedge `pred`, such that `c` @@ -848,7 +848,7 @@ edge, we first need to cast away its "constness". Halfedge_handle pred, Halfedge_handle fict_pred); - /*! + /*! inserts the curve `c` into the arrangement, such that both `c`'s endpoints correspond to existing arrangement vertices, given by `pred1->target()` and `v2`. The function creates a new halfedge @@ -864,7 +864,7 @@ edge, we first need to cast away its "constness". Halfedge_handle pred1, Vertex_handle v2); - /*! + /*! inserts the curve `c` into the arrangement, such that both `c`'s endpoints correspond to existing arrangement vertices, given by `pred1->target()` and `pred2->target()`. The function creates a @@ -887,7 +887,7 @@ edge, we first need to cast away its "constness". /// @{ - /*! + /*! sets `p` to be the point associated with the vertex `v`. The function returns a handle for the modified vertex (same as `v`). \pre `v` is not a vertex at infinity and `p` is geometrically equivalent to the point currently associated with `v`. @@ -895,14 +895,14 @@ edge, we first need to cast away its "constness". Vertex_handle modify_vertex (Vertex_handle v, const Point_2& p); - /*! + /*! removes the isolated vertex `v` from the arrangement. The function returns the face `f` that used to contain the isolated vertex. \pre `v` is an isolated vertex (has no incident edges). */ Face_handle remove_isolated_vertex (Vertex_handle v); - /*! + /*! sets `c` to be the \f$ x\f$-monotone curve associated with the edge `e`. The function returns a handle for the modified edge (same as `e`). \pre `c` is geometrically equivalent to the curve currently associated with `e`. @@ -910,7 +910,7 @@ edge, we first need to cast away its "constness". Halfedge_handle modify_edge (Halfedge_handle e, const X_monotone_curve_2& c); - /*! + /*! splits the edge `e` into two edges (more precisely, into two halfedge pairs), associated with the given subcurves `c1` and `c2`, and creates a vertex that corresponds to the split point. @@ -922,7 +922,7 @@ edge, we first need to cast away its "constness". const X_monotone_curve_2& c1, const X_monotone_curve_2& c2); - /*! + /*! merges the edges represented by `e1` and `e2` into a single edge, associated with the given merged curve `c`. Denote `e1`'s end-vertices as \f$ u_1\f$ and \f$ v\f$, while `e2`'s @@ -935,7 +935,7 @@ edge, we first need to cast away its "constness". Halfedge_handle e2, const X_monotone_curve_2& c); - /*! + /*! removes the edge `e` from the arrangement. Since the `e` may be the only edge incident to its source vertex (or its target vertex), this vertex can be removed as well. The flags `remove_source` and @@ -954,7 +954,7 @@ edge, we first need to cast away its "constness". /// \name Miscellaneous /// @{ - /*! + /*! returns `true` if `arr` represents a valid instance of `Arrangement_2`. In particular, the functions checks the topological structure of the arrangement and assures that it is valid. In addition, diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h index 85fb0e44cab..3acdae7d73e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/CGAL/Arrangement_with_history_2.h @@ -55,32 +55,32 @@ public: /// @{ -/*! +/*! a private type used as an abbreviation of the `Arrangement_with_history_2` type hereafter. */ typedef Arrangement_with_history_2 Self; -/*! +/*! the traits class in use. */ typedef unspecified_type Traits_2; -/*! +/*! the Dcel representation of the arrangement. */ typedef unspecified_type Dcel; -/*! +/*! the point type, as defined by the traits class. */ typedef typename Traits_2::Point_2 Point_2; -/*! +/*! the \f$ x\f$-monotone curve type, as defined by the traits class. */ typedef typename Traits_2::X_monotone_curve_2 X_monotone_curve_2; -/*! +/*! the curve type, as defined by the traits class. */ typedef typename Traits_2::Curve_2 Curve_2; @@ -96,25 +96,25 @@ In addition, the nested types `Vertex`, `Halfedge` and `Face` are defined, as we /// @{ -/*! +/*! a handle for an input curve. */ typedef unspecified_type Curve_handle; -/*! +/*! a bidirectional iterator over the curves that induce the arrangement. Its value-type is `Curve_2`. */ typedef unspecified_type Curve_iterator; -/*! +/*! an iterator over the edges induced by an input curve. Its value type is `Halfedge_handle`. */ typedef unspecified_type Induced_edge_iterator; -/*! +/*! an iterator for the curves that originate a given arrangement edge. Its value type is `Curve_handle`. */ @@ -125,19 +125,19 @@ typedef unspecified_type Originating_curve_iterator; /// \name Creation /// @{ -/*! +/*! constructs an empty arrangement containing one unbounded face, which corresponds to the whole plane. */ Arrangement_with_history_2(); -/*! +/*! copy constructor. */ Arrangement_with_history_2(const Self& other); -/*! +/*! constructs an empty arrangement that uses the given `traits` instance for performing the geometric predicates. */ @@ -148,17 +148,17 @@ Arrangement_with_history_2(Traits_2 *traits); /// \name Assignment Methods /// @{ -/*! +/*! assignment operator. */ Self& operator= (other); -/*! +/*! assigns the contents of another arrangement. */ void assign (const Self& other); -/*! +/*! clears the arrangement. */ void clear (); @@ -172,50 +172,50 @@ See the `Arrangement_2` reference pages for the full list. /// @{ -/*! +/*! returns the number of input curves that induce the arrangement. */ Size number_of_curves() const; -/*! +/*! returns the begin-iterator of the curves inducing the arrangement. */ Curve_iterator curves_begin(); -/*! +/*! returns the past-the-end iterator of the curves inducing the arrangement. */ Curve_iterator curves_end(); -/*! +/*! returns the number of arrangement edges induced by the curve `ch`. */ Size number_of_induced_edges (Curve_handle ch) const; -/*! +/*! returns the begin-iterator of the edges induced by the curve `ch`. */ Induced_edge_iterator induced_edges_begin (Curve_handle ch) const; -/*! +/*! returns the past-the-end iterator of the edges induced by the curve `ch`. */ Induced_edge_iterator induced_edges_end (Curve_handle ch) const; -/*! +/*! returns the number of input curves that originate the edge `e`. */ Size number_of_originating_curves (Halfedge_handle e) const; -/*! +/*! returns the begin-iterator of the curves originating the edge `e`. */ Originating_curve_iterator originating_curves_begin (Halfedge_handle e) const; -/*! +/*! returns the past-the-end iterator of the curves originating the edge `e`. */ @@ -236,7 +236,7 @@ for modifying arrangement vertices /// @{ -/*! +/*! splits the edge `e` into two edges (more precisely, into two halfedge pairs), at a given split point `p`. The function returns a handle for the halfedge whose source is the same @@ -246,7 +246,7 @@ as `e->source()` and whose target vertex is the split point. Halfedge_handle split_edge (Halfedge_handle e, const Point_2& p); -/*! +/*! merges the edges represented by `e1` and `e2` into a single edge. The function returns a handle for one of the merged halfedges. @@ -255,7 +255,7 @@ The function returns a handle for one of the merged halfedges. Halfedge_handle merge_edge (Halfedge_handle e1, Halfedge_handle e2); -/*! +/*! removes the edge `e` from the arrangement. Since the `e` may be the only edge incident to its source vertex (or its target vertex), this vertex can be removed as well. The flags `remove_source` and diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h index bdbb25c0321..99a57c2cf9b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Approximate_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns an approximation of `p`'s \f$ x\f$-coordinate (if `i == 0`), or of `p`'s \f$ y\f$-coordinate (if `i == 1`). */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h index f176e8da76f..64a975b195a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--AreMergeable_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts two \f$ x\f$-monotone curves `xc1` and `xc2` and determines whether they can be merged to form a single \f$ x\f$-monotone curve. `xc1` and `xc2` are mergeable if their underlying curves are diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h index 052e866809d..b5c727aee88 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXAtLimit_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Given a point `p`, an \f$ x\f$-monotone curve `xcv`, and an enumeration `ce` that specifies either the minimum or the maximum end of the curve where the curve has a vertical asymptote, @@ -35,7 +35,7 @@ Comparison_result operator()(const ArrTraits::Point_2& p, const ArrTraits::X_monotone_curve_2& xcv, Arr_curve_end ce); -/*! +/*! Given two \f$ x\f$-monotone curves `xcv1` and `xcv2` and two indices `ce1` and `ce2` that specify either the minimum or the maximum ends of `xcv1` and `xcv2`, respectively, diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h index 8ace68469a0..e3c56fbeadb 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXNearLimit_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Given two \f$ x\f$-monotone curves `xcv1` and `xcv2` and an enumeration `ce` that specifies either the minimum ends or the maximum ends of the curves where the curves have a vertical diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h index 18bfce34fc9..1cf927c57c5 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareX_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns `SMALLER`, `EQUAL`, or `LARGER` according to the \f$ x\f$-ordering of points `p1` and `p2`. */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h index 0ec0b9072bd..bd348bc85fb 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareXy_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns `SMALLER`, `EQUAL`, or `LARGER` according to the lexicographic \f$ xy\f$-order of the points `p1` and `p2`. */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h index 7d85a4cfe7c..5d06d07c143 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXLeft_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts two \f$ x\f$-monotone curves `xc1` and `xc2` that have a common right endpoint `p`, and returns `SMALLER, EQUAL` or `LARGER` according to the relative position of the two curves immediately to the left of \f$ p\f$. Note that in case one of the diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h index bd46c115c48..fb3d4fa9596 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtXRight_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts two \f$ x\f$-monotone curves `xc1` and `xc2` that have a common left endpoint `p`, and returns `SMALLER, EQUAL` or `LARGER` according to the relative position of the two curves immediately to the right of \f$ p\f$. Note that in case one of the diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h index 8ef6be6b7e1..a2cb53b38ef 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYAtX_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! compares the \f$ y\f$-coordinates of `p` and the vertical projection of `p` on `xc`, and returns `SMALLER`, `EQUAL`, or `LARGER` according to the result. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h index a19f6603d1c..dd7f31a06c7 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--CompareYNearBoundary_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Given two \f$ x\f$-monotone curves `xcv1` and `xcv2` and an enumeration `ce` that specifies either the minimum or the maximum ends of the curves, compares the \f$ y\f$-coordinate of the curves near diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h index ba333f5a07a..b145d3c9163 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMaxVertex_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the lexicographically larger (right) endpoint of `xc`. */ ArrTraits::Point_2 operator()(ArrTraits::X_monotone_curve_2 xc); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h index d6d070628fa..caef26fe71e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructMinVertex_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the lexicographically smaller (left) endpoint of `xc`. */ ArrTraits::Point_2 operator()(ArrTraits::X_monotone_curve_2 xc); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h index e6182552024..0c0597fd01a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ConstructXMonotoneCurve_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns an \f$ x\f$-monotone curve connecting `p1` and `p2` (i.e., the two input points are its endpoints). */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h index f5c7c85db84..dcdcda5577e 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Equal_2.h @@ -16,13 +16,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! determines whether `p1` and `p2` are geometrically equivalent. */ bool operator()(ArrTraits::Point_2 p1, ArrTraits::Point_2 p2); -/*! +/*! determines whether `xc1` and `xc2` are geometrically equivalent (have the same graph). */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h index 505b590ce54..f97f43d645b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Intersect_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes the intersections of `xc1` and `xc2` and inserts them in an ascending lexicographic \f$ xy\f$-order into the output iterator `oi`. The value-type of `Output_iterator` is diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h index c6410e1603c..84ffa9194af 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--IsVertical_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! determines whether `xc` is a vertical segment. */ bool operator()(ArrTraits::X_monotone_curve_2 xc); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h index cb845435153..24b8fb60472 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--MakeXMonotone_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! subdivides the input curve `c` into \f$ x\f$-monotone subcurves and isolated points, and inserts the results into a container through the given output iterator. The value type of `OutputIterator` is diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h index 8ba4b41ca4e..a48b8132e17 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Merge_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts two mergeable \f$ x\f$-monotone curves `xc1` and `xc2` and asigns `xc` with the merged curve. \pre `are_mergeable_2`(`xc1`, `xc2`) is true. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h index 0e497744b10..58934f055f2 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInX_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Given an \f$ x\f$-monotone curve `xcv` and an enumeration `ce` that specifies either the minimum or the maximum end of the curve, diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h index 9508237143d..71343fe93b3 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--ParameterSpaceInY_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Given an \f$ x\f$-monotone curve `xcv` and an enumeration `ce` that specifies either the minimum or the maximum end of the curve, determines the location of the curve end along the \f$ y\f$-dimension. diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h index 9d99297ee0a..50e6850ca7a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrTraits--Split_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts an input curve `xc` and a split point `p` in its interior. It splits `xc` at the split point into two subcurves `xc1` and `xc2`, such that `p` is `xc1`'s right endpoint and diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h index c434c587aca..d65c174a8d0 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementBasicTraits_2.h @@ -56,12 +56,12 @@ public: /// \name Types /// @{ -/*! +/*! models the concept `ArrTraits::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! models the concept `ArrTraits::XMonotoneCurve_2`. */ typedef unspecified_type X_monotone_curve_2; @@ -71,28 +71,28 @@ typedef unspecified_type X_monotone_curve_2; /// \name Categories /// @{ -/*! +/*! indicates whether the nested functor `Compare_at_x_left_2` is provided. */ typedef unspecified_type Has_left_category; -/*! +/*! Must be convertible to `Arr_oblivious_side_tag`. */ typedef unspecified_type Left_side_category; -/*! +/*! Must be convertible to `Arr_oblivious_side_tag`. */ typedef unspecified_type Bottom_side_category; -/*! +/*! Must be convertible to `Arr_oblivious_side_tag`. */ typedef unspecified_type Top_side_category; -/*! +/*! Must be convertible to `Arr_oblivious_side_tag`. */ typedef unspecified_type Right_side_category; @@ -102,49 +102,49 @@ typedef unspecified_type Right_side_category; /// \name Functor Types /// @{ -/*! +/*! models the concept `ArrTraits::CompareX_2`. */ typedef unspecified_type Compare_x_2; -/*! +/*! models the concept `ArrTraits::CompareXy_2`. */ typedef unspecified_type Compare_xy_2; -/*! +/*! models the concept `ArrTraits::ConstructMinVertex_2`. */ typedef unspecified_type Construct_min_vertex_2; -/*! +/*! models the concept `ArrTraits::ConstructMaxVertex_2`. */ typedef unspecified_type Construct_max_vertex_2; -/*! +/*! models the concept `ArrTraits::IsVertical_2`. */ typedef unspecified_type Is_vertical_2; -/*! +/*! models the concept `ArrTraits::CompareYAtX_2`. */ typedef unspecified_type Compare_y_at_x_2; -/*! +/*! models the concept `ArrTraits::CompareYAtXLeft_2`. Required only if the `Has_left_category` category is convertible to `Tag_true`. */ typedef unspecified_type Compare_y_at_x_left_2; -/*! +/*! models the concept `ArrTraits::CompareYAtXRight_2`. */ typedef unspecified_type Compare_y_at_x_right_2; -/*! +/*! models the concept `ArrTraits::Equal_2`. */ typedef unspecified_type Equal_2; @@ -154,47 +154,47 @@ typedef unspecified_type Equal_2; /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Compare_x_2 compare_x_2_object() const; -/*! +/*! */ Compare_xy_2 compare_xy_2_object() const; -/*! +/*! */ Construct_min_vertex_2 construct_min_vertex_2_object() const; -/*! +/*! */ Construct_max_vertex_2 construct_max_vertex_2_object() const; -/*! +/*! */ Is_vertical_2 is_vertical_2_object() const; -/*! +/*! */ Compare_y_at_x_2 compare_y_at_x_2_object() const; -/*! +/*! */ Compare_y_at_x_left_2 compare_y_at_x_left_2_object() const; -/*! +/*! */ Compare_y_at_x_right_2 compare_y_at_x_right_2_object() const; -/*! +/*! */ Equal_2 equal_2_object() const; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h index d5dbe528ebb..8f71879c3c2 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcel.h @@ -39,68 +39,68 @@ public: /// \name Types /// @{ -/*! +/*! the vertex type. */ typedef unspecified_type Vertex; -/*! +/*! the halfedge type. */ typedef unspecified_type Halfedge; -/*! +/*! the face type. */ typedef unspecified_type Face; -/*! +/*! the hole type. */ typedef unspecified_type Hole; -/*! +/*! the isolated vertex type. */ typedef unspecified_type Isolated_vertex; -/*! +/*! used to represent size values (e.g., `size_t`). */ typedef unspecified_type Size; -/*! +/*! a bidirectional iterator over the vertices. Its value-type is `Vertex`. */ typedef unspecified_type Vertex_iterator; -/*! +/*! a bidirectional iterator over the vertices. Its value-type is `Vertex`. */ typedef unspecified_type Vertex_const_iterator; -/*! +/*! a bidirectional iterator over the halfedges. Its value-type is `Halfedge`. */ typedef unspecified_type Halfedge_iterator; -/*! +/*! a bidirectional iterator over the halfedges. Its value-type is `Halfedge`. */ typedef unspecified_type Halfedge_const_iterator; -/*! +/*! a bidirectional iterator over the faces. Its value-type is `Face`. */ typedef unspecified_type Face_iterator; -/*! +/*! a bidirectional iterator over the faces. Its value-type is `Face`. */ typedef unspecified_type Face_const_iterator; @@ -111,12 +111,12 @@ typedef unspecified_type Face_const_iterator; /// \name Creation /// @{ -/*! +/*! constructs an empty Dcel with one unbounded face. */ Arr_dcel(); -/*! +/*! assigns the contents of the `other` Dcel whose unbounded face is given by `uf`, to `dcel`. The function returns a pointer to the unbounded face of `dcel` after the assignment. @@ -128,87 +128,87 @@ Face* assign (const Self& other, const Face *uf); /// \name Access Functions /// @{ -/*! +/*! returns the number of vertices. */ Size size_of_vertices() const; -/*! +/*! returns the number of halfedges (always even). */ Size size_of_halfedges() const; -/*! +/*! returns the number of faces. */ Size size_of_faces() const; -/*! +/*! returns the number of holes (the number of connected components). */ Size size_of_holes() const; -/*! +/*! returns the number of isolated vertices. */ Size size_of_isolated_vertices() const; -/*! +/*! returns a begin-iterator of the vertices in `dcel`. */ Vertex_iterator vertices_begin(); -/*! +/*! returns a past-the-end iterator of the vertices in `dcel`. */ Vertex_iterator vertices_end(); -/*! +/*! returns a begin-iterator of the vertices in `dcel`. */ Vertex_const_iterator vertices_begin() const; -/*! +/*! returns a past-the-end iterator of the vertices in `dcel`. */ Vertex_const_iterator vertices_end() const; -/*! +/*! returns a begin-iterator of the halfedges in `dcel`. */ Halfedge_iterator halfedges_begin(); -/*! +/*! returns a past-the-end iterator of the halfedges in `dcel`. */ Halfedge_iterator halfedges_end(); -/*! +/*! returns a begin-iterator of the halfedges in `dcel`. */ Halfedge_const_iterator halfedges_begin() const; -/*! +/*! returns a past-the-end iterator of the halfedges in `dcel`. */ Halfedge_const_iterator halfedges_end() const; -/*! +/*! returns a begin-iterator of the faces in `dcel`. */ Face_iterator faces_begin(); -/*! +/*! returns a past-the-end iterator of the faces in `dcel`. */ Face_iterator faces_end(); -/*! +/*! returns a begin-iterator of the faces in `dcel`. */ Face_const_iterator faces_begin() const; -/*! +/*! returns a past-the-end iterator of the faces in `dcel`. */ Face_const_iterator faces_end() const; @@ -223,52 +223,52 @@ Face_const_iterator faces_end() const; /// automatically set. /// @{ -/*! +/*! creates a new vertex. */ Vertex* new_vertex(); -/*! +/*! creates a new pair of twin halfedges. */ Halfedge* new_edge(); -/*! +/*! creates a new face. */ Face* new_face(); -/*! +/*! creates a new hole record. */ Hole* new_hole(); -/*! +/*! creates a new isolated vertex record. */ Isolated_vertex* new_isolated_vertex(); -/*! +/*! deletes the vertex `v`. */ void delete_vertex(Vertex* v); -/*! +/*! deletes the halfedge `e` as well as its twin. */ void delete_edge(Halfedge* e); -/*! +/*! deletes the face `f`. */ void delete_face(Face* f); -/*! +/*! deletes the hole `ho`. */ void delete_hole(Hole* ho); -/*! +/*! deletes the isolated vertex `iv`. */ void delete_isolated_vertex(Isolated_vertex* iv); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h index 117ad2da249..697dce33463 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelFace.h @@ -21,23 +21,23 @@ public: /// The non-mutable iterators `Hole_const_iterator`, and `Isolated_vertex_const_iterator` are also defined. /// @{ -/*! +/*! the corresponding Dcel vertex type. */ typedef unspecified_type Vertex; -/*! +/*! the corresponding Dcel halfedge type. */ typedef unspecified_type Halfedge; -/*! +/*! a bidirectional iterator over the holes in inside the face. Its value-type is `Halfedge*`. */ typedef unspecified_type Hole_iterator; -/*! +/*! a bidirectional iterator over the isolated vertices in inside the face. Its value-type is `Vertex*`. */ @@ -48,12 +48,12 @@ typedef unspecified_type Isolated_vertex_iterator; /// \name Creation /// @{ -/*! +/*! default constructor. */ Arr_dcel_face(); -/*! +/*! assigns `f` with the contents of the `other` face. */ void assign (const Self& other); @@ -65,43 +65,43 @@ void assign (const Self& other); /// non-mutable pointers or iterators: /// @{ -/*! +/*! returns whether the face is unbounded. */ bool is_unbounded() const; -/*! +/*! returns an incident halfedge along the outer boundary of the face. If `f` has no outer boundary, the function returns `NULL`. */ Halfedge* halfedge(); -/*! +/*! returns the number of holes inside `f`. */ size_t number_of_holes() const; -/*! +/*! returns a begin-iterator for the holes inside `f`. */ Hole_iterator holes_begin(); -/*! +/*! returns a past-the-end iterator for the holes inside `f`. */ Hole_iterator holes_end(); -/*! +/*! returns the number of isolated vertices inside `f`. */ size_t number_of_isolated_vertices() const; -/*! +/*! returns a begin-iterator for the isolated vertices inside `f`. */ Isolated_vertex_iterator isolated_vertices_begin(); -/*! +/*! returns a past-the-end iterator for the isolated vertices inside `f`. */ @@ -112,33 +112,33 @@ Isolated_vertex_iterator isolated_vertices_end(); /// \name Modifiers /// @{ -/*! +/*! sets the face as unbounded (if `flag` is `true`), or as a bounded face (if it is `false`). */ void set_unbounded (bool flag); -/*! +/*! sets the incident halfedge. */ void set_halfedge (Halfedge* e); -/*! +/*! adds `e` as a hole inside `f`. */ void add_hole (Halfedge* e); -/*! +/*! removes the hole that `it` points to from inside `f`. */ void erase_hole (Hole_iterator it); -/*! +/*! adds `v` as an isolated vertex inside `f`. */ void add_isolated_vertex (Vertex* v); -/*! +/*! removes the isolated vertex that `it` points to from inside `f`. */ void erase_isolated_vertex (Isolated_vertex_iterator it); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h index 66f969c0d25..d5e581284bc 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHalfedge.h @@ -28,22 +28,22 @@ public: /// \name Types /// @{ -/*! +/*! the corresponding Dcel vertex type. */ typedef unspecified_type Vertex; -/*! +/*! the corresponding Dcel face type. */ typedef unspecified_type Face; -/*! +/*! the corresponding Dcel hole type. */ typedef unspecified_type Hole; -/*! +/*! the curve type associated with the edge. */ typedef unspecified_type X_monotone_curve; @@ -53,12 +53,12 @@ typedef unspecified_type X_monotone_curve; /// \name Creation /// @{ -/*! +/*! default constructor. */ Arr_dcel_halfedge(); -/*! +/*! assigns `e` with the contents of the `other` halfedge. */ void assign (const Self& other); @@ -68,7 +68,7 @@ void assign (const Self& other); /// \name Access Functions /// @{ -/*! +/*! returns `ARR_LEFT_TO_RIGHT` if `e`'s source vertex is lexicographically smaller than it target, and `ARR_RIGHT_TO_LEFT` if it is lexicographically larger than @@ -76,7 +76,7 @@ the target. */ Arr_halfedge_direction direction() const; -/*! +/*! determines whether the `e` lies on an outer CCB of a bounded face, or on an inner CCB (a hole inside a face). The function returns `true` if `e` lies on a hole. @@ -89,44 +89,44 @@ bool is_on_hole() const; /// All functions below also have `const` counterparts, returning non-mutable pointers or references: /// @{ -/*! +/*! returns the twin halfedge. */ Halfedge* opposite(); -/*! +/*! returns the previous halfedge along the chain. */ Halfedge* prev(); -/*! +/*! returns the next halfedge along the chain. */ Halfedge* next(); -/*! +/*! returns the target vertex. */ Vertex* vertex(); -/*! +/*! returns the incident face. \pre `e` lies on the outer boundary of this face. */ Face* face(); -/*! +/*! returns the hole (inner CCB) `e` belongs to. \pre `e` lies on a hole inside its incident face. */ Hole* hole(); -/*! +/*! returns whether the vertex is not associated with a valid curve. */ bool has_null_curve() const; -/*! +/*! returns the associated curve. \pre `e` is associated with a valid curve. */ @@ -137,12 +137,12 @@ X_monotone_curve& curve(); /// \name Modifiers /// @{ -/*! +/*! sets the opposite halfedge. */ void set_opposite (Halfedge* opp); -/*! +/*! sets the lexicographical order between `e`'s source and target vertices to be `dir`. The direction of the opposite halfedge is also set to the @@ -150,35 +150,35 @@ opposite direction. */ void set_direction (Arr_halfedge_direction dir); -/*! +/*! sets the previous halfedge of `e` along the chain, and updates the cross-pointer `prev->next()`. */ void set_prev (Halfedge* prev); -/*! +/*! sets the next halfedge of `e` along the chain, and updates the cross-pointer `next->prev()`. */ void set_next (Halfedge* next); -/*! +/*! sets the target vertex. */ void set_vertex (Vertex* v); -/*! +/*! sets the incident face, marking that `e` lies on the outer CCB of the face `f`. */ void set_face (Face* f); -/*! +/*! sets the incident hole, marking that `e` lies on an inner CCB. */ void set_hole (Hole* ho); -/*! +/*! sets the associated curve of `e` and its opposite halfedge. */ void set_curve (X_monotone_curve* c); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h index 625c36dafe6..c20aaf0e1ea 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelHole.h @@ -18,12 +18,12 @@ public: /// \name Types /// @{ -/*! +/*! the corresponding Dcel face type. */ typedef unspecified_type Face; -/*! +/*! */ typedef Face::Hole_iterator Hole_iterator; @@ -33,7 +33,7 @@ typedef Face::Hole_iterator Hole_iterator; /// \name Creation /// @{ -/*! +/*! default constructor. */ Arr_dcel_hole(); @@ -44,12 +44,12 @@ Arr_dcel_hole(); /// All functions below also have `const` counterparts, returning non-mutable pointers or iterators: /// @{ -/*! +/*! returns the incident face, which contains `ho` in its interior. */ Face* face (); -/*! +/*! returns an iterator for the hole. */ Hole_iterator iterator(); @@ -59,12 +59,12 @@ Hole_iterator iterator(); /// \name Modifiers /// @{ -/*! +/*! sets the incident face. */ void set_face (Face* f); -/*! +/*! sets the hole iterator. */ void set_iterator (Hole_iterator it); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h index a3ab483e44d..045be05776a 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelIsolatedVertex.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! the corresponding Dcel face type. */ typedef unspecified_type Face; -/*! +/*! */ typedef Face::Isolated_vertex_iterator Isolated_vertex_iterator; @@ -34,7 +34,7 @@ typedef Face::Isolated_vertex_iterator Isolated_vertex_iterator; /// \name Creation /// @{ -/*! +/*! default constructor. */ Arr_dcel_isolated_vertex(); @@ -46,12 +46,12 @@ Arr_dcel_isolated_vertex(); /// non-mutable pointers or iterators: /// @{ -/*! +/*! returns the incident face, which contains `iv` in its interior. */ Face* face (); -/*! +/*! returns an iterator for the isolated vertex. */ Isolated_vertex_iterator iterator(); @@ -61,12 +61,12 @@ Isolated_vertex_iterator iterator(); /// \name Modifiers /// @{ -/*! +/*! sets the incident face. */ void set_face (Face* f); -/*! +/*! sets the isolated vertex iterator. */ void set_iterator (Isolated_vertex_iterator it); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h index a4827e9f4b8..1dfbfcfe5df 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelVertex.h @@ -26,18 +26,18 @@ public: /// \name Types /// @{ -/*! +/*! the corresponding Dcel halfedge type. */ typedef unspecified_type Halfedge; -/*! +/*! the corresponding Dcel isolated vertex-information type. */ typedef unspecified_type Isolated_vertex; -/*! +/*! the point type associated with the vertex. */ typedef unspecified_type Point; @@ -47,12 +47,12 @@ typedef unspecified_type Point; /// \name Creation /// @{ -/*! +/*! default constructor. */ Arr_dcel_vertex(); -/*! +/*! assigns `v` with the contents of the `other` vertex. */ void assign (const Self& other); @@ -64,43 +64,43 @@ void assign (const Self& other); /// non-mutable pointers or references: /// @{ -/*! +/*! returns whether the vertex is isolated (has no incident halfedges). */ bool is_isolated() const; -/*! +/*! returns an incident halfedge that has `v` as its target. \pre `v` is not an isolated vertex. */ Halfedge* halfedge(); -/*! +/*! returns the isolated vertex-information record. \pre `v` is an isolated vertex. */ Isolated_vertex* isolated_vertex(); -/*! +/*! returns whether the vertex is not associated with a valid point (i.e.\ it lies at infinity). */ bool has_null_point () const; -/*! +/*! returns the associated point. \pre `v`() is associated with a valid point. */ Point& point(); -/*! +/*! returns the placement of the \f$ x\f$-coordinate in the parameter space, that is, either the left boundary-side, the interior, or the right boundary-side. */ Arr_parameter_space parameter_space_in_x () const; -/*! +/*! returns the placement of the \f$ y\f$-coordinate in the parameter space, that is, either the bottom boundary-side, the interior, or the top boundary-side. @@ -112,23 +112,23 @@ Arr_parameter_space parameter_space_in_y () const; /// \name Modifiers /// @{ -/*! +/*! sets the incident halfedge, marking `v` as a regular vertex. */ void set_halfedge (Halfedge* e); -/*! +/*! sets the isolated vertex-information record, marking `v` as an isolated vertex. */ void set_isolated_vertex (Isolated_vertex* iv); -/*! +/*! sets the associated point. */ void set_point (Point* p); -/*! +/*! sets `v` as a vertex on a boundary side. \pre Either `inf_x` or `inf_y` is not `ARR_INTERIOR`. */ diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h index eeabb49d759..392bc80c412 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementDcelWithRebind.h @@ -22,7 +22,7 @@ public: /// \name Types /// @{ -/*! +/*! allows the instantiation of a model of the base concept `ArrangementDcel` with a different possible geometry-traits class without ad-hoc limitations on it. @@ -38,7 +38,7 @@ typedef unspecified_type template rebind; /// \name Creation /// @{ -/*! +/*! constructs an empty Dcel with one unbouned face. */ Arr_dcel(); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h index c3c033aca92..fac833d4a6c 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementInputFormatter.h @@ -18,37 +18,37 @@ public: /// \name Types /// @{ -/*! +/*! the type of arrangement to input. */ typedef unspecified_type Arrangement_2; -/*! +/*! the point type. */ typedef typename Arrangement_2::Point_2 Point_2; -/*! +/*! the \f$ x\f$-monotone curve type. */ typedef typename Arrangement_2::X_monotone_curve_2 X_monotone_curve_2; -/*! +/*! */ typedef typename Arrangement_2::Size Size; -/*! +/*! */ typedef typename Arrangement_2::Vertex_handle Vertex_handle; -/*! +/*! */ typedef typename Arrangement_2::Halfedge_handle Halfedge_handle; -/*! +/*! */ typedef typename Arrangement_2::Face_handle Face_handle; @@ -58,17 +58,17 @@ typedef typename Arrangement_2::Face_handle Face_handle; /// \name Creation /// @{ -/*! +/*! default constructor. */ Arr_in_formatter(); -/*! +/*! constructs a formatter that reads from `is`. */ Arr_in_formatter (std::istream& is); -/*! +/*! directs `inf` to read from `is`. */ void set_in (std::istream& is); @@ -78,7 +78,7 @@ void set_in (std::istream& is); /// \name Access Functions /// @{ -/*! +/*! returns the stream that `inf` reads from. \pre `inf` is directed to a valid output stream. */ @@ -89,166 +89,166 @@ std::istream& in (); /// \name Formatted Input Functions /// @{ -/*! +/*! reads a message indicating the beginning of the arrangement. */ void read_arrangement_begin (); -/*! +/*! reads a message indicating the end of the arrangement. */ void read_arrangement_end (); -/*! +/*! reads a size value, which is supposed to be preceded by the given label. */ Size read_size (const char *label = NULL); -/*! +/*! reads a message indicating the beginning of the vertex records. */ void read_vertices_begin(); -/*! +/*! reads a message indicating the end of the vertex records. */ void read_vertices_end(); -/*! +/*! reads a message indicating the beginning of the edge records. */ void read_edges_begin(); -/*! +/*! reads a message indicating the end of the edge records. */ void read_edges_end(); -/*! +/*! reads a message indicating the beginning of the face records. */ void read_faces_begin(); -/*! +/*! reads a message indicating the end of the face records. */ void read_faces_end(); -/*! +/*! reads a message indicating the beginning of a single vertex record. */ void read_vertex_begin(); -/*! +/*! reads a message indicating the end of a single vertex record. */ void read_vertex_end(); -/*! +/*! reads and returns a vertex index. */ std::size_t read_vertex_index (); -/*! +/*! reads a point. */ void read_point (Point_2& p); -/*! +/*! reads an auxiliary vertex-data object and associates it with the vertex `v`. */ void read_vertex_data (Vertex_handle v); -/*! +/*! reads a message indicating the beginning of a single edge record. */ void read_edge_begin(); -/*! +/*! reads a message indicating the end of a single edge record. */ void read_edge_end(); -/*! +/*! reads and returns halfedge index. */ std::size_t read_halfedge_index (); -/*! +/*! reads an \f$ x\f$-monotone curve. */ void read_x_monotone_curve (X_monotone_curve_2& c); -/*! +/*! reads an auxiliary halfedge-data object and associates it with the halfedge `he`. */ void read_halfegde_data (Halfedge_handle he); -/*! +/*! reads a message indicating the beginning of a single face record. */ void read_face_begin(); -/*! +/*! reads a message indicating the end of a single face record. */ void read_face_end(); -/*! +/*! reads a message indicating the beginning of the outer CCB of the current face. */ void read_outer_ccb_begin(); -/*! +/*! reads a message indicating the end of the outer CCB of the current face. */ void read_outer_ccb_end(); -/*! +/*! reads a message indicating the beginning of the container of holes inside the current face. */ void read_holes_begin(); -/*! +/*! reads a message indicating the end of the container of holes inside the current face. */ void read_holes_end(); -/*! +/*! reads a message indicating the beginning of an inner CCB of the current face. */ void read_inner_ccb_begin(); -/*! +/*! reads a message indicating the end of an inner CCB of the current face. */ void read_inner_ccb_end(); -/*! +/*! reads a message indicating the beginning a connected component boundary. */ void read_ccb_halfedges_begin(); -/*! +/*! reads a message indicating the end of a connected component boundary. */ void read_ccb_halfedges_end(); -/*! +/*! reads a message indicating the beginning of the container of isolated vertices inside the current face. */ void read_isolated_vertices_begin(); -/*! +/*! reads a message indicating the end of the container of isolated vertices inside the current face. */ void read_isolated_vertices_end(); -/*! +/*! reads an auxiliary face-data object and associates it with the face `f`. */ void read_face_data (Face_handle f); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h index 5d034c35510..05d9a064083 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementLandmarkTraits_2.h @@ -31,7 +31,7 @@ public: /// \name Types /// @{ -/*! +/*! the number type used to approximate point coordinates. */ typedef unspecified_type Approximate_number_type; @@ -41,12 +41,12 @@ typedef unspecified_type Approximate_number_type; /// \name Functor Types /// @{ -/*! +/*! models the concept `ArrTraits::Approximate_2`. */ typedef unspecified_type Approximate_2; -/*! +/*! models the concept `ArrTraits::ConstructXMonotoneCurve_2`. */ typedef unspecified_type Construct_x_monotone_curve_2; @@ -56,12 +56,12 @@ typedef unspecified_type Construct_x_monotone_curve_2; /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Approximate_2 approximate_2_object() const; -/*! +/*! */ Construct_x_monotone_curve_2 diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h index aa5d005ce2d..fea2dc64c78 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOpenBoundaryTraits_2.h @@ -57,25 +57,25 @@ public: /// \name Categories /// @{ -/*! +/*! Must be convertible to either `Arr_oblivious_side_tag` or `Arr_open_side_tag`. */ typedef unspecified_type Left_side_category; -/*! +/*! Must be convertible to either `Arr_oblivious_side_tag` or `Arr_open_side_tag`. */ typedef unspecified_type Bottom_side_category; -/*! +/*! Must be convertible to either `Arr_oblivious_side_tag` or `Arr_open_side_tag`. */ typedef unspecified_type Top_side_category; -/*! +/*! Must be convertible to either `Arr_oblivious_side_tag` or `Arr_open_side_tag`. */ @@ -86,7 +86,7 @@ typedef unspecified_type Right_side_category; /// \name Functor Types /// @{ -/*! +/*! models the concept `ArrTraits::ParameterSpaceInX_2`. Required only if the traits class supports unbounded curves that approach the left or the right sides (the `Left_side_category` @@ -95,7 +95,7 @@ or the `Right_side_category` categories are convertible to */ typedef unspecified_type Parameter_space_in_x_2; -/*! +/*! models the concept `ArrTraits::CompareYNearBoundary_2`. Required only if the traits class supports unbounded curves that approach the left or the right sides (the `Left_side_category` @@ -104,7 +104,7 @@ or the `Right_side_category` categories are convertible to */ typedef unspecified_type Compare_y_near_boundary_2; -/*! +/*! models the concept `ArrTraits::ParameterSpaceInY_2`. Required only if the traits class supports unbounded curves that approach the bottom or the top sides (the `Bottom_side_category` @@ -113,7 +113,7 @@ or the `Top_side_category` categories are convertible to */ typedef unspecified_type Parameter_space_in_y_2; -/*! +/*! models the concept `ArrTraits::CompareXAtLimit_2`. Required only if the traits class supports unbounded curves that approach the bottom or the top sides (the `Bottom_side_category` @@ -122,7 +122,7 @@ or the `Top_side_category` categories are convertible to */ typedef unspecified_type Compare_x_at_limit_2; -/*! +/*! models the concept `ArrTraits::CompareXNearLimit_2`. Required only if the traits class supports unbounded curves that approach the bottom or the top sides (the `Bottom_side_category` @@ -136,27 +136,27 @@ typedef unspecified_type Compare_x_near_limit_2; /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Parameter_space_in_x_2 parameter_space_in_x_2_object() const; -/*! +/*! */ Compare_y_near_boundary_2 compare_y_near_boundary_2_object() const; -/*! +/*! */ Parameter_space_in_y_2 parameter_space_in_y_2_object() const; -/*! +/*! */ Compare_x_at_limit_2 compare_x_at_limit_2_object() const; -/*! +/*! */ Compare_x_near_limit_2 compare_x_near_limit_2_object() const; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h index 89233432428..92649fbb1a1 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementOutputFormatter.h @@ -18,37 +18,37 @@ public: /// \name Types /// @{ -/*! +/*! the type of arrangement to output. */ typedef unspecified_type Arrangement_2; -/*! +/*! the point type. */ typedef typename Arrangement_2::Point_2 Point_2; -/*! +/*! the \f$ x\f$-monotone curve type. */ typedef typename Arrangement_2::X_monotone_curve_2 X_monotone_curve_2; -/*! +/*! */ typedef typename Arrangement_2::Size Size; -/*! +/*! */ typedef typename Arrangement_2::Vertex_const_handle Vertex_const_handle; -/*! +/*! */ typedef typename Arrangement_2::Halfedge_const_handle Halfedge_const_handle; -/*! +/*! */ typedef typename Arrangement_2::Face_const_handle Face_const_handle; @@ -58,17 +58,17 @@ typedef typename Arrangement_2::Face_const_handle Face_const_handle; /// \name Creation /// @{ -/*! +/*! default constructor. */ Arr_out_formatter(); -/*! +/*! constructs a formatter that writes to `os`. */ Arr_out_formatter (std::ostream& os); -/*! +/*! directs `outf` to write to `os`. */ void set_out (std::ostream& os); @@ -78,7 +78,7 @@ void set_out (std::ostream& os); /// \name Access Functions /// @{ -/*! +/*! returns the stream that `outf` writes to. \pre `outf` is directed to a valid output stream. */ @@ -89,156 +89,156 @@ std::ostream& out (); /// \name Formatted Output Functions /// @{ -/*! +/*! writes a message indicating the beginning of the arrangement. */ void write_arrangement_begin (); -/*! +/*! writes a message indicating the end of the arrangement. */ void write_arrangement_end (); -/*! +/*! writes a size value, preceded by a given label. */ void write_size (const char *label, Size size); -/*! +/*! writes a message indicating the beginning of the vertex records. */ void write_vertices_begin(); -/*! +/*! writes a message indicating the end of the vertex records. */ void write_vertices_end(); -/*! +/*! writes a message indicating the beginning of the edge records. */ void write_edges_begin(); -/*! +/*! writes a message indicating the end of the edge records. */ void write_edges_end(); -/*! +/*! writes a message indicating the beginning of the face records. */ void write_faces_begin(); -/*! +/*! writes a message indicating the end of the face records. */ void write_faces_end(); -/*! +/*! writes a message indicating the beginning of a single vertex record. */ void write_vertex_begin(); -/*! +/*! writes a message indicating the end of a single vertex record. */ void write_vertex_end(); -/*! +/*! writes a vertex index. */ void write_vertex_index (std::size_t idx); -/*! +/*! writes a point. */ void write_point (const Point_2& p); -/*! +/*! writes the auxiliary data associated with the vertex. */ void write_vertex_data (Vertex_const_handle v); -/*! +/*! writes a message indicating the beginning of a single edge record. */ void write_edge_begin(); -/*! +/*! writes a message indicating the end of a single edge record. */ void write_edge_end(); -/*! +/*! writes a halfedge index. */ void write_halfedge_index (std::size_t idx); -/*! +/*! writes an \f$ x\f$-monotone curve. */ void write_x_monotone_curve (const X_monotone_curve_2& c); -/*! +/*! writes the auxiliary data associated with the halfedge. */ void write_halfegde_data (Halfedge_const_handle he); -/*! +/*! writes a message indicating the beginning of a single face record. */ void write_face_begin(); -/*! +/*! writes a message indicating the end of a single face record. */ void write_face_end(); -/*! +/*! writes a message indicating the beginning of the outer CCB of the current face. */ void write_outer_ccb_begin(); -/*! +/*! writes a message indicating the end of the outer CCB of the current face. */ void write_outer_ccb_end(); -/*! +/*! writes a message indicating the beginning of the container of holes inside the current face. */ void write_holes_begin(); -/*! +/*! writes a message indicating the end of the container of holes inside the current face. */ void write_holes_end(); -/*! +/*! writes a message indicating the beginning a connected component's boundary. */ void write_ccb_halfedges_begin(); -/*! +/*! writes a message indicating the end of a connected component's boundary. */ void write_ccb_halfedges_end(); -/*! +/*! writes a message indicating the beginning of the container of isolated vertices inside the current face. */ void write_isolated_vertices_begin(); -/*! +/*! writes a message indicating the end of the container of isolated vertices inside the current face. */ void write_isolated_vertices_end(); -/*! +/*! writes the auxiliary data associated with the face. */ void write_face_data (Face_const_handle f); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h index d2edbf2ebef..0f65bb06b1d 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementPointLocation_2.h @@ -40,12 +40,12 @@ public: /// \name Types /// @{ -/*! +/*! the associated arrangement type. */ typedef unspecified_type Arrangement_2; -/*! +/*! equivalent to `Arrangement_2::Point_2`. */ typedef unspecified_type Point_2; @@ -55,12 +55,12 @@ typedef unspecified_type Point_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ ArrangementPointLocation_2(); -/*! +/*! constructs a point-location object `pl` attached to the given arrangement `arr`. */ @@ -71,7 +71,7 @@ ArrangementPointLocation_2 (const Arrangement_2& arr); /// \name Query Functions /// @{ -/*! +/*! locates the arrangement cell that contains the query point `q` and returns a discriminated union container of the following bounded types: @@ -93,12 +93,12 @@ Arr_point_location_result::Type locate(const Point_2& q) const; /// \name Operations /// @{ -/*! +/*! attaches `pl` to the given arrangement `arr`. */ void attach (const Arrangement_2& arr); -/*! +/*! detaches `pl` from the arrangement it is currently attached to. */ void detach (); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h index 6d2fff72f29..1c13c6a227b 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementTraits_2.h @@ -57,7 +57,7 @@ public: /// \name Types /// @{ -/*! +/*! models the concept `ArrTraits::Curve_2`. */ typedef unspecified_type Curve_2; @@ -67,7 +67,7 @@ typedef unspecified_type Curve_2; /// \name Functor Types /// @{ -/*! +/*! models the concept `ArrTraits::MakeXMonotone_2`. */ typedef unspecified_type Make_x_monotone_2; @@ -77,7 +77,7 @@ typedef unspecified_type Make_x_monotone_2; /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Make_x_monotone_2 make_x_monotone_2_object() const; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h index bfa48209ab9..27d65a12c7f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementVerticalRayShoot_2.h @@ -47,12 +47,12 @@ public: /// \name Types /// @{ -/*! +/*! the associated arrangement type. */ typedef unspecified_type Arrangement_2; -/*! +/*! equivalent to `Arrangement_2::Point_2`. */ typedef unspecified_type Point_2; @@ -62,12 +62,12 @@ typedef unspecified_type Point_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ ArrangementVerticalRayShoot_2(); -/*! +/*! constructs a ray-shooting object `rs` attached to the given arrangement `arr`. */ @@ -78,7 +78,7 @@ ArrangementVerticalRayShoot_2 (const Arrangement_2& arr); /// \name Query Functions /// @{ -/*! +/*! locates the arrangement feature that is first hit by an upward-directed vertical ray emanating from the query point `q`, and returns a handle for this feature. The function returns a @@ -96,7 +96,7 @@ arrangement. */ Arr_point_location_result::Type ray_shoot_up(const Point_2& q) const; -/*! +/*! locates the arrangement feature that is first hit by a downward-directed vertical ray emanating from the query point `q`, and returns a handle for this feature. The function returns a @@ -119,12 +119,12 @@ Arr_point_location_result::Type ray_shoot_down (const Point_2& q) /// \name Operations /// @{ -/*! +/*! attaches `rs` to the given arrangement `arr`. */ void attach (const Arrangement_2& arr); -/*! +/*! detaches `rs` from the arrangement it is currently attached to. */ void detach (); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h index 4e0141c412f..aae65845714 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryInputFormatter.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! the type of arrangement to input. */ typedef unspecified_type Arr_with_history_2; -/*! +/*! the inducing curve type. */ typedef typename Arrangement_2::Curve_2 Curve_2; @@ -34,38 +34,38 @@ typedef typename Arrangement_2::Curve_2 Curve_2; /// \name Formatted Input Functions /// @{ -/*! +/*! reads a message indicating the beginning of the inducing curves. */ void read_curves_begin(); -/*! +/*! reads a message indicating the end of the inducing curves. */ void read_curves_end(); -/*! +/*! reads a message indicating the beginning of a single curve record. */ void read_curve_begin(); -/*! +/*! reads a message indicating the end of a single curve record. */ void read_curve_end(); -/*! +/*! reads a curve. */ void read_curve (Curve_2& c); -/*! +/*! reads a message indicating the beginning of the set of edges induced by the current curve. */ void read_induced_edges_begin(); -/*! +/*! reads a message indicating the end of the induced edges set. */ void read_induced_edges_end(); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h index 68959f80e45..ab2de7d7468 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementWithHistoryOutputFormatter.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! the type of arrangement to output. */ typedef unspecified_type Arr_with_history_2; -/*! +/*! the inducing curve type. */ typedef typename Arrangement_2::Curve_2 Curve_2; @@ -34,38 +34,38 @@ typedef typename Arrangement_2::Curve_2 Curve_2; /// \name Formatted Output Functions /// @{ -/*! +/*! writes a message indicating the beginning of the inducing curves. */ void write_curves_begin(); -/*! +/*! writes a message indicating the end of the inducing curves. */ void write_curves_end(); -/*! +/*! writes a message indicating the beginning of a single curve record. */ void write_curve_begin(); -/*! +/*! writes a message indicating the end of a single curve record. */ void write_curve_end(); -/*! +/*! writes a curve. */ void write_curve (const Curve_2& c); -/*! +/*! writes a message indicating the beginning of the set of edges induced by the current curve. */ void write_induced_edges_begin(); -/*! +/*! writes a message indicating the end of the induced edges set. */ void write_induced_edges_end(); diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h index 3c8e599f5f2..10997c95a5f 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/ArrangementXMonotoneTraits_2.h @@ -43,7 +43,7 @@ public: /// \name Types /// @{ -/*! +/*! the multiplicity type. */ typedef unspecified_type Multiplicity; @@ -53,7 +53,7 @@ typedef unspecified_type Multiplicity; /// \name Tags /// @{ -/*! +/*! indicates whether the nested functors `Are_mergeable_2` and `Merge_2` are provided. */ @@ -64,12 +64,12 @@ typedef unspecified_type Has_merge_category; /// \name Functor Types /// @{ -/*! +/*! models the concept `ArrTraits::Intersect_2`. */ typedef unspecified_type Intersect_2; -/*! +/*! models the concept `ArrTraits::Split_2`. */ typedef unspecified_type Split_2; @@ -82,7 +82,7 @@ typedef unspecified_type Split_2; /// should be defined as `Tag_true` (and `Tag_false` otherwise. /// @{ -/*! +/*! models the concept `ArrTraits::AreMergeable_2`. @@ -90,7 +90,7 @@ models the concept `ArrTraits::AreMergeable_2`. */ typedef unspecified_type Are_mergeable_2; -/*! +/*! models the concept `ArrTraits::Merge_2`. */ typedef unspecified_type Merge_2; @@ -100,12 +100,12 @@ typedef unspecified_type Merge_2; /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Intersect_2 intersect_2_object() const; -/*! +/*! */ Split_2 split_2_object() const; @@ -118,12 +118,12 @@ Split_2 split_2_object() const; /// `Tag_false` otherwise. /// @{ -/*! +/*! */ Are_mergeable_2 are_mergeable_2_object() const; -/*! +/*! */ Merge_2 merge_2_object() const; diff --git a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h index 0a5dbe93c75..ae1ebbfded0 100644 --- a/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h +++ b/Arrangement_on_surface_2/doc/Arrangement_on_surface_2/Concepts/OverlayTraits.h @@ -24,47 +24,47 @@ public: /// \name Types /// @{ -/*! +/*! a constant handle a vertex in `Dcel_A`. */ typedef unspecified_type Vertex_handle_A; -/*! +/*! a constant handle to a halfedge in `Dcel_A`. */ typedef unspecified_type Halfedge_handle_A; -/*! +/*! a constant handle to a face `Dcel_A`. */ typedef unspecified_type Face_handle_A; -/*! +/*! a constant handle to a vertex in `Dcel_B`. */ typedef unspecified_type Vertex_handle_B; -/*! +/*! a constant handle to a halfedge in `Dcel_B`. */ typedef unspecified_type Halfedge_handle_B; -/*! +/*! a constant handle to a face in `Dcel_B`. */ typedef unspecified_type Face_handle_B; -/*! +/*! a handle to a vertex in `Dcel_R`. */ typedef unspecified_type Vertex_handle_R; -/*! +/*! a handle to a halfedge in `Dcel_R`. */ typedef unspecified_type Halfedge_handle_R; -/*! +/*! a handle to a faces in `Dcel_R`. */ typedef unspecified_type Face_handle_R; @@ -77,7 +77,7 @@ typedef unspecified_type Face_handle_R; /// appropriate auxiliary data to this vertex: /// @{ -/*! +/*! constructs the vertex `v` induced by the coinciding vertices `v1` and `v2`. */ @@ -85,7 +85,7 @@ void create_vertex (Vertex_handle_A v1, Vertex_handle_B v2, Vertex_handle_R v) const; -/*! +/*! constructs the vertex `v` induced by the vertex `v1` that lies on the halfedge `e2`. */ @@ -93,7 +93,7 @@ void create_vertex (Vertex_handle_A v1, Halfedge_handle_B e2, Vertex_handle_R v) const; -/*! +/*! constructs the vertex `v` induced by the vertex `v1` that lies inside the face `f2`. */ @@ -101,7 +101,7 @@ void create_vertex (Vertex_handle_A v1, Face_handle_B f2, Vertex_handle_R v) const; -/*! +/*! constructs the vertex `v` induced by the vertex `v2` that lies on the halfedge `e1`. */ @@ -109,7 +109,7 @@ void create_vertex (Halfedge_handle_A e1, Vertex_handle_B v2, Vertex_handle_R v) const; -/*! +/*! constructs the vertex `v` induced by the vertex `v2` that lies inside the face `f1`. */ @@ -117,7 +117,7 @@ void create_vertex (Face_handle_A f1, Vertex_handle_B v2, Vertex_handle_R v) const; -/*! +/*! constructs the vertex `v` induced by the intersection of the halfedges `e1` and `e2`. */ @@ -138,7 +138,7 @@ Vertex_handle_R v) const; /// halfedge (namely to `e->twin()`) as well: /// @{ -/*! +/*! constructs the halfedge `e` induced by an overlap between the halfedges `e1` and `e2`. */ @@ -146,7 +146,7 @@ void create_edge (Halfedge_handle_A e1, Halfedge_handle_B e2, Halfedge_handle_R e) const; -/*! +/*! constructs the halfedge `e` induced by the halfedge `e1` that lies inside the face `f2`. */ @@ -154,7 +154,7 @@ void create_edge (Halfedge_handle_A e1, Face_handle_B f2, Halfedge_handle_R e) const; -/*! +/*! constructs the halfedge `e` induced by the halfedge `e2` that lies inside the face `f1`. */ @@ -169,7 +169,7 @@ Halfedge_handle_R e) const; /// fields attached to them: /// @{ -/*! +/*! constructs the face `f` induced by the an overlap between the faces `f1` and `f2`. */ diff --git a/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h b/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h index e9be34c2afb..446481b9fc4 100644 --- a/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h +++ b/BGL/doc/BGL/CGAL/HalfedgeDS_face_max_base_with_id.h @@ -40,17 +40,17 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ HalfedgeDS_face_max_base_with_id(); -/*! +/*! Returns the index. */ int id() const; -/*! +/*! Returns a reference to the index stored in the face. */ int& id(); diff --git a/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h b/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h index 9ab99905dd0..6e597c7d346 100644 --- a/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h +++ b/BGL/doc/BGL/CGAL/HalfedgeDS_halfedge_max_base_with_id.h @@ -38,17 +38,17 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ HalfedgeDS_halfedge_max_base_with_id(); -/*! +/*! Returns the index. */ int id() const; -/*! +/*! Returns a reference to the index stored in the halfedge. */ int& id(); diff --git a/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h b/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h index 34c50e829a6..0839d254c8f 100644 --- a/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h +++ b/BGL/doc/BGL/CGAL/HalfedgeDS_vertex_max_base_with_id.h @@ -38,17 +38,17 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ HalfedgeDS_vertex_max_base_with_id(); -/*! +/*! Returns the index. */ int id() const; -/*! +/*! Returns a reference to the index stored in the vertex. */ int& id(); diff --git a/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h b/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h index 710955ad5c0..ba285cb023e 100644 --- a/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h +++ b/BGL/doc/BGL/CGAL/Polyhedron_items_with_id_3.h @@ -53,7 +53,7 @@ public: /// \name Creation /// @{ - /*! + /*! %Default constructor. */ Polyhedron_items_with_id_3(); diff --git a/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h b/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h index b26de953059..9af6d7ffaa9 100644 --- a/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h +++ b/BGL/doc/BGL/CGAL/Triangulation_vertex_base_with_id_2.h @@ -29,12 +29,12 @@ public: /// \name Access Functions /// @{ -/*! +/*! Returns the index. */ int id() const; -/*! +/*! Returns a reference to the index stored in the vertex. */ int& id(); diff --git a/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Arrangement_2.h b/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Arrangement_2.h index 98903f2b834..1b4cb4ca6a4 100644 --- a/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Arrangement_2.h +++ b/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Arrangement_2.h @@ -22,17 +22,17 @@ public: /// \name Types /// @{ -/*! +/*! The vertex descriptor. */ typename CGAL::Arrangement_2::Vertex_handle vertex_descriptor; -/*! +/*! The edge descriptor. */ typename CGAL::Arrangement_2::Halfedge_handle edge_descriptor; -/*! +/*! An iterator corresponding to `CGAL::Arrangement_2::Vertex_iterator`, with the difference that its value type is a vertex descriptor and not @@ -40,7 +40,7 @@ with the difference that its value type is a vertex descriptor and not */ typedef unspecified_type vertex_iterator; -/*! +/*! An iterator corresponding to `CGAL::Arrangement_2::Halfedge_iterator` with the difference that its value type is an edge descriptor and not @@ -48,7 +48,7 @@ with the difference that its value type is an edge descriptor and not */ typedef unspecified_type edge_iterator; -/*! +/*! An edge iterator which only iterates over the incoming edges around a vertex. It corresponds to a `CGAL::Arrangement_2::Halfedge_around_vertex_circulator` @@ -57,7 +57,7 @@ with the difference that its value type is an edge descriptor and not */ typedef unspecified_type in_edge_iterator; -/*! +/*! An edge iterator which only iterates over the outgoing halfedges around a vertex. It corresponds to a `CGAL::Arrangement_2::Halfedge_around_vertex_circulator` @@ -66,27 +66,27 @@ with the difference that its value type is an edge descriptor and not */ typedef unspecified_type out_edge_iterator; -/*! +/*! Indicates that this graph does support multiedges. */ boost::disallow_parallel_edge_tag edge_parallel_category; -/*! +/*! Indicates that this graph is bidirectional. */ boost::bidirectional_graph_tag traversal_category; -/*! +/*! The size type of the vertex list. */ typename Arrangement_2::size_type vertices_size_type; -/*! +/*! The size type of the edge list. */ typename Arrangement_2::size_type edges_size_type; -/*! +/*! The size type of the adjacency list. */ typename Arrangement_2::size_type degree_size_type; diff --git a/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Polyhedron_3.h b/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Polyhedron_3.h index ce2c3800c88..0272c3fff63 100644 --- a/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Polyhedron_3.h +++ b/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Polyhedron_3.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! The vertex descriptor. */ typename CGAL::Polyhedron_3::Vertex_handle vertex_descriptor; -/*! +/*! The edge descriptor. */ typename CGAL::Polyhedron_3::Halfedge_handle edge_descriptor; -/*! +/*! An iterator corresponding to `CGAL::Polyhedron_3::Vertex_iterator`, with the difference that its value type is a vertex descriptor and not @@ -39,7 +39,7 @@ with the difference that its value type is a vertex descriptor and not */ typedef unspecified_type vertex_iterator; -/*! +/*! An iterator corresponding to `CGAL::Polyhedron_3::Halfedge_iterator` with the difference that its value type is an edge descriptor and not @@ -47,7 +47,7 @@ with the difference that its value type is an edge descriptor and not */ typedef unspecified_type edge_iterator; -/*! +/*! An edge iterator which only iterates over the incoming edges around a vertex. It corresponds to a `CGAL::Polyhedron_3::Halfedge_around_vertex_circulator` @@ -56,7 +56,7 @@ with the difference that its value type is an edge descriptor and not */ typedef unspecified_type in_edge_iterator; -/*! +/*! An edge iterator which only iterates over the outgoing halfedges around a vertex. It corresponds to a `CGAL::Polyhedron_3::Halfedge_around_vertex_circulator` @@ -65,27 +65,27 @@ with the difference that its value type is an edge descriptor and not */ typedef unspecified_type out_edge_iterator; -/*! +/*! Indicates that this graph does not support multiedges. */ boost::disallow_parallel_edge_tag edge_parallel_category; -/*! +/*! Indicates that this graph is bidirectional. */ boost::bidirectional_graph_tag traversal_category; -/*! +/*! The size type of the vertex list. */ typename Polyhedron_3::size_type vertices_size_type; -/*! +/*! The size type of the edge list. */ typename Polyhedron_3::size_type edges_size_type; -/*! +/*! The size type of the adjacency list. */ typename Polyhedron_3::size_type degree_size_type; diff --git a/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Triangulation_2.h b/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Triangulation_2.h index 2c3d7c30b7c..3f9b977b929 100644 --- a/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Triangulation_2.h +++ b/BGL/doc/BGL/CGAL/boost/graph/graph_traits_Triangulation_2.h @@ -41,12 +41,12 @@ public: /// \name Types /// @{ -/*! +/*! The vertex descriptor. */ typedef Triangulation::Vertex_handle vertex_descriptor; -/*! +/*! The edge descriptor. It is constructible from and convertible to `Triangulation::Edge`. The edge descriptor is not a simple typedef, but a proper class, because in an undirected graph @@ -55,40 +55,40 @@ for the Edge type of the triangulation. */ typedef unspecified_type edge_descriptor; -/*! +/*! The vertex iterator type. Its value type is `vertex_descriptor`. */ typedef unspecified_type vertex_iterator; -/*! +/*! The edge iterator type, Its value type is `edge_descriptor`. */ typedef unspecified_type edge_iterator; -/*! +/*! An iterator for the outgoing edges incident to a vertex. Its value type is `edge_descriptor`. */ typedef unspecified_type out_edge_iterator; -/*! +/*! An iterator for the incoming edges incident to a vertex. Its value type is `edge_descriptor`. */ typedef unspecified_type in_edge_iterator; -/*! +/*! An iterator for the vertices adjacent to a vertex. Its value type is `vertex_descriptor`. */ typedef unspecified_type adjacency_iterator; -/*! +/*! */ typedef boost::undirected_tag directed_category; -/*! +/*! */ typedef boost::disallow_parallel_edge_tag edge_parallel_category; diff --git a/BGL/doc/BGL/CGAL/boost/graph/halfedge_graph_traits_Polyhedron_3.h b/BGL/doc/BGL/CGAL/boost/graph/halfedge_graph_traits_Polyhedron_3.h index ed3c1c87ac8..1c4137b99e7 100644 --- a/BGL/doc/BGL/CGAL/boost/graph/halfedge_graph_traits_Polyhedron_3.h +++ b/BGL/doc/BGL/CGAL/boost/graph/halfedge_graph_traits_Polyhedron_3.h @@ -16,7 +16,7 @@ public: /// \name Types /// @{ -/*! +/*! An edge iterator that iterates over one of the two opposite edges forming an undirected edge. @@ -24,7 +24,7 @@ The value type is `CGAL::Polyhedron_3::Halfedge_const_handle`. */ typedef unspecified_type undirected_edge_iterator; -/*! +/*! The point type of the vertex. */ typename CGAL::Polyhedron_3::Point_3 Point ; diff --git a/BGL/doc/BGL/Concepts/HalfedgeGraph.h b/BGL/doc/BGL/Concepts/HalfedgeGraph.h index ed46a7661ba..acb3529156a 100644 --- a/BGL/doc/BGL/Concepts/HalfedgeGraph.h +++ b/BGL/doc/BGL/Concepts/HalfedgeGraph.h @@ -63,7 +63,7 @@ class HalfedgeGraph { }; -/*! +/*! Returns the undirected edges of `g`. \relates HalfedgeGraph @@ -73,7 +73,7 @@ std::pair::undirected_edge_iterato typename halfedge_graph_traits::undirected_edge_iterator> undirected_edges(const Graph& g); -/*! +/*! Returns the opposite edge of `e`. An edge `e=(v,w)` is said to be the opposite edge of edge @@ -85,7 +85,7 @@ template typename boost::graph_traits::edge_descriptor opposite_edge(typename boost::graph_traits::edge_descriptor e, Graph const& g ); -/*! +/*! Returns the clockwise neighbor of `e`. An edge `e2=(v,w)` is called the clockwise neighbor of @@ -101,7 +101,7 @@ template typename boost::graph_traits::edge_descriptor next_edge_cw(typename boost::graph_traits::edge_descriptor e, Graph const& g ); -/*! +/*! Returns the counterclockwise neighbor of `e`. \relates HalfedgeGraph */ @@ -109,7 +109,7 @@ template typename boost::graph_traits::edge_descriptor next_edge_ccw(typename boost::graph_traits::edge_descriptor e, Graph const& g ); -/*! +/*! Returns the successor of `e`. An edge `e2=(v,w)` is called the successor of edge ` @@ -122,7 +122,7 @@ template typename boost::graph_traits::edge_descriptor next_edge(typename boost::graph_traits::edge_descriptor e, Graph const& g ); -/*! +/*! Returns the predecessor of `e`. An edge `e2=(v,w)` is called the successor of edge ` diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h index e4b73eb4b20..c7f4c8ff4f8 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Boolean_set_operations_2/Gps_default_dcel.h @@ -21,7 +21,7 @@ public: /// \name Types /// @{ -/*! +/*! allows the rebinding of the Dcel with a different traits class `T`. */ typedef unspecified_type template rebind; diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h index d3b7a37718c..0eef1b3b4bf 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_2.h @@ -30,7 +30,7 @@ public: /// \name Types /// @{ -/*! +/*! number of edges size type. */ typedef unspecified_type Size; @@ -40,7 +40,7 @@ typedef unspecified_type Size; /// \name Operations /// @{ -/*! +/*! returns the number of edges of the general polygon. */ Size size(); @@ -50,12 +50,12 @@ Size size(); /// \name Modifiers /// @{ -/*! +/*! clears the polygon. */ void clear(); -/*! +/*! reverses the orientation of the polygon. \pre `is_simple()`. */ @@ -66,12 +66,12 @@ void reverse_orientation(); /// \name Predicates /// @{ -/*! +/*! returns `true` if the polygon is empty, and `false` otherwise. */ bool is_empty(); -/*! +/*! returns the orientation of the polygon. \pre `is_simple()`. */ diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h index 421a3ff1478..fbaf40f38b8 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_set_2.h @@ -61,27 +61,27 @@ public: /// \name Types /// @{ -/*! +/*! the traits class in use. */ typedef unspecified_type Traits_2; -/*! +/*! the general polygon type. Must model the `GpsTraitsGeneralPolygon_2` concept. */ typedef unspecified_type Polygon_2; -/*! +/*! the general polygon with holes type. Must model the `GpsTraitsGeneralPolygonWithHoles_2` concept. */ typedef unspecified_type Polygon_with_holes_2; -/*! +/*! number of polygons with holes size type. */ typedef unspecified_type Size; -/*! +/*! the arrangement type used internally. */ typedef unspecified_type Arrangement_2; @@ -91,28 +91,28 @@ typedef unspecified_type Arrangement_2; /// \name Creation /// @{ -/*! +/*! constructs an empty set of polygons `gps` represented by an empty arrangement. */ General_polygon_set_2(); -/*! +/*! copy constructor. */ General_polygon_set_2(const Self & other); -/*! +/*! constructs an empty set of polygons `gps` that uses the given `traits` instance for performing the geometric operations. */ General_polygon_set_2(Traits & traits); -/*! +/*! constructs a set of polygons `gps` that consists of the single polygon `pgn`. */ General_polygon_set_2(const Polygon_2 & pgn); -/*! +/*! constructs a set of polygons `gps` that consists of the single polygon with holes `pgn_with_holes`. */ @@ -123,35 +123,35 @@ General_polygon_set_2(const Polygon_with_holes_2 & pgn_with_holes); /// \name Access Functions /// @{ -/*! +/*! obtains the polygons with holes represented by `gps`. */ template OutputIterator polygons_with_holes(OutputIterator out); -/*! +/*! returns the total number of general polygons represented by `gps`. */ Size number_of_polygons_with_holes() const; -/*! +/*! returns `true` if `gps` represents an empty set. */ bool is_empty() const; -/*! +/*! returns `true` if `gps` represents the entire plane. */ bool is_plane() const; -/*! +/*! obtains an instance of the traits. If the traits was passed as a parameter to the constructor of `gps`, it is returned. Otherwise, a newly created instance is returned. */ Traits & traits() const; -/*! +/*! obtains the arrangement data structure that internally represents the general-polygon set. */ @@ -162,12 +162,12 @@ const Arrangement_2 & arrangement() const; /// \name Modifiers /// @{ -/*! +/*! clears `gps`. */ void clear(); -/*! +/*! inserts `pgn` into `gps`. \pre `pgn` and the point set represented by `gps` are disjoint. This precondition enables the use of very efficient insertion methods. @@ -178,7 +178,7 @@ be guaranteed, use the `join` method. */ void insert(Polygon_2 & pgn); -/*! +/*! inserts `pgn_with_holes` into `gps`. \pre `pgn_with_holes` does not intersect with the point set represented by `gps`, except maybe at the vertices. If this relaxed precondition cannot be guaranteed, use the `join` @@ -186,7 +186,7 @@ method. */ void insert(Polygon_with_holes_2 & pgn_with_holes); -/*! +/*! inserts the range of polygons (or polygons with holes) into `gps`. (The value type of the input iterator is used to distinguish between the two.) \pre If the given range contains objects of type `Polygon_with_holes_2`, then these polygons and the point set represented by `gps` are pairwise disjoint, except maybe at the vertices. If the given range contains objects of type `Polygon_2`, then these polygons and the point set represented by `gps` are pairwise disjoint without any exceptions. @@ -194,7 +194,7 @@ value type of the input iterator is used to distinguish between the two.) template void insert(InputIterator begin, InputIterator end); -/*! +/*! inserts the two ranges of polygons and polygons with holes into `gps`. \pre All polygons in the first range, all polygon with holes in the second range, and the point set represented by `gps` are pairwise disjoint, except maybe at the vertices */ @@ -203,12 +203,12 @@ void insert(InputIterator1 pgn_begin, InputIterator1 pgn_end, InputIterator2 pgn_with_holes_begin, InputIterator2 pgn_with_holes_end); -/*! +/*! computes the complement of `gps`. */ void complement(); -/*! +/*! computes the complement of `other`. `gps` is overridden by the result. */ @@ -220,22 +220,22 @@ void complement(const Polygon_set_2 & other); /// In the following univariate and bivariate methods the result is placed in `gps` after it is cleared. /// @{ -/*! +/*! computes the intersection of `gps` and `other`. */ void intersection(const General_polygon_set_2 & other); -/*! +/*! computes the intersection of `gps` and `pgn`. */ void intersection(const Polygon_2 & pgn); -/*! +/*! computes the intersection of `gps` and `pgn`. */ void intersection(const Polygon_with_holes_2 & pgn); -/*! +/*! computes the intersection of a collection of point sets. The collection consists of the polygons (or polygons with holes) in the given range and the point set represented by `gps`. (The value type of the input iterator @@ -244,7 +244,7 @@ is used to distinguish between the two options.) template void intersection(InputIterator begin, InputIterator end); -/*! +/*! computes the intersection of a collection of point sets. The collection consists of the polygons and polygons with holes in the given two ranges and the point set represented by `gps`. @@ -254,22 +254,22 @@ void intersection(InputIterator1 pgn_begin, InputIterator1 pgn_end, InputIterator2 pgn_with_holes_begin, InputIterator2 pgn_with_holes_end); -/*! +/*! computes the union of `gps` and `other`. */ void join(const General_polygon_set_2 & other); -/*! +/*! computes the union of `gps` and `pgn`. */ void join(const Polygon_2 & pgn); -/*! +/*! computes the union of `gps` and `pgn`. */ void join(const Polygon_with_holes_2 & pgn); -/*! +/*! computes the union of the polygons (or polygons with holes) in the given range and the point set represented by `gps`. (The value type of the input iterator is used to distinguish between the two options.) @@ -277,7 +277,7 @@ of the input iterator is used to distinguish between the two options.) template void join(InputIterator begin, InputIterator end); -/*! +/*! computes the union of the polygons and polygons with holes in the given two ranges and the point set represented by `gps`. */ @@ -286,37 +286,37 @@ void join(InputIterator1 pgn_begin, InputIterator1 pgn_end, InputIterator2 pgn_with_holes_begin, InputIterator2 pgn_with_holes_end); -/*! +/*! computes the difference between `gps` and `other`. */ void difference(const General_polygon_set_2 & other); -/*! +/*! computes the difference between `gps` and `pgn`. */ void difference(const Polygon_2 & pgn); -/*! +/*! computes the difference between `gps` and `pgn`. */ void difference(const Polygon_with_holes_2 & pgn); -/*! +/*! computes the symmetric difference between `gps` and `other`. */ void symmetric_difference(const General_polygon_set_2 & other); -/*! +/*! computes the symmetric difference between `gps` and `pgn`. */ void symmetric_difference(const Polygon_2 & pgn); -/*! +/*! computes the symmetric difference between `gps` and `pgn`. */ void symmetric_difference(const Polygon_with_holes_2 & pgn); -/*! +/*! computes the symmetric difference (xor) of a collection of point sets. The collection consists of the polygons (or polygons with holes) in the given range and the point set represented by `gps`. (The value type of @@ -325,7 +325,7 @@ the input iterator is used to distinguish between the two options.) template void symmetric_difference(InputIterator begin, InputIterator end); -/*! +/*! computes the symmetric difference (xor) of a collection of point sets. The collection consists of the polygons and polygons with holes in the given two ranges and the point set represented by `gps`. @@ -341,25 +341,25 @@ InputIterator2 pgn_with_holes_end); /// The following bivariate function replace `gps` with the result. /// @{ -/*! +/*! computes the intersection of `gps1` and `gps2`. */ void intersection(const General_polygon_set_2 & gps1, const General_polygon_set_2 & gps2); -/*! +/*! computes the union of `gps1` and `gps2`. */ void join(const General_polygon_set_2 & gps1, const General_polygon_set_2 & gps2); -/*! +/*! computes the difference between `gps1` and `gps2`. */ void difference(const General_polygon_set_2 & gps1, const General_polygon_set_2 & gps2); -/*! +/*! computes the symmetric difference between `gps1` and `gps2`. */ void symmetric_difference(const General_polygon_set_2 & gps1, @@ -370,25 +370,25 @@ const General_polygon_set_2 & gps2); /// \name Query Functions /// @{ -/*! +/*! returns `true` if `gps` and `other` intersect in their interior, and `false` otherwise. */ bool do_intersect(const General_polygon_set_2 & other); -/*! +/*! returns `true` if `gps` and `pgn` intersect in their interior, and `false` otherwise. */ bool do_intersect(const Polygon_2 & pgn); -/*! +/*! returns `true` if `gps` and `pgn` intersect in their interior, and `false` otherwise. */ bool do_intersect(const Polygon_with_holes_2 & pgn); -/*! +/*! returns `true` if the interior of the point sets in a collection intersect, and `false` otherwise. The collection consists of the polygons (or polygons with holes) in the given range and the point set @@ -398,7 +398,7 @@ distinguish between the two options.) template void do_intersect(InputIterator begin, InputIterator end); -/*! +/*! returns `true` if the interior of the point sets in a collection intersect, and `false` otherwise. The collection consists of the polygons and polygons with holes in the given two ranges and the point @@ -409,14 +409,14 @@ void do_intersect(InputIterator1 pgn_begin, InputIterator1 pgn_end, InputIterator2 pgn_with_holes_begin, InputIterator2 pgn_with_holes_end); -/*! +/*! obtains a polygon with holes that contains the query point `p`, if exists, through `pgn`, and returns `true`. Otherwise, returns `false`. */ bool locate(const Point_2 & p, Polygon_with_holes_2 & pgn); -/*! +/*! returns either the constant `ON_ORIENTED_BOUNDARY`, `ON_POSITIVE_SIDE`, or `ON_NEGATIVE_SIDE`, iff `p` lies on the boundary, properly on the positive side, or properly on the negative @@ -424,7 +424,7 @@ side of `gps` respectively. */ Oriented_side oriented_side(const Point_2 & q); -/*! +/*! returns either the constant `ON_NEGATIVE_SIDE`, `ON_ORIENTED_BOUNDARY`, or `ON_POSITIVE_SIDE`, iff `other` and `gps` are completely disjoint, in contact, or @@ -432,7 +432,7 @@ intersect in their interior, respectively. */ Oriented_side oriented_side(const General_polygon_set_2 & other); -/*! +/*! returns either the constant `ON_NEGATIVE_SIDE`, `ON_ORIENTED_BOUNDARY`, or `ON_POSITIVE_SIDE`, iff `pgn` and `gps` are completely disjoint, in contact, or @@ -440,7 +440,7 @@ intersect in their interior, respectively. */ Oriented_side oriented_side(const Polygon_2 & pgn); -/*! +/*! returns either the constant `ON_NEGATIVE_SIDE`, `ON_ORIENTED_BOUNDARY`, or `ON_POSITIVE_SIDE`, iff `pgn` and `gps` are completely disjoint, in contact, or @@ -453,7 +453,7 @@ Oriented_side oriented_side(const Polygon_with_holes_2 & pgn); /// \name Miscellaneous /// @{ -/*! +/*! returns `true` if `gps` represents a valid point set. */ bool is_valid() const; diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h index b03ba4d4dd8..0e51813e776 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/General_polygon_with_holes_2.h @@ -20,7 +20,7 @@ public: /// each hole. /// @{ -/*! +/*! */ typedef Polygon General_polygon_2; diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h index e78fd952e8e..adc2521cbfa 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/CGAL/Gps_segment_traits_2.h @@ -24,7 +24,7 @@ public: /// `CGAL::Arr_segment_traits_2`. /// @{ -/*! +/*! */ typedef CGAL::Polygon_2 Polygon_2; diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h index 4edb5917d09..00a4c0cd04f 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--AreMergeable_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts two \f$ x\f$-monotone curves `xc1` and `xc2` and determines whether they can be merged to form a single \f$ x\f$-monotone curve. `xc1` and `xc2` are mergeable if their underlying curves are diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h index 61e7b66b89f..d85c94b6d0f 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--CompareEndpointsXy_2.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts an input curve `xc` and compares its source and target points. It returns `SMALLER` if the curve is directed from lexicographically left to right, and `LARGER` if it is directed diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h index b6ab4d63419..75fe707d88d 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--ConstructOpposite_2.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts an \f$ x\f$-monotone curve `xc` and returns its opposite curve, namely a curve whose graph is the same as `xc`'s, and whose source and target are swapped with respect to `xc`'s source and target. diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h index d9504d0a696..707ff25beeb 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Intersect_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes the intersections of `xc1` and `xc2` and inserts them in an ascending lexicographic \f$ xy\f$-order into the output iterator `oi`. The value-type of `Output_iterator` is diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h index d4600119803..681fb528625 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Merge_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts two mergeable \f$ x\f$-monotone curves `xc1` and `xc2` and asigns `xc` with the merged curve. If the target point of `xc1` and the source point of `xc2` coincide; then diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h index 01c78cb33f2..c61c498edee 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrDirectionalTraits--Split_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! accepts an input curve `xc` and a split point `p` in its interior. It splits `xc` at the split point into two subcurves `xc1` and `xc2`, such that `p` is `xc1`'s right diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h index ee1fc928d0a..f660e7fdb9d 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/ArrangementDirectionalXMonotoneTraits_2.h @@ -34,32 +34,32 @@ public: /// \name Functor Types /// @{ -/*! +/*! models the concept `ArrDirectionalTraits::CompareEndpointsXy_2`. */ typedef unspecified_type Compare_endpoints_xy_2; -/*! +/*! models the concept `ArrDirectionalTraits::ConstructOpposite_2`. */ typedef unspecified_type Construct_opposite_2; -/*! +/*! models the concept `ArrDirectionalTraits::Intersect_2`. */ typedef unspecified_type Intersect_2; -/*! +/*! models the concept `ArrDirectionalTraits::Split_2`. */ typedef unspecified_type Split_2; -/*! +/*! models the concept `ArrDirectionalTraits::AreMergeable_2`. */ typedef unspecified_type Are_mergeable_2; -/*! +/*! models the concept `ArrDirectionalTraits::Merge_2`. */ typedef unspecified_type Merge_2; @@ -69,17 +69,17 @@ typedef unspecified_type Merge_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ ArrangementDirectionalXMonotoneTraits_2(); -/*! +/*! copy constructor */ ArrangementDirectionalXMonotoneTraits_2(ArrangementDirectionalXMonotoneTraits_2 other); -/*! +/*! assignment operator. */ ArrangementDirectionalXMonotoneTraits_2 operator=(other); @@ -89,12 +89,12 @@ ArrangementDirectionalXMonotoneTraits_2 operator=(other); /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Compare_endpoints_xy_2 compare_endpoints_xy_2_object(); -/*! +/*! */ Construct_opposite_2 construct_opposite_2_object(); diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h index 5a8de55ff99..ce54bad67d3 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcel.h @@ -43,32 +43,32 @@ public: /// \name Types /// @{ -/*! +/*! the vertex type. */ typedef unspecified_type Vertex; -/*! +/*! the halfedge type. */ typedef unspecified_type Halfedge; -/*! +/*! the face type. */ typedef unspecified_type Face; -/*! +/*! the hole type. */ typedef unspecified_type Hole; -/*! +/*! the isolated vertex type. */ typedef unspecified_type Isolated_vertex; -/*! +/*! used to represent size values (e.g., `size_t`). */ typedef unspecified_type Size; @@ -81,19 +81,19 @@ typedef unspecified_type Size; /// defined. /// @{ -/*! +/*! a bidirectional iterator over the vertices. Its value-type is `Vertex`. */ typedef unspecified_type Vertex_iterator; -/*! +/*! a bidirectional iterator over the halfedges. Its value-type is `Halfedge`. */ typedef unspecified_type Halfedge_iterator; -/*! +/*! a bidirectional iterator over the faces. Its value-type is `Face`. */ typedef unspecified_type Face_iterator; @@ -103,12 +103,12 @@ typedef unspecified_type Face_iterator; /// \name Creation /// @{ -/*! +/*! constructs an empty Dcel with one unbounded face. */ Arr_dcel(); -/*! +/*! assigns the contents of the `other` Dcel whose unbounded face is given by `uf`, to `dcel`. The function returns a pointer to the unbounded face of `dcel` after the assignment. @@ -120,27 +120,27 @@ Face* assign (const Self& other, const Face *uf); /// \name Access Functions /// @{ -/*! +/*! returns the number of vertices. */ Size size_of_vertices() const; -/*! +/*! returns the number of halfedges (always even). */ Size size_of_halfedges() const; -/*! +/*! returns the number of faces. */ Size size_of_faces() const; -/*! +/*! returns the number of holes (the number of connected components). */ Size size_of_holes() const; -/*! +/*! returns the number of isolated vertices. */ Size size_of_isolated_vertices() const; @@ -157,27 +157,27 @@ returns a begin-iterator of the vertices in `dcel`. */ Vertex_iterator vertices_begin(); -/*! +/*! returns a past-the-end iterator of the vertices in `dcel`. */ Vertex_iterator vertices_end(); -/*! +/*! returns a begin-iterator of the halfedges in `dcel`. */ Halfedge_iterator halfedges_begin(); -/*! +/*! returns a past-the-end iterator of the halfedges in `dcel`. */ Halfedge_iterator halfedges_end(); -/*! +/*! returns a begin-iterator of the faces in `dcel`. */ Vertex_iterator faces_begin(); -/*! +/*! returns a past-the-end iterator of the faces in `dcel`. */ Vertex_iterator faces_end(); @@ -191,52 +191,52 @@ Vertex_iterator faces_end(); /// automatically set. /// @{ -/*! +/*! creates a new vertex. */ Vertex* new_vertex(); -/*! +/*! creates a new pair of twin halfedges. */ Halfedge* new_edge(); -/*! +/*! creates a new face. */ Face* new_face(); -/*! +/*! creates a new hole record. */ Hole* new_hole(); -/*! +/*! creates a new isolated vertex record. */ Isolated_vertex* new_isolated_vertex(); -/*! +/*! deletes the vertex `v`. */ void delete_vertex(Vertex* v); -/*! +/*! deletes the halfedge `e` as well as its twin. */ void delete_edge(Halfedge* e); -/*! +/*! deletes the face `f`. */ void delete_face(Face* f); -/*! +/*! deletes the hole `ho`. */ void delete_hole(Hole* ho); -/*! +/*! deletes the isolated vertex `iv`. */ void delete_isolated_vertex(Isolated_vertex* iv); diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h index a89986d64ef..e72c7b28382 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetDcelFace.h @@ -21,12 +21,12 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Gps_dcel_face(); -/*! +/*! assigns `f` with the contents of the `other` face. */ void assign (const Self& other); @@ -36,13 +36,13 @@ void assign (const Self& other); /// \name Access Functions /// @{ -/*! +/*! returns `true` if the face is contained in the general-polygon set, and `false` otherwise. */ bool contained() const; -/*! +/*! returns `true` if the face has been visited, and `false` otherwise. This is used internally by the some of the operations of the `General_polygon_set_2` class that traverse the arrangement faces. @@ -54,13 +54,13 @@ bool visited(); /// \name Modifiers /// @{ -/*! +/*! marks the face as contained (if `flag` is `true`), or as a hole (if it is `false`). */ void set_contained(bool flag); -/*! +/*! marks the face as visited (if `flag` is `true`), or as not visited (if it is `false`). This is used internally by the some of the operations of the `General_polygon_set_2` class that traverse the diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h index c2bf5f74cc4..03d85e0cbca 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonSetTraits_2.h @@ -27,17 +27,17 @@ public: /// \name Types /// @{ -/*! +/*! represents a general polygon. Must be a model of the `GpsTraitsGeneralPolygon_2` concept. */ typedef unspecified_type Polygon_2; -/*! +/*! represents a general polygon with holes. Must be a model of the `GpsTraitsGeneralPolygonWithHoles_2` concept. */ typedef unspecified_type Polygon_with_holes_2; -/*! +/*! A const iterator of curves. Its value type is const `X_monotone_curve_2`. */ @@ -48,7 +48,7 @@ typedef unspecified_type Curve_const_iterator; /// \name Functor Types /// @{ -/*! +/*! a functor that constructs a general polygon from a range of \f$ x\f$-monotone curves. It uses the operator @@ -58,7 +58,7 @@ parameterized by the `InputIterator` type. */ typedef unspecified_type Construct_polygon_2; -/*! +/*! a functor that constructs a general polygon with holes from a general polygon and, optionally, a range of holes. It uses the operator `void operator() (const General_polygon_2& pgn_boundary)` or @@ -67,21 +67,21 @@ a functor that constructs a general polygon with holes from a general polygon an */ typedef unspecified_type Construct_general_polygon_with_holes_2; -/*! +/*! A functor for constructing the outer boundary of a polygon with holes. It uses the operator `General_polygon_2 operator()(const General_polygon_with_holes_2& pol_wh)`. */ typedef unspecified_type Construct_outer_boundary; -/*! +/*! A functor for constructing the container of holes of a polygon with holes. It returns the begin/end iterators for the holes It uses the operator `std::pair operator()(const General_polygon_with_holes_2& pol_wh)`. */ typedef unspecified_type Construct_holes; -/*! +/*! A functor for checking if polygon with holes has no outer boundary. It uses the operator `bool operator()(const General_polygon_with_holes_2& pol_wh)`. @@ -93,17 +93,17 @@ typedef unspecified_type Is_unbounded; /// \name Creation /// @{ -/*! +/*! default constructor. */ GeneralPolygonSetTraits_2(); -/*! +/*! copy constructor */ GeneralPolygonSetTraits_2(GeneralPolygonSetTraits_2 other); -/*! +/*! assignment operator. */ GeneralPolygonSetTraits_2 operator=(other); @@ -113,32 +113,32 @@ GeneralPolygonSetTraits_2 operator=(other); /// \name Accessing Functor Objects /// @{ -/*! +/*! returns a functor that constructs a polygon. */ Construct_polygon_2 construct_polygon_2_object(); -/*! +/*! returns a functor that obtains the curves of a polygon. */ Construct_curves_2 construct_curves_2_object(); -/*! +/*! returns a functor that constructs a polygon with holes. */ Construct_general_polygon_with_holes_2 construct_polygon_with_holes_2_object() const; -/*! +/*! returns a functor that obtains the outer boundary of a polygon with holes. */ Construct_outer_boundary construct_outer_boundary_object() const; -/*! +/*! returns a functor that obtains begin/end iterators over a container of holes. */ Construct_holes construct_holes_object() const; -/*! +/*! returns a functor that determines if the polygon with holes is unbounded */ Is_unbounded construct_is_unbounded_object(); diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h index 5d208da058f..6a6b00fc845 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygonWithHoles_2.h @@ -23,13 +23,13 @@ public: /// \name Types /// @{ -/*! +/*! the general-polygon type used to represent the outer boundary and each hole. Must model the `GeneralPolygon_2` concept. */ typedef unspecified_type General_polygon_2; -/*! +/*! a bidirectional iterator over the polygonal holes. Its value type is `General_polygon_2`. @@ -41,27 +41,27 @@ typedef unspecified_type Hole_const_iterator; /// \name Creation /// @{ -/*! +/*! default constructor. */ GeneralPolygonWithHoles_2(); -/*! +/*! copy constructor. */ GeneralPolygonWithHoles_2(GeneralPolygonWithHoles_2 other); -/*! +/*! assignment operator. */ GeneralPolygonWithHoles_2 operator=(other); -/*! +/*! constructs a general polygon with holes that has no holes using a given general polygon `outer` as the outer boundary. */ GeneralPolygonWithHoles_2(General_polygon_2 & outer); -/*! +/*! constructs a general polygon with holes using a given general polygon `outer` as the outer boundary and a given range of holes. If `outer` is an empty general polygon, then an unbounded polygon with holes will be @@ -78,7 +78,7 @@ InputIterator begin, InputIterator end); /// \name Predicates /// @{ -/*! +/*! returns `true` if the outer boundary is empty, and `false` otherwise. */ @@ -89,17 +89,17 @@ bool is_unbounded(); /// \name Access Functions /// @{ -/*! +/*! returns the general polygon that represents the outer boundary. Note that this polygon is not necessarily a valid (simple) general polygon because it may be relatively simple. */ const General_polygon_2 & outer_boundary() const; -/*! +/*! returns the begin iterator of the holes. */ Hole_const_iterator holes_begin() const; -/*! +/*! returns the past-the-end iterator of the holes. */ Hole_const_iterator holes_end() const; diff --git a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h index 3522bbbc148..afb592934f1 100644 --- a/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h +++ b/Boolean_set_operations_2/doc/Boolean_set_operations_2/Concepts/GeneralPolygon_2.h @@ -26,19 +26,19 @@ public: /// \name Types /// @{ -/*! +/*! represents a planar (weakly) \f$ x\f$-monotone curve. The type of the geometric mapping of the polygonal edges. It must model the concept ArrTraits::XMonotoneCurve_2. */ typedef unspecified_type X_monotone_curve_2; -/*! +/*! an iterator over the geometric mapping of the polygon edges. Its value type is `X_monotone_curve_2`. */ typedef unspecified_type Curve_iterator; -/*! +/*! a const iterator over the geometric mapping of the polygon edges. Its value type is `X_monotone_curve_2`. */ @@ -49,22 +49,22 @@ typedef unspecified_type Curve_const_iterator; /// \name Creation /// @{ -/*! +/*! default constructor. */ GeneralPolygon_2(); -/*! +/*! copy constructor. */ GeneralPolygon_2(GeneralPolygon_2 other); -/*! +/*! assignment operator. */ GeneralPolygon_2 operator=(other); -/*! +/*! constructs a general polygon from a given range of curves. */ template @@ -75,22 +75,22 @@ GeneralPolygon_2(InputIterator begin, InputIterator end); /// \name Access Functions /// @{ -/*! +/*! returns the begin iterator of the curves. */ Curve_iterator curves_begin(); -/*! +/*! returns the past-the-end iterator of the curves. */ Curve_iterator curves_end(); -/*! +/*! returns the begin const iterator of the curves. */ Curve_const_iterator curves_begin(); -/*! +/*! returns the past-the-end const iterator of the curves. */ Curve_const_iterator curves_end(); @@ -100,7 +100,7 @@ Curve_const_iterator curves_end(); /// \name Modifiers /// @{ -/*! +/*! initializes the polygon with the polygonal chain given by the range. The value type of `Iterator` must be `X_monotone_curve_2`. \pre The curves in the range must define a simple polygon. 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 cc9fd7a826f..b230e906799 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 @@ -145,28 +145,28 @@ public: /// \name Types /// @{ -/*! +/*! `typedef Traits::FT FT` (which is always a typedef to `double`). */ typedef unspecified_type FT; -/*! +/*! `typedef Traits::ET ET` (which is an exact number type used for exact computation like for example in `achieved_epsilon()`). */ typedef unspecified_type ET; -/*! +/*! `typedef Traits::Point Point` */ typedef unspecified_type Point; -/*! +/*! `typedef Traits::Cartesian_const_iterator Cartesian_const_iterator` */ typedef unspecified_type Cartesian_const_iterator; -/*! +/*! A model of STL concept `RandomAccessIterator` with value type `double` that is used to iterate over the Cartesian center coordinates of the computed @@ -174,7 +174,7 @@ ellipsoid, see `center_cartesian_begin()`. */ typedef unspecified_type Center_coordinate_iterator; -/*! +/*! A model of STL concept `RandomAccessIterator` with value type `double` that is used to iterate over the lengths of the semiaxes of the computed ellipsoid, @@ -182,7 +182,7 @@ see `axes_lengths_begin()`. */ typedef unspecified_type Axes_lengths_iterator; -/*! +/*! A model of STL concept `RandomAccessIterator` with value type `double` that is used to iterate over the %Cartesian coordinates of the direction of a fixed @@ -199,7 +199,7 @@ typedef unspecified_type Axis_direction_iterator; /// value `eps`. /// @{ -/*! +/*! initializes `ame` to an \f$ (1+\epsilon)\f$-approximation of \f$ \mel(P)\f$ with \f$ P\f$ being the set of points in the range @@ -248,13 +248,13 @@ const Traits& traits = Traits() ); /// returned quantities. /// @{ -/*! +/*! returns the number of points of `ame`, i.e., \f$ |P|\f$. */ unsigned int number_of_points( ) const; -/*! +/*! returns a number \f$ \epsilon'\f$ such that the computed approximation is (under exact arithmetic) guaranteed to be an \f$ (1+\epsilon')\f$-approximation to @@ -264,7 +264,7 @@ arithmetic) guaranteed to be an \f$ (1+\epsilon')\f$-approximation to */ double achieved_epsilon() const; -/*! +/*! gives access to the \f$ (i,j)\f$th entry of the matrix \f$ E\f$ in the representation \f$ \{ x\in\E^d \mid x^T E x + x^T e + \eta\leq0 @@ -275,7 +275,7 @@ the number returned by `achieved_epsilon()`. */ double defining_matrix(int i,int j) const; -/*! +/*! gives access to the \f$ i\f$th entry of the vector \f$ e\f$ in the representation \f$ \{ x\in\E^d \mid x^T E x + x^T e + \eta\leq0 @@ -286,7 +286,7 @@ the number returned by `achieved_epsilon()`. */ double defining_vector(int i) const; -/*! +/*! gives access to the scalar \f$ \eta\f$ from the representation \f$ \{ x\in\E^d \mid x^T E x + x^T e + \eta\leq0 @@ -297,19 +297,19 @@ the number returned by `achieved_epsilon()`. */ double defining_scalar() const; -/*! +/*! returns a const reference to the traits class object. */ const Traits& traits( ) const; -/*! +/*! returns the dimension of the ambient space, i.e., the dimension of the points \f$ P\f$. */ int dimension() const; -/*! +/*! returns an iterator pointing to the first of the \f$ d\f$ Cartesian coordinates of the computed ellipsoid's center. @@ -320,7 +320,7 @@ relative error. \pre `ame.is_full_dimensional() == true`. */ Center_coordinate_iterator center_cartesian_begin(); -/*! +/*! returns the past-the-end iterator corresponding to `center_cartesian_begin()`. @@ -328,7 +328,7 @@ returns the past-the-end iterator corresponding to */ Center_coordinate_iterator center_cartesian_end(); -/*! +/*! returns an iterator pointing to the first of the \f$ d\f$ descendantly sorted lengths of the computed ellipsoid's axes. The \f$ d\f$ returned @@ -339,14 +339,14 @@ w.r.t.\ the involved relative error. (See also method */ Axes_lengths_iterator axes_lengths_begin(); -/*! +/*! returns the past-the-end iterator corresponding to `axes_lengths_begin()`. \pre `ame.is_full_dimensional() == true`, and \f$ d\in\{2,3\}\f$. */ Axes_lengths_iterator axes_lengths_end(); -/*! +/*! returns an iterator pointing to the first of the \f$ d\f$ %Cartesian coordinates of the computed ellipsoid's \f$ i\f$th axis direction (i.e., unit vector in @@ -361,7 +361,7 @@ length of axis \f$ i\f$ is given by the \f$ i\f$th entry of Axes_direction_coordinate_iterator axis_direction_cartesian_begin(int i); -/*! +/*! returns the past-the-end iterator corresponding to `axis_direction_cartesian_begin()`.\pre `ame.is_full_dimensional() == true`, and \f$ d\in\{2,3\}\f$, and \f$ 0\leq i < d\f$. @@ -374,7 +374,7 @@ axis_direction_cartesian_end(int i); /// \name Predicates /// @{ -/*! +/*! returns whether \f$ P\f$ is full-dimensional or not, i.e., returns `true` if and only if \f$ P\f$ is full-dimensional. @@ -407,7 +407,7 @@ bool is_full_dimensional( ) const; /// ). /// @{ -/*! +/*! returns `true` iff `ame` is valid according to the above definition. If `verbose` is `true`, some messages @@ -421,7 +421,7 @@ bool is_valid( bool verbose = false) const; /// \name Miscellaneous /// @{ -/*! +/*! Writes the points \f$ P\f$ and the computed approximation to \f$ \mel(P)\f$ as an EPS-file under pathname `name`. \pre The dimension of points \f$ P\f$ must be \f$ 2\f$. 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 00e409314e0..f378d22d560 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 @@ -32,23 +32,23 @@ public: /// \name Types /// @{ -/*! +/*! `typedef double FT`. The kernel's number type `K::RT` must be convertible to `double`. */ typedef unspecified_type FT; -/*! +/*! typedef to the second template argument, `ET`. */ typedef unspecified_type ET; -/*! +/*! `typedef K::Point_2 Point` */ typedef unspecified_type Point; -/*! +/*! `typedef K::Cartesian_const_iterator_2 Cartesian_const_iterator` */ typedef unspecified_type Cartesian_const_iterator; 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 4b8b1ae45ba..dde7b827bb8 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 @@ -33,23 +33,23 @@ public: /// \name Types /// @{ -/*! +/*! `typedef double FT`. The kernel's number type `K::RT` must be convertible to `double`. */ typedef unspecified_type FT; -/*! +/*! typedef to the second template argument, `ET`. */ typedef unspecified_type ET; -/*! +/*! `typedef K::Point_3 Point` */ typedef unspecified_type Point; -/*! +/*! `typedef K::Cartesian_const_iterator_3 Cartesian_const_iterator` */ typedef unspecified_type Cartesian_const_iterator; 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 6a921e330ae..44ceb5ce083 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 @@ -32,23 +32,23 @@ public: /// \name Types /// @{ -/*! +/*! `typedef double FT`. The kernel's number type `K::RT` must be convertible to `double`. */ typedef unspecified_type FT; -/*! +/*! typedef to the second template argument, `ET`. */ typedef unspecified_type ET; -/*! +/*! `typedef K::Point_d Point` */ typedef unspecified_type Point; -/*! +/*! `typedef K::Cartesian_const_iterator Cartesian_const_iterator` */ typedef unspecified_type Cartesian_const_iterator; 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 00c50e1832e..6be9ff955af 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_annulus_d.h @@ -58,27 +58,27 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `Traits::Point_d`. Point type used to represent the input points. */ typedef unspecified_type Point; -/*! +/*! typedef to `Traits::FT`. Number type used to return the squared radii of the smallest enclosing annulus. */ typedef unspecified_type FT; -/*! +/*! typedef to `Traits::ET`. Number type used to do the exact computations in the underlying solver for quadratic programs (cf. Implementation). */ typedef unspecified_type ET; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the points @@ -86,7 +86,7 @@ of the smallest enclosing annulus. */ typedef unspecified_type Point_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the support points @@ -94,7 +94,7 @@ of the smallest enclosing annulus. */ typedef unspecified_type Support_point_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the inner support points @@ -102,7 +102,7 @@ of the smallest enclosing annulus. */ typedef unspecified_type Inner_support_point_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the outer support points @@ -110,7 +110,7 @@ of the smallest enclosing annulus. */ typedef unspecified_type Outer_support_point_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `ET`. Used to access the coordinates of @@ -123,7 +123,7 @@ typedef unspecified_type Coordinate_iterator; /// \name Creation /// @{ -/*! +/*! initializes `min_annulus` to \f$ ma(\emptyset)\f$. */ @@ -131,7 +131,7 @@ Min_annulus_d( const Traits& traits = Traits(), int verbose = 0, std::ostream& stream = std::cout); -/*! +/*! initializes `min_annulus` to \f$ ma(P)\f$ with \f$ P\f$ being the set of points in the range [`first`,`last`). @@ -150,66 +150,66 @@ std::ostream& stream = std::cout); /// \name Access Functions /// @{ -/*! +/*! returns the dimension of the points in \f$ P\f$. If `min_annulus` is empty, the ambient dimension is \f$ -1\f$. */ int ambient_dimension( ) const; -/*! +/*! returns the number of points of `min_annulus`, i.e.\ \f$ |P|\f$. */ int number_of_points( ) const; -/*! +/*! returns the number of support points of `min_annulus`, i.e.\ \f$ |S|\f$. */ int number_of_support_points( ) const; -/*! +/*! returns the number of support points of `min_annulus` which lie on the inner sphere. */ int number_of_inner_support_points( ) const; -/*! +/*! returns the number of support points of `min_annulus` which lie on the outer sphere. */ int number_of_outer_support_points( ) const; -/*! +/*! returns an iterator referring to the first point of `min_annulus`. */ Point_iterator points_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Point_iterator points_end( ) const; -/*! +/*! returns an iterator referring to the first support point of `min_annulus`. \pre \f$ ma(P)\f$ is not degenerate, i.e., `number_of_support_points()` is at least one. */ Support_point_iterator support_points_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. \pre \f$ ma(P)\f$ is not degenerate, i.e., `number_of_support_points()` is at least one. */ Support_point_iterator support_points_end( ) const; -/*! +/*! returns an iterator referring to the first inner support point of `min_annulus`. @@ -217,14 +217,14 @@ of `min_annulus`. Inner_support_point_iterator inner_support_points_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Inner_support_point_iterator inner_support_points_end( ) const; -/*! +/*! returns an iterator referring to the first outer support point of `min_annulus`. @@ -232,14 +232,14 @@ of `min_annulus`. Outer_support_point_iterator outer_support_points_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Outer_support_point_iterator outer_support_points_end( ) const; -/*! +/*! returns the center of `min_annulus`. \cgalRequires An implicit conversion from `ET` to `RT` is available. @@ -247,7 +247,7 @@ returns the center of `min_annulus`. */ Point center( ) const; -/*! +/*! returns the squared inner radius of `min_annulus`. \cgalRequires An implicit conversion from `ET` to `RT` is available. @@ -255,7 +255,7 @@ returns the squared inner radius of `min_annulus`. */ FT squared_inner_radius( ) const; -/*! +/*! returns the squared outer radius of `min_annulus`. \cgalRequires An implicit conversion from `ET` to `RT` is available. @@ -263,7 +263,7 @@ returns the squared outer radius of `min_annulus`. */ FT squared_outer_radius( ) const; -/*! +/*! returns an iterator referring to the first coordinate of the center of `min_annulus`. @@ -277,26 +277,26 @@ common denominator. Coordinate_iterator center_coordinates_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Coordinate_iterator center_coordinates_end() const; -/*! +/*! returns the numerator of the squared inner radius of `min_annulus`. */ ET squared_inner_radius_numerator( ) const; -/*! +/*! returns the numerator of the squared outer radius of `min_annulus`. */ ET squared_outer_radius_numerator( ) const; -/*! +/*! returns the denominator of the squared radii of `min_annulus`. */ @@ -312,7 +312,7 @@ ET squared_radii_denominator( ) const; /// \E^d\f$. /// @{ -/*! +/*! returns `CGAL::ON_BOUNDED_SIDE`, `CGAL::ON_BOUNDARY`, or @@ -324,34 +324,34 @@ properly inside, on the boundary, or properly outside of CGAL::Bounded_side bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly inside `min_annulus`. \pre The dimension of `p` equals `min_annulus.ambient_dimension()` if `min_annulus` is not empty. */ bool has_on_bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies on the boundary of `min_annulus`. \pre The dimension of `p` equals `min_annulus.ambient_dimension()` if `min_annulus` is not empty. */ bool has_on_boundary( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly outside of `min_annulus`. \pre The dimension of `p` equals `min_annulus.ambient_dimension()` if `min_annulus` is not empty. */ bool has_on_unbounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `min_annulus` is empty (this implies degeneracy). */ bool is_empty( ) const; -/*! +/*! returns `true`, iff `min_annulus` is degenerate, i.e.\ if `min_annulus` is empty or equal to a single point. */ @@ -362,13 +362,13 @@ bool is_degenerate( ) const; /// \name Modifiers /// @{ -/*! +/*! resets `min_annulus` to \f$ ma(\emptyset)\f$. */ void clear( ); -/*! +/*! sets `min_annulus` to \f$ ma(P)\f$, where \f$ P\f$ is the set of points in the range [`first`,`last`). @@ -379,14 +379,14 @@ template < class InputIterator > void set( InputIterator first, InputIterator last ); -/*! +/*! inserts `p` into `min_annulus`. \pre The dimension of `p` equals `min_annulus.ambient_dimension()` if `min_annulus` is not empty. */ void insert( const Point& p); -/*! +/*! inserts the points in the range [`first`,`last`) into `min_annulus` and recomputes the smallest enclosing annulus. @@ -408,7 +408,7 @@ InputIterator last ); /// item is considered by the validity check. /// @{ -/*! +/*! returns `true`, iff `min_annulus` is valid. If `verbose` is `true`, some messages concerning the performed checks are @@ -424,7 +424,7 @@ int level = 0 ) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a const reference to the traits class object. */ @@ -435,7 +435,7 @@ const Traits& traits( ) const; }; /* end Min_annulus_d */ -/*! +/*! writes `min_annulus` to output stream `os`. \cgalRequires The output operator is defined for `Point`. @@ -445,7 +445,7 @@ std::ostream& operator << ( std::ostream& os, const Min_annulus_d& min_annulus); -/*! +/*! reads `min_annulus` from input stream `is`. \cgalRequires The input operator is defined for `Point`. 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 5d71a7a79f2..a5e6ef69fd3 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_circle_2.h @@ -78,17 +78,17 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `Traits::Point `. */ typedef unspecified_type Point ; -/*! +/*! typedef to `Traits::Circle`. */ typedef unspecified_type Circle; -/*! +/*! non-mutable model of the \stl concept BidirectionalIterator with value type `Point`. Used to access the points @@ -96,7 +96,7 @@ of the smallest enclosing circle. */ typedef unspecified_type Point_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the support points @@ -114,7 +114,7 @@ typedef unspecified_type Support_point_iterator; /// \f$ S\f$ of \f$ P\f$. /// @{ -/*! +/*! initializes `min_circle` to \f$ mc(P)\f$ with \f$ P\f$ being the set of points in the range [`first`,`last`). If `randomize` is @@ -133,7 +133,7 @@ bool randomize, Random& random = CGAL::default_random, const Traits& traits = Traits() ); -/*! +/*! initializes `min_circle` to \f$ mc(\emptyset)\f$, the empty set. @@ -141,7 +141,7 @@ initializes `min_circle` to */ Min_circle_2( const Traits& traits = Traits()); -/*! +/*! initializes `min_circle` to \f$ mc(\{p\})\f$, the set \f$ \{p\}\f$. \post `min_circle.is_degenerate()` = `true`. @@ -149,7 +149,7 @@ initializes `min_circle` to \f$ mc(\{p\})\f$, the set \f$ \{p\}\f$. Min_circle_2( const Point& p, const Traits& traits = Traits()); -/*! +/*! initializes `min_circle` to \f$ mc(\{p1,p2\})\f$, the circle with diameter equal to the segment connecting \f$ p1\f$ and \f$ p2\f$. @@ -158,7 +158,7 @@ Min_circle_2( const Point& p1, const Point& p2, const Traits& traits = Traits()); -/*! +/*! initializes `min_circle` to \f$ mc(\{p1,p2,p3\})\f$. */ @@ -172,43 +172,43 @@ const Traits& traits = Traits()); /// \name Access Functions /// @{ -/*! +/*! returns the number of points of `min_circle`, i.e.\ \f$ |P|\f$. */ int number_of_points( ) const; -/*! +/*! returns the number of support points of `min_circle`, i.e.\ \f$ |S|\f$. */ int number_of_support_points( ) const; -/*! +/*! returns an iterator referring to the first point of `min_circle`. */ Point_iterator points_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Point_iterator points_end() const; -/*! +/*! returns an iterator referring to the first support point of `min_circle`. */ Support_point_iterator support_points_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_point_iterator support_points_end() const; -/*! +/*! returns the `i`-th support point of `min_circle`. Between two modifying operations (see below) any call to @@ -218,7 +218,7 @@ the same point. */ const Point& support_point( int i) const; -/*! +/*! returns the current circle of `min_circle`. */ @@ -232,7 +232,7 @@ const Circle& circle( ) const; /// \E^2\f$. /// @{ -/*! +/*! returns `CGAL::ON_BOUNDED_SIDE`, `CGAL::ON_BOUNDARY`, or @@ -242,33 +242,33 @@ inside, on the boundary of, or properly outside of `min_circle`, resp. CGAL::Bounded_side bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly inside `min_circle`. */ bool has_on_bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies on the boundary of `min_circle`. */ bool has_on_boundary( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly outside of `min_circle`. */ bool has_on_unbounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `min_circle` is empty (this implies degeneracy). */ bool is_empty( ) const; -/*! +/*! returns `true`, iff `min_circle` is degenerate, i.e.\ if `min_circle` is empty or equal to a single point, equivalently @@ -286,14 +286,14 @@ bool is_degenerate( ) const; /// itself. /// @{ -/*! +/*! inserts `p` into `min_circle` and recomputes the smallest enclosing circle. */ void insert( const Point& p); -/*! +/*! inserts the points in the range [`first`,`last`) into `min_circle` and recomputes the smallest enclosing circle by @@ -305,7 +305,7 @@ template < class InputIterator > void insert( InputIterator first, InputIterator last ); -/*! +/*! deletes all points in `min_circle` and sets `min_circle` to the empty set. \post `min_circle.is_empty()` = `true`. @@ -321,7 +321,7 @@ void clear( ); ///
  • \f$ S\f$ is minimal, i.e.\ no support point is redundant. /// @{ -/*! +/*! returns `true`, iff `min_circle` is valid. If `verbose` is `true`, some messages concerning the performed checks @@ -337,7 +337,7 @@ int level = 0 ) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a const reference to the traits class object. */ @@ -347,7 +347,7 @@ const Traits& traits( ) const; }; /* end Min_circle_2 */ -/*! +/*! writes `min_circle` to output stream `os`. \cgalRequires The output operator is defined for `Point` (and for `Circle`, if pretty printing is used). @@ -357,7 +357,7 @@ std::ostream& operator << ( std::ostream& os, const Min_circle_2& min_circle); -/*! +/*! reads `min_circle` from input stream `is`. \cgalRequires The input operator is defined for `Point`. 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 ab0b24df029..acba791f7dc 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 @@ -22,12 +22,12 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_2`. */ typedef unspecified_type Point ; -/*! +/*! internal type. */ typedef unspecified_type Circle; @@ -37,12 +37,12 @@ typedef unspecified_type Circle; /// \name Creation /// @{ -/*! +/*! default constructor. */ Min_circle_2_traits_2( ); -/*! +/*! copy constructor. */ Min_circle_2_traits_2( @@ -53,7 +53,7 @@ const Min_circle_2_traits_2&); /// \name Operations /// @{ -/*! +/*! returns `CGAL::orientation( p, q, r)`. */ 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 b41845848de..8e21d7e4a0c 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_ellipse_2.h @@ -62,12 +62,12 @@ public: /// \name Types /// @{ -/*! +/*! Typedef to `Traits::Point `. */ typedef unspecified_type Point ; -/*! +/*! Typedef to `Traits::Ellipse`. If you are using the predefined traits class `CGAL::Min_ellipse_2_traits_2`, @@ -77,7 +77,7 @@ the example below. */ typedef unspecified_type Ellipse; -/*! +/*! Non-mutable model of the \stl concept BidirectionalIterator with value type `Point`. Used to access the points @@ -85,7 +85,7 @@ of the smallest enclosing ellipse. */ typedef unspecified_type Point_iterator; -/*! +/*! Non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the support points @@ -103,7 +103,7 @@ typedef unspecified_type Support_point_iterator; /// support set \f$ S\f$ of \f$ P\f$. /// @{ -/*! +/*! initializes `min_ellipse` to \f$ me(P)\f$ with \f$ P\f$ being the set of points in the range [`first`,`last`). If `randomize` is @@ -122,7 +122,7 @@ bool randomize, Random& random = default_random, const Traits& traits = Traits() ); -/*! +/*! creates a variable `min_ellipse` of type `Min_ellipse_2`. It is initialized to @@ -131,7 +131,7 @@ It is initialized to */ Min_ellipse_2( const Traits& traits = Traits()); -/*! +/*! initializes `min_ellipse` to \f$ me(\{p\})\f$, the set \f$ \{p\}\f$. \post `min_ellipse.is_degenerate()` = `true`. @@ -139,7 +139,7 @@ initializes `min_ellipse` to \f$ me(\{p\})\f$, the set \f$ \{p\}\f$. Min_ellipse_2( const Point& p, const Traits& traits = Traits()); -/*! +/*! initializes `min_ellipse` to \f$ me(\{p,q\})\f$, the set \f$ \{ (1-\lambda) p + \lambda q \mid 0 \leq \lambda \leq 1 \}\f$ @@ -149,7 +149,7 @@ Min_ellipse_2( const Point& p, const Point& q, const Traits& traits = Traits()); -/*! +/*! initializes `min_ellipse` to \f$ me(\{p1,p2,p3\})\f$. */ @@ -158,7 +158,7 @@ const Point& p2, const Point& p3, const Traits& traits = Traits()); -/*! +/*! initializes `min_ellipse` to \f$ me(\{p1,p2,p3,p4\})\f$. */ @@ -168,7 +168,7 @@ const Point& p3, const Point& p4, const Traits& traits = Traits()); -/*! +/*! initializes `min_ellipse` to \f$ me(\{p1,p2,p3,p4,p5\})\f$. */ @@ -184,43 +184,43 @@ const Traits& traits = Traits()); /// \name Access Functions /// @{ -/*! +/*! returns the number of points of `min_ellipse`, i.e.\ \f$ |P|\f$. */ int number_of_points( ) const; -/*! +/*! returns the number of support points of `min_ellipse`, i.e.\ \f$ |S|\f$. */ int number_of_support_points( ) const; -/*! +/*! returns an iterator referring to the first point of `min_ellipse`. */ Point_iterator points_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Point_iterator points_end() const; -/*! +/*! returns an iterator referring to the first support point of `min_ellipse`. */ Support_point_iterator support_points_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_point_iterator support_points_end() const; -/*! +/*! returns the `i`-th support point of `min_ellipse`. Between two modifying operations (see below) any call to @@ -230,7 +230,7 @@ the same point. */ const Point& support_point( int i) const; -/*! +/*! returns the current ellipse of `min_ellipse`. */ @@ -244,7 +244,7 @@ const Ellipse& ellipse( ) const; /// \E^2\f$. /// @{ -/*! +/*! returns `CGAL::ON_BOUNDED_SIDE`, `CGAL::ON_BOUNDARY`, or @@ -254,33 +254,33 @@ inside, on the boundary of, or properly outside of `min_ellipse`, resp. CGAL::Bounded_side bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly inside `min_ellipse`. */ bool has_on_bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies on the boundary of `min_ellipse`. */ bool has_on_boundary( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly outside of `min_ellipse`. */ bool has_on_unbounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `min_ellipse` is empty (this implies degeneracy). */ bool is_empty( ) const; -/*! +/*! returns `true`, iff `min_ellipse` is degenerate, i.e.\ if `min_ellipse` is empty, equal to a single point or equal to a @@ -299,14 +299,14 @@ bool is_degenerate( ) const; /// itself. /// @{ -/*! +/*! inserts `p` into `min_ellipse` and recomputes the smallest enclosing ellipse. */ void insert( const Point& p); -/*! +/*! inserts the points in the range [`first`,`last`) into `min_ellipse` and recomputes the smallest enclosing ellipse by @@ -318,7 +318,7 @@ template < class InputIterator > void insert( InputIterator first, InputIterator last ); -/*! +/*! deletes all points in `min_ellipse` and sets `min_ellipse` to the empty set. \post `min_ellipse.is_empty()` = `true`. @@ -336,7 +336,7 @@ void clear( ); /// item is considered by the validity check. /// @{ -/*! +/*! returns `true`, iff `min_ellipse` contains all points of its defining set \f$ P\f$. If `verbose` is `true`, some @@ -353,7 +353,7 @@ int level = 0 ) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a const reference to the traits class object. */ @@ -365,7 +365,7 @@ const Traits& traits( ) const; }; /* end Min_ellipse_2 */ -/*! +/*! writes `min_ellipse` to output stream `os`. \cgalRequires The output operator is defined for `Point` (and for `Ellipse`, if pretty printing is used). @@ -375,7 +375,7 @@ std::ostream& operator << ( std::ostream& os, const Min_ellipse_2& min_ellipse); -/*! +/*! reads `min_ellipse` from input stream `is`. \cgalRequires The input operator is defined for `Point`. 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 275a432ad46..e6a1ec22a1e 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 @@ -22,12 +22,12 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_2`. */ typedef unspecified_type Point ; -/*! +/*! internal type. */ typedef unspecified_type Ellipse; @@ -39,12 +39,12 @@ typedef unspecified_type Ellipse; /// required by the concept `MinEllipse2Traits`. /// @{ -/*! +/*! tests whether the ellipse is a circle. */ bool is_circle(); -/*! +/*! gives a double approximation of the ellipse's conic equation. If `K` is a Cartesian kernel, the ellipse is the set of all points \f$ (x,y)\f$ satisfying \f$ rx^2+sy^2+txy+ux+vy+w=0\f$. In the @@ -58,12 +58,12 @@ void double_coefficients (double &r, double &s, double &t, double &u, double &v, /// \name Creation /// @{ -/*! +/*! default constructor. */ Min_ellipse_2_traits_2( ); -/*! +/*! copy constructor. */ Min_ellipse_2_traits_2( 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 1ee3cbdf140..5aba7ca0424 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 @@ -24,37 +24,37 @@ public: /// \name Types /// @{ -/*! +/*! `Kernel::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! `Kernel::Vector_2`. */ typedef unspecified_type Vector_2; -/*! +/*! `Kernel::Direction_2`. */ typedef unspecified_type Direction_2; -/*! +/*! `Kernel::Line_2`. */ typedef unspecified_type Line_2; -/*! +/*! internal type. */ typedef unspecified_type Rectangle_2; -/*! +/*! internal type. */ typedef unspecified_type Parallelogram_2; -/*! +/*! internal type. */ typedef unspecified_type Strip_2; @@ -64,37 +64,37 @@ typedef unspecified_type Strip_2; /// \name Predicates /// @{ -/*! +/*! `Kernel::Equal_2`. */ typedef unspecified_type Equal_2; -/*! +/*! `Kernel::Less_xy_2`. */ typedef unspecified_type Less_xy_2; -/*! +/*! `Kernel::Less_yx_2`. */ typedef unspecified_type Less_yx_2; -/*! +/*! `Kernel::Orientation_2`. */ typedef unspecified_type Orientation_2; -/*! +/*! `Kernel::Has_on_negative_side_2`. */ typedef unspecified_type Has_on_negative_side_2; -/*! +/*! `Kernel::Compare_angle_with_x_axis_2`. */ typedef unspecified_type Compare_angle_with_x_axis_2; -/*! +/*! AdaptableBinaryFunction class `op`: `Rectangle_2` \f$ \times\f$ `Rectangle_2` @@ -104,7 +104,7 @@ the area of \f$ r1\f$ is strictly less than the area of \f$ r2\f$. */ typedef unspecified_type Area_less_rectangle_2; -/*! +/*! AdaptableBinaryFunction class `op`: `Parallelogram_2` \f$ \times\f$ @@ -115,7 +115,7 @@ less than the area of \f$ p2\f$. */ typedef unspecified_type Area_less_parallelogram_2; -/*! +/*! AdaptableBinaryFunction class `op`: `Strip_2` \f$ \times\f$ `Strip_2` \f$ \rightarrow\f$ @@ -130,12 +130,12 @@ typedef unspecified_type Width_less_strip_2; /// \name Constructions /// @{ -/*! +/*! `Kernel::Construct_vector_2`. */ typedef unspecified_type Construct_vector_2; -/*! +/*! AdaptableFunctor `op`: `Direction_2` \f$ \rightarrow\f$ `Vector_2`. @@ -144,27 +144,27 @@ AdaptableFunctor */ typedef unspecified_type Construct_vector_from_direction_2; -/*! +/*! `Kernel::Construct_perpendicular_vector_2`. */ typedef unspecified_type Construct_perpendicular_vector_2; -/*! +/*! `Kernel::Construct_direction_2`. */ typedef unspecified_type Construct_direction_2; -/*! +/*! `Kernel::Construct_opposite_direction_2`. */ typedef unspecified_type Construct_opposite_direction_2; -/*! +/*! `Kernel::Construct_line_2`. */ typedef unspecified_type Construct_line_2; -/*! +/*! Function class `op`: `Point_2` \f$ \times\f$ `Direction_2` \f$ \times\f$ `Point_2` @@ -178,7 +178,7 @@ points on each side and one sides parallel to `d`. */ typedef unspecified_type Construct_rectangle_2; -/*! +/*! Function class `op`: `Point_2` \f$ \times\f$ `Direction_2` \f$ \times\f$ @@ -193,7 +193,7 @@ of the points on each side and one side parallel to each of */ typedef unspecified_type Construct_parallelogram_2; -/*! +/*! Function class `op`: `Point_2` \f$ \times\f$ `Direction_2` \f$ \times\f$ `Point_2` @@ -216,7 +216,7 @@ typedef unspecified_type Construct_strip_2; /// exists: /// @{ -/*! +/*! copies the four vertices of `r` in counterclockwise order to `o`. */ @@ -224,7 +224,7 @@ template < class OutputIterator > OutputIterator copy_rectangle_vertices_2(const Rectangle_2& r, OutputIterator o) const; -/*! +/*! copies the four vertices of `p` in counterclockwise order to `o`. */ @@ -232,14 +232,14 @@ template < class OutputIterator > OutputIterator copy_parallelogram_vertices_2(const Parallelogram_2& p, OutputIterator o) const; -/*! +/*! copies the two lines bounding `s` to `o`. */ template < class OutputIterator > OutputIterator copy_strip_lines_2(const Strip_2& s, OutputIterator o) const; -/*! +/*! */ Construct_vector_2 construct_vector_2_object() 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 1742d74ffbf..d0806b47f50 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 @@ -26,47 +26,47 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_2`. */ typedef unspecified_type Point_d; -/*! +/*! typedef to `K::Rep_tag`. */ typedef unspecified_type Rep_tag; -/*! +/*! typedef to `K::RT`. */ typedef unspecified_type RT; -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Access_dimension_2`. */ typedef unspecified_type Access_dimension_d; -/*! +/*! typedef to `K::Access_coordinates_begin_2`. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! typedef to `K::Construct_point_2`. */ typedef unspecified_type Construct_point_d; -/*! +/*! second template parameter (default is `K::RT`). */ typedef unspecified_type ET; -/*! +/*! third template parameter (default is `K::RT`). */ typedef unspecified_type NT; @@ -76,12 +76,12 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Min_sphere_annulus_d_traits_2( ); -/*! +/*! copy constructor. */ Min_sphere_annulus_d_traits_2( @@ -94,19 +94,19 @@ const Min_sphere_annulus_d_traits_2&); /// class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d 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 0c313f3fd3b..e4627f99380 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 @@ -26,47 +26,47 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_3`. */ typedef unspecified_type Point_d; -/*! +/*! typedef to `K::Rep_tag`. */ typedef unspecified_type Rep_tag; -/*! +/*! typedef to `K::RT`. */ typedef unspecified_type RT; -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Access_dimension_3`. */ typedef unspecified_type Access_dimension_d; -/*! +/*! typedef to `K::Access_coordinates_begin_3`. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! typedef to `K::Construct_point_3`. */ typedef unspecified_type Construct_point_d; -/*! +/*! second template parameter (default is `K::RT`). */ typedef unspecified_type ET; -/*! +/*! third template parameter (default is `K::RT`). */ typedef unspecified_type NT; @@ -76,12 +76,12 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Min_sphere_annulus_d_traits_3( ); -/*! +/*! copy constructor. */ Min_sphere_annulus_d_traits_3( @@ -94,19 +94,19 @@ const Min_sphere_annulus_d_traits_3&); /// class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d 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 29fdb6d72a4..5fec804b71d 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 @@ -27,47 +27,47 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_d`. */ typedef unspecified_type Point_d; -/*! +/*! typedef to `K::Rep_tag`. */ typedef unspecified_type Rep_tag; -/*! +/*! typedef to `K::RT`. */ typedef unspecified_type RT; -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Access_dimension_d`. */ typedef unspecified_type Access_dimension_d; -/*! +/*! typedef to `K::Access_coordinates_begin_d`. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! typedef to `K::Construct_point_d`. */ typedef unspecified_type Construct_point_d; -/*! +/*! second template parameter (default is `K::RT`). */ typedef unspecified_type ET; -/*! +/*! third template parameter (default is `K::RT`). */ typedef unspecified_type NT; @@ -77,12 +77,12 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Min_sphere_annulus_d_traits_d( ); -/*! +/*! copy constructor. */ Min_sphere_annulus_d_traits_d( @@ -95,19 +95,19 @@ const Min_sphere_annulus_d_traits_d&); /// class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d 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 5395099e3fe..ae9c71826df 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_d.h @@ -78,29 +78,29 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type Traits; -/*! +/*! typedef to `Traits::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `Traits::Point`. */ typedef unspecified_type Point; -/*! +/*! non-mutable model of the STL concept `BidirectionalIterator` with value type `Point`. Used to access the points used to build the smallest enclosing sphere. */ typedef unspecified_type Point_iterator; -/*! +/*! non-mutable model of the STL concept `BidirectionalIterator` with value type `Point`. Used to access the support points defining the smallest enclosing sphere. @@ -112,7 +112,7 @@ typedef unspecified_type Support_point_iterator; /// \name Creation /// @{ -/*! +/*! creates a variable of type `Min_sphere_d` and initializes it to \f$ ms(\emptyset)\f$. @@ -121,7 +121,7 @@ must provide a default constructor. */ 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 @@ -133,56 +133,56 @@ Min_sphere_d( InputIterator first, InputIterator last, const Traits& traits = Traits()); -/*! +/*! returns the number of points of `min_sphere`, i.e.\ \f$ |P|\f$. */ int number_of_points( ) const; -/*! +/*! returns the number of support points of `min_sphere`, i.e.\ \f$ |S|\f$. */ int number_of_support_points( ) const; -/*! +/*! returns an iterator referring to the first point of `min_sphere`. */ Point_iterator points_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Point_iterator points_end() const; -/*! +/*! returns an iterator referring to the first support point of `min_sphere`. */ Support_point_iterator support_points_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_point_iterator support_points_end() const; -/*! +/*! returns the dimension of the points in \f$ P\f$. If `min_sphere` is empty, the ambient dimension is \f$ -1\f$. */ int ambient_dimension() const; -/*! +/*! returns the center of `min_sphere`. \pre `min_sphere` is not empty. */ const Point& center( ) const; -/*! +/*! returns the squared radius of `min_sphere`. \pre `min_sphere` is not empty. @@ -197,7 +197,7 @@ FT squared_radius( ) const; /// \E^d\f$. /// @{ -/*! +/*! returns `CGAL::ON_BOUNDED_SIDE`, `CGAL::ON_BOUNDARY`, or `CGAL::ON_UNBOUNDED_SIDE` iff `p` lies properly inside, @@ -207,14 +207,14 @@ on the boundary, or properly outside of `min_sphere`, resp. Bounded_side bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly inside `min_sphere`. \pre If `min_sphere` is not empty, the dimension of \f$ p\f$ equals `ambient_dimension()`. */ bool has_on_bounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies on the boundary of `min_sphere`. @@ -222,21 +222,21 @@ of `min_sphere`. */ bool has_on_boundary( const Point& p) const; -/*! +/*! returns `true`, iff `p` lies properly outside of `min_sphere`. \pre If `min_sphere` is not empty, the dimension of \f$ p\f$ equals `ambient_dimension()`. */ bool has_on_unbounded_side( const Point& p) const; -/*! +/*! returns `true`, iff `min_sphere` is empty (this implies degeneracy). */ bool is_empty( ) const; -/*! +/*! returns `true`, iff `min_sphere` is degenerate, i.e.\ if `min_sphere` is empty or equal to a single point, equivalently if @@ -249,13 +249,13 @@ bool is_degenerate( ) const; /// \name Modifiers /// @{ -/*! +/*! resets `min_sphere` to \f$ ms(\emptyset)\f$. */ 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`). @@ -266,7 +266,7 @@ template < class InputIterator > void set( InputIterator first, InputIterator last ); -/*! +/*! inserts `p` into `min_sphere`. If `p` lies inside the current sphere, this is a constant-time operation, otherwise @@ -276,7 +276,7 @@ recomputing the smallest enclosing sphere from scratch. */ void insert( const Point& p); -/*! +/*! inserts the points in the range [`first`,`last`) into `min_sphere` and recomputes the smallest enclosing sphere, by @@ -301,7 +301,7 @@ InputIterator last ); /// from numerical problems. /// @{ -/*! +/*! returns `true`, iff `min_sphere` is valid. If `verbose` is `true`, some messages concerning the performed checks @@ -317,7 +317,7 @@ int level = 0 ) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a const reference to the traits class object. */ @@ -328,7 +328,7 @@ const Traits& traits( ) const; }; /* end Min_sphere_d */ -/*! +/*! writes `min_sphere` to output stream `os`. \cgalRequires The output operator is defined for `Point`. @@ -338,7 +338,7 @@ std::ostream& operator << ( std::ostream& os, const Min_sphere_d& min_sphere); -/*! +/*! reads `min_sphere` from input stream `is`. \cgalRequires The input operator is defined for `Point`. 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 02b288ebbe6..778ee39f84d 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 @@ -36,7 +36,7 @@ public: /// \name Constants /// @{ -/*! +/*! is the constant 2, i.e.\ the dimension of \f$ \mathbb{R}^2\f$. */ typedef unspecified_type D; @@ -49,38 +49,38 @@ typedef unspecified_type D; /// `Radius` and `Point`. Here's the complete list of defined types: /// @{ -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Use_square_roots; -/*! +/*! */ typedef unspecified_type Algorithm; -/*! +/*! is a typedef to the template parameter `FT` */ typedef unspecified_type Radius; -/*! +/*! is a typedef to `K::Point_2`. */ typedef unspecified_type Point; -/*! +/*! is a typedef to `Point`. */ typedef unspecified_type Sphere; -/*! +/*! is a typedef to `K::Cartesian_const_iterator_2`. */ @@ -94,13 +94,13 @@ typedef unspecified_type Cartesian_const_iterator; /// routines of class `K::Point_2`: /// @{ -/*! +/*! returns `0`. */ FT radius(const Sphere& s); -/*! +/*! maps to `s.first.cartesian_begin()`. */ Cartesian_const_iterator center_cartesian_begin(const diff --git a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h index e62c1e38e1f..94fc8752a01 100644 --- a/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h +++ b/Bounding_volumes/doc/Bounding_volumes/CGAL/Min_sphere_of_points_d_traits_3.h @@ -36,7 +36,7 @@ public: /// \name Constants /// @{ -/*! +/*! is the constant 3, i.e.\ the dimension of \f$ \mathbb{R}^3\f$. */ typedef unspecified_type D; @@ -49,38 +49,38 @@ typedef unspecified_type D; /// `Radius` and `Point`. Here's the complete list of defined types: /// @{ -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Use_square_roots; -/*! +/*! */ typedef unspecified_type Algorithm; -/*! +/*! is a typedef to the template parameter `FT` */ typedef unspecified_type Radius; -/*! +/*! is a typedef to `K::Point_3`. */ typedef unspecified_type Point; -/*! +/*! is a typedef to `Point`. */ typedef unspecified_type Sphere; -/*! +/*! is a typedef to `K::Cartesian_const_iterator_3`. */ @@ -94,13 +94,13 @@ typedef unspecified_type Cartesian_const_iterator; /// routines of class `K::Point_3`: /// @{ -/*! +/*! returns `0`. */ FT radius(const Sphere& s); -/*! +/*! maps to `s.first.cartesian_begin()`. */ Cartesian_const_iterator center_cartesian_begin(const 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 46a3b4614a2..20af328cf96 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 @@ -35,7 +35,7 @@ public: /// \name Constants /// @{ -/*! +/*! is the constant `Dim`. */ typedef unspecified_type D; @@ -48,38 +48,38 @@ typedef unspecified_type D; /// `Radius` and `Point`. Here's the complete list of defined types: /// @{ -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Use_square_roots; -/*! +/*! */ typedef unspecified_type Algorithm; -/*! +/*! is a typedef to the template parameter `FT` */ typedef unspecified_type Radius; -/*! +/*! is a typedef to `K::Point_d`. */ typedef unspecified_type Point; -/*! +/*! is a typedef to `Point`. */ typedef unspecified_type Sphere; -/*! +/*! is a typedef to `K::Cartesian_const_iterator_d`. */ @@ -93,13 +93,13 @@ typedef unspecified_type Cartesian_const_iterator; /// routines of class `K::Point_d`: /// @{ -/*! +/*! returns `0`. */ FT radius(const Sphere& s); -/*! +/*! maps to `s.cartesian_begin()`. */ Cartesian_const_iterator center_cartesian_begin(const 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 e77a14db50a..df2e7ef860d 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 @@ -105,17 +105,17 @@ public: /// \name Types /// @{ -/*! +/*! is a typedef to `Traits::Sphere`. */ typedef unspecified_type Sphere; -/*! +/*! is a typedef to `Traits::FT`. */ typedef unspecified_type FT; -/*! +/*! is the type of the radius and of the center coordinates of the computed minsphere: When `FT` is an inexact number type (`double`, for instance), then `Result` is @@ -129,7 +129,7 @@ member function `discriminant()` of class */ typedef unspecified_type Result; -/*! +/*! is either `CGAL::LP_algorithm` or `CGAL::Farthest_first_heuristic`. As is described in the documentation of concept `MinSphereOfSpheresTraits`, the type @@ -141,7 +141,7 @@ release, then `Algorithm` will have another type.) */ typedef unspecified_type Algorithm; -/*! +/*! non-mutable model of the STL concept `BidirectionalIterator` @@ -150,7 +150,7 @@ to access the support spheres defining the smallest enclosing sphere. */ typedef unspecified_type Support_iterator; -/*! +/*! non-mutable model of the STL concept `BidirectionalIterator` @@ -163,7 +163,7 @@ typedef unspecified_type Cartesian_const_iterator; /// \name Creation /// @{ -/*! +/*! creates a variable of type `Min_sphere_of_spheres_d` and initializes it to \f$ ms(\emptyset)\f$. If the traits parameter is not supplied, the class `Traits` must provide a @@ -171,7 +171,7 @@ default constructor. */ Min_sphere_of_spheres_d(const Traits& traits = Traits()); -/*! +/*! creates a variable `minsphere` of type `Min_sphere_of_spheres_d` and inserts (cf. `insert()`) the spheres from @@ -188,19 +188,19 @@ const Traits& traits = Traits()); /// \name Access Functions /// @{ -/*! +/*! returns an iterator referring to the first support sphere of `minsphere`. */ Support_iterator support_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_iterator support_end() const; -/*! +/*! returns the discriminant of `minsphere`. This number is undefined when `FT` is an inexact number type. When `FT` is exact, the center @@ -210,7 +210,7 @@ returned by this function. \pre `minsphere` is not empty, and `FT` is an exact n */ const FT& discriminant( ) const; -/*! +/*! returns the radius of `minsphere`. If `FT` is an exact number type then the radius of the minsphere is the real number \f$ a+b\sqrt{t}\f$, where \f$ t\f$ is the @@ -220,7 +220,7 @@ component of the pair returned by `radius()`. */ Result radius( ) const; -/*! +/*! returns a const-iterator to the first of the `Traits::%D` center coordinates of `minsphere`. The iterator returns objects of type `Result`. If `FT` is an exact number type, @@ -231,7 +231,7 @@ discriminant (cf. `discriminant()`). \pre `minsphere` is not empty. Cartesian_const_iterator center_cartesian_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator, i.e.\ `center_cartesian_begin()+Traits::%D`. \pre `minsphere` is not empty. @@ -244,7 +244,7 @@ const; /// \name Predicates /// @{ -/*! +/*! returns `true`, iff `minsphere` is empty, i.e.\ iff \f$ ms(S)=\emptyset\f$. */ @@ -255,13 +255,13 @@ bool is_empty( ) const; /// \name Modifiers /// @{ -/*! +/*! resets `minsphere` to \f$ ms(\emptyset)\f$, with \f$ S:= \emptyset\f$. */ void clear (); -/*! +/*! sets `minsphere` to the \f$ ms(S)\f$, where \f$ S\f$ is the set of spheres in the range [`first`,`last`). @@ -270,13 +270,13 @@ the \f$ ms(S)\f$, where \f$ S\f$ is the set of spheres in the range template < class InputIterator > void set( InputIterator first, InputIterator last ); -/*! +/*! inserts the sphere `s` into the set \f$ S\f$ of instance `minsphere`. */ void insert( const Sphere& s ); -/*! +/*! inserts the spheres in the range [`first`,`last`) into the set \f$ S\f$ of instance `minsphere`. @@ -294,7 +294,7 @@ InputIterator first, InputIterator last ); /// R\f$ is minimal, i.e., no support sphere is redundant. /// @{ -/*! +/*! returns `true`, iff `minsphere` is valid. When `FT` is inexact, this routine always returns `true`. @@ -306,7 +306,7 @@ bool is_valid() const; /// \name Miscellaneous /// @{ -/*! +/*! returns a const reference to the traits class object. */ 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 dde860f1365..95bcfe84705 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 @@ -39,7 +39,7 @@ public: /// \name Constants /// @{ -/*! +/*! is the constant 2, i.e.\ the dimension of \f$ \mathbb{R}^2\f$. */ typedef unspecified_type D; @@ -52,38 +52,38 @@ typedef unspecified_type D; /// `Radius` and `Point`. Here's the complete list of defined types: /// @{ -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Use_square_roots; -/*! +/*! */ typedef unspecified_type Algorithm; -/*! +/*! is a typedef to the template parameter `FT` */ typedef unspecified_type Radius; -/*! +/*! is a typedef to `K::Point_2`. */ typedef unspecified_type Point; -/*! +/*! is a typedef to `std::pair`. */ typedef unspecified_type Sphere; -/*! +/*! is a typedef to `K::Cartesian_const_iterator_2`. */ @@ -97,13 +97,13 @@ typedef unspecified_type Cartesian_const_iterator; /// routines of class `K::Point_2`: /// @{ -/*! +/*! maps to `s.second`. */ FT radius(const Sphere& s); -/*! +/*! maps to `s.first.cartesian_begin()`. */ Cartesian_const_iterator center_cartesian_begin(const 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 6ca42ad2210..b57be341112 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 @@ -32,7 +32,7 @@ public: /// \name Constants /// @{ -/*! +/*! is the constant 3, i.e.\ the dimension of \f$ \mathbb{R}^3\f$. */ typedef unspecified_type D; @@ -45,38 +45,38 @@ typedef unspecified_type D; /// `Radius` and `Point`. Here's the complete list of defined types: /// @{ -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Use_square_roots; -/*! +/*! */ typedef unspecified_type Algorithm; -/*! +/*! is a typedef to the template parameter `FT` */ typedef unspecified_type Radius; -/*! +/*! is a typedef to `K::Point_3`. */ typedef unspecified_type Point; -/*! +/*! is a typedef to `std::pair`. */ typedef unspecified_type Sphere; -/*! +/*! is a typedef to `K::Cartesian_const_iterator_3`. */ @@ -90,13 +90,13 @@ typedef unspecified_type Cartesian_const_iterator; /// routines of class `K::Point_3`: /// @{ -/*! +/*! returns `0`. */ FT radius(const Sphere& s); -/*! +/*! maps to `s.first.cartesian_begin()`. */ Cartesian_const_iterator center_cartesian_begin(const 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 e8b5504a5c3..ce8b0bb0d37 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 @@ -35,7 +35,7 @@ public: /// \name Constants /// @{ -/*! +/*! is the constant `Dim`. */ typedef unspecified_type D; @@ -48,38 +48,38 @@ typedef unspecified_type D; /// `Radius` and `Point`. Here's the complete list of defined types: /// @{ -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Use_square_roots; -/*! +/*! */ typedef unspecified_type Algorithm; -/*! +/*! is a typedef to the template parameter `FT` */ typedef unspecified_type Radius; -/*! +/*! is a typedef to `K::Point_d`. */ typedef unspecified_type Point; -/*! +/*! is a typedef to `std::pair`. */ typedef unspecified_type Sphere; -/*! +/*! is a typedef to `K::Cartesian_const_iterator_d`. */ @@ -93,13 +93,13 @@ typedef unspecified_type Cartesian_const_iterator; /// routines of class `K::Point_d`: /// @{ -/*! +/*! maps to `s.second`. */ FT radius(const Sphere& s); -/*! +/*! maps to `s.first.cartesian_begin()`. */ Cartesian_const_iterator center_cartesian_begin(const 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 e2de6493835..e58749a4dea 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 @@ -22,44 +22,44 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! typedef to `K::Iso_rectangle_2`. */ typedef unspecified_type Iso_rectangle_2; -/*! +/*! typedef to `K::Less_x_2`. */ typedef unspecified_type Less_x_2; -/*! +/*! typedef to `K::Less_y_2`. */ typedef unspecified_type Less_y_2; -/*! +/*! typedef to `K::Construct_vertex_2`. */ typedef unspecified_type Construct_vertex_2; -/*! +/*! typedef to `K::Construct_iso_rectangle_2`. */ typedef unspecified_type Construct_iso_rectangle_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the signed distance of two points' @@ -67,7 +67,7 @@ class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ */ typedef unspecified_type Signed_x_distance_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the signed distance of two points' @@ -75,7 +75,7 @@ class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ */ typedef unspecified_type Signed_y_distance_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the \f$ ||\cdot||_{\infty}\f$ distance of two @@ -83,7 +83,7 @@ points. */ typedef unspecified_type Infinity_distance_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the signed \f$ ||\cdot||_{\infty}\f$ @@ -91,7 +91,7 @@ distance of two points. */ typedef unspecified_type Signed_infinity_distance_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -102,7 +102,7 @@ line through \f$ q\f$. */ typedef unspecified_type Construct_point_2_below_left_implicit_point_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -113,7 +113,7 @@ horizontal line through \f$ q\f$. */ typedef unspecified_type Construct_point_2_below_right_implicit_point_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -124,7 +124,7 @@ horizontal line through \f$ q\f$. */ typedef unspecified_type Construct_point_2_above_right_implicit_point_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -142,48 +142,48 @@ typedef unspecified_type Construct_point_2_above_left_implicit_point_2; /// to fetch the corresponding function object. /// @{ -/*! +/*! */ Inf_distance_2 inf_distance_2_object() const; -/*! +/*! */ Signed_inf_distance_2 signed_inf_distance_2_object() const; -/*! +/*! */ Construct_vertex_2 construct_vertex_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2 construct_iso_rectangle_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_below_left_point_2 construct_iso_rectangle_2_below_left_point_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_above_left_point_2 construct_iso_rectangle_2_above_left_point_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_below_right_point_2 construct_iso_rectangle_2_below_right_point_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_above_right_point_2 diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h index ff530f550a0..94e219ba824 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/ApproximateMinEllipsoid_d_Traits_d.h @@ -24,12 +24,12 @@ public: /// \name Types /// @{ -/*! +/*! `typedef double FT` */ typedef unspecified_type FT; -/*! +/*! Some model of concept `RingNumberType` that provides exact arithmetic. In addition, `ET` must be able to exactly represent any finite `double` value. (An @@ -41,7 +41,7 @@ exact computations. */ typedef unspecified_type ET; -/*! +/*! Type of the input points. `Point` must provide the default and copy constructor, and must be a model of `DefaultConstructible`, `CopyConstructible`, and @@ -49,7 +49,7 @@ of `DefaultConstructible`, `CopyConstructible`, and */ typedef unspecified_type Point; -/*! +/*! Model for the STL concept `RandomAccessIterator` whose value type must be convertible to `double`. This type is used to iterate over the %Cartesian @@ -63,13 +63,13 @@ typedef unspecified_type Cartesian_const_iterator; /// \name Access Functions /// @{ -/*! +/*! returns the dimension of a point `p`. */ int dimension(const Point& p); -/*! +/*! returns an input iterator over the Euclidean coordinates of the point \f$ p\f$. The range of the iterator must have size `dimension(p)`. diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h index 52e0c610320..c57eb36fb1a 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/Circle.h @@ -47,7 +47,7 @@ void set(); void set( const Point& p); -/*! +/*! sets `circle` to the circle with diameter equal to the segment connecting `p` and `q`. The algorithm guarantees that `set` is never called with two equal points. diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h index b231ee11eb4..67685312757 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinCircle2Traits.h @@ -18,14 +18,14 @@ public: /// \name Types /// @{ -/*! +/*! The point type must provide default and copy constructor, assignment and equality test. */ typedef unspecified_type Point; -/*! +/*! The circle type must fulfill the requirements listed below in the next section. @@ -37,7 +37,7 @@ typedef unspecified_type Circle; /// \name Variables /// @{ -/*! +/*! The current circle. This variable is maintained by the algorithm, the user should neither access nor modify it directly. @@ -50,12 +50,12 @@ Circle circle; /// Only default and copy constructor are required. /// @{ -/*! +/*! */ MinCircle2Traits( ); -/*! +/*! */ MinCircle2Traits( const MinCircle2Traits&); @@ -67,7 +67,7 @@ MinCircle2Traits( const MinCircle2Traits&); /// `is_valid` of `Min_circle_2` is used. /// @{ -/*! +/*! returns constants `CGAL::LEFT_TURN`, `CGAL::COLLINEAR`, or diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h index 5a12a8e46db..0e644da4eb9 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinEllipse2Traits.h @@ -18,14 +18,14 @@ public: /// \name Types /// @{ -/*! +/*! The point type must provide default and copy constructor, assignment and equality test. */ typedef unspecified_type Point; -/*! +/*! The ellipse type must fulfill the requirements listed below in the next section. @@ -37,7 +37,7 @@ typedef unspecified_type Ellipse; /// \name Variables /// @{ -/*! +/*! The current ellipse. This variable is maintained by the algorithm, the user should neither access nor modify it directly. @@ -50,12 +50,12 @@ Ellipse ellipse; /// Only default and copy constructor are required. /// @{ -/*! +/*! */ Traits( ); -/*! +/*! */ Traits( const Traits&); diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h index 12956a87cbe..93c1a0926c7 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinQuadrilateralTraits_2.h @@ -22,39 +22,39 @@ public: /// \name Types /// @{ -/*! +/*! type for representing points. */ typedef unspecified_type Point_2; -/*! +/*! type for representing vectors. */ typedef unspecified_type Vector_2; -/*! +/*! type for representing directions. */ typedef unspecified_type Direction_2; -/*! +/*! type for representing lines. */ typedef unspecified_type Line_2; -/*! +/*! type for representing (not necessarily axis-parallel) rectangles. */ typedef unspecified_type Rectangle_2; -/*! +/*! type for representing parallelograms. */ typedef unspecified_type Parallelogram_2; -/*! +/*! type for representing strips, that is the closed region bounded by two parallel lines. */ @@ -65,36 +65,36 @@ typedef unspecified_type Strip_2; /// \name Predicates /// @{ -/*! +/*! a model for `Kernel::Equal_2`. */ typedef unspecified_type Equal_2; -/*! +/*! a model for `Kernel::Less_xy_2`. */ typedef unspecified_type Less_xy_2; -/*! +/*! a model for `Kernel::Less_yx_2`. */ typedef unspecified_type Less_yx_2; -/*! +/*! a model for `Kernel::Has_on_negative_side_2`. */ typedef unspecified_type Has_on_negative_side_2; -/*! +/*! a model for `Kernel::Compare_angle_with_x_axis_2`. */ typedef unspecified_type Compare_angle_with_x_axis_2; -/*! +/*! AdaptableFunctor `op`: `Rectangle_2` \f$ \times\f$ `Rectangle_2` \f$ \rightarrow\f$ @@ -104,7 +104,7 @@ strictly less than the area of \f$ r2\f$. */ typedef unspecified_type Area_less_rectangle_2; -/*! +/*! AdaptableFunctor `op`: `Parallelogram_2` \f$ \times\f$ @@ -115,7 +115,7 @@ than the area of \f$ p2\f$. */ typedef unspecified_type Area_less_parallelogram_2; -/*! +/*! AdaptableFunctor `op`: `Strip_2` \f$ \times\f$ `Strip_2` \f$ \rightarrow\f$ `bool`. @@ -125,7 +125,7 @@ than the width of \f$ s2\f$. */ typedef unspecified_type Width_less_strip_2; -/*! +/*! a model for `Kernel::Orientation_2`. @@ -139,13 +139,13 @@ typedef unspecified_type Orientation_2; /// \name Constructions /// @{ -/*! +/*! a model for `Kernel::Construct_vector_2`. */ typedef unspecified_type Construct_vector_2; -/*! +/*! AdaptableFunctor `op`: `Direction_2` \f$ \rightarrow\f$ `Vector_2`. @@ -154,31 +154,31 @@ AdaptableFunctor */ typedef unspecified_type Construct_vector_from_direction_2; -/*! +/*! a model for `Kernel::Construct_perpendicular_vector_2`. */ typedef unspecified_type Construct_perpendicular_vector_2; -/*! +/*! a model for `Kernel::Construct_direction_2`. */ typedef unspecified_type Construct_direction_2; -/*! +/*! a model for `Kernel::Construct_opposite_direction_2`. */ typedef unspecified_type Construct_opposite_direction_2; -/*! +/*! a model for `Kernel::Construct_line_2`. */ typedef unspecified_type Construct_line_2; -/*! +/*! Function class `op`: `Point_2` \f$ \times\f$ `Direction_2` \f$ \times\f$ `Point_2` @@ -192,7 +192,7 @@ points on each side and one sides parallel to `d`. */ typedef unspecified_type Construct_rectangle_2; -/*! +/*! Function class `op`: `Point_2` \f$ \times\f$ `Direction_2` \f$ \times\f$ @@ -207,7 +207,7 @@ of the points on each side and one side parallel to each of */ typedef unspecified_type Construct_parallelogram_2; -/*! +/*! Function class `op`: `Point_2` \f$ \times\f$ `Direction_2` \f$ \times\f$ `Point_2` @@ -230,7 +230,7 @@ typedef unspecified_type Construct_strip_2; /// function must exist: /// @{ -/*! +/*! copies the four vertices of `r` in counterclockwise order to `o`. */ @@ -238,7 +238,7 @@ template < class OutputIterator > OutputIterator copy_rectangle_vertices_2(const Rectangle_2& r, OutputIterator o) const; -/*! +/*! copies the four vertices of `p` in counterclockwise order to `o`. */ @@ -246,14 +246,14 @@ template < class OutputIterator > OutputIterator copy_parallelogram_vertices_2(const Parallelogram_2& p, OutputIterator o) const; -/*! +/*! copies the two lines bounding `s` to `o`. */ template < class OutputIterator > OutputIterator copy_strip_lines_2(const Strip_2& s, OutputIterator o) const; -/*! +/*! */ Construct_vector_2 construct_vector_2_object() diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h index 001e14bb8b4..db1d354ca78 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereAnnulusDTraits.h @@ -21,12 +21,12 @@ public: /// \name Types /// @{ -/*! +/*! point type used to represent the input points. */ typedef unspecified_type Point_d; -/*! +/*! compile time tag to distinguish between %Cartesian and homogeneous representation of the input points. `Rep_tag` has to be either `CGAL::Cartesian_tag` or @@ -34,13 +34,13 @@ representation of the input points. `Rep_tag` has to be either */ typedef unspecified_type Rep_tag; -/*! +/*! number type used to represent the coordinates of the input points. It has to be a model for `RingNumberType`. */ typedef unspecified_type RT; -/*! +/*! number type used to return either the squared radius of the smallest enclosing sphere or annulus, or the squared distance of the polytopes. `FT` has to be either `RT` or `CGAL::Quotient` if @@ -49,17 +49,17 @@ respectively (cf. `Rep_tag`). */ typedef unspecified_type FT; -/*! +/*! data accessor object used to access the dimension of the input points. */ typedef unspecified_type Access_dimension_d; -/*! +/*! data accessor object used to access the coordinates of the input points. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! constructor object used to construct either the center of the smallest enclosing sphere or annulus, or the points realizing the distance between the two polytopes. @@ -74,7 +74,7 @@ typedef unspecified_type Construct_point_d; /// `CGAL::Polytope_distance_d`. /// @{ -/*! +/*! exact number type used to do the exact computations in the underlying solver for linear programs. It has to to be a model for `RingNumberType`. There must be an implicit conversion from @@ -82,7 +82,7 @@ underlying solver for linear programs. It has to to be a model for */ typedef unspecified_type ET; -/*! +/*! fast (possibly inexact) number type used to speed up the pricing step in the underlying solver for linear programs. It has to be a model for `RingNumberType`. There must be implicit conversions from `RT` to @@ -96,12 +96,12 @@ typedef unspecified_type NT; /// Only default and copy constructor are required. /// @{ -/*! +/*! */ MinSphereAnnulusDTraits( ); -/*! +/*! */ MinSphereAnnulusDTraits( const MinSphereAnnulusDTraits&); @@ -113,19 +113,19 @@ MinSphereAnnulusDTraits( const MinSphereAnnulusDTraits&); /// class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h index 1532115da2b..be843a34c9d 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/MinSphereOfSpheresTraits.h @@ -18,7 +18,7 @@ public: /// \name Constants /// @{ -/*! +/*! specifies the dimension of the spheres you want to compute the minsphere of. */ @@ -29,28 +29,28 @@ typedef unspecified_type D; /// \name Types /// @{ -/*! +/*! is a typedef to to some class representing a sphere. (The package will compute the minsphere of spheres of type `Sphere`.) The type `Sphere` must provide a copy constructor. */ typedef unspecified_type Sphere; -/*! +/*! is a (exact or inexact) field number type. \cgalRequires Currently, `FT` must either be `double` or `float`, or an exact field number type. (An exact number type is one which evaluates arithmetic expressions involving the four basic operations and comparisions with infinite precision, that is, like in \f$ \mathbb{R}\f$.) */ typedef unspecified_type FT; -/*! +/*! non-mutable model of the STL concept `ForwardIterator` with value type `FT`. Used to access the center coordinates of a sphere. */ typedef unspecified_type Cartesian_const_iterator; -/*! +/*! must typedef to either `CGAL::Tag_true` or `CGAL::Tag_false`. The algorithm uses (depending on the type @@ -68,7 +68,7 @@ square-roots are disabled (due to lacking hardware support). */ typedef unspecified_type Use_square_roots; -/*! +/*! selects the method to compute the minsphere with. It must typedef to either `CGAL::Default_algorithm`, `CGAL::LP_algorithm` or `CGAL::Farthest_first_heuristic`. @@ -95,14 +95,14 @@ typedef unspecified_type Algorithm; /// \name Access Functions /// @{ -/*! +/*! returns the radius of sphere `s`. \post The returned number is greater or equal to \f$ 0\f$. */ FT radius(const Sphere& s); -/*! +/*! returns an iterator referring to the first of the `D` %Cartesian coordinates of the center of `s`. diff --git a/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h b/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h index 03db092e279..5f91e17f539 100644 --- a/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h +++ b/Bounding_volumes/doc/Bounding_volumes/Concepts/RectangularPCenterTraits_2.h @@ -19,48 +19,48 @@ public: /// \name Types /// @{ -/*! +/*! model for `FieldNumberType`. */ typedef unspecified_type FT; -/*! +/*! model for `Kernel::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! model for `Kernel::Iso_rectangle_2`. */ typedef unspecified_type Iso_rectangle_2; -/*! +/*! model for `Kernel::Less_x_2`. */ typedef unspecified_type Less_x_2; -/*! +/*! model for `Kernel::Less_y_2`. */ typedef unspecified_type Less_y_2; -/*! +/*! model for `Kernel::Construct_vertex_2`. */ typedef unspecified_type Construct_vertex_2; -/*! +/*! model for `Kernel::Construct_iso_rectangle_2`. */ typedef unspecified_type Construct_iso_rectangle_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the signed distance of two points' @@ -68,7 +68,7 @@ class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ */ typedef unspecified_type Signed_x_distance_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the signed distance of two points' @@ -76,7 +76,7 @@ class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ */ typedef unspecified_type Signed_y_distance_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the \f$ ||\cdot||_{\infty}\f$ distance of two @@ -84,7 +84,7 @@ points. */ typedef unspecified_type Infinity_distance_2; -/*! +/*! adaptable binary function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT` returns the signed \f$ ||\cdot||_{\infty}\f$ @@ -92,7 +92,7 @@ distance of two points. */ typedef unspecified_type Signed_infinity_distance_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -103,7 +103,7 @@ line through \f$ q\f$. */ typedef unspecified_type Construct_point_2_below_left_implicit_point_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -114,7 +114,7 @@ horizontal line through \f$ q\f$. */ typedef unspecified_type Construct_point_2_below_right_implicit_point_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -125,7 +125,7 @@ horizontal line through \f$ q\f$. */ typedef unspecified_type Construct_point_2_above_right_implicit_point_2; -/*! +/*! 3-argument function class: `Point_2` \f$ \times\f$ `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. For arguments @@ -143,48 +143,48 @@ typedef unspecified_type Construct_point_2_above_left_implicit_point_2; /// to fetch the corresponding function object. /// @{ -/*! +/*! */ Inf_distance_2 inf_distance_2_object() const; -/*! +/*! */ Signed_inf_distance_2 signed_inf_distance_2_object() const; -/*! +/*! */ Construct_vertex_2 construct_vertex_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2 construct_iso_rectangle_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_below_left_point_2 construct_iso_rectangle_2_below_left_point_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_above_left_point_2 construct_iso_rectangle_2_above_left_point_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_below_right_point_2 construct_iso_rectangle_2_below_right_point_2_object() const; -/*! +/*! */ Construct_iso_rectangle_2_above_right_point_2 diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h index ebbc8b21601..1a7f21cbdda 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_d.h @@ -60,14 +60,14 @@ public: /// \name Types /// @{ -/*! +/*! number type to represent the box boundaries. Allowed are the built-in types `int`, `unsigned int`, `float`, and `double`. */ typedef unspecified_type NT; -/*! +/*! type for the box `id`-number. */ typedef std::size_t ID; @@ -77,32 +77,32 @@ typedef std::size_t ID; /// \name Creation /// @{ -/*! +/*! %Default constructor. No particular initialization. */ Box_d(); -/*! +/*! Constructor initialized to the complete or the empty space. If empty, all interval starting(end) points will be set to positive(negative) infinity. */ Box_d(bool complete); -/*! +/*! initializes the box intervals to [`lo[i]`,`hi[i]`], \f$ 0 \leq i < D\f$. \pre `lo[i]` \f$ <\f$ `hi[i]` for \f$ 0 \leq i < D\f$. */ Box_d(NT lo[D], NT hi[D]); -/*! +/*! constructs from `bbox`. \cgalRequires \f$ D=2\f$ and `NT`\f$ \equiv\f$`double`. */ Box_d( const Bbox_2& bbox); -/*! +/*! constructs from `bbox`. \cgalRequires \f$ D=3\f$ and `NT`\f$ \equiv\f$`double`. */ @@ -113,20 +113,20 @@ Box_d( const Bbox_3& bbox); /// \name Modifiers /// @{ -/*! +/*! initializes to the complete or the empty space. If empty, all interval starting(end) points will be set to positive(negative) infinity. */ void init( bool complete = false); -/*! +/*! extend `box` to contain the old `box` and `point`. */ void extend(NT point[D]); -/*! +/*! returns \f$ D\f$, the dimension of the box. */ static int dimension(); @@ -136,7 +136,7 @@ static int dimension(); /// \name Access Functions /// @{ -/*! +/*! returns a unique box id, see the `IdPolicy` template parameter above for the different choices. @@ -144,37 +144,37 @@ choices. */ std::size_t id(); -/*! +/*! returns the lower boundary in dimension `d` \pre \f$ 0 \leq\f$`d`\f$ < D\f$. */ NT min_coord(int d) const; -/*! +/*! returns the upper boundary in dimension `d` \pre \f$ 0 \leq\f$`d`\f$ < D\f$. */ NT max_coord(int d) const; -/*! +/*! returns the bounding box \cgalRequires \f$ D=2\f$ and `NT`\f$ \equiv\f$`double` */ const Bbox_2& bbox() const; -/*! +/*! returns the bounding box \cgalRequires \f$ D=3\f$ and `NT`\f$ \equiv\f$`double` */ const Bbox_3& bbox() const; -/*! +/*! extends `box` to the smallest box that additionally contains the point represented by coordinates in `p`. */ void extend(NT p[N]); -/*! +/*! extends `box` to the smallest box that additionally contains the point represented by coordinate intervals in `p`. */ diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h index cf88a003dad..309fcc24d36 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_traits_d.h @@ -39,7 +39,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Box_traits_d(); diff --git a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h index 5c74601f8a1..45a3a33e83d 100644 --- a/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/CGAL/Box_intersection_d/Box_with_handle_d.h @@ -69,14 +69,14 @@ public: /// \name Types /// @{ -/*! +/*! number type to represent the box boundaries. Allowed are the built-in types `int`, `unsigned int`, `float`, and `double`. */ typedef unspecified_type NT; -/*! +/*! type for the box `id`-number. */ typedef std::size_t ID; @@ -86,20 +86,20 @@ typedef std::size_t ID; /// \name Creation /// @{ -/*! +/*! %Default constructor. No particular initialization. */ Box_with_handle_d(); -/*! +/*! initializes to the complete or the empty space. If empty, all interval starting (end) points will be set to positive (negative) infinity, sets handle to \f$ h\f$. */ Box_with_handle_d(bool complete, Handle h); -/*! +/*! initializes the box intervals to [`lo[i]`,`hi[i]`], \f$ 0 \leq i < D\f$ and sets the handle to \f$ h\f$. @@ -107,14 +107,14 @@ sets the handle to \f$ h\f$. */ Box_with_handle_d(NT lo[D], NT hi[D], Handle h); -/*! +/*! constructs from bbox and sets the handle to \f$ h\f$, exists iff \f$ D=2\f$ and `NT`\f$ \equiv\f$`double`. */ Box_with_handle_d( const Bbox_2& bbox, Handle h); -/*! +/*! constructs from bbox and sets the handle to \f$ h\f$, exists iff \f$ D=3\f$ and `NT`\f$ \equiv\f$`double`. @@ -126,14 +126,14 @@ Box_with_handle_d( const Bbox_3& bbox, Handle h); /// \name Modifiers /// @{ -/*! +/*! initializes to the complete or the empty space. If empty, all interval starting(end) points will be set to positive(negative) infinity. */ void init( bool complete = false); -/*! +/*! extend `box` to contain the old `box` and `point`. */ @@ -144,17 +144,17 @@ void extend(NT point[D]); /// \name Access Functions /// @{ -/*! +/*! returns the handle stored in `box`. */ Handle handle() const; -/*! +/*! returns \f$ D\f$, the dimension of the box. */ static int dimension(); -/*! +/*! returns a unique box id, see the `IdPolicy` template parameter above for the different choices. Does not exist if `ID_NONE` has been chosen for the @@ -162,23 +162,23 @@ choices. Does not exist if `ID_NONE` has been chosen for the */ std::size_t id(); -/*! +/*! returns the lower boundary in dimension `d`, \f$ 0 \leq\f$`d`\f$ < D\f$. */ NT min_coord( int d) const; -/*! +/*! returns the upper boundary in dimension `d`, \f$ 0 \leq\f$`d`\f$ < D\f$. */ NT max_coord( int d) const; -/*! +/*! returns the bounding box iff \f$ D=2\f$ and `NT`\f$ \equiv\f$`double`. */ const Bbox_2& bbox() const; -/*! +/*! returns the bounding box iff \f$ D=3\f$ and `NT`\f$ \equiv\f$`double`. */ diff --git a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h index e558b912fa8..94f6b2120ed 100644 --- a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionBox_d.h @@ -28,20 +28,20 @@ public: /// \name Types /// @{ -/*! +/*! number type to represent the box boundaries. Allowed are the built-in types `int`, `unsigned int`, `float`, and `double`. */ typedef unspecified_type NT; -/*! +/*! type for the box `id`-number, must be a model of the `LessThanComparable` concept. */ typedef unspecified_type ID; -/*! +/*! returns the dimension of the box. */ static int dimension(); @@ -51,18 +51,18 @@ static int dimension(); /// \name Access Functions /// @{ -/*! +/*! returns the unique `id`-number for the `box`. */ ID id() const; -/*! +/*! returns the lower boundary in dimension `d`, \f$ 0 \leq\f$`d`\f$ < \f$`dimension()`. */ NT min_coord( int d) const; -/*! +/*! returns the upper boundary in dimension `d`, \f$ 0 \leq\f$`d`\f$ < \f$`dimension()`. */ diff --git a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h index 50484fed2f2..0b0614bd52a 100644 --- a/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h +++ b/Box_intersection_d/doc/Box_intersection_d/Concepts/BoxIntersectionTraits_d.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! type used for passing box parameters in the functions below. Since we support in our algorithms passing the boxes by value as well as passing them as pointers, this @@ -35,36 +35,36 @@ would be `B` where this type is `const B&`. */ typedef unspecified_type Box_parameter; -/*! +/*! number type to represent the box boundaries. Allowed are the built-in types `int`, `unsigned int`, `float`, and `double`. */ typedef unspecified_type NT; -/*! +/*! type for the `id`-number, model of the `LessThanComparable` concept. */ typedef unspecified_type ID; -/*! +/*! returns the dimension of the box. */ static int dimension(); -/*! +/*! returns the unique `id`-number for the `box`. */ static ID id(Box_parameter box); -/*! +/*! returns the lower boundary of the `box` in dimension `d`, \f$ 0 \leq\f$`d`\f$ < \f$`dimension()`. */ static NT min_coord( Box_parameter box, int d); -/*! +/*! returns the upper boundary of the `box` in dimension `d`, \f$ 0 \leq\f$`d`\f$ < \f$`dimension()`. */ 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 4a4de7d0c96..930e38930bc 100644 --- a/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h +++ b/CGAL_ipelets/doc/CGAL_ipelets/CGAL/CGAL_Ipelet_base.h @@ -34,74 +34,74 @@ public: /// `Ipelet_base::Ray_2`, `Ipelet_base::Triangle_2` and `Ipelet_base::Iso_rectangle_2`. /// @{ -/*! +/*! The kernel used to define internal types. */ typedef Kernel Kernel; -/*! +/*! The number type of the coordinates. */ typedef Kernel::FT FT; -/*! +/*! The point type. */ typedef Kernel::Point_2 Point_2; -/*! +/*! The circle type. */ typedef Kernel::Circle_2 Circle_2; -/*! +/*! The circular arc type. The `CGAL::Sign`, equals either to `CGAL::COUNTERCLOCKWISE` or `CGAL::CLOCKWISE`, indicates if the arc is the set of points on the circle from the first point to the second point turning clockwise or counterclockwise. */ typedef CGAL::tuple Circular_arc_2; -/*! +/*! The weighted point type. */ typedef CGAL::Weighted_point Weighted_point_2; -/*! +/*! The segment type. */ typedef Kernel::Segment_2 Segment_2; -/*! +/*! The line type. */ typedef Kernel::Line_2 Line_2; -/*! +/*! The ray type. */ typedef Kernel::Ray_2 Ray_2; -/*! +/*! The triangle type. */ typedef Kernel::Triangle_2 Triangle_2; -/*! +/*! The polygon type. */ typedef CGAL::Polygon_2 Polygon_2; -/*! +/*! A type to represent bounding boxes. */ typedef Kernel::Iso_rectangle_2 Iso_rectangle_2; -/*! +/*! Class type providing operators to extract points from segments and polygons. */ template Point_grabber; -/*! +/*! Class type providing operators to extract segments from polygons. */ template Segment_grabber; @@ -111,7 +111,7 @@ template Segment_grabber; /// \name Creation /// @{ -/*! +/*! initializes an ipelet. The string `name` is the name given to the ipelet in the Ipe menu. @@ -130,7 +130,7 @@ CGAL_ipelet(const std::string fct_names[],const std::string help_msg[],const std /// \name Access Functions /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin returns a pointer to an Ipe object representing the drawing page. @@ -139,7 +139,7 @@ Refer to the Ipe library documentation for more details. */ IpePage* get_ipe_page(); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin returns a pointer to an Ipe object providing services to Ipelets. @@ -153,7 +153,7 @@ IpeletHelper* get_ipelet_helper(); /// \name Operations /// @{ -/*! +/*! Prints in Ipe a pop-up help message constructed from the string array of the constructor. This function expects that the last function defined in the ipelet is dedicated to print the help message. When the boolean `one_per_func` is `true`, one help message per function is printed @@ -163,17 +163,17 @@ only one help message is printed using the first string in the array given to th */ void show_help(bool one_per_func=true); -/*! +/*! Prints the string `msg` as a message in Ipe. */ void print_error_message(std::string msg); -/*! +/*! function called when the user selects the \cgal ipelet. */ void protected_run(int i)=0; -/*! +/*! This function assigns to output iterator `out` all handled objects selected in Ipe. Objects read belong to the set of `read objects` (even within groups). @@ -190,7 +190,7 @@ Iso_rectangle_2 read_active_objects(Dispatch_or_drop_output_iterator out, bool deselect_all=true, bool delete_selected_objects=false); -/*! +/*! returns an output iterator which wraps `it`. `OutputIterator` must be a model of the output iterator concept accepting assignments from `Point_2`. The returned output iterator will accept assignments from objects of types @@ -203,7 +203,7 @@ For more details on the returned output iterator refer to the Boost library template boost::function_output_iterator > point_grabber(OutputIterator it); -/*! +/*! returns an output iterator which wraps `it`. `OutputIterator` must be a model of the output iterator concept accepting assignments from `Segment_2`. The returned output iterator will accept assignments from objects of types @@ -216,7 +216,7 @@ For more details on the returned output iterator refer to the Boost library template boost::function_output_iterator > segment_grabber(OutputIterator it); -/*! +/*! This function draws in the page of Ipe a given object. `T` must be a type inside the set of `drawable objects`. @@ -227,14 +227,14 @@ is set to `true`, object drawn is deselected. */ template void draw_in_ipe(const T& object,bool deselect=false); -/*! +/*! Same as above, except that objects are clipped to `bbox` before been drawn. */ template void draw_in_ipe(const T& object, const Iso_rectangle_2& bbox, bool deselect=false); -/*! +/*! This function draws in the page of Ipe a set of objects given by an iterator range. These objects must be of a type inside the set of `drawable objects`. @@ -244,14 +244,14 @@ is set to `true`, objects drawn are deselected. */ template void draw_in_ipe(Iterator begin, Iterator end,bool makegrp=true,bool deselectall=false); -/*! +/*! Same as above, except that objects are clipped to `bbox` before been drawn. */ template void draw_in_ipe(Iterator begin, Iterator end, const Iso_rectangle_2& bbox, bool makegrp=true,bool deselectall=false); -/*! +/*! This function draws in the page of Ipe a polyline defined by an iterator range of points. If the boolean `setclose` is `true`, the polyline drawn is closed. @@ -261,7 +261,7 @@ If the boolean `deselect` is set to `true`, polyline drawn is deselected. template void draw_polyline_in_ipe (iterator first, iterator last,bool setclose=false,bool deselect=false); -/*! +/*! This function draws in the page of Ipe the dual of a 2D \cgal triangulation. The edges of the dual are restricted to the interior of `bbox`. @@ -272,7 +272,7 @@ is set to `true`, segments drawn are deselected. template void draw_dual_in_ipe(Triangulation T,const Iso_rectangle_2& bbox, bool makegrp=true,bool deselect=false); -/*! +/*! This function draws in the page of Ipe the Voronoi segment skeleton from a triangulation of segments. The edges are restricted to the interior of `bbox`. @@ -283,7 +283,7 @@ is set to `true`, segments drawn are deselected. template void draw_skeleton_in_ipe(Triangulation T,const Iso_rectangle_2& bbox, bool makegrp=true,bool deselect=false); -/*! +/*! This function induces the creation of a dialog box requesting a value from the user. The string `msg` is printed in this dialog box. diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h index e3e1fda467d..2ed8beb8ab5 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_2.h @@ -17,12 +17,12 @@ public: /// \name Creation /// @{ -/*! +/*! Constructs an arc from a full circle. */ Circular_arc_2(const Circle_2 &c); -/*! +/*! Constructs the circular arc supported by `c`, whose source is `p` and whose target is `q` when traversing the circle in counterclockwise direction. @@ -32,7 +32,7 @@ Circular_arc_2(const Circle_2 &c, const Circular_arc_point_2 &p, const Circular_arc_point_2 &q); -/*! +/*! Constructs an arc that is supported by the circle of type `Circle_2` passing through the points `p`, `q` and `r`. The source and target are respectively `p` @@ -51,18 +51,18 @@ const Point_2 &r); /// \name Access Functions /// @{ -/*! +/*! */ Circle_2 supporting_circle(); -/*! +/*! returns the center of the supporting circle. */ Point_2 const& center( ) const; -/*! +/*! returns the squared radius of the supporting circle. */ @@ -74,12 +74,12 @@ CircularKernel::FT const& squared_radius( ) const; /// A circular arc is not oriented. Still, its source and target endpoints can be defined, supposing that its supporting circle in traversed the counterclockwise direction from `source` to `target`. /// @{ -/*! +/*! */ Circular_arc_point_2 source(); -/*! +/*! */ Circular_arc_point_2 target(); @@ -95,17 +95,17 @@ Circular_arc_point_2 target(); /// @{ -/*! +/*! \pre `ca`.`is_x_monotone()`. */ Circular_arc_point_2 left(); -/*! +/*! \pre `ca`.`is_x_monotone()`. */ Circular_arc_point_2 right(); -/*! +/*! Returns a bounding box containing the arc. */ Bbox_2 bbox() const; @@ -115,12 +115,12 @@ Bbox_2 bbox() const; /// \name Query Functions /// @{ -/*! +/*! Tests whether the arc is x-monotone. */ bool is_x_monotone(); -/*! +/*! Tests whether the arc is y-monotone. */ bool is_y_monotone(); @@ -129,7 +129,7 @@ bool is_y_monotone(); }; /* end Circular_arc_2 */ -/*! +/*! Test for equality. Two arcs are equal, iff their non-oriented supporting circles are equal (i.e.\ they have same center and same squared radius) and their endpoints are equal. @@ -137,20 +137,20 @@ squared radius) and their endpoints are equal. */ bool operator==(const Circular_arc_2 &ca1, const Circular_arc_2 &ca2); -/*! +/*! Test for non-equality \relates Circular_arc_2 */ bool operator!=(const Circular_arc_2 &ca1, const Circular_arc_2 &ca2); -/*! +/*! \relates Circular_arc_2 */ istream& operator>> (std::istream& is, Circular_arc_2 & ca); -/*! +/*! \relates Circular_arc_2 */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h index 991fe628871..3166a680368 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_arc_point_2.h @@ -17,12 +17,12 @@ public: /// \name Creation /// @{ -/*! +/*! */ Circular_arc_point_2(const CircularKernel::Point_2 &q); -/*! +/*! */ Circular_arc_point_2(const CircularKernel::Root_for_circles_2_2 &r); @@ -32,17 +32,17 @@ Circular_arc_point_2(const CircularKernel::Root_for_circles_2_2 &r); /// \name Access Functions /// @{ -/*! +/*! `x`-coordinate of the point. */ const CircularKernel::Root_of_2 & x(); -/*! +/*! `y`-coordinate of the point. */ const CircularKernel::Root_of_2 & y(); -/*! +/*! Returns a bounding box around the point. */ Bbox_2 bbox() const; @@ -52,52 +52,52 @@ Bbox_2 bbox() const; }; /* end Circular_arc_point_2 */ -/*! +/*! Test for equality. Two points are equal, iff their `x` and `y` coordinates are equal. \relates Circular_arc_point_2 */ bool operator==(const Circular_arc_point_2 &p, const Circular_arc_point_2 &q); -/*! +/*! Test for nonequality. \relates Circular_arc_point_2 */ bool operator!=(const Circular_arc_point_2 &p, const Circular_arc_point_2 &q); -/*! +/*! Returns true iff `p` is lexicographically smaller than `q`, i.e.\ either if `p.x() < q.x()` or if `p.x() == q.x()` and `p.y() < q.y()`. \relates Circular_arc_point_2 */ bool operator<(const Circular_arc_point_2 &p, const Circular_arc_point_2 &q); -/*! +/*! Returns true iff `p` is lexicographically greater than `q`. \relates Circular_arc_point_2 */ bool operator>(const Circular_arc_point_2 &p, const Circular_arc_point_2 &q); -/*! +/*! Returns true iff `p` is lexicographically smaller than or equal to `q`. \relates Circular_arc_point_2 */ bool operator<=(const Circular_arc_point_2 &p, const Circular_arc_point_2 &q); -/*! +/*! Returns true iff `p` is lexicographically greater than or equal to `q`. \relates Circular_arc_point_2 */ bool operator>=(const Circular_arc_point_2 &p, const Circular_arc_point_2 &q); -/*! +/*! \relates Circular_arc_point_2 */ istream& operator>> (std::istream& is, Circular_arc_point_2 & cp); -/*! +/*! \relates Circular_arc_point_2 */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h index e2ebfac236a..7346da54455 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Circular_kernel_2.h @@ -34,12 +34,12 @@ public: /// well as `AlgebraicKernelForCircles::FT` and `Kernel::FT`. /// @{ -/*! +/*! Ring number type. */ typedef AlgebraicKernelForCircles::RT RT; -/*! +/*! Field number type. */ typedef AlgebraicKernelForCircles::FT FT; @@ -51,17 +51,17 @@ typedef AlgebraicKernelForCircles::FT FT; /// functionality on them described in the `CircularKernel` concept. /// @{ -/*! +/*! */ typedef Line_arc_2 Line_arc_2; -/*! +/*! */ typedef Circular_arc_2 Circular_arc_2; -/*! +/*! */ typedef Circular_arc_point_2 Circular_arc_point_2; diff --git a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h index 58da6a4797d..399f104743b 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/CGAL/Line_arc_2.h @@ -23,7 +23,7 @@ public: /// \name Creation /// @{ -/*! +/*! Construct the line segment supported by `l`, whose source is `p1` and whose target is `p2`. \pre `p1` and `p2` lie on `l`. @@ -32,14 +32,14 @@ Line_arc_2(const Line_2 &l, const Circular_arc_point_2 &p1, const Circular_arc_point_2 &p2); -/*! +/*! Same. */ Line_arc_2(const Line_2 &l, const Point_2 &p1, const Point_2 &p2); -/*! +/*! */ Line_arc_2(const Segment_2 &s); @@ -49,32 +49,32 @@ Line_arc_2(const Segment_2 &s); /// \name Access Functions /// @{ -/*! +/*! */ Line_2 supporting_line(); -/*! +/*! */ Circular_arc_point_2 source(); -/*! +/*! */ Circular_arc_point_2 target(); -/*! +/*! */ Circular_arc_point_2 left(); -/*! +/*! */ Circular_arc_point_2 right(); -/*! +/*! Returns a bounding box containing the line segment. */ Bbox_2 bbox() const; @@ -84,7 +84,7 @@ Bbox_2 bbox() const; /// \name Query Functions /// @{ -/*! +/*! */ bool is_vertical(); @@ -94,7 +94,7 @@ bool is_vertical(); }; /* end Line_arc_2 */ -/*! +/*! Test for equality. Two arcs are equal, iff their non-oriented supporting lines are equal (i.e.\ they contain the same set of points) and their endpoints are equal. @@ -102,19 +102,19 @@ points) and their endpoints are equal. */ bool operator==(const Line_arc_2 &la1, const Line_arc_2 &la2); -/*! +/*! Test for non-equality. \relates Line_arc_2 */ bool operator!=(const Line_arc_2 &la1, const Line_arc_2 &la2); -/*! +/*! \relates Line_arc_2 */ istream& operator>> (std::istream& is, Line_arc_2 & ca); -/*! +/*! \relates Line_arc_2 */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h index 8b6d188d0dd..f151d18c4a4 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareX.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the `x` (first) variables of two `Root_for_circles_2_2`. */ template < class OutputIterator > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h index 833686484b1..56a481a5d29 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareXY.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares two `Root_for_circles_2_2` lexicographically. */ template < class OutputIterator > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h index 822566fcfea..3b1a4f33931 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--CompareY.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the `y` (second) variables of two `Root_for_circles_2_2`. */ template < class OutputIterator > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h index ac72651c952..d84da07d998 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomialForCircles_2_2.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs polynomial `(x-a)^2 + (y-b)^2 - rsq`. */ AlgebraicKernelForCircles::PolynomialForCircles_2_2 diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h index c1f221f4bf3..3005eb2d6b5 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--ConstructPolynomial_1_2.h @@ -16,7 +16,7 @@ public: /// @{ -/*! +/*! Constructs polynomial `ax+by+c`. */ AlgebraicKernelForCircles::Polynomial_1_2 diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h index 8f114b1a1d7..ec08a2a4b56 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--PolynomialForCircles_2_2.h @@ -26,7 +26,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! */ bool operator ==(AlgebraicKernelForCircles::const PolynomialForCircles_2_2 & p, diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h index 58e3c9d2abd..e8a171ac3a7 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--RootForCircles_2_2.h @@ -20,7 +20,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! */ bool operator ==( const AlgebraicKernelForCircles::RootForCircles_2_2 & p, diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h index b76668957b2..125ad326094 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--SignAt.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Computes the sign of polynomial `p` evaluated at a root `r`. */ template < class OutputIterator > @@ -20,7 +20,7 @@ CGAL::Sign operator()(const AlgebraicKernelForCircles::Polynomial_1_2 & p, const AlgebraicKernelForCircles::Root_for_circles_2_2 & r); -/*! +/*! Same as previous. */ template < class OutputIterator > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h index 111cda23ec0..7dbae05d1a0 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--Solve.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the common roots of `p1` and `p2`, with their multiplicity, as objects of type `std::pair< AlgebraicKernelForCircles::Root_for_circles_2_2, int>`. @@ -23,7 +23,7 @@ operator()(const AlgebraicKernelForCircles::Polynomial_1_2 &p1, const AlgebraicKernelForCircles::Polynomial_1_2 &p2, OutputIterator res); -/*! +/*! Same as previous. */ template < class OutputIterator > @@ -32,7 +32,7 @@ operator()(const AlgebraicKernelForCircles::Polynomial_1_2 &p1, const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p2, OutputIterator res); -/*! +/*! Same as previous. */ template < class OutputIterator > @@ -41,7 +41,7 @@ operator()(const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p1, const AlgebraicKernelForCircles::Polynomial_1_2 &p2, OutputIterator res); -/*! +/*! Same as previous. */ template < class OutputIterator > diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h index 87bee83b51f..b5073346f09 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--XCriticalPoints.h @@ -14,7 +14,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the `x`-critical points of polynomial `p`, as objects of type `AlgebraicKernelForCircles::Root_for_circles_2_2`. */ @@ -23,7 +23,7 @@ OutputIterator operator()(const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p, OutputIterator res); -/*! +/*! Computes the `x`-critical point with smallest (resp.\ largest) `x` of polynomial `p` if `b` is `true` (resp.\ `false`). */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h index 9ce0e369d62..7ea7aff383b 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles--YCriticalPoints.h @@ -14,7 +14,7 @@ public: /// A model `fo` of this type must provide: /// @{ -/*! +/*! Copies in the output iterator the `y`-critical points of polynomial `p`, as objects of type `AlgebraicKernelForCircles::Root_for_circles_2_2`. */ @@ -23,7 +23,7 @@ OutputIterator operator()(const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p, OutputIterator res); -/*! +/*! Computes the `y`-critical point with smallest (resp.\ largest) `y` of polynomial `p` if `b` is `true` (resp.\ `false`). */ diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h index 90bf22b2446..57da6cf6d54 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/AlgebraicKernelForCircles.h @@ -21,38 +21,38 @@ public: /// A model of `AlgebraicKernelForCircles` is supposed to provide /// @{ -/*! +/*! A model of `RingNumberType`. */ typedef unspecified_type RT; -/*! +/*! A model of `FieldNumberType```. */ typedef unspecified_type FT; -/*! +/*! A model of `AlgebraicKernelForCircles::Polynomial_1_2`, for bivariate polynomials of degree up to 1. */ typedef unspecified_type Polynomial_1_2; -/*! +/*! A model of `AlgebraicKernelForCircles::PolynomialForCircles_2_2`, for bivariate polynomials of degree up to 2 that can store equations of circles. */ typedef unspecified_type Polynomial_for_circles_2_2; -/*! +/*! A model of `RootOf_2`, for algebraic numbers of degree up to 2. */ typedef unspecified_type Root_of_2; -/*! +/*! A model of `AlgebraicKernelForCircles::RootForCircles_2_2`, for solutions of systems of two models of @@ -60,54 +60,54 @@ solutions of systems of two models of */ typedef unspecified_type Root_for_circles_2_2; -/*! +/*! A model of `AlgebraicKernelForCircles::ConstructPolynomial_1_2`. */ typedef unspecified_type Construct_polynomial_1_2; -/*! +/*! A model of `AlgebraicKernelForCircles::ConstructPolynomialForCircles_2_2`. */ typedef unspecified_type Construct_polynomial_for_circles_2_2; -/*! +/*! A model of the concept `AlgebraicKernelForCircles::CompareX`. */ typedef unspecified_type Compare_x; -/*! +/*! A model of the concept `AlgebraicKernelForCircles::CompareY`. */ typedef unspecified_type Compare_y; -/*! +/*! A model of the concept `AlgebraicKernelForCircles::CompareXY`. */ typedef unspecified_type Compare_xy; -/*! +/*! A model of the concept `AlgebraicKernelForCircles::SignAt`. */ typedef unspecified_type Sign_at; -/*! +/*! A model of the concept `AlgebraicKernelForCircles::XCriticalPoints`. */ typedef unspecified_type X_critical_points; -/*! +/*! A model of the concept `AlgebraicKernelForCircles::YCriticalPoints`. */ typedef unspecified_type Y_critical_points; -/*! +/*! A model of the concept `AlgebraicKernelForCircles::Solve`. */ typedef unspecified_type Solve; diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h index 219d1b80725..edb7a0cba6b 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--BoundedSide_2.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! */ Bounded_side diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h index 214e45e6fac..a48163d16ec 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareXY_2.h @@ -18,7 +18,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares \f$ p\f$ and \f$ q\f$ according to the lexicographic ordering on \f$ x\f$- and \f$ y\f$-coordinates. */ Comparison_result operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h index 5b45032bca7..8b26c299feb 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareX_2.h @@ -18,7 +18,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the `x`-coordinates of `p` and `q`. */ Comparison_result operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h index 768fda88193..30779892646 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareY_2.h @@ -18,7 +18,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the \f$ y\f$-coordinates of \f$ p\f$ and \f$ q\f$. */ Comparison_result operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h index af11ab25d07..911d9d10e69 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYatX_2.h @@ -14,7 +14,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! For a circular arc. \pre The arc `a` must be monotone and `p` must be in the vertical range of `a`. */ @@ -22,7 +22,7 @@ Comparison_result operator() (const CircularKernel::Circular_arc_point_2 &p, const CircularKernel::Circular_arc_2 &a); -/*! +/*! Same for a segment. */ Comparison_result operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h index fb76fca12b8..e491dde878d 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--CompareYtoRight_2.h @@ -15,7 +15,7 @@ public: /// @{ -/*! +/*! For two circular arcs. \pre `p` must be a common point to `a1` and `a2`, and `a1` and `a2` must be defined to the right of `p`. */ @@ -24,7 +24,7 @@ Comparison_result operator() const Circular_kernel_2::Circular_arc_2 &a2, const Circular_kernel_2::Circular_arc_point_2 &p); -/*! +/*! Same for two segments. */ Comparison_result operator() @@ -32,7 +32,7 @@ Comparison_result operator() const Circular_kernel_2::Line_arc_2 &a2, const Circular_kernel_2::Circular_arc_point_2 &p); -/*! +/*! For a segment and an arc. */ Comparison_result operator() @@ -40,7 +40,7 @@ Comparison_result operator() const Circular_kernel_2::Circular_arc_2 &a2, const Circular_kernel_2::Circular_arc_point_2 &p); -/*! +/*! Same as previous. */ Comparison_result operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h index 97937059e86..ed2e467370a 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularX_2.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Computes the `x`-coordinate of the point. */ CircularKernel::Root_of_2 diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h index c4ff81cfc7d..6eeb1108e98 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ComputeCircularY_2.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Computes the `y`-coordinate of the point. */ CircularKernel::Root_of_2 diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h index e8cb257b403..884b35561f7 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructBbox_2.h @@ -17,19 +17,19 @@ public: /// @{ -/*! +/*! */ CGAL::Bbox_2 operator() (const CircularKernel::Circular_arc_point_2 & p); -/*! +/*! */ CGAL::Bbox_2 operator() (const CircularKernel::Line_arc_2 & l); -/*! +/*! */ CGAL::Bbox_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h index b0bc53e9b45..f01b0029399 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircle_2.h @@ -16,13 +16,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the supporting circle of a circular arc. */ CircularKernel::Circle_2 operator() (CircularKernel::CircularArc_2); -/*! +/*! Constructs a circle from an equation. */ CircularKernel::Circle_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h index a4c15700805..eac9ee0ed5d 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArcPoint_2.h @@ -12,13 +12,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! */ CircularKernel::Circular_arc_point_2 operator() (const CircularKernel::Root_for_circles_2_2 & r); -/*! +/*! */ CircularKernel::Circular_arc_point_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h index ddfffcf5124..628b54dbe27 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularArc_2.h @@ -12,13 +12,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs an arc from a full circle. */ CircularKernel::Circular_arc_2 operator() (const CircularKernel::Circle_2 &c); -/*! +/*! Construct the circular arc supported by `c`, whose source is `p1` and whose target is `p2` when traversing the circle in counterclockwise direction. @@ -29,7 +29,7 @@ CircularKernel::Circular_arc_2 operator() const CircularKernel::Circular_arc_point_2 &p1, const CircularKernel::Circular_arc_point_2 &p2); -/*! +/*! Constructs the unique circular arc whose supporting circle is `c`, and whose source is the intersection of `c` and `c1` with index `b1`, and whose target is the intersection @@ -43,7 +43,7 @@ CircularKernel::Circular_arc_2 operator() const CircularKernel::Circle_2 &c1, bool b1, const CircularKernel::Circle_2 &c2, bool b2); -/*! +/*! Same, for intersections defined by lines instead of circles. */ CircularKernel::Circular_arc_2 operator() @@ -51,7 +51,7 @@ CircularKernel::Circular_arc_2 operator() const CircularKernel::Line_2 &l1, bool b1, const CircularKernel::Line_2 &l2, bool b2); -/*! +/*! Constructs an arc that is supported by the circle of type `CircularKernel::Circle_2` passing through the points `p`, `q` and `r`. The source and target are respectively `p` diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h index d01edbc1e86..b2a4a7b5190 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMaxVertex_2.h @@ -12,14 +12,14 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the `x`-maximal vertex of `c`. \pre The arc `c` is `x`-monotone. */ CircularKernel::Circular_arc_point_2 operator() (const CircularKernel::Circular_arc_2 & c); -/*! +/*! Same, for a line segment. */ CircularKernel::Circular_arc_point_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h index 5b98466ae38..6d9b05ce175 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularMinVertex_2.h @@ -12,14 +12,14 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the `x`-minimal vertex of `c`. \pre The arc `c` is `x`-monotone. */ CircularKernel::Circular_arc_point_2 operator() (const CircularKernel::Circular_arc_2 & c); -/*! +/*! Same, for a line segment. */ CircularKernel::Circular_arc_point_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h index 74f7da37560..201150d672d 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularSourceVertex_2.h @@ -13,13 +13,13 @@ public: /// @{ -/*! +/*! Constructs the source vertex of `c`. */ CircularKernel::Circular_arc_point_2 operator() (const CircularKernel::Circular_arc_2 & c); -/*! +/*! Same, for a line segment. */ CircularKernel::Circular_arc_point_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h index 8dca6628a87..17793c54913 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructCircularTargetVertex_2.h @@ -13,13 +13,13 @@ public: /// @{ -/*! +/*! Constructs the target vertex of `c`. */ CircularKernel::Circular_arc_point_2 operator() (const CircularKernel::Circular_arc_2 & c); -/*! +/*! Same, for a line segment. */ CircularKernel::Circular_arc_point_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h index 115231b79de..c1e50206c60 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLineArc_2.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the line segment supported by `l`, whose source is `p1` and whose target is `p2`. \pre `p1` and `p2` lie on `l`. @@ -22,20 +22,20 @@ CircularKernel::Line_arc_2 operator() const CircularKernel::Circular_arc_point_2 &p1, const CircularKernel::Circular_arc_point_2 &p2); -/*! +/*! */ CircularKernel::Line_arc_2 operator() (const CircularKernel::Segment_2 &s); -/*! +/*! */ CircularKernel::Line_arc_2 operator() (const CircularKernel::Point_2 &p1, const CircularKernel::Point_2 &p2); -/*! +/*! Constructs the line segment whose supporting line is `l`, whose source endpoint is the \f$ b_1^{th}\f$ intersection of `l` with `c1`, and whose target endpoint is the \f$ b_2^{th}\f$ intersection of `l` @@ -47,7 +47,7 @@ CircularKernel::Line_arc_2 operator() const CircularKernel::Circle_2 &c1, bool b1, const CircularKernel::Circle_2 &c2, bool b2); -/*! +/*! Same, for intersections defined by lines instead of circles. */ CircularKernel::Line_arc_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h index 52838beef61..c72a4fb1cc3 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--ConstructLine_2.h @@ -16,13 +16,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the supporting line of a line segment. */ CircularKernel::Line_2 operator() (CircularKernel::LineArc_2); -/*! +/*! Constructs a line from an equation. */ CircularKernel::Line_2 operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h index 4e1f6f5a701..c7cf25c8fd5 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoIntersect_2.h @@ -18,7 +18,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! determines if two geometric objects of type `Type1` and `Type2` intersect or not, for all pairs `Type1` and `Type2`, where the types `Type1` and `Type2` can be any of the following: diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h index e440055c1a8..70c9d434c2f 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--DoOverlap_2.h @@ -14,14 +14,14 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! For two line arcs. */ bool operator() (const CircularKernel::Line_arc_2 & l0, const CircularKernel::Line_arc_2 & l1); -/*! +/*! For two circular arcs. */ bool operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h index 21d2d3dbc60..45432d330a1 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Equal_2.h @@ -20,21 +20,21 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! For two points. */ bool operator() (const CircularKernel::Circular_arc_point_2 &p0, const CircularKernel::Circular_arc_point_2 &p1); -/*! +/*! For two arcs. */ bool operator() (const CircularKernel::Circular_arc_2 &a0, const CircularKernel::Circular_arc_2 &a1); -/*! +/*! For two segments. */ bool operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h index 5e2c5bd2cf4..5f97c20f01e 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--GetEquation.h @@ -15,13 +15,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Returns the equation of the line. */ CircularKernel::Polynomial_1_2 operator()(const CircularKernel::Line_2 & c); -/*! +/*! Returns the equation of the circle. */ CircularKernel::Polynomial_for_circles_2_2 diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h index c33135b8fcb..a1e6162fe05 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnBoundedSide_2.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! */ bool diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h index ff982483c9c..2ce3eb432f0 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOnUnboundedSide_2.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! */ bool diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h index c1f9958f9ce..2b218e1daba 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--HasOn_2.h @@ -15,28 +15,28 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! For a line. */ bool operator() (const CircularKernel::Line_2 & l, const CircularKernel::Circular_arc_point_2 &p); -/*! +/*! For a circle. */ bool operator() (const CircularKernel::Circle_2 & c, const CircularKernel::Circular_arc_point_2 &p); -/*! +/*! For a line arc. */ bool operator() (const CircularKernel::Line_arc_2 & l, const CircularKernel::Circular_arc_point_2 &p); -/*! +/*! For a circular arc. */ bool operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h index 22a14d5a437..464cc2033b5 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--InXRange_2.h @@ -14,14 +14,14 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! For a line arc. */ bool operator() (const CircularKernel::Line_arc_2 & l, const CircularKernel::Circular_arc_point_2 & p); -/*! +/*! For a circular arc. \pre `c` is `x`-monotone. */ bool operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h index 48dcdadb737..800827614b5 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Intersect_2.h @@ -16,7 +16,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the intersection elements between the two objects. `intersections` iterates on elements of type `CGAL::Object`, in lexicographic order. diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h index d64a41fed3b..37bdc0b055c 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsVertical_2.h @@ -13,13 +13,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! For a line arc. */ bool operator() (const CircularKernel::Line_arc_2 & l); -/*! +/*! For a circular arc, always returns `false`. */ bool operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h index 51a6f2d23ad..b2c8345ffbf 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsXMonotone_2.h @@ -12,13 +12,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Tests whether the arc is `x`-monotone. */ bool operator() (const CircularKernel::Circular_arc_2 & c); -/*! +/*! For a line arc, always returns `true`. */ bool operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h index eaff197011f..ac4aa4f68bf 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--IsYMonotone_2.h @@ -12,13 +12,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Tests whether the arc is `y`-monotone. */ bool operator() (const CircularKernel::Circular_arc_2 & c); -/*! +/*! For a line arc, always returns `true`. */ bool operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h index 54a0500166c..42f63e8adde 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXMonotone_2.h @@ -14,7 +14,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Splits the arc `ca` into `x`-monotone arcs that are returned through the output iterator. Note that, to ensure an easy interface with the `Arrangement_2` package, the arcs are returned as `CGAL::Object`'s diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h index 206b3262f3d..4cefff436ea 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--MakeXYMonotone_2.h @@ -14,7 +14,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Splits the arc `ca` into `y`-monotone arcs that are returned through the output iterator. Note that, to ensure an easy interface with the `Arrangement_2` package, the arcs are returned as `CGAL::Object`'s diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h index d1e7ac239e6..1b693ddf7a0 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel--Split_2.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Splits arc `a` at point `p`, which creates arcs `a1` and `a2`. \pre The point lies on the input arc. */ @@ -22,7 +22,7 @@ const CircularKernel::Circular_arc_point_2 &p, CircularKernel::Circular_arc_2 &a1, CircularKernel::Circular_arc_2 &a2); -/*! +/*! Same for a line arc. */ void operator() diff --git a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h index 215ce0a078d..88a08e5fd2a 100644 --- a/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h +++ b/Circular_kernel_2/doc/Circular_kernel_2/Concepts/CircularKernel.h @@ -22,72 +22,72 @@ public: /// and other functionalities. /// @{ -/*! +/*! Model of `LinearKernel`. */ typedef unspecified_type Linear_kernel; -/*! +/*! Model of `AlgebraicKernelForCircles`. */ typedef unspecified_type Algebraic_kernel; -/*! +/*! Model of `RingNumberType`. */ typedef unspecified_type RT; -/*! +/*! Model of `FieldNumberType`. */ typedef unspecified_type FT; -/*! +/*! Model of `RootOf_2`. */ typedef unspecified_type Root_of_2; -/*! +/*! Model of `AlgebraicKernelForCircles::RootForCircles_2_2`. */ typedef unspecified_type Root_for_circles_2_2; -/*! +/*! Model of `AlgebraicKernelForCircles::Polynomial_1_2`. */ typedef unspecified_type Polynomial_1_2; -/*! +/*! Model of `AlgebraicKernelForCircles::PolynomialForCircles_2_2`. */ typedef unspecified_type Polynomial_for_circles_2_2; -/*! +/*! Model of `Kernel::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! Model of `Kernel::Line_2`. */ typedef unspecified_type Line_2; -/*! +/*! Model of `Kernel::Circle_2`. */ typedef unspecified_type Circle_2; -/*! +/*! Model of `CircularKernel::LineArc_2`. */ typedef unspecified_type Line_arc_2; -/*! +/*! Model of `CircularKernel::CircularArc_2`. */ typedef unspecified_type Circular_arc_2; -/*! +/*! Model of `CircularKernel::CircularArcPoint_2`. */ typedef unspecified_type Circular_arc_point_2; @@ -97,82 +97,82 @@ typedef unspecified_type Circular_arc_point_2; /// \name Predicates /// @{ -/*! +/*! Model of `CircularKernel::CompareX_2`. */ typedef unspecified_type Compare_x_2; -/*! +/*! Model of `CircularKernel::CompareY_2`. */ typedef unspecified_type Compare_y_2; -/*! +/*! Model of `CircularKernel::CompareXY_2`. */ typedef unspecified_type Compare_xy_2; -/*! +/*! Model of `CircularKernel::Equal_2`. */ typedef unspecified_type Equal_2; -/*! +/*! Model of `CircularKernel::CompareYatX_2`. */ typedef unspecified_type Compare_y_at_x_2; -/*! +/*! Model of `CircularKernel::CompareYtoRight_2`. */ typedef unspecified_type Compare_y_to_right_2; -/*! +/*! Model of `CircularKernel::HasOn_2`. */ typedef unspecified_type Has_on_2; -/*! +/*! Model of `CircularKernel::DoOverlap_2`. */ typedef unspecified_type Do_overlap_2; -/*! +/*! Model of `CircularKernel::DoIntersect_2`. */ typedef unspecified_type Do_intersect_2; -/*! +/*! Model of `CircularKernel::BoundedSide_2`. */ typedef unspecified_type Bounded_side_2; -/*! +/*! Model of `CircularKernel::HasOnBoundedSide_2`. */ typedef unspecified_type Has_on_bounded_side_2; -/*! +/*! Model of `CircularKernel::HasOnUnboundedSide_2`. */ typedef unspecified_type Has_on_unbounded_side_2; -/*! +/*! Model of `CircularKernel::InXRange_2`. */ typedef unspecified_type In_x_range_2; -/*! +/*! Model of `CircularKernel::IsVertical_2`. */ typedef unspecified_type Is_vertical_2; -/*! +/*! Model of `CircularKernel::IsXMonotone_2`. */ typedef unspecified_type Is_x_monotone_2; -/*! +/*! Model of `CircularKernel::IsYMonotone_2`. */ typedef unspecified_type Is_y_monotone_2; @@ -182,12 +182,12 @@ typedef unspecified_type Is_y_monotone_2; /// \name Constructions /// @{ -/*! +/*! Model of `CircularKernel::ConstructLine_2`. */ typedef unspecified_type Construct_line_2; -/*! +/*! Model of `CircularKernel::ConstructCircle_2`. */ typedef unspecified_type Construct_circle_2; @@ -197,67 +197,67 @@ Model of `CircularKernel::ConstructBbox_2`. */ typedef unspecified_type Construct_bbox_2; -/*! +/*! Model of `CircularKernel::ConstructCircularArcPoint_2`. */ typedef unspecified_type Construct_circular_arc_point_2; -/*! +/*! Model of `CircularKernel::ConstructLineArc_2`. */ typedef unspecified_type Construct_line_arc_2; -/*! +/*! Model of `CircularKernel::ConstructCircularArc_2`. */ typedef unspecified_type Construct_circular_arc_2; -/*! +/*! Model of `CircularKernel::ComputeCircularX_2` */ typedef unspecified_type Compute_circular_x_2; -/*! +/*! Model of `CircularKernel::ComputeCircularY_2` */ typedef unspecified_type Compute_circular_y_2; -/*! +/*! Model of `CircularKernel::ConstructCircularMinVertex_2`. */ typedef unspecified_type Construct_circular_min_vertex_2; -/*! +/*! Model of `CircularKernel::ConstructCircularMaxVertex_2`. */ typedef unspecified_type Construct_circular_max_vertex_2; -/*! +/*! Model of `CircularKernel::ConstructCircularSourceVertex_2`. */ typedef unspecified_type Construct_circular_source_vertex_2; -/*! +/*! Model of `CircularKernel::ConstructCircularTargetVertex_2`. */ typedef unspecified_type Construct_circular_target_vertex_2; -/*! +/*! Model of `CircularKernel::Intersect_2`. */ typedef unspecified_type Intersect_2; -/*! +/*! Model of `CircularKernel::Split_2`. */ typedef unspecified_type Split_2; -/*! +/*! Model of `CircularKernel::MakeXMonotone_2`. */ typedef unspecified_type Make_x_monotone_2; -/*! +/*! Model of `CircularKernel::MakeXYMonotone_2`. */ typedef unspecified_type Make_xy_monotone_2; @@ -267,7 +267,7 @@ typedef unspecified_type Make_xy_monotone_2; /// \name Link with the algebraic kernel /// @{ -/*! +/*! Model of `CircularKernel::GetEquation`. */ typedef unspecified_type Get_equation; @@ -284,7 +284,7 @@ typedef unspecified_type Get_equation; /// following member function must exist: /// @{ -/*! +/*! */ Construct_circular_arc_2 construct_circular_arc_2_object() const; diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h index 023e0c82d99..eea28fb3796 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_3.h @@ -23,12 +23,12 @@ public: /// \name Creation /// @{ -/*! +/*! Constructs an arc from a full circle. */ Circular_arc_3(const Circle_3 &c); -/*! +/*! Constructs an arc from a full circle, using pt as source and target. */ Circular_arc_3(const Circle_3 &c, const Circular_arc_point_3& pt); @@ -46,7 +46,7 @@ Circular_arc_3(const Circle_3 &c, const Circular_arc_point_3& p /// if \f$ (a,b,c)>(0,0,0)\f$ (i.e.\ \f$ (a>0) || (a==0) \&\& (b>0) || (a==0)\&\&(b==0)\&\&(c>0)\f$). /// @{ -/*! +/*! Constructs the circular arc supported by `c`, whose source and target are `p` and `q`, respectively. \pre `p` and `q` lie on `c` and are different. @@ -55,7 +55,7 @@ Circular_arc_3(const Circle_3 &c, const Circular_arc_point_3 &p, const Circular_arc_point_3 &q); -/*! +/*! Constructs an arc that is supported by the circle of type `Circle_3` passing through the points `p`, `q` and `r`. The source and target are respectively `p` @@ -76,29 +76,29 @@ const Point_3 &r); /// \name Access Functions /// @{ -/*! +/*! */ Circle_3 supporting_circle(); -/*! +/*! returns the center of the supporting circle. */ Point_3 const& center( ) const; -/*! +/*! returns the squared radius of the supporting circle. */ SphericalKernel::FT const& squared_radius( ) const; -/*! +/*! */ Plane_3 supporting_plane(); -/*! +/*! */ Sphere_3 diametral_sphere(); @@ -114,17 +114,17 @@ Sphere_3 diametral_sphere(); /// \f$ y\f$-extremal point otherwise. /// @{ -/*! +/*! */ Circular_arc_point_3 source(); -/*! +/*! */ Circular_arc_point_3 target(); -/*! +/*! Test for equality. Two arcs are equal, iff their non-oriented supporting planes are equal, and the centers and squared radii of their respective supporting circles are equal, and their @@ -132,7 +132,7 @@ sources and targets are equal. */ bool operator==(const Circular_arc_3 &a1, const Circular_arc_3 &a2); -/*! +/*! Test for nonequality. */ bool operator!=(const Circular_arc_3 &a1, @@ -142,13 +142,13 @@ const Circular_arc_3 &a2); }; /* end Circular_arc_3 */ -/*! +/*! \relates Circular_arc_3 */ istream& operator>> (std::istream& is, Circular_arc_3 & ca); -/*! +/*! \relates Circular_arc_3 */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h index a02a4c23c5d..dedfefdbf5a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Circular_arc_point_3.h @@ -17,12 +17,12 @@ public: /// \name Creation /// @{ -/*! +/*! */ Circular_arc_point_3(const Point_3 &q); -/*! +/*! */ Circular_arc_point_3(const SphericalKernel::Root_for_spheres_2_3 &r); @@ -32,22 +32,22 @@ Circular_arc_point_3(const SphericalKernel::Root_for_spheres_2_3 &r); /// \name Access Functions /// @{ -/*! +/*! \f$ x\f$-coordinate of the point. */ const SphericalKernel::Root_of_2 & x(); -/*! +/*! \f$ y\f$-coordinate of the point. */ const SphericalKernel::Root_of_2 & y(); -/*! +/*! \f$ z\f$-coordinate of the point. */ const SphericalKernel::Root_of_2 & z(); -/*! +/*! Returns a bounding box around the point. */ Bbox_3 bbox() const; @@ -57,20 +57,20 @@ Bbox_3 bbox() const; }; /* end Circular_arc_point_3 */ -/*! +/*! Test for equality. Two points are equal, iff their \f$ x\f$, \f$ y\f$ and \f$ z\f$ coordinates are equal. \relates Circular_arc_point_3 */ bool operator==(const Circular_arc_point_3 &p, const Circular_arc_point_3 &q); -/*! +/*! Test for nonequality. \relates Circular_arc_point_3 */ bool operator!=(const Circular_arc_point_3 &p, const Circular_arc_point_3 &q); -/*! +/*! Returns true iff `p` is lexicographically smaller than `q`, i.e.\ either if `p.x() < q.x()` or if `p.x() == q.x()` and `p.y() < q.y()` or if `p.x() == q.x()` and `p.y() == q.y()` and `p.z() < q.z()`. @@ -78,31 +78,31 @@ or if `p.x() == q.x()` and `p.y() == q.y()` and `p.z() < q.z()`. */ bool operator<(const Circular_arc_point_3 &p, const Circular_arc_point_3 &q); -/*! +/*! Returns true iff `p` is lexicographically greater than `q`. \relates Circular_arc_point_3 */ bool operator>(const Circular_arc_point_3 &p, const Circular_arc_point_3 &q); -/*! +/*! Returns true iff `p` is lexicographically smaller than or equal to `q`. \relates Circular_arc_point_3 */ bool operator<=(const Circular_arc_point_3 &p, const Circular_arc_point_3 &q); -/*! +/*! Returns true iff `p` is lexicographically greater than or equal to `q`. \relates Circular_arc_point_3 */ bool operator>=(const Circular_arc_point_3 &p, const Circular_arc_point_3 &q); -/*! +/*! \relates Circular_arc_point_3 */ istream& operator>> (std::istream& is, Circular_arc_point_3 & p); -/*! +/*! \relates Circular_arc_point_3 */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h index 7e94edb5802..52916046472 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Line_arc_3.h @@ -16,7 +16,7 @@ public: /// \name Creation /// @{ -/*! +/*! Construct the line segment supported by `l`, whose source is `p1`, and whose target is `p2`. \pre `p1` and `p2` lie on `l`. `p1` and `p2` are different. @@ -25,14 +25,14 @@ Line_arc_3(const Line_3 &l, const Circular_arc_point_3 &p1, const Circular_arc_point_3 &p2); -/*! +/*! Same. */ Line_arc_3(const Line_3 &l, const Point_3 &p1, const Point_3 &p2); -/*! +/*! */ Line_arc_3(const Segment_3 &s); @@ -42,28 +42,28 @@ Line_arc_3(const Segment_3 &s); /// \name Access Functions /// @{ -/*! +/*! */ Line_3 supporting_line(); -/*! +/*! */ Circular_arc_point_3 source(); -/*! +/*! */ Circular_arc_point_3 target(); -/*! +/*! Constructs the minimum vertex according to the lexicographic ordering of coordinates. */ Circular_arc_point_3 min(); -/*! +/*! Same for the maximum vertex. */ Circular_arc_point_3 max(); @@ -73,32 +73,32 @@ Circular_arc_point_3 max(); /// \name Query Functions /// @{ -/*! +/*! Returns true `iff` the segment is vertical. */ bool is_vertical(); -/*! +/*! Test for equality. Two segments are equal, iff their non-oriented supporting lines are equal (i.e.\ they define the same set of points), and their endpoints are the same. */ bool operator==(const Line_arc_3 &s1, const Line_arc_3 &s2); -/*! +/*! Test for nonequality. */ bool operator!=(const Line_arc_3 &s1, const Line_arc_3 &s2); -/*! +/*! The format for input/output is, for each line arc: a `Line_3` (the supporting line) and two `Circular_arc_point_3` (the two endpoints), under the condition that the endpoints are actually lying on the line. */ istream& operator>> (std::istream& is, Line_arc_3 & ca); -/*! +/*! The format for input/output is, for each line arc: a `Line_3` (the supporting line) and two `Circular_arc_point_3` (the two endpoints), under the condition that the endpoints are actually lying on the line. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h index 717f4f5150c..24bc8de658f 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/CGAL/Spherical_kernel_3.h @@ -35,12 +35,12 @@ public: /// `Kernel::FT`. /// @{ -/*! +/*! Ring number type. */ typedef AlgebraicKernelForSpheres::RT RT; -/*! +/*! Field number type. */ typedef AlgebraicKernelForSpheres::FT FT; @@ -57,17 +57,17 @@ typedef AlgebraicKernelForSpheres::FT FT; /// model of `AlgebraicKernelForSpheres::PolynomialsForCircles_3`. /// @{ -/*! +/*! */ typedef Line_arc_3 Line_arc_3; -/*! +/*! */ typedef Circular_arc_3 Circular_arc_3; -/*! +/*! */ typedef Circular_arc_point_3 Circular_arc_point_3; diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h index 116e233bb56..7ef5402dc3e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareX.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the `x` (first) variables of two `Root_for_spheres_2_3`. */ CGAL::Comparison_result diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h index 1edd14c7f7c..60cfffab7ed 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXY.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the `x` and `y` (the two first) variables of two `Root_for_spheres_2_3` lexicographically. */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h index 8f541e7388c..92dd9bc52d7 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareXYZ.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares two `Root_for_spheres_2_3` lexicographically. */ CGAL::Comparison_result diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h index a14f7c85237..2d8cb30cf48 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareY.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the `y` (second) variables of two `Root_for_spheres_2_3`. */ CGAL::Comparison_result diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h index 1f7e8972937..2a2743f67c4 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--CompareZ.h @@ -17,7 +17,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the \f$ z\f$-coordinates of two `Root_for_spheres_2_3`. */ CGAL::Comparison_result diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h index be58e0d6f36..73517c1da08 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialForSpheres_2_3.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs polynomial `(x-a)^2 + (y-b)^2 + (z-c)^2 - rsq`. */ AlgebraicKernelForSpheres::PolynomialForSpheres_2_3 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h index a5b7b168700..1860c7088d5 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomial_1_3.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs polynomial `ax+by+cz+d`. */ AlgebraicKernelForSpheres::Polynomial_1_3 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h index 070d78268ce..766c1fa5833 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ConstructPolynomialsForLines_3.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs polynomials `a1.t+a2`, `b1.t+b2`, `c1.t+c2`. */ AlgebraicKernelForSpheres::Polynomials_for_line_3 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h index 300cd3fc7ae..9a41be9e609 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--PolynomialForSpheres_2_3.h @@ -26,7 +26,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Tests equality of two polynomials. */ bool operator ==(const AlgebraicKernelForSpheres::PolynomialForSpheres_2_3 & p, diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h index c5c9583dadf..da3556e3fe8 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--RootForSpheres_2_3.h @@ -20,7 +20,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Test equality of two roots of systems. */ bool operator ==(const AlgebraicKernelForSpheres::RootForSpheres_2_3 & r1, diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h index 5b5315fa01c..e447c16569e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--SignAt.h @@ -12,14 +12,14 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Computes the sign of polynomial `p` evaluated at a root `r`. */ CGAL::Sign operator()(const AlgebraicKernelForSpheres::Polynomial_1_3 & p, const AlgebraicKernelForSpheres::Root_for_spheres_2_3 & r); -/*! +/*! Same as previous. */ CGAL::Sign diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h index 1ac1ea695c7..6c2cab02d7b 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--Solve.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the common roots of `p1`, `p2`, and `p3`, with their multiplicity, as objects of type `std::pair< AlgebraicKernelForSpheres::Root_for_spheres_2_3, int>`. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h index 8d9fdb48551..c1ec1bf7e91 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--XCriticalPoints.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the `x`-critical points of polynomial `p`, as objects of type `AlgebraicKernelForSpheres::Root_for_spheres_2_3`. */ @@ -24,7 +24,7 @@ OutputIterator operator()(const AlgebraicKernelForSpheres::Polynomial_for_spheres_2_3 &p, OutputIterator res); -/*! +/*! Computes the `i`th `x`-critical point of polynomial `p`. */ template < class OutputIterator > diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h index 6f603587e2d..8201c661c4d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--YCriticalPoints.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the `y`-critical points of polynomial `p`, as objects of type `AlgebraicKernelForSpheres::Root_for_spheres_2_3`. */ @@ -24,7 +24,7 @@ OutputIterator operator()(const AlgebraicKernelForSpheres::Polynomial_for_spheres_2_3 &p, OutputIterator res); -/*! +/*! Computes the `i`th `y`-critical point of polynomial `p`. */ template < class OutputIterator > diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h index f886885ca43..68e5e99971f 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres--ZCriticalPoints.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the `z`-critical points of polynomial `p`, as objects of type `AlgebraicKernelForSpheres::Root_for_spheres_2_3`. */ @@ -24,7 +24,7 @@ OutputIterator operator()(const AlgebraicKernelForSpheres::Polynomial_for_spheres_2_3 &p, OutputIterator res); -/*! +/*! Computes the `i`th `z`-critical point of polynomial `p`. */ template < class OutputIterator > diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h index 4ae6eb80a50..9d891eed1db 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/AlgebraicKernelForSpheres.h @@ -21,45 +21,45 @@ public: /// A model of `AlgebraicKernelForSpheres` is supposed to provide /// @{ -/*! +/*! A model of `RingNumberType`. */ typedef unspecified_type RT; -/*! +/*! A model of `FieldNumberType```. */ typedef unspecified_type FT; -/*! +/*! A model of `AlgebraicKernelForSpheres::Polynomial_1_3`, for trivariate polynomials of degree up to 1. */ typedef unspecified_type Polynomial_1_3; -/*! +/*! A model of `AlgebraicKernelForSpheres::PolynomialForSpheres_2_3`, for trivariate polynomials of degree up to 2 that can store equations of spheres. */ typedef unspecified_type Polynomial_for_spheres_2_3; -/*! +/*! A model of `AlgebraicKernelForSpheres::PolynomialsForLines_3`, for systems of polynomials that can store equations of lines in 3D. */ typedef unspecified_type Polynomials_for_lines_3; -/*! +/*! A model of `RootOf_2`, for algebraic numbers of degree up to 2. */ typedef unspecified_type Root_of_2; -/*! +/*! A model of `AlgebraicKernelForSpheres::RootForSpheres_2_3`, for solutions of systems of three models of @@ -67,78 +67,78 @@ solutions of systems of three models of */ typedef unspecified_type Root_for_spheres_2_3; -/*! +/*! A model of `AlgebraicKernelForSpheres::ConstructPolynomial_1_3`. */ typedef unspecified_type Construct_polynomial_1_3; -/*! +/*! A model of `AlgebraicKernelForSpheres::ConstructPolynomialForSpheres_2_3`. */ typedef unspecified_type Construct_polynomial_for_spheres_2_3; -/*! +/*! A model of `AlgebraicKernelForSpheres::ConstructPolynomialsForLines_3`. */ typedef unspecified_type Construct_polynomials_for_lines_3; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::CompareX`. */ typedef unspecified_type Compare_x; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::CompareY`. */ typedef unspecified_type Compare_y; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::CompareZ`. */ typedef unspecified_type Compare_z; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::CompareXY`. */ typedef unspecified_type Compare_xy; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::CompareXYZ`. */ typedef unspecified_type Compare_xyz; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::SignAt`. */ typedef unspecified_type Sign_at; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::XCriticalPoints`. */ typedef unspecified_type X_critical_points; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::YCriticalPoints`. */ typedef unspecified_type Y_critical_points; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::ZCriticalPoints`. */ typedef unspecified_type Z_critical_points; -/*! +/*! A model of the concept `AlgebraicKernelForSpheres::Solve`. */ typedef unspecified_type Solve; diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h index 4bb1778c98d..5a427f81ad4 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--BoundedSide_3.h @@ -19,7 +19,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! For a sphere. */ Bounded_side @@ -27,7 +27,7 @@ operator() (const SphericalKernel::Sphere_3& s, const SphericalKernel::Circular_arc_point_3& p); -/*! +/*! For a circle. */ Bounded_side diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h index b2d792a62d4..177382b53d2 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareThetaZ_3.h @@ -21,7 +21,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! Compares `p` and `q` according to the lexicographic ordering on \f$ \theta\f$- and \f$ z\f$-coordinates in the cylindrical coordinate system relative to the context sphere used by the function `SphericalKernel::compare_theta_z_3_object`. \pre `p` and `q` lie on the context sphere used by the function `SphericalKernel::compare_theta_z_3_object`, but do not coincide with its poles. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h index 339b702b1c7..c89f57589bf 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareTheta_3.h @@ -21,7 +21,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! Compares the \f$ \theta\f$-coordinates of `p` and `q` in the cylindrical coordinate system relative to the context sphere used by the function `SphericalKernel::compare_theta_3_object`. \pre `p` and `q` lie on the context sphere used by the function `SphericalKernel::compare_theta_3_object`, but do not coincide with its poles. @@ -30,7 +30,7 @@ Comparison_result operator() (const SphericalKernel::Circular_arc_point_3 &p, const SphericalKernel::Circular_arc_point_3 &q ); -/*! +/*! Compares the \f$ \theta\f$-coordinates of `p` and of the meridian defined by `m` (see Section \ref sectionSKobjects) in the cylindrical coordinate system relative to the context sphere used by the function `SphericalKernel::compare_theta_3_object`. \pre `p` lies on the context sphere used by the function `SphericalKernel::compare_theta_3_object`, but does not coincide with its poles. `m` \f$ \neq(0,0,0)\f$ and the \f$ z\f$-coordinate of `m` is \f$ 0\f$. @@ -39,13 +39,13 @@ Comparison_result operator() (const SphericalKernel::Circular_arc_point_3 &p, const SphericalKernel::Vector_3 &m ); -/*! +/*! Same as previous, with opposite result. */ Comparison_result operator() (const SphericalKernel::Vector_3 &m,const SphericalKernel::Circular_arc_point_3 &p); -/*! +/*! Compares the \f$ \theta\f$-coordinates of the meridians defined by `m1` and by `m2` (see Section \ref sectionSKobjects) in the cylindrical coordinate system relative to the context sphere used by the function `SphericalKernel::compare_theta_3_object`. `m1` \f$ \neq(0,0,0)\f$, `m2` \f$ \neq(0,0,0)\f$ and the \f$ z\f$-coordinate of `m1` and `m2` is \f$ 0\f$. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h index 103c4be1e20..f591957d31e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXYZ_3.h @@ -21,7 +21,7 @@ public: /// An object of this type must provide in addition: /// @{ -/*! +/*! Compares `p` and `q` according to the lexicographic ordering on \f$ x\f$-, \f$ y\f$-, and \f$ z\f$-coordinates. */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h index a8f04ef5ca0..857a9f1e6ff 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareXY_3.h @@ -24,7 +24,7 @@ public: /// An object of this type must provide in addition: /// @{ -/*! +/*! Compares `p` and `q` according to the lexicographic ordering on \f$ x\f$- and \f$ y\f$-coordinates. */ Comparison_result operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h index 8e8595f5d32..596965a20aa 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareX_3.h @@ -24,7 +24,7 @@ public: /// An object of this type must provide in addition: /// @{ -/*! +/*! Compares the \f$ x\f$-coordinates of `p` and `q`. */ Comparison_result operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h index f2b6a236479..df7e7ee7c1e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareY_3.h @@ -24,7 +24,7 @@ public: /// An object of this type must provide in addition: /// @{ -/*! +/*! Compares the \f$ y\f$-coordinates of `p` and `q`. */ Comparison_result operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h index 50b81aa9499..d7eabaf9662 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZAtTheta_3.h @@ -13,7 +13,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! compares the \f$ z\f$-coordinates of the two intersections points of `a0` and `a1` with the meridian defined by `m` (see Section \ref sectionSKobjects). \pre `a0` and `a1` lie on the context sphere used by the function `SphericalKernel::compare_z_at_theta_3_object`. `m` \f$ \neq(0,0,0)\f$ and the \f$ z\f$-coordinate of `m` is \f$ 0\f$. Arcs `a0` and `a1` are \f$ \theta\f$-monotone and both intersected by the meridian defined by `m`(see Section \ref sectionSKobjects). @@ -23,7 +23,7 @@ Comparison_result operator() const SphericalKernel::Circular_arc_3& a1, const SphericalKernel::Vector_3 &m); -/*! +/*! given a meridian anchored at the poles of the context sphere used by the function `SphericalKernel::compare_z_at_theta_3_object`, and passing through point `p`, compares the \f$ z\f$-coordinate of point `p` and that of the intersection of the meridian with `a`. \pre `a` and `p` lie on the context sphere used by the function `SphericalKernel::compare_z_at_theta_3_object`, arc `a` is \f$ \theta\f$-monotone and the meridian passing through `p` intersects arc `a`. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h index 597de01cb3b..afa30a84101 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZToRight_3.h @@ -15,7 +15,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! Compares the \f$ z\f$-coordinates of the intersection points of both arcs with a meridian anchored at the poles of the context sphere used by the function `SphericalKernel::compare_z_to_right_3_object`, at a \f$ \theta\f$-coordinate infinitesimally greater that the \f$ \theta\f$-coordinate of point `p`. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h index 2ca16166913..231e08d4e58 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--CompareZ_3.h @@ -22,7 +22,7 @@ public: /// An object of this type must provide in addition: /// @{ -/*! +/*! Compares the \f$ z\f$-coordinates of `p` and `q`. */ Comparison_result operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h index 9816f87d1b5..9d1616784fe 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateAngle_3.h @@ -11,7 +11,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Computes an approximation of the angle of the arc in radians `a`. */ double diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h index 7fbe45f381b..10790dfe157 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeApproximateSquaredLength_3.h @@ -14,7 +14,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Computes an approximation of the squared length of the arc `a`. */ double diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h index 165828207db..1066b75b12f 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularX_3.h @@ -11,7 +11,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the \f$ x\f$-coordinate of the point `p`. */ SphericalKernel::Root_of_2 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h index 537fe8a1600..cd7832e5945 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularY_3.h @@ -10,7 +10,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the \f$ y\f$-coordinate of the point `p`. */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h index d59f34e7d0b..980b4fa459a 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ComputeCircularZ_3.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the \f$ z\f$-coordinate of the point `p`. */ SphericalKernel::Root_of_2 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h index 11814794af4..4b8973145b1 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructBbox_3.h @@ -15,19 +15,19 @@ public: /// a bounding box of geometric objects: /// @{ -/*! +/*! */ CGAL::Bbox_3 operator() (const SphericalKernel::Circular_arc_point_3 & p); -/*! +/*! */ CGAL::Bbox_3 operator() (const SphericalKernel::Line_arc_3 & l); -/*! +/*! */ CGAL::Bbox_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h index eafb40f77e1..971ee15a6c7 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircle_3.h @@ -14,13 +14,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the circle containing the arc. */ SphericalKernel::Circle_3 operator() (const SphericalKernel::Circular_arc_3 &a); -/*! +/*! Constructs a circle from an equation. */ SphericalKernel::Circle_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h index 5a0cfb74a5b..199e8642715 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArcPoint_3.h @@ -12,13 +12,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! */ SphericalKernel::Circular_arc_point_3 operator() (const SphericalKernel::Root_for_spheres_2_3 & r); -/*! +/*! */ SphericalKernel::Circular_arc_point_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h index 28067f4ee76..a98395e59ff 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularArc_3.h @@ -21,13 +21,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs an arc from a full circle. */ SphericalKernel::Circular_arc_3 operator() (const SphericalKernel::Circle_3 &c); -/*! +/*! Constructs the circular arc supported by `c`, whose source and target are `p` and `q`, respectively. \pre `p` and `q` lie on `c` and they are different. @@ -37,7 +37,7 @@ SphericalKernel::Circular_arc_3 operator() const SphericalKernel::Circular_arc_point_3 &p, const SphericalKernel::Circular_arc_point_3 &q); -/*! +/*! Constructs an arc that is supported by the circle of type `SphericalKernel::Circle_3` passing through the points `p`, `q` and `r`. The source and target are respectively `p` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h index 0ad9d50355d..19a9ed9cdfb 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMaxVertex_3.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the maximal vertex of `l` with lexicographically largest coordinates. */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h index 0f6cde6c6ea..ff0685de062 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularMinVertex_3.h @@ -11,7 +11,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the minimal vertex of `l` with lexicographically smallest coordinates. */ diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h index 279f2477d1e..8bad0d7b5a4 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularSourceVertex_3.h @@ -11,13 +11,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the source vertex of `a`. */ SphericalKernel::Circular_arc_point_3 operator() (const SphericalKernel::Circular_arc_3 & a); -/*! +/*! Same, for a line segment. */ SphericalKernel::Circular_arc_point_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h index 53a7854dc9e..f200f4ef213 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructCircularTargetVertex_3.h @@ -11,13 +11,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the target vertex of `a`. */ SphericalKernel::Circular_arc_point_3 operator() (const SphericalKernel::Circular_arc_3 & a); -/*! +/*! Same, for a line segment. */ SphericalKernel::Circular_arc_point_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h index e08c80f7b03..2f9e57de6ba 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLineArc_3.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the line segment supported by `l`, whose source is `p` and whose target is `q`. \pre `p` and `q` lie on `l` and are different. @@ -22,13 +22,13 @@ SphericalKernel::Line_arc_3 operator() const SphericalKernel::Circular_arc_point_3 &p, const SphericalKernel::Circular_arc_point_3 &q); -/*! +/*! */ SphericalKernel::Line_arc_3 operator() (const SphericalKernel::Segment_3 &s); -/*! +/*! */ SphericalKernel::Line_arc_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h index 653218d1ec0..76773ae40b1 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructLine_3.h @@ -18,13 +18,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the line containing the segment. */ SphericalKernel::Line_3 operator() (const SphericalKernel::Line_arc_3 &s); -/*! +/*! Constructs a line from an equation. */ SphericalKernel::Line_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h index 8c1dc4d0a2b..1b955bf1428 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructPlane_3.h @@ -18,13 +18,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Constructs the plane containing the arc. */ SphericalKernel::Plane_3 operator() (const SphericalKernel::Circular_arc_3 &a); -/*! +/*! Constructs a plane from an equation. */ SphericalKernel::Plane_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h index b1637c18a8a..ff91610bac5 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--ConstructSphere_3.h @@ -18,13 +18,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Returns the diametral sphere of the supporting circle of arc `a`. */ SphericalKernel::Sphere_3 operator()(const SphericalKernel::Circular_arc_3 & a); -/*! +/*! Constructs a sphere from an equation. */ SphericalKernel::Sphere_3 operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h index 6f30e45de01..8ec36e83a99 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoIntersect_3.h @@ -18,7 +18,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! determines if two geometric objects of type Type1 and Type2 intersect or not. for all pairs `Type1` and `Type2`, where the types `Type1` and `Type2` diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h index 91d0d93da86..a09666706b3 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--DoOverlap_3.h @@ -11,7 +11,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! For two line arcs. The computation may be faster when the boolean is set to true. */ bool operator() @@ -19,7 +19,7 @@ bool operator() const SphericalKernel::Line_arc_3 & l1, const bool known_equal_supporting_line = false); -/*! +/*! For two circular arcs. The computation may be faster when the boolean is set to true. */ bool operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h index 4bfccee2d39..d2ee772abde 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Equal_3.h @@ -22,14 +22,14 @@ public: /// An object of this type must provide in addition: /// @{ -/*! +/*! For two points. */ bool operator() (const SphericalKernel::Circular_arc_point_3 &p0, const SphericalKernel::Circular_arc_point_3 &p1); -/*! +/*! For two arcs. Two arcs are equal, iff their non-oriented supporting planes are equal, and the centers and squared radii of their respective supporting circles are equal, and their @@ -39,7 +39,7 @@ bool operator() (const SphericalKernel::Circular_arc_3 &a0, const SphericalKernel::Circular_arc_3 &a1); -/*! +/*! For two segments. Two segments are equal, iff their non-oriented supporting lines are equal (i.e.\ they define the same set of points), and their endpoints are the same. diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h index 6848d2daa71..4d28619e57e 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--GetEquation.h @@ -19,25 +19,25 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Returns the equation of the plane. */ SphericalKernel::Polynomial_1_3 operator()(const SphericalKernel::Plane_3 & p); -/*! +/*! Returns the equation of the sphere. */ SphericalKernel::Polynomial_for_spheres_2_3 operator()(const SphericalKernel::Sphere_3 & p); -/*! +/*! Returns the equations of the line. */ SphericalKernel::Polynomials_for_line_3 operator()(const SphericalKernel::Line_3 & c); -/*! +/*! Returns the equations of the circle. */ SphericalKernel::Polynomials_for_circle_3 diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h index 1002e6b1fa6..89edee1e7ba 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnBoundedSide_3.h @@ -18,7 +18,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! For a sphere. */ bool @@ -26,7 +26,7 @@ operator() (const SphericalKernel::Sphere_3& s, const SphericalKernel::Circular_arc_point_3& p); -/*! +/*! For a circle. */ bool diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h index 97e004f2a30..01b8fb9b7a1 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOnUnboundedSide_3.h @@ -19,7 +19,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! For a sphere. */ bool @@ -27,7 +27,7 @@ operator() (const SphericalKernel::Sphere_3& s, const SphericalKernel::Circular_arc_point_3& p); -/*! +/*! For a circle. */ bool diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h index a8e443b6abe..bf306400dc9 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--HasOn_3.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Returns `true` when `obj1` contains `obj2`, where Type1 and Type2 can be respectively:
    • diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h index a68fb024f09..de3a4f5d298 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--IsThetaMonotone_3.h @@ -15,7 +15,7 @@ public: /// An object of this type must provide: /// @{ -/*! +/*! Tests whether the arc `a` is \f$ \theta\f$-monotone, i.e.\ the intersection of any meridian anchored at the poles of the context sphere used by the function `SphericalKernel::is_theta_monotone_3_object` and the arc `a` is reduced to at most one point in general, and two points if a pole of that sphere is diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h index c94044212f3..fe16e37902f 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--MakeThetaMonotone_3.h @@ -15,7 +15,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Copies in the output iterator the results of the split of arc `a` at the \f$ \theta\f$-extremal point(s) of its supporting circle relatively to the context sphere used by the function `SphericalKernel::make_theta_monotone_3_object` @@ -30,7 +30,7 @@ template OutputIterator operator() (const SphericalKernel::Circular_arc_3 &a,OutputIterator res); -/*! +/*! Copies in the output iterator the results of the split of circle `c` at its \f$ \theta\f$-extremal point(s) relatively to the context sphere used by the function `SphericalKernel::make_theta_monotone_3_object`. (Refer to Section \ref sectionSKobjects for the definition of these points.) diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h index e6cdb135754..64d37b00258 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel--Split_3.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Splits arc `a` at point `p`, which creates arcs `a1` and `a2`. \pre The point `p` lies in the interior of the input arc `a`. */ @@ -22,7 +22,7 @@ const SphericalKernel::Circular_arc_point_3 &p, SphericalKernel::Circular_arc_3 &a1, SphericalKernel::Circular_arc_3 &a2); -/*! +/*! Same for a line arc. */ void operator() diff --git a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h index ba23658e20e..531abd4088d 100644 --- a/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h +++ b/Circular_kernel_3/doc/Circular_kernel_3/Concepts/SphericalKernel.h @@ -20,42 +20,42 @@ public: /// types /// @{ -/*! +/*! Model of `Kernel`. */ typedef unspecified_type Linear_kernel; -/*! +/*! Model of `AlgebraicKernelForSpheres`. */ typedef unspecified_type Algebraic_kernel; -/*! +/*! Model of `RootOf_2`. */ typedef unspecified_type Root_of_2; -/*! +/*! Model of `AlgebraicKernelForSpheres::RootForSpheres_2_3`. */ typedef unspecified_type Root_for_spheres_2_3; -/*! +/*! Model of `AlgebraicKernelForSpheres::Polynomial_1_3`. */ typedef unspecified_type Polynomial_1_3; -/*! +/*! Model of `AlgebraicKernelForSpheres::PolynomialsForLines_3`. */ typedef unspecified_type Polynomials_for_line_3; -/*! +/*! Model of `AlgebraicKernelForSpheres::PolynomialForSpheres_2_3`. */ typedef unspecified_type Polynomial_for_spheres_2_3; -/*! +/*! Model of `AlgebraicKernelForSpheres::PolynomialsForCircles_3`. */ typedef unspecified_type Polynomials_for_circle_3; @@ -66,47 +66,47 @@ typedef unspecified_type Polynomials_for_circle_3; /// and to define the following geometric objects /// @{ -/*! +/*! Model of `Kernel::Point_3`. */ typedef unspecified_type Point_3; -/*! +/*! Model of `Kernel::Vector_3`. */ typedef unspecified_type Vector_3; -/*! +/*! Model of `Kernel::Line_3`. */ typedef unspecified_type Line_3; -/*! +/*! Model of `Kernel::Plane_3`. */ typedef unspecified_type Plane_3; -/*! +/*! Model of `Kernel::Sphere_3`. */ typedef unspecified_type Sphere_3; -/*! +/*! Model of `Kernel::Circle_3`. */ typedef unspecified_type Circle_3; -/*! +/*! Model of `SphericalKernel::LineArc_3`. */ typedef unspecified_type Line_arc_3; -/*! +/*! Model of `SphericalKernel::CircularArc_3`. */ typedef unspecified_type Circular_arc_3; -/*! +/*! Model of `SphericalKernel::CircularArcPoint_3`. */ typedef unspecified_type Circular_arc_point_3; @@ -119,87 +119,87 @@ typedef unspecified_type Circular_arc_point_3; /// constructions and other functionalities. /// @{ -/*! +/*! Model of `SphericalKernel::CompareX_3`. */ typedef unspecified_type Compare_x_3; -/*! +/*! Model of `SphericalKernel::CompareY_3`. */ typedef unspecified_type Compare_y_3; -/*! +/*! Model of `SphericalKernel::CompareZ_3`. */ typedef unspecified_type Compare_z_3; -/*! +/*! Model of `SphericalKernel::CompareXY_3`. */ typedef unspecified_type Compare_xy_3; -/*! +/*! Model of `SphericalKernel::CompareXYZ_3`. */ typedef unspecified_type Compare_xyz_3; -/*! +/*! Model of `SphericalKernel::CompareTheta_3`. */ typedef unspecified_type Compare_theta_3; -/*! +/*! Model of `SphericalKernel::CompareThetaZ_3`. */ typedef unspecified_type Compare_theta_z_3; -/*! +/*! Model of `SphericalKernel::CompareZAtTheta_3`. */ typedef unspecified_type Compare_z_at_theta_3; -/*! +/*! Model of `SphericalKernel::CompareZToRight_3`. */ typedef unspecified_type Compare_z_to_right_3; -/*! +/*! Model of `SphericalKernel::Equal_3`. */ typedef unspecified_type Equal_3; -/*! +/*! Model of `SphericalKernel::HasOn_3`. */ typedef unspecified_type Has_on_3; -/*! +/*! Model of `SphericalKernel::DoOverlap_3`. */ typedef unspecified_type Do_overlap_3; -/*! +/*! Model of `SphericalKernel::DoIntersect_3`. */ typedef unspecified_type Do_intersect_3; -/*! +/*! Model of `SphericalKernel::BoundedSide_3`. */ typedef unspecified_type Bounded_side_3; -/*! +/*! Model of `SphericalKernel::HasOnBoundedSide_3`. */ typedef unspecified_type Has_on_bounded_side_3; -/*! +/*! Model of `SphericalKernel::HasOnUnboundedSide_3`. */ typedef unspecified_type Has_on_unbounded_side_3; -/*! +/*! Model of `SphericalKernel::IsThetaMonotone_3`. */ typedef unspecified_type Is_theta_monotone_3; @@ -209,77 +209,77 @@ typedef unspecified_type Is_theta_monotone_3; /// \name Constructions /// @{ -/*! +/*! Model of `SphericalKernel::ConstructLine_3`. */ typedef unspecified_type Construct_line_3; -/*! +/*! Model of `SphericalKernel::ConstructPlane_3`. */ typedef unspecified_type Construct_plane_3; -/*! +/*! Model of `SphericalKernel::ConstructSphere_3`. */ typedef unspecified_type Construct_sphere_3; -/*! +/*! Model of `SphericalKernel::ConstructCircle_3`. */ typedef unspecified_type Construct_circle_3; -/*! +/*! Model of `SphericalKernel::ConstructLineArc_3`. */ typedef unspecified_type Construct_line_arc_3; -/*! +/*! Model of `SphericalKernel::ConstructCircularArc_3`. */ typedef unspecified_type Construct_circular_arc_3; -/*! +/*! Model of `SphericalKernel::ConstructCircularArcPoint_3`. */ typedef unspecified_type Construct_circular_arc_point_3; -/*! +/*! Model of `SphericalKernel::ConstructCircularMinVertex_3`. */ typedef unspecified_type Construct_circular_min_vertex_3; -/*! +/*! Model of `SphericalKernel::ConstructCircularMaxVertex_3`. */ typedef unspecified_type Construct_circular_max_vertex_3; -/*! +/*! Model of `SphericalKernel::ConstructCircularSourceVertex_3`. */ typedef unspecified_type Construct_circular_source_vertex_3; -/*! +/*! Model of `SphericalKernel::ConstructCircularTargetVertex_3`. */ typedef unspecified_type Construct_circular_target_vertex_3; -/*! +/*! Model of `SphericalKernel::ConstructBbox_3`. */ typedef unspecified_type Construct_bbox_3; -/*! +/*! Model of `SphericalKernel::Intersect_3`. */ typedef unspecified_type Intersect_3; -/*! +/*! Model of `SphericalKernel::Split_3`. */ typedef unspecified_type Split_3; -/*! +/*! Model of `SphericalKernel::MakeThetaMonotone_3`. */ typedef unspecified_type Make_theta_monotone_3; @@ -289,27 +289,27 @@ typedef unspecified_type Make_theta_monotone_3; /// \name Computations /// @{ -/*! +/*! Model of `SphericalKernel::ComputeCircularX_3`. */ typedef unspecified_type Compute_circular_x_3; -/*! +/*! Model of `SphericalKernel::ComputeCircularY_3`. */ typedef unspecified_type Compute_circular_y_3; -/*! +/*! Model of `SphericalKernel::ComputeCircularZ_3`. */ typedef unspecified_type Compute_circular_z_3; -/*! +/*! Model of `SphericalKernel::ComputeApproximateSquaredLength_3`. */ typedef unspecified_type Compute_approximate_squared_length_3; -/*! +/*! Model of `SphericalKernel::ComputeApproximateAngle_3`. */ typedef unspecified_type Compute_approximate_angle_3; @@ -319,7 +319,7 @@ typedef unspecified_type Compute_approximate_angle_3; /// \name Link with the algebraic kernel /// @{ -/*! +/*! Model of `SphericalKernel::GetEquation`. */ typedef unspecified_type Get_equation; @@ -336,7 +336,7 @@ typedef unspecified_type Get_equation; /// following member function must exist: /// @{ -/*! +/*! */ Construct_circular_arc_3 construct_circular_arc_3_object() const; @@ -347,32 +347,32 @@ Construct_circular_arc_3 construct_circular_arc_3_object() const; /// A context sphere must be provided to the following functions: /// @{ -/*! +/*! */ Compare_theta_3 compare_theta_3_object(const Sphere_3& sphere) const; -/*! +/*! */ Compare_theta_z_3 compare_theta_z_3_object(const Sphere_3& sphere) const; -/*! +/*! */ Compare_z_at_theta_3 compare_z_at_theta_3_object(const Sphere_3& sphere) const; -/*! +/*! */ Compare_z_to_right_3 compare_z_to_right_3_object(const Sphere_3& sphere) const; -/*! +/*! */ Make_theta_monotone_3 make_theta_monotone_3_object(const Sphere_3& sphere) const; -/*! +/*! */ Is_theta_monotone_3 is_theta_monotone_3_object(const Sphere_3& sphere) const; diff --git a/Circulator/doc/Circulator/Concepts/Circulator.h b/Circulator/doc/Circulator/Concepts/Circulator.h index 3bf3f0ccf4d..db658fe07f4 100644 --- a/Circulator/doc/Circulator/Concepts/Circulator.h +++ b/Circulator/doc/Circulator/Concepts/Circulator.h @@ -318,7 +318,7 @@ class BidirectionalCirculator { }; /* end ForwardCirculator */ -/*! +/*! \ingroup PkgHandlesAndCirculatorsConcepts See Subsection \ref sectionRandomAccessCirculatorRequ in the page on Circulators. \cgalConcept diff --git a/Circulator/doc/Circulator/Concepts/ConstRange.h b/Circulator/doc/Circulator/Concepts/ConstRange.h index 009262e1600..661c257aa3d 100644 --- a/Circulator/doc/Circulator/Concepts/ConstRange.h +++ b/Circulator/doc/Circulator/Concepts/ConstRange.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! The constant iterator type. */ typedef unspecified_type const_iterator; -/*! +/*! An unsigned integral type that can represent the size of a range. */ @@ -35,22 +35,22 @@ typedef unspecified_type size_type; /// \name Member functions /// @{ -/*! +/*! returns the const iterator pointing to the first element. */ const_iterator begin() const; -/*! +/*! returns the past-the-end const iterator. */ const_iterator end() const; -/*! +/*! returns the size of the range. */ size_type size() const; -/*! +/*! returns whether the range is empty. */ bool empty() const; diff --git a/Circulator/doc/Circulator/Concepts/Handle.h b/Circulator/doc/Circulator/Concepts/Handle.h index c6439999f6d..2746bb91144 100644 --- a/Circulator/doc/Circulator/Concepts/Handle.h +++ b/Circulator/doc/Circulator/Concepts/Handle.h @@ -37,12 +37,12 @@ public: /// \name Dereference /// @{ -/*! +/*! returns the object pointed to. */ value_type& operator*(); -/*! +/*! returns a pointer to the object pointed to. */ value_type* operator->(); diff --git a/Circulator/doc/Circulator/Concepts/Range.h b/Circulator/doc/Circulator/Concepts/Range.h index b7c305db4d8..7b60925b9cb 100644 --- a/Circulator/doc/Circulator/Concepts/Range.h +++ b/Circulator/doc/Circulator/Concepts/Range.h @@ -42,17 +42,17 @@ public: /// \name Types /// @{ -/*! +/*! The constant iterator type. */ typedef unspecified_type const_iterator; -/*! +/*! The iterator type. It must be convertible to `const_iterator`. */ typedef unspecified_type iterator; -/*! +/*! An unsigned integral type that can represent the size of a range. */ @@ -63,32 +63,32 @@ typedef unspecified_type size_type; /// \name Member functions /// @{ -/*! +/*! returns the const iterator pointing to the first element. */ const_iterator begin() const; -/*! +/*! returns the past-the-end const iterator. */ const_iterator end() const; -/*! +/*! returns the iterator pointing to the first element. */ iterator begin(); -/*! +/*! returns the past-the-end iterator. */ iterator end(); -/*! +/*! returns the size of the range. */ size_type size() const; -/*! +/*! returns whether the range is empty. */ bool empty() const; diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h index aea53410a63..e89454df0bf 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xy_traits_2.h @@ -29,38 +29,38 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Point_3 Point_2; -/*! +/*! */ typedef Less_xy_plane_xy_2 Less_xy_2; -/*! +/*! */ typedef Less_yx_plane_xy_2 Less_yx_2; -/*! +/*! */ typedef Less_dist_to_line_plane_xy_2 Less_signed_distance_to_line_2; -/*! +/*! */ typedef Less_rotate_ccw_plane_xy_2 Less_rotate_ccw_2; -/*! +/*! */ typedef Left_turn_plane_xy_2 Left_turn_2; -/*! +/*! */ typedef Equal_xy_plane_xy_2 Equal_2; @@ -70,7 +70,7 @@ typedef Equal_xy_plane_xy_2 Equal_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ Convex_hull_projective_xy_traits_2(); @@ -80,34 +80,34 @@ Convex_hull_projective_xy_traits_2(); /// \name Operations /// @{ -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Less_signed_distance_to_line_2 less_signed_distance_to_line_2_object(); -/*! +/*! */ Less_rotate_ccw_2 less_rotate_ccw_2_object(); -/*! +/*! */ Left_turn_2 left_turn_2_object(); -/*! +/*! */ Equal_2 equal_2_object(); diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h index f59eaf5ae2b..1c5fdaa325f 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_xz_traits_2.h @@ -28,38 +28,38 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Point_3 Point_2; -/*! +/*! */ typedef Less_xy_plane_xz_2 Less_xy_2; -/*! +/*! */ typedef Less_yx_plane_xz_2 Less_yx_2; -/*! +/*! */ typedef Less_dist_to_line_plane_xz_2 Less_signed_distance_to_line_2; -/*! +/*! */ typedef Less_rotate_ccw_plane_xz_2 Less_rotate_ccw_2; -/*! +/*! */ typedef Left_turn_plane_xz_2 Left_turn_2; -/*! +/*! */ typedef Equal_xy_plane_xz_2 Equal_2; @@ -69,7 +69,7 @@ typedef Equal_xy_plane_xz_2 Equal_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ Convex_hull_projective_xz_traits_2(); @@ -79,33 +79,33 @@ Convex_hull_projective_xz_traits_2(); /// \name Operations /// @{ -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Less_signed_distance_to_line_2 less_signed_distance_to_line_2_object(); -/*! +/*! */ Less_rotate_ccw_2 less_rotate_ccw_2_object(); -/*! +/*! */ Left_turn_2 left_turn_2_object(); -/*! +/*! */ Equal_2 equal_2_object(); diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h index 20b797c91d9..e41cfeb0dec 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/Convex_hull_projective_yz_traits_2.h @@ -28,38 +28,38 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Point_3 Point_2; -/*! +/*! */ typedef Less_xy_plane_yz_2 Less_xy_2; -/*! +/*! */ typedef Less_yx_plane_yz_2 Less_yx_2; -/*! +/*! */ typedef Less_dist_to_line_plane_yz_2 Less_signed_distance_to_line_2; -/*! +/*! */ typedef Less_rotate_ccw_plane_yz_2 Less_rotate_ccw_2; -/*! +/*! */ typedef Left_turn_plane_yz_2 Left_turn_2; -/*! +/*! */ typedef Equal_xy_plane_yz_2 Equal_2; @@ -69,7 +69,7 @@ typedef Equal_xy_plane_yz_2 Equal_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ Convex_hull_projective_yz_traits_2(); @@ -79,34 +79,34 @@ Convex_hull_projective_yz_traits_2(); /// \name Operations /// @{ -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Less_signed_distance_to_line_2 less_signed_distance_to_line_2_object(); -/*! +/*! */ Less_rotate_ccw_2 less_rotate_ccw_2_object(); -/*! +/*! */ Left_turn_2 left_turn_2_object(); -/*! +/*! */ Equal_2 equal_2_object(); diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h index 435801f7a4b..f1c084b7493 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_constructive_traits_2.h @@ -26,38 +26,38 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef R::Point_2 Point_2; -/*! +/*! */ typedef R::Less_xy_2 Less_xy_2; -/*! +/*! */ typedef R::Less_yx_2 Less_yx_2; -/*! +/*! */ typedef CGAL::r_Less_dist_to_line Less_signed_distance_to_line_2; -/*! +/*! */ typedef R::Less_rotate_ccw Less_rotate_ccw_2; -/*! +/*! */ typedef R::Left_turn_2 Left_turn_2; -/*! +/*! */ typedef R::Equal_2 Equal_2; @@ -67,7 +67,7 @@ typedef R::Equal_2 Equal_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ Convex_hull_constructive_traits_2(); @@ -77,34 +77,34 @@ Convex_hull_constructive_traits_2(); /// \name Operations /// @{ -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Less_signed_distance_to_line_2 less_signed_distance_to_line_2_object(); -/*! +/*! */ Less_rotate_ccw_2 less_rotate_ccw_2_object(); -/*! +/*! */ Left_turn_2 left_turn_2_object(); -/*! +/*! */ Equal_2 equal_2_object(); diff --git a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h index 93fc6277f64..11de0b83ff7 100644 --- a/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/CGAL/convex_hull_traits_2.h @@ -22,38 +22,38 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef R::Point_2 Point_2; -/*! +/*! */ typedef R::Less_xy Less_xy_2; -/*! +/*! */ typedef R::Less_yx Less_yx_2; -/*! +/*! */ typedef R::Less_signed_distance_to_line_2 Less_signed_distance_to_line_2; -/*! +/*! */ typedef R::Less_rotate_ccw_2 Less_rotate_ccw_2; -/*! +/*! */ typedef R::Left_turn_2 Left_turn_2; -/*! +/*! */ typedef R::Equal_2 Equal_2; @@ -63,7 +63,7 @@ typedef R::Equal_2 Equal_2; /// \name Creation /// @{ -/*! +/*! copy constructor. */ Convex_hull_traits_2(Convex_hull_traits_2& t); @@ -73,33 +73,33 @@ Convex_hull_traits_2(Convex_hull_traits_2& t); /// \name Operations /// @{ -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Less_signed_distance_to_line_2 less_signed_distance_to_line_2_object(); -/*! +/*! */ Less_rotate_ccw_2 less_rotate_ccw_2_object(); -/*! +/*! */ Left_turn_2 left_turn_2_object(); -/*! +/*! */ Equal_2 equal_2_object(); diff --git a/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h b/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h index 34234015e7d..34b1219ba3e 100644 --- a/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h +++ b/Convex_hull_2/doc/Convex_hull_2/Concepts/ConvexHullTraits_2.h @@ -25,12 +25,12 @@ public: /// \name Types /// @{ -/*! +/*! The point type on which the convex hull functions operate. */ typedef unspecified_type Point_2; -/*! +/*! Binary predicate object type comparing `Point_2`s. Must provide `bool operator()(Point_2 p, Point_2 q)` where `true` is returned iff \f$ p ==_{xy} q\f$, false otherwise. @@ -38,7 +38,7 @@ is returned iff \f$ p ==_{xy} q\f$, false otherwise. */ typedef unspecified_type Equal_2; -/*! +/*! Binary predicate object type comparing `Point_2`s lexicographically. Must provide `bool operator()(Point_2 p, Point_2 q)` where `true` @@ -50,12 +50,12 @@ respectively. */ typedef unspecified_type Less_xy_2; -/*! +/*! Same as `Less_xy_2` with the roles of \f$ x\f$ and \f$ y\f$ interchanged. */ typedef unspecified_type Less_yx_2; -/*! +/*! Predicate object type that must provide `bool operator()(Point_2 p,Point_2 q,Point_2 r)`, which returns `true` iff `r` lies to the left of the @@ -63,7 +63,7 @@ oriented line through `p` and `q`. */ typedef unspecified_type Left_turn_2; -/*! +/*! Predicate object type that must provide `bool operator()(Point_2 p, Point_2 q, Point_2 r,Point_2 s)`, which returns `true` iff @@ -78,7 +78,7 @@ the order given by `Less_signed_distance_to_line_2`. */ typedef unspecified_type Less_signed_distance_to_line_2; -/*! +/*! Predicate object type that must provide `bool operator()(Point_2 e, Point_2 p,Point_2 q)`, where `true` is returned iff a tangent at \f$ e\f$ to the point set @@ -95,7 +95,7 @@ typedef unspecified_type Less_rotate_ccw_2; /// Only a copy constructor is required. /// @{ -/*! +/*! */ ConvexHullTraits_2(ConvexHullTraits_2& t); @@ -107,32 +107,32 @@ ConvexHullTraits_2(ConvexHullTraits_2& t); /// object types must exist. /// @{ -/*! +/*! */ Equal_2 equal_2_object(); -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Less_signed_distance_to_line_2 less_signed_distance_to_line_2_object(); -/*! +/*! */ Less_rotate_ccw_2 less_rotate_ccw_2_object( ); -/*! +/*! */ Left_turn_2 left_turn_2_object(); diff --git a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h index 6043516322d..75066b81347 100644 --- a/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/CGAL/Convex_hull_traits_3.h @@ -19,144 +19,144 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef R::Point_3 Point_3; -/*! +/*! */ typedef R::Segment_3 Segment_3; -/*! +/*! */ typedef R::Triangle_3 Triangle_3; -/*! +/*! A triple of points, in order to avoid the need for exact constructions. */ typedef unspecified_type Plane_3;; -/*! +/*! */ typedef R::Vector_3 Vector_3; -/*! +/*! */ typedef Polyhedron_default_traits_3 Poly_traits; -/*! +/*! */ typedef Halfedge_data_structure_polyhedron_default_3 HDS; -/*! +/*! */ typedef Polyhedron_3 Polyhedron_3; -/*! +/*! */ typedef R::Construct_segment_3 Construct_segment_3; -/*! +/*! */ typedef R::Construct_ray_3 Construct_ray_3; -/*! +/*! */ typedef R::Construct_plane_3 Construct_plane_3; -/*! +/*! */ typedef R::Construct_vector_3 Construct_vector_3; -/*! +/*! */ typedef R::Construct_triangle_3 Construct_triangle_3; -/*! +/*! */ typedef R::Construct_centroid_3 Construct_centroid_3; -/*! +/*! */ typedef R::Construct_orthogonal_vector_3 Construct_orthogonal_vector_3; -/*! +/*! */ R::Equal_3 Equal_3; -/*! +/*! */ R::Collinear_3 Collinear_3; -/*! +/*! */ R::Coplanar_3 Coplanar_3; -/*! +/*! */ R::Less_distance_to_point_3 Less_distance_to_point_3; -/*! +/*! */ R::Has_on_positive_side_3 Has_on_positive_side_3; -/*! +/*! */ R::Less_signed_dist_to_plane_3 Less_signed_distance_to_plane_3; -/*! +/*! */ Projection_traits_xy_3 Traits_xy; -/*! +/*! */ Projection_traits_xz_3 Traits_xz; -/*! +/*! */ Projection_traits_yz_3 Traits_yz; -/*! +/*! */ R::Ray_3 Ray_3; -/*! +/*! */ R::Has_on_3 Has_on_3; -/*! +/*! */ R::Oriented_side_3 Oriented_side_3; -/*! +/*! */ R::Do_intersect_3 Do_intersect_3; @@ -166,7 +166,7 @@ R::Do_intersect_3 Do_intersect_3; /// \name Creation /// @{ -/*! +/*! copy constructor. */ Convex_hull_traits_3(Convex_hull_traits_3& t); @@ -176,97 +176,97 @@ Convex_hull_traits_3(Convex_hull_traits_3& t); /// \name Operations /// @{ -/*! +/*! */ Construct_segment_3 construct_segment_3_object() const; -/*! +/*! */ Construct_ray_3 construct_ray_3_object() const; -/*! +/*! */ Construct_plane_3 construct_plane_3_object() const; -/*! +/*! */ Construct_triangle_3 construct_triangle_3_object() const; -/*! +/*! */ Construct_vector_3 construct_vector_3_object() const; -/*! +/*! */ Construct_centroid_3 construct_centroid_3_object() const; -/*! +/*! */ Construct_orthogonal_vector_3 construct_orthogonal_vector_3_object() const; -/*! +/*! */ Equal_3 equal_3_object() const; -/*! +/*! */ Collinear_3 collinear_3_object() const; -/*! +/*! */ Coplanar_3 coplanar_3_object() const; -/*! +/*! */ Has_on_3 has_on_3_object() const; -/*! +/*! */ Less_distance_to_point_3 less_distance_to_point_3_object() const; -/*! +/*! */ Has_on_positive_side_3 has_on_positive_side_3_object() const; -/*! +/*! */ Oriented_side_3 oriented_side_3_object() const; -/*! +/*! */ Do_intersect_3 do_intersect_3_object() const; -/*! +/*! */ Less_signed_distance_to_plane_3 diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h index 8e617f46c74..6bf6e0b8243 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronFacet_3.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! plane equation type stored in facets. */ typedef unspecified_type Plane; -/*! +/*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; -/*! +/*! circulator of halfedges around a facet. */ @@ -40,7 +40,7 @@ typedef unspecified_type Halfedge_around_facet_circulator; /// \name Creation /// @{ -/*! +/*! default constructor. */ Facet(); @@ -50,22 +50,22 @@ Facet(); /// \name Operations /// @{ -/*! +/*! */ Plane& plane(); -/*! +/*! plane equation. */ const Plane& plane() const; -/*! +/*! an incident halfedge that points to `f`. */ Halfedge_handle halfedge(); -/*! +/*! circulator of halfedges around the facet (counterclockwise). */ Halfedge_around_facet_circulator facet_begin(); diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h index 5756020a1fc..c68630d1664 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronHalfedge_3.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Halfedge(); @@ -29,37 +29,37 @@ Halfedge(); /// \name Operations /// @{ -/*! +/*! the opposite halfedge. */ Halfedge_handle opposite(); -/*! +/*! the next halfedge around the facet. */ Halfedge_handle next(); -/*! +/*! the previous halfedge around the facet. */ Halfedge_handle prev(); -/*! +/*! is true if `h` is a border halfedge. */ bool is_border() const; -/*! +/*! circulator of halfedges around the facet (counterclockwise). */ Halfedge_around_facet_circulator facet_begin(); -/*! +/*! the incident vertex of `h`. */ Vertex_handle vertex(); -/*! +/*! the incident facet of `h`. If `h` is a border halfedge the result is default construction of the handle. */ diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h index d372db89774..fb04213fe80 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedronVertex_3.h @@ -18,7 +18,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Vertex(); @@ -28,12 +28,12 @@ Vertex(); /// \name Operations /// @{ -/*! +/*! */ Point& point(); -/*! +/*! the point. */ const Point& point() const; diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h index f3cd83857b1..a62967474ba 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullPolyhedron_3.h @@ -14,47 +14,47 @@ public: /// \name Types /// @{ -/*! +/*! type of point stored in a vertex */ typedef unspecified_type Point_3; -/*! +/*! a model of `ConvexHullPolyhedronVertex_3` */ typedef unspecified_type Vertex; -/*! +/*! a model of `ConvexHullPolyhedronHalfedge_3` */ typedef unspecified_type Halfedge; -/*! +/*! a model of `ConvexHullPolyhedronFacet_3` */ typedef unspecified_type Facet; -/*! +/*! halfedge data structure */ typedef unspecified_type Halfedge_data_structure; -/*! +/*! handle to halfedge */ typedef unspecified_type Halfedge_handle; -/*! +/*! iterator for halfedge */ typedef unspecified_type Halfedge_iterator; -/*! +/*! handle to facet */ typedef unspecified_type Facet_handle; -/*! +/*! iterator for facet */ typedef unspecified_type Facet_iterator; @@ -65,7 +65,7 @@ typedef unspecified_type Facet_iterator; /// Only a default constructor is required. /// @{ -/*! +/*! */ ConvexHullPolyhedron_3(); @@ -75,27 +75,27 @@ ConvexHullPolyhedron_3(); /// \name Operations /// @{ -/*! +/*! iterator over all facets (excluding holes). */ Facet_iterator facets_begin(); -/*! +/*! past-the-end iterator. */ Facet_iterator facets_end(); -/*! +/*! iterator over all halfedges. */ Halfedge_iterator P.halfedges_begin(); -/*! +/*! past-the-end iterator. */ Halfedge_iterator P.halfedges_end(); -/*! +/*! adds a new tetrahedron to the polyhedral surface with its vertices initialized with `p1`, `p2`, `p3` and `p4`. @@ -108,14 +108,14 @@ thereafter with `p3`. The remaining fourth vertex is initialized with */ Halfedge_handle make_tetrahedron(Point_3 p1, Point_3 p2, Point_3 p3, Point_3 p4); -/*! +/*! removes the incident facet of `h` and changes all halfedges incident to the facet into border edges or removes them from the polyhedral surface if they were already border edges. */ void erase_facet(Halfedge_handle h); -/*! +/*! creates a new facet within the hole incident to `h` and `g` by connecting the tip of `g` with the tip of `h` with two new halfedges @@ -128,7 +128,7 @@ the new vertex. Halfedge_handle add_vertex_and_facet_to_border(Halfedge_handle h, Halfedge_handle g); -/*! +/*! creates a new facet within the hole incident to `h` and `g` by connecting the tip of `g` with the tip of `h` with a new halfedge and @@ -140,7 +140,7 @@ edge that is incident to the new facet. Halfedge_handle add_facet_to_border(Halfedge_handle h, Halfedge_handle g); -/*! +/*! fills a hole with a newly created facet. Makes all border halfedges of the hole denoted by h incident to the new facet. @@ -149,7 +149,7 @@ Returns `h`. */ Halfedge_handle fill_hole(Halfedge_handle h); -/*! +/*! calls the `operator()` of the modifier `m`. See `Modifier_base` for a description of modifier design and its usage. diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h index 113c52fb891..627b3b5185c 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/ConvexHullTraits_3.h @@ -14,32 +14,32 @@ public: /// \name Types /// @{ -/*! +/*! The point type on which the convex hull algorithm operates */ typedef unspecified_type Point_3; -/*! +/*! a 3D plane */ typedef unspecified_type Plane_3; -/*! +/*! a 3D segment */ typedef unspecified_type Segment_3; -/*! +/*! a 3D triangle */ typedef unspecified_type Triangle_3; -/*! +/*! a 3D vector */ typedef unspecified_type Vector_3; -/*! +/*! Function object type that provides `Plane_3 operator()(Point_3 p, Point_3 q, Point_3 r)`, which constructs and returns a plane passing through `p`, `q`, and `r` and oriented @@ -47,14 +47,14 @@ in a positive sense when seen from the positive side of the plane. */ typedef unspecified_type Construct_plane_3; -/*! +/*! Function object type that provides `Segment_3 operator()(Point_3 p, Point_3 q)`, which constructs and returns the segment with source `p` and target `q`. */ typedef unspecified_type Construct_segment_3; -/*! +/*! Function object type that provides `Triangle_3 operator()(Point_3 p, Point_3 q, Point_3 r)`, which constructs and returns the triangle with vertices `p`, `q`, and @@ -62,42 +62,42 @@ constructs and returns the triangle with vertices `p`, `q`, and */ typedef unspecified_type Construct_triangle_3; -/*! +/*! Function object type that provides `Vector_3 operator()(Point_3 p, Point_3 q)`, which constructs and returns the vector `q`-`p`. */ typedef unspecified_type Construct_vector_3; -/*! +/*! Predicate object type that provides `bool operator()(Point_3 p, Point_3 q)`, which determines if points `p` and `q` are equal. */ typedef unspecified_type Equal_3; -/*! +/*! Predicate object type that provides `bool operator()(Point_3 p, Point_3 q, Point_3 r)`, which determines if points `p`, `q` and `r` are collinear. */ typedef unspecified_type Collinear_3; -/*! +/*! Predicate object type that provides `bool operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, which determines if points `p`, `q`, `r`, and `s` are coplanar. */ typedef unspecified_type Coplanar_3; -/*! +/*! Predicate object type that provides `bool operator()(Plane_3 h, Point_3 q)`, which determines if the point `q` is on the positive side of the halfspace `h`. */ typedef unspecified_type Has_on_positive_side_3; -/*! +/*! Predicate object type that provides a constructor taking a single `Point_3` object and `bool operator()(Point_3 q, Point_3 r)`, which returns true iff the @@ -107,7 +107,7 @@ at construction. */ typedef unspecified_type Less_distance_to_point_3; -/*! +/*! Predicate object type that provides `bool operator()(Plane_3 p, Point_3 q, Point_3 r)`, which returns true iff the signed distance from `q` to `p` is smaller @@ -121,7 +121,7 @@ typedef unspecified_type Less_signed_distance_to_plane_3; /// Only a copy constructor is required. /// @{ -/*! +/*! */ ConvexHullTraits_3(ConvexHullTraits_3& ch); @@ -136,7 +136,7 @@ predicate object type. For example: */ /// @{ -/*! +/*! */ Construct_plane_3 construct_plane_3_object(); diff --git a/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h b/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h index 55b6af41085..89fdc2fbfd3 100644 --- a/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h +++ b/Convex_hull_3/doc/Convex_hull_3/Concepts/IsStronglyConvexTraits_3.h @@ -20,34 +20,34 @@ public: /// \name Types /// @{ -/*! +/*! a 3D plane */ typedef unspecified_type Plane_3; -/*! +/*! a 3D point */ typedef unspecified_type Point_3; -/*! +/*! a 3D ray */ typedef unspecified_type Ray_3; -/*! +/*! a 3D triangle */ typedef unspecified_type Triangle_3; -/*! +/*! Function object type that provides `Ray_3 operator()(Point_3 p, Point_3 q)`, which constructs and returns the ray based at point `p` and passing though `q`. */ typedef unspecified_type Construct_ray_3; -/*! +/*! Function object type that provides `Triangle_3 operator()(Point_3 p, Point_3 q, Point_3 r)`, which constructs and returns the triangle with vertices `p`, `q`, and @@ -55,28 +55,28 @@ constructs and returns the triangle with vertices `p`, `q`, and */ typedef unspecified_type Construct_triangle_3; -/*! +/*! Predicate object type that provides `bool operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, which determines if points `p`, `q`, `r`, and `s` are coplanar. */ typedef unspecified_type Coplanar_3; -/*! +/*! Function object type that provides `CGAL::Object operator()(Triangle_3 t, Ray_3 r)`, which returns `true` iff `t` and `r` intersect. */ typedef unspecified_type Do_intersect_3; -/*! +/*! Predicate object type that provides `bool operator()(Plane_3 h, Point_3 q)`, which determines of the point `q` is on the positive side of the halfspace `h`. */ typedef unspecified_type Has_on_positive_side_3; -/*! +/*! Predicate object type that provides `Oriented_side operator()(Plane_3 p, Point_3 q)`, which determines the position of point `q` relative to plane `p`. @@ -89,7 +89,7 @@ typedef unspecified_type Oriented_side_3; /// Only a copy constructor is required. /// @{ -/*! +/*! */ IsStronglyConvexTraits_3(IsStronglyConvexTraits_3& t); @@ -104,7 +104,7 @@ predicate object type. For example: */ /// @{ -/*! +/*! */ Construct_ray_3 construct_ray_3_object(); diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h index 378dc4373d4..81f92306f97 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_to_polyhedron_3.h @@ -1,6 +1,6 @@ namespace CGAL { -/*! +/*! converts the convex hull `C` to polyhedral surface stored in `P`. \pre `dim == 3` and `dcur == 3`. @@ -10,7 +10,7 @@ converts the convex hull `C` to polyhedral surface stored in template void convex_hull_d_to_polyhedron_3( const Convex_hull_d& C, Polyhedron_3& P) ; -/*! +/*! constructs the representation of the surface of `C` as a bidirected LEDA graph `G`. \pre `dim == 3`. diff --git a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h index 49c3a992a27..32755837f67 100644 --- a/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h +++ b/Convex_hull_d/doc/Convex_hull_d/CGAL/Convex_hull_d_traits_3.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Convex_hull_d_traits_3(); diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h index 802e65abecb..a2cf31b0127 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/ConvexHullTraits_d.h @@ -16,40 +16,40 @@ public: /// \name Types /// @{ -/*! +/*! the dD point type on which the convex hull algorithm operates */ typedef unspecified_type Point_d; -/*! +/*! a dD plane */ typedef unspecified_type Hyperplane_d; -/*! +/*! a dD vector */ typedef unspecified_type Vector_d; -/*! +/*! a dD ray */ typedef unspecified_type Ray_d; -/*! +/*! an arithmetic ring type */ typedef unspecified_type RT; -/*! +/*! Function object type that provides `Vector_d operator()(int d, CGAL::Null_vector)`, which constructs and returns the null vector. */ typedef unspecified_type Construct_vector_d; -/*! +/*! Function object type that provides `Hyperplane_d operator()(ForwardIterator first, ForwardIterator last, Point_d p, CGAL::Oriented_side side)`, which @@ -61,21 +61,21 @@ tuple is returned. */ typedef unspecified_type Construct_hyperplane_d; -/*! +/*! Function object type that provides `Point_d operator()(Vector_d v)`, which constructs and returns the point defined by \f$ 0+v\f$. */ typedef unspecified_type Vector_to_point_d; -/*! +/*! Function object type that provides `Vector_d operator()(Point_d v)`, which constructs and returns the vector defined by \f$ p-0\f$. */ typedef unspecified_type Point_to_vector_d; -/*! +/*! Function object type that provides `Orientation operator()(ForwardIterator first, ForwardIterator last)`, which determines the orientation of the @@ -83,7 +83,7 @@ points `tuple[first,last)`. */ typedef unspecified_type Orientation_d; -/*! +/*! Function object type that provides `Vector_d operator()(Hyperplane_d h)`, which constructs and returns a vector orthogonal to `h` and pointing from the boundary @@ -91,14 +91,14 @@ into its positive halfspace. */ typedef unspecified_type Orthogonal_vector_d; -/*! +/*! Predicate object type that provides `Oriented_side operator()(Hyperplane_d h, Point_d p)`, which determines the oriented side of `p` with respect to `h`. */ typedef unspecified_type Oriented_side_d; -/*! +/*! Predicate object type that provides `bool operator()(Hyperplane_d h, Point_d p)`, which return true iff `p` lies in the positive halfspace determined by @@ -106,14 +106,14 @@ return true iff `p` lies in the positive halfspace determined by */ typedef unspecified_type Has_on_positive_side_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last)`, which determines if the points `tuple[first,last)` are affinely independent. */ typedef unspecified_type Affinely_independent_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last, Point_d p)`, which determines if `p` is contained in @@ -121,7 +121,7 @@ the closed simplex defined by the points in `tuple[first,last)`. */ typedef unspecified_type Contained_in_simplex_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last, Point_d p)`, which determines if `p` is contained in @@ -129,7 +129,7 @@ the affine hull of the points in `tuple[first,last)`. */ typedef unspecified_type Contained_in_affined_hull_d; -/*! +/*! Predicate object type that provides `Object operator()(Ray_d r, Hyperplane_d h)`, which determines if `r` and `h` intersect and returns the corresponding @@ -150,7 +150,7 @@ predicate object type. For example: */ /// @{ -/*! +/*! */ Construct_vector_d construct_vector_d_object(); diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h index 4be66c74794..8e403582f50 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayLiftedTraits_d.h @@ -15,40 +15,40 @@ public: /// \name Types /// @{ -/*! +/*! the dD point type on which the Delaunay algorithm operates */ typedef unspecified_type Point_d; -/*! +/*! a dD plane */ typedef unspecified_type Hyperplane_d; -/*! +/*! a dD vector */ typedef unspecified_type Vector_d; -/*! +/*! a dD ray */ typedef unspecified_type Ray_d; -/*! +/*! a arithmetic ring type */ typedef unspecified_type RT; -/*! +/*! Function object type that provides `Vector_d operator()(int d, CGAL::Null_vector)`, which constructs and returns the null vector. */ typedef unspecified_type Construct_vector_d; -/*! +/*! Function object type that provides `Hyperplane_d operator()(ForwardIterator first, ForwardIterator last, Point_d p, CGAL::Oriented_side side)`, which @@ -60,21 +60,21 @@ tuple is returned. */ typedef unspecified_type Construct_hyperplane_d; -/*! +/*! Function object type that provides `Point_d operator()(Vector_d v)`, which constructs and returns the point defined by \f$ 0+v\f$. */ typedef unspecified_type Vector_to_point_d; -/*! +/*! Function object type that provides `Vector_d operator()(Point_d v)`, which constructs and returns the vector defined by \f$ p-0\f$. */ typedef unspecified_type Point_to_vector_d; -/*! +/*! Function object type that provides `Orientation operator()(ForwardIterator first, ForwardIterator last)`, which determines the orientation of the @@ -82,7 +82,7 @@ points `tuple[first,last)`. */ typedef unspecified_type Orientation_d; -/*! +/*! Function object type that provides `Vector_d operator()(Hyperplane_d h)`, which constructs and returns a vector orthogonal to `h` and pointing from the boundary @@ -90,14 +90,14 @@ into its positive halfspace. */ typedef unspecified_type Orthogonal_vector_d; -/*! +/*! Predicate object type that provides `Oriented_side operator()(Hyperplane_d h, Point_d p)`, which determines the oriented side of `p` with respect to `h`. */ typedef unspecified_type Oriented_side_d; -/*! +/*! Predicate object type that provides `bool operator()(Hyperplane_d h, Point_d p)`, which return true iff `p` lies in the positive halfspace determined by @@ -105,14 +105,14 @@ return true iff `p` lies in the positive halfspace determined by */ typedef unspecified_type Has_on_positive_side_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last)`, which determines if the points `tuple[first,last)` are affinely independent. */ typedef unspecified_type Affinely_independent_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last, Point_d p)`, which determines if `p` is contained in @@ -120,7 +120,7 @@ the closed simplex defined by the points in `tuple[first,last)`. */ typedef unspecified_type Contained_in_simplex_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last, Point_d p)`, which determines if `p` is contained in @@ -128,7 +128,7 @@ the affine hull of the points in `tuple[first,last)`. */ typedef unspecified_type Contained_in_affined_hull_d; -/*! +/*! Predicate object type that provides `Object operator()(Ray_d r, Hyperplane_d h)`, which determines if `r` and `h` intersect and returns the corresponding @@ -145,7 +145,7 @@ requirements. */ /// @{ -/*! +/*! Predicate object type that provides `DelaunayTraits_d::Point_d operator()(Point_d p)`, which determines the \f$ d-1\f$-dimensional point from the \f$ d\f$-dimensional point @@ -153,7 +153,7 @@ determines the \f$ d-1\f$-dimensional point from the \f$ d\f$-dimensional point */ typedef unspecified_type Project_along_d_axis_d; -/*! +/*! Predicate object type that provides `Point_d operator()(DelaunayTraits_d::Point_d p)`, which determines the \f$ d\f$-dimensional point from the \f$ d-1\f$-dimensional point @@ -161,7 +161,7 @@ determines the \f$ d\f$-dimensional point from the \f$ d-1\f$-dimensional point */ typedef unspecified_type Lift_to_paraboloid_d; -/*! +/*! Predicate object type that provides `RT homogeneous(Vector_d v,int i)` and `int dimension(Vector_d v)`, where the former determines the \f$ i\f$th @@ -187,7 +187,7 @@ predicate object type. For example: */ /// @{ -/*! +/*! */ Construct_vector_d construct_vector_d_object(); diff --git a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h index bda11d494ac..7bc4621a3ea 100644 --- a/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h +++ b/Convex_hull_d/doc/Convex_hull_d/Concepts/DelaunayTraits_d.h @@ -16,30 +16,30 @@ public: /// \name Types /// @{ -/*! +/*! the dD point type on which the Delaunay algorithm operates */ typedef unspecified_type Point_d; -/*! +/*! a dD sphere */ typedef unspecified_type Sphere_d; -/*! +/*! an arithmetic field type */ typedef unspecified_type FT; -/*! +/*! Predicate object type that provides `Point_d operator()(Sphere_d s, int i)`, which returns the \f$ i\f$th point defining sphere `s`. */ typedef unspecified_type Point_of_sphere_d; -/*! +/*! Predicate object type that provides `Sphere_d operator()(int d, ForwardIterator first, ForwardIterator last)`, which returns a dD sphere through the points in @@ -47,7 +47,7 @@ last)`, which returns a dD sphere through the points in */ typedef unspecified_type Construct_sphere_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last, Point_d p)`, which determines if `p` is contained in @@ -55,14 +55,14 @@ the closed simplex defined by the points in `tuple[first,last)`. */ typedef unspecified_type Contained_in_simplex_d; -/*! +/*! Predicate object type that provides `FT operator()(Point_d p,Point_d q)`, which determines the squared distance from `p` to `q`. */ typedef unspecified_type Squared_distance_d; -/*! +/*! Predicate object type that provides `bool operator()(ForwardIterator first, ForwardIterator last)`, which determines if the points in `tuple[first,last)` are @@ -83,7 +83,7 @@ predicate object type. For example: */ /// @{ -/*! +/*! */ Construct_sphere_d construct_sphere_d_object(); diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h index 147621b9ac2..f901f15efca 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramEdge.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! the size type (convertible to `size_t`). */ typedef unspecified_type Size; -/*! +/*! the corresponding diagram-vertex type. */ typedef unspecified_type Vertex; -/*! +/*! the \f$ x\f$-monotone curve type. */ typedef unspecified_type X_monotone_curve_2; @@ -38,12 +38,12 @@ typedef unspecified_type X_monotone_curve_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ EnvelopeDiagramEdge(); -/*! +/*! copy constructor. */ EnvelopeDiagramEdge (const EnvelopeDiagramEdge& other); @@ -53,39 +53,39 @@ EnvelopeDiagramEdge (const EnvelopeDiagramEdge& other); /// \name Access Functions /// @{ -/*! +/*! returns the number of \f$ x\f$-monotone curves associated with `e`. */ Size number_of_curves () const; -/*! +/*! returns whether `e` represents an empty interval - namely, whether the set of \f$ x\f$-monotone curves associated with it is empty. */ bool is_empty () const; -/*! +/*! returns a representative \f$ x\f$-monotone curve associated with `e`. \pre `e` does not represent an empty interval. */ const X_monotone_curve_2& curve () const; -/*! +/*! returns an iterator for the first \f$ x\f$-monotone curve associated with `e`. */ Curve_const_iterator curves_begin () const; -/*! +/*! returns a past-the-end iterator for the \f$ x\f$-monotone curves associated with `e`. */ Curve_const_iterator curves_end () const; -/*! +/*! returns the vertex lying to `e`'s left. \pre `e` is not the leftmost edge in the diagram. */ Vertex_const_handle left() const; -/*! +/*! returns the vertex lying to `e`'s right. \pre `e` is not the rightmost edge in the diagram. */ @@ -96,28 +96,28 @@ Vertex_const_handle right() const; /// \name Modifiers /// @{ -/*! +/*! clears the set of curves associated with `e`. */ void clear_curves(); -/*! +/*! adds the \f$ x\f$-monotone curve `cv` to the set of curves associated with `e`. */ void add_curve (const X_monotone_curve_2& cv); -/*! +/*! adds the given range of \f$ x\f$-monotone curves to the set of curves associated with `e`. */ void add_curves (Curve_const_iterator begin, Curve_const_iterator end); -/*! +/*! sets the vertex lying to the left of `e` to be `v`. */ void set_left (Vertex_const_handle v); -/*! +/*! sets the vertex lying to the right of `e` to be `v`. */ void set_right (Vertex_const_handle v); diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h index bb6cd8b480f..54acaae7724 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagramVertex.h @@ -19,22 +19,22 @@ public: /// \name Types /// @{ -/*! +/*! the size type (convertible to `size_t`). */ typedef unspecified_type Size; -/*! +/*! the corresponding diagram-edge type. */ typedef unspecified_type Edge; -/*! +/*! the point type associated with the vertex. */ typedef unspecified_type Point_2; -/*! +/*! the \f$ x\f$-monotone curve type. */ typedef unspecified_type X_monotone_curve_2; @@ -44,17 +44,17 @@ typedef unspecified_type X_monotone_curve_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ EnvelopeDiagramVertex(); -/*! +/*! copy constructor. */ EnvelopeDiagramVertex (const EnvelopeDiagramVertex& other); -/*! +/*! constructs a vertex associated with the given point `p`. */ EnvelopeDiagramVertex (const Point_2& p); @@ -64,32 +64,32 @@ EnvelopeDiagramVertex (const Point_2& p); /// \name Access Functions /// @{ -/*! +/*! returns the point associated with `v`. */ const Point_2& point () const; -/*! +/*! returns the number of \f$ x\f$-monotone curves associated with `v`. */ Size number_of_curves () const; -/*! +/*! returns an iterator for the first \f$ x\f$-monotone curve associated with `v`. */ Curve_const_iterator curves_begin () const; -/*! +/*! returns a past-the-end iterator for the \f$ x\f$-monotone curves associated with `v`. */ Curve_const_iterator curves_end () const; -/*! +/*! returns the edge lying to `v`'s left. */ Edge_const_handle left() const; -/*! +/*! returns the edge lying to `v`'s right. */ Edge_const_handle right() const; @@ -99,33 +99,33 @@ Edge_const_handle right() const; /// \name Modifiers /// @{ -/*! +/*! associates the point `p` with `v`. */ void set_point (const Point_2& p); -/*! +/*! clears the set of curves associated with `v`. */ void clear_curves(); -/*! +/*! adds the \f$ x\f$-monotone curve `cv` to the set of curves associated with `v`. */ void add_curve (const X_monotone_curve_2& cv); -/*! +/*! adds the given range of \f$ x\f$-monotone curves to the set of curves associated with `v`. */ void add_curves (Curve_const_iterator begin, Curve_const_iterator end); -/*! +/*! sets the edge lying to the left of `v` to be `e`. */ void set_left (Edge_const_handle e); -/*! +/*! sets the edge lying to the right of `v` to be `e`. */ void set_right (Edge_const_handle e); diff --git a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h index 7ae9c3e542a..485761eb7a9 100644 --- a/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h +++ b/Envelope_2/doc/Envelope_2/Concepts/EnvelopeDiagram_1.h @@ -41,57 +41,57 @@ public: /// \name Types /// @{ -/*! +/*! the geometric traits class. */ typedef unspecified_type Traits_2; -/*! +/*! the point type. */ typedef Traits_2::Point_2 Point_2; -/*! +/*! the \f$ x\f$-monotone curve type. */ typedef Traits_2::X_monotone_curve_2 X_monotone_curve_2; -/*! +/*! the size type (convertible to `size_t`). */ typedef unspecified_type Size; -/*! +/*! an iterator for the \f$ x\f$-monotone curves that induce a diagram feature, with value type `X_monotone_curve_2`. */ typedef unspecified_type Curve_const_iterator; -/*! +/*! the vertex type, a model of the concept `EnvelopeDiagramVertex`. */ typedef unspecified_type Vertex; -/*! +/*! the edge type, a model of the concept `EnvelopeDiagramEdge`. */ typedef unspecified_type Edge; -/*! +/*! a handle to a diagram vertex. */ typedef unspecified_type Vertex_handle; -/*! +/*! a non-mutable handle to a diagram vertex. */ typedef unspecified_type Vertex_const_handle; -/*! +/*! a handle to a diagram edge. */ typedef unspecified_type Edge_handle; -/*! +/*! a non-mutable handle to a diagram edge. */ typedef unspecified_type Edge_const_handle; @@ -101,14 +101,14 @@ typedef unspecified_type Edge_const_handle; /// \name Creation /// @{ -/*! +/*! constructs an empty diagram containing one unbounded edge, which corresponds to the entire plane and has no \f$ x\f$-monotone curves that are associated with it. */ EnvelopeDiagram_1(); -/*! +/*! copy constructor. */ Envelope_diagram_1 (const Self& other); @@ -118,12 +118,12 @@ Envelope_diagram_1 (const Self& other); /// \name Access Functions /// @{ -/*! +/*! returns the leftmost edge of the diagram (a non-const version is also available). */ Edge_const_handle leftmost() const; -/*! +/*! returns the rightmost edge of the diagram (a non-const version is also available). */ Edge_const_handle rightmost() const; @@ -133,32 +133,32 @@ Edge_const_handle rightmost() const; /// \name Modifiers /// @{ -/*! +/*! sets the leftmost edge of the diagram to be `e`. */ void set_leftmost (Edge_const_handle e); -/*! +/*! sets the rightmost edge of the diagram to be `e`. */ void set_rightmost (Edge_const_handle e); -/*! +/*! creates a new diagram vertex, associated with the point `p`. */ Vertex_handle new_vertex (const Point_2& p); -/*! +/*! creates a new diagram edge. */ Edge_handle new_edge (); -/*! +/*! deletes the given vertex `v`. */ void delete_vertex (Vertex_handle v); -/*! +/*! deletes the given edge `e`. */ void delete_edge (Edge_handle e); diff --git a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h index cd5b2f47eaa..30dbf206ca1 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/Env_surface_data_traits_3.h @@ -49,32 +49,32 @@ public: /// \name Types /// @{ -/*! +/*! the base traits-class. */ typedef Traits Base_traits_3; -/*! +/*! the base surface. */ typedef typename Base_traits_3::Surface_3 Base_surface_3; -/*! +/*! the base \f$ xy\f$-monotone surface surface. */ typedef typename Base_traits_3::Xy_monotone_surface_3 Base_xy_monotone_surface_3; -/*! +/*! the conversion functor. */ typedef Cnv Convert; -/*! +/*! the type of data associated with surfaces. */ typedef SData Surface_data; -/*! +/*! the type of data associated with \f$ xy\f$-monotone surfaces. */ typedef XyData Xy_monotone_surface_data; @@ -87,18 +87,18 @@ typedef XyData Xy_monotone_surface_data; /// \name Creation /// @{ - /*! + /*! default constructor. */ Surface_3 (); - /*! + /*! constructs surface from the given `base` surface with uninitialized data field. */ Surface_3 (const Base_surface_3& base); - /*! + /*! constructs surface from the given `base` surface with an attached `data` field. */ @@ -109,13 +109,13 @@ typedef XyData Xy_monotone_surface_data; /// \name Access Functions /// @{ - /*! + /*! returns the data field (a non-const version, which returns a reference to the data object, is also available). */ const Surface_data& data () const; - /*! + /*! sets the data field. */ void set_data (const Surface_data& data); @@ -131,18 +131,18 @@ typedef XyData Xy_monotone_surface_data; /// \name Creation /// @{ - /*! + /*! default constructor. */ Xy_monotone_surface_3 (); - /*! + /*! constructs an \f$ xy\f$-monotone surface from the given `base` surface with uninitialized data field. */ Xy_monotone_surface_3 (const Base_xy_monotone_surface_3& base); - /*! + /*! constructs an \f$ x\f$-monotone surface from the given `base` \f$ x\f$-monotone surface with an attached `data` field. */ @@ -154,13 +154,13 @@ typedef XyData Xy_monotone_surface_data; /// \name Access Functions /// @{ - /*! + /*! returns the field (a non-const version, which returns a reference to the data object, is also available). */ const Xy_monotone_surface_data& data () const; - /*! + /*! sets the data field. */ void set_data (const Xy_monotone_surface_data& data); diff --git a/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h b/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h index d83478781d2..d5c6b319111 100644 --- a/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h +++ b/Envelope_3/doc/Envelope_3/CGAL/envelope_3.h @@ -29,17 +29,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Envelope_diagram_2 Self; -/*! +/*! */ typedef Arrangement_2 Base; -/*! +/*! an iterator for the \f$ xy\f$-monotone surfaces that induce a diagram feature. Its value-type is `EnvTraits::Xy_monotone_surface_3`. */ @@ -50,18 +50,18 @@ typedef unspecified_type Surface_const_iterator; /// \name Creation /// @{ -/*! +/*! constructs an empty diagram containing one unbounded face, which corresponds to the entire plane and has no originators. */ Envelope_diagram_2(); -/*! +/*! copy constructor. */ Envelope_diagram_2 (const Self& other); -/*! +/*! constructs an empty diagram that uses the given `traits` instance for performing the geometric predicates. */ @@ -74,23 +74,23 @@ Envelope_diagram_2 (EnvTraits *traits); /// \name Access Functions /// @{ - /*! + /*! returns the number of \f$ xy\f$-monotone surfaces that induce `v`. */ size_t number_of_surfaces () const; - /*! + /*! returns an iterator for the first \f$ xy\f$-monotone surface that induces `v`. */ Surface_const_iterator surfaces_begin () const; - /*! + /*! returns a past-the-end iterator for the \f$ xy\f$-monotone surfaces that induce `v`. */ Surface_const_iterator surfaces_end () const; - /*! + /*! returns the first \f$ xy\f$-monotone surface that induce `v`. \pre The number of surfaces is not 0. */ @@ -109,18 +109,18 @@ Envelope_diagram_2 (EnvTraits *traits); */ size_t number_of_surfaces () const; - /*! + /*! returns an iterator for the first \f$ xy\f$-monotone surface that induces the halfedge. */ Surface_const_iterator surfaces_begin () const; - /*! + /*! returns a past-the-end iterator for the \f$ xy\f$-monotone surfaces that induce the halfedge. */ Surface_const_iterator surfaces_end () const; - /*! + /*! returns the first \f$ xy\f$-monotone surface that induce `e`. \pre The number of surfaces is not 0. */ @@ -133,23 +133,23 @@ Envelope_diagram_2 (EnvTraits *traits); /// \name Access Functions /// @{ - /*! + /*! returns the number of \f$ xy\f$-monotone surfaces that induce the face. */ size_t number_of_surfaces () const; - /*! + /*! returns an iterator for the first \f$ xy\f$-monotone surface that induces the face. */ Surface_const_iterator surfaces_begin () const; - /*! + /*! returns a past-the-end iterator for the \f$ xy\f$-monotone surfaces that induce the face. */ Surface_const_iterator surfaces_end () const; - /*! + /*! returns the first \f$ xy\f$-monotone surface that induce the face. \pre The number of surfaces is not 0. */ diff --git a/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h b/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h index 1764253df05..41c5969a332 100644 --- a/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h +++ b/Envelope_3/doc/Envelope_3/Concepts/EnvelopeTraits_3.h @@ -29,12 +29,12 @@ public: /// \name Types /// @{ -/*! +/*! represents an arbitrary surface in \f$ \mathbb{R}^3\f$. */ typedef unspecified_type Surface_3; -/*! +/*! represents a weakly \f$ xy\f$-monotone surface in \f$ \mathbb{R}^3\f$. */ typedef unspecified_type Xy_monotone_surface_3; @@ -44,7 +44,7 @@ typedef unspecified_type Xy_monotone_surface_3; /// \name Functor Types /// @{ -/*! +/*! provides the operator (templated by the `OutputIterator` type) :
    • `OutputIterator operator() (Surface_3 S, bool is_lower, OutputIterator oi)` @@ -60,7 +60,7 @@ The operator returns a past-the-end iterator for the output sequence. */ typedef unspecified_type Make_xy_monotone_3; -/*! +/*! provides the operator (templated by the `OutputIterator` type) :
      • `OutputIterator operator() (Xy_monotone_surface_3 s, OutputIterator oi)` @@ -84,7 +84,7 @@ iterator for the output sequence. */ typedef unspecified_type Construct_projected_boundary_2; -/*! +/*! provides the operator (templated by the `OutputIterator` type) :
        • `OutputIterator operator() (Xy_monotone_surface_3 s1, Xy_monotone_surface_3 s2, OutputIterator oi)` @@ -104,7 +104,7 @@ The operator returns a past-the-end iterator for the output sequence. */ typedef unspecified_type Construct_projected_intersections_2; -/*! +/*! provides the operators :
          • `Comparison_result operator() (Point_2 p, Xy_monotone_surface_3 s1, Xy_monotone_surface_3 s2)` @@ -135,7 +135,7 @@ is defined as `Tag_true`. */ typedef unspecified_type Compare_z_at_xy_3; -/*! +/*! provides the operator :
            • `Comparison_result operator() (X_monotone_curve_2 c, Xy_monotone_surface_3 s1, Xy_monotone_surface_3 s2)` @@ -152,7 +152,7 @@ some small enough neighborhood of points above \f$ c\f$. */ typedef unspecified_type Compare_z_at_xy_above_3; -/*! +/*! provides the operator :
              • `Comparison_result operator() (X_monotone_curve_2 c, Xy_monotone_surface_3 s1, Xy_monotone_surface_3 s2)` @@ -174,17 +174,17 @@ typedef unspecified_type Compare_z_at_xy_below_3; /// \name Creation /// @{ -/*! +/*! default constructor. */ EnvelopeTraits_3(); -/*! +/*! copy constructor. */ EnvelopeTraits_3(EnvelopeTraits_3 other); -/*! +/*! assignment operator. */ EnvelopeTraits_3 operator=(other); @@ -194,32 +194,32 @@ EnvelopeTraits_3 operator=(other); /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Make_xy_monotone_3 make_xy_monotone_3_object(); -/*! +/*! */ Construct_projected_boundary_2 construct_projected_boundary_2_object(); -/*! +/*! */ Construct_projected_intersections_2 construct_projected_intersections_2_object(); -/*! +/*! */ Compare_z_at_xy_3 compare_z_at_xy_3_object(); -/*! +/*! */ Compare_z_at_xy_above_3 compare_z_at_xy_above_3_object(); -/*! +/*! */ Compare_z_at_xy_below_3 compare_z_at_xy_below_3_object(); diff --git a/Generator/doc/Generator/CGAL/Random.h b/Generator/doc/Generator/CGAL/Random.h index 0444d9ea75d..71f3e1dfb74 100644 --- a/Generator/doc/Generator/CGAL/Random.h +++ b/Generator/doc/Generator/CGAL/Random.h @@ -32,7 +32,7 @@ public: /// \name Types /// @{ -/*! +/*! The State type. */ typedef unspecified_type State; @@ -42,14 +42,14 @@ typedef unspecified_type State; /// \name Creation /// @{ -/*! +/*! %Default constructor. The seed is chosen based on the system time. */ Random( ); -/*! +/*! Constructor initializing its internal state using `seed`. Equal values for `seed` result in equal sequences of random @@ -62,13 +62,13 @@ Random( unsigned int seed); /// \name Operations /// @{ -/*! +/*! returns a random `bool`. */ bool get_bool( ); -/*! +/*! returns a random `int` value from the interval \f$[0,2^b)\f$. This is supposed to @@ -76,14 +76,14 @@ be efficient. */ template int get_bits(); -/*! +/*! returns a random `int` from the interval `[lower,upper)`. */ int get_int( int lower, int upper); -/*! +/*! returns a random `double` from the interval `[lower,upper)`. @@ -97,7 +97,7 @@ double upper = 1.0); /// The following member functions are a 1-to-1 correspondence to some distributions from the boost random library. /// @{ -/*! +/*! returns a random `IntType` from the interval `[lower,upper)`. `IntType` can be an integral type @@ -106,7 +106,7 @@ as `int`, `std::ptrdiff_t`, `std::size_t`,etc. */ template IntType uniform_smallint( IntType lower=0, IntType upper=9); -/*! +/*! returns a random `IntType` from the interval `[lower,upper)`. `IntType` can be an integral type @@ -115,7 +115,7 @@ as `int`, `std::ptrdiff_t`, `std::size_t`,etc. */ template IntType uniform_int( IntType lower=0, IntType upper=9); -/*! +/*! returns a random `RealType` from the interval `[lower,upper)`. `RealType` can be `float`, `double`, etc. @@ -123,14 +123,14 @@ returns a random `RealType` from the interval template Realtype uniform_real( RealType lower = 0.0, RealType upper = 1.0); -/*! +/*! returns a random `RealType` from the interval `[0,1)`. `RealType` can be `float`, `double`, etc. */ template RealType uniform_01(); -/*! +/*! returns `random``uniform_int( 0, upper-1)`. */ @@ -141,19 +141,19 @@ template IntType operator() ( IntType upper); /// \name Seed and State Functions /// @{ -/*! +/*! returns the seed used for initialization. */ unsigned int get_seed() const; -/*! +/*! saves the current internal state in `state`. */ void save_state( State& state) const; -/*! +/*! restores the internal state from `state`. */ @@ -164,7 +164,7 @@ void restore_state( State const& state); /// \name Equality Test /// @{ -/*! +/*! returns `true`, iff the random object and `random2` have equal internal states. diff --git a/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h b/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h index 1c9327a0470..568261f68cd 100644 --- a/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h +++ b/Generator/doc/Generator/CGAL/Random_convex_set_traits_2.h @@ -15,36 +15,36 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Kernel::Point_2 Point_2; -/*! +/*! */ typedef Kernel::FT FT; -/*! +/*! function object class derived from `std::binary_function` */ typedef unspecified_type Sum; -/*! +/*! function object class derived from `std::binary_function` */ typedef unspecified_type Scale; -/*! +/*! function object class derived from `std::unary_function` */ typedef unspecified_type Max_coordinate; -/*! +/*! function object class derived from `std::binary_function` */ @@ -55,7 +55,7 @@ typedef unspecified_type Angle_less; /// \name Creation /// @{ -/*! +/*! default constructor */ Random_convex_set_traits_2(); @@ -65,7 +65,7 @@ Random_convex_set_traits_2(); /// \name Operations /// @{ -/*! +/*! returns CGAL::ORIGIN. */ Point_2 origin() const; diff --git a/Generator/doc/Generator/Concepts/PointGenerator.h b/Generator/doc/Generator/Concepts/PointGenerator.h index 350e0a6b6e6..5faf00a3897 100644 --- a/Generator/doc/Generator/Concepts/PointGenerator.h +++ b/Generator/doc/Generator/Concepts/PointGenerator.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! the type of point being generated. */ typedef unspecified_type value_type; @@ -35,7 +35,7 @@ typedef unspecified_type value_type; /// \name Operations /// @{ -/*! +/*! returns an absolute bound for the coordinates of all generated points. */ diff --git a/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h b/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h index 5772deaca46..52de2d5b770 100644 --- a/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h +++ b/Generator/doc/Generator/Concepts/RandomConvexSetTraits_2.h @@ -15,18 +15,18 @@ public: /// \name Types /// @{ -/*! +/*! point class. */ typedef unspecified_type Point_2; -/*! +/*! class used for doing computations on point and vector coordinates (has to fulfill field type requirements). */ typedef unspecified_type FT; -/*! +/*! AdaptableBinaryFunction class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `Point_2`. It returns the point that results from adding @@ -34,7 +34,7 @@ the vectors corresponding to both arguments. */ typedef unspecified_type Sum; -/*! +/*! AdaptableBinaryFunction class: `Point_2` \f$ \times\f$ `FT` \f$ \rightarrow\f$ `Point_2`. `Scale(p,k)` returns the point that @@ -43,14 +43,14 @@ factor of `k`. */ typedef unspecified_type Scale; -/*! +/*! AdaptableUnaryFunction class: `Point_2` \f$ \rightarrow\f$ `FT`. `Max_coordinate(p)` returns the coordinate of `p` with largest absolute value. */ typedef unspecified_type Max_coordinate; -/*! +/*! AdaptableBinaryFunction class: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `bool`. It returns `true`, iff the angle of the @@ -65,7 +65,7 @@ typedef unspecified_type Angle_less; /// \name Operations /// @{ -/*! +/*! return origin (neutral element for the `Sum` operation). */ diff --git a/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h b/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h index c564ccf52df..3f4f54b0628 100644 --- a/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h +++ b/Generator/doc/Generator/Concepts/RandomPolygonTraits_2.h @@ -20,17 +20,17 @@ public: /// \name Types /// @{ -/*! +/*! The coordinate type of the points of the polygon. */ typedef unspecified_type FT; -/*! +/*! The point type of the polygon. */ typedef unspecified_type Point_2; -/*! +/*! Predicate object type that determines the orientation of three points. It must provide `Orientation operator()(Point_2 p, Point_2 q, Point_2 r)` that @@ -41,7 +41,7 @@ on \f$ l\f$. */ typedef unspecified_type Orientation_2; -/*! +/*! Binary predicate object type comparing `Point_2`s lexicographically. It must provide `bool operator()(Point_2 p, Point_2 q)` that returns `true` iff \f$ p <_{xy} q\f$. @@ -57,12 +57,12 @@ typedef unspecified_type Less_xy_2; /// \name Operations /// @{ -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Orienation_2 orientation_2_object(); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h index 6db353d6049..26b2cb56625 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/CircularArcGraphicsItem.h @@ -15,7 +15,7 @@ public: /// \name Creation /// @{ -/*! +/*! Constructs a graphics item for a circular arc. */ @@ -26,17 +26,17 @@ CircularArcGraphicsItem(); /// \name Operations /// @{ -/*! +/*! Returns the pen used to draw edges. */ QPen edgesPen()() const; -/*! +/*! Sets the pen used to draw edges. */ void setEdgesPen()(const QPen& p); -/*! +/*! Sets the circular arc. */ void setArc(const Circular_arc_2& ca2); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h index eb8b3e4ec72..2ea6dc9f5cb 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/ConstrainedTriangulationGraphicsItem.h @@ -16,7 +16,7 @@ public: /// \name Creation /// @{ -/*! +/*! Constructs a graphics item for triangulation `ct`. */ @@ -27,12 +27,12 @@ ConstrainedTriangulationGraphicsItem(CT* ct); /// \name Operations /// @{ -/*! +/*! Returns the pen used to draw constraints. */ QPen constraintsPen()() const; -/*! +/*! Sets the pen used to draw constraints. */ void setConstraintsPen()(const QPen& p); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/Converter.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/Converter.h index 2a3782b8a53..40f9dff1c71 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/Converter.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/Converter.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! The clipping rect is used for unbounded \cgal objects. */ Converter(QRectF clippingRect); @@ -31,42 +31,42 @@ Converter(QRectF clippingRect); /// \name From CGAL to Qt /// @{ -/*! +/*! Converts a bounding box. */ QRectF operator()(Bbox_2); -/*! +/*! Converts a point. */ QPointF operator()(K::Point_2); -/*! +/*! Converts a segment. */ QLineF operator()(K::Segment_2); -/*! +/*! Clips the ray and converts the resulting segment. */ QLineF operator()(K::Ray_2); -/*! +/*! Clips the line and converts the resulting segment. */ QLineF operator()(K::Line_2); -/*! +/*! Converts a triangle. */ QPolygonF operator()(K::Triangle_2); -/*! +/*! Converts an iso rectangle. */ QRectF operator()(K::Iso_rectangle_2); -/*! +/*! Converts a list of points to a polygon. */ QPolygonF operator()(std::list); @@ -76,22 +76,22 @@ QPolygonF operator()(std::list); /// \name From Qt to CGAL /// @{ -/*! +/*! Converts a point. */ K::Point_2 operator()(QPointF); -/*! +/*! Converts a segment. */ K::Segment_2 operator()(QLineF); -/*! +/*! Converts an iso rectangle. */ K::Iso_rectangle_2 operator()(QRectF); -/*! +/*! Converts a polygon to a list of points. */ std::list operator()(QPolygonF); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsItem.h index dc9a6df0db5..a39084f51b6 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsItem.h @@ -15,7 +15,7 @@ public: /// \name Slots /// @{ -/*! +/*! This slot must be provided by derived classes. */ virtual void modelChanged(); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h index c48f3931140..f08f45716e9 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircleInput.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! \param p is a parent object. \param s is the scene where the circle is generated. \param pointsOnCircle is the @@ -35,7 +35,7 @@ GraphicsViewCircleInput(QObject *p, QGraphicsScene* s, int pointsOnCircle = 1 /// \name Signals /// @{ -/*! +/*! The object `o` contains a `std::pair` for center and radius, or a `std::pair` for two points defining the circle, or `CGAL::array` for three points defining diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h index 232f83c8b85..b62a71616fa 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewCircularArcInput.h @@ -18,7 +18,7 @@ public: /// \name Creation /// @{ -/*! +/*! \param p is a parent object. \param s is the scene where the circular arc is generated. */ @@ -29,7 +29,7 @@ GraphicsViewCircularArcInput(QObject *p, QGraphicsScene* s); /// \name Signals /// @{ -/*! +/*! The object `o` contains a `Circular_arc_2`. */ void generate(Object o); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewInput.h index c73a480cf8d..8d7b5eabaa4 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewInput.h @@ -13,7 +13,7 @@ public: /// \name Signals /// @{ -/*! +/*! A signal that emits a `CGAL::Object`. */ void generate(Object); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h index e5f1ba41595..4e485606b91 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewIsoRectangleInput.h @@ -15,7 +15,7 @@ public: /// \name Creation /// @{ -/*! +/*! \param p is a parent object. \param s is the scene where the iso rectangle is generated. */ @@ -26,7 +26,7 @@ GraphicsViewIsoRectangleInput(QObject *p, QGraphicsScene* s); /// \name Signals /// @{ -/*! +/*! The object `o` contains a `K::Iso_rectangle_2`. */ void generate(Object o); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewNavigation.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewNavigation.h index 84719eb758f..2834386a54a 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewNavigation.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewNavigation.h @@ -17,7 +17,7 @@ public: /// \name Operations /// @{ -/*! +/*! The event filter. */ bool eventFilter(QObject *obj, QEvent *event); @@ -27,7 +27,7 @@ bool eventFilter(QObject *obj, QEvent *event); /// \name Signals /// @{ -/*! +/*! Emits the real world mouse coordinates. */ void mouseCoordinates(QPointF p); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h index 9b5e683e0b5..23a8915078e 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/GraphicsViewPolylineInput.h @@ -28,7 +28,7 @@ public: /// \name Creation /// @{ -/*! +/*! \param p is a parent object. \param s is the scene where the polyline is generated. \param n is the number of points of the polyline to be generated. If `n = 0`, @@ -44,7 +44,7 @@ bool closed = true); /// \name Signals /// @{ -/*! +/*! The object `o` contains a `std:list`. */ void generate(CGAL::Object o); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/PainterOstream.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/PainterOstream.h index c3a30cd97b7..ccc5b43e110 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/PainterOstream.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/PainterOstream.h @@ -15,7 +15,7 @@ public: /// \name Creation /// @{ -/*! +/*! The clipping rect is used for unbounded `Kernel` objects. */ PainterOstream(QPainter* qp, QRectF clippingRect); @@ -25,62 +25,62 @@ PainterOstream(QPainter* qp, QRectF clippingRect); /// \name Operations /// @{ -/*! +/*! Draws a point. */ PainterOstream operator<<(K::Point_2); -/*! +/*! Draws a segment. */ PainterOstream operator<<(K::Segment_2); -/*! +/*! Draws a clipped ray. */ PainterOstream operator<<(K::Ray_2); -/*! +/*! Draws a clipped line. */ PainterOstream operator<<(K::Line_2); -/*! +/*! Draws a triangle. */ PainterOstream operator<<(K::Triangle_2); -/*! +/*! Draws an iso rectangle. */ PainterOstream operator<<(K::Iso_rectangle_2); -/*! +/*! Draws a circle. */ PainterOstream operator<<(K::Circle_2); -/*! +/*! Draws a circular arc. */ PainterOstream operator<<(K::Circular_arc_2); -/*! +/*! Draws a polyline. In order to close it the first and last point must be equal. */ PainterOstream operator<<(std::list); -/*! +/*! Draws an iso rectangle. */ PainterOstream operator<<(Bbox_2); -/*! +/*! Sets the pen used in the next paint operations. */ PainterOstream operator<<(QPen); -/*! +/*! Sets the brush used in the next paint operations. */ PainterOstream operator<<(QBrush); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h index 7a3bdf4d068..048c29d08c0 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/TriangulationGraphicsItem.h @@ -15,7 +15,7 @@ public: /// \name Creation /// @{ -/*! +/*! Constructs a graphics item for a triangulation pointed by `t`. */ @@ -26,42 +26,42 @@ TriangulationGraphicsItem(T* t); /// \name Operations /// @{ -/*! +/*! Returns the pen used to draw vertices. */ QPen verticesPen()() const; -/*! +/*! Sets the pen used to draw vertices. */ void setVerticesPen()(const QPen& p); -/*! +/*! Returns the pen used to draw edges. */ QPen edgesPen()() const; -/*! +/*! Sets the pen used to draw edges. */ void setEdgesPen()(const QPen& p); -/*! +/*! Returns `true`, iff vertices are drawn. */ bool visibleVertices(); -/*! +/*! Sets the property. */ void setVisibleVertices(bool b); -/*! +/*! Returns `true`, iff edges are drawn. */ bool visibleEdges(); -/*! +/*! Sets the property. */ void setVisibleEdges(bool b); diff --git a/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h b/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h index 46a875a14d2..731cdc1c95a 100644 --- a/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h +++ b/GraphicsView/doc/GraphicsView/CGAL/Qt/VoronoiGraphicsItem.h @@ -17,7 +17,7 @@ public: /// \name Creation /// @{ -/*! +/*! Constructs a graphics item for the dual of the Delaunay triangulation `dt`. */ @@ -28,22 +28,22 @@ VoronoiGraphicsItem
                (DT* dt); /// \name Operations /// @{ -/*! +/*! Returns the pen used to draw edges. */ QPen edgesPen()() const; -/*! +/*! Set the pen used to draw edges. */ void setEdgesPen()(const QPen& p); -/*! +/*! Returns `true`, iff edges are drawn. */ bool visibleEdges(); -/*! +/*! Set the property. */ bool setVisibleEdges(bool b); diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h index f0b523102a8..872112801dc 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_const_decorator.h @@ -65,7 +65,7 @@ public: /// \name Creation /// @{ -/*! +/*! keeps internally a const reference to `hds`. */ HalfedgeDS_const_decorator( const HDS& hds); @@ -111,14 +111,14 @@ All tests of level 3 and `normalized_border_is_valid()`. */ /// @{ -/*! +/*! returns `true` if the halfedge data structure `hds` is valid with respect to the `level` value as defined above. If `verbose` is `true`, statistics are written to `cerr`. */ bool is_valid( bool verbose = false, int level = 0) const; -/*! +/*! returns `true` if the border halfedges are in normalized representation, which is when enumerating all halfedges with the halfedge iterator the following holds: The non-border edges precede the diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h index a0c8dac7bc2..547af29534c 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_decorator.h @@ -57,7 +57,7 @@ public: /// \name Creation /// @{ -/*! +/*! keeps internally a reference to `hds`. */ HalfedgeDS_decorator( HDS& hds); @@ -67,14 +67,14 @@ HalfedgeDS_decorator( HDS& hds); /// \name Creation of New Items /// @{ -/*! +/*! appends a copy of `v` to `hds` if vertices are supported. Returns a handle of the new vertex, or `Vertex_handle()` otherwise. */ Vertex_handle vertices_push_back( const Vertex& v); -/*! +/*! appends a copy of `f` to `hds` if faces are supported. Returns a handle of the new face, or `Face_handle()` otherwise. @@ -86,7 +86,7 @@ Face_handle faces_push_back( const Face& f); /// \name Creation of New Composed Items /// @{ -/*! +/*! returns handle of a halfedge from a newly created loop in `hds` consisting of a single closed edge, one vertex and two faces (if @@ -94,7 +94,7 @@ supported respectively). */ Halfedge_handle create_loop(); -/*! +/*! returns a halfedge from a newly created segment in `hds` consisting of a single open edge, two vertices and one face (if @@ -109,7 +109,7 @@ Halfedge_handle create_segment(); /// incidence relations except if mentioned otherwise. /// @{ -/*! +/*! removes the first vertex if vertices are supported. @@ -117,13 +117,13 @@ removes the first vertex if vertices are supported. */ void vertices_pop_front(); -/*! +/*! removes the last vertex if vertices are supported. */ void vertices_pop_back(); -/*! +/*! removes the vertex `v` if vertices are supported. @@ -131,7 +131,7 @@ removes the vertex `v` if vertices are supported. */ void vertices_erase( Vertex_handle v); -/*! +/*! removes the range `[first,last)` if vertices are supported. @@ -139,7 +139,7 @@ are supported. */ void vertices_erase( Vertex_handle first, Vertex_handle last); -/*! +/*! removes the first face if faces are supported. @@ -147,13 +147,13 @@ removes the first face if faces are supported. */ void faces_pop_front(); -/*! +/*! removes the last face if faces are supported. */ void faces_pop_back(); -/*! +/*! removes the face `f` if faces are supported. @@ -161,7 +161,7 @@ removes the face `f` if faces are supported. */ void faces_erase( Face_handle f); -/*! +/*! removes the range `[first,last)` if faces are supported. @@ -169,7 +169,7 @@ supported. */ void faces_erase( Face_handle first, Face_handle last); -/*! +/*! removes the face incident to `h` from `hds` and changes all halfedges incident to the face into border edges or removes them from the @@ -182,7 +182,7 @@ creates isolated vertices they get removed as well. See */ 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()`. @@ -190,7 +190,7 @@ connected component of `h`. \pre For all halfedges `g` in the connected componen */ void erase_connected_component( Halfedge_handle h); -/*! +/*! 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). @@ -206,7 +206,7 @@ unsigned int keep_largest_connected_components(unsigned int nb_components_to_kee /// \name Modifying Functions (For Border Halfedges) /// @{ -/*! +/*! removes the face incident to `h` from `hds` and creates a hole. \pre `h != Halfedge_handle()` and `!(h->is_border())`. @@ -214,21 +214,21 @@ removes the face incident to `h` from `hds` and creates a hole. */ void make_hole( Halfedge_handle h); -/*! +/*! fills the hole incident to `h` with a new face from `hds`. Returns `h`. \pre `h != Halfedge_handle()` and `h->is_border()`. */ Halfedge_handle fill_hole( Halfedge_handle h); -/*! +/*! fills the hole incident to `h` with a copy of face `f`. Returns `h`. \pre `h != Halfedge_handle()` and `h->is_border()`. */ Halfedge_handle fill_hole( Halfedge_handle h, const Face& f); -/*! +/*! extends the surface with a new face from `hds` into the hole incident to `h` and `g`. It creates a new edge connecting the vertex denoted by `g` with the vertex denoted by `h` and fills this separated @@ -239,7 +239,7 @@ to `g`. Returns the new halfedge that is incident to the new face. Halfedge_handle add_face_to_border( Halfedge_handle h, Halfedge_handle g); -/*! +/*! extends the surface with a copy of face `f` into the hole incident to `h` and `g`. It creates a new edge connecting the tip of `g` with the tip of `h` and fills this separated part of the hole with a @@ -271,7 +271,7 @@ the halfedge `h->next` with a new face in-between. */ /// @{ -/*! +/*! splits the face incident to `h` and `g` into two faces with a new diagonal between the two vertices denoted by `h` and `g` respectively. The second (new) face obtained from @@ -285,7 +285,7 @@ to the distance from `h` to `g` around the face. */ Halfedge_handle split_face( Halfedge_handle h, Halfedge_handle g); -/*! +/*! joins the two faces incident to `h`. The face incident to `h->opposite()` gets removed from `hds`. Both faces might be holes. Returns the predecessor of `h` around the face. The invariant @@ -300,7 +300,7 @@ of the face removed and the time to compute `h->prev()`. */ Halfedge_handle join_face( Halfedge_handle h); -/*! +/*! splits the vertex incident to `h` and `g` into two vertices and connects them with a new edge. The second (new) vertex obtained from `hds` is a copy of the first vertex. Returns @@ -313,7 +313,7 @@ to the distance from `h` to `g` around the vertex. */ Halfedge_handle split_vertex( Halfedge_handle h, Halfedge_handle g); -/*! +/*! joins the two vertices incident to `h`. The vertex denoted by `h->opposite()` gets removed by `hds`. Returns the predecessor of `h` around the vertex, i.e., `h->opposite()->prev()`. The invariant @@ -329,7 +329,7 @@ the time to compute `h->prev()` and `h->opposite()->prev()`. */ Halfedge_handle join_vertex( Halfedge_handle h); -/*! +/*! barycentric triangulation of `h->face()`. Creates a new vertex, a copy of `h->vertex()`, and connects it to each vertex incident to `h->face()` splitting `h->face()` into triangles. @@ -344,7 +344,7 @@ The time is proportional to the size of the face. */ Halfedge_handle create_center_vertex( Halfedge_handle h); -/*! +/*! reverses `create_center_vertex`. Erases the vertex pointed to by `g` and all incident halfedges thereby merging all incident faces. Only `g->face()` remains. @@ -361,7 +361,7 @@ The time is proportional to the sum of the size of all incident faces. */ Halfedge_handle erase_center_vertex( Halfedge_handle g); -/*! +/*! cuts the halfedge data structure into two parts along the cycle `(h,i,j)`. Three new vertices (one copy for each vertex in the cycle) and three new halfedges (one copy for each halfedge in the cycle), and two new @@ -380,7 +380,7 @@ Halfedge_handle split_loop( Halfedge_handle h, Halfedge_handle i, Halfedge_handle j); -/*! +/*! glues the boundary of the two faces denoted by `h` and `g` together and returns `h`. Both faces and the vertices along the face denoted by `g` gets removed. Both faces may be holes. The invariant @@ -400,12 +400,12 @@ Halfedge_handle join_loop( Halfedge_handle h, Halfedge_handle g); /// These operations are the same as for `CGAL::HalfedgeDS_const_decorator`. /// @{ -/*! +/*! */ bool is_valid( bool verbose = false, int level = 0) const; -/*! +/*! */ bool normalized_border_is_valid( bool verbose = false) const; @@ -415,7 +415,7 @@ bool normalized_border_is_valid( bool verbose = false) const; /// \name Miscellaneous /// @{ -/*! +/*! reverses face orientations. \pre `is_valid()` of level three. */ void inside_out(); diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h index facfc5c279f..bbd41329b33 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_default.h @@ -37,12 +37,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bidirectional_iterator_tag iterator_category; -/*! +/*! */ typedef CGAL::Tag_true Supports_removal; diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h index 04248266fca..4f6e98e924a 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_base.h @@ -53,7 +53,7 @@ public: /// \name Types /// @{ -/*! +/*! plane type for three argument version. */ typedef unspecified_type Plane; @@ -63,12 +63,12 @@ typedef unspecified_type Plane; /// \name Creation /// @{ -/*! +/*! default constructor. */ HalfedgeDS_face_base(); -/*! +/*! initialized with plane `pln`. */ HalfedgeDS_face_base( const Plane& pln); @@ -78,12 +78,12 @@ HalfedgeDS_face_base( const Plane& pln); /// \name Operations /// @{ -/*! +/*! */ Plane& plane(); -/*! +/*! */ const Plane& plane() const; diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h index ca6cb1e34a7..56ced2fd44e 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_face_min_base.h @@ -27,7 +27,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ HalfedgeDS_face_min_base(); diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h index bce82a1da8f..45c9e165444 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_base.h @@ -75,7 +75,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ HalfedgeDS_halfedge_base(); diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h index 30f225fc9ca..661409637db 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_halfedge_min_base.h @@ -28,7 +28,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ HalfedgeDS_halfedge_min_base(); diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h index 36a002a9aa8..7ad28c20c2a 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_items_decorator.h @@ -62,102 +62,102 @@ public: /// available as well. /// @{ -/*! +/*! halfedge data structure. */ typedef unspecified_type HalfedgeDS; -/*! +/*! traits class. */ typedef unspecified_type Traits; -/*! +/*! vertex type of `HalfedgeDS`. */ typedef unspecified_type Vertex; -/*! +/*! halfedge type of `HalfedgeDS`. */ typedef unspecified_type Halfedge; -/*! +/*! face type of `HalfedgeDS`. */ typedef unspecified_type Face; -/*! +/*! */ typedef unspecified_type Vertex_handle; -/*! +/*! */ typedef unspecified_type Halfedge_handle; -/*! +/*! */ typedef unspecified_type Face_handle; -/*! +/*! */ typedef unspecified_type Vertex_iterator; -/*! +/*! */ typedef unspecified_type Halfedge_iterator; -/*! +/*! */ typedef unspecified_type Face_iterator; -/*! +/*! */ typedef unspecified_type size_type; -/*! +/*! */ typedef unspecified_type difference_type; -/*! +/*! */ typedef unspecified_type iterator_category; -/*! +/*! */ typedef unspecified_type Supports_vertex_halfedge; -/*! +/*! */ typedef unspecified_type Supports_halfedge_prev; -/*! +/*! */ typedef unspecified_type Supports_halfedge_vertex; -/*! +/*! */ typedef unspecified_type Supports_halfedge_face; -/*! +/*! */ typedef unspecified_type Supports_face_halfedge; -/*! +/*! */ typedef unspecified_type Supports_removal; @@ -167,7 +167,7 @@ typedef unspecified_type Supports_removal; /// \name Creation /// @{ -/*! +/*! default constructor. */ HalfedgeDS_items_decorator(); @@ -178,43 +178,43 @@ HalfedgeDS_items_decorator(); /// Corresponding member functions for `const_handle`'s are provided as well. /// @{ -/*! +/*! returns the incident halfedge of `v` if supported, `Halfedge_handle()` otherwise. */ Halfedge_handle get_vertex_halfedge( Vertex_handle v); -/*! +/*! returns the incident vertex of `h` if supported, `Vertex_handle()` otherwise. */ Vertex_handle get_vertex(Halfedge_handle h); -/*! +/*! returns the previous halfedge of `h` if supported, `Halfedge_handle()` otherwise. */ Halfedge_handle get_prev(Halfedge_handle h); -/*! +/*! returns the previous halfedge of `h`. Uses the `prev()` method if supported or performs a search around the face using `next()`. */ Halfedge_handle find_prev(Halfedge_handle h); -/*! +/*! returns the previous halfedge of `h`. Uses the `prev()` method if supported or performs a search around the vertex using `next()`. */ Halfedge_handle find_prev_around_vertex(Halfedge_handle h); -/*! +/*! returns the incident face of `h` if supported, `Face_handle()` otherwise. */ Face_handle get_face(Halfedge_handle h); -/*! +/*! returns the incident halfedge of `f` if supported, `Halfedge_handle()` otherwise. */ @@ -225,18 +225,18 @@ Halfedge_handle get_face_halfedge( Face_handle f); /// \name Modifying Functions (Composed) /// @{ -/*! +/*! makes `h->%opposite()` the successor of `h`. */ void close_tip( Halfedge_handle h) const; -/*! +/*! makes `h->%opposite()` the successor of `h` and sets the incident vertex of `h` to `v`. */ void close_tip( Halfedge_handle h, Vertex_handle v) const; -/*! +/*! inserts the tip of the edge `h` into the halfedges around the vertex pointed to by `v`. Halfedge `h->%opposite()` is the new successor of `v` and `h->%next()` will be set to `v->next()`. The vertex of `h` @@ -244,41 +244,41 @@ will be set to the vertex `v` refers to if vertices are supported. */ void insert_tip( Halfedge_handle h, Halfedge_handle v) const; -/*! +/*! removes the edge `h->%next()->%opposite()` from the halfedge circle around the vertex referred to by `h`. The new successor halfedge of `h` will be `h->%next()->%opposite()->%next()`. */ void remove_tip( Halfedge_handle h) const; -/*! +/*! inserts the halfedge `h` between `f` and `f->%next()`. The face of `h` will be the one `f` refers to if faces are supported. */ void insert_halfedge( Halfedge_handle h, Halfedge_handle f) const; -/*! +/*! removes edge `h->%next()` from the halfedge circle around the face referred to by `h`. The new successor of `h` will be `h->%next()->%next()`. */ void remove_halfedge( Halfedge_handle h) const; -/*! +/*! loops around the vertex incident to `h` and sets all vertex pointers to `v`. \pre `h != Halfedge_handle()`. */ void set_vertex_in_vertex_loop( Halfedge_handle h, Vertex_handle v) const; -/*! +/*! loops around the face incident to `h` and sets all face pointers to `f`. \pre `h != Halfedge_handle()`. */ void set_face_in_face_loop( Halfedge_handle h, Face_handle f) const; -/*! +/*! performs an edge flip. It returns `h` after rotating the edge `h` one vertex in the direction of the face orientation. \pre `h != Halfedge_handle()` and both incident faces of `h` are triangles. @@ -290,37 +290,37 @@ Halfedge_handle flip_edge( Halfedge_handle h) const; /// \name Modifying Functions (Primitives) /// @{ -/*! +/*! sets the incident halfedge of `v` to `g`. */ void set_vertex_halfedge( Vertex_handle v, Halfedge_handle g) const; -/*! +/*! sets the incident halfedge of the vertex `v` to `h`. */ void set_vertex_halfedge( Halfedge_handle h) const; -/*! +/*! sets the incident vertex of `h` to `v`. */ void set_vertex( Halfedge_handle h, Vertex_handle v) const; -/*! +/*! sets the previous link of `h` to `g`. */ void set_prev( Halfedge_handle h, Halfedge_handle g) const; -/*! +/*! sets the incident face of `h` to `f`. */ void set_face( Halfedge_handle h, Face_handle f) const; -/*! +/*! sets the incident halfedge of `f` to `g`. */ void set_face_halfedge( Face_handle f, Halfedge_handle g) const; -/*! +/*! sets the incident halfedge of the face `f` to `h`. */ void set_face_halfedge( Halfedge_handle h) const; diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h index ac0b30b6a3b..7199bce9c1a 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_list.h @@ -34,12 +34,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bidirectional_iterator_tag iterator_category; -/*! +/*! */ typedef CGAL::Tag_true Supports_removal; @@ -53,7 +53,7 @@ typedef CGAL::Tag_true Supports_removal; */ /// @{ -/*! +/*! inserts elements in the range [`first, last`) before position `target` and removes the elements from `source`. It takes constant time if `&source == &``hds`; otherwise, it takes linear @@ -62,7 +62,7 @@ time in the size of the range. \pre [`first, last`) is a valid range in `source` void vertices_splice( Vertex_iterator target, Self &source, Vertex_iterator first, Vertex_iterator last); -/*! +/*! inserts elements in the range [`first, last`) before position `target` and removes the elements from `source`. It takes constant time if `&source == &``hds`; otherwise, it takes linear @@ -71,7 +71,7 @@ time in the size of the range. \pre [`first, last`) is a valid range in `source` void halfedges_splice( Halfedge_iterator target, Self &source, Halfedge_iterator first, Halfedge_iterator last); -/*! +/*! inserts elements in the range [`first, last`) before position `target` and removes the elements from `source`. It takes constant time if `&source == &``hds`; otherwise, it takes linear diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h index 437b7e4cd02..4eb89512958 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vector.h @@ -39,12 +39,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef random_access_iterator_tag iterator_category; -/*! +/*! */ typedef CGAL::Tag_false Supports_removal; diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h index 18afb8ea5d3..e76ea3dd61e 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_base.h @@ -51,7 +51,7 @@ public: /// \name Types /// @{ -/*! +/*! point type for three argument version. */ typedef unspecified_type Point; @@ -61,12 +61,12 @@ typedef unspecified_type Point; /// \name Creation /// @{ -/*! +/*! default constructor. */ HalfedgeDS_vertex_base(); -/*! +/*! initialized with point `p`. */ HalfedgeDS_vertex_base( const Point& p); @@ -76,12 +76,12 @@ HalfedgeDS_vertex_base( const Point& p); /// \name Operations /// @{ -/*! +/*! */ Point& point(); -/*! +/*! */ const Point& point() const; diff --git a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h index cf85a36f80d..28756ef9d02 100644 --- a/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h +++ b/HalfedgeDS/doc/HalfedgeDS/CGAL/HalfedgeDS_vertex_min_base.h @@ -27,7 +27,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ HalfedgeDS_vertex_min_base(); diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h index 7eda92a4830..625d3affab2 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSFace.h @@ -37,57 +37,57 @@ public: /// \name Types /// @{ -/*! +/*! instantiated `HalfedgeDS` ( \f$ \equiv\f$ `Refs`). */ typedef unspecified_type HalfedgeDS; -/*! +/*! base class that allows modifications. */ typedef unspecified_type Base; -/*! +/*! model of `HalfedgeDSVertex`. */ typedef unspecified_type Vertex; -/*! +/*! model of `HalfedgeDSHalfedge`. */ typedef unspecified_type Halfedge; -/*! +/*! handle to vertex. */ typedef unspecified_type Vertex_handle; -/*! +/*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; -/*! +/*! handle to face. */ typedef unspecified_type Face_handle; -/*! +/*! */ typedef unspecified_type Vertex_const_handle; -/*! +/*! */ typedef unspecified_type Halfedge_const_handle; -/*! +/*! */ typedef unspecified_type Face_const_handle; -/*! +/*! `CGAL::Tag_true` or `CGAL::Tag_false`. */ @@ -98,7 +98,7 @@ typedef unspecified_type Supports_face_halfedge; /// \name Creation /// @{ -/*! +/*! default constructor. */ Face(); @@ -108,18 +108,18 @@ Face(); /// \name Operations available if Supports_face_halfedge == CGAL::Tag_true /// @{ -/*! +/*! */ Halfedge_handle halfedge(); -/*! +/*! incident halfedge that points to the face. */ Halfedge_const_handle halfedge() const; -/*! +/*! sets incident halfedge to `h`. */ diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h index 1826fa70bdc..a4d2f741595 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSHalfedge.h @@ -48,72 +48,72 @@ public: /// \name Types /// @{ -/*! +/*! instantiated `HalfedgeDS` ( \f$ \equiv\f$ `Refs`). */ typedef unspecified_type HalfedgeDS; -/*! +/*! base class that allows modifications. */ typedef unspecified_type Base; -/*! +/*! base class to access `set_opposite()`. */ typedef unspecified_type Base_base; -/*! +/*! model of `HalfedgeDSVertex`. */ typedef unspecified_type Vertex; -/*! +/*! model of `HalfedgeDSFace`. */ typedef unspecified_type Face; -/*! +/*! handle to vertex. */ typedef unspecified_type Vertex_handle; -/*! +/*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; -/*! +/*! handle to face. */ typedef unspecified_type Face_handle; -/*! +/*! */ typedef unspecified_type Vertex_const_handle; -/*! +/*! */ typedef unspecified_type Halfedge_const_handle; -/*! +/*! */ typedef unspecified_type Face_const_handle; -/*! +/*! \link CGAL::Tag_true `CGAL::Tag_true`\endlink or \link CGAL::Tag_false `CGAL::Tag_false`\endlink. */ typedef unspecified_type Supports_halfedge_prev; -/*! +/*! \link CGAL::Tag_true `CGAL::Tag_true`\endlink or \link CGAL::Tag_false `CGAL::Tag_false`\endlink. */ typedef unspecified_type Supports_halfedge_vertex; -/*! +/*! \link CGAL::Tag_true `CGAL::Tag_true`\endlink or \link CGAL::Tag_false `CGAL::Tag_false`\endlink. */ typedef unspecified_type Supports_halfedge_face; @@ -123,7 +123,7 @@ typedef unspecified_type Supports_halfedge_face; /// \name Creation /// @{ -/*! +/*! default constructor. */ Halfedge(); @@ -133,39 +133,39 @@ Halfedge(); /// \name Operations /// @{ -/*! +/*! */ Halfedge_handle opposite(); -/*! +/*! the opposite halfedge. */ Halfedge_const_handle opposite() const; -/*! +/*! sets opposite halfedge to `h`. */ void set_opposite( Halfedge_handle h); -/*! +/*! */ Halfedge_handle next(); -/*! +/*! the next halfedge around the face. */ Halfedge_const_handle next() const; -/*! +/*! sets next halfedge to `h`. */ void set_next( Halfedge_handle h); -/*! +/*! is true if the halfedge is a border halfedge. */ bool is_border() const; @@ -175,16 +175,16 @@ bool is_border() const; /// \name Operations available if Supports_halfedge_prev == CGAL::Tag_true /// @{ -/*! +/*! */ Halfedge_handle prev(); -/*! +/*! the previous halfedge around the face. */ Halfedge_const_handle prev() const; -/*! +/*! sets prev halfedge to `h`. */ @@ -195,16 +195,16 @@ void set_prev( Halfedge_handle h); /// \name Operations available if Supports_halfedge_vertex == CGAL::Tag_true /// @{ -/*! +/*! */ Vertex_handle vertex(); -/*! +/*! the incident vertex of `h`. */ Vertex_const_handle vertex() const; -/*! +/*! sets incident vertex to `v`. */ @@ -215,18 +215,18 @@ void set_vertex( Vertex_handle v); /// \name Operations available if Supports_halfedge_face == CGAL::Tag_true /// @{ -/*! +/*! */ Face_handle face(); -/*! +/*! the incident face of the halfedge. If the halfedge is a border halfedge the result is default construction of the handle. */ Face_const_handle face() const; -/*! +/*! sets incident face to `f`. */ diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h index 16f5a2e900e..3886723812c 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSItems.h @@ -64,17 +64,17 @@ public: /// \name Types /// @{ -/*! +/*! model of `HalfedgeDSVertex`. */ typedef Vertex_wrapper::Vertex Vertex; -/*! +/*! model of `HalfedgeDSHalfedge`. */ typedef Halfedge_wrapper::Halfedge Halfedge; -/*! +/*! model of `HalfedgeDSFace`. */ typedef Face_wrapper::Face Face; diff --git a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h index 27efdaaf950..17c5ceba094 100644 --- a/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h +++ b/HalfedgeDS/doc/HalfedgeDS/Concepts/HalfedgeDSVertex.h @@ -37,57 +37,57 @@ public: /// \name Types /// @{ -/*! +/*! instantiated `HalfedgeDS` ( \f$ \equiv\f$ `Refs`). */ typedef unspecified_type HalfedgeDS; -/*! +/*! base class that allows modifications. */ typedef unspecified_type Base; -/*! +/*! model of `HalfedgeDSHalfedge`. */ typedef unspecified_type Halfedge; -/*! +/*! model of `HalfedgeDSFace`. */ typedef unspecified_type Face; -/*! +/*! handle to vertex. */ typedef unspecified_type Vertex_handle; -/*! +/*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; -/*! +/*! handle to face. */ typedef unspecified_type Face_handle; -/*! +/*! */ typedef unspecified_type Vertex_const_handle; -/*! +/*! */ typedef unspecified_type Halfedge_const_handle; -/*! +/*! */ typedef unspecified_type Face_const_handle; -/*! +/*! `CGAL::Tag_true` or `CGAL::Tag_false`. */ @@ -98,7 +98,7 @@ typedef unspecified_type Supports_vertex_halfedge; /// \name Creation /// @{ -/*! +/*! default constructor. */ Vertex(); @@ -108,16 +108,16 @@ Vertex(); /// \name Operations available if Supports_vertex_halfedge == CGAL::Tag_true /// @{ -/*! +/*! */ Halfedge_handle halfedge(); -/*! +/*! incident halfedge that points to the vertex. */ Halfedge_const_handle halfedge() const; -/*! +/*! sets incident halfedge to `h`. */ diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h index 66e45221e37..66a85dd1dae 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Extremal_polygon_traits_2.h @@ -29,27 +29,27 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! typedef to `K::Less_xy_2`. */ typedef unspecified_type Less_xy_2; -/*! +/*! typedef to `K::Orientation_2`. */ typedef unspecified_type Orientation_2; -/*! +/*! AdaptableBinaryFunction class `op`: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT`. For a fixed `Point_2` \f$ root\f$, `op`\f$ (p,\,q)\f$ returns @@ -62,25 +62,25 @@ typedef unspecified_type Operation; /// \name Operations /// @{ -/*! +/*! returns 3. */ int min_k() const; -/*! +/*! returns `FT(0)`. */ FT init(const Point_2& p, const Point_2& q) const; -/*! +/*! returns `Operation` where `p` is the fixed \f$ root\f$ point. */ Operation operation( const Point_2& p) const; -/*! +/*! writes the vertices of [`points_begin`, `points_end`) forming a maximum area triangle rooted at `points_begin[0]` to o and returns the @@ -91,12 +91,12 @@ OutputIterator > OutputIterator compute_min_k_gon( RandomAccessIterator points_begin, RandomAccessIterator points_end, FT& max_area, OutputIterator o) const; -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); @@ -134,27 +134,27 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! typedef to `K::Less_xy_2`. */ typedef unspecified_type Less_xy_2; -/*! +/*! typedef to `K::Orientation_2`. */ typedef unspecified_type Orientation_2; -/*! +/*! AdaptableBinaryFunction class `op`: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT`. For a fixed `Point_2` \f$ root\f$, `op`\f$ (p,\,q)\f$ returns @@ -168,26 +168,26 @@ typedef unspecified_type Operation; /// \name Operations /// @{ -/*! +/*! returns 2. */ int min_k() const; -/*! +/*! returns twice the Euclidean distance between `p` and `q`. */ FT init(const Point_2& p, const Point_2& q) const; -/*! +/*! returns `Operation` where `p` is the fixed \f$ root\f$ point. */ Operation operation( const Point_2& p) const; -/*! +/*! writes the pair (`points_begin[0]`, `p`) where `p` is drawn from [`points_begin`, `points_end`) such that the Euclidean @@ -200,12 +200,12 @@ OutputIterator > OutputIterator compute_min_k_gon( RandomAccessIterator points_begin, RandomAccessIterator points_end, FT& max_area, OutputIterator o) const; -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); diff --git a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h index 6269c8d3d15..5f15072ce24 100644 --- a/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/CGAL/Largest_empty_iso_rectangle_2.h @@ -26,22 +26,22 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef T Traits; -/*! +/*! */ typedef Traits::Point_2 Point_2; -/*! +/*! */ typedef Traits::Iso_rectangle_2 Iso_rectangle_2; -/*! +/*! Iterator over the points. This iterator allows to enumerate the points. It is non mutable, @@ -55,27 +55,27 @@ typedef unspecified_type const_iterator; /// \name Creation /// @{ -/*! +/*! Constructor. The iso-rectangle `b` is the bounding rectangle. */ Largest_empty_iso_rectangle_2 (const Iso_rectangle_2 &b); -/*! +/*! Constructor. The iso-rectangle whose lower left and upper right points are `p` and `q` respectively is the bounding rectangle. */ Largest_empty_iso_rectangle_2 (const Point_2 p,const Point_2 q); -/*! +/*! Constructor. The iso-rectangle whose lower left point and upper right points are (0,0) and (1,1) respectively is the bounding rectangle. */ Largest_empty_iso_rectangle_2 (); -/*! +/*! Copy constructor. */ Largest_empty_iso_rectangle_2 @@ -86,7 +86,7 @@ Largest_empty_iso_rectangle_2 /// \name Assignment /// @{ -/*! +/*! */ Largest_empty_iso_rectangle_2 @@ -97,17 +97,17 @@ operator=(const Largest_empty_iso_rectangle_2 & tr); /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the traits object. */ const Traits & traits() const; -/*! +/*! Returns an iterator to the beginning of the point set. */ const_iterator begin() const; -/*! +/*! Returns a past-the-end iterator for the point set. */ const_iterator end() const; @@ -117,21 +117,21 @@ const_iterator end() const; /// \name Queries /// @{ -/*! +/*! Returns the four points that define the largest empty iso-rectangle. (Note that these points are not necessarily on a corner of an iso-rectangle.) */ Quadruple get_left_bottom_right_top(); -/*! +/*! Returns the largest empty iso-rectangle. (Note that the two points defining the iso-rectangle are not necessarily part of the point set.) */ Iso_rectangle_2 get_largest_empty_iso_rectangle(); -/*! +/*! Returns the iso-rectangle passed in the constructor. */ Iso_rectangle_2 get_bounding_box(); @@ -141,19 +141,19 @@ Iso_rectangle_2 get_bounding_box(); /// \name Insertion /// @{ -/*! +/*! Inserts point `p` in the point set, if it is not already in the set. */ void insert(const Point_2& p); -/*! +/*! Inserts point `p` in the point set, if it is not already in the set. */ void push_back(const Point_2& p); -/*! +/*! Inserts the points in the range `[first, last)`, and returns the number of inserted points. \tparam InputIterator must be an iterator with value type `Point_2`. @@ -167,13 +167,13 @@ insert(InputIterator first, InputIterator last); /// \name Removal /// @{ -/*! +/*! Removes point `p`. Returns false iff `p` is not in the point set. */ bool remove(const Point_2& p); -/*! +/*! Removes all points. */ void clear(); diff --git a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h index 2436623cb41..1b00927f86c 100644 --- a/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/Concepts/ExtremalPolygonTraits_2.h @@ -29,30 +29,30 @@ public: /// \name Types /// @{ -/*! +/*! model for `FieldNumberType`. */ typedef unspecified_type FT; -/*! +/*! model for `Kernel::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! model for `Kernel::Less_xy_2`. */ typedef unspecified_type Less_xy_2; -/*! +/*! model for `Kernel::Orientation_2`. */ typedef unspecified_type Orientation_2; -/*! +/*! AdaptableBinaryFunction class `op`: `Point_2` \f$ \times\f$ `Point_2` \f$ \rightarrow\f$ `FT`. Together with `init` this operation recursively defines the @@ -71,14 +71,14 @@ typedef unspecified_type Operation; /// \name Operations /// @{ -/*! +/*! returns the minimal \f$ k\f$ for which a maximal \f$ k\f$-gon can be computed. (e.g. in the maximum area case this is three.) */ int min_k() const; -/*! +/*! returns the value of the objective function for a polygon consisting of the two points `p` and `q`. (e.g. in the maximum area case this is `FT( 0)`.) @@ -86,14 +86,14 @@ in the maximum area case this is `FT( 0)`.) FT init( const Point_2& p, const Point_2& q) const; -/*! +/*! return `Operation` where `p` is the fixed \f$ root\f$ point. */ Operation operation( const Point_2& p) const; -/*! +/*! writes the points of [`points_begin`, `points_end`) forming a `min_k()`-gon rooted at `points_begin[0]` of maximal @@ -105,12 +105,12 @@ OutputIterator > OutputIterator compute_min_k_gon( RandomAccessIterator points_begin, RandomAccessIterator points_end, FT& max_area, OutputIterator o) const; -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); diff --git a/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h b/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h index 40edbf5fa78..82b57b053b8 100644 --- a/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h +++ b/Inscribed_areas/doc/Inscribed_areas/Concepts/LargestEmptyIsoRectangleTraits_2.h @@ -23,17 +23,17 @@ public: /// \name Types /// @{ -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The iso rectangle type. */ typedef unspecified_type Iso_rectangle_2; -/*! +/*! Predicate object. Must provide the operator `Comparison_result operator()(Point_2 p, Point_2 q)` @@ -44,7 +44,7 @@ according ding to the */ typedef unspecified_type Compare_x_2; -/*! +/*! Predicate object. Must provide the operator `Comparison_result operator()(Point_2 p, Point_2 q)` @@ -55,7 +55,7 @@ according to the */ typedef unspecified_type Compare_y_2; -/*! +/*! Predicate object. Must provide the operator `bool operator()(Point_2 p, Point_2 q)` @@ -64,7 +64,7 @@ whether `p` is less than `q` according to their \f$ x\f$-ordering. */ typedef unspecified_type Less_x_2; -/*! +/*! Predicate object. Must provide the operator `bool operator()(Point_2 p, Point_2 q)` @@ -81,17 +81,17 @@ typedef unspecified_type Less_y_2; /// provided. /// @{ -/*! +/*! Default constructor. */ LargestEmptyIsoRectangleTraits_2(); -/*! +/*! Copy constructor */ LargestEmptyIsoRectangleTraits_2(LargestEmptyIsoRectangleTraits_2); -/*! +/*! Assignment operator. */ LargestEmptyIsoRectangleTraits_2 operator=(LargestEmptyIsoRectangleTraits_2 gtr); @@ -102,22 +102,22 @@ LargestEmptyIsoRectangleTraits_2 operator=(LargestEmptyIsoRectangleTraits_2 gtr) /// The following functions give access to the predicate and constructor objects. /// @{ -/*! +/*! */ Compare_x_2 compare_x_2_object(); -/*! +/*! */ Compare_y_2 compare_y_2_object(); -/*! +/*! */ Less_x_2 less_x_2_object(); -/*! +/*! */ Less_y_2 less_y_2_object(); diff --git a/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h b/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h index ad4c232607e..6fb18c1e68e 100644 --- a/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h +++ b/Interpolation/doc/Interpolation/CGAL/Interpolation_gradient_fitting_traits_2.h @@ -26,61 +26,61 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef K::FT FT; -/*! +/*! */ typedef K::Point_2 Point_d; -/*! +/*! */ typedef K::Vector_2 Vector_d; -/*! +/*! */ typedef K::Aff_transformation_2 Aff_transformation_d; -/*! +/*! */ typedef K::Construct_vector_2 Construct_vector_d; -/*! +/*! */ typedef K::Construct_scaled_vector_2 Construct_scaled_vector_d; -/*! +/*! */ typedef K::Compute_squared_distance_2 Compute_squared_distance_d; -/*! +/*! */ typedef Construct_null_matrix_2 Construct_null_matrix_d; -/*! +/*! */ typedef Construct_scaling_matrix_2 Construct_scaling_matrix_d; -/*! +/*! */ typedef Construct_sum_matrix_2 Construct_sum_matrix_d; -/*! +/*! */ typedef Construct_outer_product_2 Construct_outer_product_d; @@ -90,43 +90,43 @@ typedef Construct_outer_product_2 Construct_outer_product_d; /// \name Operations /// @{ -/*! +/*! */ Construct_scaled_vector_d construct_scaled_vector_d_object() const; -/*! +/*! */ Construct_vector_d construct_vector_d_object()const; -/*! +/*! */ Compute_squared_distance_d compute_squared_distance_d_object() const; -/*! +/*! */ Construct_null_matrix_d construct_null_matrix_d_object() const; -/*! +/*! */ Construct_scaling_matrix_d construct_scaling_matrix_d_object() const; -/*! +/*! */ Construct_sum_matrix_d construct_sum_matrix_d_object() const; -/*! +/*! */ Construct_outer_product_d diff --git a/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h b/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h index 7ff785db254..cbf1bd57e8b 100644 --- a/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h +++ b/Interpolation/doc/Interpolation/CGAL/Interpolation_traits_2.h @@ -24,33 +24,33 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef K::FT FT; -/*! +/*! */ typedef K::Point_2 Point_d; -/*! +/*! */ typedef K::Vector_2 Vector_d; -/*! +/*! */ typedef K::Construct_vector_2 Construct_vector_d; -/*! +/*! */ typedef K::Construct_scaled_vector_2 Construct_scaled_vector_d; -/*! +/*! */ typedef K::Compute_squared_distance_2 @@ -61,19 +61,19 @@ Compute_squared_distance_d; /// \name Operations /// @{ -/*! +/*! */ Construct_scaled_vector_d construct_scaled_vector_d_object() const; -/*! +/*! */ Construct_vector_d construct_vector_d_object()const; -/*! +/*! */ Compute_squared_distance_d diff --git a/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h b/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h index 3ee5033edde..b09a3ef7dc2 100644 --- a/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h +++ b/Interpolation/doc/Interpolation/CGAL/Voronoi_intersection_2_traits_3.h @@ -36,62 +36,62 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef K::RT Weight; -/*! +/*! */ typedef K::FT FT; -/*! +/*! */ typedef K::Point_3 Point_2; -/*! +/*! */ typedef K::Segment_3 Segment_2; -/*! +/*! */ typedef K::Triangle_3 Triangle_2; -/*! +/*! */ typedef K::Line_3 Line_2; -/*! +/*! */ typedef K::Ray_3 Ray_2; -/*! +/*! */ typedef K::Vector_3 Vector_2; -/*! +/*! */ typedef K::Construct_triangle_3 Construct_triangle_2; -/*! +/*! */ typedef K::Construct_ray_3 Construct_ray_2; -/*! +/*! */ typedef K::Compare_distance_3 Compare_distance_2; -/*! +/*! An instance of this function object class computes the square root of the result of `K::Compute_squared_area_3`. If the number type `FT` does not support the square root @@ -100,28 +100,28 @@ before computing the square root. */ Compute_area_3 Compute_area_2; -/*! +/*! */ typedef Orientation_with_normal_plane_2_3 Orientation_2; -/*! +/*! */ typedef Side_of_plane_centered_sphere_2_3 Power_test_2; -/*! +/*! */ typedef Construct_plane_centered_circumcenter_3 Construct_weighted_circumcenter_2; -/*! +/*! */ typedef Compare_first_projection_3 Compare_x_2; -/*! +/*! */ typedef Compare_second_projection_3 Compare_y_2; @@ -131,7 +131,7 @@ typedef Compare_second_projection_3 Compare_y_2; /// \name Creation /// @{ -/*! +/*! The plane associated to the traits class contains `point` and has as normal vector `normal`. */ Voronoi_intersection_2_traits_3(const typename K::Point_3& point=typename K::Point_3(), const typename K::Vector_3& normal=NULL_VECTOR); diff --git a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h index d9b6306d2f4..73aad73f06c 100644 --- a/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h +++ b/Interpolation/doc/Interpolation/CGAL/interpolation_functions.h @@ -27,12 +27,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Map::mapped_type Data_type; -/*! +/*! */ typedef Map::key_type Key_type; @@ -42,12 +42,12 @@ typedef Map::key_type Key_type; /// \name Creation /// @{ -/*! +/*! Introduces a `Data_access` to the container `map`. */ Data_access(const Map& map); -/*! +/*! If there is an entry for `p` in the container `map`, then the pair of `map.find(p)` and `true` is returned. Otherwise, the diff --git a/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h b/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h index df5d940295a..e6d6d48f2d4 100644 --- a/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h +++ b/Interpolation/doc/Interpolation/Concepts/GradientFittingTraits.h @@ -24,24 +24,24 @@ public: /// \name Types /// @{ -/*! +/*! The number type must follow the model `FieldNumberType`. */ typedef unspecified_type FT; -/*! +/*! The point type on which the function is defined and interpolated. */ typedef unspecified_type Point_d; -/*! +/*! The corresponding vector type. */ typedef unspecified_type Vector_d; -/*! +/*! defines a matrix type. Must provide the following member functions : @@ -55,7 +55,7 @@ multiplication of `tr` with `v`. */ typedef unspecified_type Aff_transformation_d; -/*! +/*! A constructor object for `Vector_d`. Provides : @@ -68,7 +68,7 @@ the null vector. */ typedef unspecified_type Construct_vector_d; -/*! +/*! Constructor object for `Vector_d`. Provides : @@ -78,7 +78,7 @@ vector `v` scaled by a factor `scale`. */ typedef unspecified_type Construct_scaled_vector_d; -/*! +/*! Constructor object for `Aff_transformation_d`. Provides : @@ -87,7 +87,7 @@ transformation whose matrix has only zero entries. */ typedef unspecified_type Construct_null_matrix_d; -/*! +/*! Constructor object for `Aff_transformation_d`. Provides : @@ -96,7 +96,7 @@ scaling by a scale factor `scale`. */ typedef unspecified_type Construct_scaling_matrix_d; -/*! +/*! Constructor object for `Aff_transformation_d`. Provides : @@ -105,7 +105,7 @@ representing `tr1` and `tr2`. */ typedef unspecified_type Construct_sum_matrix_d; -/*! +/*! Constructor object for `Aff_transformation_d`. Provides : @@ -119,7 +119,7 @@ typedef unspecified_type Construct_outer_product_d; /// \name Creation /// @{ -/*! +/*! default constructor. */ GradientFittingTraits(); @@ -131,29 +131,29 @@ GradientFittingTraits(); /// constructor object types must exist. /// @{ -/*! +/*! */ Construct_vector_d construct_vector_d_object(); -/*! +/*! */ Construct_scaled_vector_d construct_scaled_vector_d_object(); -/*! +/*! */ Construct_null_matrix_d construct_null_matrix_d_object(); -/*! +/*! */ Construct_sum_matrix_d construct_sum_matrix_d_object(); -/*! +/*! */ Construct_outer_product_d diff --git a/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h b/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h index d7bf55e9344..299a3680da3 100644 --- a/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h +++ b/Interpolation/doc/Interpolation/Concepts/InterpolationTraits.h @@ -23,24 +23,24 @@ public: /// \name Types /// @{ -/*! +/*! The number type must follow the model `FieldNumberType`. */ typedef unspecified_type FT; -/*! +/*! The point type on which the function is defined and interpolated. */ typedef unspecified_type Point_d; -/*! +/*! The corresponding vector type. */ typedef unspecified_type Vector_d; -/*! +/*! A constructor object for `Vector_d`. Provides : @@ -53,7 +53,7 @@ the null vector. */ typedef unspecified_type Construct_vector_d; -/*! +/*! Constructor object for `Vector_d`. Provides : @@ -63,7 +63,7 @@ vector `v` scaled by a factor `scale`. */ typedef unspecified_type Construct_scaled_vector_d; -/*! +/*! Constructor object for `FT`. Provides the operator: @@ -72,7 +72,7 @@ distance between `a` and `b`. */ typedef unspecified_type Compute_squared_distance_d; -/*! +/*! default constructor. */ InterpolationTraits(); @@ -84,17 +84,17 @@ InterpolationTraits(); /// constructor object types must exist. /// @{ -/*! +/*! */ Construct_vector_d construct_vector_d_object(); -/*! +/*! */ Construct_scaled_vector_d construct_scaled_vector_d_object(); -/*! +/*! */ Compute_squared_distance_d compute_squared_distance_d_object(); 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 92e2636b527..0aa28b3c0d4 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 @@ -25,12 +25,12 @@ public: /// \name Types /// @{ -/*! +/*! the type of inf and sup of the interval. */ typedef Interval::Value Value; -/*! +/*! An iterator over all intervals. */ typedef unspecified_type const_iterator; @@ -40,12 +40,12 @@ typedef unspecified_type const_iterator; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Interval_skip_list(); -/*! +/*! Constructor that inserts the iterator range `[first, last)` in the interval skip list. \tparam InputIterator must be an input iterator with value type `Interval`. */ @@ -59,7 +59,7 @@ InputIterator last); /// \name Operations /// @{ -/*! +/*! Inserts the iterator range `[first, last)` in the interval skip list, and returns the number of inserted intervals. \tparam InputIterator must be an input iterator with value type `Interval`. @@ -69,22 +69,22 @@ int insert( InputIterator first, InputIterator last); -/*! +/*! Inserts interval `i` in the interval skip list. */ void insert(const Interval& i); -/*! +/*! Removes interval `i` from the interval skip list. Returns `true` iff removal was successful. */ bool remove(const Interval& i); -/*! +/*! Returns `true` iff there is an interval that contains `v`. */ bool is_contained(const Value& v); -/*! +/*! Writes the intervals `i` with `i.inf()` \f$ \leq\f$ `v` \f$ \leq\f$ `i.sup` to the output iterator `out`. \tparam OutputIterator must be an output iterator with value type `Interval`. @@ -94,18 +94,18 @@ OutputIterator find_intervals( const Value& v, OutputIterator out); -/*! +/*! Removes all intervals from the interval skip list. */ void clear(); -/*! +/*! Returns an iterator over all intervals. */ const_iterator begin() const; -/*! +/*! Returns the past the end iterator. */ const_iterator end() const; @@ -114,7 +114,7 @@ const_iterator end() const; }; /* end Interval_skip_list */ -/*! +/*! Inserts the interval skip list `isl` into the stream `os`. \pre The output operator must be defined for `Interval`. \relates Interval_skip_list 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 1f131a48e1e..6db50ce910f 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 @@ -21,12 +21,12 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Interval_skip_list_interval(); -/*! +/*! Constructs the interval with infimum `i` and supremum `s`. The arguments `ic` and `uc` have value `true`, iff the interval is closed at the lower and upper bound, respectively. @@ -41,12 +41,12 @@ bool uc = true); /// \name Operations /// @{ -/*! +/*! Returns `true`, iff the interval is closed at the lower bound. */ bool inf_closed() const; -/*! +/*! Returns `true`, iff the interval is closed at the upper bound. */ bool sup_closed() const; @@ -55,7 +55,7 @@ bool sup_closed() const; }; /* end Interval_skip_list_interval */ -/*! +/*! Inserts the interval `i` into the stream `os`. \pre The output operator for `Value` is defined. 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 cf576d510ed..0175c59494e 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 @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! The type of the \f$ z\f$-coordinate of points stored in vertices of faces. */ typedef FT Value; @@ -33,12 +33,12 @@ typedef FT Value; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Level_interval(); -/*! +/*! Constructs the interval with smallest and largest `z` coordinate of the points stored in the vertices of the face `fh` points to. */ @@ -49,7 +49,7 @@ Level_interval(FaceHandle fh); /// \name Operations /// @{ -/*! +/*! Returns the face handle. */ FaceHandle face_handle(); @@ -58,7 +58,7 @@ FaceHandle face_handle(); }; /* end Level_interval */ -/*! +/*! Inserts the interval `i` into the stream `os`. \pre The output operator for `*Face_handle` is defined. \relates Level_interval diff --git a/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h b/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h index 3c166039aac..920d294919f 100644 --- a/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h +++ b/Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h @@ -22,7 +22,7 @@ public: /// \name Creation /// @{ -/*! +/*! Default constructor. */ Interval(); @@ -32,7 +32,7 @@ Interval(); /// \name Types /// @{ -/*! +/*! The type of the lower and upper bound of the interval. */ typedef unspecified_type Value; @@ -42,32 +42,32 @@ typedef unspecified_type Value; /// \name Access Functions /// @{ -/*! +/*! Returns the lower bound. */ Value inf() const; -/*! +/*! Returns the upper bound. */ Value sup() const; -/*! +/*! Returns `true`, iff the interval contains `v`. */ bool contains(const Value& v) const; -/*! +/*! Returns `true`, iff the interval contains `(i,s)`. */ bool contains_interval(const Value& i, const Value& s) const; -/*! +/*! Equality test. */ bool operator==(const Interval& I) const; -/*! +/*! Unequality test. */ bool operator!=(const Interval& I) const; 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 b0d3858c0d1..6512717f475 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 @@ -59,17 +59,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef typename DataKernel::FT FT; -/*! +/*! */ typedef typename DataKernel::Point_3 Point_3; -/*! +/*! */ typedef typename DataKernel::Vector_3 Vector_3; @@ -79,7 +79,7 @@ typedef typename DataKernel::Vector_3 Vector_3; /// \name Creation /// @{ -/*! +/*! default constructor. */ Monge_form(); @@ -89,7 +89,7 @@ Monge_form(); /// \name Access Functions /// @{ -/*! +/*! Point on the fitted surface where differential quantities are computed. */ @@ -100,17 +100,17 @@ Point_3 origin() const; /// \name Monge Basis /// @{ -/*! +/*! */ Vector_3 maximal_principal_direction() const; -/*! +/*! */ Vector_3 minimal_principal_direction() const; -/*! +/*! */ Vector_3 normal_direction() const; @@ -120,17 +120,17 @@ Vector_3 normal_direction() const; /// \name Monge Coefficients /// @{ -/*! +/*! \f$ i=0\f$ for the maximum and \f$ i=1\f$ for the minimum. */ FT principal_curvatures(size_t i)const; -/*! +/*! \f$ 0 \leq i \leq3\f$ */ FT third_order_coefficients(size_t i) const; -/*! +/*! \f$ 0 \leq i \leq4\f$ */ FT fourth_order_coefficients(size_t i) const; @@ -140,7 +140,7 @@ FT fourth_order_coefficients(size_t i) const; /// \name Operations /// @{ -/*! +/*! change principal basis and Monge coefficients so that the given_normal and the Monge normal make an acute angle. If @@ -154,27 +154,27 @@ void comply_wrt_given_normal(const Vector_3& given_normal); }; /* end Monge_form */ -/*! +/*! */ typedef DataKernel Data_kernel; -/*! +/*! */ typedef LocalKernel Local_kernel; -/*! +/*! */ typedef typename Local_kernel::FT FT; -/*! +/*! */ typedef typename Local_kernel::Vector_3 Vector_3; -/*! +/*! see the page `Monge_via_jet_fitting::Monge_form`. */ typedef unspecified_type Monge_form; @@ -184,7 +184,7 @@ typedef unspecified_type Monge_form; /// \name Creation /// @{ -/*! +/*! default constructor */ Monge_via_jet_fitting(); @@ -194,7 +194,7 @@ Monge_via_jet_fitting(); /// \name Operations /// @{ -/*! +/*! This operator performs all the computations. The \f$ N\f$ input points are given by the `InputIterator` parameters which value-type are `Data_kernel::Point_3`, `d` is the degree of the fitted @@ -205,12 +205,12 @@ template Monge_form operator()(InputIterator begin, InputIterator end, size_t d, size_t d'); -/*! +/*! condition number of the linear fitting system. */ FT condition_number(); -/*! +/*! pca eigenvalues and eigenvectors, the pca_basis has always 3 such pairs. \pre \f$ i\f$ ranges from 0 to 2. */ 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 3ae8a7b99b9..ec4037e685e 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/DataKernel.h @@ -26,17 +26,17 @@ public: /// \name Types /// @{ -/*! +/*! The scalar type. */ typedef unspecified_type FT; -/*! +/*! The point type. */ typedef unspecified_type Point_3; -/*! +/*! The vector type. */ typedef unspecified_type Vector_3; 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 8b85a04d20d..4520de652f8 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/LocalKernel.h @@ -43,17 +43,17 @@ public: /// \name Types /// @{ -/*! +/*! The scalar type. */ typedef unspecified_type FT; -/*! +/*! The point type. */ typedef unspecified_type Point_3; -/*! +/*! The vector type. */ typedef unspecified_type Vector_3; diff --git a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h index c0eba9d8ccd..862110dccd3 100644 --- a/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h +++ b/Jet_fitting_3/doc/Jet_fitting_3/Concepts/SvdTraits.h @@ -26,17 +26,17 @@ public: /// \name Types /// @{ - /*! + /*! The scalar type. */ typedef unspecified_type FT; - /*! + /*! The vector type, model of the concept `SvdTraits::Vector`. */ typedef unspecified_type Vector; - /*! + /*! The matrix type, model of the concept `SvdTraits::Matrix`. */ typedef unspecified_type matrix; @@ -48,7 +48,7 @@ public: /// singular value decomposition algorithm. /// @{ - /*! + /*! Solves the system \f$ MX=B\f$ (in the least square sense if \f$ M\f$ is not square) using a singular value decomposition and returns the condition number of \f$ M\f$. The solution is stored in \f$ B\f$. @@ -66,11 +66,11 @@ Concept of vector type used by the concept SvdTraits. */ class SvdTraits::Vector { public: - /*! + /*! initialize all the elements of the vector to zero. */ Vector(size_t n); - /*! + /*! */ size_t size(); @@ -80,12 +80,12 @@ public: */ FT operator()(size_t i); - /*! + /*! set the \f$ i^{th}\f$ entry to `value`. */ void set(size_t i, const FT value); - /*! + /*! return the vector as an array. */ FT* vector(); @@ -99,28 +99,28 @@ Concept of matrix type used by the concept SvdTraits. */ class SvdTraits::Matrix { public: - /*! + /*! initialize all the entries of the matrix to zero. */ Matrix(size_t n1, size_t n2); - /*! + /*! */ size_t number_of_rows(); - /*! + /*! */ size_t number_of_columns(); - /*! + /*! return the entry at row \f$ i\f$ and column \f$ j\f$, \f$ i\f$ from \f$ 0\f$ to `number_of_rows - 1`, \f$ j\f$ from \f$ 0\f$ to `number_of_columns - 1`. */ FT operator()(size_t i, size_t j); - /*! + /*! set the entry at row \f$ i\f$ and column \f$ j\f$ to \f$ value\f$. */ void set(size_t i, size_t j, const FT value); 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 e4a13a7a295..7e888aa8b1a 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_2.h @@ -88,18 +88,18 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an identity transformation. */ Aff_transformation_2(const Identity_transformation& ); -/*! +/*! introduces a translation by a vector `v`. */ Aff_transformation_2(const Translation, const Vector_2 &v); -/*! +/*! approximates the rotation over the angle indicated by direction `d`, such that the differences between the sines and cosines of the rotation given by d and the approximating rotation @@ -111,7 +111,7 @@ const Direction_2 &d, const Kernel::RT &num, const Kernel::RT &den = RT(1)); -/*! +/*! introduces a rotation by the angle `rho`. \pre \f$ sine\_rho^2 + cosine\_rho^2 == hw^2\f$. */ @@ -120,14 +120,14 @@ const Kernel::RT &sine_rho, const Kernel::RT &cosine_rho, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a scaling by a scale factor \f$ s/hw\f$. */ Aff_transformation_2(const Scaling, const Kernel::RT &s, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a general affine transformation in the \f$3 \times 3\f$ matrix form \f$ @@ -160,7 +160,7 @@ const Kernel::RT &m00, const Kernel::RT &m01, const Kernel::RT &m02, const Kernel::RT &m10, const Kernel::RT &m11, const Kernel::RT &m12, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a general linear transformation \f$\small \mbox{\(\left(\begin{array}{ccc} m_{00} & m_{01} & 0\\ @@ -176,7 +176,7 @@ const Kernel::RT &hw = RT(1)); /// @} -/*! +/*! \name Operations The main thing to do with transformations is to apply them on @@ -192,42 +192,42 @@ available through `operator()` overloads. */ /// @{ -/*! +/*! */ Point_2 transform(const Point_2 &p) const; -/*! +/*! */ Vector_2 transform(const Vector_2 &p) const; -/*! +/*! */ Direction_2 transform(const Direction_2 &p) const; -/*! +/*! */ Line_2 transform(const Line_2 &p) const; -/*! +/*! */ Point_2 operator()(const Point_2 &p) const; -/*! +/*! */ Vector_2 operator()(const Vector_2 &p) const; -/*! +/*! */ Direction_2 operator()(const Direction_2 &p) const; -/*! +/*! */ Line_2 operator()(const Line_2 &p) const; @@ -237,24 +237,24 @@ Line_2 operator()(const Line_2 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! composes two affine transformations. */ Aff_transformation_2 operator*(const Aff_transformation_2 &s) const; -/*! +/*! gives the inverse transformation. */ Aff_transformation_2 inverse() const; -/*! +/*! returns `true`, if the transformation is not reflecting, i.e.\ the determinant of the involved linear transformation is non-negative. */ bool is_even() const; -/*! +/*! returns `true`, if the transformation is reflecting. */ bool is_odd() const; @@ -264,22 +264,22 @@ bool is_odd() const; /// \name Matrix Entry Access /// @{ -/*! +/*! */ Kernel::FT cartesian(int i, int j) const; -/*! +/*! returns entry \f$ m_{ij}\f$ in a matrix representation in which \f$ m_{22}\f$ is 1. */ Kernel::FT m(int i, int j) const; -/*! +/*! */ Kernel::RT homogeneous(int i, int j) const; -/*! +/*! returns entry \f$ m_{ij}\f$ in some fixed matrix representation. */ Kernel::RT hm(int i, int j) const; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_3.h b/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_3.h index 27a3b88965d..10199d96314 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Aff_transformation_3.h @@ -44,25 +44,25 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an identity transformation. */ Aff_transformation_3(const Identity_transformation& ); -/*! +/*! introduces a translation by a vector `v`. */ Aff_transformation_3(const Translation, const Vector_3 &v); -/*! +/*! introduces a scaling by a scale factor \f$ s/hw\f$. */ Aff_transformation_3(const Scaling, const Kernel::RT &s, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a general affine transformation of the matrix form \f$ @@ -92,7 +92,7 @@ const Kernel::RT &m10, const Kernel::RT &m11, const Kernel::RT &m12, const Kerne const Kernel::RT &m20, const Kernel::RT &m21, const Kernel::RT &m22, const Kernel::RT &m23, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a general linear transformation of the matrix form \f$ \small \mbox{\(\left(\begin{array}{cccc} @@ -128,65 +128,65 @@ available through `operator()` overloads. */ /// @{ -/*! +/*! */ Point_3 transform(const Point_3 &p) const; -/*! +/*! */ Vector_3 transform(const Vector_3 &p) const; -/*! +/*! */ Direction_3 transform(const Direction_3 &p) const; -/*! +/*! */ Plane_3 transform(const Plane_3 &p) const; -/*! +/*! */ Point_3 operator()(const Point_3 &p) const; -/*! +/*! */ Vector_3 operator()(const Vector_3 &p) const; -/*! +/*! */ Direction_3 operator()(const Direction_3 &p) const; -/*! +/*! */ Plane_3 operator()(const Plane_3 &p) const; -/*! +/*! composes two affine transformations. */ Aff_transformation_3 operator*(const Aff_transformation_3 &s) const; -/*! +/*! gives the inverse transformation. */ Aff_transformation_3 inverse() const; -/*! +/*! returns `true`, if the transformation is not reflecting, i.e.\ the determinant of the involved linear transformation is non-negative. */ bool is_even() const; -/*! +/*! returns `true`, if the transformation is reflecting. */ bool is_odd() const; @@ -197,22 +197,22 @@ bool is_odd() const; /// @{ -/*! +/*! */ Kernel::FT cartesian(int i, int j) const; -/*! +/*! returns entry \f$ m_{ij}\f$ in a matrix representation in which \f$ m_{33}\f$ is 1. */ Kernel::FT m(int i, int j) const; -/*! +/*! */ Kernel::RT homogeneous(int i, int j) const; -/*! +/*! returns entry \f$ m_{ij}\f$ in some fixed matrix representation. */ Kernel::RT hm(int i, int j) const; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Bbox_2.h b/Kernel_23/doc/Kernel_23/CGAL/Bbox_2.h index e5768e1ea7f..6a279a51361 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Bbox_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Bbox_2.h @@ -17,7 +17,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a bounding box `b` with lower left corner at `(xmin, ymin)` and with upper right corner at `(xmax, ymax)`. @@ -30,54 +30,54 @@ double x_max, double y_max); /// \name Operations /// @{ -/*! +/*! Test for equality. */ bool operator==(const Bbox_2 &c) const; -/*! +/*! Test for inequality. */ bool operator!=(const Bbox_2 &q) const; -/*! +/*! Returns 2. */ int dimension() const; -/*! +/*! */ double xmin() const; -/*! +/*! */ double ymin() const; -/*! +/*! */ double xmax() const; -/*! +/*! */ double ymax() const; -/*! +/*! Returns `xmin()` if `i==0` or `ymin()` if `i==1`. \pre i==0 or i==1 */ double min(int i) const; -/*! +/*! Returns `xmax()` if `i==0` or `ymax()` if `i==1`. \pre i==0 or i==1 */ double max(int i) const; -/*! +/*! returns a bounding box of `b` and `c`. */ Bbox_2 operator+(const Bbox_2 &c) const; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Bbox_3.h b/Kernel_23/doc/Kernel_23/CGAL/Bbox_3.h index 1387ec49368..6dcdb0ca15c 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Bbox_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Bbox_3.h @@ -17,7 +17,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a bounding box `b` with lexicographically smallest corner point at `(xmin, ymin, zmin)` lexicographically largest corner point at @@ -31,66 +31,66 @@ double x_max, double y_max, double z_max); /// \name Operations /// @{ -/*! +/*! Test for equality. */ bool operator==(const Bbox_3 &c) const; -/*! +/*! Test for inequality. */ bool operator!=(const Bbox_3 &q) const; -/*! +/*! Returns 3. */ int dimension() const; -/*! +/*! */ double xmin() const; -/*! +/*! */ double ymin() const; -/*! +/*! */ double zmin() const; -/*! +/*! */ double xmax() const; -/*! +/*! */ double ymax() const; -/*! +/*! */ double zmax() const; -/*! +/*! Returns `xmin()` if `i==0` or `ymin()` if `i==1` or `zmin()` if `i==2`. \pre i<=0 and i<=2 */ double min(int i) const; -/*! +/*! Returns `xmax()` if `i==0` or `ymax()` if `i==1` or `zmax()` if `i==2`. \pre i==0 and i<=2 */ double max(int i) const; -/*! +/*! returns a bounding box of `b` and `c`. */ Bbox_3 operator+(const Bbox_3 &c) const; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h b/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h index 1f63400da37..9072e84d130 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Cartesian.h @@ -32,12 +32,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef FieldNumberType FT; -/*! +/*! */ typedef FieldNumberType RT; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h b/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h index 306125b9720..056e256a80e 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Cartesian_converter.h @@ -36,7 +36,7 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Cartesian_converter<>(); @@ -47,7 +47,7 @@ Cartesian_converter<>(); /// Similar operators are defined for the other kernel traits types `Point_3`, `Vector_2`... /// @{ -/*! +/*! returns a `K2::Point_2` which coordinates are those of `p`, converted by `NTConverter`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Circle_2.h b/Kernel_23/doc/Kernel_23/CGAL/Circle_2.h index b68c9c87e4e..6c72ef4d095 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Circle_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Circle_2.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a variable `c` of type `Circle_2`. It is initialized to the circle with center `center`, @@ -33,7 +33,7 @@ Circle_2(const Point_2 ¢er, const Kernel::FT &squared_radius, const Orientation &ori = COUNTERCLOCKWISE); -/*! +/*! introduces a variable `c` of type `Circle_2`. It is initialized to the unique circle which passes through @@ -46,7 +46,7 @@ Circle_2(const Point_2 &p, const Point_2 &q, const Point_2 &r); -/*! +/*! introduces a variable `c` of type `Circle_2`. It is initialized to the circle with diameter \f$ \overline{pq}\f$ @@ -57,7 +57,7 @@ Circle_2( const Point_2 &p, const Point_2 &q, const Orientation &ori = COUNTERCLOCKWISE); -/*! +/*! introduces a variable `c` of type `Circle_2`. It is initialized to the circle with center `center`, squared @@ -73,25 +73,25 @@ Circle_2( const Point_2 ¢er, /// \name Access Functions /// @{ -/*! +/*! returns the center of `c`. */ const Point_2 ¢er( ) const; -/*! +/*! returns the squared radius of `c`. */ const Kernel::FT& squared_radius( ) const; -/*! +/*! returns the orientation of `c`. */ Orientation orientation( ) const; -/*! +/*! returns `true`, iff `c` and `circle2` are equal, i.e.\ if they have the same center, same squared radius and @@ -99,7 +99,7 @@ same orientation. */ bool operator == ( const Circle_2& circle2) const; -/*! +/*! returns `true`, iff `c` and `circle2` are not equal. */ @@ -110,13 +110,13 @@ bool operator != ( const Circle_2 & circle2) const; /// \name Predicates /// @{ -/*! +/*! returns `true`, iff `c` is degenerate, i.e.\ if `c` has squared radius zero. */ bool is_degenerate( ) const; -/*! +/*! returns either the constant \ref ON_ORIENTED_BOUNDARY, \ref ON_POSITIVE_SIDE, or \ref ON_NEGATIVE_SIDE, @@ -127,7 +127,7 @@ of `c`, resp. Oriented_side oriented_side( const Point_2 &p) const; -/*! +/*! returns \ref ON_BOUNDED_SIDE, \ref ON_BOUNDARY, or \ref ON_UNBOUNDED_SIDE @@ -137,27 +137,27 @@ outside of `c`, resp. Bounded_side bounded_side( const Point_2 &p) const; -/*! +/*! */ bool has_on_positive_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_negative_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_boundary(const Point_2 &p) const; -/*! +/*! */ bool has_on_bounded_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_unbounded_side(const Point_2 &p) const; @@ -167,14 +167,14 @@ bool has_on_unbounded_side(const Point_2 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the circle with the same center and squared radius as `c` but with opposite orientation. */ Circle_2 opposite() const; -/*! +/*! returns the circle obtained by applying \f$ at\f$ on `c`. \pre `at` is an orthogonal transformation. @@ -182,7 +182,7 @@ returns the circle obtained by applying \f$ at\f$ on `c`. Circle_2 orthogonal_transform( Aff_transformation_2 const& at) const; -/*! +/*! returns a bounding box containing `c`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Circle_3.h b/Kernel_23/doc/Kernel_23/CGAL/Circle_3.h index 0b59442c81d..03458ca6731 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Circle_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Circle_3.h @@ -17,7 +17,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a variable `c` of type `Circle_3`. It is initialized to the circle of center `center` and squared radius `sq_r` in plane `plane`. @@ -27,7 +27,7 @@ Circle_3(const Point_3 ¢er, const Kernel::FT &sq_r, const Plane_3 & plane); -/*! +/*! introduces a variable `c` of type `Circle_3`. It is initialized to the circle of center `center` and squared radius `sq_r` in a plane normal to @@ -38,7 +38,7 @@ Circle_3(const Point_3 & center, const Kernel::FT & sq_r, const Vector_3 & n); -/*! +/*! introduces a variable `c` of type `Circle_3`. It is initialized to the circle passing through the three points. \pre The three points are not collinear. @@ -46,7 +46,7 @@ It is initialized to the circle passing through the three points. Circle_3(const Point_3 & p, const Point_3 & q, const Point_3 & r); -/*! +/*! introduces a variable `c` of type `Circle_3`. It is initialized to the circle along which the two spheres intersect. \pre The two spheres intersect along a circle. @@ -54,7 +54,7 @@ It is initialized to the circle along which the two spheres intersect. Circle_3(const Sphere_3 & sphere1, const Sphere_3 & sphere2); -/*! +/*! introduces a variable `c` of type `Circle_3`. It is initialized to the circle along which the sphere and the plane intersect. @@ -63,7 +63,7 @@ plane intersect. Circle_3(constSphere_3 & sphere, const Plane_3 & plane); -/*! +/*! introduces a variable `c` of type `Circle_3`. It is initialized to the circle along which the sphere and the plane intersect. @@ -77,49 +77,49 @@ Circle_3(const Plane_3 & plane, /// \name Access Functions /// @{ -/*! +/*! returns the center of `c`. */ const Point_3 & center( ) const; -/*! +/*! returns the squared radius of `c`. */ const Kernel::FT & squared_radius( ) const; -/*! +/*! returns the supporting plane of `c`. */ const Plane_3 & supporting_plane( ) const; -/*! +/*! returns the diametral sphere of `c`. */ const Sphere_3 & diametral_sphere( ) const; -/*! +/*! returns the area of `c`, divided by \f$ \pi\f$. */ Kernel::FT const& area_divided_by_pi( ) const; -/*! +/*! returns an approximation of the area of `c`. */ double approximate_area( ) const; -/*! +/*! returns the squared length of `c`, divided by \f$ \pi^2\f$. */ Kernel::FT squared_length_divided_by_pi_square( ) const; -/*! +/*! returns an approximation of the squared length (i.e.\ perimeter) of `c`. */ @@ -130,7 +130,7 @@ double approximate_squared_length( ) const; /// \name Predicates /// @{ -/*! +/*! */ bool has_on(const Point_3 & p) const; @@ -140,7 +140,7 @@ bool has_on(const Point_3 & p) const; /// \name Operations /// @{ -/*! +/*! returns a bounding box containing `c`. */ @@ -150,7 +150,7 @@ Bbox_3 bbox() const; }; /* end Circle_3 */ -/*! +/*! returns `true`, iff `c1` and `c2` are equal, i.e.\ if they have the same center, the same squared radius and the same supporting plane. @@ -159,7 +159,7 @@ and the same supporting plane. bool operator == (const Circle_3& c1, Circle_3 const& c2); -/*! +/*! \relates Circle_3 */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Dimension.h b/Kernel_23/doc/Kernel_23/CGAL/Dimension.h index 50136b46914..7bede383919 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Dimension.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Dimension.h @@ -35,7 +35,7 @@ public: /// \name Constants /// @{ -/*! +/*! The dimension value as a compile-time integral constant. It is implemented as `K::Ambient_dimension::%type::%value`. It exists only when the dimension is a compile-time constant. @@ -47,7 +47,7 @@ static const int value; /// \name Types /// @{ -/*! +/*! Either `Dimension_tag` if the dimension is a compile-time constant of value `dim`, or `Dynamic_dimension_tag` otherwise. It is implemented as `K::Ambient_dimension::%type`. @@ -90,7 +90,7 @@ public: /// \name Constants /// @{ -/*! +/*! The value of the `dim` parameter. */ static const int value; @@ -164,7 +164,7 @@ public: /// \name Constants /// @{ -/*! +/*! The dimension value as a compile-time integral constant. It is implemented as `K::Feature_dimension::%type::%value`. It exists only when the dimension is a compile-time constant. @@ -176,7 +176,7 @@ static const int value; /// \name Types /// @{ -/*! +/*! Either `Dimension_tag` if the dimension is a compile-time constant of value `dim`, or `Dynamic_dimension_tag` otherwise. It is implemented as `K::Feature_dimension::%type`. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Direction_2.h b/Kernel_23/doc/Kernel_23/CGAL/Direction_2.h index a8fb66a62ab..d429786625b 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Direction_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Direction_2.h @@ -24,27 +24,27 @@ public: /// \name Creation /// @{ -/*! +/*! introduces the direction `d` of vector `v`. */ Direction_2(const Vector_2 &v); -/*! +/*! introduces the direction `d` of line `l`. */ Direction_2(const Line_2 &l); -/*! +/*! introduces the direction `d` of ray `r`. */ Direction_2(const Ray_2 &r); -/*! +/*! introduces the direction `d` of segment `s`. */ Direction_2(const Segment_2 &s); -/*! +/*! introduces a direction `d` passing through the origin and the point with %Cartesian coordinates \f$ (x, y)\f$. */ @@ -58,53 +58,53 @@ Direction_2(const Kernel::RT &x, const Kernel::RT &y); /// counterclockwise order. /// @{ -/*! +/*! returns values, such that `d``== Direction_2(delta(0),delta(1))`. \pre \f$ 0 \leq i \leq1\f$. */ Kernel::RT delta(int i) const; -/*! +/*! returns `delta(0)`. */ Kernel::RT dx() const; -/*! +/*! returns `delta(1)`. */ Kernel::RT dy() const; -/*! +/*! */ bool operator==(const Direction_2 &e) const; -/*! +/*! */ bool operator!=(const Direction_2 &e) const; -/*! +/*! */ bool operator<(const Direction_2 &e) const; -/*! +/*! */ bool operator>(const Direction_2 &e) const; -/*! +/*! */ bool operator<=(const Direction_2 &e) const; -/*! +/*! */ bool operator>=(const Direction_2 &e) const; -/*! +/*! returns true, iff `d` is not equal to `d1`, and while rotating counterclockwise starting at `d1`, `d` is reached strictly before `d2` is reached. @@ -115,7 +115,7 @@ also `d` == `d1`. bool counterclockwise_in_between(const Direction_2 &d1, const Direction_2 &d2) const; -/*! +/*! The direction opposite to `d`. */ Direction_2 operator-() const; @@ -125,12 +125,12 @@ Direction_2 operator-() const; /// \name Miscellaneous /// @{ -/*! +/*! returns a vector that has the same direction as `d`. */ Vector_2 vector() const; -/*! +/*! returns the direction obtained by applying `t` on `d`. */ Direction_2 transform(const Aff_transformation_2 &t) const; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Direction_3.h b/Kernel_23/doc/Kernel_23/CGAL/Direction_3.h index b93828c6fe7..d8941d772f7 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Direction_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Direction_3.h @@ -23,28 +23,28 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a direction `d` initialized with the direction of vector `v`. */ Direction_3(const Vector_3 &v); -/*! +/*! introduces the direction `d` of line `l`. */ Direction_3(const Line_3 &l); -/*! +/*! introduces the direction `d` of ray `r`. */ Direction_3(const Ray_3 &r); -/*! +/*! introduces the direction `d` of segment `s`. */ Direction_3(const Segment_3 &s); -/*! +/*! introduces a direction `d` initialized with the direction from the origin to the point with %Cartesian coordinates \f$ (x, y, z)\f$. */ @@ -55,48 +55,48 @@ Direction_3(const Kernel::RT &x, const Kernel::RT &y, const Kernel::RT &z); /// \name Operations /// @{ -/*! +/*! returns values, such that `d``== Direction_3(delta(0),delta(1),delta(2))`. \pre \f$ 0 \leq i \leq2\f$. */ Kernel::RT delta(int i) const; -/*! +/*! returns `delta(0)`. */ Kernel::RT dx() const; -/*! +/*! returns `delta(1)`. */ Kernel::RT dy() const; -/*! +/*! returns `delta(2)`. */ Kernel::RT dz() const; -/*! +/*! Test for equality. */ bool operator==(const Direction_3 &e) const; -/*! +/*! Test for inequality. */ bool operator!=(const Direction_3 &e) const; -/*! +/*! The direction opposite to `d`. */ Direction_3 operator-() const; -/*! +/*! returns a vector that has the same direction as `d`. */ Vector_3 vector() const; -/*! +/*! returns the direction obtained by applying `t` on `d`. */ Direction_3 transform(const Aff_transformation_3 &t) const; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h b/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h index ae21b832e24..3824706ee10 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Filtered_kernel.h @@ -103,12 +103,12 @@ public: /// \name Types /// @{ -/*! +/*! The type of the exact kernel. */ typedef EK Exact_kernel; -/*! +/*! The type of the approximate "filtering" kernel. */ typedef FK Approximate_kernel; @@ -118,7 +118,7 @@ typedef FK Approximate_kernel; /// \name Constants /// @{ -/*! +/*! A Boolean value corresponding to the second template argument. Tells whether static filters are provided. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h b/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h index 058c1630c68..4d0ba6880ec 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Filtered_predicate.h @@ -40,7 +40,7 @@ public: /// \name Types /// @{ -/*! +/*! The return type of the function operators. It must also be the same type as `EP::result_type`. */ @@ -51,7 +51,7 @@ typedef FP::result_type result_type; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Filtered_predicate(); @@ -62,12 +62,12 @@ Filtered_predicate(); /// Similar function operators are defined for up to 7 arguments. /// @{ -/*! +/*! The unary function operator for unary predicates. */ template result_type operator()(A1 a1); -/*! +/*! The binary function operator for binary predicates. */ template diff --git a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h index e78a023a1f8..433d5c48559 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous.h @@ -32,12 +32,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Quotient FT; -/*! +/*! */ typedef RingNumberType RT; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous_converter.h b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous_converter.h index a54f57b0e0d..95ffa3d46ee 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Homogeneous_converter.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Homogeneous_converter.h @@ -34,7 +34,7 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Homogeneous_converter<>(); @@ -46,7 +46,7 @@ Homogeneous_converter<>(); /// kernel traits geometric types `Point_3`, `Vector_2`... /// @{ -/*! +/*! returns a `K2::Point_2` which coordinates are those of `p`, converted by `RTConverter`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Iso_cuboid_3.h b/Kernel_23/doc/Kernel_23/CGAL/Iso_cuboid_3.h index 5ae96a810b9..992c383dffa 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Iso_cuboid_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Iso_cuboid_3.h @@ -26,7 +26,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an iso-oriented cuboid `c` with diagonal opposite vertices `p` and `q`. Note that the object is brought in the canonical form. @@ -34,7 +34,7 @@ brought in the canonical form. Iso_cuboid_3(const Point_3 &p, const Point_3 &q); -/*! +/*! introduces an iso-oriented cuboid `c` with diagonal opposite vertices `p` and `q`. The `int` argument value is only used to distinguish the two overloaded functions. @@ -43,7 +43,7 @@ is only used to distinguish the two overloaded functions. Iso_cuboid_3(const Point_3 &p, const Point_3 &q, int); -/*! +/*! introduces an iso-oriented cuboid `c` whose minimal \f$ x\f$ coordinate is the one of `left`, the maximal \f$ x\f$ coordinate is the one of `right`, the @@ -59,7 +59,7 @@ const Point_3 &top, const Point_3 &far, const Point_3 &close); -/*! +/*! introduces an iso-oriented cuboid `c` with diagonal opposite vertices (`min_hx/hw`, `min_hy/hw`, `min_hz/hw`) and @@ -82,83 +82,83 @@ Iso_cuboid_3(const Bbox_3& bbox); /// \name Operations /// @{ -/*! +/*! Test for equality: two iso-oriented cuboid are equal, iff their lower left and their upper right vertices are equal. */ bool operator==(const Iso_cuboid_3 &c2) const; -/*! +/*! Test for inequality. */ bool operator!=(const Iso_cuboid_3 &c2) const; -/*! +/*! returns the i'th vertex modulo 8 of `c`. starting with the lower left vertex. */ Point_3 vertex(int i) const; -/*! +/*! returns `vertex(i)`, as indicated in the figure below: \image html IsoCuboid.gif */ Point_3 operator[](int i) const; -/*! +/*! returns the smallest vertex of `c` (= `vertex(0)`). */ Point_3 min() const; -/*! +/*! returns the largest vertex of `c` (= `vertex(7)`). */ Point_3 max() const; -/*! +/*! returns smallest %Cartesian \f$ x\f$-coordinate in `c`. */ Kernel::FT xmin() const; -/*! +/*! returns smallest %Cartesian \f$ y\f$-coordinate in `c`. */ Kernel::FT ymin() const; -/*! +/*! returns smallest %Cartesian \f$ z\f$-coordinate in `c`. */ Kernel::FT zmin() const; -/*! +/*! returns largest %Cartesian \f$ x\f$-coordinate in `c`. */ Kernel::FT xmax() const; -/*! +/*! returns largest %Cartesian \f$ y\f$-coordinate in `c`. */ Kernel::FT ymax() const; -/*! +/*! returns largest %Cartesian \f$ z\f$-coordinate in `c`. */ Kernel::FT zmax() const; -/*! +/*! returns `i`-th %Cartesian coordinate of the smallest vertex of `c`. \pre \f$ 0 \leq i \leq2\f$. */ Kernel::FT min_coord(int i) const; -/*! +/*! returns `i`-th %Cartesian coordinate of the largest vertex of `c`. \pre \f$ 0 \leq i \leq2\f$. @@ -170,13 +170,13 @@ Kernel::FT max_coord(int i) const; /// \name Predicates /// @{ -/*! +/*! `c` is degenerate, if all vertices are coplanar. */ bool is_degenerate() const; -/*! +/*! returns either \ref ON_UNBOUNDED_SIDE, \ref ON_BOUNDED_SIDE, or the constant \ref ON_BOUNDARY, @@ -184,17 +184,17 @@ depending on where point `p` is. */ Bounded_side bounded_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_boundary(const Point_3 &p) const; -/*! +/*! */ bool has_on_bounded_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_unbounded_side(const Point_3 &p) const; @@ -204,17 +204,17 @@ bool has_on_unbounded_side(const Point_3 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the volume of `c`. */ Kernel::FT volume() const; -/*! +/*! returns a bounding box containing `c`. */ Bbox_3 bbox() const; -/*! +/*! returns the iso-oriented cuboid obtained by applying `t` on the smallest and the largest of `c`. \pre The angle at a rotation must be a multiple of \f$ \pi/2\f$, otherwise the resulting cuboid does not have the same size. Note that rotating about an arbitrary angle can even result in a degenerate iso-oriented cuboid. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Iso_rectangle_2.h b/Kernel_23/doc/Kernel_23/CGAL/Iso_rectangle_2.h index 09c148ec814..05f6d6c0baa 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Iso_rectangle_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Iso_rectangle_2.h @@ -27,7 +27,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an iso-oriented rectangle `r` with diagonal opposite vertices `p` and `q`. Note that the object is brought in the canonical form. @@ -35,7 +35,7 @@ brought in the canonical form. Iso_rectangle_2(const Point_2 &p, const Point_2 &q); -/*! +/*! introduces an iso-oriented rectangle `r` with diagonal opposite vertices `p` and `q`. The `int` argument value is only used to distinguish the two overloaded functions. @@ -45,7 +45,7 @@ Iso_rectangle_2(const Point_2 &p, const Point_2 &q, int); -/*! +/*! introduces an iso-oriented rectangle `r` whose minimal \f$ x\f$ coordinate is the one of `left`, the maximal \f$ x\f$ coordinate is the one of `right`, the @@ -57,7 +57,7 @@ const Point_2 &right, const Point_2 &bottom, const Point_2 &top); -/*! +/*! introduces an iso-oriented rectangle `r` with diagonal opposite vertices (`min_hx/hw`, `min_hy/hw`) and (`max_hx/hw`, `max_hy/hw`). @@ -78,66 +78,66 @@ Iso_rectangle_2(const Bbox_2& bbox); /// \name Operations /// @{ -/*! +/*! Test for equality: two iso-oriented rectangles are equal, iff their lower left and their upper right vertices are equal. */ bool operator==(const Iso_rectangle_2 &r2) const; -/*! +/*! Test for inequality. */ bool operator!=(const Iso_rectangle_2 &r2) const; -/*! +/*! returns the i'th vertex modulo 4 of `r` in counterclockwise order, starting with the lower left vertex. */ Point_2 vertex(int i) const; -/*! +/*! returns `vertex(i)`. */ Point_2 operator[](int i) const; -/*! +/*! returns the lower left vertex of `r` (= `vertex(0)`). */ Point_2 min() const; -/*! +/*! returns the upper right vertex of `r` (= `vertex(2)`). */ Point_2 max() const; -/*! +/*! returns the \f$ x\f$ coordinate of lower left vertex of `r`. */ Kernel::FT xmin() const; -/*! +/*! returns the \f$ y\f$ coordinate of lower left vertex of `r`. */ Kernel::FT ymin() const; -/*! +/*! returns the \f$ x\f$ coordinate of upper right vertex of `r`. */ Kernel::FT xmax() const; -/*! +/*! returns the \f$ y\f$ coordinate of upper right vertex of `r`. */ Kernel::FT ymax() const; -/*! +/*! returns the `i`'th %Cartesian coordinate of the lower left vertex of `r`. \pre \f$ 0 \leq i \leq1\f$. */ Kernel::FT min_coord(int i) const; -/*! +/*! returns the `i`'th %Cartesian coordinate of the upper right vertex of `r`. \pre \f$ 0 \leq i \leq1\f$. @@ -149,13 +149,13 @@ Kernel::FT max_coord(int i) const; /// \name Predicates /// @{ -/*! +/*! `r` is degenerate, if all vertices are collinear. */ bool is_degenerate() const; -/*! +/*! returns either \ref ON_UNBOUNDED_SIDE, \ref ON_BOUNDED_SIDE, or the constant \ref ON_BOUNDARY, @@ -163,17 +163,17 @@ depending on where point `p` is. */ Bounded_side bounded_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_boundary(const Point_2 &p) const; -/*! +/*! */ bool has_on_bounded_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_unbounded_side(const Point_2 &p) const; @@ -183,17 +183,17 @@ bool has_on_unbounded_side(const Point_2 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the area of `r`. */ Kernel::FT area() const; -/*! +/*! returns a bounding box containing `r`. */ Bbox bbox() const; -/*! +/*! returns the iso-oriented rectangle obtained by applying `t` on the lower left and the upper right corner of `r`. \pre The angle at a rotation must be a multiple of \f$ \pi/2\f$, otherwise the resulting rectangle does not have the same side length. Note that rotating about an arbitrary angle can even result in a degenerate iso-oriented rectangle. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Kernel_traits.h b/Kernel_23/doc/Kernel_23/CGAL/Kernel_traits.h index 5072e007f8e..9bb8270ad6d 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Kernel_traits.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Kernel_traits.h @@ -33,7 +33,7 @@ public: /// \name Types /// @{ -/*! +/*! If `T` is a type `K::Point_2` of some kernel model `K`, then `Kernel` is equal to `K`. diff --git a/Kernel_23/doc/Kernel_23/CGAL/Line_2.h b/Kernel_23/doc/Kernel_23/CGAL/Line_2.h index f77a8641622..96fae5ba955 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Line_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Line_2.h @@ -44,37 +44,37 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a line `l` with the line equation in %Cartesian coordinates \f$ ax +by +c = 0\f$. */ Line_2(const Kernel::RT &a, const Kernel::RT &b, const Kernel::RT &c); -/*! +/*! introduces a line `l` passing through the points `p` and `q`. Line `l` is directed from `p` to `q`. */ Line_2(const Point_2 &p, const Point_2 &q); -/*! +/*! introduces a line `l` passing through point `p` with direction `d`. */ Line_2(const Point_2 &p, const Direction_2&d); -/*! +/*! introduces a line `l` passing through point `p` and oriented by `v`. */ Line_2(const Point_2 &p, const Vector_2&v); -/*! +/*! introduces a line `l` supporting the segment `s`, oriented from source to target. */ Line_2(const Segment_2 &s); -/*! +/*! introduces a line `l` supporting the ray `r`, with same orientation. */ @@ -85,33 +85,33 @@ Line_2(const Ray_2 &r); /// \name Operations /// @{ -/*! +/*! Test for equality: two lines are equal, iff they have a non empty intersection and the same direction. */ bool operator==(const Line_2 &h) const; -/*! +/*! Test for inequality. */ bool operator!=(const Line_2 &h) const; -/*! +/*! returns the first coefficient of `l`. */ Kernel::RT a() const; -/*! +/*! returns the second coefficient of `l`. */ Kernel::RT b() const; -/*! +/*! returns the third coefficient of `l`. */ Kernel::RT c() const; -/*! +/*! returns an arbitrary point on `l`. It holds `point(i) == point(j)`, iff `i==j`. Furthermore, `l` is directed from `point(i)` @@ -119,19 +119,19 @@ to `point(j)`, for all `i` \f$ <\f$ `j`. */ Point_2 point(int i) const; -/*! +/*! returns the orthogonal projection of `p` onto `l`. */ Point_2 projection(const Point_2 &p) const; -/*! +/*! returns the \f$ x\f$-coordinate of the point at `l` with given \f$ y\f$-coordinate. \pre `l` is not horizontal. */ Kernel::FT x_at_y(const Kernel::FT &y) const; -/*! +/*! returns the \f$ y\f$-coordinate of the point at `l` with given \f$ x\f$-coordinate. \pre `l` is not vertical. @@ -143,23 +143,23 @@ Kernel::FT y_at_x(const Kernel::FT &x) const; /// \name Predicates /// @{ -/*! +/*! line `l` is degenerate, if the coefficients `a` and `b` of the line equation are zero. */ bool is_degenerate() const; -/*! +/*! */ bool is_horizontal() const; -/*! +/*! */ bool is_vertical() const; -/*! +/*! returns \ref ON_ORIENTED_BOUNDARY, \ref ON_NEGATIVE_SIDE, or the constant \ref ON_POSITIVE_SIDE, @@ -173,17 +173,17 @@ Oriented_side oriented_side(const Point_2 &p) const; /// \name Convenience Boolean Functions /// @{ -/*! +/*! */ bool has_on(const Point_2 &p) const; -/*! +/*! */ bool has_on_positive_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_negative_side(const Point_2 &p) const; @@ -193,29 +193,29 @@ bool has_on_negative_side(const Point_2 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a vector having the direction of `l`. */ Vector_2 to_vector() const; -/*! +/*! returns the direction of `l`. */ Direction_2 direction() const; -/*! +/*! returns the line with opposite direction. */ Line_2 opposite() const; -/*! +/*! returns the line perpendicular to `l` and passing through `p`, where the direction is the direction of `l` rotated counterclockwise by 90 degrees. */ Line_2 perpendicular(const Point_2 &p) const; -/*! +/*! returns the line obtained by applying `t` on a point on `l` and the direction of `l`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Line_3.h b/Kernel_23/doc/Kernel_23/CGAL/Line_3.h index f13dc88dc7b..7d3dad4f06e 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Line_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Line_3.h @@ -16,31 +16,31 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a line `l` passing through the points `p` and `q`. Line `l` is directed from `p` to `q`. */ Line_3(const Point_3 &p, const Point_3 &q); -/*! +/*! introduces a line `l` passing through point `p` with direction `d`. */ Line_3(const Point_3 &p, const Direction_3&d); -/*! +/*! introduces a line `l` passing through point `p` and oriented by `v`. */ Line_3(const Point_3 &p, const Vector_3&v); -/*! +/*! returns the line supporting the segment `s`, oriented from source to target. */ Line_3(const Segment_3 &s); -/*! +/*! returns the line supporting the ray `r`, with the same orientation. */ @@ -51,23 +51,23 @@ Line_3(const Ray_3 &r); /// \name Operations /// @{ -/*! +/*! Test for equality: two lines are equal, iff they have a non empty intersection and the same direction. */ bool operator==(const Line_3 &h) const; -/*! +/*! Test for inequality. */ bool operator!=(const Line_3 &h) const; -/*! +/*! returns the orthogonal projection of `p` on `l`. */ Point_3 projection(const Point_3 &p) const; -/*! +/*! returns an arbitrary point on `l`. It holds `point(i) = point(j)`, iff `i=j`. */ @@ -78,12 +78,12 @@ Point_3 point(int i) const; /// \name Predicates /// @{ -/*! +/*! returns `true` iff line `l` is degenerated to a point. */ bool is_degenerate() const; -/*! +/*! returns `true` iff `p` lies on `l`. */ bool has_on(const Point_3 &p) const; @@ -93,27 +93,27 @@ bool has_on(const Point_3 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the plane perpendicular to `l` passing through `p`. */ Plane_3 perpendicular_plane(const Point_3 &p) const; -/*! +/*! returns the line with opposite direction. */ Line_3 opposite() const; -/*! +/*! returns a vector having the same direction as `l`. */ Vector_3 to_vector() const; -/*! +/*! returns the direction of `l`. */ Direction_3 direction() const; -/*! +/*! returns the line obtained by applying `t` on a point on `l` and the direction of `l`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Plane_3.h b/Kernel_23/doc/Kernel_23/CGAL/Plane_3.h index 70d839dab04..d9348ede185 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Plane_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Plane_3.h @@ -24,7 +24,7 @@ public: /// \name Creation /// @{ -/*! +/*! creates a plane `h` defined by the equation \f$ a\, px +b\, py +c\, pz + d = 0\f$. Notice that `h` is degenerate if @@ -35,7 +35,7 @@ const Kernel::RT &b, const Kernel::RT &c, const Kernel::RT &d); -/*! +/*! creates a plane `h` passing through the points `p`, `q` and `r`. The plane is oriented such that `p`, `q` and `r` are oriented in a positive sense @@ -46,42 +46,42 @@ Plane_3(const Point_3 &p, const Point_3 &q, const Point_3 &r); -/*! +/*! introduces a plane `h` that passes through point `p` and that is orthogonal to `v`. */ Plane_3(const Point_3 &p, const Vector_3 &v); -/*! +/*! introduces a plane `h` that passes through point `p` and that has as an orthogonal direction equal to `d`. */ Plane_3(const Point_3 &p, const Direction_3&d); -/*! +/*! introduces a plane `h` that is defined through the three points `l.point(0)`, `l.point(1)` and `p`. */ Plane_3(const Line_3 &l, const Point_3 &p); -/*! +/*! introduces a plane `h` that is defined through the three points `r.point(0)`, `r.point(1)` and `p`. */ Plane_3(const Ray_3 &r, const Point_3 &p); -/*! +/*! introduces a plane `h` that is defined through the three points `s.source()`, `s.target()` and `p`. */ Plane_3(const Segment_3 &s, const Point_3 &p); -/*! +/*! introduces a plane `h` that is defined as the plane containing the circle. */ @@ -92,78 +92,78 @@ Plane_3(const Circle_3 &c); /// \name Operations /// @{ -/*! +/*! Test for equality: two planes are equal, iff they have a non empty intersection and the same orientation. */ bool operator==(const Plane_3 &h2) const; -/*! +/*! Test for inequality. */ bool operator!=(const Plane_3 &h2) const; -/*! +/*! returns the first coefficient of `h`. */ Kernel::RT a() const; -/*! +/*! returns the second coefficient of `h`. */ Kernel::RT b() const; -/*! +/*! returns the third coefficient of `h`. */ Kernel::RT c() const; -/*! +/*! returns the fourth coefficient of `h`. */ Kernel::RT d() const; -/*! +/*! returns the line that is perpendicular to `h` and that passes through point `p`. The line is oriented from the negative to the positive side of `h`. */ Line_3 perpendicular_line(const Point_3 &p) const; -/*! +/*! returns the orthogonal projection of `p` on `h`. */ Point_3 projection(const Point_3 &p) const; -/*! +/*! returns the plane with opposite orientation. */ Plane_3 opposite() const; -/*! +/*! returns an arbitrary point on `h`. */ Point_3 point() const; -/*! +/*! returns a vector that is orthogonal to `h` and that is directed to the positive side of `h`. */ Vector_3 orthogonal_vector() const; -/*! +/*! returns the direction that is orthogonal to `h` and that is directed to the positive side of `h`. */ Direction_3 orthogonal_direction() const; -/*! +/*! returns a vector orthogonal to `orthogonal_vector()`. */ Vector_3 base1() const; -/*! +/*! returns a vector that is both orthogonal to `base1()`, and to `orthogonal_vector()`, and such that the result of `orientation( point(), point() + base1(), point()+base2(), point() + orthogonal_vector() )` is positive. @@ -179,14 +179,14 @@ Vector_3 base2() const; /// preserves combinatorics, but not distances. /// @{ -/*! +/*! returns the image point of the projection of `p` under an affine transformation, which maps `h` onto the \f$ xy\f$-plane, with the \f$ z\f$-coordinate removed. */ Point_2 to_2d(const Point_3 &p) const; -/*! +/*! returns a point `q`, such that `to_2d( to_3d( p ))` is equal to `p`. */ @@ -197,7 +197,7 @@ Point_3 to_3d(const Point_2 &p) const; /// \name Predicates /// @{ -/*! +/*! returns either \ref ON_ORIENTED_BOUNDARY, or the constant \ref ON_POSITIVE_SIDE, or the constant \ref ON_NEGATIVE_SIDE, @@ -211,32 +211,32 @@ Oriented_side oriented_side(const Point_3 &p) const; /// \name Convenience Boolean Functions /// @{ -/*! +/*! */ bool has_on(const Point_3 &p) const; -/*! +/*! */ bool has_on_positive_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_negative_side(const Point_3 &p) const; -/*! +/*! */ bool has_on(const Line_3 &l) const; -/*! +/*! */ bool has_on(const Circle_3 &l) const; -/*! +/*! Plane `h` is degenerate, if the coefficients `a`, `b`, and `c` of the plane equation are zero. */ @@ -247,7 +247,7 @@ bool is_degenerate() const; /// \name Miscellaneous /// @{ -/*! +/*! returns the plane obtained by applying `t` on a point of `h` and the orthogonal direction of `h`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Point_2.h b/Kernel_23/doc/Kernel_23/CGAL/Point_2.h index 0c1316d8985..18a2cf4c749 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Point_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Point_2.h @@ -45,7 +45,7 @@ public: /// \name Types /// @{ -/*! +/*! An iterator for enumerating the %Cartesian coordinates of a point. */ @@ -56,30 +56,30 @@ typedef unspecified_type Cartesian_const_iterator; /// \name Creation /// @{ -/*! +/*! introduces a variable `p` with %Cartesian coordinates \f$ (0,0)\f$. */ Point_2(const Origin &ORIGIN); -/*! +/*! introduces a point `p` initialized to `(x,y)`. */ Point_2(int x, int y); -/*! +/*! introduces a point `p` initialized to `(x,y)` provided `RT` supports construction from `double`. */ Point_2(double x, double y); -/*! +/*! introduces a point `p` initialized to `(hx/hw,hy/hw)`. \pre `hw` \f$ \neq\f$ `Kernel::RT(0)`. */ Point_2(const Kernel::RT &hx, const Kernel::RT &hy, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a point `p` initialized to `(x,y)`. */ Point_2(const Kernel::FT &x, const Kernel::FT &y); @@ -89,13 +89,13 @@ Point_2(const Kernel::FT &x, const Kernel::FT &y); /// \name Operations /// @{ -/*! +/*! Test for equality. Two points are equal, iff their \f$ x\f$ and \f$ y\f$ coordinates are equal. The point can be compared with `ORIGIN`. */ bool operator==(const Point_2 &q) const; -/*! +/*! Test for inequality. The point can be compared with `ORIGIN`. */ bool operator!=(const Point_2 &q) const; @@ -110,27 +110,27 @@ bool operator!=(const Point_2 &q) const; /// `FieldNumberType` is a quotient. /// @{ -/*! +/*! returns the homogeneous \f$ x\f$ coordinate. */ Kernel::RT hx() const; -/*! +/*! returns the homogeneous \f$ y\f$ coordinate. */ Kernel::RT hy() const; -/*! +/*! returns the homogenizing coordinate. */ Kernel::RT hw() const; -/*! +/*! returns the %Cartesian \f$ x\f$ coordinate, that is `hx()`/`hw()`. */ Kernel::FT x() const; -/*! +/*! returns the %Cartesian \f$ y\f$ coordinate, that is `hy()`/`hw()`. */ Kernel::FT y() const; @@ -143,48 +143,48 @@ Kernel::FT y() const; /// in a homogeneous flavor. /// @{ -/*! +/*! returns the i'th homogeneous coordinate of `p`, starting with 0. \pre \f$ 0\leq i \leq2\f$. */ Kernel::RT homogeneous(int i) const; -/*! +/*! returns the i'th %Cartesian coordinate of `p`, starting with 0. \pre \f$ 0\leq i \leq1\f$. */ Kernel::FT cartesian(int i) const; -/*! +/*! returns `cartesian(i)`. \pre \f$ 0\leq i \leq1\f$. */ Kernel::FT operator[](int i) const; -/*! +/*! returns an iterator to the %Cartesian coordinates of `p`, starting with the 0th coordinate. */ Cartesian_const_iterator cartesian_begin() const; -/*! +/*! returns an off the end iterator to the Cartesian coordinates of `p`. */ Cartesian_const_iterator cartesian_end() const; -/*! +/*! returns the dimension (the constant 2). */ int dimension() const; -/*! +/*! returns a bounding box containing `p`. Note that bounding boxes are not parameterized with whatsoever. */ Bbox_2 bbox() const; -/*! +/*! returns the point obtained by applying `t` on `p`. */ Point_2 transform(const Aff_transformation_2 &t) const; @@ -194,7 +194,7 @@ Point_2 transform(const Aff_transformation_2 &t) const; }; /* end Point_2 */ -/*! +/*! returns true iff `p` is lexicographically smaller than `q`, i.e.\ either if `p.x() < q.x()` or if `p.x() == q.x()` and `p.y() < q.y()`. @@ -203,28 +203,28 @@ i.e.\ either if `p.x() < q.x()` or if `p.x() == q.x()` and bool operator<(const Point_2 &p, const Point_2 &q); -/*! +/*! returns true iff `p` is lexicographically greater than `q`. \relates Point_2 */ bool operator>(const Point_2 &p, const Point_2 &q); -/*! +/*! returns true iff `p` is lexicographically smaller or equal to `q`. \relates Point_2 */ bool operator<=(const Point_2 &p, const Point_2 &q); -/*! +/*! returns true iff `p` is lexicographically greater or equal to `q`. \relates Point_2 */ bool operator>=(const Point_2 &p, const Point_2 &q); -/*! +/*! returns the difference vector between `q` and `p`. You can substitute `ORIGIN` for either `p` or `q`, but not for both. @@ -237,7 +237,7 @@ const Point_2 &q); /// \ingroup Kernel_operator_plus /// @{ -/*! +/*! returns the point obtained by translating `p` by the vector `v`. \relates Point_2 @@ -250,7 +250,7 @@ const Vector_2 &v); /// \ingroup Kernel_operator_minus /// @{ -/*! +/*! returns the point obtained by translating `p` by the vector -`v`. \relates Point_2 diff --git a/Kernel_23/doc/Kernel_23/CGAL/Point_3.h b/Kernel_23/doc/Kernel_23/CGAL/Point_3.h index 6471469e428..f994b303982 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Point_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Point_3.h @@ -27,7 +27,7 @@ public: /// \name Types /// @{ -/*! +/*! An iterator for enumerating the %Cartesian coordinates of a point. */ @@ -38,29 +38,29 @@ typedef unspecified_type Cartesian_const_iterator; /// \name Creation /// @{ -/*! +/*! introduces a point with %Cartesian coordinates\f$ (0,0,0)\f$. */ Point_3(const Origin &ORIGIN); -/*! +/*! introduces a point `p` initialized to `(x,y,z)`. */ Point_3(int x, int y, int z); -/*! +/*! introduces a point `p` initialized to `(x,y,z)` provided `RT` supports it. */ Point_3(double x, double y, double z); -/*! +/*! introduces a point `p` initialized to `(hx/hw,hy/hw, hz/hw)`. \pre `hw` \f$ \neq\f$ 0. */ Point_3(const Kernel::RT &hx, const Kernel::RT &hy, const Kernel::RT &hz, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a point `p` initialized to `(x,y,z)`. */ Point_3(const Kernel::FT &x, const Kernel::FT &y, const Kernel::FT &z); @@ -70,13 +70,13 @@ Point_3(const Kernel::FT &x, const Kernel::FT &y, const Kernel::FT &z); /// \name Operations /// @{ -/*! +/*! Test for equality: Two points are equal, iff their \f$ x\f$, \f$ y\f$ and \f$ z\f$ coordinates are equal. */ bool operator==(const Point_3 &q) const; -/*! +/*! Test for inequality. */ bool operator!=(const Point_3 &q) const; @@ -91,37 +91,37 @@ bool operator!=(const Point_3 &q) const; /// FieldNumberType is a quotient. /// @{ -/*! +/*! returns the homogeneous \f$ x\f$ coordinate. */ Kernel::RT hx() const; -/*! +/*! returns the homogeneous \f$ y\f$ coordinate. */ Kernel::RT hy() const; -/*! +/*! returns the homogeneous \f$ z\f$ coordinate. */ Kernel::RT hz() const; -/*! +/*! returns the homogenizing coordinate. */ Kernel::RT hw() const; -/*! +/*! returns the %Cartesian \f$ x\f$ coordinate, that is `hx()`/`hw()`. */ Kernel::FT x() const; -/*! +/*! returns the %Cartesian \f$ y\f$ coordinate, that is `hy()`/`hw()`. */ Kernel::FT y() const; -/*! +/*! returns the %Cartesian \f$ z\f$ coordinate, that is `hz()`/`hw()`. */ Kernel::FT z() const; @@ -134,47 +134,47 @@ Kernel::FT z() const; /// %Cartesian and in a homogeneous flavor. /// @{ -/*! +/*! returns the i'th homogeneous coordinate of `p`, starting with 0. \pre \f$ 0\leq i \leq3\f$. */ Kernel::RT homogeneous(int i) const; -/*! +/*! returns the i'th %Cartesian coordinate of `p`, starting with 0. \pre \f$ 0\leq i \leq2\f$. */ Kernel::FT cartesian(int i) const; -/*! +/*! returns `cartesian(i)`. \pre \f$ 0\leq i \leq2\f$. */ Kernel::FT operator[](int i) const; -/*! +/*! returns an iterator to the %Cartesian coordinates of `p`, starting with the 0th coordinate. */ Cartesian_const_iterator cartesian_begin() const; -/*! +/*! returns an off the end iterator to the %Cartesian coordinates of `p`. */ Cartesian_const_iterator cartesian_end() const; -/*! +/*! returns the dimension (the constant 3). */ int dimension() const; -/*! +/*! returns a bounding box containing `p`. */ Bbox_3 bbox() const; -/*! +/*! returns the point obtained by applying `t` on `p`. */ Point_3 transform(const Aff_transformation_3 &t) const; @@ -183,7 +183,7 @@ Point_3 transform(const Aff_transformation_3 &t) const; }; /* end Point_3 */ -/*! +/*! returns true iff `p` is lexicographically smaller than `q` (the lexicographical order being defined on the %Cartesian coordinates). @@ -192,14 +192,14 @@ coordinates). bool operator<(const Point_3 &p, const Point_3 &q); -/*! +/*! returns true iff `p` is lexicographically greater than `q`. \relates Point_3 */ bool operator>(const Point_3 &p, const Point_3 &q); -/*! +/*! returns true iff `p` is lexicographically smaller or equal to `q`. \relates Point_3 @@ -207,7 +207,7 @@ returns true iff `p` is lexicographically smaller or equal to bool operator<=(const Point_3 &p, const Point_3 &q); -/*! +/*! returns true iff `p` is lexicographically greater or equal to `q`. \relates Point_3 @@ -215,7 +215,7 @@ returns true iff `p` is lexicographically greater or equal to bool operator>=(const Point_3 &p, const Point_3 &q); -/*! +/*! returns the difference vector between `q` and `p`. You can substitute `ORIGIN` for either `p` or `q`, but not for both. @@ -228,7 +228,7 @@ const Point_3 &q); ///@{ -/*! +/*! returns the point obtained by translating `p` by the vector `v`. \relates Point_3 @@ -242,7 +242,7 @@ const Vector_3 &v); ///@{ -/*! +/*! returns the point obtained by translating `p` by the vector -`v`. \relates Point_3 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 f96df92d803..d89a5559ecc 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 @@ -39,22 +39,22 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Point_3 Point_2; -/*! +/*! */ typedef Segment_3 Segment_2; -/*! +/*! */ typedef Triangle_3 Triangle_2; -/*! +/*! */ typedef Line_3 Line_2; @@ -73,7 +73,7 @@ typedef Line_3 Line_2; /// new point is constructed. /// @{ -/*! +/*! A construction object. Provides the operator : @@ -95,19 +95,19 @@ typedef unspecified_type Intersect_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ Projection_traits_xy_3(); -/*! +/*! Copy constructor. */ Projection_traits_xy_3( Projection_traits_xy_3 tr); -/*! +/*! Assignment operator. */ Projection_traits_xy_3 operator=(Projection_traits_xy_3 tr); diff --git a/Kernel_23/doc/Kernel_23/CGAL/Ray_2.h b/Kernel_23/doc/Kernel_23/CGAL/Ray_2.h index c83bdf35e88..e3a5a656f09 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Ray_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Ray_2.h @@ -17,25 +17,25 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a ray `r` with source `p` and passing through point `q`. */ Ray_2(const Point_2 &p, const Point_2&q); -/*! +/*! introduces a ray `r` starting at source `p` with direction `d`. */ Ray_2(const Point_2 &p, const Direction_2 &d); -/*! +/*! introduces a ray `r` starting at source `p` with the direction of `v`. */ Ray_2(const Point_2 &p, const Vector_2 &v); -/*! +/*! introduces a ray `r` starting at source `p` with the same direction as `l`. */ @@ -46,45 +46,45 @@ Ray_2(const Point_2 &p, const Line_2 &l); /// \name Operations /// @{ -/*! +/*! Test for equality: two rays are equal, iff they have the same source and the same direction. */ bool operator==(const Ray_2 &h) const; -/*! +/*! Test for inequality. */ bool operator!=(const Ray_2 &h) const; -/*! +/*! returns the source of `r`. */ Point_2 source() const; -/*! +/*! returns a point on `r`. `point(0)` is the source, `point(i)`, with `i>0`, is different from the source. \pre \f$ i \geq0\f$. */ Point_2 point(int i) const; -/*! +/*! returns the direction of `r`. */ Direction_2 direction() const; -/*! +/*! returns a vector giving the direction of `r`. */ Vector_2 to_vector() const; -/*! +/*! returns the line supporting `r` which has the same direction. */ Line_2 supporting_line() const; -/*! +/*! returns the ray with the same source and the opposite direction. */ Ray_2 opposite() const; @@ -94,29 +94,29 @@ Ray_2 opposite() const; /// \name Predicates /// @{ -/*! +/*! ray `r` is degenerate, if the source and the second defining point fall together (that is if the direction is degenerate). */ bool is_degenerate() const; -/*! +/*! */ bool is_horizontal() const; -/*! +/*! */ bool is_vertical() const; -/*! +/*! A point is on `r`, iff it is equal to the source of `r`, or if it is in the interior of `r`. */ bool has_on(const Point_2 &p) const; -/*! +/*! checks if point `p` is on `r`. This function is faster than function `has_on()` if the precondition checking is disabled. @@ -129,7 +129,7 @@ bool collinear_has_on(const Point_2 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the ray obtained by applying `t` on the source and on the direction of `r`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Ray_3.h b/Kernel_23/doc/Kernel_23/CGAL/Ray_3.h index 4b4caa4fd92..38ff59bf2c5 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Ray_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Ray_3.h @@ -17,25 +17,25 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a ray `r` with source `p` and passing through point `q`. */ Ray_3(const Point_3 &p, const Point_3 &q); -/*! +/*! introduces a ray `r` with source `p` and with direction `d`. */ Ray_3(const Point_3 &p, const Direction_3 &d); -/*! +/*! introduces a ray `r` with source `p` and with a direction given by `v`. */ Ray_3(const Point_3 &p, const Vector_3 &v); -/*! +/*! introduces a ray `r` starting at source `p` with the same direction as `l`. */ @@ -46,62 +46,62 @@ Ray_3(const Point_3 &p, const Line_3 &l); /// \name Operations /// @{ -/*! +/*! Test for equality: two rays are equal, iff they have the same source and the same direction. */ bool operator==(const Ray_3 &h) const; -/*! +/*! Test for inequality. */ bool operator!=(const Ray_3 &h) const; -/*! +/*! returns the source of `r` */ Point_3 source() const; -/*! +/*! returns a point on `r`. `point(0)` is the source. `point(i)`, with `i>0`, is different from the source. \pre \f$ i \geq0\f$. */ Point_3 point(int i) const; -/*! +/*! returns the direction of `r`. */ Direction_3 direction() const; -/*! +/*! returns a vector giving the direction of `r`. */ Vector_3 to_vector() const; -/*! +/*! returns the line supporting `r` which has the same direction. */ Line_3 supporting_line() const; -/*! +/*! returns the ray with the same source and the opposite direction. */ Ray_3 opposite() const; -/*! +/*! ray `r` is degenerate, if the source and the second defining point fall together (that is if the direction is degenerate). */ bool is_degenerate() const; -/*! +/*! A point is on `r`, iff it is equal to the source of `r`, or if it is in the interior of `r`. */ bool has_on(const Point_3 &p) const; -/*! +/*! returns the ray obtained by applying `t` on the source and on the direction of `r`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Segment_2.h b/Kernel_23/doc/Kernel_23/CGAL/Segment_2.h index 232ce4cf7b9..df8465e9a48 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Segment_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Segment_2.h @@ -24,7 +24,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a segment `s` with source `p` and target `q`. The segment is directed from the source towards the target. @@ -36,38 +36,38 @@ Segment_2(const Point_2 &p, const Point_2 &q); /// \name Operations /// @{ -/*! +/*! Test for equality: Two segments are equal, iff their sources and targets are equal. */ bool operator==(const Segment_2 &q) const; -/*! +/*! Test for inequality. */ bool operator!=(const Segment_2 &q) const; -/*! +/*! returns the source of `s`. */ Point_2 source() const; -/*! +/*! returns the target of `s`. */ Point_2 target() const; -/*! +/*! returns the point of `s` with lexicographically smallest coordinate. */ Point_2 min() const; -/*! +/*! returns the point of `s` with lexicographically largest coordinate. */ Point_2 max() const; -/*! +/*! returns source or target of `s`: `vertex(0)` returns the source of `s`, `vertex(1)` returns the target of `s`. The parameter `i` is taken modulo 2, which gives @@ -75,37 +75,37 @@ easy access to the other vertex. */ Point_2 vertex(int i) const; -/*! +/*! returns `vertex(i)`. */ Point_2 point(int i) const; -/*! +/*! returns `vertex(i)`. */ Point_2 operator[](int i) const; -/*! +/*! returns the squared length of `s`. */ Kernel::FT squared_length() const; -/*! +/*! returns the direction from source to target of `s`. */ Direction_2 direction() const; -/*! +/*! returns the vector `s.target()` - `s.source()`. */ Vector_2 to_vector() const; -/*! +/*! returns a segment with source and target point interchanged. */ Segment_2 opposite() const; -/*! +/*! returns the line `l` passing through `s`. Line `l` has the same orientation as segment `s`. */ @@ -116,28 +116,28 @@ Line_2 supporting_line() const; /// \name Predicates /// @{ -/*! +/*! segment `s` is degenerate, if source and target are equal. */ bool is_degenerate() const; -/*! +/*! */ bool is_horizontal() const; -/*! +/*! */ bool is_vertical() const; -/*! +/*! A point is on `s`, iff it is equal to the source or target of `s`, or if it is in the interior of `s`. */ bool has_on(const Point_2 &p) const; -/*! +/*! checks if point `p` is on segment `s`. This function is faster than function `has_on()`. \pre `p` is on the supporting line of `s`. @@ -149,12 +149,12 @@ bool collinear_has_on(const Point_2 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a bounding box containing `s`. */ Bbox_2 bbox() const; -/*! +/*! returns the segment obtained by applying `t` on the source and the target of `s`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Segment_3.h b/Kernel_23/doc/Kernel_23/CGAL/Segment_3.h index e477483e967..c3e751db7cc 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Segment_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Segment_3.h @@ -24,7 +24,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a segment `s` with source `p` and target `q`. It is directed from the source towards the target. @@ -36,38 +36,38 @@ Segment_3(const Point_3 &p, const Point_3 &q); /// \name Operations /// @{ -/*! +/*! Test for equality: Two segments are equal, iff their sources and targets are equal. */ bool operator==(const Segment_3 &q) const; -/*! +/*! Test for inequality. */ bool operator!=(const Segment_3 &q) const; -/*! +/*! returns the source of `s`. */ Point_3 source() const; -/*! +/*! returns the target of `s`. */ Point_3 target() const; -/*! +/*! returns the point of `s` with smallest coordinate (lexicographically). */ Point_3 min() const; -/*! +/*! returns the point of `s` with largest coordinate (lexicographically). */ Point_3 max() const; -/*! +/*! returns source or target of `s`: `vertex(0)` returns the source, `vertex(1)` returns the target. The parameter `i` is taken modulo 2, which gives @@ -75,60 +75,60 @@ easy access to the other vertex. */ Point_3 vertex(int i) const; -/*! +/*! returns `vertex(i)`. */ Point_3 point(int i) const; -/*! +/*! returns `vertex(i)`. */ Point_3 operator[](int i) const; -/*! +/*! returns the squared length of `s`. */ Kernel::FT squared_length() const; -/*! +/*! returns the vector `s.target()` - `s`.`source()`. */ Vector_3 to_vector() const; -/*! +/*! returns the direction from source to target. */ Direction_3 direction() const; -/*! +/*! returns a segment with source and target interchanged. */ Segment_3 opposite() const; -/*! +/*! returns the line `l` passing through `s`. Line `l` has the same orientation as segment `s`, that is from the source to the target of `s`. */ Line_3 supporting_line() const; -/*! +/*! segment `s` is degenerate, if source and target fall together. */ bool is_degenerate() const; -/*! +/*! A point is on `s`, iff it is equal to the source or target of `s`, or if it is in the interior of `s`. */ bool has_on(const Point_3 &p) const; -/*! +/*! returns a bounding box containing `s`. */ Bbox_3 bbox() const; -/*! +/*! returns the segment obtained by applying `t` on the source and the target of `s`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h b/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h index 530ce323e5a..c07aa377649 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Simple_cartesian.h @@ -34,12 +34,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef FieldNumberType FT; -/*! +/*! */ typedef FieldNumberType RT; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h b/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h index a50d4efab9d..6a8244560a3 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Simple_homogeneous.h @@ -34,12 +34,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Quotient FT; -/*! +/*! */ typedef RingNumberType RT; diff --git a/Kernel_23/doc/Kernel_23/CGAL/Sphere_3.h b/Kernel_23/doc/Kernel_23/CGAL/Sphere_3.h index 51a2f66639d..764dbef3323 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Sphere_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Sphere_3.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a variable `c` of type `Sphere_3`. It is initialized to the sphere with center `center`, @@ -33,7 +33,7 @@ Sphere_3( const Point_3 & center, const Kernel::FT & squared_radius, const Orientation & orientation = COUNTERCLOCKWISE); -/*! +/*! introduces a variable `c` of type `Sphere_3`. It is initialized to the unique sphere which passes through @@ -47,7 +47,7 @@ const Point_3 & q, const Point_3 & r, const Point_3 & s); -/*! +/*! introduces a variable `c` of type `Sphere_3`. It is initialized to the smallest sphere which passes through @@ -59,7 +59,7 @@ const Point_3 & q, const Point_3 & r, const Orientation& o = COUNTERCLOCKWISE); -/*! +/*! introduces a variable `c` of type `Sphere_3`. It is initialized to the smallest sphere which passes through @@ -70,7 +70,7 @@ Sphere_3( const Point_3 & p, const Point_3 & q, const Orientation& o = COUNTERCLOCKWISE); -/*! +/*! introduces a variable `c` of type `Sphere_3`. It is initialized to the sphere with center `center`, squared @@ -81,7 +81,7 @@ radius zero and orientation `orientation`. Sphere_3( const Point_3 & center, const Orientation& orientation = COUNTERCLOCKWISE); -/*! +/*! introduces a variable `c` of type `Sphere_3`. It is initialized to the diametral sphere of the circle. @@ -93,25 +93,25 @@ Sphere_3( const Circle_3 & c ); /// \name Access Functions /// @{ -/*! +/*! returns the center of `c`. */ const Point_3 & center( ) const; -/*! +/*! returns the squared radius of `c`. */ Kernel::FT const& squared_radius( ) const; -/*! +/*! returns the orientation of `c`. */ Orientation const& orientation( ) const; -/*! +/*! returns `true`, iff `c` and `sphere2` are equal, i.e.\ if they have the same center, same squared radius and @@ -119,7 +119,7 @@ same orientation. */ bool operator == ( const Sphere_3 & sphere2) const; -/*! +/*! returns `true`, iff `c` and `sphere2` are not equal. */ @@ -130,13 +130,13 @@ bool operator != ( const Sphere_3 & sphere2) const; /// \name Predicates /// @{ -/*! +/*! returns `true`, iff `c` is degenerate, i.e.\ if `c` has squared radius zero. */ bool is_degenerate( ) const; -/*! +/*! returns either the constant \ref ON_ORIENTED_BOUNDARY, \ref ON_POSITIVE_SIDE, or \ref ON_NEGATIVE_SIDE, @@ -147,7 +147,7 @@ of `c`, resp. Oriented_side oriented_side( const Point_3 & p) const; -/*! +/*! returns \ref ON_BOUNDED_SIDE, \ref ON_BOUNDARY, or \ref ON_UNBOUNDED_SIDE @@ -157,37 +157,37 @@ outside of `c`, resp. Bounded_side bounded_side( const Point_3 & p) const; -/*! +/*! */ bool has_on_positive_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_negative_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_boundary(const Point_3 &p) const; -/*! +/*! */ bool has_on_bounded_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_unbounded_side(const Point_3 &p) const; -/*! +/*! */ bool has_on(const Point_3 &p) const; -/*! +/*! */ bool has_on(const Circle_3 &p) const; @@ -197,14 +197,14 @@ bool has_on(const Circle_3 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the sphere with the same center and squared radius as `c` but with opposite orientation. */ Sphere_3 opposite() const; -/*! +/*! returns the sphere obtained by applying `at` on `c`. \pre `at` is an orthogonal transformation. @@ -212,7 +212,7 @@ returns the sphere obtained by applying `at` on `c`. Sphere_3 orthogonal_transform( Aff_transformation_3 const& at) const; -/*! +/*! returns a bounding box containing `c`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Tetrahedron_3.h b/Kernel_23/doc/Kernel_23/CGAL/Tetrahedron_3.h index 10ad9541dc6..bcd383d6743 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Tetrahedron_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Tetrahedron_3.h @@ -27,7 +27,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a tetrahedron `t` with vertices `p_0`, `p_1`, `p_2` and `p_3`. */ Tetrahedron_3(const Point_3 &p0, @@ -40,24 +40,24 @@ const Point_3 &p3); /// \name Operations /// @{ -/*! +/*! Test for equality: two tetrahedra `t` and `t2` are equal, iff `t` and `t2` have the same orientation and their sets (not sequences) of vertices are equal. */ bool operator==(const Tetrahedron_3 &t2) const; -/*! +/*! Test for inequality. */ bool operator!=(const Tetrahedron_3 &t2) const; -/*! +/*! returns the i'th vertex modulo 4 of `t`. */ Point_3 vertex(int i) const; -/*! +/*! returns `vertex(int i)`. */ Point_3 operator[](int i) const; @@ -67,22 +67,22 @@ Point_3 operator[](int i) const; /// \name Predicates /// @{ -/*! +/*! Tetrahedron `t` is degenerate, if the vertices are coplanar. */ bool is_degenerate() const; -/*! +/*! */ Orientation orientation() const; -/*! +/*! \pre `t` is not degenerate. */ Oriented_side oriented_side(const Point_3 &p) const; -/*! +/*! \pre `t` is not degenerate. */ Bounded_side bounded_side(const Point_3 &p) const; @@ -92,27 +92,27 @@ Bounded_side bounded_side(const Point_3 &p) const; /// \name Convencience Boolean Functions /// @{ -/*! +/*! */ bool has_on_positive_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_negative_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_boundary(const Point_3 &p) const; -/*! +/*! */ bool has_on_bounded_side(const Point_3 &p) const; -/*! +/*! */ bool has_on_unbounded_side(const Point_3 &p) const; @@ -122,17 +122,17 @@ bool has_on_unbounded_side(const Point_3 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the signed volume of `t`. */ Kernel::FT volume() const; -/*! +/*! returns a bounding box containing `t`. */ Bbox_3 bbox() const; -/*! +/*! returns the tetrahedron obtained by applying `at` on the three vertices of `t`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Triangle_2.h b/Kernel_23/doc/Kernel_23/CGAL/Triangle_2.h index 84a25712933..be0b30b91cd 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Triangle_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Triangle_2.h @@ -23,7 +23,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a triangle `t` with vertices `p`, `q` and `r`. */ Triangle_2(const Point_2 &p, @@ -35,24 +35,24 @@ const Point_2 &r); /// \name Operations /// @{ -/*! +/*! Test for equality: two triangles are equal, iff there exists a cyclic permutation of the vertices of \f$ t2\f$, such that they are equal to the vertices of `t`. */ bool operator==(const Triangle_2 &t2) const; -/*! +/*! Test for inequality. */ bool operator!=(const Triangle_2 &t2) const; -/*! +/*! returns the i'th vertex modulo 3 of `t`. */ Point_2 vertex(int i) const; -/*! +/*! returns `vertex(i)`. */ Point_2 operator[](int i) const; @@ -63,17 +63,17 @@ Point_2 operator[](int i) const; /// For convenience we provide the following Boolean functions: /// @{ -/*! +/*! triangle `t` is degenerate, if the vertices are collinear. */ bool is_degenerate() const; -/*! +/*! returns the orientation of `t`. */ Orientation orientation() const; -/*! +/*! returns `ON_ORIENTED_BOUNDARY`, or `POSITIVE_SIDE`, @@ -84,7 +84,7 @@ determined by the position of point `p`. */ Oriented_side oriented_side(const Point_2 &p) const; -/*! +/*! returns the constant `ON_BOUNDARY`, `ON_BOUNDED_SIDE`, or else `ON_UNBOUNDED_SIDE`, @@ -93,27 +93,27 @@ depending on where point `p` is. */ Bounded_side bounded_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_positive_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_negative_side(const Point_2 &p) const; -/*! +/*! */ bool has_on_boundary(const Point_2 &p) const; -/*! +/*! */ bool has_on_bounded_side(const Point_2 &p) const; -/*! +/*! \pre `t` is not degenerate. */ bool has_on_unbounded_side(const Point_2 &p) const; @@ -123,24 +123,24 @@ bool has_on_unbounded_side(const Point_2 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a triangle where the boundary is oriented the other way round (this flips the positive and the negative side, but not the bounded and unbounded side). */ Triangle_2 opposite(); -/*! +/*! returns the signed area of `t`. */ Kernel::FT area() const; -/*! +/*! returns a bounding box containing `t`. */ Bbox_2 bbox() const; -/*! +/*! returns the triangle obtained by applying \f$ at\f$ on the three vertices of `t`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Triangle_3.h b/Kernel_23/doc/Kernel_23/CGAL/Triangle_3.h index 345b2284ff2..073b9c4104d 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Triangle_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Triangle_3.h @@ -18,7 +18,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces a triangle `t` with vertices `p`, `q` and `r`. */ Triangle_3(const Point_3 &p, @@ -30,29 +30,29 @@ const Point_3 &r); /// \name Operations /// @{ -/*! +/*! Test for equality: two triangles `t1` and `t2` are equal, iff there exists a cyclic permutation of the vertices of t2`, such that they are equal to the vertices of `t1`. */ bool operator==(const Triangle_3 &t2) const; -/*! +/*! Test for inequality. */ bool operator!=(const Triangle_3 &t2) const; -/*! +/*! returns the i'th vertex modulo 3 of `t`. */ Point_3 vertex(int i) const; -/*! +/*! returns `vertex(int i)`. */ Point_3 operator[](int i) const; -/*! +/*! returns the supporting plane of `t`, with same orientation. */ @@ -63,12 +63,12 @@ Plane_3 supporting_plane(); /// \name Predicates /// @{ -/*! +/*! `t` is degenerate if its vertices are collinear. */ bool is_degenerate() const; -/*! +/*! A point is on `t`, if it is on a vertex, an edge or the face of `t`. */ @@ -79,17 +79,17 @@ bool has_on(const Point_3 &p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a square of the area of `t`. */ Kernel::FT squared_area() const; -/*! +/*! returns a bounding box containing `t`. */ Bbox_3 bbox() const; -/*! +/*! returns the triangle obtained by applying `at` on the three vertices of `t`. */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Vector_2.h b/Kernel_23/doc/Kernel_23/CGAL/Vector_2.h index 999b280f331..43f3c445e31 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Vector_2.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Vector_2.h @@ -22,7 +22,7 @@ public: /// \name Types /// @{ -/*! +/*! An iterator for enumerating the Cartesian coordinates of a vector. */ @@ -33,48 +33,48 @@ typedef unspecified_type Cartesian_const_iterator; /// \name Creation /// @{ -/*! +/*! introduces the vector `b-a`. */ Vector_2(const Point_2 &a, const Point_2 &b); -/*! +/*! introduces the vector `s.target()-s.source()`. */ Vector_2(const Segment_2 &s); -/*! +/*! introduces the vector having the same direction as `r`. */ Vector_2(const Ray_2 &r); -/*! +/*! introduces the vector having the same direction as `l`. */ Vector_2(const Line_2 &l); -/*! +/*! introduces a null vector `v`. */ Vector_2(const Null_vector &NULL_VECTOR); -/*! +/*! introduces a vector `v` initialized to `(x,y)`. */ Vector_2(int x, int y); -/*! +/*! introduces a vector `v` initialized to `(x,y)`. */ Vector_2(double x, double y); -/*! +/*! introduces a vector `v` initialized to `(hx/hw,hy/hw)`. \pre \f$ hw\neq0\f$. */ Vector_2(const Kernel::RT &hx, const Kernel::RT &hy, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a vector `v` initialized to `(x,y)`. */ Vector_2(const Kernel::FT &x, const Kernel::FT &y); @@ -84,14 +84,14 @@ Vector_2(const Kernel::FT &x, const Kernel::FT &y); /// \name Operations /// @{ -/*! +/*! Test for equality: two vectors are equal, iff their \f$ x\f$ and \f$ y\f$ coordinates are equal. You can compare a vector with the `NULL_VECTOR`. */ bool operator==(const Vector_2 &w) const; -/*! +/*! Test for inequality. You can compare a vector with the `NULL_VECTOR`. */ @@ -107,27 +107,27 @@ bool operator!=(const Vector_2 &w) const; /// `FieldNumberType` is a quotient. /// @{ -/*! +/*! returns the homogeneous \f$ x\f$ coordinate. */ Kernel::RT hx() const; -/*! +/*! returns the homogeneous \f$ y\f$ coordinate. */ Kernel::RT hy() const; -/*! +/*! returns the homogenizing coordinate. */ Kernel::RT hw() const; -/*! +/*! returns the `x`-coordinate of `v`, that is `hx()`/`hw()`. */ Kernel::FT x() const; -/*! +/*! returns the `y`-coordinate of `v`, that is `hy()`/`hw()`. */ Kernel::FT y() const; @@ -141,52 +141,52 @@ Kernel::FT y() const; /// @{ -/*! +/*! returns the i'th homogeneous coordinate of `v`, starting with 0. \pre \f$ 0\leq i \leq2\f$. */ Kernel::RT homogeneous(int i) const; -/*! +/*! returns the i'th Cartesian coordinate of `v`, starting at 0. \pre \f$ 0\leq i \leq1\f$. */ Kernel::FT cartesian(int i) const; -/*! +/*! returns `cartesian(i)`. \pre \f$ 0\leq i \leq1\f$. */ Kernel::FT operator[](int i) const; -/*! +/*! returns an iterator to the Cartesian coordinates of `v`, starting with the 0th coordinate. */ Cartesian_const_iterator cartesian_begin() const; -/*! +/*! returns an off the end iterator to the Cartesian coordinates of `v`. */ Cartesian_const_iterator cartesian_end() const; -/*! +/*! returns the dimension (the constant 2). */ int dimension() const; -/*! +/*! returns the direction which passes through `v`. */ Direction_2 direction() const; -/*! +/*! returns the vector obtained by applying `t` on `v`. */ Vector_2 transform(const Aff_transformation_2 &t) const; -/*! +/*! returns the vector perpendicular to `v` in clockwise or counterclockwise orientation. */ @@ -200,7 +200,7 @@ Vector_2 perpendicular(const Orientation &o) const; /// \ingroup Kernel_operator_plus ///@{ -/*! +/*! Addition. */ Vector_2 operator+(const Vector_2 &w) const; @@ -211,29 +211,29 @@ Vector_2 operator+(const Vector_2 &w) const; /// \ingroup Kernel_operator_minus ///@{ -/*! +/*! Subtraction. */ Vector_2 operator-(const Vector_2 &w) const; /// @} -/*! +/*! returns the opposite vector. */ Vector_2 operator-() const; -/*! +/*! returns the scalar product (= inner product) of the two vectors. */ Kernel::FT operator*(const Vector_2 &w) const; -/*! +/*! Division by a scalar. */ Vector_2 operator/(const Kernel::RT &s) const; -/*! +/*! returns the squared length of `v`. */ Kernel::FT squared_length() const; @@ -246,28 +246,28 @@ Kernel::FT squared_length() const; /// \ingroup Kernel_operator_prod ///@{ -/*! +/*! Multiplication with a scalar from the right. \relates Vector_2 */ Vector_2 operator*(const Vector_2 &v, const Kernel::RT &s); -/*! +/*! Multiplication with a scalar from the right. \relates Vector_2 */ Vector_2 operator*(const Vector_2 &v, const Kernel::FT &s); -/*! +/*! Multiplication with a scalar from the left. \relates Vector_2 */ Vector_2 operator*(const Kernel::RT &s, const Vector_2 &v); -/*! +/*! Multiplication with a scalar from the left. \relates Vector_2 */ diff --git a/Kernel_23/doc/Kernel_23/CGAL/Vector_3.h b/Kernel_23/doc/Kernel_23/CGAL/Vector_3.h index 57cf41ffb4a..e7970222d4b 100644 --- a/Kernel_23/doc/Kernel_23/CGAL/Vector_3.h +++ b/Kernel_23/doc/Kernel_23/CGAL/Vector_3.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! An iterator for enumerating the %Cartesian coordinates of a vector. */ @@ -35,47 +35,47 @@ typedef unspecified_type Cartesian_const_iterator; /// \name Creation /// @{ -/*! +/*! introduces the vector `b-a`. */ Vector_3(const Point_3 &a, const Point_3 &b); -/*! +/*! introduces the vector `s.target()-s.source()`. */ Vector_3(const Segment_3 &s); -/*! +/*! introduces a vector having the same direction as `r`. */ Vector_3(const Ray_3 &r); -/*! +/*! introduces a vector having the same direction as `l`. */ Vector_3(const Line_3 &l); -/*! +/*! introduces a null vector `v`. */ Vector_3(const Null_vector &NULL_VECTOR); -/*! +/*! introduces a vector `v` initialized to `(x, y, z)`. */ Vector_3(int x, int y, int z); -/*! +/*! introduces a vector `v` initialized to `(x, y, z). */ Vector_3(double x, double y, double z); -/*! +/*! introduces a vector `v` initialized to `(hx/hw, hy/hw, hz/hw). */ Vector_3(const Kernel::RT &hx, const Kernel::RT &hy, const Kernel::RT &hz, const Kernel::RT &hw = RT(1)); -/*! +/*! introduces a vector `v` initialized to `(x, y, z)`. */ Vector_3(const Kernel::FT &x, const Kernel::FT &y, const Kernel::FT &z); @@ -85,14 +85,14 @@ Vector_3(const Kernel::FT &x, const Kernel::FT &y, const Kernel::FT &z); /// \name Operations /// @{ -/*! +/*! Test for equality: two vectors are equal, iff their \f$ x\f$, \f$ y\f$ and \f$ z\f$ coordinates are equal. You can compare a vector with the `NULL_VECTOR`. */ bool operator==(const Vector_3 &w) const; -/*! +/*! Test for inequality. You can compare a vector with the `NULL_VECTOR`. */ @@ -108,37 +108,37 @@ bool operator!=(const Vector_3 &w) const; /// `FieldNumberType` is a quotient. /// @{ -/*! +/*! returns the homogeneous \f$ x\f$ coordinate. */ Kernel::RT hx() const; -/*! +/*! returns the homogeneous \f$ y\f$ coordinate. */ Kernel::RT hy() const; -/*! +/*! returns the homogeneous \f$ z\f$ coordinate. */ Kernel::RT hz() const; -/*! +/*! returns the homogenizing coordinate. */ Kernel::RT hw() const; -/*! +/*! returns the `x`-coordinate of `v`, that is `hx()`/`hw()`. */ Kernel::FT x() const; -/*! +/*! returns the `y`-coordinate of `v`, that is `hy()`/`hw()`. */ Kernel::FT y() const; -/*! +/*! returns the `z` coordinate of `v`, that is `hz()`/`hw()`. */ Kernel::FT z() const; @@ -151,47 +151,47 @@ Kernel::FT z() const; /// and homogeneous flavor. /// @{ -/*! +/*! returns the i'th homogeneous coordinate of `v`, starting with 0. \pre \f$ 0\leq i \leq3\f$. */ Kernel::RT homogeneous(int i) const; -/*! +/*! returns the i'th %Cartesian coordinate of `v`, starting at 0. \pre \f$ 0\leq i \leq2\f$. */ Kernel::FT cartesian(int i) const; -/*! +/*! returns `cartesian(i)`. \pre \f$ 0\leq i \leq2\f$. */ Kernel::FT operator[](int i) const; -/*! +/*! returns an iterator to the %Cartesian coordinates of `v`, starting with the 0th coordinate. */ Cartesian_const_iterator cartesian_begin() const; -/*! +/*! returns an off the end iterator to the %Cartesian coordinates of `v`. */ Cartesian_const_iterator cartesian_end() const; -/*! +/*! returns the dimension (the constant 3). */ int dimension() const; -/*! +/*! returns the vector obtained by applying `t` on `v`. */ Vector_3 transform(const Aff_transformation_3 &t) const; -/*! +/*! returns the direction of `v`. */ Direction_3 direction() const; @@ -204,7 +204,7 @@ Direction_3 direction() const; /// \ingroup Kernel_operator_plus ///@{ -/*! +/*! Addition. */ Vector_3 operator+(const Vector_3 &w) const; @@ -214,29 +214,29 @@ Vector_3 operator+(const Vector_3 &w) const; /// \ingroup Kernel_operator_minus ///@{ -/*! +/*! Subtraction. */ Vector_3 operator-(const Vector_3 &w) const; /// @} -/*! +/*! Returns the opposite vector. */ Vector_3 operator-() const; -/*! +/*! Division by a scalar. */ Vector_3 operator/(const Kernel::RT &s) const; -/*! +/*! returns the squared length of `v`. */ Kernel::FT squared_length() const; -/*! +/*! returns the scalar product (= inner product) of the two vectors. */ Kernel::FT operator*(const Vector_3 &w) const; @@ -248,28 +248,28 @@ Kernel::FT operator*(const Vector_3 &w) const; /// \ingroup Kernel_operator_prod ///@{ -/*! +/*! Multiplication with a scalar from the right. \relates Vector_3 */ Vector_3 operator*(const Vector_3 &v, const Kernel::RT &s); -/*! +/*! Multiplication with a scalar from the right. \relates Vector_3 */ Vector_3 operator*(const Vector_3 &v, const Kernel::FT &s); -/*! +/*! Multiplication with a scalar from the left. \relates Vector_3 */ Vector_3 operator*(const Kernel::RT &s, const Vector_3 &v); -/*! +/*! Multiplication with a scalar from the left. \relates Vector_3 */ diff --git a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h index 00b7757c1ff..414dd9cf9d7 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h +++ b/Kernel_23/doc/Kernel_23/Concepts/FunctionObjectConcepts.h @@ -16,14 +16,14 @@ public: /// @{ - /*! + /*! returns \ref CGAL::OBTUSE, \ref CGAL::RIGHT or \ref CGAL::ACUTE depending on the angle formed by the two vectors `u` and `v`. */ Angle operator()(const Kernel::Vector_2&u, const Kernel::Vector_2&v); - /*! + /*! returns \ref CGAL::OBTUSE, \ref CGAL::RIGHT or \ref CGAL::ACUTE depending on the angle formed by the three points `p`, `q`, `r` (`q` being the vertex of the angle). The returned value is the same as `operator()(p - q, r - q)`. @@ -32,7 +32,7 @@ public: const Kernel::Point_2&q, const Kernel::Point_2&r); - /*! + /*! returns \ref CGAL::OBTUSE, \ref CGAL::RIGHT or \ref CGAL::ACUTE depending on the angle formed by the two vectors `pq`, `rs`. The returned value is the same as `operator()(q - p, s - r)`. @@ -63,7 +63,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns \ref CGAL::OBTUSE, \ref CGAL::RIGHT or \ref CGAL::ACUTE depending on the angle formed by the three points `p`, `q`, `r` (`q` being the vertex of the angle). @@ -92,7 +92,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff the three points are collinear and `q` lies between `p` and `r`. Note that `true` is returned, if `q==p` or @@ -122,7 +122,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff the three points are collinear and `q` lies between `p` and `r`. Note that `true` is returned, if `q==p` or @@ -152,21 +152,21 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, if `l1` and `l2` are parallel or if one of those (or both) is degenerate. */ bool operator()(const Kernel::Line_2&l1, const Kernel::Line_2&l2); - /*! + /*! returns `true`, if `r1` and `r2` are parallel or if one of those (or both) is degenerate. */ bool operator()(const Kernel::Ray_2&r1, const Kernel::Ray_2&r2); - /*! + /*! returns `true`, if `s1` and `s2` are parallel or if one of those (or both) is degenerate. */ @@ -193,28 +193,28 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, if `l1` and `l2` are parallel or if one of those (or both) is degenerate. */ bool operator()(const Kernel::Line_3&l1, const Kernel::Line_3&l2); - /*! + /*! returns `true`, if `h1` and `h2` are parallel or if one of those (or both) is degenerate. */ bool operator()(const Kernel::Plane_3&h1, const Kernel::Plane_3&h2); - /*! + /*! returns `true`, if `r1` and `r2` are parallel or if one of those (or both) is degenerate. */ bool operator()(const Kernel::Ray_3&r1, const Kernel::Ray_3&r2); - /*! + /*! returns `true`, if `s1` and `s2` are parallel or if one of those (or both) is degenerate. */ @@ -243,7 +243,7 @@ public: /// @{ - /*! + /*! returns `true`, iff the three points are collinear and `q` lies strictly between `p` and `r`. Note that `false` is returned, if `q==p` or @@ -274,7 +274,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff the three points are collinear and `q` lies strictly between `p` and `r`. Note that `false` is returned, if `q==p` or @@ -308,7 +308,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! assigns `o` to `t` if `o` was constructed from an object of type `T`. Returns `true`, if the assignment was possible. @@ -340,7 +340,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! assigns `o` to `t` if `o` was constructed from an object of type `T`. Returns `true`, if the assignment was possible. @@ -370,7 +370,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns either \ref CGAL::ON_UNBOUNDED_SIDE, \ref CGAL::ON_BOUNDED_SIDE, or the constant \ref CGAL::ON_BOUNDARY, depending on where point `p` is relative to @@ -379,7 +379,7 @@ public: Bounded_side operator()(const Kernel::Circle_2&c, const Kernel::Point_2&p); - /*! + /*! returns either \ref CGAL::ON_UNBOUNDED_SIDE, \ref CGAL::ON_BOUNDED_SIDE, or the constant \ref CGAL::ON_BOUNDARY, depending on where point `p` is relative to @@ -388,7 +388,7 @@ public: Bounded_side operator()(const Kernel::Triangle_2& t, const Kernel::Point_2&p); - /*! + /*! returns either \ref CGAL::ON_UNBOUNDED_SIDE, \ref CGAL::ON_BOUNDED_SIDE, or the constant \ref CGAL::ON_BOUNDARY, depending on where point `p` is relative to @@ -419,7 +419,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns either \ref CGAL::ON_UNBOUNDED_SIDE, \ref CGAL::ON_BOUNDED_SIDE, or the constant \ref CGAL::ON_BOUNDARY, depending on where point `p` is with @@ -428,7 +428,7 @@ public: Bounded_side operator()(const Kernel::Sphere_3& s, const Kernel::Point_3&p); - /*! + /*! returns either \ref CGAL::ON_UNBOUNDED_SIDE, \ref CGAL::ON_BOUNDED_SIDE, or the constant \ref CGAL::ON_BOUNDARY, depending on where point `p` is with @@ -437,7 +437,7 @@ public: Bounded_side operator()(const Kernel::Tetrahedron_3& t, const Kernel::Point_3&p); - /*! + /*! returns either \ref CGAL::ON_UNBOUNDED_SIDE, \ref CGAL::ON_BOUNDED_SIDE, or the constant \ref CGAL::ON_BOUNDARY, depending on where point `p` is with @@ -505,7 +505,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff `q` lies between `p` and `r`. \pre `p, q` and `r` are collinear. */ @@ -534,7 +534,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff `q` lies between `p` and `r`. \pre `p, q` and `r` are collinear. */ @@ -562,7 +562,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff `q` lies strictly between `p` and `r`. \pre `p, q` and `r` are collinear. */ @@ -591,7 +591,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff `q` lies strictly between `p` and `r`. \pre `p, q` and `r` are collinear. */ @@ -621,14 +621,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! checks if point `p` is on `r`. \pre `p` is on the supporting line of `r`. */ bool operator()(const Kernel::Ray_2& r, const Kernel::Point_2&p); - /*! + /*! checks if point `p` is on `s`. \pre `p` is on the supporting line of `s`. */ @@ -655,7 +655,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, if `p`, `q`, and `r` are collinear. */ bool operator()(const Kernel::Point_2&p, @@ -682,7 +682,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, if `p`, `q`, and `r` are collinear. */ bool operator()(const Kernel::Point_3&p, @@ -707,7 +707,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the angles between the positive \f$ x\f$-axis and the directions in counterclockwise order. @@ -732,7 +732,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the dihedral angles \f$ \theta_1\f$ and \f$ \theta_2\f$, where \f$ \theta_1\f$ is the dihedral angle, in \f$ [0, \pi]\f$, of the tetrahedron \f$ (a_1, b_1, c_1, d_1)\f$ at the edge `(a_1, b_1)`, and \f$ \theta_2\f$ is @@ -746,7 +746,7 @@ public: const K::Point_3& d1, const K::FT& cosine); - /*! + /*! compares the dihedral angles \f$ \theta_1\f$ and \f$ \theta_2\f$, where \f$ \theta_i\f$ is the dihedral angle in the tetrahedron `(a_i, b_i, c_i, d_i)` at the edge `(a_i, b_i)`. These two angles are computed @@ -763,7 +763,7 @@ public: const K::Point_3& c2, const K::Point_3& d2); - /*! + /*! compares the dihedral angles \f$ \theta_1\f$ and \f$ \theta_2\f$, where \f$ \theta_1\f$ is the dihedral angle, in \f$ [0, \pi]\f$, between the vectorial planes defined by `(u_1, v_1)` and `(u_1, w_1)`, and @@ -776,7 +776,7 @@ public: const K::Vector_3& w1, const K::FT& cosine); - /*! + /*! compares the dihedral angles \f$ \theta_1\f$ and \f$ \theta_2\f$, where \f$ \theta_i\f$ is the dihedral angle between the vectorial planes defined by `(u_i, v_i)` and `(u_i, w_i)`. These two angles are @@ -812,7 +812,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the squared distance between `obj1` and `obj2` to the squared distance between `obj1` and `obj3`, for all triples of types `Type1`, `Type2` and`Type3` @@ -828,7 +828,7 @@ public: const Type2& obj2, const Type3& obj3); - /*! + /*! compares the squared distance between `obj1` and `obj2` to the squared distance between `obj3` and `obj4`, for all tuples of types `Type1`, `Type2`, `Type3` @@ -867,7 +867,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the squared distance between `obj1` and `obj2` to the squared distance between `obj1` and `obj3`, for all triples of types `Type1`, `Type2` and `Type3` in the following set of types: @@ -881,7 +881,7 @@ public: const Type2& obj2, const Type3& obj3); - /*! + /*! compares the squared distance between `obj1` and `obj2` to the squared distance between `obj3` and `obj4`, for all tuples of types `Type1`, `Type2`, `Type3` and `Type4` in the following set of types: @@ -917,13 +917,13 @@ public: /// @{ - /*! + /*! compares the slopes of the lines `l1` and `l2` */ Comparison_result operator()(const Kernel::Line_2& l1, const Kernel::Line_2& l2); - /*! + /*! compares the slopes of the segments `s1` and `s2` */ Comparison_result operator()(const Kernel::Segment_2& s1, @@ -950,7 +950,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the squared distance between the two geometrical objects `obj1` and `obj2` to the value `d2`, where the types `Type1` and `Type2` can be any of the following: @@ -987,7 +987,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the squared distance between the two geometrical objects `obj1` and `obj2` to the value `d2`, for all pairs `Type1` and `Type2`, where the types `Type1` and `Type2` can be any of the following: @@ -1021,7 +1021,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the squared radius of the sphere of radius 0 centered at `p` to `sr`. This returns the opposite sign of `sr`. @@ -1029,7 +1029,7 @@ public: Comparison_result operator()(const Kernel::Point_3& p, const Kernel::FT& sr); - /*! + /*! compares the squared radius of the sphere defined by the points `p` and `q` to `sr`. */ @@ -1037,7 +1037,7 @@ public: const Kernel::Point_3&q, const Kernel::FT& sr); - /*! + /*! compares the squared radius of the sphere defined by the points `p`, `q`, and `r` to `sr`. */ @@ -1046,7 +1046,7 @@ public: const Kernel::Point_3&r, const Kernel::FT& sr); - /*! + /*! compares the squared radius of the sphere defined by the points `p`, `q`, `r`, and `s` to `sr`. */ @@ -1080,7 +1080,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the \f$ x\f$-coordinates of `p` and the horizontal projection of `p` on `h`. See Figure \ref fig-compare_x_at_y_2 (a). @@ -1088,7 +1088,7 @@ public: Comparison_result operator()(const Kernel::Point_2 &p, const Kernel::Line_2 &h); - /*! + /*! compares the \f$ x\f$-coordinates of the horizontal projection of `p` on `h1` and on `h2`. See Figure \ref fig-compare_x_at_y_2 (b). @@ -1098,7 +1098,7 @@ public: const Kernel::Line_2 &h1, const Kernel::Line_2 &h2); - /*! + /*! Let `p` be the intersection of lines `l1` and `l2`. This function compares the \f$ x\f$-coordinates of `p` and the horizontal projection of `p` on `h`. @@ -1109,7 +1109,7 @@ public: const Kernel::Line_2 &l2, const Kernel::Line_2 &h); - /*! + /*! Let `p` be the intersection of lines `l1` and `l2`. This function compares the \f$ x\f$-coordinates of the horizontal projection of `p` on `h1` and on `h2`. @@ -1141,7 +1141,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! Compares the Cartesian coordinates of points `p` and `q` lexicographically in \f$ xyz\f$ order: first \f$ x\f$-coordinates are compared, if they are equal, \f$ y\f$-coordinates @@ -1171,7 +1171,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! Compares the Cartesian coordinates of points `p` and `q` lexicographically in \f$ xy\f$ order: first \f$ x\f$-coordinates are compared, if they are equal, \f$ y\f$-coordinates @@ -1201,7 +1201,7 @@ public: /// @{ - /*! + /*! Compares the Cartesian coordinates of points `p` and `q` lexicographically in \f$ xy\f$ order: first \f$ x\f$-coordinates are compared, if they are equal, \f$ y\f$-coordinates @@ -1233,13 +1233,13 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the Cartesian \f$ x\f$-coordinates of points `p` and `q` */ Comparison_result operator()(const Kernel::Point_2&p, const Kernel::Point_2&q); - /*! + /*! compares the \f$ x\f$-coordinates of `p` and the intersection of lines `l1` and `l2`. See Figure \ref fig-compare12 (a). @@ -1248,7 +1248,7 @@ public: const Kernel::Line_2 &l1, const Kernel::Line_2 &l2); - /*! + /*! compares the `x`-coordinates of the intersection of line `l` with line `h1` and with line `h2`. @@ -1258,7 +1258,7 @@ public: const Kernel::Line_2 &h1, const Kernel::Line_2 &h2); - /*! + /*! compares the \f$ x\f$-coordinates of the intersection of lines `l1` and `l2` and the intersection of lines `h1` and `h2`. @@ -1289,7 +1289,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! Compares the Cartesian \f$ x\f$-coordinates of points `p` and `q` */ @@ -1320,7 +1320,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compares the \f$ y\f$-coordinates of `p` and the vertical projection of `p` on `h`. See Figure \ref fig-compare2 (e). \pre `h` is not vertical. @@ -1328,7 +1328,7 @@ public: Comparison_result operator()(const Kernel::Point_2 &p, const Kernel::Line_2 &h); - /*! + /*! This function compares the `y`-coordinates of the vertical projection of `p` on `h1` and on `h2`. See Figure \ref fig-compare2 (e). \pre `h1` and `h2` are not vertical. @@ -1337,7 +1337,7 @@ public: const Kernel::Line_2 &h1, const Kernel::Line_2 &h2); - /*! + /*! Let `p` be the intersection of lines `l1` and `l2`. This function compares the \f$ y\f$-coordinates of `p` and the vertical projection of `p` on `h`. @@ -1349,7 +1349,7 @@ public: const Kernel::Line_2 &l2, const Kernel::Line_2 &h); - /*! + /*! Let `p` be the intersection of lines `l1` and `l2`. This function compares the `y`-coordinates of the vertical projection of `p` on `h1` and on `h2`. @@ -1362,7 +1362,7 @@ public: const Kernel::Line_2 &h1, const Kernel::Line_2 &h2); - /*! + /*! compares the `y`-coordinates of `p` and the vertical projection of `p` on `s`. If `s` is vertical, then return \ref CGAL::EQUAL when `p` lies on `s`, \ref CGAL::SMALLER when `p` lies @@ -1373,7 +1373,7 @@ public: Comparison_result operator()(const Kernel::Point_2 &p, const Kernel::Segment_2 &s); - /*! + /*! This function compares the \f$ y\f$-coordinates of the vertical projection of `p` on `s1` and on `s2`. If `s1` or `s2` is vertical, then return \ref CGAL::EQUAL if they intersect, otherwise return @@ -1407,7 +1407,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! Compares the Cartesian coordinates of points `p` and `q` lexicographically in \f$ yx\f$ order: first \f$ y\f$-coordinates are compared, if they are equal, \f$ x\f$-coordinates @@ -1439,14 +1439,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! Compares the Cartesian \f$ y\f$-coordinates of points `p` and `q` */ Comparison_result operator()(const Kernel::Point_2&p, const Kernel::Point_2&q); - /*! + /*! compares the \f$ y\f$-coordinates of `p` and the intersection of lines `l1` and `l2`. @@ -1456,7 +1456,7 @@ public: const Kernel::Line_2 &l1, const Kernel::Line_2 &l2); - /*! + /*! compares the \f$ y\f$-coordinates of the intersection of line `l` with line `h1` and with line `h2`. @@ -1466,7 +1466,7 @@ public: const Kernel::Line_2 &h1, const Kernel::Line_2 &h2); - /*! + /*! compares the \f$ y\f$-coordinates of the intersection of lines `l1` and `l2` and the intersection of lines `h1` and `h2`. @@ -1498,7 +1498,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! Compares the Cartesian \f$ y\f$-coordinates of points `p` and `q` */ @@ -1525,7 +1525,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! Compares the Cartesian \f$ z\f$-coordinates of points `p` and `q` */ @@ -1551,7 +1551,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the coefficient `a` of the line with equation `ax +by + c = 0`. */ Kernel::FT operator()(const Kernel::Line_2& l) const; @@ -1599,7 +1599,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an approximation of the area of `c`. */ double operator()(const Kernel::Circle_3& c); @@ -1624,7 +1624,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an approximation of the squared length (i.e.\ perimeter) of `c`. */ double operator()(const Kernel::Circle_3& c); @@ -1649,7 +1649,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the area of `c`, divided by \f$ \pi\f$. */ Kernel::FT operator()(const Kernel::Circle_3& c); @@ -1675,7 +1675,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the signed area of the triangle defined by the points `p`, `q` and `r`. */ @@ -1683,12 +1683,12 @@ public: const Kernel::Point_2& q, const Kernel::Point_2& r); - /*! + /*! returns the area of `r`. */ Kernel::FT operator()(const Kernel::Iso_rectangle_2& r); - /*! + /*! returns the signed area of `t`. */ Kernel::FT operator()(const Kernel::Triangle_2& t); @@ -1713,13 +1713,13 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the area of `t`. This requires that `Kernel::FT` supports the `sqrt` operation. */ Kernel::FT operator()(const Kernel::Triangle_3& t); - /*! + /*! returns the area of the triangle `p`, `q`, `r`. This requires that `Kernel::FT` supports the `sqrt` operation. */ @@ -1745,7 +1745,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the coefficient `b` of the line with equation `ax +by + c = 0`. */ Kernel::FT operator()(const Kernel::Line_2& l) const; @@ -1793,7 +1793,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the coefficient `c` of the line with equation `ax +by + c = 0`. */ Kernel::FT operator()(const Kernel::Line_2& l) const; @@ -1868,7 +1868,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the determinant of the two vectors `v` and `w`. */ Kernel::FT operator()(const Kernel::Vector_2& v, @@ -1895,7 +1895,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the determinant of the three vectors `u`, `v` and `w`. */ Kernel::FT operator()(const Kernel::Vector_3& u, @@ -1922,7 +1922,7 @@ public: /// @{ - /*! + /*! returns an \f$ x\f$-coordinate of the direction. */ Kernel::FT operator()(const Kernel::Direction_2& d) const; @@ -1969,7 +1969,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an \f$ y\f$-coordinate of the direction. */ Kernel::FT operator()(const Kernel::Direction_2& d) const; @@ -1992,7 +1992,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an \f$ y\f$-coordinate of the direction. */ Kernel::FT operator()(const Kernel::Direction_3& d) const; @@ -2015,7 +2015,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an \f$ z\f$-coordinate of the direction. */ Kernel::FT operator()(const Kernel::Direction_3& d) const; @@ -2038,12 +2038,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the homogeneous \f$ x\f$-coordinate of the point. */ Kernel::FT operator()(const Kernel::Point_2& p) const; - /*! + /*! returns the homogeneous \f$ x\f$-coordinate of the vector. */ Kernel::FT operator()(const Kernel::Vector_2& v) const; @@ -2094,12 +2094,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the homogeneous \f$ y\f$-coordinate of the point. */ Kernel::FT operator()(const Kernel::Point_2& p) const; - /*! + /*! returns the homogeneous \f$ y\f$-coordinate of the vector. */ Kernel::FT operator()(const Kernel::Vector_2& v) const; @@ -2236,7 +2236,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the scalar (inner) product of the two vectors `v` and `w`. */ Kernel::FT operator()(const Kernel::Vector_2& v, @@ -2262,7 +2262,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the scalar (inner) product of the two vectors `v` and `w`. */ Kernel::FT operator()(const Kernel::Vector_3& v, @@ -2289,12 +2289,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the square of the area of `t`. */ Kernel::FT operator()(const Kernel::Triangle_3& t); - /*! + /*! returns the square of the area of the triangle `p`, `q`, `r`. */ Kernel::FT operator()(const Kernel::Point_3& p, @@ -2321,7 +2321,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the squared distance between two geometrical objects of type for all pairs `Type1` and `Type2`, where the types `Type1` and `Type2` can be any of the following: @@ -2355,7 +2355,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the squared distance between two geometrical objects of type `Type1` and `Type2`, for all pairs `Type1` and `Type2`, where the types `Type1` and `Type2` can be any of the @@ -2389,7 +2389,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the squared length of `c`, divided by \f$ \pi^2\f$. */ Kernel::FT operator()(const Kernel::Circle_3& c); @@ -2416,12 +2416,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the squared length of `v`. */ Kernel::FT operator()(const Kernel::Vector_2& v); - /*! + /*! returns the squared length of `s`. */ Kernel::FT operator()(const Kernel::Segment_2& s); @@ -2447,12 +2447,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the squared length of `v`. */ Kernel::FT operator()(const Kernel::Vector_3& v); - /*! + /*! returns the squared length of `s`. */ Kernel::FT operator()(const Kernel::Segment_3& s); @@ -2478,12 +2478,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the squared radius of `c`. */ Kernel::FT operator()(const Kernel::Circle_2& c); - /*! + /*! returns the squared radius of the circle passing through `p`, `q` and `r`. \pre `p, q` and `r` are not collinear. */ @@ -2491,14 +2491,14 @@ public: const Kernel::Point_2& q, const Kernel::Point_2& r); - /*! + /*! returns the squared radius of the smallest circle passing through `p`, and `q`, i.e.\ one fourth of the squared distance between `p` and `q`. */ Kernel::FT operator()(const Kernel::Point_2& p, const Kernel::Point_2& q); - /*! + /*! returns the squared radius of the smallest circle passing through `p`, i.e.\ \f$ 0\f$. */ Kernel::FT operator()(const Kernel::Point_2& p); @@ -2527,17 +2527,17 @@ public: /// @{ - /*! + /*! returns the squared radius of `s`. */ Kernel::FT operator()(const Kernel::Sphere_3& s); - /*! + /*! returns the squared radius of `c`. */ Kernel::FT operator()(const Kernel::Circle_3& c); - /*! + /*! returns the squared radius of the sphere passing through `p`, `q`, `r` and `s`. \pre `p, q, r` and `s` are not coplanar. */ @@ -2546,7 +2546,7 @@ public: const Kernel::Point_3& r, const Kernel::Point_3& s); - /*! + /*! returns the squared radius of the sphere passing through `p`, `q` and `r`, and whose center is in the plane defined by these three points. */ @@ -2554,14 +2554,14 @@ public: const Kernel::Point_3& q, const Kernel::Point_3& r); - /*! + /*! returns the squared radius of the smallest circle passing through `p`, and `q`, i.e.\ one fourth of the squared distance between `p` and `q`. */ Kernel::FT operator()(const Kernel::Point_3& p, const Kernel::Point_3& q); - /*! + /*! returns the squared radius of the smallest circle passing through `p`, i.e.\ \f$ 0\f$. */ Kernel::FT operator()(const Kernel::Point_3& p); @@ -2589,17 +2589,17 @@ public: /// @{ - /*! + /*! returns the volume of `c`. */ Kernel::FT operator()(const Kernel::Iso_cuboid_3& c); - /*! + /*! returns the signed volume of `t`. */ Kernel::FT operator()(const Kernel::Tetrahedron_3& t); - /*! + /*! returns the signed volume of the tetrahedron defined by the four points `p0`, `p1`, `p2`, `p3`. */ @@ -2627,12 +2627,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the \f$ x\f$-coordinate of the point. */ Kernel::FT operator()(const Kernel::Point_2& p) const; - /*! + /*! returns the \f$ x\f$-coordinate of the vector. */ Kernel::FT operator()(const Kernel::Vector_2& v) const; @@ -2656,12 +2656,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the \f$ x\f$-coordinate of the point. */ Kernel::FT operator()(const Kernel::Point_3& p) const; - /*! + /*! returns the \f$ x\f$-coordinate of the vector. */ Kernel::FT operator()(const Kernel::Vector_3& v) const; @@ -2684,7 +2684,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the largest \f$ x\f$-coordinate of the iso-rectangle. */ Kernel::FT operator()(const Kernel::Iso_rectangle_2& r) const; @@ -2730,7 +2730,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the smallest \f$ x\f$-coordinate of the iso-rectangle. */ Kernel::FT operator()(const Kernel::Iso_rectangle_2& r) const; @@ -2753,7 +2753,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the smallest \f$ x\f$-coordinate of the iso-cuboid. */ Kernel::FT operator()(const Kernel::Iso_cuboid_3& r) const; @@ -2778,7 +2778,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the \f$ y\f$-coordinate of the point at `l` with given \f$ x\f$-coordinate. \pre `l` is not vertical. @@ -2804,12 +2804,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the \f$ y\f$-coordinate of the point. */ Kernel::FT operator()(const Kernel::Point_2& p) const; - /*! + /*! returns the \f$ y\f$-coordinate of the vector. */ Kernel::FT operator()(const Kernel::Vector_2& v) const; @@ -2832,12 +2832,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the \f$ y\f$-coordinate of the point. */ Kernel::FT operator()(const Kernel::Point_3& p) const; - /*! + /*! returns the \f$ y\f$-coordinate of the vector. */ Kernel::FT operator()(const Kernel::Vector_3& v) const; @@ -2860,7 +2860,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the largest \f$ y\f$-coordinate of the iso-rectangle. */ Kernel::FT operator()(const Kernel::Iso_rectangle_2& r) const; @@ -2906,7 +2906,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the smallest \f$ y\f$-coordinate of the iso-rectangle. */ Kernel::FT operator()(const Kernel::Iso_rectangle_2& r) const; @@ -2948,12 +2948,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the \f$ z\f$-coordinate of the point. */ Kernel::FT operator()(const Kernel::Point_3& p) const; - /*! + /*! returns the \f$ z\f$-coordinate of the vector. */ Kernel::FT operator()(const Kernel::Vector_3& v) const; @@ -3022,7 +3022,7 @@ public: /// @{ - /*! + /*! compute the barycenter of the points `p1` and `p2` with corresponding weights `w1` and `1-w1`. */ @@ -3030,7 +3030,7 @@ public: operator()( const Kernel::Point_2& p1, const Kernel::FT&w1, const Kernel::Point_2& p2); - /*! + /*! compute the barycenter of the points `p1` and `p2` with corresponding weights `w1` and `w2`. \pre `w1+w2 != 0`. */ @@ -3038,7 +3038,7 @@ public: operator()( const Kernel::Point_2& p1, const Kernel::FT&w1, const Kernel::Point_2& p2, const Kernel::FT&w2); - /*! + /*! compute the barycenter of the points `p1`, `p2` and `p3` with corresponding weights `w1`, `w2` and `1-w1-w2`. */ @@ -3047,7 +3047,7 @@ public: const Kernel::Point_2& p2, const Kernel::FT&w2, const Kernel::Point_2& p3); - /*! + /*! compute the barycenter of the points `p1`, `p2` and `p3` with corresponding weights `w1`, `w2` and `w3`. \pre `w1+w2+w3 != 0`. */ @@ -3056,7 +3056,7 @@ public: const Kernel::Point_2& p2, const Kernel::FT&w2, const Kernel::Point_2& p3, const Kernel::FT&w3); - /*! + /*! compute the barycenter of the points `p1`, `p2`, `p3` and `p4` with corresponding weights `w1`, `w2`, `w3` and `1-w1-w2-w3`. */ @@ -3066,7 +3066,7 @@ public: const Kernel::Point_2& p3, const Kernel::FT&w3, const Kernel::Point_2& p4); - /*! + /*! compute the barycenter of the points `p1`, `p2`, `p3` and `p4` with corresponding weights `w1`, `w2`, `w3` and `w4`. \pre `1+w2+w3+w4 != 0.` */ @@ -3099,7 +3099,7 @@ public: /// @{ - /*! + /*! compute the barycenter of the points `p1` and `p2` with corresponding weights `w1` and `1-w1`. */ @@ -3107,7 +3107,7 @@ public: operator()( const Kernel::Point_3& p1, const Kernel::FT&w1, const Kernel::Point_3& p2); - /*! + /*! compute the barycenter of the points `p1` and `p2` with corresponding weights `w1` and `w2`. \pre `w1+w2 != 0`. */ @@ -3115,7 +3115,7 @@ public: operator()( const Kernel::Point_3& p1, const Kernel::FT&w1, const Kernel::Point_3& p2, const Kernel::FT&w2); - /*! + /*! compute the barycenter of the points `p1`, `p2` and `p3` with corresponding weights `w1`, `w2` and `1-w1-w2`. */ @@ -3124,7 +3124,7 @@ public: const Kernel::Point_3& p2, const Kernel::FT&w2, const Kernel::Point_3& p3); - /*! + /*! compute the barycenter of the points `p1`, `p2` and `p3` with corresponding weights `w1`, `w2` and `w3`. \pre `w1+w2+w3 != 0`. */ @@ -3133,7 +3133,7 @@ public: const Kernel::Point_3& p2, const Kernel::FT&w2, const Kernel::Point_3& p3, const Kernel::FT&w3); - /*! + /*! compute the barycenter of the points `p1`, `p2`, `p3` and `p4` with corresponding weights `w1`, `w2`, `w3` and `1-w1-w2-w3`. */ @@ -3143,7 +3143,7 @@ public: const Kernel::Point_3& p3, const Kernel::FT&w3, const Kernel::Point_3& p4); - /*! + /*! compute the barycenter of the points `p1`, `p2`, `p3` and `p4` with corresponding weights `w1`, `w2`, `w3` and `w4`. \pre `w1+w2+w3+w4 != 0`. */ @@ -3174,7 +3174,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! when `index` == 1, returns a vector `b1` that is orthogonal to the normal `n` to plane `h`; when `index` == 2, returns a vector `b2` that is orthogonal to `n` and `b1` and such that @@ -3202,31 +3202,31 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns a bounding box of `p`. */ CGAL::Bbox_2 operator()(const Kernel::Point_2 &p); - /*! + /*! returns a bounding box of `s`. */ CGAL::Bbox_2 operator()(const Kernel::Segment_2 &s); - /*! + /*! returns a bounding box of `t`. */ CGAL::Bbox_2 operator()(const Kernel::Triangle_2 &t); - /*! + /*! returns a bounding box of `i`. */ CGAL::Bbox_2 operator()(const Kernel::Iso_rectangle_2 &i); - /*! + /*! returns a bounding box of `c`. */ CGAL::Bbox_2 operator()(const Kernel::Circle_2 @@ -3250,43 +3250,43 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns a bounding box of `c`. */ CGAL::Bbox_3 operator()(const Kernel::Circle_3 &c); - /*! + /*! returns a bounding box of `p`. */ CGAL::Bbox_3 operator()(const Kernel::Point_3 &p); - /*! + /*! returns a bounding box of `s`. */ CGAL::Bbox_3 operator()(const Kernel::Segment_3 &s); - /*! + /*! returns a bounding box of `t`. */ CGAL::Bbox_3 operator()(const Kernel::Triangle_3 &t); - /*! + /*! returns a bounding box of `t`. */ CGAL::Bbox_3 operator()(const Kernel::Tetrahedron_3 &t); - /*! + /*! returns a bounding box of `i`. */ CGAL::Bbox_3 operator()(const Kernel::Iso_Cuboid_3 &i); - /*! + /*! returns a bounding box of `s`. */ CGAL::Bbox_3 operator()(const Kernel::Sphere_3 @@ -3312,7 +3312,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! constructs the bisector of `p` and `q`. The bisector is oriented in such a way that `p` lies on its positive side. \pre `p` and `q` are not equal. @@ -3320,7 +3320,7 @@ public: Kernel::Line_2 operator()(const Kernel::Point_2&p, const Kernel::Point_2&q ); - /*! + /*! constructs the bisector of the two lines `l1` and `l2`. In the general case, the bisector has the direction of the vector which is the sum of the normalized directions of the two lines, and which passes @@ -3355,7 +3355,7 @@ public: /// @{ - /*! + /*! constructs the bisector plane of `p` and `q`. The bisector is oriented in such a way that `p` lies on its positive side. \pre `p` and `q` are not equal. @@ -3363,7 +3363,7 @@ public: Kernel::Plane_3 operator()(const Kernel::Point_3&p, const Kernel::Point_3&q ); - /*! + /*! constructs the bisector of the two planes `h1` and `h2`. In the general case, the bisector has a normal vector which has the same direction as the sum of the normalized normal vectors of the two planes, and @@ -3399,25 +3399,25 @@ public: /// @{ - /*! + /*! returns an iterator on the 0'th Cartesian coordinate of `p`. */ Kernel::Cartesian_const_iterator_2 operator()(const Kernel::Point_2 &p); - /*! + /*! returns the past the end iterator of the Cartesian coordinates of `p`. */ Kernel::Cartesian_const_iterator_2 operator()(const Kernel::Point_2 &p, int); - /*! + /*! returns an iterator on the 0'th Cartesian coordinate of `v`. */ Kernel::Cartesian_const_iterator_2 operator()(const Kernel::Vector_2 &v); - /*! + /*! returns the past the end iterator of the Cartesian coordinates of `v`. */ Kernel::Cartesian_const_iterator_2 operator()(const Kernel::Vector_2 @@ -3444,25 +3444,25 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an iterator on the 0'th Cartesian coordinate of `p`. */ Kernel::Cartesian_const_iterator_3 operator()(const Kernel::Point_3 &p); - /*! + /*! returns the past the end iterator of the Cartesian coordinates of `p`. */ Kernel::Cartesian_const_iterator_3 operator()(const Kernel::Point_3 &p, int); - /*! + /*! returns an iterator on the 0'th Cartesian coordinate of `v`. */ Kernel::Cartesian_const_iterator_3 operator()(const Kernel::Vector_3 &v); - /*! + /*! returns the past the end iterator of the Cartesian coordinates of `v`. */ Kernel::Cartesian_const_iterator_3 operator()(const Kernel::Vector_3 @@ -3488,7 +3488,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compute the center of the circle `c`. */ Kernel::Point_2 operator()(const Kernel::Circle_2 & c); @@ -3514,12 +3514,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compute the center of the sphere `s`. */ Kernel::Point_3 operator()(const Kernel::Sphere_3 & s); - /*! + /*! compute the center of the circle `c`. */ Kernel::Point_3 operator()(const Kernel::Circle_3 & c); @@ -3547,14 +3547,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compute the centroid of the points `p`, `q`, and `r`. */ Kernel::Point_2 operator()(const Kernel::Point_2&p, const Kernel::Point_2&q, const Kernel::Point_2&r); - /*! + /*! compute the centroid of the points `p`, `q`, `r` and `s`. */ Kernel::Point_2 operator()(const Kernel::Point_2&p, @@ -3562,7 +3562,7 @@ public: const Kernel::Point_2&r, const Kernel::Point_2&s); - /*! + /*! compute the centroid of the triangle `t`. */ Kernel::Point_2 operator()(const Kernel::Triangle_2&t); @@ -3589,14 +3589,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compute the centroid of the points `p`, `q`, and `r`. */ Kernel::Point_3 operator()(const Kernel::Point_3&p, const Kernel::Point_3&q, const Kernel::Point_3&r); - /*! + /*! compute the centroid of the points `p`, `q`, `r` and `s`. */ Kernel::Point_3 operator()(const Kernel::Point_3&p, @@ -3604,12 +3604,12 @@ public: const Kernel::Point_3&r, const Kernel::Point_3&s); - /*! + /*! compute the centroid of the triangle `t`. */ Kernel::Point_3 operator()(const Kernel::Triangle_3&t); - /*! + /*! compute the centroid of the tetrahedron `t`. */ Kernel::Point_3 operator()(const Kernel::Tetrahedron_3&t); @@ -3634,7 +3634,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a variable of type `Kernel::Circle_2`. It is initialized to the circle with center `center`, @@ -3647,7 +3647,7 @@ public: Orientation const& orientation = COUNTERCLOCKWISE); - /*! + /*! introduces a variable of type `Kernel::Circle_2`. It is initialized to the unique circle which passes through @@ -3660,7 +3660,7 @@ public: Kernel::Point_2 const& q, Kernel::Point_2 const& r); - /*! + /*! introduces a variable of type `Kernel::Circle_2`. It is initialized to the circle with diameter `pq` @@ -3672,7 +3672,7 @@ public: Orientation const& orientation = COUNTERCLOCKWISE); - /*! + /*! introduces a variable of type `Kernel::Circle_2`. It is initialized to the circle with center `center`, squared @@ -3705,7 +3705,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a variable of type `Kernel::Circle_3`. It is initialized to the circle with center `center`, and squared radius `sq_r` in the plane `plane`. @@ -3716,7 +3716,7 @@ public: Kernel::FT const& sq_r, Kernel::Plane_3 const& plane); - /*! + /*! introduces a variable of type `Kernel::Circle_3`. It is initialized to the circle with center `center`, and squared radius `sq_r` in the plane @@ -3728,7 +3728,7 @@ public: Kernel::FT const& sq_r, Kernel::Vector_3 const& n); - /*! + /*! introduces a variable of type `Kernel::Point_3`. It is initialized to the circle passing through the three points. \pre The three points are not collinear. @@ -3738,7 +3738,7 @@ public: Kernel::Point_3 const& q, Kernel::Point_3 const& r); - /*! + /*! introduces a variable of type `Kernel::Circle_3`. It is initialized to the circle along which the two spheres intersect. \pre The two spheres intersect along a circle. @@ -3747,7 +3747,7 @@ public: ( Kernel::Sphere_3 const& sphere1, Kernel::Sphere_3 const& sphere2); - /*! + /*! introduces a variable of type `Kernel::Circle_3`. It is initialized to the circle along which the sphere and the plane intersect. @@ -3757,7 +3757,7 @@ public: ( Kernel::Sphere_3 const& sphere, Kernel::Plane_3 const& plane); - /*! + /*! introduces a variable of type `Kernel::Circle_3`. It is initialized to the circle along which the sphere and the plane intersect. @@ -3787,13 +3787,13 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compute the center of the smallest circle passing through the points `p` and `q`. Note : this is the same as `Kernel::ConstructMidpoint_2`. */ Kernel::Point_2 operator()(const Kernel::Point_2&p, const Kernel::Point_2&q); - /*! + /*! compute the center of the circle passing through the points `p`, `q`, and `r`. \pre `p`, `q`, and `r` are not collinear. */ @@ -3801,7 +3801,7 @@ public: const Kernel::Point_2&q, const Kernel::Point_2&r); - /*! + /*! compute the center of the circle passing through the three vertices of `t`. \pre `t` is not degenerate. */ @@ -3827,14 +3827,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! compute the center of the smallest circle passing through the points `p` and `q`. Note : this is the same as `Kernel::ConstructMidpoint_3`. */ Kernel::Point_3 operator()(const Kernel::Point_3&p, const Kernel::Point_3&q); - /*! + /*! compute the center of the sphere passing through the points `p`, `q`, `r`, and `s`. \pre `p`, `q`, `r`, and `s` are not coplanar. */ @@ -3843,13 +3843,13 @@ public: const Kernel::Point_3&r, const Kernel::Point_3&s); - /*! + /*! compute the center of the sphere passing through the vertices of `t`. \pre `t` is not degenerate. */ Kernel::Point_3 operator()(const Kernel::Tetrahedron_3&t); - /*! + /*! compute the center of the circle passing through the points `p`, `q` and `r`. \pre `p`, `q` and `r` are not collinear. */ @@ -3857,7 +3857,7 @@ public: const Kernel::Point_3&q, const Kernel::Point_3&r); - /*! + /*! compute the center of the circle passing through the vertices of `t`. \pre `t` is not degenerate. */ @@ -3884,7 +3884,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! computes the cross product of `v` and `w`. */ Kernel::Vector_3 operator()(const Kernel::Vector_3 &v, @@ -3910,7 +3910,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces the vector `v1 - v2`. */ Kernel::Vector_2 operator()(const Kernel::Vector_2 &v1, @@ -3936,7 +3936,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces the vector `v1 - v2`. */ Kernel::Vector_3 operator()(const Kernel::Vector_3 &v1, @@ -3963,22 +3963,22 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces the direction of vector `v`. */ Kernel::Direction_2 operator()(const Kernel::Vector_2 &v); - /*! + /*! introduces the direction of line `l`. */ Kernel::Direction_2 operator()(const Kernel::Line_2 &l); - /*! + /*! introduces the direction of ray `r`. */ Kernel::Direction_2 operator()(const Kernel::Ray_2 &r); - /*! + /*! introduces the direction of segment `s`. */ Kernel::Direction_2 operator()(const Kernel::Segment_2 &s); @@ -4004,23 +4004,23 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a direction initialized with the direction of vector `v`. */ Kernel::Direction_3 operator()(const Kernel::Vector_3 &v); - /*! + /*! introduces the direction of line `l`. */ Kernel::Direction_3 operator()(const Kernel::Line_3 &l); - /*! + /*! introduces the direction of ray `r`. */ Kernel::Direction_3 operator()(const Kernel::Ray_3 &r); - /*! + /*! introduces the direction of segment `s`. */ Kernel::Direction_3 operator()(const Kernel::Segment_3 &s); @@ -4045,7 +4045,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces the vector `v/s`. */ Kernel::Vector_2 operator()(const Kernel::Vector_2 &v, @@ -4071,7 +4071,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces the vector `v/s`. */ Kernel::Vector_3 operator()(const Kernel::Vector_3 &v, @@ -4097,7 +4097,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! constructs the line which is at the same distance from the three points `p`, `q` and `r`. \pre `p`, `q` and `r` are not collinear. @@ -4126,7 +4126,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces an iso-oriented cuboid with diagonal opposite vertices `p` and `q` such that `p` is the lexicographically smallest point in the cuboid. @@ -4134,7 +4134,7 @@ public: Kernel::Iso_cuboid_3 operator()(const Kernel::Point_3 &p, const Kernel::Point_3 &q); - /*! + /*! introduces an iso-oriented cuboid with diagonal opposite vertices `p` and `q`. The `int` argument value is only used to distinguish the two overloaded functions. @@ -4144,7 +4144,7 @@ public: const Kernel::Point_3 &q, int); - /*! + /*! introduces an iso-oriented cuboid `fo` whose minimal \f$ x\f$ coordinate is the one of `left`, the maximal \f$ x\f$ coordinate is the one of `right`, the @@ -4182,7 +4182,7 @@ public: /// @{ - /*! + /*! introduces an iso-oriented rectangle with diagonal opposite vertices `p` and `q` such that `p` is the lexicographically smallest point in the rectangle. @@ -4190,7 +4190,7 @@ public: Kernel::Iso_rectangle_2 operator()(const Kernel::Point_2 &p, const Kernel::Point_2 &q); - /*! + /*! introduces an iso-oriented rectangle with diagonal opposite vertices `p` and `q`. The `int` argument value is only used to distinguish the two overloaded functions. @@ -4200,7 +4200,7 @@ public: const Kernel::Point_2 &q, int); - /*! + /*! introduces an iso-oriented rectangle `fo` whose minimal \f$ x\f$ coordinate is the one of `left`, the maximal \f$ x\f$ coordinate is the one of `right`, the @@ -4234,7 +4234,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns a point `q` on plane `h`, such that the projection of this point onto the \f$ xy\f$-plane is `p`. */ @@ -4261,34 +4261,34 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a line passing through the points `p` and `q`. Line is directed from `p` to `q`. */ Kernel::Line_2 operator()(const Kernel::Point_2 &p, const Kernel::Point_2 &q); - /*! + /*! introduces a line passing through point `p` with direction `d`. */ Kernel::Line_2 operator()(const Kernel::Point_2 &p, const Kernel::Direction_2&d); - /*! + /*! introduces a line passing through point `p` and oriented by `v`. */ Kernel::Line_2 operator()(const Kernel::Point_2 &p, const Kernel::Vector_2&v); - /*! + /*! introduces a line supporting the segment `s`, oriented from source to target. */ Kernel::Line_2 operator()(const Kernel::Segment_2 &s); - /*! + /*! introduces a line supporting the ray `r`, with same orientation. */ @@ -4314,34 +4314,34 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a line passing through the points `p` and `q`. Line is directed from `p` to `q`. */ Kernel::Line_3 operator()(const Kernel::Point_3 &p, const Kernel::Point_3 &q); - /*! + /*! introduces a line passing through point `p` and oriented by `v`. */ Kernel::Line_3 operator()(const Kernel::Point_3 &p, const Kernel::Vector_3&v); - /*! + /*! introduces a line passing through point `p` with direction `d`. */ Kernel::Line_3 operator()(const Kernel::Point_3 &p, const Kernel::Direction_3&d); - /*! + /*! returns the line supporting the segment `s`, oriented from source to target. */ Kernel::Line_3 operator()(const Kernel::Segment_3 &s); - /*! + /*! returns the line supporting the ray `r`, with the same orientation. */ @@ -4369,14 +4369,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the vertex of `r` with lexicographically largest coordinates. */ Kernel::Point_2 operator()(const Kernel::Iso_rectangle_2 &r); - /*! + /*! returns the vertex of `s` with lexicographically largest coordinates. */ @@ -4404,14 +4404,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the vertex of `c` with lexicographically largest coordinates. */ Kernel::Point_3 operator()(const Kernel::Iso_cuboid_3 &c); - /*! + /*! returns the vertex of `s` with lexicographically largest coordinates. */ @@ -4439,7 +4439,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! computes the midpoint of the segment `pq`. */ Kernel::Point_2 operator()(const Kernel::Point_2& p, @@ -4465,7 +4465,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! computes the midpoint of the segment `pq`. */ Kernel::Point_3 operator()(const Kernel::Point_3& p, @@ -4493,14 +4493,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the vertex of `r` with lexicographically smallest coordinates. */ Kernel::Point_2 operator()(const Kernel::Iso_rectangle_2 &r); - /*! + /*! returns the vertex of `s` with lexicographically smallest coordinates. */ @@ -4528,14 +4528,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the vertex of `c` with lexicographically smallest coordinates. */ Kernel::Point_3 operator()(const Kernel::Iso_cuboid_3 &c); - /*! + /*! returns the vertex of `s` with lexicographically smallest coordinates. */ @@ -4564,7 +4564,7 @@ public: /// @{ - /*! + /*! computes the normal of the vectors `q-p` and `r-p`. */ Kernel::Vector_3 operator()(const Kernel::Point_3& p, @@ -4598,7 +4598,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! constructs an object that contains `t` and returns it. */ template @@ -4629,7 +4629,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! constructs an object that contains `t` and returns it. */ template @@ -4656,7 +4656,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the circle with the same center and squared radius as `c`, but with opposite orientation. */ @@ -4682,7 +4682,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the direction opposite to `d`. */ Kernel::Direction_2 operator()(const @@ -4709,7 +4709,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the direction opposite to `d`. */ Kernel::Direction_3 operator()(const @@ -4737,7 +4737,7 @@ public: /// @{ - /*! + /*! returns the line representing the same set of points as `l`, but with opposite direction. */ @@ -4764,7 +4764,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the line representing the same set of points as `l`, but with opposite direction. */ @@ -4790,7 +4790,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the plane representing the same set of points as `p`, but with opposite orientation. */ @@ -4816,7 +4816,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the ray with the same source as `r`, but in opposite direction. */ Kernel::Ray_2 operator()(const Kernel::Ray_2& r); @@ -4841,7 +4841,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the ray with the same source as `r`, but in opposite direction. */ Kernel::Ray_3 operator()(const Kernel::Ray_3& r); @@ -4867,7 +4867,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the segment representing the same set of points as `s`, but with opposite orientation. */ @@ -4894,7 +4894,7 @@ public: /// @{ - /*! + /*! returns the segment representing the same set of points as `s`, but with opposite orientation. */ @@ -4921,7 +4921,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the sphere with the same center and squared radius as `s`, but with opposite orientation. */ @@ -4947,7 +4947,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the triangle with opposite orientation to `t` (this flips the positive and the negative side, but not bounded and unbounded side). @@ -4975,7 +4975,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the vector `-v`. */ Kernel::Vector_2 operator()(const Kernel::Vector_2& v); @@ -5001,7 +5001,7 @@ public: /// @{ - /*! + /*! returns the vector `-v`. */ Kernel::Vector_3 operator()(const Kernel::Vector_3& v); @@ -5027,13 +5027,13 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns a vector that is orthogonal to the plane `p` and directed to the positive side of `p`. */ Kernel::Vector_3 operator()(const Kernel::Plane_3& p); - /*! + /*! returns a vector that is orthogonal to the plane defined by `Kernel::ConstructPlane_3()(p, q, r)` and directed to the positive side of this plane. @@ -5062,7 +5062,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a direction orthogonal to `d`. If `o` is \ref CGAL::CLOCKWISE, `d` is rotated clockwise; if `o` is \ref CGAL::COUNTERCLOCKWISE, `d` is rotated counterclockwise. @@ -5092,7 +5092,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the line perpendicular to `l` and passing through `p`, where the direction is the direction of `l` rotated counterclockwise by 90 degrees. @@ -5121,7 +5121,7 @@ public: /// @{ - /*! + /*! returns the line that is perpendicular to `pl` and that passes through point `p`. The line is oriented from the negative to the positive side of `pl` @@ -5150,7 +5150,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the plane perpendicular to `l` passing through `p`, such that the normal direction of the plane coincides with the direction of the line. @@ -5179,7 +5179,7 @@ public: /// @{ - /*! + /*! returns `v` rotated clockwise by 90 degrees, if `o` is \ref CGAL::CLOCKWISE, and rotated counterclockwise otherwise. \pre `o` is not \ref CGAL::COLLINEAR. @@ -5209,7 +5209,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! creates a plane defined by the equation \f$ a\, x +b\, y +c\, z + d = 0\f$. Notice that it is degenerate if \f$ a = b = c = 0\f$. @@ -5219,7 +5219,7 @@ public: const Kernel::RT &c, const Kernel::RT &d); - /*! + /*! creates a plane passing through the points `p`, `q` and `r`. The plane is oriented such that `p`, `q` and `r` are oriented in a positive sense @@ -5230,42 +5230,42 @@ public: const Kernel::Point_3 &q, const Kernel::Point_3 &r); - /*! + /*! introduces a plane that passes through point `p` and that has as an orthogonal direction equal to `d`. */ Kernel::Plane_3 operator()(const Kernel::Point_3 &p, const Kernel::Direction_3&d); - /*! + /*! introduces a plane that passes through point `p` and that is orthogonal to `v`. */ Kernel::Plane_3 operator()(const Kernel::Point_3 &p, const Kernel::Vector_3 &v); - /*! + /*! introduces a plane that is defined through the three points `l.point(0)`, `l.point(1)` and `p`. */ Kernel::Plane_3 operator()(const Kernel::Line_3 &l, const Kernel::Point_3 &p); - /*! + /*! introduces a plane that is defined through the three points `r.point(0)`, `r.point(1)` and `p`. */ Kernel::Plane_3 operator()(const Kernel::Ray_3 &r, const Kernel::Point_3 &p); - /*! + /*! introduces a plane that is defined through the three points `s.source()`, `s.target()` and `p`. */ Kernel::Plane_3 operator()(const Kernel::Segment_3 &s, const Kernel::Point_3 &p); - /*! + /*! introduces a plane that is defined as the plane containing the circle. */ Kernel::Plane_3 operator()(const Kernel::Circle_3 &c); @@ -5292,7 +5292,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an arbitrary point on `l`. It holds `point(i) == point(j)`, iff `i==j`. Furthermore, is directed from `point(i)` @@ -5301,7 +5301,7 @@ public: Kernel::Point_2 operator()(const Kernel::Line_2& l, int i); - /*! + /*! returns a point on `r`. `point(0)` is the source, `point(i)`, with `i>0`, is different from the source. \pre `i>= 0`. @@ -5309,7 +5309,7 @@ public: Kernel::Point_2 operator()(const Kernel::Ray_2& r, int i); - /*! + /*! returns source or target of `s`: `point(0)` returns the source of `s`, `point(1)` returns the target of `s`. The parameter `i` is taken modulo 2, which gives @@ -5342,7 +5342,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns an arbitrary point on `l`. It holds `point(i) == point(j)`, iff `i==j`. Furthermore, is directed from `point(i)` @@ -5351,12 +5351,12 @@ public: Kernel::Point_3 operator()(const Kernel::Line_3& l, int i); - /*! + /*! returns an arbitrary point on `h`. */ Kernel::Point_3 operator()(const Kernel::Plane_3& h); - /*! + /*! returns a point on `r`. `point(0)` is the source, `point(i)`, with `i>0`, is different from the source. \pre `i >= 0`. @@ -5364,7 +5364,7 @@ public: Kernel::Point_3 operator()(const Kernel::Ray_3& r, int i); - /*! + /*! returns source or target of `s`: `point(0)` returns the source of `s`, `point(1)` returns the target of `s`. The parameter `i` is taken modulo 2, which gives @@ -5394,7 +5394,7 @@ public: /// @{ - /*! + /*! introduces a variable with Cartesian coordinates \f$ (0,0)\f$. */ @@ -5420,7 +5420,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a point with Cartesian coordinates\f$ (0,0,0)\f$. */ Kernel::Point_3 operator()(const Origin &ORIGIN); @@ -5445,7 +5445,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the orthogonal projection of `p` onto `l`. */ Kernel::Point_2 operator()(const Kernel::Line_2& l, @@ -5472,13 +5472,13 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the orthogonal projection of `p` onto `l`. */ Kernel::Point_3 operator()(const Kernel::Line_3& l, const Kernel::Point_3& p); - /*! + /*! returns the orthogonal projection of `p` onto `h`. */ Kernel::Point_3 operator()(const Kernel::Plane_3& h, @@ -5505,7 +5505,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the image point of the projection of `p` under an affine transformation, which maps `h` onto the \f$ xy\f$-plane, with the \f$ z\f$-coordinate removed. @@ -5533,7 +5533,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the radical line of the circles. \pre The two circles don't have the same center. */ @@ -5562,7 +5562,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the radical plane of the spheres. \pre The two spheres don't have the same center. */ @@ -5590,28 +5590,28 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a ray with source `p` and passing through point `q`. */ Kernel::Ray_2 operator()(const Kernel::Point_2 &p, const Kernel::Point_2 &q); - /*! + /*! introduces a ray starting at source `p` with the direction given by `v`. */ Kernel::Ray_2 operator()(const Kernel::Point_2 &p, const Kernel::Vector_2 &v); - /*! + /*! introduces a ray starting at source `p` with direction `d`. */ Kernel::Ray_2 operator()(const Kernel::Point_2 &p, const Kernel::Direction_2 &d); - /*! + /*! introduces a ray starting at source `p` with the same direction as `l`. */ @@ -5638,28 +5638,28 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a ray with source `p` and passing through point `q`. */ Kernel::Ray_3 operator()(const Kernel::Point_3 &p, const Kernel::Point_3 &q); - /*! + /*! introduces a ray with source `p` and with the direction given by `v`. */ Kernel::Ray_3 operator()(const Kernel::Point_3 &p, const Kernel::Vector_3 &v); - /*! + /*! introduces a ray with source `p` and with direction `d`. */ Kernel::Ray_3 operator()(const Kernel::Point_3 &p, const Kernel::Direction_3 &d); - /*! + /*! introduces a ray with source `p` and with the same direction as `l`. */ @@ -5685,12 +5685,12 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! produces the vector `v` scaled by a factor `scale`. */ Kernel::Vector_2 operator()(const Kernel::Vector_2 &v, const Kernel::RT& scale); - /*! + /*! produces the vector `v` scaled by a factor `scale`. */ Kernel::Vector_2 operator()(const Kernel::Vector_2 &v, const Kernel::FT& scale); @@ -5715,13 +5715,13 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! produces the vector `v` scaled by a factor `scale`. */ Kernel::Vector_3 operator()(const Kernel::Vector_3 &v, const Kernel::RT& scale); - /*! + /*! produces the vector `v` scaled by a factor `scale`. */ Kernel::Vector_3 operator()(const Kernel::Vector_3 &v, @@ -5748,7 +5748,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns a point different from the source on the ray `r`. */ @@ -5804,7 +5804,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a segment with source `p` and target `q`. The segment is directed from the source towards the target. @@ -5831,7 +5831,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a segment with source `p` and target `q`. It is directed from the source towards the target. @@ -5859,14 +5859,14 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the source of the segment `s`. */ Kernel::Point_2 operator()(const Kernel::Segment_2 &s); - /*! + /*! returns the source of the ray `r`. */ @@ -5930,7 +5930,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a sphere initialized to the sphere with center `center`, squared radius `squared_radius` and orientation `orientation`. @@ -5940,7 +5940,7 @@ public: const Kernel::FT & squared_radius, const Orientation & orientation = COUNTERCLOCKWISE); - /*! + /*! introduces a sphere initialized to the unique sphere which passes through the points `p`, `q`, `r` and `s`. The orientation of the sphere is the orientation of the point quadruple @@ -5952,7 +5952,7 @@ public: const Kernel::Point_3 & r, const Kernel::Point_3 & s); - /*! + /*! introduces a sphere initialized to the smallest sphere which passes through the points `p`, `q`, and `r`. The orientation of the sphere is `o`. \pre `o` is not \ref CGAL::COPLANAR. @@ -5962,7 +5962,7 @@ public: const Kernel::Point_3 & r, const Orientation& o = COUNTERCLOCKWISE); - /*! + /*! introduces a sphere initialized to the smallest sphere which passes through the points `p` and `q`. The orientation of the sphere is `o`. \pre `o` is not \ref CGAL::COPLANAR. @@ -5971,7 +5971,7 @@ public: const Kernel::Point_3 & q, const Orientation & o = COUNTERCLOCKWISE); - /*! + /*! introduces a sphere `s` initialized to the sphere with center `center`, squared radius zero and orientation `orientation`. \pre `orientation` \f$ \neq\f$ \ref CGAL::COPLANAR. @@ -5980,7 +5980,7 @@ public: Kernel::Sphere_3 operator()( const Kernel::Point_3 & center, const Orientation & orientation = COUNTERCLOCKWISE); - /*! + /*! introduces a sphere initialized to the diametral sphere of the circle. */ @@ -6007,7 +6007,7 @@ public: /// @{ - /*! + /*! introduces the vector `v1 + v2`. */ Kernel::Vector_2 operator()(const Kernel::Vector_2 &v1, @@ -6034,7 +6034,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces the vector `v1 + v2`. */ Kernel::Vector_3 operator()(const Kernel::Vector_3 &v1, @@ -6060,7 +6060,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the supporting plane of `t`, with same orientation. */ Kernel::Plane_3 operator()(const Kernel::Triangle_3& t); @@ -6085,7 +6085,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the target of the segment `s`. */ @@ -6139,7 +6139,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a tetrahedron with vertices `p_0`, `p_1`, `p_2` and `p_3`. */ Kernel::Tetrahedron_3 operator()(const Kernel::Point_3 &p0, @@ -6168,14 +6168,14 @@ public: /// @{ - /*! + /*! returns the point obtained by translating `p` by the vector `v`. */ Kernel::Point_2 operator()(const Kernel::Point_2& p, const Kernel::Vector_2& v); - /*! + /*! returns the point obtained by translating a point at the origin by the vector `v`. */ @@ -6204,14 +6204,14 @@ public: /// @{ - /*! + /*! returns the point obtained by translating `p` by the vector `v`. */ Kernel::Point_3 operator()(const Kernel::Point_3& p, const Kernel::Vector_3& v); - /*! + /*! returns the point obtained by translating a point at the origin by the vector `v`. */ @@ -6239,7 +6239,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces a triangle with vertices `p`, `q` and `r`. */ Kernel::Triangle_2 operator()(const Kernel::Point_2 &p, @@ -6267,7 +6267,7 @@ public: /// @{ - /*! + /*! introduces a triangle with vertices `p`, `q` and `r`. */ Kernel::Triangle_3 operator()(const Kernel::Point_3 &p, @@ -6296,7 +6296,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! computes the unit normal of the vectors`q-p` and `r-p`. This requires that `Kernel::FT` supports the `sqrt` operation. */ @@ -6327,40 +6327,40 @@ public: /// @{ - /*! + /*! introduces the vector `b-a`. */ Kernel::Vector_2 operator()(const Kernel::Point_2 &a, const Kernel::Point_2 &b); - /*! + /*! introduces the vector `b`. */ Kernel::Vector_2 operator()(const Origin &o, const Kernel::Point_2 &b); - /*! + /*! introduces the vector `-a`. */ Kernel::Vector_2 operator()(const Kernel::Point_2 &a, const Origin &o); - /*! + /*! introduces the vector `s.target()-s.source()`. */ Kernel::Vector_2 operator()(const Kernel::Segment_2 &s); - /*! + /*! introduces a vector having the same direction as `r`. */ Kernel::Vector_2 operator()(const Kernel::Ray_2 &r); - /*! + /*! introduces a vector having the same direction as `l`. */ Kernel::Vector_2 operator()(const Kernel::Line_2 &l); - /*! + /*! introduces a null vector . */ Kernel::Vector_2 operator()(const Null_vector &NULL_VECTOR); @@ -6386,40 +6386,40 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! introduces the vector `b-a`. */ Kernel::Vector_3 operator()(const Kernel::Point_3 &a, const Kernel::Point_3 &b); - /*! + /*! introduces the vector `b`. */ Kernel::Vector_3 operator()(const Origin &o, const Kernel::Point_3 &b); - /*! + /*! introduces the vector `-a`. */ Kernel::Vector_3 operator()(const Kernel::Point_3 &a, const Origin &o); - /*! + /*! introduces the vector `s.target()-s.source()`. */ Kernel::Vector_3 operator()(const Kernel::Segment_3 &s); - /*! + /*! introduces a vector having the same direction as `r`. */ Kernel::Vector_3 operator()(const Kernel::Ray_3 &r); - /*! + /*! introduces a vector having the same direction as `l`. */ Kernel::Vector_3 operator()(const Kernel::Line_3 &l); - /*! + /*! introduces a null vector . */ Kernel::Vector_3 operator()(const Null_vector &NULL_VECTOR); @@ -6448,7 +6448,7 @@ public: /// @{ - /*! + /*! returns source or target of `s`: `fo``(s,0)` returns the source of `s`, `fo``(s,1)` returns the target of `s`. The parameter `i` is taken modulo 2. @@ -6456,7 +6456,7 @@ public: Kernel::Point_2 operator()(const Kernel::Segment_2 &s, int i); - /*! + /*! returns the i'th vertex of `r` in counterclockwise order, starting with the lower left vertex. The parameter `i` is taken modulo 4. @@ -6464,7 +6464,7 @@ public: Kernel::Point_2 operator()(const Kernel::Iso_rectangle_2 &r, int i); - /*! + /*! returns the i'th vertex of `t`. The parameter `i` is taken modulo 3. */ @@ -6496,7 +6496,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns source or target of `s`: `fo``(s,0)` returns the source of `s`, `fo``(s,1)` returns the target of `s`. The parameter `i` is taken modulo 2. @@ -6504,7 +6504,7 @@ public: Kernel::Point_3 operator()(const Kernel::Segment_3 &s, int i); - /*! + /*! returns the i'th vertex of `c`, as indicated in the figure below. The parameter `i` is taken modulo 8. @@ -6513,14 +6513,14 @@ public: Kernel::Point_3 operator()(const Kernel::Iso_cuboid_3 &c, int i); - /*! + /*! returns the i'th vertex of `t`. The parameter `i` is taken modulo 3. */ Kernel::Point_3 operator()(const Kernel::Triangle_3 &t, int i); - /*! + /*! returns the i'th vertex of `t`. The parameter `i` is taken modulo 4. */ @@ -6548,7 +6548,7 @@ public: /// @{ - /*! + /*! Let `p` be the plane defined by the points `p`, `q`, and `r`. Note that the order defines the orientation of `p`. The function computes the orientation of points `p`, @@ -6563,7 +6563,7 @@ public: const Kernel::Point_3&r, const Kernel::Point_3&s); - /*! + /*! If `p,q,r` are collinear, then \ref CGAL::COLLINEAR is returned. If not, then `p,q,r` define a plane `p`. The return value in this case is either \ref CGAL::POSITIVE or \ref CGAL::NEGATIVE, but we don't specify it explicitly. @@ -6595,7 +6595,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the bounded side of the circle defined by `p`, `q`, and `r` on which `s` lies. \pre `p`, `q`, `r`, and `s` are coplanar and `p`, `q`, and `r` are not collinear. @@ -6625,7 +6625,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, if `p`, `q`, `r`, and `s` are coplanar. */ bool operator()(const Kernel::Point_3&p, @@ -6654,7 +6654,7 @@ public: /// @{ - /*! + /*! returns `true` iff `d` is not equal to `d1`, and while rotating counterclockwise starting at `d1`, `d` is reached strictly before `d2` is reached. @@ -6687,7 +6687,7 @@ public: /// @{ - /*! + /*! determines if two geometrical objects of type `Type1` and `Type2` intersect or not, for all pairs `Type1` and `Type2`, where the types `Type1` and `Type2` can be any of the @@ -6723,7 +6723,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! determines if two geometrical objects of type `Type1` and `Type2` intersect or not, for all pairs `Type1` and `Type2`, where the types `Type1` and @@ -6766,7 +6766,7 @@ public: /// @{ - /*! + /*! returns true iff `p` and `q` have the same Cartesian \f$ x\f$-coordinate and the same Cartesian \f$ y\f$-coordinate. */ @@ -6793,7 +6793,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` and `q` have the same Cartesian \f$ x\f$-coordinate. */ bool operator()(const Kernel::Point_2&p, @@ -6819,7 +6819,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` and `q` have the same Cartesian \f$ x\f$-coordinate. */ bool operator()(const Kernel::Point_3&p, @@ -6845,7 +6845,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` and `q` have the same Cartesian \f$ y\f$-coordinate. */ bool operator()(const Kernel::Point_2&p, @@ -6871,7 +6871,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` and `q` have the same Cartesian \f$ y\f$-coordinate. */ bool operator()(const Kernel::Point_3&p, @@ -6897,7 +6897,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` and `q` have the same Cartesian \f$ z\f$-coordinate. */ bool operator()(const Kernel::Point_3&p, @@ -6932,55 +6932,55 @@ public: /// them, it returns `true` iff `x` and `y` are equal. /// @{ - /*! + /*! */ bool operator()(const Kernel::Point_2& x, const Kernel::Point_2& y); - /*! + /*! */ bool operator()(const Kernel::Vector_2& x, const Kernel::Vector_2& y); - /*! + /*! */ bool operator()(const Kernel::Direction_2& x, const Kernel::Direction_2& y); - /*! + /*! */ bool operator()(const Kernel::Line_2& x, const Kernel::Line_2& y); - /*! + /*! */ bool operator()(const Kernel::Ray_2& x, const Kernel::Ray_2& y); - /*! + /*! */ bool operator()(const Kernel::Segment_2& x, const Kernel::Segment_2& y); - /*! + /*! */ bool operator()(const Kernel::Circle_2& x, const Kernel::Circle_2& y); - /*! + /*! */ bool operator()(const Kernel::Triangle_2& x, const Kernel::Triangle_2& y); - /*! + /*! */ bool operator()(const Kernel::Iso_rectangle_2& x, @@ -7018,73 +7018,73 @@ public: /// @{ - /*! + /*! */ bool operator()(const Kernel::Point_3& x, const Kernel::Point_3& y); - /*! + /*! */ bool operator()(const Kernel::Vector_3& x, const Kernel::Vector_3& y); - /*! + /*! */ bool operator()(const Kernel::Direction_3& x, const Kernel::Direction_3& y); - /*! + /*! */ bool operator()(const Kernel::Line_3& x, const Kernel::Line_3& y); - /*! + /*! */ bool operator()(const Kernel::Plane_3& x, const Kernel::Plane_3& y); - /*! + /*! */ bool operator()(const Kernel::Ray_3& x, const Kernel::Ray_3& y); - /*! + /*! */ bool operator()(const Kernel::Segment_3& x, const Kernel::Segment_3& y); - /*! + /*! */ bool operator()(const Kernel::Circle_3& x, const Kernel::Circle_3& y); - /*! + /*! */ bool operator()(const Kernel::Sphere_3& x, const Kernel::Sphere_3& y); - /*! + /*! */ bool operator()(const Kernel::Triangle_3& x, const Kernel::Triangle_3& y); - /*! + /*! */ bool operator()(const Kernel::Tetrahedron_3& x, const Kernel::Tetrahedron_3& y); - /*! + /*! */ bool operator()(const Kernel::Iso_cuboid_3& x, @@ -7112,19 +7112,19 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the boundary of `c`. */ bool operator()(const Kernel::Circle_2&c, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the boundary of `i`. */ bool operator()(const Kernel::Iso_rectangle_2&i, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the boundary of `t`. */ bool operator()(const Kernel::Triangle_2&t, @@ -7153,19 +7153,19 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the boundary of `s`. */ bool operator()(const Kernel::Sphere_3&s, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the boundary of `t`. */ bool operator()(const Kernel::Tetrahedron_3&t, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the boundary of `c`. */ bool operator()(const Kernel::Iso_cuboid_3&c, @@ -7193,19 +7193,19 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the bounded side of `c`. */ bool operator()(const Kernel::Circle_2&c, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the bounded side of `i`. */ bool operator()(const Kernel::Iso_rectangle_2&i, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the bounded side of `t`. */ bool operator()(const Kernel::Triangle_2&t, @@ -7233,19 +7233,19 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the bounded side of `s`. */ bool operator()(const Kernel::Sphere_3&s, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the bounded side of `t`. */ bool operator()(const Kernel::Tetrahedron_3&t, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the bounded side of `c`. */ bool operator()(const Kernel::Iso_cuboid_3&c, @@ -7275,20 +7275,20 @@ public: /// @{ - /*! + /*! returns true iff `p` lies on the negative side of `c`. */ bool operator()(const Kernel::Circle_2&c, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the negative side of `l` (`l` is considered a half-space). */ bool operator()(const Kernel::Line_2&l, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the negative side of `t`. */ bool operator()(const Kernel::Triangle_2&t, @@ -7316,20 +7316,20 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the negative side of `h` (`h` is considered a half-space). */ bool operator()(const Kernel::Plane_3&h, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the negative side of `s`. */ bool operator()(const Kernel::Sphere_3&s, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the negative side of `t`. */ bool operator()(const Kernel::Tetrahedron_3&t, @@ -7357,20 +7357,20 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the positive side of `c`. */ bool operator()(const Kernel::Circle_2&c, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the positive side of `l` (`l` is considered a half-space). */ bool operator()(const Kernel::Line_2&l, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the positive side of `t`. */ bool operator()(const Kernel::Triangle_2&t, @@ -7398,20 +7398,20 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the positive side of `h` (`h` is considered a half-space). */ bool operator()(const Kernel::Plane_3&h, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the positive side of `s`. */ bool operator()(const Kernel::Sphere_3&s, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the positive side of `t`. */ bool operator()(const Kernel::Tetrahedron_3&t, @@ -7440,19 +7440,19 @@ public: /// @{ - /*! + /*! returns true iff `p` lies on the unbounded side of `c`. */ bool operator()(const Kernel::Circle_2&c, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the unbounded side of `i`. */ bool operator()(const Kernel::Iso_rectangle_2&i, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on the unbounded side of `t`. */ bool operator()(const Kernel::Triangle_2&t, @@ -7481,19 +7481,19 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on the unbounded side of `s`. */ bool operator()(const Kernel::Sphere_3&s, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the unbounded side of `t`. */ bool operator()(const Kernel::Tetrahedron_3&t, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on the unbounded side of `c`. */ bool operator()(const Kernel::Iso_cuboid_3&c, @@ -7523,19 +7523,19 @@ public: /// @{ - /*! + /*! returns true iff `p` lies on `l`. */ bool operator()(const Kernel::Line_2&l, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on `r`. */ bool operator()(const Kernel::Ray_2&r, const Kernel::Point_2&p); - /*! + /*! returns true iff `p` lies on `s`. */ bool operator()(const Kernel::Segment_2&s, @@ -7568,61 +7568,61 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `p` lies on `c`. */ bool operator()(const Kernel::Circle_3&c, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on `l`. */ bool operator()(const Kernel::Line_3&l, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on `r`. */ bool operator()(const Kernel::Ray_3&r, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on `s`. */ bool operator()(const Kernel::Segment_3&s, const Kernel::Point_3&p); - /*! + /*! returns true iff `p` lies on `pl`. */ bool operator()(const Kernel::Plane_3&pl, const Kernel::Point_3&p); - /*! + /*! returns true iff `l` lies on `pl`. */ bool operator()(const Kernel::Plane_3&pl, const Kernel::Line_3&l); - /*! + /*! returns true iff `c` lies on `pl`. */ bool operator()(const Kernel::Plane_3&pl, const Kernel::Circle_3&c); - /*! + /*! returns true iff `c` lies on `s`. */ bool operator()(const Kernel::Sphere_3&s, const Kernel::Point_3&c); - /*! + /*! returns true iff `c` lies on `s`. */ bool operator()(const Kernel::Sphere_3&s, const Kernel::Circle_3&c); - /*! + /*! returns true iff `p` lies on `t`. */ bool operator()(const Kernel::Triangle_3&t, @@ -7649,7 +7649,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! computes the intersection region of two geometrical objects of type `Type1` and `Type2`, for all pairs `Type1` and `Type2`. For details see the reference manual page for `intersection()`. @@ -7678,7 +7678,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! computes the intersection region of two geometrical objects of type `Type1` and `Type2`. For details see the reference manual page for `intersection()`. @@ -7713,32 +7713,32 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Circle_2&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Iso_rectangle_2&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Line_2&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Ray_2&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Segment_2&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Triangle_2&o); @@ -7772,47 +7772,47 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Circle_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Iso_cuboid_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Line_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Plane_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Ray_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Segment_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Sphere_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Tetrahedron_3&o); - /*! + /*! returns true iff `o` is degenerate. */ bool operator()(const Kernel::Triangle_3&o); @@ -7839,17 +7839,17 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff `o` is horizontal. */ bool operator()(const Kernel::Line_2&o); - /*! + /*! returns true iff `o` is horizontal. */ bool operator()(const Kernel::Ray_2&o); - /*! + /*! returns true iff `o` is horizontal. */ bool operator()(const Kernel::Segment_2&o); @@ -7877,17 +7877,17 @@ public: /// @{ - /*! + /*! returns true iff `o` is vertical. */ bool operator()(const Kernel::Line_2&o); - /*! + /*! returns true iff `o` is vertical. */ bool operator()(const Kernel::Ray_2&o); - /*! + /*! returns true iff `o` is vertical. */ bool operator()(const Kernel::Segment_2&o); @@ -7913,7 +7913,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true`, iff the three points `p`, `q` and `r` form a left turn. */ @@ -7941,7 +7941,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the distance of `q` to `p` is smaller than the distance of `r` to `p`. */ @@ -7970,7 +7970,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the distance of `q` to `p` is smaller than the distance of `r` to `p`. */ @@ -7997,7 +7997,7 @@ public: /// @{ - /*! + /*! returns true iff the three points `p`, `q` and `r` form a left turn or if they are collinear and the distance of `q` to `p` is @@ -8029,7 +8029,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns `true` if the signed distance from `p` and the oriented line `l` is smaller than the signed distance of `q` and `l`. @@ -8039,7 +8039,7 @@ public: const Kernel::Point_2& p, const Kernel::Point_2& q); - /*! + /*! returns `true` if the signed distance from `r` and the oriented line `l` defined by `p` and `q` is smaller than the signed distance of `s` and `l`. @@ -8071,7 +8071,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true, iff the signed distance from point `q` to plane `p` is smaller than the signed distance from point `r` to `p`. */ @@ -8079,7 +8079,7 @@ public: const Kernel::Point_3& q, const Kernel::Point_3& r); - /*! + /*! returns true, iff the signed distance from point `q` to the plane `p` defined by `p1, p2, p3` is smaller than the signed distance from point `r` to `p`. @@ -8111,7 +8111,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ x\f$-coordinate of `p` is smaller than the \f$ x\f$-coordinate of `q` or if the are the same and the \f$ y\f$-coordinate of `p` is smaller than the \f$ y\f$-coordinate of `q`, or, @@ -8141,7 +8141,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ x\f$-coordinate of `p` is smaller than the \f$ x\f$-coordinate of `q` or if the are the same and the \f$ y\f$-coordinate of `p` is smaller than the \f$ y\f$-coordinate of `q`. @@ -8170,7 +8170,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ x\f$-coordinate of `p` is smaller than the \f$ x\f$-coordinate of `q` or if the are the same and the \f$ y\f$-coordinate of `p` is smaller than the \f$ y\f$-coordinate of `q`. @@ -8199,7 +8199,7 @@ public: /// @{ - /*! + /*! returns true iff the \f$ x\f$-coordinate of `p` is smaller than the \f$ x\f$-coordinate of `q`. */ @@ -8226,7 +8226,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ x\f$-coordinate of `p` is smaller than the \f$ x\f$-coordinate of `q`. */ @@ -8253,7 +8253,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ y\f$-coordinate of `p` is smaller than the \f$ y\f$-coordinate of `q` or if the are the same and the \f$ x\f$-coordinate of `p` is smaller than the \f$ x\f$-coordinate of `q`. @@ -8281,7 +8281,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ y\f$-coordinate of `p` is smaller than the \f$ y\f$-coordinate of `q`. */ @@ -8308,7 +8308,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ y\f$-coordinate of `p` is smaller than the \f$ y\f$-coordinate of `q`. */ @@ -8333,7 +8333,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns true iff the \f$ z\f$-coordinate of `p` is smaller than the \f$ z\f$-coordinate of `q`. */ @@ -8360,7 +8360,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns \ref CGAL::LEFT_TURN, if `r` lies to the left of the oriented line `l` defined by `p` and `q`, returns \ref CGAL::RIGHT_TURN if `r` lies to the right of `l`, and returns \ref CGAL::COLLINEAR if `r` lies @@ -8370,7 +8370,7 @@ public: const Kernel::Point_2&q, const Kernel::Point_2&r); - /*! + /*! returns \ref CGAL::LEFT_TURN if `u` and `v` form a left turn, returns \ref CGAL::RIGHT_TURN if `u` and `v` form a right turn, and returns \ref CGAL::COLLINEAR if `u` and `v` are collinear. @@ -8399,7 +8399,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns \ref CGAL::POSITIVE, if `s` lies on the positive side of the oriented plane `h` defined by `p`, `q`, and `r`, returns \ref CGAL::NEGATIVE if `s` lies on the negative side of `h`, and returns \ref CGAL::COPLANAR if `s` lies @@ -8410,7 +8410,7 @@ public: const Kernel::Point_3&r, const Kernel::Point_3&s); - /*! + /*! returns \ref CGAL::POSITIVE if `u`, `v` and `w` are positively oriented, returns \ref CGAL::NEGATIVE if `u`, `v` and `w` are negatively oriented, and returns \ref CGAL::COPLANAR if `u`, `v` and `w` are coplanar. @@ -8419,7 +8419,7 @@ public: const Kernel::Vector_3&v, const Kernel::Vector_3&w); - /*! + /*! returns the orientation of the sphere `s`. */ Orientation operator()(const Kernel::Sphere_3&s); @@ -8448,7 +8448,7 @@ public: /// @{ - /*! + /*! returns \ref CGAL::ON_ORIENTED_BOUNDARY, \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, depending on the position of `p` relative to the oriented circle `c`. @@ -8456,7 +8456,7 @@ public: Oriented_side operator()(const Kernel::Circle_2&c, const Kernel::Point_2&p); - /*! + /*! returns \ref CGAL::ON_ORIENTED_BOUNDARY, \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, depending on the position of `p` relative to the oriented line `l`. @@ -8464,7 +8464,7 @@ public: Oriented_side operator()(const Kernel::Line_2&l, const Kernel::Point_2&p); - /*! + /*! returns \ref CGAL::ON_ORIENTED_BOUNDARY, \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, depending on the position of `p` relative to the oriented triangle `t`. @@ -8494,7 +8494,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns \ref CGAL::ON_ORIENTED_BOUNDARY, \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, depending on the position of `p` relative to the oriented plane `h`. @@ -8502,7 +8502,7 @@ public: Oriented_side operator()(const Kernel::Plane_3&h, const Kernel::Point_3&p); - /*! + /*! returns \ref CGAL::ON_ORIENTED_BOUNDARY, \ref CGAL::ON_NEGATIVE_SIDE, or the constant \ref CGAL::ON_POSITIVE_SIDE, depending on the position of `p` relative to the oriented tetrahedron `t`. @@ -8510,7 +8510,7 @@ public: Oriented_side operator()(const Kernel::Tetrahedron_3&t, const Kernel::Point_3&p); - /*! + /*! returns \ref CGAL::ON_ORIENTED_BOUNDARY, \ref CGAL::ON_NEGATIVE_SIDE, or the \ref CGAL::ON_POSITIVE_SIDE, depending on the position of `p` relative to the oriented sphere `s`. @@ -8540,7 +8540,7 @@ public: /// @{ - /*! + /*! returns the relative position of point `t` to the circle defined by `p`, `q` and `r`. The order of the points `p`, `q` and `r` does not matter. @@ -8551,7 +8551,7 @@ public: const Kernel::Point_2&r, const Kernel::Point_2&t); - /*! + /*! returns the position of the point `t` relative to the circle that has `pq` as its diameter. */ @@ -8580,7 +8580,7 @@ public: /// @{ - /*! + /*! returns the relative position of point `t` to the sphere defined by `p`, `q`, `r`, and `s`. The order of the points `p`, `q`, `r`, and `s` does not matter. @@ -8592,7 +8592,7 @@ public: const Kernel::Point_3&s, const Kernel::Point_3&t); - /*! + /*! returns the position of the point `t` relative to the sphere passing through `p`, `q`, and `r` and whose center is in the plane defined by these three points. @@ -8602,7 +8602,7 @@ public: const Kernel::Point_3&r, const Kernel::Point_3&t); - /*! + /*! returns the position of the point `t` relative to the sphere that has `pq` as its diameter. */ @@ -8632,7 +8632,7 @@ public: /// @{ - /*! + /*! returns the relative position of point `t` to the oriented circle defined by `p`, `q` and `r`. The order of the points `p`, `q` and `r` is important, @@ -8671,7 +8671,7 @@ public: /// A model of this concept must provide: /// @{ - /*! + /*! returns the relative position of point `t` to the oriented sphere defined by `p`, `q`, `r` and `s`. The order of the points `p`, `q`, `r`, and `s` is important, diff --git a/Kernel_23/doc/Kernel_23/Concepts/Kernel.h b/Kernel_23/doc/Kernel_23/Concepts/Kernel.h index 766c19b251a..f587c2c36e4 100644 --- a/Kernel_23/doc/Kernel_23/Concepts/Kernel.h +++ b/Kernel_23/doc/Kernel_23/Concepts/Kernel.h @@ -47,47 +47,47 @@ public: /// similar. /// @{ - /*! + /*! a model of `FieldNumberType` */ typedef unspecified_type FT; - /*! + /*! a model of `RingNumberType` */ typedef unspecified_type RT; - /*! + /*! `bool` or `Uncertain` */ typedef unspecified_type Boolean; - /*! + /*! `CGAL::Sign` or `Uncertain` */ typedef unspecified_type Sign; - /*! + /*! `CGAL::Comparison_result` or `Uncertain` */ typedef unspecified_type Comparison_result; - /*! + /*! `CGAL::Orientation` or `Uncertain` */ typedef unspecified_type Orientation; - /*! + /*! `CGAL::Oriented_side` or `Uncertain` */ typedef unspecified_type Oriented_side; - /*! + /*! `CGAL::Bounded_side` or `Uncertain` */ typedef unspecified_type Bounded_side; - /*! + /*! `CGAL::Angle` or `Uncertain` */ typedef unspecified_type Angle; @@ -97,7 +97,7 @@ public: /// \name Constants /// @{ - /*! + /*! A Boolean value indicating whether the predicates are filtered (as in `CGAL::Filtered_kernel`). This helps propagating such decisions to traits classes which are built on top of a kernel, so that they can decide to @@ -110,7 +110,7 @@ public: /// \name Two-dimensional Coordinate Access /// @{ - /*! + /*! a model of `Kernel::CartesianConstIterator_2` */ typedef unspecified_type Cartesian_const_iterator_2; @@ -120,52 +120,52 @@ public: /// \name Two-dimensional Geometric Objects /// @{ - /*! + /*! a model of `Kernel::Point_2` */ typedef unspecified_type Point_2; - /*! + /*! a model of `Kernel::Vector_2` */ typedef unspecified_type Vector_2; - /*! + /*! a model of `Kernel::Direction_2` */ typedef unspecified_type Direction_2; - /*! + /*! a model of `Kernel::Line_2` */ typedef unspecified_type Line_2; - /*! + /*! a model of `Kernel::Ray_2` */ typedef unspecified_type Ray_2; - /*! + /*! a model of `Kernel::Segment_2` */ typedef unspecified_type Segment_2; - /*! + /*! a model of `Kernel::Triangle_2` */ typedef unspecified_type Triangle_2; - /*! + /*! a model of `Kernel::IsoRectangle_2` */ typedef unspecified_type Iso_rectangle_2; - /*! + /*! a model of `Kernel::Circle_2` */ typedef unspecified_type Circle_2; - /*! + /*! a model of `Kernel::Object_2` */ typedef unspecified_type Object_2; @@ -175,57 +175,57 @@ public: /// \name Two-dimensional Constructions /// @{ - /*! + /*! a model of `Kernel::ConstructPoint_2` */ typedef unspecified_type Construct_point_2; - /*! + /*! a model of `Kernel::ConstructVector_2` */ typedef unspecified_type Construct_vector_2; - /*! + /*! a model of `Kernel::ConstructDirection_2` */ typedef unspecified_type Construct_direction_2; - /*! + /*! a model of `Kernel::ConstructSegment_2` */ typedef unspecified_type Construct_segment_2; - /*! + /*! a model of `Kernel::ConstructLine_2` */ typedef unspecified_type Construct_line_2; - /*! + /*! a model of `Kernel::ConstructRay_2` */ typedef unspecified_type Construct_ray_2; - /*! + /*! a model of `Kernel::ConstructCircle_2` */ typedef unspecified_type Construct_circle_2; - /*! + /*! a model of `Kernel::ConstructTriangle_2` */ typedef unspecified_type Construct_triangle_2; - /*! + /*! a model of `Kernel::ConstructIsoRectangle_2` */ typedef unspecified_type Construct_iso_rectangle_2; - /*! + /*! a model of `Kernel::ConstructObject_2` */ typedef unspecified_type Construct_object_2; - /*! + /*! a model of `Kernel::ConstructScaledVector_2` */ typedef unspecified_type Construct_scaled_vector_2; @@ -245,22 +245,22 @@ public: */ typedef unspecified_type Construct_divided_vector_2; - /*! + /*! a model of `Kernel::ConstructTranslatedPoint_2` */ typedef unspecified_type Construct_translated_point_2; - /*! + /*! a model of `Kernel::ConstructPointOn_2` */ typedef unspecified_type Construct_point_on_2; - /*! + /*! a model of `Kernel::ConstructProjectedPoint_2` */ typedef unspecified_type Construct_projected_point_2; - /*! + /*! a model of `Kernel::ConstructProjectedXYPoint_2` */ typedef unspecified_type Construct_projected_xy_point_2; @@ -271,62 +271,62 @@ public: */ typedef unspecified_type Construct_second_point_2; - /*! + /*! a model of `Kernel::ConstructCartesianConstIterator_2` */ typedef unspecified_type Construct_cartesian_const_iterator_2; - /*! + /*! a model of `Kernel::ConstructVertex_2` */ typedef unspecified_type Construct_vertex_2; - /*! + /*! a model of `Kernel::ConstructBbox_2` */ typedef unspecified_type Construct_bbox_2; - /*! + /*! a model of `Kernel::ConstructPerpendicularVector_2` */ typedef unspecified_type Construct_perpendicular_vector_2; - /*! + /*! a model of `Kernel::ConstructPerpendicularDirection_2` */ typedef unspecified_type Construct_perpendicular_direction_2; - /*! + /*! a model of `Kernel::ConstructPerpendicularLine_2` */ typedef unspecified_type Construct_perpendicular_line_2; - /*! + /*! a model of `Kernel::ConstructMaxVertex_2` */ typedef unspecified_type Construct_max_vertex_2; - /*! + /*! a model of `Kernel::ConstructMidpoint_2` */ typedef unspecified_type Construct_midpoint_2; - /*! + /*! a model of `Kernel::ConstructEquidistantLine_3` */ typedef unspecified_type Construct_equidistant_line_3; - /*! + /*! a model of `Kernel::ConstructMinVertex_2` */ typedef unspecified_type Construct_min_vertex_2; - /*! + /*! a model of `Kernel::ConstructCenter_2` */ typedef unspecified_type Construct_center_2; - /*! + /*! a model of `Kernel::ConstructCentroid_2` */ typedef unspecified_type Construct_centroid_2; @@ -336,12 +336,12 @@ public: */ typedef unspecified_type Construct_barycenter_2; - /*! + /*! a model of `Kernel::ConstructCircumcenter_2` */ typedef unspecified_type Construct_circumcenter_2; - /*! + /*! a model of `Kernel::ConstructBisector_2` */ typedef unspecified_type Construct_bisector_2; @@ -351,37 +351,37 @@ public: */ typedef unspecified_type Construct_radical_line_2; - /*! + /*! a model of `Kernel::ConstructOppositeDirection_2` */ typedef unspecified_type Construct_opposite_direction_2; - /*! + /*! a model of `Kernel::ConstructOppositeSegment_2` */ typedef unspecified_type Construct_opposite_segment_2; - /*! + /*! a model of `Kernel::ConstructOppositeRay_2` */ typedef unspecified_type Construct_opposite_ray_2; - /*! + /*! a model of `Kernel::ConstructOppositeLine_2` */ typedef unspecified_type Construct_opposite_line_2; - /*! + /*! a model of `Kernel::ConstructOppositeTriangle_2` */ typedef unspecified_type Construct_opposite_triangle_2; - /*! + /*! a model of `Kernel::ConstructOppositeCircle_2` */ typedef unspecified_type Construct_opposite_circle_2; - /*! + /*! a model of `Kernel::ConstructOppositeVector_2` */ typedef unspecified_type Construct_opposite_vector_2; @@ -406,12 +406,12 @@ public: */ typedef unspecified_type Construct_min_vertex_2; - /*! + /*! a model of `Kernel::Intersect_2` */ typedef unspecified_type Intersect_2; - /*! + /*! a model of `Kernel::Assign_2` */ typedef unspecified_type Assign_2; @@ -491,27 +491,27 @@ public: */ typedef unspecified_type Compute_y_at_x_2; - /*! + /*! a model of `Kernel::ComputeSquaredDistance_2` */ typedef unspecified_type Compute_squared_distance_2; - /*! + /*! a model of `Kernel::ComputeSquaredLength_2` */ typedef unspecified_type Compute_squared_length_2; - /*! + /*! a model of `Kernel::ComputeSquaredRadius_2` */ typedef unspecified_type Compute_squared_radius_2; - /*! + /*! a model of `Kernel::ComputeArea_2` */ typedef unspecified_type Compute_area_2; - /*! + /*! a model of `Kernel::ComputeDeterminant_2` */ typedef unspecified_type Compute_determinant_2; @@ -526,77 +526,77 @@ public: /// \name Two-dimensional Generalized Predicates /// @{ - /*! + /*! a model of `Kernel::Angle_2` */ typedef unspecified_type Angle_2; - /*! + /*! a model of `Kernel::Equal_2` */ typedef unspecified_type Equal_2; - /*! + /*! a model of `Kernel::EqualX_2` */ typedef unspecified_type Equal_x_2; - /*! + /*! a model of `Kernel::EqualY_2` */ typedef unspecified_type Equal_y_2; - /*! + /*! a model of `Kernel::LessX_2` */ typedef unspecified_type Less_x_2; - /*! + /*! a model of `Kernel::LessY_2` */ typedef unspecified_type Less_y_2; - /*! + /*! a model of `Kernel::LessXY_2` */ typedef unspecified_type Less_xy_2; - /*! + /*! a model of `Kernel::LessYX_2` */ typedef unspecified_type Less_yx_2; - /*! + /*! a model of `Kernel::CompareX_2` */ typedef unspecified_type Compare_x_2; - /*! + /*! a model of `Kernel::CompareXAtY_2` */ typedef unspecified_type Compare_x_at_y_2; - /*! + /*! a model of `Kernel::CompareY_2` */ typedef unspecified_type Compare_y_2; - /*! + /*! a model of `Kernel::CompareXY_2` */ typedef unspecified_type Compare_xy_2; - /*! + /*! a model of `Kernel::CompareYX_2` */ typedef unspecified_type Compare_yx_2; - /*! + /*! a model of `Kernel::CompareYAtX_2` */ typedef unspecified_type Compare_y_at_x_2; - /*! + /*! a model of `Kernel::CompareDistance_2` */ typedef unspecified_type Compare_distance_2; @@ -606,147 +606,147 @@ public: */ typedef unspecified_type Compare_square_distance_2; - /*! + /*! a model of `Kernel::CompareAngleWithXAxis_2` */ typedef unspecified_type Compare_angle_with_x_axis_2; - /*! + /*! a model of `Kernel::CompareSlope_2` */ typedef unspecified_type Compare_slope_2; - /*! + /*! a model of `Kernel::LessDistanceToPoint_2` */ typedef unspecified_type Less_distance_to_point_2; - /*! + /*! a model of `Kernel::LessSignedDistanceToLine_2` */ typedef unspecified_type Less_signed_distance_to_line_2; - /*! + /*! a model of `Kernel::LessRotateCCW_2` */ typedef unspecified_type Less_rotate_ccw_2; - /*! + /*! a model of `Kernel::LeftTurn_2` */ typedef unspecified_type Left_turn_2; - /*! + /*! a model of `Kernel::Collinear_2` */ typedef unspecified_type Collinear_2; - /*! + /*! a model of `Kernel::Orientation_2` */ typedef unspecified_type Orientation_2; - /*! + /*! a model of `Kernel::SideOfOrientedCircle_2` */ typedef unspecified_type Side_of_oriented_circle_2; - /*! + /*! a model of `Kernel::SideOfBoundedCircle_2` */ typedef unspecified_type Side_of_bounded_circle_2; - /*! + /*! a model of `Kernel::IsHorizontal_2` */ typedef unspecified_type Is_horizontal_2; - /*! + /*! a model of `Kernel::IsVertical_2` */ typedef unspecified_type Is_vertical_2; - /*! + /*! a model of `Kernel::IsDegenerate_2` */ typedef unspecified_type Is_degenerate_2; - /*! + /*! a model of `Kernel::HasOn_2` */ typedef unspecified_type Has_on_2; - /*! + /*! a model of `Kernel::CollinearHasOn_2` */ typedef unspecified_type Collinear_has_on_2; - /*! + /*! a model of `Kernel::HasOnBoundedSide_2` */ typedef unspecified_type Has_on_bounded_side_2; - /*! + /*! a model of `Kernel::HasOnUnboundedSide_2` */ typedef unspecified_type Has_on_unbounded_side_2; - /*! + /*! a model of `Kernel::HasOnBoundary_2` */ typedef unspecified_type Has_on_boundary_2; - /*! + /*! a model of `Kernel::HasOnPositiveSide_2` */ typedef unspecified_type Has_on_positive_side_2; - /*! + /*! a model of `Kernel::HasOnNegativeSide_2` */ typedef unspecified_type Has_on_negative_side_2; - /*! + /*! a model of `Kernel::OrientedSide_2` */ typedef unspecified_type Oriented_side_2; - /*! + /*! a model of `Kernel::BoundedSide_2` */ typedef unspecified_type Bounded_side_2; - /*! + /*! a model of `Kernel::AreParallel_2` */ typedef unspecified_type Are_parallel_2 ; - /*! + /*! a model of `Kernel::AreOrderedAlongLine_2` */ typedef unspecified_type Are_ordered_along_line_2 ; - /*! + /*! a model of `Kernel::AreStrictlyOrderedAlongLine_2` */ typedef unspecified_type Are_strictly_ordered_along_line_2; - /*! + /*! a model of `Kernel::CollinearAreOrderedAlongLine_2` */ typedef unspecified_type Collinear_are_ordered_along_line_2; - /*! + /*! a model of `Kernel::CollinearAreStrictlyOrderedAlongLine_2` */ typedef unspecified_type Collinear_are_strictly_ordered_along_line_2; - /*! + /*! a model of `Kernel::CounterclockwiseInBetween_2` */ typedef unspecified_type Counterclockwise_in_between_2; - /*! + /*! a model of `Kernel::DoIntersect_2` */ typedef unspecified_type Do_intersect_2; @@ -756,7 +756,7 @@ public: /// \name Three-dimensional Coordinate Access /// @{ - /*! + /*! a model of `Kernel::CartesianConstIterator_3` */ typedef unspecified_type Cartesian_const_iterator_3; @@ -766,67 +766,67 @@ public: /// \name Three-dimensional Geometric Objects /// @{ - /*! + /*! a model of `Kernel::Point_3` */ typedef unspecified_type Point_3; - /*! + /*! a model of `Kernel::Vector_3` */ typedef unspecified_type Vector_3; - /*! + /*! a model of `Kernel::Direction_3` */ typedef unspecified_type Direction_3; - /*! + /*! a model of `Kernel::IsoCuboid_3` */ typedef unspecified_type Iso_cuboid_3; - /*! + /*! a model of `Kernel::Line_3` */ typedef unspecified_type Line_3; - /*! + /*! a model of `Kernel::Ray_3` */ typedef unspecified_type Ray_3; - /*! + /*! a model of `Kernel::Circle_3` */ typedef unspecified_type Circle_3; - /*! + /*! a model of `Kernel::Sphere_3` */ typedef unspecified_type Sphere_3; - /*! + /*! a model of `Kernel::Segment_3` */ typedef unspecified_type Segment_3; - /*! + /*! a model of `Kernel::Plane_3` */ typedef unspecified_type Plane_3; - /*! + /*! a model of `Kernel::Triangle_3` */ typedef unspecified_type Triangle_3; - /*! + /*! a model of `Kernel::Tetrahedron_3` */ typedef unspecified_type Tetrahedron_3; - /*! + /*! a model of `Kernel::Object_3` */ typedef unspecified_type Object_3; @@ -836,57 +836,57 @@ public: /// \name Three-dimensional Constructions /// @{ - /*! + /*! a model of `Kernel::ConstructPoint_3` */ typedef unspecified_type Construct_point_3; - /*! + /*! a model of `Kernel::ConstructVector_3` */ typedef unspecified_type Construct_vector_3; - /*! + /*! a model of `Kernel::ConstructDirection_3` */ typedef unspecified_type Construct_direction_3; - /*! + /*! a model of `Kernel::ConstructPlane_3` */ typedef unspecified_type Construct_plane_3; - /*! + /*! a model of `Kernel::ConstructIsoCuboid_3` */ typedef unspecified_type Construct_iso_cuboid_3; - /*! + /*! a model of `Kernel::ConstructLine_3` */ typedef unspecified_type Construct_line_3; - /*! + /*! a model of `Kernel::ConstructRay_3` */ typedef unspecified_type Construct_ray_3; - /*! + /*! a model of `Kernel::ConstructSphere_3` */ typedef unspecified_type Construct_sphere_3; - /*! + /*! a model of `Kernel::ConstructSegment_3` */ typedef unspecified_type Construct_segment_3; - /*! + /*! a model of `Kernel::ConstructTriangle_3` */ typedef unspecified_type Construct_triangle_3; - /*! + /*! a model of `Kernel::ConstructTetrahedron_3` */ typedef unspecified_type Construct_tetrahedron_3; @@ -896,42 +896,42 @@ public: */ typedef unspecified_type Construct_circle_3; - /*! + /*! a model of `Kernel::ConstructObject_3` */ typedef unspecified_type Construct_object_3; - /*! + /*! a model of `Kernel::ConstructScaledVector_3` */ typedef unspecified_type Construct_scaled_vector_3; - /*! + /*! a model of `Kernel::ConstructTranslatedPoint_3` */ typedef unspecified_type Construct_translated_point_3; - /*! + /*! a model of `Kernel::ConstructPointOn_3` */ typedef unspecified_type Construct_point_on_3; - /*! + /*! a model of `Kernel::ConstructProjectedPoint_3` */ typedef unspecified_type Construct_projected_point_3; - /*! + /*! a model of `Kernel::ConstructLiftedPoint_3` */ typedef unspecified_type Construct_lifted_point_3; - /*! + /*! a model of `Kernel::ConstructCartesianConstIterator_3` */ typedef unspecified_type Construct_cartesian_const_iterator_3; - /*! + /*! a model of `Kernel::ConstructVertex_3` */ typedef unspecified_type Construct_vertex_3; @@ -956,22 +956,22 @@ public: */ typedef unspecified_type Construct_min_vertex_3; - /*! + /*! a model of `Kernel::ConstructBbox_3` */ typedef unspecified_type Construct_bbox_3; - /*! + /*! a model of `Kernel::ConstructSupportingPlane_3` */ typedef unspecified_type Construct_supporting_plane_3; - /*! + /*! a model of `Kernel::ConstructOrthogonalVector_3` */ typedef unspecified_type Construct_orthogonal_vector_3; - /*! + /*! a model of `Kernel::ConstructBaseVector_3` */ typedef unspecified_type Construct_base_vector_3; @@ -996,47 +996,47 @@ public: */ typedef unspecified_type Construct_normal_3; - /*! + /*! a model of `Kernel::ConstructPerpendicularPlane_3` */ typedef unspecified_type Construct_perpendicular_plane_3; - /*! + /*! a model of `Kernel::ConstructRadicalPlane_3` */ typedef unspecified_type Construct_radical_plane_3; - /*! + /*! a model of `Kernel::ConstructPerpendicularLine_3` */ typedef unspecified_type Construct_perpendicular_line_3; - /*! + /*! a model of `Kernel::ConstructMidpoint_3` */ typedef unspecified_type Construct_midpoint_3; - /*! + /*! a model of `Kernel::ConstructCenter_3` */ typedef unspecified_type Construct_center_3; - /*! + /*! a model of `Kernel::ConstructCentroid_3` */ typedef unspecified_type Construct_centroid_3; - /*! + /*! a model of `Kernel::ConstructCircumcenter_3` */ typedef unspecified_type Construct_circumcenter_3; - /*! + /*! a model of `Kernel::ConstructBisector_3` */ typedef unspecified_type Construct_bisector_3; - /*! + /*! a model of `Kernel::ConstructCrossProductVector_3` */ typedef unspecified_type Construct_cross_product_vector_3; @@ -1052,47 +1052,47 @@ public: */ typedef unspecified_type Construct_second_point_3; - /*! + /*! a model of `Kernel::ConstructOppositeDirection_3` */ typedef unspecified_type Construct_opposite_direction_3; - /*! + /*! a model of `Kernel::ConstructOppositeSegment_3` */ typedef unspecified_type Construct_opposite_segment_3; - /*! + /*! a model of `Kernel::ConstructOppositeRay_3` */ typedef unspecified_type Construct_opposite_ray_3; - /*! + /*! a model of `Kernel::ConstructOppositeLine_3` */ typedef unspecified_type Construct_opposite_line_3; - /*! + /*! a model of `Kernel::ConstructOppositePlane_3` */ typedef unspecified_type Construct_opposite_plane_3; - /*! + /*! a model of `Kernel::ConstructOppositeSphere_3` */ typedef unspecified_type Construct_opposite_sphere_3; - /*! + /*! a model of `Kernel::ConstructOppositeVector_3` */ typedef unspecified_type Construct_opposite_vector_3; - /*! + /*! a model of `Kernel::Intersect_3` */ typedef unspecified_type Intersect_3; - /*! + /*! a model of `Kernel::Assign_3` */ typedef unspecified_type Assign_3; @@ -1197,27 +1197,27 @@ public: */ typedef unspecified_type Compute_zmin_3; - /*! + /*! a model of `Kernel::ComputeArea_3` */ typedef unspecified_type Compute_area_3; - /*! + /*! a model of `Kernel::ComputeSquaredArea_3` */ typedef unspecified_type Compute_squared_area_3; - /*! + /*! a model of `Kernel::ComputeAreaDividedByPi_3` */ typedef unspecified_type Compute_area_divided_by_pi_3; - /*! + /*! a model of `Kernel::ComputeApproximateArea_3` */ typedef unspecified_type Compute_approximate_area_3; - /*! + /*! a model of `Kernel::ComputeDeterminant_3` */ typedef unspecified_type Compute_determinant_3; @@ -1227,32 +1227,32 @@ public: */ typedef unspecified_type Compute_scalar_product_3; - /*! + /*! a model of `Kernel::ComputeSquaredDistance_3` */ typedef unspecified_type Compute_squared_distance_3; - /*! + /*! a model of `Kernel::ComputeSquaredLength_3` */ typedef unspecified_type Compute_squared_length_3; - /*! + /*! a model of `Kernel::ComputeSquaredLengthDividedByPiSquare_3` */ typedef unspecified_type Compute_squared_length_divided_by_pi_square_3; - /*! + /*! a model of `Kernel::ComputeApproximateSquaredLength_3` */ typedef unspecified_type Compute_approximate_squared_length_3; - /*! + /*! a model of `Kernel::ComputeSquaredRadius_3` */ typedef unspecified_type Compute_squared_radius_3; - /*! + /*! a model of `Kernel::ComputeVolume_3` */ typedef unspecified_type Compute_volume_3; @@ -1262,82 +1262,82 @@ public: /// \name Three-dimensional Generalized Predicates /// @{ - /*! + /*! a model of `Kernel::Angle_3` */ typedef unspecified_type Angle_3; - /*! + /*! a model of `Kernel::Equal_3` */ typedef unspecified_type Equal_3; - /*! + /*! a model of `Kernel::EqualX_3` */ typedef unspecified_type Equal_x_3; - /*! + /*! a model of `Kernel::EqualY_3` */ typedef unspecified_type Equal_y_3; - /*! + /*! a model of `Kernel::EqualZ_3` */ typedef unspecified_type Equal_z_3; - /*! + /*! a model of `Kernel::EqualXY_3` */ typedef unspecified_type Equal_xy_3; - /*! + /*! a model of `Kernel::LessX_3` */ typedef unspecified_type Less_x_3; - /*! + /*! a model of `Kernel::LessY_3` */ typedef unspecified_type Less_y_3; - /*! + /*! a model of `Kernel::LessZ_3` */ typedef unspecified_type Less_z_3; - /*! + /*! a model of `Kernel::LessXY_3` */ typedef unspecified_type Less_xy_3; - /*! + /*! a model of `Kernel::LessXYZ_3` */ typedef unspecified_type Less_xyz_3; - /*! + /*! a model of `Kernel::CompareX_3` */ typedef unspecified_type Compare_x_3; - /*! + /*! a model of `Kernel::CompareY_3` */ typedef unspecified_type Compare_y_3; - /*! + /*! a model of `Kernel::CompareZ_3` */ typedef unspecified_type Compare_z_3; - /*! + /*! a model of `Kernel::CompareXY_3` */ typedef unspecified_type Compare_xy_3; - /*! + /*! a model of `Kernel::CompareXYZ_3` */ typedef unspecified_type Compare_xyz_3; @@ -1347,132 +1347,132 @@ public: */ typedef unspecified_type Compare_squared_distance_3; - /*! + /*! a model of `Kernel::LessSignedDistanceToPlane_3` */ typedef unspecified_type Less_signed_distance_to_plane_3; - /*! + /*! a model of `Kernel::LessDistanceToPoint_3` */ typedef unspecified_type Less_distance_to_point_3; - /*! + /*! a model of `Kernel::CompareDihedralAngle_3` */ typedef unspecified_type Compare_dihedral_angle_3; - /*! + /*! a model of `Kernel::CompareDistance_3` */ typedef unspecified_type Compare_distance_3; - /*! + /*! a model of `Kernel::Collinear_3` */ typedef unspecified_type Collinear_3; - /*! + /*! a model of `Kernel::Coplanar_3` */ typedef unspecified_type Coplanar_3; - /*! + /*! a model of `Kernel::Orientation_3` */ typedef unspecified_type Orientation_3; - /*! + /*! a model of `Kernel::CoplanarOrientation_3` */ typedef unspecified_type Coplanar_orientation_3; - /*! + /*! a model of `Kernel::CoplanarSideOfBoundedCircle_3` */ typedef unspecified_type Coplanar_side_of_bounded_circle_3; - /*! + /*! a model of `Kernel::SideOfOrientedSphere_3` */ typedef unspecified_type Side_of_oriented_sphere_3; - /*! + /*! a model of `Kernel::SideOfBoundedSphere_3` */ typedef unspecified_type Side_of_bounded_sphere_3; - /*! + /*! a model of `Kernel::IsDegenerate_3` */ typedef unspecified_type Is_degenerate_3; - /*! + /*! a model of `Kernel::HasOn_3` */ typedef unspecified_type Has_on_3; - /*! + /*! a model of `Kernel::HasOnBoundedSide_3` */ typedef unspecified_type Has_on_bounded_side_3; - /*! + /*! a model of `Kernel::HasOnUnboundedSide_3` */ typedef unspecified_type Has_on_unbounded_side_3; - /*! + /*! a model of `Kernel::HasOnBoundary_3` */ typedef unspecified_type Has_on_boundary_3; - /*! + /*! a model of `Kernel::HasOnPositiveSide_3` */ typedef unspecified_type Has_on_positive_side_3; - /*! + /*! a model of `Kernel::HasOnNegativeSide_3` */ typedef unspecified_type Has_on_negative_side_3; - /*! + /*! a model of `Kernel::OrientedSide_3` */ typedef unspecified_type Oriented_side_3; - /*! + /*! a model of `Kernel::BoundedSide_3` */ typedef unspecified_type Bounded_side_3; - /*! + /*! a model of `Kernel::AreParallel_3` */ typedef unspecified_type Are_parallel_3 ; - /*! + /*! a model of `Kernel::AreOrderedAlongLine_3` */ typedef unspecified_type Are_ordered_along_line_3 ; - /*! + /*! a model of `Kernel::AreStrictlyOrderedAlongLine_3` */ typedef unspecified_type Are_strictly_ordered_along_line_3; - /*! + /*! a model of `Kernel::CollinearAreOrderedAlongLine_3` */ typedef unspecified_type Collinear_are_ordered_along_line_3; - /*! + /*! a model of `Kernel::CollinearAreStrictlyOrderedAlongLine_3` */ typedef unspecified_type Collinear_are_strictly_ordered_along_line_3; - /*! + /*! a model of `Kernel::DoIntersect_3` */ typedef unspecified_type Do_intersect_3; @@ -1490,7 +1490,7 @@ public: /// @{ - /*! + /*! */ Kernel::Construct_vector_2 construct_vector_2_object() const ; diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Aff_transformation_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Aff_transformation_d.h index b6cd2b7d70f..1064a5c71c3 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Aff_transformation_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Aff_transformation_d.h @@ -30,12 +30,12 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ typedef unspecified_type LA; -/*! +/*! the matrix type. */ typedef unspecified_type Matrix; @@ -45,20 +45,20 @@ typedef unspecified_type Matrix; /// \name Creation /// @{ -/*! +/*! introduces some transformation. */ Aff_transformation_d(); -/*! +/*! introduces the identity transformation in \f$ d\f$-dimensional space. */ Aff_transformation_d(int d, Identity_transformation); -/*! +/*! introduces the transformation of \f$ d\f$-space specified by matrix \f$ M\f$. @@ -66,7 +66,7 @@ transformation of \f$ d\f$-space specified by matrix \f$ M\f$. */ Aff_transformation_d(Matrix M); -/*! +/*! introduces the transformation of \f$ d\f$-space specified by a diagonal matrix with entries `set [start,end)` on the diagonal (a scaling of the space). @@ -77,13 +77,13 @@ template Aff_transformation_d(Scaling, Forward_iterator start, Forward_iterator end); -/*! +/*! introduces the translation by vector \f$ v\f$. */ Aff_transformation_d(Translation, Vector_d v); -/*! +/*! returns a scaling by a scale factor `num/den`. \pre `den != 0 `. @@ -91,7 +91,7 @@ returns a scaling by a scale factor `num/den`. Aff_transformation_d(int d, Scaling, RT num, RT den); -/*! +/*! returns a planar rotation with sine and cosine values `sin_num/den` and `cos_num/den` in the plane spanned by the base vectors \f$ b_{e1}\f$ and \f$ b_{e2}\f$ in @@ -105,7 +105,7 @@ in the plane spanned by the base vectors \f$ b_{e1}\f$ and \f$ b_{e2}\f$ in Aff_transformation_d(int d, Rotation, RT sin_num, RT cos_num, RT den, int e1 = 0, int e2 = 1); -/*! +/*! returns a planar rotation within a two-dimensional linear subspace. The subspace is spanned by the base vectors \f$ b_{e1}\f$ and \f$ b_{e2}\f$ in \f$ d\f$-space. The @@ -123,18 +123,18 @@ dir, RT num, RT den, int e1 = 0, int e2 = 1); /// \name Operations /// @{ -/*! +/*! the dimension of the underlying space */ int dimension() ; -/*! +/*! returns the transformation matrix */ const Matrix& matrix() ; -/*! +/*! returns the inverse transformation. @@ -142,7 +142,7 @@ transformation. */ Aff_transformation_d inverse() ; -/*! +/*! composition of transformations. Note that transformations are not necessarily commutative. `t*s` is the transformation which transforms first by `t` and then by diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h index 1ca4aa56262..0e5f4fcb4ec 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Direction_d.h @@ -34,18 +34,18 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ typedef unspecified_type LA; -/*! +/*! a read-only iterator for the deltas of `dir`. */ typedef unspecified_type Delta_const_iterator; -/*! +/*! construction tag. */ typedef unspecified_type Base_direction; @@ -55,20 +55,20 @@ typedef unspecified_type Base_direction; /// \name Creation /// @{ -/*! +/*! introduces a variable `dir` of type `Direction_d`. */ Direction_d(); -/*! +/*! introduces a variable `dir` of type `Direction_d` initialized to the direction of `v`. */ Direction_d(Vector_d v); -/*! +/*! introduces a variable `dir` of type `Direction_d` in dimension `d` with representation tuple `set [first,last)`. @@ -78,7 +78,7 @@ dimension `d` with representation tuple `set [first,last)`. template Direction_d(int d, InputIterator first, InputIterator last); -/*! +/*! returns a variable `dir` of type `Direction_d` initialized to the direction of the \f$ i\f$-th base vector of dimension \f$ d\f$. @@ -87,14 +87,14 @@ direction of the \f$ i\f$-th base vector of dimension \f$ d\f$. */ Direction_d(int d, Base_direction, int i); -/*! +/*! introduces a variable `dir` of type `Direction_d` in \f$ 2\f$-dimensional space. */ Direction_d(RT x, RT y); -/*! +/*! introduces a variable `dir` of type `Direction_d` in \f$ 3\f$-dimensional space. @@ -106,63 +106,63 @@ Direction_d(RT x, RT y, RT z); /// \name Operations /// @{ -/*! +/*! returns the dimension of `dir`. */ int dimension() ; -/*! +/*! returns the \f$ i\f$-th component of `dir`. \pre \f$ 0 \leq i < d\f$. */ RT delta(int i) ; -/*! +/*! returns the \f$ i\f$-th delta of `dir`. \pre \f$ 0 \leq i < d\f$. */ RT operator[](int i) ; -/*! +/*! returns an iterator pointing to the first delta of `dir`. */ Delta_const_iterator deltas_begin() ; -/*! +/*! returns an iterator pointing beyond the last delta of `dir`. */ Delta_const_iterator deltas_end() ; -/*! +/*! returns a vector pointing in direction `dir`. */ Vector_d vector() ; -/*! +/*! returns true iff `dir.delta(i)==0` for all \f$ 0\leq i < d\f$. */ bool is_degenerate() ; -/*! +/*! returns \f$ t(p)\f$. */ Direction_d transform(const Aff_transformation_d& t) ; -/*! +/*! returns the direction opposite to `dir`. */ Direction_d opposite() ; -/*! +/*! returns the direction opposite to `dir`. */ diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h index a2048f4c26f..34b901989bf 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Hyperplane_d.h @@ -38,12 +38,12 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ typedef unspecified_type LA; -/*! +/*! a read-only iterator for the coefficients. */ @@ -54,13 +54,13 @@ typedef unspecified_type Coefficient_const_iterator; /// \name Creation /// @{ -/*! +/*! introduces a variable `h` of type `Hyperplane_d`. */ Hyperplane_d(); -/*! +/*! introduces a variable `h` of type `Hyperplane_d` initialized to the hyperplane with coefficients `set [first,last)` and `D`. @@ -70,7 +70,7 @@ hyperplane with coefficients `set [first,last)` and `D`. template Hyperplane_d(int d, InputIterator first, InputIterator last, RT D); -/*! +/*! introduces a variable `h` of type `Hyperplane_d` initialized to the hyperplane with coefficients `set [first,last)`. @@ -81,7 +81,7 @@ with coefficients `set [first,last)`. template Hyperplane_d(int d, InputIterator first, InputIterator last); -/*! +/*! constructs some hyperplane that passes through the points in `set [first,last)`. If `side` is `ON_POSITIVE_SIDE` or `ON_NEGATIVE_SIDE` then `o` is on that side of the @@ -94,7 +94,7 @@ template Hyperplane_d(ForwardIterator first, ForwardIterator last, Point_d o, Oriented_side side = ON_ORIENTED_BOUNDARY); -/*! +/*! constructs the hyperplane with normal direction `dir` that passes through \f$ p\f$. The direction `dir` points into the positive side. @@ -104,14 +104,14 @@ side. Hyperplane_d(Point_d p, Direction_d dir); -/*! +/*! introduces a variable `h` of type `Hyperplane_d` in \f$ 2\f$-dimensional space with equation \f$ ax+by+c=0\f$. */ Hyperplane_d(RT a, RT b, RT c); -/*! +/*! introduces a variable `h` of type `Hyperplane_d` in \f$ 3\f$-dimensional space with equation \f$ ax+by+cz+d=0\f$. @@ -123,12 +123,12 @@ Hyperplane_d(RT a, RT b, RT c, RT d); /// \name Operations /// @{ -/*! +/*! returns the dimension of `h`. */ int dimension() ; -/*! +/*! returns the \f$ i\f$-th coefficient of `h`. @@ -136,7 +136,7 @@ returns the \f$ i\f$-th coefficient of */ RT operator[](int i) ; -/*! +/*! returns the \f$ i\f$-th coefficient of `h`. @@ -144,19 +144,19 @@ returns the \f$ i\f$-th coefficient of */ RT coefficient(int i) ; -/*! +/*! returns an iterator pointing to the first coefficient. */ Coefficient_const_iterator coefficients_begin() ; -/*! +/*! returns an iterator pointing beyond the last coefficient. */ Coefficient_const_iterator coefficients_end() ; -/*! +/*! returns the orthogonal vector of `h`. It points from the negative halfspace into the positive halfspace and its homogeneous coordinates are \f$ (c_0, @@ -164,14 +164,14 @@ positive halfspace and its homogeneous coordinates are \f$ (c_0, */ Vector_d orthogonal_vector() ; -/*! +/*! returns the orthogonal direction of `h`. It points from the negative halfspace into the positive halfspace. */ Direction_d orthogonal_direction() ; -/*! +/*! returns the side of the hyperplane `h` containing \f$ p\f$. @@ -179,7 +179,7 @@ the side of the hyperplane `h` containing \f$ p\f$. */ Oriented_side oriented_side(const Point_d& p) ; -/*! +/*! returns true iff point `p` lies on the hyperplane `h`. @@ -187,14 +187,14 @@ returns true iff point */ bool has_on(const Point_d& p) ; -/*! +/*! returns true iff point `p` lies on the boundary of hyperplane `h`. \pre `h.dimension() == p.dimension()`. */ bool has_on_boundary(const Point_d& p) ; -/*! +/*! returns true iff point `p` lies on the positive side of hyperplane `h`. @@ -203,7 +203,7 @@ true iff point `p` lies on the positive side of hyperplane */ bool has_on_positive_side(const Point_d& p) ; -/*! +/*! returns true iff point `p` lies on the negative side of hyperplane `h`. @@ -212,7 +212,7 @@ true iff point `p` lies on the negative side of hyperplane */ bool has_on_negative_side(const Point_d& p) ; -/*! +/*! returns \f$ t(h)\f$. \pre `h.dimension() == t.dimension()`. @@ -225,7 +225,7 @@ Hyperplane_d transform(const Aff_transformation_d& t) }; /* end Hyperplane_d */ -/*! +/*! test for weak equality. \pre `h1.dimension() == h2.dimension()`. diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Iso_box_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Iso_box_d.h index 7d2b124f468..b8accff25e5 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Iso_box_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Iso_box_d.h @@ -15,7 +15,7 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an iso-oriented iso-box `b` with diagonal opposite vertices \f$ p\f$ and \f$ q\f$. @@ -28,23 +28,23 @@ const Point_d &q); /// \name Operations /// @{ -/*! +/*! Test for equality: two iso-oriented cuboid are equal, iff their lower left and their upper right vertices are equal. */ bool operator==(const Iso_box_d& b2) const; -/*! +/*! Test for inequality. */ bool operator!=(const Iso_box_d& b2) const; -/*! +/*! returns the smallest vertex of `b`. */ const Point_d& min() const; -/*! +/*! returns the largest vertex of `b`. */ const Point_d& max() const; @@ -54,13 +54,13 @@ const Point_d& max() const; /// \name Predicates /// @{ -/*! +/*! `b` is degenerate, if all vertices are collinear. */ bool is_degenerate() const; -/*! +/*! returns either `ON_UNBOUNDED_SIDE`, `ON_BOUNDED_SIDE`, or the constant `ON_BOUNDARY`, @@ -68,17 +68,17 @@ depending on where point \f$ p\f$ is. */ Bounded_side bounded_side(const Point_d& p) const; -/*! +/*! */ bool has_on_boundary(const Point_d& p) const; -/*! +/*! */ bool has_on_bounded_side(const Point_d& p) const; -/*! +/*! */ bool has_on_unbounded_side(const Point_d& p) const; @@ -88,7 +88,7 @@ bool has_on_unbounded_side(const Point_d& p) const; /// \name Miscellaneous /// @{ -/*! +/*! returns the volume of `b`. */ Kernel_d::FT volume() const; diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Line_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Line_d.h index a12b110f08f..c6b015d9938 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Line_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Line_d.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ @@ -35,13 +35,13 @@ typedef unspecified_type LA; /// \name Creation /// @{ -/*! +/*! introduces a variable `l` of type `Line_d`. */ Line_d(); -/*! +/*! introduces a line through `p` and `q` and oriented from `p` to `q`. @@ -50,7 +50,7 @@ line through `p` and `q` and oriented from `p` to */ Line_d(Point_d p, Point_d q); -/*! +/*! introduces a line through `p` with direction `dir`. @@ -58,7 +58,7 @@ a line through `p` with direction `dir`. */ Line_d(Point_d p, Direction_d dir); -/*! +/*! introduces a variable `l` of type `Line_d` and initializes it to the line through `s.source()` and `s.target()` with direction from @@ -68,7 +68,7 @@ introduces a variable */ Line_d(Segment_d s); -/*! +/*! introduces a variable `l` of type `Line_d` and initializes it to the line through `r.point(1)` and `r.point(2)`. @@ -80,13 +80,13 @@ Line_d(Ray_d r); /// \name Operations /// @{ -/*! +/*! returns the dimension of the ambient space. */ int dimension(); -/*! +/*! returns an arbitrary point on `l`. It holds that `point(i) == point(j)`, iff `i==j`. Furthermore, `l` is directed from `point(i)` to @@ -94,19 +94,19 @@ returns an arbitrary point on */ Point_d point(int i) ; -/*! +/*! returns the line `(point(2),point(1))` of opposite direction. */ Line_d opposite() ; -/*! +/*! returns the direction of `l`. */ Direction_d direction(); -/*! +/*! returns \f$ t(l)\f$. \pre `l.dimension()==t.dimension()`. @@ -114,14 +114,14 @@ returns \f$ t(l)\f$. Line_d transform(const Aff_transformation_d & t); -/*! +/*! returns `l+v`, i.e., `l` translated by vector \f$ v\f$. \pre `l.dimension()==v.dimension()`. */ Line_d operator+(const Vector_d& v); -/*! +/*! returns the point of intersection of `l` with the hyperplane that is orthogonal to `l` and that contains `p`. @@ -130,7 +130,7 @@ orthogonal to `l` and that contains `p`. */ Point_d projection(const Point_d& p) ; -/*! +/*! returns true if \f$ p\f$ lies on `l` and false otherwise. @@ -143,7 +143,7 @@ bool has_on(const Point_d& p) ; }; /* end Line_d */ -/*! +/*! Test for equality as unoriented lines \pre `l1.dimension()==l2.dimension()`. @@ -151,7 +151,7 @@ Test for equality as unoriented lines */ bool weak_equality(const Line_d& l1, const Line_d& l2) ; -/*! +/*! returns true if `l1` and `l2` are parallel as unoriented lines and false otherwise. diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h index b010e3c88c0..58aa146932a 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Point_d.h @@ -36,18 +36,18 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ typedef unspecified_type LA; -/*! +/*! a read-only iterator for the %Cartesian coordinates. */ typedef unspecified_type Cartesian_const_iterator; -/*! +/*! a read-only iterator for the homogeneous coordinates. */ @@ -58,20 +58,20 @@ typedef unspecified_type Homogeneous_const_iterator; /// \name Creation /// @{ -/*! +/*! introduces a variable `p` of type `Point_d`. */ Point_d(); -/*! +/*! introduces a variable `p` of type `Point_d` in \f$ d\f$-dimensional space, initialized to the origin. */ Point_d(int d, Origin); -/*! +/*! introduces a variable `p` of type `Point_d` in dimension `d`. If `size [first,last) == d` this creates a point with %Cartesian coordinates `set [first,last)`. If `size [first,last) == d+1` the range @@ -85,7 +85,7 @@ where the sign chosen is the sign of \f$ h_d\f$. template Point_d(int d, InputIterator first, InputIterator last); -/*! +/*! introduces a variable `p` of type `Point_d` in dimension `d` initialized to the point with homogeneous coordinates as defined by @@ -99,14 +99,14 @@ The sign chosen is the sign of \f$ D\f$. template Point_d(int d, InputIterator first, InputIterator last, RT D); -/*! +/*! introduces a variable `p` of type `Point_d` in \f$ 2\f$-dimensional space. \pre \f$ w \neq0\f$. */ Point_d(RT x, RT y, RT w = 1); -/*! +/*! introduces a variable `p` of type `Point_d` in \f$ 3\f$-dimensional space. @@ -120,13 +120,13 @@ Point_d(RT x, RT y, RT z, RT w); /// \name Operations /// @{ -/*! +/*! returns the dimension of `p`. */ int dimension() ; -/*! +/*! returns the \f$ i\f$-th %Cartesian coordinate of `p`. @@ -134,7 +134,7 @@ coordinate of `p`. */ FT cartesian(int i) ; -/*! +/*! returns the \f$ i\f$-th %Cartesian coordinate of `p`. @@ -142,7 +142,7 @@ coordinate of `p`. */ FT operator[](int i) ; -/*! +/*! returns the \f$ i\f$-th homogeneous coordinate of `p`. @@ -150,35 +150,35 @@ coordinate of `p`. */ RT homogeneous(int i) ; -/*! +/*! returns an iterator pointing to the zeroth %Cartesian coordinate \f$ p_0\f$ of `p`. */ Cartesian_const_iterator cartesian_begin() ; -/*! +/*! returns an iterator pointing beyond the last %Cartesian coordinate of `p`. */ Cartesian_const_iterator cartesian_end() ; -/*! +/*! returns an iterator pointing to the zeroth homogeneous coordinate \f$ h_0\f$ of `p`. */ Homogeneous_const_iterator homogeneous_begin() ; -/*! +/*! returns an iterator pointing beyond the last homogeneous coordinate of `p`. */ Homogeneous_const_iterator homogeneous_end() ; -/*! +/*! returns \f$ t(p)\f$. */ Point_d transform(const Aff_transformation_d& t) @@ -189,13 +189,13 @@ Point_d transform(const Aff_transformation_d& t) /// \name Arithmetic Operators, Tests and IO /// @{ -/*! +/*! returns the vector \f$ p-O\f$. */ Vector_d operator-(const Origin& o) ; -/*! +/*! returns \f$ p - q\f$. @@ -203,7 +203,7 @@ q\f$. */ Vector_d operator-(const Point_d& q) ; -/*! +/*! returns \f$ p + v\f$. @@ -211,7 +211,7 @@ v\f$. */ Point_d operator+(const Vector_d& v) ; -/*! +/*! returns \f$ p - v\f$. @@ -219,7 +219,7 @@ v\f$. */ Point_d operator-(const Vector_d& v) ; -/*! +/*! adds `v` to `p`. @@ -227,7 +227,7 @@ to `p`. */ Point_d& operator+=(const Vector_d& v); -/*! +/*! subtracts `v` from `p`. @@ -235,7 +235,7 @@ subtracts */ Point_d& operator-=(const Vector_d& v); -/*! +/*! returns true if `p` is the origin. */ diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Ray_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Ray_d.h index 1e20758161c..91eb3445f48 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Ray_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Ray_d.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ @@ -35,13 +35,13 @@ typedef unspecified_type LA; /// \name Creation /// @{ -/*! +/*! introduces some ray in \f$ d\f$-dimensional space. */ Ray_d(); -/*! +/*! introduces a ray through `p` and `q` and starting at `p`. @@ -51,7 +51,7 @@ through `p` and `q` and starting at `p`. */ Ray_d(Point_d p, Point_d q); -/*! +/*! introduces a ray starting in `p` with direction `dir`. @@ -61,7 +61,7 @@ a ray starting in `p` with direction `dir`. */ Ray_d(Point_d p, Direction_d dir); -/*! +/*! introduces a ray through `s.source()` and `s.target()` and starting at `s.source()`. @@ -75,19 +75,19 @@ Ray_d(Segment_d s); /// \name Operations /// @{ -/*! +/*! returns the dimension of the ambient space. */ int dimension() ; -/*! +/*! returns the source point of `r`. */ Point_d source() ; -/*! +/*! returns a point on `r`. `point(0)` is the source. `point(i)`, with \f$ i>0\f$, is different from the source. @@ -96,25 +96,25 @@ different from the source. */ Point_d point(int i) ; -/*! +/*! returns the direction of `r`. */ Direction_d direction() ; -/*! +/*! returns the supporting line of `r`. */ Line_d supporting_line() ; -/*! +/*! returns the ray with direction opposite to `r` and starting in `source`. */ Ray_d opposite() ; -/*! +/*! returns \f$ t(r)\f$. \pre `r.dimension()==t.dimension()`. @@ -122,7 +122,7 @@ returns \f$ t(r)\f$. Ray_d transform(const Aff_transformation_d& t) ; -/*! +/*! returns `r+v`, i.e., `r` translated by vector \f$ v\f$. @@ -130,7 +130,7 @@ returns */ Ray_d operator+(const Vector_d& v) ; -/*! +/*! A point is on `r`, iff it is equal to the source of `r`, or if it is in the interior of `r`. @@ -144,7 +144,7 @@ bool has_on(const Point_d& p) ; }; /* end Ray_d */ -/*! +/*! returns true if the unoriented supporting lines of `r1` and `r2` are parallel and false otherwise. diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Segment_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Segment_d.h index 383f8e72a21..72460d756c2 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Segment_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Segment_d.h @@ -28,7 +28,7 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ typedef unspecified_type LA; @@ -38,13 +38,13 @@ typedef unspecified_type LA; /// \name Creation /// @{ -/*! +/*! introduces a variable `s` of type `Segment_d`. */ Segment_d(); -/*! +/*! introduces a variable `s` of type `Segment_d` which is initialized to the segment \f$ (p,q)\f$. @@ -53,7 +53,7 @@ the segment \f$ (p,q)\f$. */ Segment_d(Point_d p, Point_d q); -/*! +/*! introduces a variable `s` of type `Segment_d` which is initialized to the segment `(p,p+v)`. @@ -67,25 +67,25 @@ Segment_d(Point_d p, Vector_d v); /// \name Operations /// @{ -/*! +/*! returns the dimension of the ambient space. */ int dimension(); -/*! +/*! returns the source point of segment `s`. */ Point_d source(); -/*! +/*! returns the target point of segment `s`. */ Point_d target(); -/*! +/*! returns source or target of `s`: `vertex(0)` returns the source, `vertex(1)` returns the target. The parameter \f$ i\f$ is taken modulo \f$ 2\f$, which gives easy @@ -95,35 +95,35 @@ access to the other vertex. */ Point_d vertex(int i) ; -/*! +/*! returns `vertex(i)`. */ Point_d point(int i) ; -/*! +/*! returns `vertex(i)`. */ Point_d operator[](int i) ; -/*! +/*! returns the lexicographically smaller vertex. */ Point_d min() ; -/*! +/*! returns the lexicographically larger vertex. */ Point_d max() ; -/*! +/*! returns the segment `(target(),source())`. */ Segment_d opposite() ; -/*! +/*! returns the direction from source to target. @@ -131,19 +131,19 @@ source to target. */ Direction_d direction() ; -/*! +/*! returns the vector from source to target. */ Vector_d vector() ; -/*! +/*! returns the square of the length of `s`. */ FT squared_length() ; -/*! +/*! returns true if \f$ p\f$ lies on `s` and false otherwise. @@ -151,7 +151,7 @@ on `s` and false otherwise. */ bool has_on(const Point_d& p) ; -/*! +/*! returns the supporting line of `s`. @@ -159,7 +159,7 @@ of `s`. */ Line_d supporting_line() ; -/*! +/*! returns \f$ t(s)\f$. \pre `s.dimension()==t.dimension()`. @@ -167,7 +167,7 @@ returns \f$ t(s)\f$. Segment_d transform(const Aff_transformation_d& t) ; -/*! +/*! returns \f$ s+v\f$, i.e., `s` translated by vector \f$ v\f$. @@ -175,7 +175,7 @@ returns */ Segment_d operator+(const Vector_d& v) ; -/*! +/*! returns true if `s` is degenerate i.e.\ `s.source()=s.target()`. */ @@ -185,7 +185,7 @@ bool is_degenerate() ; }; /* end Segment_d */ -/*! +/*! Test for equality as unoriented segments. @@ -194,7 +194,7 @@ segments. */ bool weak_equality(const Segment_d& s1, const Segment_d& s2) ; -/*! +/*! return true if one of the segments is degenerate or if the unoriented supporting lines are parallel. @@ -204,7 +204,7 @@ unoriented supporting lines are parallel. bool parallel(const Segment_d& s1, const Segment_d& s2) ; -/*! +/*! if `s1` and `s2` touch in a common end point, this point is assigned to `common` and the result is `true`, otherwise the result is `false`. If diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h index 05cee94e4dd..51c3a02be79 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Sphere_d.h @@ -32,12 +32,12 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ typedef unspecified_type LA; -/*! +/*! a read-only iterator for points defining the sphere. */ @@ -48,13 +48,13 @@ typedef unspecified_type point_iterator; /// \name Creation /// @{ -/*! +/*! introduces a variable `S` of type `Sphere_d`. */ Sphere_d(); -/*! +/*! introduces a variable `S` of type `Sphere_d`. `S` is initialized to the sphere through the points in `A = tuple [first,last)`. @@ -71,12 +71,12 @@ ForwardIterator first, ForwardIterator last); /// \name Operations /// @{ -/*! +/*! returns the dimension of the ambient space. */ int dimension(); -/*! +/*! returns the \f$ i\f$th defining point. @@ -84,38 +84,38 @@ point. */ Point_d point(int i) ; -/*! +/*! returns an iterator pointing to the first defining point. */ point_iterator points_begin() ; -/*! +/*! returns an iterator pointing beyond the last defining point. */ point_iterator points_end() ; -/*! +/*! returns true iff the defining points are not full dimensional. */ bool is_degenerate(); -/*! +/*! returns true iff the set of defining points is legal. A set of defining points is legal iff their orientation is non-zero or if they are all equal. */ bool is_legal() ; -/*! +/*! returns the center of `S`. \pre `S` is legal. */ Point_d center() ; -/*! +/*! returns the squared radius of the sphere. @@ -123,13 +123,13 @@ sphere. */ FT squared_radius() ; -/*! +/*! returns the orientation of `S`. */ Orientation orientation() ; -/*! +/*! returns either the constant `ON_ORIENTED_BOUNDARY`, `ON_POSITIVE_SIDE`, or `ON_NEGATIVE_SIDE`, iff p lies on the @@ -141,7 +141,7 @@ side of sphere, resp. */ Oriented_side oriented_side(const Point_d& p) ; -/*! +/*! returns `ON_BOUNDED_SIDE`, `ON_BOUNDARY`, or `ON_UNBOUNDED_SIDE` iff p lies properly inside, on the boundary, or properly outside of @@ -151,7 +151,7 @@ sphere, resp. */ Bounded_side bounded_side(const Point_d& p) ; -/*! +/*! returns `S.oriented_side(p)==ON_POSITIVE_SIDE`. @@ -159,7 +159,7 @@ returns */ bool has_on_positive_side (const Point_d& p) ; -/*! +/*! returns `S.oriented_side(p)==ON_NEGATIVE_SIDE`. @@ -167,7 +167,7 @@ returns */ bool has_on_negative_side (const Point_d& p) ; -/*! +/*! returns `S.oriented_side(p)==ON_ORIENTED_BOUNDARY`, which is the same as `S.bounded_side(p)==ON_BOUNDARY`. @@ -176,7 +176,7 @@ returns */ bool has_on_boundary (const Point_d& p) ; -/*! +/*! returns `S.bounded_side(p)==ON_BOUNDED_SIDE`. @@ -184,7 +184,7 @@ returns */ bool has_on_bounded_side (const Point_d& p) ; -/*! +/*! returns `S.bounded_side(p)==ON_UNBOUNDED_SIDE`. @@ -192,14 +192,14 @@ returns */ bool has_on_unbounded_side (const Point_d& p) ; -/*! +/*! returns the sphere with the same center and squared radius as `S` but with opposite orientation. */ Sphere_d opposite() ; -/*! +/*! returns the sphere translated by `v`. @@ -211,7 +211,7 @@ Sphere_d operator+(const Vector_d& v) ; }; /* end Sphere_d */ -/*! +/*! Test for equality as unoriented spheres. \pre `S1.dimension()==S2.dimension()`. \relates Sphere_d diff --git a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h index a2df77c6e33..f074809099a 100644 --- a/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h +++ b/Kernel_d/doc/Kernel_d/CGAL/Kernel_d/Vector_d.h @@ -38,24 +38,24 @@ public: /// \name Types /// @{ -/*! +/*! the linear algebra layer. */ typedef unspecified_type LA; -/*! +/*! a read-only iterator for the %Cartesian coordinates. */ typedef unspecified_type Cartesian_const_iterator; -/*! +/*! a read-only iterator for the homogeneous coordinates. */ typedef unspecified_type Homogeneous_const_iterator; -/*! +/*! construction tag. */ typedef unspecified_type Base_vector; @@ -65,20 +65,20 @@ typedef unspecified_type Base_vector; /// \name Creation /// @{ -/*! +/*! introduces a variable `v` of type `Vector_d`. */ Vector_d(); -/*! +/*! introduces the zero vector `v` of type `Vector_d` in \f$ d\f$-dimensional space. For the creation flag `CGAL::NULL_VECTOR` can be used. */ Vector_d(int d, Null_vector); -/*! +/*! introduces a variable `v` of type `Vector_d` in dimension `d`. If `size [first,last) == d` this creates a vector with %Cartesian @@ -92,7 +92,7 @@ sign chosen is the sign of \f$ h_d\f$. template Vector_d(int d, InputIterator first, InputIterator last); -/*! +/*! introduces a variable `v` of type `Vector_d` in dimension `d` initialized to the vector with homogeneous coordinates as defined by @@ -106,7 +106,7 @@ chosen is the sign of \f$ D\f$. template Vector_d(int d, InputIterator first, InputIterator last, RT D); -/*! +/*! returns a variable `v` of type `Vector_d` initialized to the \f$ i\f$-th base vector of dimension \f$ d\f$. @@ -115,14 +115,14 @@ base vector of dimension \f$ d\f$. */ Vector_d(int d, Base_vector, int i); -/*! +/*! introduces a variable `v` of type `Vector_d` in \f$ 2\f$-dimensional space. \pre \f$ w \neq0\f$. */ Vector_d(RT x, RT y, RT w = 1); -/*! +/*! introduces a variable `v` of type `Vector_d` in \f$ 3\f$-dimensional space. \pre \f$ w \neq0\f$. @@ -134,12 +134,12 @@ Vector_d(RT x, RT y, RT z, RT w); /// \name Operations /// @{ -/*! +/*! returns the dimension of `v`. */ int dimension() ; -/*! +/*! returns the \f$ i\f$-th %Cartesian coordinate of `v`. @@ -147,7 +147,7 @@ coordinate of `v`. */ FT cartesian(int i) ; -/*! +/*! returns the \f$ i\f$-th %Cartesian coordinate of `v`. @@ -155,7 +155,7 @@ coordinate of `v`. */ FT operator[](int i) ; -/*! +/*! returns the \f$ i\f$-th homogeneous coordinate of `v`. @@ -163,46 +163,46 @@ coordinate of `v`. */ RT homogeneous(int i) ; -/*! +/*! returns the square of the length of `v`. */ FT squared_length() ; -/*! +/*! returns an iterator pointing to the zeroth %Cartesian coordinate of `v`. */ Cartesian_const_iterator cartesian_begin() ; -/*! +/*! returns an iterator pointing beyond the last %Cartesian coordinate of `v`. */ Cartesian_const_iterator cartesian_end() ; -/*! +/*! returns an iterator pointing to the zeroth homogeneous coordinate of `v`. */ Homogeneous_const_iterator homogeneous_begin() ; -/*! +/*! returns an iterator pointing beyond the last homogeneous coordinate of `v`. */ Homogeneous_const_iterator homogeneous_end() ; -/*! +/*! returns the direction of `v`. */ Direction_d direction() ; -/*! +/*! returns \f$ t(v)\f$. */ Vector_d transform(const Aff_transformation_d& t) @@ -213,91 +213,91 @@ Vector_d transform(const Aff_transformation_d& t) /// \name Arithmetic Operators, Tests and IO /// @{ -/*! +/*! multiplies all %Cartesian coordinates by `n`. */ Vector_d& operator*=(const RT& n) ; -/*! +/*! multiplies all %Cartesian coordinates by `r`. */ Vector_d& operator*=(const FT& r) ; -/*! +/*! returns the vector with %Cartesian coordinates \f$ v_i/n, 0 \leq i < d\f$. */ Vector_d operator/(const RT& n) ; -/*! +/*! returns the vector with %Cartesian coordinates \f$ v_i/r, 0 \leq i < d\f$. */ Vector_d operator/(const FT& r) ; -/*! +/*! divides all %Cartesian coordinates by `n`. */ Vector_d& operator/=(const RT& n) ; -/*! +/*! divides all %Cartesian coordinates by `r`. */ Vector_d& operator/=(const FT& r) ; -/*! +/*! inner product, i.e., \f$ \sum_{ 0 \le i < d } v_i w_i\f$, where \f$ v_i\f$ and \f$ w_i\f$ are the %Cartesian coordinates of \f$ v\f$ and \f$ w\f$ respectively. */ FT operator* (const Vector_d& w) ; -/*! +/*! returns the vector with %Cartesian coordinates \f$ v_i+w_i, 0 \leq i < d\f$. */ Vector_d operator+(const Vector_d& w) ; -/*! +/*! addition plus assignment. */ Vector_d& operator+=(const Vector_d& w) ; -/*! +/*! returns the vector with %Cartesian coordinates \f$ v_i-w_i, 0 \leq i < d\f$. */ Vector_d operator-(const Vector_d& w) ; -/*! +/*! subtraction plus assignment. */ Vector_d& operator-=(const Vector_d& w) ; -/*! +/*! returns the vector in opposite direction. */ Vector_d operator-() ; -/*! +/*! returns true if `v` is the zero vector. */ bool is_zero() ; -/*! +/*! returns the vector with %Cartesian coordinates \f$ n v_i\f$. */ Vector_d operator*(const RT& n, const Vector_d& v); -/*! +/*! returns the vector with %Cartesian coordinates \f$ r v_i, 0 \leq i < d\f$. */ diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h index b254752bd8f..bedf2157290 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affine_rank_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes the affine rank of the points in `A = tuple [first,last)`. \pre The objects are of the same dimension. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h index 008d21f51a2..901de05dbe4 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Affinely_independent_d.h @@ -11,7 +11,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns true iff the points in `A = tuple [first,last)` are affinely independent. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h index d452b882934..24fc52bc415 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Center_of_sphere_d.h @@ -10,7 +10,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the center of the sphere spanned by the points in `A = tuple [first,last)`. \pre \f$A\f$ contains \f$d+1\f$ affinely independent points of dimension \f$d\f$. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h index ed0e788065a..05278ed2647 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compare_lexicographically_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! Compares the %Cartesian coordinates of points `p` and `q` lexicographically in ascending order of its %Cartesian components `p[i]` and `q[i]` for \f$ i = diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h index e6c836e211c..884fce9e5ec 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Component_accessor_d.h @@ -12,13 +12,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the dimension of \f$ p\f$. */ int dimension(const Kernel_d::Point_d& p); -/*! +/*! returns the ith homogeneous coordinate of \f$ p\f$. \pre `0 <= i <= dimension(p)`. @@ -26,7 +26,7 @@ returns the ith homogeneous coordinate of \f$ p\f$. Kernel_d::RT homogeneous(const Kernel_d::Point_d& p, int i); -/*! +/*! returns the ith %Cartesian coordinate of \f$ p\f$. \pre `0 <= i < dimension(p)`. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h index 4ade1f0059a..d38afd3325b 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Compute_coordinate_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the \f$ i\f$th cartesian coordinate of \f$ p\f$ */ Kernel_d::FT operator()(const Kernel_d::Point_d& diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h index 693963760d8..5adc5241458 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--ConstructCartesianConstIterator_d.h @@ -15,13 +15,13 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns an iterator on the 0'th %Cartesian coordinate of `p`. */ Kernel_d::Cartesian_const_iterator_d operator()(const Kernel_d::Point_d &p); -/*! +/*! returns the past the end iterator of the %Cartesian coordinates of `p`. */ Kernel_d::Cartesian_const_iterator_d operator()(const Kernel_d::Point_d diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h index 59d00fca689..e16c911fed5 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_affine_hull_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! determines whether \f$ p\f$ is contained in the affine hull of the points in `A = tuple [first,last)`. \pre The objects are of the same dimension. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h index 8b0ca118194..eae0bc7cf05 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_linear_hull_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! determines whether \f$ v\f$ is contained in the linear hull of the vectors in `A = tuple [first,last)`. \pre The objects are of the same dimension. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h index 0e2cd945503..6a5db7f56dc 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Contained_in_simplex_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! determines whether \f$ p\f$ is contained in the simplex of the points in `A = tuple [first,last)`. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h index c90a3f25f0d..60300e83d7a 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Equal_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns true iff \f$ p\f$ and \f$ q\f$ are equal (as \f$ d\f$-dimensional points). diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h index 2583d028dc9..99eb66dc298 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Has_on_positive_side_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns true iff \f$ p\f$ is on the positive side of \f$ o\f$. `Kernel_object` may be any of `Kernel_d::Sphere_d`, `Kernel_d::Hyperplane_d`.\pre `p` and `o` have the same dimension. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h index cc4baf958d8..b5afe6cc350 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Intersect_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the result of the intersection of \f$ p\f$ and \f$ q\f$ in form of a stack-based discriminated union container object. `Type1` and `Type2` may be any of `Kernel_d::Segment_d`, `Kernel_d::Ray_d`, `Kernel_d::Line_d`, diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h index 1e71c56e699..2d3001b90eb 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_coordinate_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns `true` iff the \f$ i\f$th %Cartesian coordinate of `p` is smaller than the \f$ i\f$th %Cartesian coordinate of `q`. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h index 5a5db561767..271cfdf43d7 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_lexicographically_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns `true` iff `p` is lexicographically smaller than `q` with respect to %Cartesian lexicographic order of points. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h index 433f66911b1..13e986ac842 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Less_or_equal_lexicographically_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns `true` iff \f$ p\f$ is lexicographically smaller than \f$ q\f$ with respect to %Cartesian lexicographic order of points or equal to \f$ q\f$. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h index 769617412d5..b1402af0763 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Lift_to_paraboloid_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns \f$ p = (x_0,\ldots,x_{d-1})\f$ lifted to the paraboloid of revolution which is the point \f$ (p_0, \ldots,p_{d-1},\sum_{0 \le i < d}p_i^2)\f$ in \f$ (d+1)\f$-space. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h index 9e400469798..7533bdb7276 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_base_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes a basis of the linear space spanned by the vectors in `A = tuple [first,last)` and returns it via an iterator range starting in `result`. The returned diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h index cdab1520ec8..de5003c96d3 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linear_rank_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes the linear rank of the vectors in `A = tuple [first,last)`. \pre \f$ A\f$ contains vectors of the same dimension \f$ d\f$. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h index 0f5b69d5b6e..c07d0c18770 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Linearly_independent_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! decides whether the vectors in `A = tuple [first,last)` are linearly independent. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h index bfd3358c9ac..6a8fad7ddc5 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Midpoint_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes the midpoint of the segment \f$ pq\f$.\pre `p` and `q` have the same dimension. */ diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h index 039ebc3875d..1b152d312ba 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orientation_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! determines the orientation of the points of the tuple `A = tuple [first,last)` where \f$ A\f$ consists of \f$ d + 1\f$ points in \f$ d\f$-space. This is the sign of the determinant diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h index 66ccf63163b..21d0d5de9f5 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Oriented_side_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the side of \f$ p\f$ with respect to \f$ o\f$. `Kernel_object` may be any of `Kernel_d::Sphere_d` or `Kernel_d::Hyperplane_d`. \pre `p` and `o` have the same dimension. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h index bb2780768a3..994031944ff 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Orthogonal_vector_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes an orthogonal vector to \f$ h\f$. */ Kernel_d::Vector_d operator()(const Kernel_d::Hyperplane_d& h); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h index a069495ffce..0d63c27f389 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_dimension_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the dimension of \f$ p\f$. */ int operator()(const Kernel_d::Point_d& diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h index 967df31ff0c..7de600fcbd2 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_of_sphere_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the ith point defining the sphere \f$ s\f$. */ bool operator()(const Kernel_d::Sphere_d& s, int i); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h index 5c57cc66181..5437e1fe8f5 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Point_to_vector_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! converts \f$ p\f$ to its geometric vector. */ Kernel_d::Vector_d operator()(const Kernel_d::Point_d& p); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h index 314374e0fc9..09bfeada680 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Project_along_d_axis_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns \f$ p\f$ projected along the \f$ d\f$-axis onto the hyperspace spanned by the first \f$ d-1\f$ standard base vectors. */ diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h index 0903b592f95..5ecdb6fea14 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_bounded_sphere_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the relative position of point `p` to the sphere defined by `A = tuple [first,last)`. The order of the points of \f$ A\f$ does not matter. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h index feeb04048f2..9f6fdd64e04 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Side_of_oriented_sphere_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! returns the relative position of point `p` to the oriented sphere defined by the points in `A = tuple [first,last)` The order of the points in \f$ A\f$ is important, since it determines the orientation of the implicitly constructed diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h index db0dfdeb5c5..9edbedda509 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Squared_distance_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes the square of the Euclidean distance between the two points \f$ p\f$ and \f$ q\f$. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h index 99268e84b6a..ae937f0961e 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Value_at_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! computes the value of \f$ h\f$ evaluated at \f$ p\f$. diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h index e3859ea5bfa..b5494c67994 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel--Vector_to_point_d.h @@ -12,7 +12,7 @@ public: /// A model of this concept must provide: /// @{ -/*! +/*! converts \f$ v\f$ to the affine point \f$ 0+v\f$. */ Kernel_d::Point_d operator()(const Kernel_d::Vector_d& v); diff --git a/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h b/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h index d93fad26e3d..9c2a9476348 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Kernel_d.h @@ -27,12 +27,12 @@ public: /// \name Types /// @{ -/*! +/*! a number type that is a model for `FieldNumberType` */ typedef unspecified_type FT; -/*! +/*! a number type that is a model for `RingNumberType` */ typedef unspecified_type RT; @@ -42,7 +42,7 @@ typedef unspecified_type RT; /// \name Coordinate Access /// @{ -/*! +/*! a type that allows to iterate over the %Cartesian coordinates */ @@ -53,52 +53,52 @@ typedef unspecified_type Cartesian_const_iterator_d; /// \name Geometric Objects /// @{ -/*! +/*! */ typedef unspecified_type Point_d; -/*! +/*! */ typedef unspecified_type Vector_d; -/*! +/*! */ typedef unspecified_type Direction_d; -/*! +/*! */ typedef unspecified_type Hyperplane_d; -/*! +/*! */ typedef unspecified_type Line_d; -/*! +/*! */ typedef unspecified_type Ray_d; -/*! +/*! */ typedef unspecified_type Segment_d; -/*! +/*! */ typedef unspecified_type Iso_box_d; -/*! +/*! */ typedef unspecified_type Sphere_d; -/*! +/*! */ typedef unspecified_type Aff_transformation_d; @@ -108,127 +108,127 @@ typedef unspecified_type Aff_transformation_d; /// \name Constructions /// @{ -/*! +/*! */ typedef unspecified_type Barycentric_coordinates_d; -/*! +/*! a model of `Kernel_d::Center_of_sphere_d` */ typedef unspecified_type Center_of_sphere_d; -/*! +/*! a model of `Kernel_d::Compute_coordinate_d` */ typedef unspecified_type Compute_coordinate_d; -/*! +/*! */ typedef unspecified_type Construct_point_d; -/*! +/*! */ typedef unspecified_type Construct_vector_d; -/*! +/*! */ typedef unspecified_type Construct_direction_d; -/*! +/*! */ typedef unspecified_type Construct_hyperplane_d; -/*! +/*! */ typedef unspecified_type Construct_segment_d; -/*! +/*! */ typedef unspecified_type Construct_iso_box_d; -/*! +/*! */ typedef unspecified_type Construct_line_d; -/*! +/*! */ typedef unspecified_type Construct_ray_d; -/*! +/*! */ typedef unspecified_type Construct_sphere_d; -/*! +/*! */ typedef unspecified_type Construct_aff_transformation_d; -/*! +/*! a model of `Kernel_d::ConstructCartesianConstIterator_d` */ typedef unspecified_type Construct_cartesian_const_iterator_d; -/*! +/*! a model of `Kernel_d::Intersect_d` */ typedef unspecified_type Intersect_d; -/*! +/*! a model of `Kernel_d::Lift_to_paraboloid_d` */ typedef unspecified_type Lift_to_paraboloid_d; -/*! +/*! a model of `Kernel_d::Linear_base_d` */ typedef unspecified_type Linear_base_d; -/*! +/*! a model of `Kernel_d::Midpoint_d` */ typedef unspecified_type Midpoint_d; -/*! +/*! a model of `Kernel_d::Orthogonal_vector_d` */ typedef unspecified_type Orthogonal_vector_d; -/*! +/*! a model of `Kernel_d::Point_of_sphere_d` */ typedef unspecified_type Point_of_sphere_d; -/*! +/*! a model of `Kernel_d::Point_to_vector_d` */ typedef unspecified_type Point_to_vector_d; -/*! +/*! a model of `Kernel_d::Project_along_d_axis_d` */ typedef unspecified_type Project_along_d_axis_d; -/*! +/*! a model of `Kernel_d::Squared_distance_d` */ typedef unspecified_type Squared_distance_d; -/*! +/*! a model of `Kernel_d::Value_at_d` */ typedef unspecified_type Value_at_d; -/*! +/*! a model of `Kernel_d::Vector_to_point_d` */ typedef unspecified_type Vector_to_point_d; @@ -238,102 +238,102 @@ typedef unspecified_type Vector_to_point_d; /// \name Generalized Predicates /// @{ -/*! +/*! a model of `Kernel_d::Affine_rank_d` */ typedef unspecified_type Affine_rank_d; -/*! +/*! a model of `Kernel_d::Affinely_independent_d` */ typedef unspecified_type Affinely_independent_d; -/*! +/*! a model of `Kernel_d::Compare_lexicographically_d` */ typedef unspecified_type Compare_lexicographically_d; -/*! +/*! a model of `Kernel_d::Component_accessor_d` */ typedef unspecified_type Component_accessor_d; -/*! +/*! a model of `Kernel_d::Contained_in_affine_hull_d` */ typedef unspecified_type Contained_in_affine_hull_d; -/*! +/*! a model of `Kernel_d::Contained_in_linear_hull_d` */ typedef unspecified_type Contained_in_linear_hull_d; -/*! +/*! a model of `Kernel_d::Contained_in_simplex_d` */ typedef unspecified_type Contained_in_simplex_d; -/*! +/*! a model of `Kernel_d::Equal_d` */ typedef unspecified_type Equal_d; -/*! +/*! a model of `Kernel_d::Has_on_positive_side_d` */ typedef unspecified_type Has_on_positive_side_d; -/*! +/*! a model of `Kernel_d::Less_coordinate_d` */ typedef unspecified_type Less_coordinate_d; -/*! +/*! a model of `Kernel_d::Less_lexicographically_d` */ typedef unspecified_type Less_lexicographically_d; -/*! +/*! a model of `Kernel_d::Less_or_equal_lexicographically_d` */ typedef unspecified_type Less_or_equal_lexicographically_d; -/*! +/*! a model of `Kernel_d::Linear_rank_d` */ typedef unspecified_type Linear_rank_d; -/*! +/*! a model of `Kernel_d::Linearly_independent_d` */ typedef unspecified_type Linearly_independent_d; -/*! +/*! a model of `Kernel_d::Orientation_d` */ typedef unspecified_type Orientation_d; -/*! +/*! a model of `Kernel_d::Oriented_side_d` */ typedef unspecified_type Oriented_side_d; -/*! +/*! a model of `Kernel_d::Point_dimension_d` */ typedef unspecified_type Point_dimension_d; -/*! +/*! */ typedef unspecified_type Position_on_line_d; -/*! +/*! a model of `Kernel_d::Side_of_bounded_sphere_d` */ typedef unspecified_type Side_of_bounded_sphere_d; -/*! +/*! a model of `Kernel_d::Side_of_oriented_sphere_d` */ typedef unspecified_type Side_of_oriented_sphere_d; @@ -349,12 +349,12 @@ typedef unspecified_type Side_of_oriented_sphere_d; /// the corresponding functions are: /// @{ -/*! +/*! */ Kernel_d::Construct_point_d construct_point_d_object() const; -/*! +/*! */ Kernel_d::Orientation_d orientation_d_object() const; diff --git a/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h b/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h index 1248c2cd889..c52619321be 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h +++ b/Kernel_d/doc/Kernel_d/Concepts/LinearAlgebraTraits_d.h @@ -24,17 +24,17 @@ public: /// \name Types /// @{ -/*! +/*! the number type of the components. */ typedef unspecified_type NT; -/*! +/*! the vector type. */ typedef unspecified_type Vector; -/*! +/*! the matrix type. */ typedef unspecified_type Matrix; @@ -44,14 +44,14 @@ typedef unspecified_type Matrix; /// \name Operations /// @{ -/*! +/*! returns \f$ M^T\f$ (a `M.column_dimension()` \f$ \times\f$ `M.column_dimension()` - matrix). */ static Matrix transpose(const Matrix& M); -/*! +/*! determines whether `M` has an inverse. It also computes either the inverse as \f$ (1/D) \cdot I\f$ or when no inverse exists, a vector \f$ c\f$ such that \f$ c^T \cdot M = 0 \f$. @@ -60,7 +60,7 @@ inverse exists, a vector \f$ c\f$ such that \f$ c^T \cdot M = 0 \f$. static bool inverse(const Matrix& M, Matrix& I, NT& D, Vector& c); -/*! +/*! returns the inverse matrix of `M`. More precisely, \f$ 1/D\f$ times the matrix returned is the inverse of `M`. @@ -70,7 +70,7 @@ returned is the inverse of `M`. */ static Matrix inverse(const Matrix& M, NT& D) ; -/*! +/*! returns the determinant \f$ D\f$ of `M` and sufficient information to verify that the value of the determinant is correct. If the determinant is zero then \f$ c\f$ is a @@ -86,14 +86,14 @@ q(j)\f$ such that \f$ L \cdot M \cdot Q = U\f$, \f$ L(0,0) = 1\f$, \f$ L(i,i) = static NT determinant (const Matrix& M, Matrix& L, Matrix& U, std::vector& q, Vector& c); -/*! +/*! verifies the conditions stated above. */ static bool verify_determinant (const Matrix& M, NT D, Matrix& L, Matrix& U, const std::vector& q, Vector& c); -/*! +/*! returns the determinant of `M`. @@ -101,7 +101,7 @@ determinant of `M`. */ static NT determinant (const Matrix& M); -/*! +/*! returns the sign of the determinant of `M`. @@ -109,7 +109,7 @@ the sign of the determinant of `M`. */ static int sign_of_determinant (const Matrix& M); -/*! +/*! determines the complete solution space of the linear system \f$ M\cdot x = b\f$. If the system is unsolvable then \f$ c^T \cdot M = 0\f$ and \f$ c^T \cdot b @@ -123,7 +123,7 @@ system. static bool linear_solver(const Matrix& M, const Vector& b, Vector& x, NT& D, Matrix& spanning_vectors, Vector& c); -/*! +/*! determines whether the linear system \f$ M\cdot x = b\f$ is solvable. If yes, then \f$ (1/D) x\f$ is a solution, if not then \f$ c^T \cdot M = 0\f$ and \f$ c^T \cdot b \not= 0\f$. @@ -132,14 +132,14 @@ solution, if not then \f$ c^T \cdot M = 0\f$ and \f$ c^T \cdot b \not= 0\f$. static bool linear_solver(const Matrix& M, const Vector& b, Vector& x, NT& D, Vector& c) ; -/*! +/*! as above, but without the witness \f$ c\f$ \pre `M.row_dimension() = b.dimension()`. */ static bool linear_solver(const Matrix& M, const Vector& b, Vector& x, NT& D) ; -/*! +/*! determines whether the system \f$ M \cdot x = b\f$ is solvable \pre `M.row_dimension() = b.dimension()`. @@ -147,7 +147,7 @@ determines whether the system \f$ M \cdot x = b\f$ is solvable static bool is_solvable(const Matrix& M, const Vector& b) ; -/*! +/*! determines whether the homogeneous linear system \f$ M\cdot x = 0\f$ has a non - trivial solution. If yes, then \f$ x\f$ is such a solution. @@ -155,7 +155,7 @@ such a solution. static bool homogeneous_linear_solver (const Matrix& M, Vector& x); -/*! +/*! determines the solution space of the homogeneous linear system \f$ M\cdot x = 0\f$. It returns the dimension of the solution space. Moreover the columns of `spanning_vecs` @@ -164,14 +164,14 @@ span the solution space. static int homogeneous_linear_solver (const Matrix& M, Matrix& spanning_vecs); -/*! +/*! returns the indices of a maximal subset of independent columns of `M`. */ static int independent_columns (const Matrix& M, std::vector& columns); -/*! +/*! returns the rank of matrix `M` */ diff --git a/Kernel_d/doc/Kernel_d/Concepts/Matrix.h b/Kernel_d/doc/Kernel_d/Concepts/Matrix.h index eaaf781267b..c1728429535 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Matrix.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Matrix.h @@ -15,54 +15,54 @@ public: /// \name Types /// @{ -/*! +/*! the ring type of the components. */ typedef unspecified_type NT; -/*! +/*! bidirectional iterator for accessing all components row-wise. */ typedef unspecified_type iterator; -/*! +/*! bidirectional iterator for accessing all components row-wise. */ typedef unspecified_type const_iterator; -/*! +/*! random access iterator for accessing row entries. */ typedef unspecified_type row_iterator; -/*! +/*! random access iterator for accessing row entries. */ typedef unspecified_type const_row_iterator; -/*! +/*! random access iterator for accessing column entries. */ typedef unspecified_type column_iterator; -/*! +/*! random access iterator for accessing column entries. */ typedef unspecified_type const_column_iterator; -/*! +/*! a tag class for identity initialization */ typedef unspecified_type Identity; -/*! +/*! the vector type used. */ typedef unspecified_type Vector; @@ -72,48 +72,48 @@ typedef unspecified_type Vector; /// \name Creation /// @{ -/*! +/*! creates an instance `M` of type `Matrix`. */ Matrix(); -/*! +/*! creates an instance `M` of type `Matrix` of dimension \f$ n \times n\f$ initialized to the zero matrix. */ Matrix(int n); -/*! +/*! creates an instance `M` of type `Matrix` of dimension \f$ m \times n\f$ initialized to the zero matrix. */ Matrix(int m, int n); -/*! +/*! creates an instance `M` of type `Matrix` of dimension `p.first`\f$ \times\f$`p.second` initialized to the zero matrix. */ Matrix(std::pair p); -/*! +/*! creates an instance `M` of type `Matrix` of dimension \f$ n \times n\f$ initialized to the identity matrix (times `x`). */ Matrix(int n, Identity, NT x = NT(1)); -/*! +/*! creates an instance `M` of type `Matrix` of dimension \f$ m \times n\f$ initialized to the matrix with `x` entries. */ Matrix(int m, int n, NT x); -/*! +/*! creates an instance `M` of type `Matrix`. Let \f$ S\f$ be the ordered set of \f$ n\f$ column-vectors of common dimension \f$ m\f$ as given by the iterator @@ -127,7 +127,7 @@ Note that `Vector` or `std::vector` fulfill these requirements. template Matrix(Forward_iterator first, Forward_iterator last); -/*! +/*! creates an instance `M` of type `Matrix`. Let \f$ A\f$ be an array of \f$ n\f$ column-vectors of common dimension \f$ m\f$. `M` is initialized to an @@ -140,25 +140,25 @@ Matrix(std::vector< Vector > A); /// \name Operations /// @{ -/*! +/*! returns \f$ n\f$, the number of rows of `M`. */ int row_dimension() ; -/*! +/*! returns \f$ m\f$, the number of columns of `M`. */ int column_dimension() ; -/*! +/*! returns \f$ (m,n)\f$, the dimension pair of `M`. */ std::pair dimension() ; -/*! +/*! returns the \f$ i\f$-th row of `M` (an \f$ m\f$ - vector). @@ -166,7 +166,7 @@ returns the \f$ i\f$-th row of `M` (an */ Vector row(int i) ; -/*! +/*! returns the \f$ i\f$-th column of `M` (an \f$ n\f$ - vector). @@ -174,20 +174,20 @@ returns the \f$ i\f$-th column of `M` */ Vector column(int i) ; -/*! +/*! returns \f$ M_{i,j}\f$. \pre \f$ 0\le i\le m-1\f$ and \f$ 0\le j\le n-1\f$. */ NT& operator()(int i, int j) ; -/*! +/*! swaps rows \f$ i\f$ and \f$ j\f$. \pre \f$ 0\le i\le m-1\f$ and \f$ 0\le j\le m-1\f$. */ void swap_rows(int i, int j) ; -/*! +/*! swaps columns \f$ i\f$ and \f$ j\f$. @@ -195,7 +195,7 @@ swaps columns \f$ i\f$ and */ void swap_columns(int i, int j) ; -/*! +/*! an iterator pointing to the first entry of the \f$ i\f$th row. @@ -203,7 +203,7 @@ first entry of the \f$ i\f$th row. */ row_iterator row_begin(int i) ; -/*! +/*! an iterator pointing beyond the last entry of the \f$ i\f$th row. @@ -211,7 +211,7 @@ the last entry of the \f$ i\f$th row. */ row_iterator row_end(int i) ; -/*! +/*! an iterator pointing to the first entry of the \f$ i\f$th row. @@ -219,7 +219,7 @@ first entry of the \f$ i\f$th row. */ const_row_iterator row_begin(int i) const; -/*! +/*! an iterator pointing beyond the last entry of the \f$ i\f$th row. @@ -227,7 +227,7 @@ the last entry of the \f$ i\f$th row. */ const_row_iterator row_end(int i) const; -/*! +/*! an iterator pointing to the first entry of the \f$ i\f$th column. @@ -236,7 +236,7 @@ to the first entry of the \f$ i\f$th column. */ column_iterator column_begin(int i) ; -/*! +/*! an iterator pointing beyond the last entry of the \f$ i\f$th column. @@ -244,7 +244,7 @@ beyond the last entry of the \f$ i\f$th column. */ column_iterator column_end(int i) ; -/*! +/*! an iterator pointing to the first entry of the \f$ i\f$th column. @@ -253,7 +253,7 @@ to the first entry of the \f$ i\f$th column. */ const_column_iterator column_begin(int i) const; -/*! +/*! an iterator pointing beyond the last entry of the \f$ i\f$th column. @@ -262,37 +262,37 @@ beyond the last entry of the \f$ i\f$th column. const_column_iterator column_end(int i) const; -/*! +/*! an iterator pointing to the first entry of \f$ M\f$. */ iterator begin(); -/*! +/*! an iterator pointing beyond the last entry of \f$ M\f$. */ terator end(); -/*! +/*! an iterator pointing to the first entry of \f$ M\f$. */ const_iterator begin() const; -/*! +/*! an iterator pointing beyond the last entry of \f$ M\f$. */ const_terator end() const; -/*! +/*! Test for equality. */ bool operator==(const Matrix& M1) ; -/*! +/*! Test for inequality. */ bool operator!=(const Matrix& M1) ; @@ -302,14 +302,14 @@ bool operator!=(const Matrix& M1) ; /// \name Arithmetic Operators /// @{ -/*! +/*! Addition. \pre `M.row_dimension() == M1.row_dimension()` \pre `M.column_dimension() == M1.column_dimension()` */ Matrix operator+ (const Matrix& M1); -/*! +/*! Subtraction. \pre `M.row_dimension() == M1.row_dimension()` @@ -317,12 +317,12 @@ Subtraction. */ Matrix operator- (const Matrix& M1); -/*! +/*! Negation. */ Matrix operator-(); -/*! +/*! Multiplication. \pre `M.column_dimension() = M1.row_dimension()` @@ -330,7 +330,7 @@ Multiplication. Matrix operator*(const Matrix& M1) ; -/*! +/*! Multiplication with vector. @@ -338,12 +338,12 @@ vector. */ Vector operator*(const Vector& vec) ; -/*! +/*! Multiplication of every entry with `x`. */ Matrix operator*(const NT& x, const Matrix& M); -/*! +/*! Multiplication of every entry with `x`. */ Matrix operator*(const Matrix& M, const NT& x) ; diff --git a/Kernel_d/doc/Kernel_d/Concepts/Vector.h b/Kernel_d/doc/Kernel_d/Concepts/Vector.h index 1cf60dbf7b7..ed8882ec327 100644 --- a/Kernel_d/doc/Kernel_d/Concepts/Vector.h +++ b/Kernel_d/doc/Kernel_d/Concepts/Vector.h @@ -15,17 +15,17 @@ public: /// \name Types /// @{ -/*! +/*! the ring type of the components. */ typedef unspecified_type NT; -/*! +/*! the iterator type for accessing components. */ typedef unspecified_type iterator; -/*! +/*! the const iterator type for accessing components. */ @@ -36,27 +36,27 @@ typedef unspecified_type const_iterator; /// \name Creation /// @{ -/*! +/*! creates an instance `v` of type `Vector`. */ Vector(); -/*! +/*! creates an instance `v` of type `Vector`. `v` is initialized to a vector of dimension \f$ d\f$. */ Vector(int d); -/*! +/*! creates an instance `v` of type `Vector`. `v` is initialized to a vector of dimension \f$ d\f$ with entries `x`. */ Vector(int d, NT x); -/*! +/*! creates an instance `v` of type `Vector`; `v` is initialized to the vector with entries `set [first,last)`. @@ -70,103 +70,103 @@ Vector(Forward_iterator first, Forward_iterator last); /// \name Operations /// @{ -/*! +/*! returns the dimension of `v`. */ int dimension() ; -/*! +/*! returns true iff `v` is the zero vector. */ bool is_zero() ; -/*! +/*! returns the \f$ i\f$-th component of `v`. \pre \f$ 0\le i \le v.dimension()-1\f$. */ NT& operator[](int i) ; -/*! +/*! iterator to the first component. */ iterator begin() ; -/*! +/*! iterator beyond the last component. */ iterator end() ; -/*! +/*! iterator to the first component. */ const_iterator begin() const; -/*! +/*! iterator beyond the last component. */ const_iterator end() const; -/*! +/*! Addition. \pre `v.dimension() == v1.dimension()`. */ Vector operator+(const Vector& v1) ; -/*! +/*! Subtraction. \pre `v.dimension() = v1.dimension()`. */ Vector operator-(const Vector& v1) ; -/*! +/*! Inner Product. \pre `v.dimension() = v1.dimension()`. */ NT operator*(const Vector& v1) ; -/*! +/*! Negation. */ Vector operator-() ; -/*! +/*! Addition plus assignment. \pre `v.dimension() == v1.dimension()`. */ Vector& operator+=(const Vector& v1); -/*! +/*! Subtraction plus assignment. \pre `v.dimension() == v1.dimension()`. */ Vector& operator-=(const Vector& v1); -/*! +/*! Scalar multiplication plus assignment. */ Vector& operator*=(const NT& s); -/*! +/*! Scalar division plus assignment. */ Vector& operator/=(const NT& s); -/*! +/*! Component-wise multiplication with number \f$ r\f$. */ Vector operator*(const NT& r, const Vector& v); -/*! +/*! Component-wise multiplication with number \f$ r\f$. */ Vector operator*(const Vector& v, const NT& r); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h index 8ea629476a4..764bb92ef40 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_2.h @@ -44,12 +44,12 @@ public: /// \name Types /// @{ -/*! +/*! The template argument triangulation. */ typedef unspecified_type Triangulation; -/*! +/*! The template argument for the visitor. */ typedef unspecified_type Visitor; @@ -59,7 +59,7 @@ typedef unspecified_type Visitor; /// \name Creation /// @{ -/*! +/*! Maintain the Delaunay triangulation of the points in `tr.active_points_2_handle()`. @@ -71,22 +71,22 @@ Delaunay_triangulation_2(Traits tr); /// \name Operations /// @{ -/*! +/*! Access the triangulation that is maintained. */ const Triangulation& triangulation() const; -/*! +/*! Access the visitor. */ Visitor& visitor(); -/*! +/*! Insert the point. */ Vertex_handle insert(Point_key k); -/*! +/*! Erase the vertex. */ void erase(Vertex_handle h); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_3.h index 9cc55c47585..ce3bea3bdc3 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_3.h @@ -43,12 +43,12 @@ public: /// \name Types /// @{ -/*! +/*! The template argument. */ typedef unspecified_type Triangulation; -/*! +/*! The template argument. */ typedef unspecified_type Visitor; @@ -58,7 +58,7 @@ typedef unspecified_type Visitor; /// \name Creation /// @{ -/*! +/*! Maintain the Delaunay triangulation of the points in `tr.active_points_3_handle()`. */ Delaunay_triangulation_3(Traits tr); @@ -68,22 +68,22 @@ Delaunay_triangulation_3(Traits tr); /// \name Operations /// @{ -/*! +/*! Access the triangulation that is maintained. */ const Triangulation* triangulation(); -/*! +/*! This method returns true if the `Kinetic::Delaunay_triangulation_3` is currently maintaining certificates for a Delaunay triangulation. */ bool has_certificates(); -/*! +/*! This method allows you to control whether the triangulation is maintaining certificates. */ void set_has_certificates(bool tf); -/*! +/*! Access the visitor. */ Visitor& visitor(); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h index 4a82d930c0c..b8fad0ecd76 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_recent_edges_visitor_2.h @@ -19,12 +19,12 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Delaunay_triangulation_recent_edges_visitor_2(); -/*! +/*! The iterator through the recently created edges. */ typedef unspecified_type iterator; @@ -34,17 +34,17 @@ typedef unspecified_type iterator; /// \name Operations /// @{ -/*! +/*! Begin iteration through the recent edges. */ iterator begin() const; -/*! +/*! End iteration through the recent edges. */ iterator end() const; -/*! +/*! Returns true if this edge exists in the set. */ bool contains(Triangulation::Edge) const; diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h index 22c80411586..77c83ae7fd2 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_2.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Delaunay_triangulation_visitor_base_2(); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h index 1ed05f07292..a790ccede4f 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Delaunay_triangulation_visitor_base_3.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Delaunay_triangulation_default_visitor_3(); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_2.h index 753a248744a..bea5f6b5407 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_2.h @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! The number type used to represent the walls of the box and perform calculations. Generally this is `Traits::NT`. */ typedef unspecified_type NT; @@ -33,7 +33,7 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! This constructs a bounding box with the dimensions specified by the last 4 arguments. They are optional and will take the values \f$ \pm\f$10 if omitted. */ Enclosing_box_2(Traits, NT xmin, NT xmax, NT ymin, NT ymax); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_3.h index 0b7c99d69ad..6876090ccd6 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Enclosing_box_3.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! The number type used to represent the walls of the box and perform calculations. Generally this is `Traits::NT`. */ typedef unspecified_type NT; @@ -34,7 +34,7 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! This constructs a bounding box with the dimensions specified by the last 6 arguments. They are optional and will take the values \f$ \pm\f$10 if omitted. */ Enclosing_box_3(Traits, NT xmin, NT xmax, NT ymin, NT ymax, NT zmin, NT zmax); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h index 119b8ff16a9..e5763ff9fde 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Erase_event.h @@ -42,7 +42,7 @@ public: /// \name Creation /// @{ -/*! +/*! Erase the object `k` from the table `t` when processed. */ Insert_event(ActiveObjectsTable::Key k, diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_moving_points_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_moving_points_2.h index cd6ee3f84ed..981749e8fad 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_moving_points_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_moving_points_2.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Qt_moving_points_2(QtGui::Handle,Traits::Active_points_2_table::Handle); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_triangulation_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_triangulation_2.h index 8301943d852..93d9cafe418 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_triangulation_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_triangulation_2.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! Construct the object and make all the connections with the appropriate other objects. */ Qt_widget_2(KineticTriangulation_2::Handle,QtWidget_2::Handle,QtMovingPoints_2::Handle); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_widget_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_widget_2.h index 0d9cabaf3d9..30b63c502c9 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_widget_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/IO/Qt_widget_2.h @@ -76,7 +76,7 @@ typedef unspecified_type Listener; /// \name Creation /// @{ -/*! +/*! default constructor. */ Qt_widget_2(int argc, char *argv[], Simulator::Handle); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h index 27a5a9b8b0a..b891894773c 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Insert_event.h @@ -42,7 +42,7 @@ public: /// \name Creation /// @{ -/*! +/*! Insert the object o, into the table t when processed. */ diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h index a1370f68f69..0de283cc32e 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Regular_triangulation_visitor_base_3.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Regular_triangulation_default_visitor_3(); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort.h index ca8aaa58545..70290453bd4 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort.h @@ -22,7 +22,7 @@ public: /// \name Creation /// @{ -/*! +/*! The basic constructor. */ Sort(Traits tr); @@ -32,27 +32,27 @@ Sort(Traits tr); /// \name Types /// @{ -/*! +/*! The type of the visitor. */ typedef unspecified_type Visitor; -/*! +/*! The traits type. */ typedef unspecified_type Traits; -/*! +/*! The handle used to refer to vertex in the sorted list. Derefernecing this returns a `Key` into the `ActiveObjectsTable`. */ typedef unspecified_type Vertex_handle; -/*! +/*! A reference counted pointer to be used for storing references to the object. */ typedef unspecified_type Handle; -/*! +/*! A reference counted pointer to be used for storing references to the object. */ typedef unspecified_type Const_handle; @@ -62,22 +62,22 @@ typedef unspecified_type Const_handle; /// \name Operations /// @{ -/*! +/*! Access the visitor. */ Visitor& visitor(); -/*! +/*! Access the traits. */ Traits& traits(); -/*! +/*! Insert the point. */ Vertex_handle insert(Point_key k); -/*! +/*! Erase the point. */ void erase(Vertex_handle k); @@ -88,12 +88,12 @@ solver `s` is used to compute the next root between the two points being swapped. This method is called by an Event object.*/ void swap(Vertex_handle vh, typename Traits::Kinetic_kernel::Compare_x_1::result_type& s); -/*! +/*! Begin iterating through the ordered `Vertex_handle`s (the iterator is convertible to `Vertex_handle`. */ Iterator begin(); -/*! +/*! End iterating through the ordered `Vertex_handle`s (the iterator is convertible to `Vertex_handle`. */ Iterator end(); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h index 13d18bd2cc3..91f70eee064 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/CGAL/Kinetic/Sort_visitor_base.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Sort_visitor_base(); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h index 9d2d9833a3c..263e434ff5a 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_2.h @@ -18,47 +18,47 @@ public: /// \name Operations /// @{ -/*! +/*! The vertex is about to be deleted. */ void pre_remove_vertex(Vertex_handle); -/*! +/*! The vertex was just removed. */ void post_remove_vertex(Point_key); -/*! +/*! The vertex is about to be inserted into the cell (although the `Cell_handle` might be `NULL`). */ void pre_insert_vertex(Point_key); -/*! +/*! The vertex was just inserted. */ void post_insert_vertex(Vertex_handle); -/*! +/*! The trajectory of the point at the vertex changed. */ void change_vertex(Vertex_handle); -/*! +/*! The face has just been made. */ void create_face(Face_handle f); -/*! +/*! The face is about to be destroyed. */ void destroy_face(Face_handle f); -/*! +/*! The edge is about to be flipped. */ void pre_flip(Edge); -/*! +/*! The edge was just created with a flip. */ void post_flip(Edge); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h index 750c4fe89f2..290dde59b6a 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/DelaunayTriangulationVisitor_3.h @@ -17,57 +17,57 @@ public: /// \name Operations /// @{ -/*! +/*! The vertex is about to be deleted. */ void pre_remove_vertex(Vertex_handle); -/*! +/*! The vertex was just removed. */ void post_remove_vertex(Point_key, Cell_handle); -/*! +/*! The vertex is about to be inserted into the cell (although the `Cell_handle` might be `NULL`). */ void pre_insert_vertex(Point_key, Cell_handle); -/*! +/*! The vertex was just inserted. */ void post_insert_vertex(Vertex_handle); -/*! +/*! The trajectory of the point at the vertex changed. */ void change_vertex(Vertex_handle); -/*! +/*! The cell was just created and initialized. */ void create_cell(Cell_handle); -/*! +/*! The cell is about to be removed. */ void destroy_cell(Cell_handle); -/*! +/*! The edge is about to be flipped. */ void pre_edge_flip(Edge); -/*! +/*! The facet was just created with a flip. */ void post_edge_flip(Facet); -/*! +/*! The facet is about to be flipped. */ void pre_facet_flip(Facet); -/*! +/*! The edge was just created with a flip. */ void post_facet_flip(Edge); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h index a0c0898deba..c61c16c8167 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/EventLogVisitor.h @@ -17,7 +17,7 @@ public: /// \name Types /// @{ -/*! +/*! An iterator through strings defining the events that occurred. Each event is represented by a `std::string`. */ typedef unspecified_type Event_iterator; @@ -27,12 +27,12 @@ typedef unspecified_type Event_iterator; /// \name Operations /// @{ -/*! +/*! Begin iterating through the events. */ Event_iterator events_begin(); -/*! +/*! */ Event_iterator events_end(); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h index 553970fda07..41237856012 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/RegularTriangulationVisitor_3.h @@ -19,12 +19,12 @@ public: /// \name Operations /// @{ -/*! +/*! The point defined by `Key` is about to move from the cell. */ void pre_move(Key, Cell); -/*! +/*! The point defined by `Key` just moved to the cell. */ void post_move(Key, Cell); diff --git a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h index cb0f578c9f8..6fe2da11021 100644 --- a/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h +++ b/Kinetic_data_structures/doc/Kinetic_data_structures/Concepts/SortVisitor.h @@ -17,37 +17,37 @@ public: /// \name Operations /// @{ -/*! +/*! The vertex is about to be deleted. */ void pre_remove_vertex(Vertex_handle); -/*! +/*! The vertex was just removed. */ void post_remove_vertex(Point_key); -/*! +/*! The vertex is about to be inserted into the cell (although the `Cell_handle` might be `NULL`). */ void pre_insert_vertex(Point_key); -/*! +/*! The vertex was just inserted. */ void post_insert_vertex(Vertex_handle); -/*! +/*! Something changed at the vertex. */ void change_vertex(Vertex_handle); -/*! +/*! The pair of vertices is about to be exchanged. */ void pre_swap(Vertex_handle, Vertex_handle); -/*! +/*! The pair of vertices was just swapped. */ void post_swap(Vertex_handle, Vertex_handle); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h index ea92fbe08db..293c7cc8e94 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Cartesian.h @@ -19,27 +19,27 @@ public: /// \name Types /// @{ -/*! +/*! This is a model of `Kinetic::Certificate`. */ typedef unspecified_type Certificate; -/*! +/*! */ typedef unspecified_type Point_1; -/*! +/*! */ typedef unspecified_type Point_2; -/*! +/*! */ typedef unspecified_type Point_3; -/*! +/*! */ typedef unspecified_type Weighted_point_3; @@ -52,72 +52,72 @@ typedef unspecified_type Weighted_point_3; /// the functor. They are models of `Kinetic::CertificateGenerator`. /// @{ -/*! +/*! */ typedef unspecified_type Orientation_2; -/*! +/*! */ typedef unspecified_type Orientation_3; -/*! +/*! */ typedef unspecified_type Side_of_oriented_circle_2; -/*! +/*! */ typedef unspecified_type Side_of_oriented_sphere_3; -/*! +/*! */ typedef unspecified_type Power_test_3; -/*! +/*! */ typedef unspecified_type Weighted_orientation_3; -/*! +/*! */ typedef unspecified_type Compare_x_1; -/*! +/*! */ typedef unspecified_type Compare_x_2; -/*! +/*! */ typedef unspecified_type Compare_y_2; -/*! +/*! */ typedef unspecified_type Compare_x_3; -/*! +/*! */ typedef unspecified_type Compare_y_3; -/*! +/*! */ typedef unspecified_type Compare_z_3; -/*! +/*! */ typedef unspecified_type Compare_distance_2; -/*! +/*! */ typedef unspecified_type Compare_distance_3; diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h index d77ef88813f..64d9706f6ca 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_instantaneous_kernel.h @@ -19,82 +19,82 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type Orientation_2; -/*! +/*! */ typedef unspecified_type Orientation_3; -/*! +/*! */ typedef unspecified_type Side_of_oriented_circle_2; -/*! +/*! */ typedef unspecified_type Side_of_oriented_sphere_3; -/*! +/*! */ typedef unspecified_type Power_test_3; -/*! +/*! */ typedef unspecified_type Weighted_orientation_3; -/*! +/*! */ typedef unspecified_type Compare_x_1; -/*! +/*! */ typedef unspecified_type Compare_x_2; -/*! +/*! */ typedef unspecified_type Compare_y_2; -/*! +/*! */ typedef unspecified_type Compare_x_3; -/*! +/*! */ typedef unspecified_type Compare_y_3; -/*! +/*! */ typedef unspecified_type Compare_z_3; -/*! +/*! */ typedef unspecified_type Compare_distance_2; -/*! +/*! */ typedef unspecified_type Compare_distance_3; -/*! +/*! Note that this one does not work if the current time is not a `NT`. */ typedef unspecified_type Coplanar_orientation_3; -/*! +/*! Note that this one does not work if the current time is not a `NT`. */ typedef unspecified_type Coplanar_side_of_bounded_circle_3; diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h index 451aec66c5e..9db4ab8fcfe 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Default_simulator.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! Construct a `Kinetic::Default_simulator` which will process events between times start and end (events outside this window will be discarded). */ Default_simulator(const Time start=Time(0), const Time end= Time::infinity()); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Listener.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Listener.h index f2e1a08cd1b..f055ff25cf2 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Listener.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Listener.h @@ -121,12 +121,12 @@ public: /// \name Types /// @{ -/*! +/*! This type is inherited from the `Interface` template argument. It is a reference counted pointer type for the object providing notifications. */ typedef unspecified_type Notifier_handle; -/*! +/*! The type (usually an enum) used to distinguish different types of notifications. This is inherited from the `Interface` template argument. */ typedef unspecified_type Notification_type; @@ -136,7 +136,7 @@ typedef unspecified_type Notification_type; /// \name Creation /// @{ -/*! +/*! The `Listener` subscribes to events coming from the notifier and stores a pointer to the notifier. */ Listener(Notifier_handle np); @@ -146,12 +146,12 @@ Listener(Notifier_handle np); /// \name Operations /// @{ -/*! +/*! Return a pointer to the notifier. */ Notifier_handle notifier(); -/*! +/*! This method is pure virtual. A class which wishes to receive events must inherit from this class and implement this method. The method will then be called whenever there is a notification. */ virtual void new_notification(Notification_type); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Ref_counted.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Ref_counted.h index 239526cd0e9..edae9b7a628 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Ref_counted.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Ref_counted.h @@ -22,12 +22,12 @@ public: /// \name Types /// @{ -/*! +/*! A reference counted pointer to an Object. */ typedef unspecified_type Handle; -/*! +/*! A const reference counted pointer to an Object. */ typedef unspecified_type Const_handle; @@ -37,7 +37,7 @@ typedef unspecified_type Const_handle; /// \name Creation /// @{ -/*! +/*! default constructor. */ Ref_counted(); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Simulator_objects_listener.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Simulator_objects_listener.h index ef5880327ea..d5389651cfa 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Simulator_objects_listener.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/Simulator_objects_listener.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Simulator_objects_listener(Simulator::Handle, KDS*); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/listeners.h b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/listeners.h index 00663a06906..3dec51e5a16 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/listeners.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/CGAL/Kinetic/listeners.h @@ -47,7 +47,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Simulator_listener(Simulator::Handle, KDS *kds); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h index d2a78da5eef..3c1b3d92889 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/ActiveObjectsTable.h @@ -32,17 +32,17 @@ public: /// \name Types /// @{ -/*! +/*! A key identifying an object in the table. */ typedef unspecified_type Key; -/*! +/*! The type being stored in the table. */ typedef unspecified_type Data; -/*! +/*! The base class to derive from for listening for runtime events. */ typedef unspecified_type Listener; @@ -55,22 +55,22 @@ typedef unspecified_type Listener; /// you to iterate through the objects in the set `Foo`. /// @{ -/*! +/*! An iterator through all the valid keys in the table. */ typedef unspecified_type Key_iterator; -/*! +/*! An iterator through all the objects which have been changed in the last editing session. The iterator iterates through the objects in lexicographical order. */ typedef unspecified_type Changed_iterator; -/*! +/*! An iterator through all the objects which were added in the last editing session. */ typedef unspecified_type Inserted_iterator; -/*! +/*! An iterator through all the objects which were deleted in the last editing session. */ typedef unspecified_type Erased_iterator; @@ -80,17 +80,17 @@ typedef unspecified_type Erased_iterator; /// \name Operations /// @{ -/*! +/*! Access the object referenced by the key. */ Data operator[](Key key) const; -/*! +/*! Access the object referenced by the key. */ Data at(Key key) const; -/*! +/*! Set the editing state of the object. A notification is sent when the editing state is set to false after it has been true, i.e.\ the editing session is finished. @@ -98,12 +98,12 @@ This allows changes to be batched together. */ void set_is_editing(bool is_editing); -/*! +/*! Access the editing state. */ bool is_editing() const; -/*! +/*! This method changes the motion of one moving object. The position at the current time should not be different from the previous current position. However, @@ -115,14 +115,14 @@ no notifications are created. */ void set(Key key, Data object); -/*! +/*! Insert a new object into the table and return a `Key` which can be used to refer to it. See `set(Key, Data)` for a description of editing modes. */ Key insert_object(Data ob); -/*! +/*! Delete an object from the table. The object with Key key must already be in the table. This does not necessarily decrease the amount of storage used at all. In fact, it @@ -131,12 +131,12 @@ of how the editing modes are used. */ void erase(Key key); -/*! +/*! Remove all objects from the table and free all storage. */ void clear(); -/*! +/*! Returns true if the object has been set in the currently notified editing session. Note that this method can only be saftely called when processing an `IS_EDITING` @@ -144,13 +144,13 @@ notification. */ void is_set(Key) const; -/*! +/*! Returns true if the object has been set in the currently notified editing session. */ void is_new(Key) const; -/*! +/*! Returns true if the object has been set in the currently notified editing session. */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h index b4f006cbaba..b5007c0d49f 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/CertificateGenerator.h @@ -46,12 +46,12 @@ public: /// \name Operations /// @{ -/*! +/*! Return a `Certifate` object for the corresponding certificate. */ Certificate operator()(Args, Time begin, Time end); -/*! +/*! Compute the sign of the function at \f$ \lim_{\delta\rightarrow0} t+\delta\f$. This can be used to evaluate predicates at the current moment. */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h index 1db8ae9f0a9..feaff2a493b 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/EvenQueue.h @@ -19,13 +19,13 @@ public: /// \name Types /// @{ -/*! +/*! The type used to access items in the queue in order to change or delete them. */ typedef unspecified_type Key; -/*! +/*! The priority type for items in the queue. This is typically the same as `Kinetic::Simulator::Time` */ @@ -36,7 +36,7 @@ typedef unspecified_type Priority; /// \name Creation /// @{ -/*! +/*! Construct a queue which will start at time start and run until time end. */ @@ -48,54 +48,54 @@ size_hint); /// \name Operations /// @{ -/*! +/*! Insert an event into the event queue. A `Key` which can be used to manipulated the event is returned. */ template Key insert(Priority, Event); -/*! +/*! Erase an event from the queue. */ void erase(Key); -/*! +/*! Change the data in the event referred to by the key. */ template void set(Key, Event); -/*! +/*! Access the event referred to by the passed key. */ template Event& get(Key) const; -/*! +/*! Return the priority of the event. */ Priority priority(Key) const; -/*! +/*! Return true if the queue is empty. */ bool empty(); -/*! +/*! Return the priority of the next event in the queue. */ Priority next_priority() const; -/*! +/*! Process the next `Event` by calling its process method with its `Priority`. */ void process_next(); -/*! +/*! Set the priority beyond which to ignore events. */ void set_end_priority(); -/*! +/*! Return true if the queue contains the event and false if it does not. This is used for auditing events and can be slow if needed. diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h index 0dc9c374ab9..2d1fb0a925b 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/FunctionKernel.h @@ -148,12 +148,12 @@ public: /// \name Types /// @{ - /*! + /*! The number type used in describing the function. */ typedef unspecified_type NT; - /*! + /*! Construct a constant function from a number. */ Function(NT); @@ -163,7 +163,7 @@ public: /// \name Operations /// @{ - /*! + /*! Evaluate the function at an `NT`. */ NT operator()(NT); @@ -172,22 +172,22 @@ public: }; /* end Function */ - /*! + /*! The basic representational number type. */ typedef unspecified_type NT; - /*! + /*! A type representing the roots of a `Function`. */ typedef unspecified_type Root; - /*! + /*! A model of `RootStack`. These objects can be created by calling the `root_stack_object` method with a `Function` and two (optional) `Root` objects. The enumerator then enumerates all roots of the function in the open inverval defined by the two root arguments. They optional arguments default to positive and negative infinity. */ typedef unspecified_type Root_stack; - /*! + /*! The traits for the `Root_enumerator` class. */ typedef unspecified_type Root_enumerator_traits; @@ -200,13 +200,13 @@ public: /// argument. /// @{ - /*! + /*! A functor which returns the sign of a `Function` at a `NT` or `Root`. */ typedef unspecified_type Sign_at; - /*! + /*! A functor which returns sign of a function immediately after a root. */ @@ -246,7 +246,7 @@ public: /// \name Operations /// @{ - /*! + /*! This family of methods takes a list of coefficients and returns a function. There can be any number of coeffients passed as arguments (up to about 25 in the @@ -267,14 +267,14 @@ public: /// given below. /// @{ - /*! + /*! This functor, creation of which requires two `Root`s, returns the sign of a passed function between the pair of roots. */ typedef unspecified_type Sign_between_roots; - /*! + /*! This functor computes the derivitive of a `Function`. Construction takes no arguments. */ typedef unspecified_type Differentiate; @@ -286,7 +286,7 @@ public: /// functor and take one `Function` as a functor argument. /// @{ - /*! + /*! Map \f$ f(x)\f$ to \f$ f(-x)\f$. */ typedef unspecified_type Negate_variable; diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h index 3c0a7e0640a..78da23f8d51 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/InstantaneousKernel.h @@ -19,12 +19,12 @@ public: /// \name Types /// @{ -/*! +/*! A number type which can be used to represent the current time. This must be a ring or field type. */ typedef unspecified_type NT; -/*! +/*! The type used to represent the current time. This type must be comparable. */ typedef unspecified_type Time; @@ -34,32 +34,32 @@ typedef unspecified_type Time; /// \name Operations /// @{ -/*! +/*! Return the current time. */ Time time(); -/*! +/*! Return the current time as an `NT`. As a precondition, `time_is_nt` must be true. */ NT time_as_nt(); -/*! +/*! Return true if the last time time was set, it was using an object of type `NT`. */ bool time_is_nt(); -/*! +/*! Set the current time to have a certain value. All existing predicates are updated automatically. */ void set_time(Time); -/*! +/*! The the current time to be an instance of `NT`. With this more efficient techniques can be used. `time_is_nt()` must be true. */ void set_time(NT); -/*! +/*! Return a static object corresponding to the kinetic object at this instant in time. `time_is_nt()` must be true. */ Static_object static_object(Key); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h index 067110b0a7c..eec51ccbd1b 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Key.h @@ -19,7 +19,7 @@ method `is_valid()` to differentiate. class Key { public: -/*! +/*! The default constructor is guaranteed to construct an invalid key (i.e.\ one which is false when cast to a bool. */ Key(); @@ -27,14 +27,14 @@ Key(); /// \name Operations /// @{ -/*! +/*! This method returns false if the key was created using the default constructor or was otherwise created to be invalid. */ bool is_valid() const; -/*! +/*! Write a text description of the key to a standard stream. */ std::ostream& operator<<(std::ostream&, Key); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h index 5e9cc9c6cad..278fb4f4ec2 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Kinetic--Certificate.h @@ -18,17 +18,17 @@ public: /// \name Operations /// @{ -/*! +/*! Returns the next failure time. */ Time failure_time(); -/*! +/*! Returns true if the certificate will ever fail. */ bool will_fail(); -/*! +/*! Advances to the next failure time (the next root of the certificate functions). */ void pop_failure_time(); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/KineticKernel.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/KineticKernel.h index ef774024bce..408be9c6bd1 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/KineticKernel.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/KineticKernel.h @@ -19,7 +19,7 @@ public: /// \name Types /// @{ -/*! +/*! The type which is used to represent coordinates of moving primitives. It is a model of the concept `FunctionKernel::Function`. This is the analog of the CGAL @@ -27,13 +27,13 @@ kernel `RT`. */ typedef unspecified_type Motion_function; -/*! +/*! The type representing the results of predicates. See `Kinetic::Certificate`. */ typedef unspecified_type Certificate; -/*! +/*! The type of the function kernel used. See `Kinetic::FunctionKernel`. */ @@ -44,7 +44,7 @@ typedef unspecified_type Function_kernel; /// \name Operations /// @{ -/*! +/*! Gets a copy of the function kernel. */ diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h index 5ed10cac409..c041b621132 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/RootStack.h @@ -17,12 +17,12 @@ public: /// \name Types /// @{ -/*! +/*! The root of a function. */ typedef unspecified_type Root; -/*! +/*! The traits class for this concept. */ typedef unspecified_type Traits; @@ -32,12 +32,12 @@ typedef unspecified_type Traits; /// \name Creation /// @{ -/*! +/*! default constructor. */ RootStack(); -/*! +/*! Construct a `Kinetic::RootStack` over the roots of `f` in the half open interval [`lb` to `ub`). */ RootStack(Function f, Root lb, Root ub, Traits tr); @@ -47,17 +47,17 @@ RootStack(Function f, Root lb, Root ub, Traits tr); /// \name Operations /// @{ -/*! +/*! Advance to the next root. As a precondition, empty() must be false. */ void pop(); -/*! +/*! Return the current root. As a precondition, empty() must be false. Note that the `Root` returned might not actually be in the interval (since the solver has not yet proved that there are no more roots). */ Root top(); -/*! +/*! Return true if there are known to be no more roots left. There might not actually be any roots of the polynomial left in the interval, but the work necessary to prove this has been delayed. */ bool empty(); diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h index 0d55eebd5c7..31d2b4cfec3 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/SimulationTraits.h @@ -25,36 +25,36 @@ public: /// \name Types /// @{ -/*! +/*! The number type used for representation. */ typedef unspecified_type NT; -/*! +/*! A model of `Kinetic::InstantaneousKernel` which can be used to apply static CGAL data structures to snapshots of moving data. */ typedef unspecified_type Instantaneous_kernel; -/*! +/*! A model of `Kinetic::Kernel`. */ typedef unspecified_type Kinetic_kernel; -/*! +/*! A model of `Kinetic::FunctionKernel`. */ typedef unspecified_type Function_kernel; -/*! +/*! A model of `Kinetic::ActiveObjectsTable` which holds the relevant kinetic primitives. */ typedef unspecified_type Active_points_@omtable; -/*! +/*! A model of `Kinetic::Simulator` which will be used by all the kinetic data structures. */ @@ -65,27 +65,27 @@ typedef unspecified_type Simulator; /// \name Operations /// @{ -/*! +/*! Get a new instantaneous kernel. */ Instantaneous_kernel instantaneous_kernel_object(); -/*! +/*! Get a new kinetic kernel. */ Kinetic_kernel kinetic_kernel_object(); -/*! +/*! Get a new function kernel. */ Function_kernel function_kernel_object(); -/*! +/*! Return a pointer to the `Kinetic::Simulator` which is to be used in the simulation. */ Simulator::Handle simulator_handle(); -/*! +/*! Return a pointer to the `Kinetic::ActiveObjectsTable` which is to be used in the simulation. diff --git a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h index b7ad90b5e4b..70b0fbfb791 100644 --- a/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h +++ b/Kinetic_data_structures/doc/Kinetic_framework/Concepts/Simulator.h @@ -49,12 +49,12 @@ public: /// \name Types /// @{ - /*! + /*! The type of the function kernel used to instantiate this `Kinetic::Simulator`. */ typedef unspecified_type Function_kernel; - /*! + /*! Extend this base class to listen to notifications from this `Kinetic::Simulator`. There are two types of notifications: `HAS_AUDIT_TIME` and `DIRECTION_OF_TIME`. The first is made when kinetic data structures can perform an audit. The second is made when the direction of time is changed. */ typedef unspecified_type Listener; @@ -75,13 +75,13 @@ public: */ class Time { public: - /*! + /*! Construct an instance of time from a number type, where NT is the number type used in the simulation. */ Time(NT); - /*! + /*! Write it to a stream. */ std::ostream& operator<<(std::ostream&, Time); @@ -146,7 +146,7 @@ public: /// \name Operations /// @{ -/*! +/*! This method is called when the event occurs. This method will only be called once per time this event is scheduled and the event will be removed from the queue immediately @@ -154,7 +154,7 @@ public: */ void process(); -/*! +/*! Return a `void *` which represents the KDS which this event belongs to. The pointer is used solely to tell if two events come from the same KDS for the purposes of handling @@ -162,7 +162,7 @@ public: */ void* kds(); -/*! +/*! The two events `a` and `b` occur at the same time (`this` has key `a`). This method returns a `CGAL::Comparison_result` which is used to order the two equal @@ -172,7 +172,7 @@ public: CGAL::Comparison_result compare_concurrent(Key a, Key b) const; -/*! +/*! The two events `a` and `b` occur at the same time (`this` has key `a`) and cannot be perturbed to be unequal. This event allows @@ -181,7 +181,7 @@ public: */ bool merge_concurrent(Key a, Key b); -/*! +/*! Audit that this is a valid event. To use this, kinetic data structure can check that this event is indeed pointed to by the correct part of the combinatorial @@ -189,7 +189,7 @@ public: */ void audit(Key this_key); -/*! +/*! Write the event to a stream. */ std::ostream& write(std::ostream&) const; @@ -200,17 +200,17 @@ public: - /*! + /*! The basic number type used in computations. */ typedef unspecified_type NT; - /*! + /*! A reference counted pointer to be used for storing references to the object. */ typedef unspecified_type Handle; - /*! + /*! A reference counted pointer to be used for storing references to the object. */ typedef unspecified_type Const_handle; @@ -220,7 +220,7 @@ public: /// \name Creation /// @{ - /*! + /*! Construct a `Kinetic::Simulator` which will process events between times start and end (events outside this window will be discarded). */ Simulator(const Time start=Time(0), const Time end= Time::infinity()); @@ -230,48 +230,48 @@ public: /// \name Operations /// @{ - /*! + /*! Access the `Function_kernel` object used by the `Kinetic::Simulator`. */ Function_kernel function_kernel_object() const; - /*! + /*! Return the current time. */ Time current_time(); - /*! + /*! Set the current time to `t`, which cannot be less than `current_time`. Any events in the queue before time `t` are processed. */ void set_current_time(Time t); - /*! + /*! This function returns a time which can be represented using an instance of type `NT` which is shortly after the current time. You can then advance the current time to this one and act on the data structure using the return nt. */ NT next_time_reprsentable_as_nt() const; - /*! + /*! Return true if there is a rational number which is equivalent to the current time. Equivalent means that it has the same ordering relation to all previous and scheduled events. */ bool has_current_time_as_nt() const; - /*! + /*! Returns true if the current time is a rational number and there are no events at the current time. This means that the simulation can be audited at this time. */ bool has_audit_time() const; - /*! + /*! Return the time of the next event in the queue. */ Time next_event_time() const; - /*! + /*! Return the time the simulation will end. If time is running backwards, then this returns `Time::infinity()`. */ Time end_time() const; - /*! + /*! Set the current time to \f$ t_{cur}\f$ and the end time to \f$ t_{end}\f$. The event queue must be empty. Use this method if you want to reset or extend the @@ -279,7 +279,7 @@ public: */ void set_interval(Time t_cur, Time t_end); - /*! + /*! Schedule a new event at time `t`. The object `event` must implement the concept `Event`. The `Event_key` returned can be used to access or deschedule the @@ -288,7 +288,7 @@ public: template Event_key new_event(Time t, const Event event); - /*! + /*! Schedule a new event that will occur at the end of the simulation. This type of event is useful if, for example, you want to run for a while, change all motions, and then run some @@ -297,7 +297,7 @@ public: template Event_key new_final_event(const Event event); - /*! + /*! This method returns an `Event_key` which is guaranteed never to be assigned to any real event. This is a very useful placeholder for events which are known @@ -306,7 +306,7 @@ public: */ Event_key null_event() const; - /*! + /*! Performs some checks as to whether the key corresponds to a valid event. Generally, a event is valid if it is not defaultly constructed and either is in the @@ -314,18 +314,18 @@ public: */ void audit_event(Event_key) const; - /*! + /*! Return true if there are no more events. */ bool empty() const; - /*! + /*! Remove the event referenced by `k` from the event queue. */ void delete_event(const Event_key k); - /*! + /*! This method returns a pointer to an event, which can be used for recoving data, such as cached solvers, from that event. The second argument really shouldn't be there, but gcc seems to @@ -336,33 +336,33 @@ public: Queue::Event_handle::Handle event(const Event_key k, const Ev e) const; - /*! + /*! Return the time at which the event referenced by `k` occurs. */ Time event_time(Event_key k) const; - /*! + /*! Set the event referenced by key `k` to `ev`, for example if you want to change what happens when that event occurs. A new event key is returned. */ template Event_key set_event(Event_key k, const Ev ev); - /*! + /*! Return `POSITIVE` if time is running forwards or `NEGATIVE` if it is running backwards. */ Sign direction_of_time() const; - /*! + /*! Set which direction time is running. */ void set_direction_of_time(Sign dir) const; - /*! + /*! Return the number of events which have been processed. */ unsigned int current_event_number() const; - /*! + /*! Process all events up to the ith event. `i` cannot be less than `current_event_number`. */ void set_current_event_number(unsigned int i) const; @@ -373,13 +373,13 @@ public: }; /* end Kinetic::Simulator */ -/*! +/*! Return a double approximation of the time value. \relates Simulator::Time */ double to_double(Simulator::Time); -/*! +/*! Return an interval containing the time value. \relates Simulator::Time */ diff --git a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h index 83790e04f24..a43db1a650d 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Dynamic_matrix.h @@ -31,7 +31,7 @@ public: /// \name Creation /// @{ -/*! +/*! initializes the dynamic matrix to `m`. `m` is not copied, we only store a reference. @@ -43,31 +43,31 @@ Dynamic_matrix( const M& m); /// \name Operations /// @{ -/*! +/*! returns the number of columns. */ int number_of_columns() const; -/*! +/*! returns the number of rows. */ int number_of_rows() const; -/*! +/*! returns the entry at position (`row`, `column`). \pre \f$ 0 \le\f$ `row` \f$ <\f$ `number_of_rows()`, and \f$ 0 \le\f$ `column` \f$ <\f$ `number_of_columns()`. */ Entry operator()( int row, int column) const; -/*! +/*! replace column `old` with column number `new`. \pre \f$ 0 \le\f$ `old`, `new` \f$ <\f$ `number_of_columns()`. */ void replace_column( int old, int new); -/*! +/*! returns a new matrix consisting of all rows of the dynmic matrix with even index, (i.e.\ first row is row \f$ 0\f$ of the dynamic matrix, second row is row \f$ 2\f$ of @@ -75,7 +75,7 @@ the dynamic matrix, etc.). \pre `number_of_rows()` \f$ > 0\f$. */ Matrix* extract_all_even_rows() const; -/*! +/*! deletes the rightmost columns, such that the dynamic matrix becomes quadratic. \pre `number_of_columns()` \f$ \ge\f$ `number_of_rows()`. \post `number_of_rows()` \f$ ==\f$ `number_of_columns()`. diff --git a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h index 063ecf16e17..e4f01c40586 100644 --- a/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h +++ b/Matrix_search/doc/Matrix_search/CGAL/Sorted_matrix_search_traits_adaptor.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! initializes `t` to use `m` for feasibility testing. */ @@ -33,23 +33,23 @@ m); /// \name Types /// @{ -/*! +/*! typedef to `M`. */ typedef M Matrix; -/*! +/*! typedef to `Matrix::Value`. */ typedef Matrix::Value Value; -/*! +/*! typedef to `std::less`. */ typedef std::less Compare_strictly; -/*! +/*! typedef to `std::less_equal`. */ @@ -60,21 +60,21 @@ typedef std::less_equal Compare_non_strictly; /// \name Operations /// @{ -/*! +/*! returns the `Compare_strictly` object to be used for the search. */ Compare_strictly compare_strictly() const; -/*! +/*! returns the `Compare_non_strictly` object to be used for the search. */ Compare_non_strictly compare_non_strictly() const; -/*! +/*! uses the feasibility test given during creation. */ diff --git a/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h b/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h index 3b66f0ef901..7b361cc3f36 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h +++ b/Matrix_search/doc/Matrix_search/Concepts/BasicMatrix.h @@ -21,7 +21,7 @@ public: /// \name Types /// @{ -/*! +/*! The type of a matrix entry. It has to define a copy constructor. */ @@ -32,19 +32,19 @@ typedef unspecified_type Value; /// \name Operations /// @{ -/*! +/*! returns the number of columns. */ int number_of_columns() const; -/*! +/*! returns the number of rows. */ int number_of_rows() const; -/*! +/*! returns the entry at position (`row`, `column`). \pre \f$ 0 \le\f$ `row` \f$ <\f$ `number_of_rows()`, and \f$ 0 \le\f$ `column` \f$ <\f$ `number_of_columns()`. */ diff --git a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h index 095905a671e..68b751c3676 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/MonotoneMatrixSearchTraits.h @@ -33,7 +33,7 @@ public: /// \name Types /// @{ -/*! +/*! The type of a matrix entry. */ typedef unspecified_type Value; @@ -43,31 +43,31 @@ typedef unspecified_type Value; /// \name Operations /// @{ -/*! +/*! returns the number of columns. */ int number_of_columns() const; -/*! +/*! returns the number of rows. */ int number_of_rows() const; -/*! +/*! returns the entry at position (`row`, `column`). \pre \f$ 0 \le\f$ `row` \f$ <\f$ `number_of_rows()`, and \f$ 0 \le\f$ `column` \f$ <\f$ `number_of_columns()`. */ Entry operator()( int row, int column) const; -/*! +/*! replace column `old` with column number `new`. \pre \f$ 0 \le\f$ `old`, `new` \f$ <\f$ `number_of_columns()`. */ void replace_column( int old, int new); -/*! +/*! returns a new Matrix consisting of all rows of `m` with even index, (i.e.\ first row is row \f$ 0\f$ of `m`, second row is row \f$ 2\f$ of @@ -75,7 +75,7 @@ a new Matrix consisting of all rows of `m` with even index, */ Matrix* extract_all_even_rows() const; -/*! +/*! deletes the rightmost columns, such that `m` becomes quadratic. \pre `number_of_columns()` \f$ \ge\f$ `number_of_rows()`. \post `number_of_rows()` \f$ ==\f$ `number_of_columns()`. diff --git a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h index 1ae111a42a0..be3e77de406 100644 --- a/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h +++ b/Matrix_search/doc/Matrix_search/Concepts/SortedMatrixSearchTraits.h @@ -21,19 +21,19 @@ public: /// \name Types /// @{ -/*! +/*! The class used for representing matrices. It has to be a model for `BasicMatrix`. */ typedef unspecified_type Matrix; -/*! +/*! The class used for representing the matrix elements. */ typedef Matrix::Value Value; -/*! +/*! An adaptable binary function class: `Value` \f$ \times\f$ `Value` \f$ \rightarrow\f$ `bool` defining a non-reflexive total order on `Value`. This @@ -41,7 +41,7 @@ determines the direction of the search. */ typedef unspecified_type Compare_strictly; -/*! +/*! An adaptable binary function class: `Value` \f$ \times\f$ `Value` \f$ \rightarrow\f$ `bool` defining the reflexive total order on `Value` corresponding @@ -54,21 +54,21 @@ typedef unspecified_type Compare_non_strictly; /// \name Operations /// @{ -/*! +/*! returns the `Compare_strictly` object to be used for the search. */ Compare_strictly compare_strictly() const; -/*! +/*! returns the `Compare_non_strictly` object to be used for the search. */ Compare_non_strictly compare_non_strictly() const; -/*! +/*! The predicate to determine whether an element `a` is feasible. It has to be monotone in the sense that `compare(a, b)` and diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h index daf37d9c50c..e80acb71a5b 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_criteria_2.h @@ -31,7 +31,7 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor with bound \f$ B=\sqrt{2}\f$. */ Delaunay_mesh_criteria_2(); @@ -40,7 +40,7 @@ Delaunay_mesh_criteria_2(); -/*! +/*! Construct a traits class with bound \f$ B=\sqrt{\frac{1}{4 b}}\f$. */ diff --git a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h index ad908d054ad..f8624d97adc 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesh_size_criteria_2.h @@ -34,7 +34,7 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor with \f$ B=\sqrt{2}\f$. No bound on size. */ Delaunay_mesh_size_criteria_2(); @@ -43,7 +43,7 @@ Delaunay_mesh_size_criteria_2(); -/*! +/*! Construct a traits class with bound \f$ B=\sqrt{\frac{1}{4 b}}\f$. If \f$ S \neq0\f$, the size bound is \f$ S\f$. If \f$ S = 0\f$, there is no bound on size. 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 52cde085f36..8e8100cb7fd 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Delaunay_mesher_2.h @@ -46,7 +46,7 @@ public: /// \name Types /// @{ -/*! +/*! the geometric traits class. */ typedef CDT::Geom_traits Geom_traits; @@ -56,7 +56,7 @@ typedef CDT::Geom_traits Geom_traits; -/*! +/*! const iterator over defined seeds. Its value type is `Geom_traits::Point_2`. */ @@ -68,7 +68,7 @@ typedef unspecified_type Seeds_iterator; /// \name Creation /// @{ -/*! +/*! Create a new mesher, working on `t`, with meshing criteria `criteria`. */ @@ -85,7 +85,7 @@ Delaunay_mesher_2(CDT& t, Criteria criteria = Criteria()); /// The following functions are used to define seeds. /// @{ -/*! +/*! Sets seeds to the empty set. All finite connected components of the constrained triangulation will be refined. @@ -96,7 +96,7 @@ void clear_seeds (); -/*! +/*! Sets seeds to the sequence `[begin, end)`. If `mark==true`, the mesh domain is the union of the bounded connected components including at least one seed. If @@ -115,7 +115,7 @@ const bool mark=false); -/*! +/*! Start of the seeds sequence. */ Seeds_const_iterator seeds_begin () const; @@ -124,7 +124,7 @@ Seeds_const_iterator seeds_begin () const; -/*! +/*! Past the end of the seeds sequence. */ Seeds_const_iterator seeds_end () const; @@ -145,7 +145,7 @@ by a call to `set_bad_faces`. */ /// @{ -/*! +/*! Refines the constrained Delaunay triangulation into a mesh satisfying the criteria defined by the traits. @@ -156,7 +156,7 @@ void refine_mesh(); -/*! +/*! Returns a const reference to the criteria traits object. */ const Criteria& get_criteria(); @@ -165,7 +165,7 @@ const Criteria& get_criteria(); -/*! +/*! Assigns `criteria` to the criteria traits object. */ void set_criteria(Criteria criteria); @@ -174,7 +174,7 @@ void set_criteria(Criteria criteria); -/*! +/*! Assigns `criteria` to the criteria traits object. If `recalculate_bad_faces` is `false`, the list of bad faces is let empty and the function `set_bad_faces` should be called before @@ -187,7 +187,7 @@ recalculate_bad_faces); -/*! +/*! This method permits to set the list of bad triangles directly, from the sequence `[begin, end)`, so that the algorithm will not scan the whole set of triangles to @@ -212,7 +212,7 @@ InputIterator end); /// meshing algorithm step by step, using the following methods. /// @{ -/*! +/*! This method must be called just before the first call to the following step by step refinement method, that is when all vertices and constrained edges have been @@ -227,7 +227,7 @@ void init(); -/*! +/*! Tests if the step by step refinement algorithm is done. If it returns `true`, the following calls to `step_by_step_refine_mesh` will not insert any points, until some new constrained segments or points are @@ -239,7 +239,7 @@ bool is_refinement_done(); -/*! +/*! Applies one step of the algorithm, by inserting one point, if the algorithm is not done. Returns `false` iff no point has been inserted because the algorithm is done. 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 7eaca9cb9aa..356ef933c76 100644 --- a/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h +++ b/Mesh_2/doc/Mesh_2/CGAL/Triangulation_conformer_2.h @@ -78,7 +78,7 @@ public: /// \name Creation /// @{ -/*! +/*! Create a new conforming maker, working on `t`. */ Triangulation_conformer_2(CDT& t); @@ -93,7 +93,7 @@ Triangulation_conformer_2(CDT& t); /// \name Conforming methods /// @{ -/*! +/*! Refines the triangulation into a conforming Delaunay triangulation. After a call to this method, all triangles fulfill the Delaunay property, that is the empty circle @@ -105,7 +105,7 @@ void make_conforming_Delaunay(); -/*! +/*! Refines the triangulation into a conforming Gabriel triangulation. After a call to this method, all constrained edges \f$ e\f$ have the Gabriel property: the circle with diameter \f$ e\f$ @@ -129,7 +129,7 @@ of edges. */ /// @{ -/*! +/*! Returns `true` iff all triangles fulfill the Delaunay property. */ bool is_conforming_Delaunay(); @@ -138,7 +138,7 @@ bool is_conforming_Delaunay(); -/*! +/*! Returns `true` iff all constrained edges have the Gabriel property: their circumsphere is empty. */ @@ -163,7 +163,7 @@ not be mixed between two calls of `init_XX`. */ /// @{ -/*! +/*! The method must be called after all points and constrained segments are inserted and before any call to the following methods. If some points or segments are then inserted in the triangulation, this @@ -175,7 +175,7 @@ void init_Delaunay(); -/*! +/*! Applies one step of the algorithm, by inserting one point, if the algorithm is not done. Returns `false` iff no point has been inserted because the algorithm is done. @@ -186,7 +186,7 @@ bool step_by_step_conforming_Delaunay (); -/*! +/*! Analog to `init_Delaunay` for Gabriel conforming. */ @@ -196,7 +196,7 @@ void init_Gabriel(); -/*! +/*! Analog to `step_by_step_conforming_Delaunay()` for Gabriel conforming. */ @@ -206,7 +206,7 @@ bool step_by_step_conforming_Gabriel (); -/*! +/*! Tests if the step by step conforming algorithm is done. If it returns `true`, the following calls to `step_by_step_conforming_XX` will not insert any points, until some diff --git a/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h b/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h index 3b01af4bfeb..70e553f0476 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/ConformingDelaunayTriangulationTraits_2.h @@ -30,7 +30,7 @@ public: /// \name Types /// @{ -/*! +/*! The field type. It must be a model of `FieldWithSqrt`, that is must be a number type supporting the operations \f$ +\f$, \f$ -\f$, \f$ *\f$, \f$ /\f$, and \f$ \sqrt{\cdot}\f$. @@ -38,13 +38,13 @@ supporting the operations \f$ +\f$, \f$ -\f$, \f$ *\f$, \f$ /\f$, and \f$ \sqrt{ typedef unspecified_type FT; -/*! +/*! The vector type. */ typedef unspecified_type Vector_2; -/*! +/*! Constructor object. Must provide the operator `Vector_2 operator()(Point a, Point b)` that computes the vector `b-a`. @@ -52,7 +52,7 @@ that computes the vector `b-a`. typedef unspecified_type Construct_vector_2; -/*! +/*! Constructor object. Must provide the operator `Vector_2 operator()(Vector_2 v, FT scale)` that computes the vector `scale` \f$\cdot\f$ `v`. @@ -60,7 +60,7 @@ that computes the vector `scale` \f$\cdot\f$ `v`. typedef unspecified_type Construct_scaled_vector_2; -/*! +/*! Constructor object. Must provide the operator `Point_2 operator()(Point_2 p, Vector_2 v)` that computes the point `p+v`. @@ -68,7 +68,7 @@ that computes the point `p+v`. typedef unspecified_type Construct_translated_point_2; -/*! +/*! Constructor object. Must provide the operator `Point_2 operator()(Point_2 a, Point_2 b)` that computes the midpoint of the segment \f$ ab\f$. @@ -76,7 +76,7 @@ computes the midpoint of the segment \f$ ab\f$. typedef unspecified_type Construct_midpoint_2; -/*! +/*! Constructor object. Must provide the operator `FT operator()(Point_2 a, Point_2 b)` that computes the squared distance between `a` and `b`. @@ -84,7 +84,7 @@ computes the squared distance between `a` and `b`. typedef unspecified_type Compute_squared_distance_2; -/*! +/*! Predicate object. Must provide the operator `CGAL::Angle operator()(Point_2 p, Point_2 q, Point_2 r)` that returns OBTUSE, RIGHT or ACUTE depending on the angle formed by the three @@ -98,7 +98,7 @@ typedef unspecified_type Angle_2; /// \name Access to predicate and constructor objects /// @{ -/*! +/*! */ Construct_vector_2 construct_vector_2_object(); @@ -107,7 +107,7 @@ Construct_vector_2 construct_vector_2_object(); -/*! +/*! */ Construct_scaled_vector_2 construct_scaled_vector_2_object(); @@ -116,7 +116,7 @@ Construct_scaled_vector_2 construct_scaled_vector_2_object(); -/*! +/*! */ Construct_translated_point_2 @@ -126,7 +126,7 @@ construct_translated_point_2_object(); -/*! +/*! */ Construct_midpoint_2 construct_midpoint_2_object(); @@ -135,7 +135,7 @@ Construct_midpoint_2 construct_midpoint_2_object(); -/*! +/*! */ Compute_squared_distance_2 @@ -145,7 +145,7 @@ compute_squared_distance_2_object(); -/*! +/*! */ Angle_2 angle_2_object(); diff --git a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h index f7f3106bc4a..c39e9931393 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshFaceBase_2.h @@ -24,7 +24,7 @@ public: /// \name Access Functions /// @{ -/*! +/*! returns true if this face is in the domain to be refined. */ bool is_in_domain() const; @@ -33,7 +33,7 @@ bool is_in_domain() const; -/*! +/*! sets if this face is in the domain. */ void set_in_domain(const bool b); diff --git a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h index b8cac8ed4d9..da254b0dd9a 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/DelaunayMeshTraits_2.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! Constructor object. Must provide an operator `Point_2 operator()(Point_2 p, Point_2 q, Point_2 r);` that constructs the center of the circle passing through the points `p`, @@ -34,7 +34,7 @@ that constructs the center of the circle passing through the points `p`, typedef unspecified_type Construct_circumcenter_2; -/*! +/*! Constructor object. Must provide an operator `FT operator()(Point_2 p, Point_2 q, Point_2 r);` that computes the signed area of the triangle defined by @@ -48,7 +48,7 @@ typedef unspecified_type Compute_area_2; /// \name Access to predicate and constructor objects /// @{ -/*! +/*! */ Construct_circumcenter_2 construct_circumcenter_2_object(); @@ -57,7 +57,7 @@ Construct_circumcenter_2 construct_circumcenter_2_object(); -/*! +/*! */ Compute_area_2 compute_area_2_object(); diff --git a/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h b/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h index f4dcf685336..1697e2dbec8 100644 --- a/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h +++ b/Mesh_2/doc/Mesh_2/Concepts/MeshingCriteria_2.h @@ -50,20 +50,20 @@ public: /// \name Types /// @{ -/*! +/*! Handle to a face of the triangulation. */ typedef unspecified_type Face_handle; -/*! +/*! Default constructible, copy constructible, assignable, and less-than comparable type. */ typedef unspecified_type Quality; -/*! +/*! Predicate object. Must provide two operators. - The first operator `Mesh_2::Face_badness operator()(Face_handle fh, @@ -91,7 +91,7 @@ typedef unspecified_type Is_bad; /// \name Access to predicate and constructor objects /// @{ -/*! +/*! */ Is_bad is_bad_object(); diff --git a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h index ce5ae0d84ee..500dd2736e3 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Implicit_mesh_domain_3.h @@ -49,7 +49,7 @@ public: /// \name Creation /// @{ -/*! +/*! `f` is the object of type `Function` that represents the implicit surface. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h index 824a282c606..141bab55fdb 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Labeled_image_mesh_domain_3.h @@ -43,7 +43,7 @@ public: /// \name Creation /// @{ -/*! +/*! Construction from an image. The parameter `error_bound` is relative to the size of the image. */ diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h index feb477d710d..321cc9b5fd5 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_cell_criteria_3.h @@ -26,7 +26,7 @@ public: /// \name Types /// @{ -/*! +/*! Numerical type */ typedef Tr::FT FT; @@ -36,7 +36,7 @@ typedef Tr::FT FT; /// \name Creation /// @{ -/*! +/*! Returns an object to serve as default criteria for cells. The argument `radius_edge_bound` is the upper bound for the radius-edge ratio of the tetrahedra. The argument `radius_bound` is a uniform upper bound @@ -48,7 +48,7 @@ Mesh_cell_criteria_3( FT radius_edge_bound, FT radius_bound); -/*! +/*! Returns an object to serve as default criteria for facets. The type `SizingField` must be a model of the concept `MeshDomainField_3`. The behavior and semantic of the arguments are the same as above, except that the radius bound parameter is a functional instead of a constant. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h index 9454a50f460..6104673fe32 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_complex_3_in_triangulation_3.h @@ -44,27 +44,27 @@ public: /// \name Types /// @{ -/*! +/*! Index type. */ typedef Tr::Vertex::Index Index; -/*! +/*! Surface index type. */ typedef Tr::Cell::Surface_patch_index Surface_patch_index; -/*! +/*! Subdomain index type. */ typedef Tr::Cell::Subdomain_index Subdomain_index; -/*! +/*! `Corner_index` type. */ typedef CornerIndex Corner_index; -/*! +/*! `Curve_segment_index` type. */ typedef CurveSegmentIndex Curve_segment_index; @@ -74,7 +74,7 @@ typedef CurveSegmentIndex Curve_segment_index; /// \name Operations /// @{ -/*! +/*! Outputs the mesh to `os` in medit format. */ 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 a34ee5c4529..54f338fb018 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 @@ -29,17 +29,17 @@ public: /// \name Types /// @{ -/*! +/*! Numerical type. */ typedef Gt::FT FT; -/*! +/*! Point type. */ typedef Gt::Point_3 Point_3; -/*! +/*! Type of index of the vertices of the triangulation. */ typedef Index Index; @@ -49,7 +49,7 @@ typedef Index Index; /// \name Creation /// @{ -/*! +/*! Builds a constant domain field with size `size`. */ @@ -60,7 +60,7 @@ Mesh_constant_domain_field_3(FT size); /// \name Operations /// @{ -/*! +/*! Sets the size such as `operator()` will return size `size` at any query point of dimension `dimension` and index `index`. 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 2b029e92d40..c9c8db19177 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_criteria_3.h @@ -58,19 +58,19 @@ public: /// \name Types /// @{ -/*! +/*! The criteria for edges. */ typedef Mesh_edge_criteria_3
     Edge_criteria; -/*! +/*! The criteria for facets. */ typedef Mesh_facet_criteria_3 Facet_criteria; -/*! +/*! The criteria for cells. */ @@ -81,7 +81,7 @@ typedef Mesh_cell_criteria_3 Cell_criteria; /// \name Creation /// @{ -/*! +/*! Construction from facet and cell criteria. The edge criteria are ignored in this case. */ @@ -89,7 +89,7 @@ Mesh_criteria_3( Facet_criteria facet_criteria, Cell_criteria cell_criteria); -/*! +/*! Construction from edge, facet and cell criteria. */ Mesh_criteria_3( @@ -97,7 +97,7 @@ Edge_criteria edge_criteria, Facet_criteria facet_criteria, Cell_criteria cell_criteria); -/*! +/*! \brief Construction from criteria parameters. This constructor uses named parameters (from Boost.Parameter) for convenient criteria construction. diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h index a3768140281..a596a353b13 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_domain_with_polyline_features_3.h @@ -29,12 +29,12 @@ public: /// \name Types /// @{ -/*! +/*! `Corner_index` type. */ typedef int Corner_index; -/*! +/*! `Curve_segment_index` type. */ typedef int Curve_segment_index; @@ -44,7 +44,7 @@ typedef int Curve_segment_index; /// \name Creation /// @{ -/*! +/*! Constructor. Forwards the arguments to the constructor of the base class. */ @@ -56,7 +56,7 @@ Mesh_domain_with_polyline_features_3(T ...t); /// \name Operations /// @{ -/*! +/*! Add 1-dimensional features in the domain. `InputIterator` value type must be a model of the concept `MeshPolyline_3`. @@ -64,7 +64,7 @@ be a model of the concept `MeshPolyline_3`. template void add_features(InputIterator begin, InputIterator beyond); -/*! +/*! Add 1-dimensional features in the domain with their incidences with 2-dimensional features of the domain. The `InputIterator` value type must be diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h index 6905dd831ab..be93ff57939 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_edge_criteria_3.h @@ -20,7 +20,7 @@ public: /// \name Types /// @{ -/*! +/*! Numerical type. */ typedef Tr::Geom_traits::FT FT; @@ -30,7 +30,7 @@ typedef Tr::Geom_traits::FT FT; /// \name Creation /// @{ -/*! +/*! Returns an object to serve as criteria for edges. The argument `length_bound` is an upper bound for the length of the edges which are used to discretize the curve segments. @@ -39,7 +39,7 @@ Note that if one parameter is set to 0, then its corresponding criteria is ignor Mesh_edge_criteria_3( FT length_bound); -/*! +/*! Returns an object to serve as criteria for edges. The type `SizingField` must be a model of concept `MeshDomainField_3`. The behavior and semantic of the argument are the same as above, except that the length diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h index 52a98d05c7b..63fd8679f48 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_criteria_3.h @@ -31,7 +31,7 @@ public: /// \name Types /// @{ -/*! +/*! Numerical type */ typedef Tr::Geom_traits::FT FT; @@ -41,7 +41,7 @@ typedef Tr::Geom_traits::FT FT; /// \name Creation /// @{ -/*! +/*! Returns an object to serve as criteria for facets. The argument `angle_bound` is the lower bound for the angle in degrees of the surface mesh facets. The argument `radius_bound` is a uniform upper bound @@ -58,7 +58,7 @@ FT radius_bound, FT distance_bound, Mesh_facet_topology topology = FACET_VERTICES_ON_SURFACE); -/*! +/*! Returns an object to serve as criteria for facets. The types `SizingField` and `DistanceField` must be models of the concept `MeshDomainField_3`. The behavior and semantic of the arguments are the same diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_topology.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_topology.h index dc945d5764f..6fdb737bb23 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_topology.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_facet_topology.h @@ -15,7 +15,7 @@ enum Mesh_facet_topology { FACET_VERTICES_ON_SAME_SURFACE_PATCH, //!< The three vertices of a facet belonging //!< to a surface patch `s` have to be on //!< the same surface patch `s`, on a curve segment or on a corner. - /*! + /*! The three vertices of a facet belonging to a surface patch `s` have to be on the same surface patch `s`, or on a curve segment incident to the surface patch `s` or on a corner incident to the diff --git a/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h b/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h index b3f01f0b51a..7655da4ba45 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Mesh_polyhedron_3.h @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! `CGAL::Polyhedron_3` type with customized `PolyhedronItems_3` designed to handle sharp feature detection. */ diff --git a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h index d89caa8c313..5063293ed23 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_3.h @@ -48,7 +48,7 @@ public: /// \name Creation /// @{ -/*! +/*! Construction from a bouding polyhedral surface which should be closed, and free of intersections. The inside of `bounding_polyhedron` will be meshed. */ diff --git a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h index 20fd467c441..6dcbf79b788 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Polyhedral_mesh_domain_with_features_3.h @@ -34,7 +34,7 @@ public: /// \name Types /// @{ -/*! +/*! Numerical type. */ typedef unspecified_type FT; @@ -44,7 +44,7 @@ typedef unspecified_type FT; /// \name Creation /// @{ -/*! +/*! Constructs a `Polyhedral_mesh_domain_with_features_3` from a polyhedral surface of type `Polyhedron`. The only requirement on type `Polyhedron` is that `CGAL::Mesh_polyhedron_3::%type` should be constructible from `Polyhedron`. @@ -54,7 +54,7 @@ The interior of `bounding_polyhedron` will be meshed. template Polyhedral_mesh_domain_with_features_3(Polyhedron bounding_polyhedron); -/*! +/*! Constructs a `Polyhedral_mesh_domain_with_features_3` from an off file. No feature detection is done at this level. */ @@ -77,7 +77,7 @@ Polyhedral_mesh_domain_with_features_3(Polyhedron polyhedron, /// \name Operations /// @{ -/*! +/*! Detects sharp features of the internal bounding polyhedron (and the potential internal polyhedron) and inserts them in as features of the domain. `angle_bound` gives the maximum dihedral angle (in degrees) between two triangles of the input polyhedron/a which is used to consider that the edge between diff --git a/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h b/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h index 94dd48e95ee..7b5b3411c67 100644 --- a/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h +++ b/Mesh_3/doc/Mesh_3/CGAL/Triangle_accessor_3.h @@ -26,19 +26,19 @@ public: /// \name Types /// @{ -/*! +/*! Triangle iterator. */ typedef Polyhedron_3::Facet_const_iterator Triangle_iterator; -/*! +/*! Triangle handle. */ typedef Polyhedron_3::Facet_const_handle Triangle_handle; -/*! +/*! Triangle type. */ typedef K::Triangle_3 Triangle_3; diff --git a/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h b/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h index 34537a85ea4..53284473f5a 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/BisectionGeometricTraits_3.h @@ -31,44 +31,44 @@ public: /// \name Types /// @{ -/*! +/*! Numerical type. Must be a model of `FieldWithSqrt` and constructible from a `double`. */ typedef unspecified_type FT; -/*! +/*! The point type. Must have a constructor `Point_3(FT, FT, FT)`. */ typedef unspecified_type Point_3; -/*! +/*! Segment type. */ typedef unspecified_type Segment_3; -/*! +/*! Ray type. */ typedef unspecified_type Ray_3; -/*! +/*! Line type. */ typedef unspecified_type Line_3; -/*! +/*! Vector type. */ typedef unspecified_type Vector_3; -/*! +/*! Sphere type. */ typedef unspecified_type Sphere_3; -/*! +/*! Function object providing the operator `FT operator()(Vector_3 v, Vector_3 w)` which returns the scalar @@ -76,7 +76,7 @@ Function object providing the operator */ typedef unspecified_type Compute_scalar_product_3; -/*! +/*! Function object providing the operator `FT operator()(Point_3, Point_3)` which returns the squared distance @@ -84,7 +84,7 @@ between two points. */ typedef unspecified_type Compute_squared_distance_3; -/*! +/*! Function object providing the operator `FT operator()(Sphere_3 s)` which returns the squared radius @@ -92,7 +92,7 @@ of `s`. */ typedef unspecified_type Compute_squared_radius_3; -/*! +/*! Function object providing the operator `Point_3 operator()(Sphere_3 s)` which returns the center of @@ -100,7 +100,7 @@ the sphere `s`. */ typedef unspecified_type Construct_center_3; -/*! +/*! Function object providing the operator `Point_3 operator()(Point_3 p, Point_3 q)` which computes @@ -108,7 +108,7 @@ the midpoint of the segment `pq`. */ typedef unspecified_type Construct_midpoint_3; -/*! +/*! Function object providing the following operators: `Point_3 operator()(Line_3 l,int i)` which returns an @@ -129,7 +129,7 @@ point. */ typedef unspecified_type Construct_point_on_3; -/*! +/*! Function object providing the operator `Segment_3 operator()(Point_3 p, Point_3 q)` which @@ -138,7 +138,7 @@ source to the target. */ typedef unspecified_type Construct_segment_3; -/*! +/*! Function object providing the operator `Vector_3 operator()(Vector_3 v, FT scale)` which returns @@ -146,7 +146,7 @@ the vector `v` scaled by a factor `scale`. */ typedef unspecified_type Construct_scaled_vector_3; -/*! +/*! Function object providing the operator `Point_3 operator()(Point_3 p, Vector_3 v)` which returns @@ -154,7 +154,7 @@ the point obtained by translating `p` by the vector `v`. */ typedef unspecified_type Construct_translated_point_3; -/*! +/*! Function object providing the operator `Vector_3 operator()(Point_3 a, Point_3 b)` which returns @@ -162,7 +162,7 @@ the vector `b-a`. */ typedef unspecified_type Construct_vector_3; -/*! +/*! Function object providing the operator `bool operator()(Sphere_3 s, Point_3 p)` which @@ -176,57 +176,57 @@ typedef unspecified_type Has_on_bounded_side_3; /// The following functions give access to the predicate and construction objects: /// @{ -/*! +/*! */ Compute_scalar_product_3 compute_scalar_product_3_object(); -/*! +/*! */ Compute_squared_distance_3 compute_squared_distance_3_object(); -/*! +/*! */ Compute_squared_radius_3 compute_squared_radius_3_object(); -/*! +/*! */ Construct_center_3 construct_center_3_object(); -/*! +/*! */ Construct_midpoint_3 construct_midpoint_3_object(); -/*! +/*! */ Construct_point_on_3 construct_point_on_3_object(); -/*! +/*! */ Construct_scaled_vector_3 construct_scaled_vector_3_object(); -/*! +/*! */ Construct_segment_3 construct_segment_3_object(); -/*! +/*! */ Construct_translated_point_3 construct_translated_point_3_object(); -/*! +/*! */ Construct_vector_3 construct_vector_3_object(); -/*! +/*! */ Has_on_bounded_side_3 has_on_bounded_side_3_object(); diff --git a/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h b/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h index d02e3fc3a43..e30fc646a3c 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/IntersectionGeometricTraits_3.h @@ -21,22 +21,22 @@ public: /// \name Types /// @{ -/*! +/*! Point type. */ typedef unspecified_type Point_3; -/*! +/*! Segment type. */ typedef unspecified_type Segment_3; -/*! +/*! Triangle type. */ typedef unspecified_type Triangle_3; -/*! +/*! Function object that detects an intersection between a 3D segment and a 3D triangle. Provides the operators: @@ -49,7 +49,7 @@ have a non empty intersection. */ typedef unspecified_type Do_intersect_3; -/*! +/*! Function object that constructs the intersection between a 3D segment and a 3D triangle. Provides the operators: @@ -70,13 +70,13 @@ typedef unspecified_type Intersect_3; /// \name Operations /// @{ -/*! +/*! Returns the intersection detection functor. */ Do_intersect_3 do_intersect_3_object(); -/*! +/*! Returns the intersection constructor. */ Intersect_3 diff --git a/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h b/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h index b9777c4b8d5..627cefdc5ad 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/LabeledImage_3.h @@ -22,13 +22,13 @@ public: /// \name Types /// @{ -/*! +/*! Type of voxel data. Must be an integral type. */ typedef unspecified_type Type; -/*! +/*! Ring number type. */ typedef unspecified_type RT; @@ -38,38 +38,38 @@ typedef unspecified_type RT; /// \name Operations /// @{ -/*! +/*! First dimension of the 3D array, i.e., the number of voxels along the x coordinate axis. */ int xdim(); -/*! +/*! Second dimension of the 3D array. */ int ydim(); -/*! +/*! Third dimension of the 3D array. */ int zdim(); -/*! +/*! Size of each voxel along x coordinate axis. */ RT vx(); -/*! +/*! Size of each voxel along y coordinate axis. */ RT vy(); -/*! +/*! Size of each voxel along z coordinate axis. */ RT vz(); -/*! +/*! Pointer to the first element of the 3D image. The size of the array must be `xdim()`\f$ \times\f$`ydim()`\f$ \times\f$`zdim()`. */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h index 247992e7a7d..063ca5ae3da 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCellBase_3.h @@ -47,18 +47,18 @@ public: /// \name Types /// @{ -/*! +/*! Point type, required to match the point type of the 3D triangulation in which the mesh is embedded. */ typedef unspecified_type Point; -/*! +/*! Type of indices for cells of the input complex. Must match the type `MeshDomain_3::Subdomain_index`. */ typedef unspecified_type Subdomain_index;; -/*! +/*! Type of indices for surface patches of the input complex. Must match the type `MeshDomain_3::Surface_patch_index`. */ typedef unspecified_type Surface_patch_index;; @@ -68,51 +68,51 @@ typedef unspecified_type Surface_patch_index;; /// \name Operations /// @{ -/*! +/*! Returns the index of the input subdomain that contains the cell `cell` of the triangulation. */ Subdomain_index subdomain_index(); -/*! +/*! Sets the subdomain index of the cell. */ void set_subdomain_index(Subdomain_index index); -/*! +/*! returns `true` iff `facet(i)` is a surface facet. */ bool is_facet_on_surface(int i); -/*! +/*! returns `Surface_patch_index` of facet `i`. */ Surface_patch_index surface_patch_index(int i); -/*! +/*! sets `Surface_patch_index` of facet `i` to `index`. */ void set_surface_patch_index(int i, Surface_patch_index index); -/*! +/*! Returns `true` iff `facet(i)` has been visited. */ bool is_facet_visited (int i); -/*! +/*! Marks `facet(i)` as visited if `b` is `true` and non-visited otherwise. */ void set_facet_visited (int i, bool b); -/*! +/*! Returns a const reference to the surface center of `facet(i)`. */ const Point& facet_surface_center(int i); -/*! +/*! Sets point `p` as the surface center of `facet(i)`. */ void set_facet_surface_center (int i, Point p); diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h index 7be8564f376..b2a032651ce 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCellCriteria_3.h @@ -25,14 +25,14 @@ public: /// \name Types /// @{ -/*! +/*! Handle type for the cells of the triangulation. Must match the `Cell_handle` type in the triangulation type used by the mesh generation function. */ typedef unspecified_type Cell_handle; -/*! +/*! Type representing the quality of a cell. Must be a model of CopyConstructible and LessThanComparable. Between two cells, the one which has the lower @@ -40,7 +40,7 @@ quality must have the lower `Cell_quality`. */ typedef unspecified_type Cell_quality; -/*! +/*! Type representing if a cell is bad or not. Must be convertible to `bool`. If it converts to `true` then the cell is bad, otherwise the cell is good with regard to the criteria. @@ -57,7 +57,7 @@ typedef unspecified_type Is_cell_bad; /// \name Operations /// @{ -/*! +/*! Returns `Is_cell_bad` value of cell `c`. */ Is_cell_bad operator()(Cell_handle c); diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h index fc13bceacb7..0fcbb496951 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshComplexWithFeatures_3InTriangulation_3.h @@ -61,14 +61,14 @@ public: /// \name Types /// @{ -/*! +/*! A type for indexes of curve segment. The type must match the type `MeshDomainWithFeatures_3::Curve_segment_index` when the concept is used for mesh generation. */ typedef unspecified_type Curve_segment_index; -/*! +/*! A type for indexes of corners. The type must match the type `MeshDomainWithFeatures_3::Corner_index` @@ -76,13 +76,13 @@ when the concept is used for mesh generation. */ typedef unspecified_type Corner_index; -/*! +/*! An iterator type to visit the edges of the triangulation belonging to curve segments. */ typedef unspecified_type Edges_in_complex_iterator; -/*! +/*! An iterator type to visit the vertices of the triangulation that are corners of the embedded complex. */ @@ -93,39 +93,39 @@ typedef unspecified_type Vertices_in_complex_iterator; /// \name Modifiers /// @{ -/*! +/*! Adds edge `e` as an element of the curve segment with index `index`. */ void add_to_complex(Edge e, const Curve_segment_index& index); -/*! +/*! Same as above with `e=(v1,v2)`. */ void add_to_complex(const Vertex_handle& v1, const Vertex_handle& v2, const Curve_segment_index& index); -/*! +/*! Marks vertex `v` as a corner with index `index`. */ void add_to_complex(const Vertex_handle& v, const Corner_index& index); -/*! +/*! Removes edge `e` from the embedded complex. */ void remove_from_complex(const Edge& e); -/*! +/*! Same as above with `e=(v1,v2)`. */ void remove_from_complex(const Vertex_handle& v1, const Vertex_handle& v2); -/*! +/*! Removes vertex `v` from the embedded complex. */ @@ -137,63 +137,63 @@ void remove_from_complex(const Vertex_handle& v); /// Queries on the 1D complex and 0D complex. /// @{ -/*! +/*! Returns the number of edges which belong to curve segments. */ size_type number_of_edges() const; -/*! +/*! Returns the number of edges which belong to curve segment with index `index`. */ size_type number_of_edges(Curve_segment_index index) const; -/*! +/*! Returns the number of vertices which are corners of the complex. */ size_type number_of_corners() const; -/*! +/*! Returns the number of vertices which are corners of the complex with index `index`. */ size_type number_of_corners(Corner_index index) const; -/*! +/*! Returns `true` iff edge `e` belongs to some curve segment. */ bool is_in_complex(const Edge& e) const; -/*! +/*! Same as above with `e=(v1,v2)`. */ bool is_in_complex(const Vertex_handle& v1, const Vertex_handle& v2) const; -/*! +/*! Returns `true` if vertex `v` is a corner. */ bool is_in_complex(const Vertex_handle& v) const; -/*! +/*! Returns `Curve_segment_index` of edge `e`. The default `Curve_segment_index` value is returned if edge `e` does not belong to any curve segment. */ Curve_segment_index curve_segment_index(const Edge& e); -/*! +/*! Same as above with `e=(v1,v2)`. */ Curve_segment_index curve_segment_index(const Vertex_handle& v1, const Vertex_handle& v2); -/*! +/*! Returns `Corner_index` of vertex `v`. The default `Corner_index` value is returned if vertex `v` is not a corner of the complex. @@ -205,32 +205,32 @@ Corner_index corner_index(const Vertex_handle& v); /// \name Traversal of the complex /// @{ -/*! +/*! Returns an `Edges_in_complex_iterator` to visit the edges of the triangulation belonging to curve segments. */ Edges_in_complex_iterator edges_in_complex_begin() const; -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Edge_in_complex_iterator edges_in_complex_end() const; -/*! +/*! Returns an `Edges_in_complex_iterator` to visit the edges of the triangulation belonging to curve segments of index `index`. */ Edges_in_complex_iterator edges_in_complex_begin(Curve_segment_index index) const; -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Edge_in_complex_iterator edges_in_complex_end(Curve_segment_index index) const; -/*! +/*! Fills `out` with the vertices of the triangulation that are adjacent to vertex `v` through an edge belonging to some curve segment. @@ -241,27 +241,27 @@ template OutputIterator adjacent_vertices_in_complex (const Vertex_handle& v, OutputIterator out) const; -/*! +/*! Returns a `Vertices_in_complex_iterator` to visit the vertices of the triangulation that are corners. */ Vertices_in_complex_iterator vertices_in_complex_begin() const; -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Vertices_in_complex_iterator vertices_in_complex_end() const; -/*! +/*! Returns a `Vertices_in_complex_iterator` to visit the vertices of the triangulation that are corners of index `index`. */ Vertices_in_complex_iterator vertices_in_complex_begin(Corner_index index) const; -/*! +/*! Returns the past-the-end iterator for the above iterator. */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h index 3688a9d9da3..5b62a420a20 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshComplex_3InTriangulation_3.h @@ -56,7 +56,7 @@ public: /// \name Types /// @{ -/*! +/*! The type of the embedding 3D triangulation. It is required to be @@ -72,50 +72,50 @@ of the concepts `MeshVertexBase_3` and */ typedef unspecified_type Triangulation; -/*! +/*! Type `Vertex_handle` type of the triangulation. */ typedef Triangulation::Vertex_handle Vertex_handle; -/*! +/*! The `Cell_handle` type of the triangulation. */ typedef Triangulation::Cell_handle Cell_handle; -/*! +/*! The `Facet` type of the triangulation. */ typedef Triangulation::Facet Facet; -/*! +/*! The `Edge` type of the triangulation. */ typedef Triangulation::Edge Edge; -/*! +/*! Size type (unsigned integral type). */ typedef Triangulation::size_type size_type; -/*! +/*! A type for indices of subdomains. This type must match the type `MeshDomain_3::Subdomain_index` when the concept is used for mesh generation. */ typedef unspecified_type Subdomain_index; -/*! +/*! A type for indices of surface patches. This type must match the type `MeshDomain_3::Surface_patch_index` when the concept is used for mesh generation. */ typedef unspecified_type Surface_patch_index; -/*! +/*! A type for indexing vertices that belong to some surface patches or subdomains. This type must match the type `MeshDomain_3::Index` @@ -123,13 +123,13 @@ when the concept is used for mesh generation. */ typedef unspecified_type Index; -/*! +/*! An iterator type to visit the cells of the triangulation belonging to the 3D complex. */ typedef unspecified_type Cells_in_complex_iterator; -/*! +/*! An iterator type to visit the surface facets. */ typedef unspecified_type Facets_in_complex_iterator; @@ -139,22 +139,22 @@ typedef unspecified_type Facets_in_complex_iterator; /// \name Creation /// @{ -/*! +/*! Builds an empty 3D complex. */ MeshComplex_3InTriangulation_3(); -/*! +/*! Copy constructor. Embedded triangulation is duplicated. */ MeshComplex_3InTriangulation_3(const MeshComplex_3InTriangulation_3 & rhs); -/*! +/*! Assignment operator. Embedded triangulation is duplicated, and the former triangulation of the 3D complex is deleted. */ MeshComplex_3InTriangulation_3& operator= (const MeshComplex_3InTriangulation_3 & rhs); -/*! +/*! Swaps the 3D complex and `rhs`. */ void swap(MeshComplex_3InTriangulation_3 & rhs); @@ -164,7 +164,7 @@ void swap(MeshComplex_3InTriangulation_3 & rhs); /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the triangulation. */ const Triangulation& triangulation() const; @@ -177,7 +177,7 @@ advanced operations allowing a direct manipulation of the triangulation. */ /// @{ -/*! +/*! Returns a reference to the triangulation. */ Triangulation& triangulation(); @@ -187,44 +187,44 @@ Triangulation& triangulation(); /// \name Modifiers /// @{ -/*! +/*! Sets the cell `c` as a cell of the subdomain `index`. */ void add_to_complex(Cell_handle c, Subdomain_index index); -/*! +/*! Adds the facet `f` as a facet of the surface patch `index`. */ void add_to_complex(Facet f, Surface_patch_index index); -/*! +/*! Same as above with `f=(c,i)`. */ void add_to_complex(Cell_handle c, int i, Surface_patch_index index); -/*! +/*! Removes cell `c` from the embedded complex. */ void remove_from_complex(Cell_handle c); -/*! +/*! Removes facet `f` from the embedded complex. */ void remove_from_complex(Facet f); -/*! +/*! Same as above with `f=(c,i)`. */ void remove_from_complex(Cell_handle c, int i); -/*! +/*! Sets the `dimension` of vertex `v`. The dimension is an integer attached to the vertex. When the concept `MeshComplex_3InTriangulation_3` is used for mesh generation this integer is used to store the dimension of the lowest dimensional face of the input complex including the vertex. */ void set_dimension(Vertex_handle v, int dimension); -/*! +/*! Sets the index of a vertex. */ void set_index(Vertex_handle v, Index index); @@ -234,39 +234,39 @@ void set_index(Vertex_handle v, Index index); /// \name Queries on the faces of the embedded complex /// @{ -/*! +/*! Returns the number of cells that belong to the embedded complex. */ size_type number_of_cells(); -/*! +/*! Returns the number of cells that belong to the subdomain of the embedded complex with index `index`. */ size_type number_of_cells(Subdomain_index index); -/*! +/*! Returns the number of facets that are surface facets, i. e. belong to some surface patch of the embedded complex. */ size_type number_of_facets(); -/*! +/*! Returns the number of facets that belong to the surface patch of the embedded complex with index `index`. */ size_type number_of_facets(Surface_patch_index index); -/*! +/*! Returns `true` iff the cell `c` belongs to the 3D complex. */ bool is_in_complex(Cell_handle c); -/*! +/*! Returns `true` iff the facet `f` belongs to the boundary 2D complex. */ bool is_in_complex(Facet f); -/*! +/*! Same as above with `f=(c,i)`. */ bool is_in_complex(Cell_handle c, int i); @@ -276,7 +276,7 @@ bool is_in_complex(Cell_handle c, int i); /// \name Queries on the identifier of the face complex including triangulation cells, facets and vertices. /// @{ -/*! +/*! Returns the index of the subdomain containing the cell `c`. The default subdomain index is returned if the cell `c` does not belong @@ -284,25 +284,25 @@ to the embedded complex. */ Subdomain_index subdomain_index(Cell_handle c); -/*! +/*! For a surface facet, returns the index of the surface patch containing the facet. The default `Surface_patch_index` value is returned if the facet is not a surface facet. */ Surface_patch_index surface_patch_index(Facet f); -/*! +/*! Same as above with `f=(c,i)`. */ Surface_patch_index surface_patch_index(Cell_handle c, int i); -/*! +/*! Returns the dimension of the vertex `v`. */ int in_dimension( Vertex_handle v) const; -/*! +/*! Returns the index of the vertex `v`. */ @@ -316,45 +316,45 @@ All those iterators are bidirectional and non mutable. */ /// @{ -/*! +/*! Returns a `Cell_in_complex_iterator` to visit the cells of the triangulation contained in the embedded complex. */ Cells_in_complex_iterator cells_in_complex_begin(); -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Cells_in_complex_iterator cells_in_complex_end(); -/*! +/*! Returns a `Cell_in_complex_iterator` to visit the cells of the triangulation which belong to the approximation of subdomain of index `index`. */ Cells_in_complex_iterator cells_in_complex_begin(Subdomain_index index); -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Cells_in_complex_iterator cells_in_complex_end(Subdomain_index index); -/*! +/*! Returns a `Facet_in_complex_iterator` to visit the facets in the surface patches of the embedded complexes. */ Facets_in_complex_iterator facets_in_complex_begin(); -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Facets_in_complex_iterator facets_in_complex_end(); -/*! +/*! Returns a `Facet_in_complex_iterator` to visit the facets of the triangulation which which belong to the approximation of surface patch of index `index`. */ Facets_in_complex_iterator facets_in_complex_begin(Surface_patch_index index); -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Facets_in_complex_iterator facets_in_complex_end(Surface_patch_index index); diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h index f8e97ba3bc6..7279c3b69d2 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteriaWithFeatures_3.h @@ -31,7 +31,7 @@ public: /// \name Types /// @{ -/*! +/*! Functor that describes the criteria for the mesh edges that discretize the input domain 1-dimensional features. This type must be a model @@ -44,7 +44,7 @@ typedef unspecified_type Edge_criteria; /// \name Access Functions /// @{ -/*! +/*! Returns the edge criteria. */ Edge_criteria edge_criteria_object(); diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h index c3674b660aa..58d250816ac 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshCriteria_3.h @@ -28,14 +28,14 @@ public: /// \name Types /// @{ -/*! +/*! Functor that describes the criteria for surface facets. This type must be a model of the concept `MeshFacetCriteria_3`. */ typedef unspecified_type Facet_criteria; -/*! +/*! Functor that describes the criteria for mesh tetrahedra. This type must be a model of the concept `MeshCellCriteria_3`. @@ -47,12 +47,12 @@ typedef unspecified_type Cell_criteria; /// \name Access Functions /// @{ -/*! +/*! Returns the facet criteria. */ Facet_criteria facet_criteria_object(); -/*! +/*! Returns the cell criteria. */ Cell_criteria cell_criteria_object(); diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h index c94fd945318..23951c5ef4c 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshDomainField_3.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! Numerical type. */ typedef unspecified_type FT; -/*! +/*! Point type. */ typedef unspecified_type Point_3; -/*! +/*! Index type for points. Must match the type `MeshDomain_3::Index`. */ typedef unspecified_type Index; @@ -45,7 +45,7 @@ on the input feature including the query point. */ /// @{ -/*! +/*! returns the value of the sizing field at the point `p`, assumed to be included in the input complex feature with dimension `dimension` diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h index 3a00e39a4e6..ed531ce4f90 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshEdgeCriteria_3.h @@ -22,19 +22,19 @@ public: /// \name Types /// @{ -/*! +/*! Point type. Must match the `Point_3` type in the triangulation type used by the mesh generation function. */ typedef unspecified_type Point_3; -/*! +/*! Type for edges of the triangulation. Must match the `Edge` type in the triangulation type used by the mesh generation function. */ typedef unspecified_type Edge; -/*! +/*! Numerical type. */ typedef unspecified_type FT; @@ -44,13 +44,13 @@ typedef unspecified_type FT; /// \name Operations /// @{ -/*! +/*! Returns `true` if edge `e` does not fulfill the criteria. */ bool operator()(const Edge& e); -/*! +/*! Returns the value of the sizing field (i.e.\ the maximum edge length) at point `p`. */ diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h index 1534efd24e0..fbea71b5164 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshFacetCriteria_3.h @@ -25,21 +25,21 @@ public: /// \name Types /// @{ -/*! +/*! Type for the facets of the triangulation. Must match the `Facet` type in the triangulation type used by the mesh generation function. */ typedef unspecified_type Facet; -/*! +/*! Handle type for the cells of the triangulation. Must match the `Cell_handle` type in the triangulation type used by the mesh generation function. */ typedef unspecified_type Cell_handle; -/*! +/*! Type representing the quality of a facet. Must be a model of CopyConstructible and LessThanComparable. Between two facets, the one which has the lower @@ -47,7 +47,7 @@ quality must have the lower `Facet_quality`. */ typedef unspecified_type Facet_quality; -/*! +/*! Type representing if a facet is bad or not. This type must be convertible to `bool`. If it converts to `true` then the facet is bad, otherwise the facet is good with regard to the criteria. @@ -65,12 +65,12 @@ typedef unspecified_type Is_facet_bad; /// \name Operations /// @{ -/*! +/*! Returns `Is_facet_bad` value of facet `f`. */ Is_facet_bad operator()(Facet f); -/*! +/*! Same as above with `f=(c,i)`. */ Is_facet_bad operator()(Cell_handle c, int i); diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h index 532ca4e656b..252c55da9fc 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshPolyline_3.h @@ -17,12 +17,12 @@ public: /// \name Types /// @{ -/*! +/*! Point type. Must match the type `MeshDomain_3::Point_3`. */ typedef unspecified_type value_type; -/*! +/*! A constant iterator on points. Must be a model of Bidirectional iterator and have `value_type` as value type. */ typedef unspecified_type const_iterator; @@ -32,12 +32,12 @@ typedef unspecified_type const_iterator; /// \name Operations /// @{ -/*! +/*! Returns an iterator on the first point of the polyline. */ const_iterator begin(); -/*! +/*! Returns the past-the-end iterator for the above iterator. */ const_iterator end(); diff --git a/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h b/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h index 9a3be178eec..a6540782b13 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/MeshVertexBase_3.h @@ -34,12 +34,12 @@ public: /// \name Types /// @{ -/*! +/*! Index type. Must match the type `MeshDomain_3::Index`. */ typedef unspecified_type Index; -/*! +/*! Numerical type. */ typedef unspecified_type FT; @@ -49,22 +49,22 @@ typedef unspecified_type FT; /// \name Operations /// @{ -/*! +/*! Returns the dimension of the lowest dimensional face of the input 3D complex that contains the vertex. */ int in_dimension() const; -/*! +/*! Sets the dimension of the lowest dimensional face of the input 3D complex that contains the vertex. */ void set_dimension(int); -/*! +/*! Returns the index of the lowest dimensional face of the input 3D complex that contains the vertex. */ Index index(); -/*! +/*! Sets the index of the lowest dimensional face of the input 3D complex that contains the vertex. */ void set_index(Index); @@ -87,12 +87,12 @@ Sets the special aspect of the vertex. */ void set_special(bool); -/*! +/*! */ FT meshing_info() const; -/*! +/*! */ void set_meshing_info(FT); diff --git a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h index 3083f0c059c..007bf867341 100644 --- a/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h +++ b/Mesh_3/doc/Mesh_3/Concepts/TriangleAccessor_3.h @@ -18,24 +18,24 @@ public: /// \name Types /// @{ -/*! +/*! Triangle type. Must be a model of DefaultConstructible and CopyConstructible. */ typedef unspecified_type Triangle_3; -/*! +/*! Triangle iterator type. Must be a model of InputIterator. */ typedef unspecified_type Triangle_iterator; -/*! +/*! Handle to a `Triangle_3`. Must be constructible from `Triangle_iterator`. It may be `Triangle_Iterator` itself. */ typedef unspecified_type Triangle_handle; -/*! +/*! Polyhedron type. */ typedef unspecified_type Polyhedron; @@ -45,17 +45,17 @@ typedef unspecified_type Polyhedron; /// \name Operations /// @{ -/*! +/*! Returns a `Triangle_iterator` to visit the triangles of polyhedron `p`. */ Triangle_iterator triangles_begin(Polyhedron p); -/*! +/*! Returns the past-the-end iterator for the above iterator. */ Triangle_iterator triangles_end(Polyhedron p); -/*! +/*! Returns a `Triangle_3` object from handle `h`. */ diff --git a/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h b/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h index 8b962418889..bdcafceb206 100644 --- a/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h +++ b/Minkowski_sum_2/doc/Minkowski_sum_2/Concepts/PolygonConvexDecomposition_2.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! the geometric kernel type. */ typedef unspecified_type Kernel; -/*! +/*! the point type, used to represent polygon vertices. */ typedef unspecified_type Point_2; -/*! +/*! the polygon type. */ typedef unspecified_type Polygon_2; @@ -39,7 +39,7 @@ typedef unspecified_type Polygon_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ PolygonConvexDecomposition_2 (); @@ -49,7 +49,7 @@ PolygonConvexDecomposition_2 (); /// \name Operations /// @{ -/*! +/*! decomposes the input polygon `P` into convex sub-polygons, and writes them to the output iterator `oi`. The value-type of the output iterator must be `Polygon_2`. diff --git a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h index a73a0f7d0e1..18ba868788a 100644 --- a/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h +++ b/Miscellany/doc/Miscellany/CGAL/Handle_hash_function.h @@ -29,7 +29,7 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Handle_hash_function(); @@ -39,7 +39,7 @@ Handle_hash_function(); /// \name Operations /// @{ -/*! +/*! Returns unique hash value for any `Handle` type for which `&*key` gives a unique address. diff --git a/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h b/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h index 44da820fdf6..9ca0f52bd70 100644 --- a/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h +++ b/Miscellany/doc/Miscellany/CGAL/Memory_sizer.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::size_t size_type; @@ -34,7 +34,7 @@ typedef std::size_t size_type; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Memory_sizer(); @@ -44,12 +44,12 @@ Memory_sizer(); /// \name Operations /// @{ -/*! +/*! Returns the virtual memory size in bytes. */ size_type virtual_size() const; -/*! +/*! Returns the resident memory size in bytes. */ size_type resident_size() const; diff --git a/Miscellany/doc/Miscellany/CGAL/Modifier_base.h b/Miscellany/doc/Miscellany/CGAL/Modifier_base.h index 42d67a6b96b..c53841d30a5 100644 --- a/Miscellany/doc/Miscellany/CGAL/Modifier_base.h +++ b/Miscellany/doc/Miscellany/CGAL/Modifier_base.h @@ -49,7 +49,7 @@ public: /// \name Types /// @{ -/*! +/*! the internal representation type. */ typedef R Representation; @@ -59,7 +59,7 @@ typedef R Representation; /// \name Operations /// @{ -/*! +/*! \post `rep` is a valid representation. */ virtual void operator()( R& rep); diff --git a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h index 6f11666dd3a..df32da35d07 100644 --- a/Miscellany/doc/Miscellany/CGAL/Profile_counter.h +++ b/Miscellany/doc/Miscellany/CGAL/Profile_counter.h @@ -40,14 +40,14 @@ public: /// \name Creation /// @{ -/*! +/*! The internal counter is initialized to 0, and the string `s` is stored for further printing by the destructor. */ Profile_counter(std::string s); -/*! +/*! The value of the counter is printed to `std::cerr` together with the string. */ @@ -58,7 +58,7 @@ to `std::cerr` together with the string. /// \name Operations /// @{ -/*! +/*! Increments the internal counter. */ void operator++(); diff --git a/Miscellany/doc/Miscellany/CGAL/Real_timer.h b/Miscellany/doc/Miscellany/CGAL/Real_timer.h index 4d7aa40350b..775a1e013e4 100644 --- a/Miscellany/doc/Miscellany/CGAL/Real_timer.h +++ b/Miscellany/doc/Miscellany/CGAL/Real_timer.h @@ -33,7 +33,7 @@ public: /// \name Creation /// @{ -/*! +/*! state is *stopped*. */ Real_timer(); @@ -43,45 +43,45 @@ Real_timer(); /// \name Operations /// @{ -/*! +/*! \pre state is *stopped*. */ void start(); -/*! +/*! \pre state is *running*. */ void stop (); -/*! +/*! reset timer to zero. The state is unaffected. */ void reset(); -/*! +/*! `true` if the current state is running. */ bool is_running() const; -/*! +/*! real time in seconds, or 0 if the underlying system call failed. */ double time() const; -/*! +/*! number of start/stop-intervals since the last reset. */ int intervals() const; -/*! +/*! smallest possible time step in seconds, or -1 if the system call failed. */ double precision() const; -/*! +/*! maximal representable time in seconds. */ double max const(); diff --git a/Miscellany/doc/Miscellany/CGAL/Timer.h b/Miscellany/doc/Miscellany/CGAL/Timer.h index f9a14db475d..3da73acaff2 100644 --- a/Miscellany/doc/Miscellany/CGAL/Timer.h +++ b/Miscellany/doc/Miscellany/CGAL/Timer.h @@ -35,7 +35,7 @@ public: /// \name Creation /// @{ -/*! +/*! state is *stopped*. */ Timer(); @@ -45,45 +45,45 @@ Timer(); /// \name Operations /// @{ -/*! +/*! \pre state is *stopped*. */ void start(); -/*! +/*! \pre state is *running*. */ void stop (); -/*! +/*! reset timer to zero. The state is unaffected. */ void reset(); -/*! +/*! `true` if the current state is running. */ bool is_running() const; -/*! +/*! user process time in seconds, or 0 if the underlying system call failed. */ double time() const; -/*! +/*! number of start/stop-intervals since the last reset. */ int intervals() const; -/*! +/*! smallest possible time step in seconds, or -1 if the system call failed. */ double precision() const; -/*! +/*! maximal representable time in seconds. */ double max() const; diff --git a/Miscellany/doc/Miscellany/CGAL/Union_find.h b/Miscellany/doc/Miscellany/CGAL/Union_find.h index 451d93a5918..86148c8c12c 100644 --- a/Miscellany/doc/Miscellany/CGAL/Union_find.h +++ b/Miscellany/doc/Miscellany/CGAL/Union_find.h @@ -25,22 +25,22 @@ public: /// There are also constant versions `const_handle` and `const_iterator`. /// @{ -/*! +/*! values stored in items (equal to `T`). */ typedef unspecified_type value_type; -/*! +/*! handle to values. */ typedef unspecified_type handle; -/*! +/*! iterator over values. */ typedef unspecified_type iterator; -/*! +/*! allocator. */ typedef unspecified_type allocator; @@ -50,7 +50,7 @@ typedef unspecified_type allocator; /// \name Creation /// @{ -/*! +/*! creates an instance `P` of type `Union_find` and initializes it to the empty partition. */ @@ -61,61 +61,61 @@ Union_find(); /// \name Operations /// @{ -/*! +/*! the allocator of the partition. */ allocator get_allocator() const; -/*! +/*! returns the number of disjoint sets of the partition. */ std::size_t number_of_sets() const; -/*! +/*! returns the number of values of the partition. */ std::size_t size() const; -/*! +/*! returns the memory consumed by the partition. */ std::size_t bytes() const; -/*! +/*! returns the size of the set containing `h`. */ std::size_t size( const_handle h) const; -/*! +/*! reinitializes to an empty partition. */ void clear(); -/*! +/*! creates a new singleton set containing `x` and returns a handle to it. */ handle make_set(const T& x); -/*! +/*! same as `make_set()`. */ handle push_back(const T& x) ; -/*! +/*! inserts the range of values referenced by `[first,beyond)`. \tparam Forward_iterator must be a forward iterator with value type `T`. */ template void insert(Forward_iterator first, Forward_iterator beyond) ; -/*! +/*! */ handle find(handle h) const; -/*! +/*! returns a canonical handle of the set that contains `h`, i.e., `P.same_set(h,h2)` iff `P.find(h) == P.find(h2)`. @@ -123,27 +123,27 @@ canonical handle of the set that contains `h`, i.e., */ const_handle find( const_handle p) const; -/*! +/*! unites the sets of partition `P` containing `h1` and `h2`. \pre `h1` and `h2` are in `P`. */ void unify_sets( handle h1, handle h2); -/*! +/*! returns true iff `h1` and `h2` belong to the same set of `P`. \pre `h1` and `h2` are in `P`. */ bool same_set( const_handle h1, const_handle h2) const; -/*! +/*! returns an iterator pointing to the first value of the partition. */ iterator begin() const; -/*! +/*! returns an iterator pointing beyond the last value of the partition. */ diff --git a/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h b/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h index 4e2f1edd0ec..eab63c17eb6 100644 --- a/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h +++ b/Miscellany/doc/Miscellany/CGAL/Unique_hash_map.h @@ -42,17 +42,17 @@ public: /// In compliance with stl, the types `key_type`, `data_type`, and `hasher` are defined as well. /// @{ -/*! +/*! the `Key` type. */ typedef unspecified_type Key; -/*! +/*! the `Data` type. */ typedef unspecified_type Data; -/*! +/*! the unique hash function type. */ typedef unspecified_type Hash_function; @@ -62,7 +62,7 @@ typedef unspecified_type Hash_function; /// \name Creation /// @{ -/*! +/*! creates an injective function `map` from `Key` to the set of unused variables of type `Data`, sets `default_data` to `default`, @@ -74,7 +74,7 @@ const Data& default = Data(), std::size_t table_size = 1, const Hash_function& fct = Hash_function()); -/*! +/*! creates an injective function `map` from `Key` to the set of unused variables of type `Data`, sets `default_data` to `default`, @@ -98,17 +98,17 @@ const Hash_function& fct = Hash_function()); /// \name Operations /// @{ -/*! +/*! the current `default_value`. */ Data default_value() const; -/*! +/*! the current hash function. */ Hash_function hash_function() const; -/*! +/*! returns true if \f$ key\f$ is defined in `map`. Note that there can be keys defined that have not been inserted explicitly. Their variables are initialized to @@ -116,7 +116,7 @@ been inserted explicitly. Their variables are initialized to */ bool is_defined( const Key& key) const; -/*! +/*! resets `map` to the injective function `map` from `Key` to the set of unused variables of type `Data`. The `default_data` @@ -124,7 +124,7 @@ remains unchanged. */ void clear(); -/*! +/*! resets `map` to the injective function `map` from `Key` to the set of unused variables of type `Data` and sets `default_data` @@ -132,7 +132,7 @@ to `default`. */ void clear(const Data& default); -/*! +/*! returns a reference to the variable `map``(key)`. If `key` has not been inserted into `map` before, `key` is inserted and @@ -140,7 +140,7 @@ initialized with `default_value`. */ Data& operator[](const Key& key); -/*! +/*! returns a const reference to the variable `map``(key)`. If `key` has not been inserted into `map` before, a const reference to the @@ -149,7 +149,7 @@ into `map`. */ const Data& operator[](const Key& key) const; -/*! +/*! inserts all keys from the range `[first1,beyond1)`. The data variable for each inserted `key` is initilized with the diff --git a/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h b/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h index b3fd8a31066..6cbe5ecb666 100644 --- a/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h +++ b/Miscellany/doc/Miscellany/Concepts/UniqueHashFunction.h @@ -21,7 +21,7 @@ public: /// \name Types /// @{ -/*! +/*! type of the hash value. */ typedef std::size_t result_type; @@ -31,13 +31,13 @@ typedef std::size_t result_type; /// \name Creation /// @{ -/*! +/*! copy constructor. */ UniqueHashFunction( const UniqueHashFunction& hash2); -/*! +/*! assignment. */ UniqueHashFunction& operator=(const UniqueHashFunction& hash2); @@ -47,7 +47,7 @@ UniqueHashFunction& operator=(const UniqueHashFunction& hash2); /// \name Operations /// @{ -/*! +/*! returns a unique hash value for the `key` value. */ diff --git a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h index b1ec4806b66..7c3f245abaf 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/CGAL/Residue.h @@ -47,22 +47,22 @@ public: /// \name Creation /// @{ -/*! +/*! constructor which initializes with zero. */ Residue(); -/*! +/*! copy constructor. */ Residue(const Residue& m); -/*! +/*! constructor which initializes with \f$ i\mod p\f$. */ Residue(int i); -/*! +/*! constructor which initializes with \f$ i\mod p\f$. */ Residue(long i); @@ -72,78 +72,78 @@ Residue(long i); /// \name Operations /// @{ -/*! +/*! sets the current prime to the given value and returns the old prime. */ static int set_current_prime(int p); -/*! +/*! returns the value of the current prime. */ static int get_current_prime(); -/*! +/*! returns the unique representative within the range \f$ [-p/2,p/2]\f$, where \f$ p\f$ is the current prime. */ int get_value() const; -/*! +/*! */ Residue operator+(Residue a); -/*! +/*! */ Residue operator-(Residue a); -/*! +/*! */ Residue operator+(Residue a,Residue b); -/*! +/*! */ Residue operator-(Residue a,Residue b); -/*! +/*! */ Residue operator*(Residue a,Residue b); -/*! +/*! */ Residue operator/(Residue a,Residue b); -/*! +/*! */ Residue & operator+=(Residue a); -/*! +/*! */ Residue & operator-=(Residue a); -/*! +/*! */ Residue & operator*=(Residue a); -/*! +/*! */ Residue & operator/=(Residue a); -/*! +/*! */ Residue operator==(Residue a,Residue b); -/*! +/*! */ Residue operator!=(Residue a,Residue b); diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h index 7b3e3567052..035ab78a34e 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImage.h @@ -22,17 +22,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef ModularTraits::Residue_type result_type; -/*! +/*! */ typedef ModularTraits::Type argument_type; -/*! +/*! computes \f$ \varphi(x)\f$. diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h index 0bb7476d2b3..22bdf8f8504 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits--ModularImageRepresentative.h @@ -17,17 +17,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef ModularTraits::Type result_type; -/*! +/*! */ typedef ModularTraits::Residue_type argument_type; -/*! +/*! computes \f$ \varphi^{-1}(x)\f$. diff --git a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h index 9933b7eb909..41ff0200c90 100644 --- a/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h +++ b/Modular_arithmetic/doc/Modular_arithmetic/Concepts/ModularTraits.h @@ -22,12 +22,12 @@ public: /// A model of `ModularTraits` is supposed to provide: /// @{ -/*! +/*! The associated type. */ typedef unspecified_type Type ; -/*! +/*! Tag indicating whether the associated type is modularizable. @@ -35,7 +35,7 @@ This is either `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Is_modularizable; -/*! +/*! The type of the modular image. @@ -52,12 +52,12 @@ typedef unspecified_type Residue_type; /// `CGAL::Null_functor`. /// @{ -/*! +/*! A model of `ModularTraits::ModularImage` */ typedef unspecified_type Modular_image; -/*! +/*! A model of `ModularTraits::ModularImageRepresentative` */ typedef unspecified_type Modular_image_representative; diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h index 86620193e9d..bb18b82facb 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_cartesian.h @@ -29,7 +29,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Extended_cartesian(); diff --git a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h index 0e719c275f3..90388050a96 100644 --- a/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Extended_homogeneous.h @@ -32,7 +32,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Extended_homogeneous(); 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 7ad244e609e..ae4436f92b0 100644 --- a/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h +++ b/Nef_2/doc/Nef_2/CGAL/Filtered_extended_homogeneous.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Filtered_extended_homogeneous(); 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 594457a63c7..da6256d6729 100644 --- a/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h +++ b/Nef_2/doc/Nef_2/CGAL/Nef_polyhedron_2.h @@ -95,37 +95,37 @@ public: /// \name Types /// @{ -/*! +/*! the oriented lines modeling halfplanes. */ typedef unspecified_type Line; -/*! +/*! the affine points of the plane. */ typedef unspecified_type Point; -/*! +/*! directions in our plane. */ typedef unspecified_type Direction; -/*! +/*! tag for calling polygon constructor. */ typedef unspecified_type Polygons_tag; -/*! +/*! tag for calling polyline constructor. */ typedef unspecified_type Polylines_tag; -/*! +/*! construction selection. */ enum Boundary { EXCLUDED, INCLUDED }; -/*! +/*! construction selection */ enum Content { EMPTY, COMPLETE }; @@ -135,7 +135,7 @@ enum Content { EMPTY, COMPLETE }; /// \name Creation /// @{ -/*! +/*! creates an instance `N` of type `Nef_polyhedron_2` and initializes it to the empty set if `plane == EMPTY` @@ -144,7 +144,7 @@ and to the whole plane if `plane == COMPLETE`. */ Nef_polyhedron_2(Content plane = EMPTY); -/*! +/*! creates a Nef polyhedron `N` containing the halfplane left of `l` including `l` if `line==INCLUDED`, excluding `l` @@ -152,7 +152,7 @@ if `line==EXCLUDED`. */ Nef_polyhedron_2(Line l, Boundary line = INCLUDED); -/*! +/*! creates a Nef polyhedron `N` from the simple polygon `P` spanned by the list of points in the iterator range `[it,end)` and @@ -170,7 +170,7 @@ template Nef_polyhedron_2(Forward_iterator it, Forward_iterator end, Boundary b = INCLUDED); -/*! +/*! The iterator range [it, end) defines a set point ranges, each of which defines the boundary of simple polygon. */ @@ -178,7 +178,7 @@ template Nef_polyhedron_2(Forward_iterator it, Forward_iterator end, Polygons_tag); -/*! +/*! The iterator range [it, end) defines a set point ranges, each of which defines a polyline. */ @@ -191,7 +191,7 @@ Polylines_tag); /// \name Operations /// @{ -/*! +/*! makes `N` the empty set if `plane == EMPTY` and the full plane if `plane == COMPLETE`. @@ -199,13 +199,13 @@ full plane if `plane == COMPLETE`. */ void clear(Content plane = EMPTY) ; -/*! +/*! returns true if `N` is empty, false otherwise. */ bool is_empty() ; -/*! +/*! returns true if `N` is the whole plane, false otherwise. */ @@ -224,56 +224,56 @@ bool is_plane() ; /// respectively. /// @{ -/*! +/*! returns the complement of `N` in the plane. */ Nef_polyhedron_2 complement() ; -/*! +/*! returns the interior of `N`. */ Nef_polyhedron_2 interior() ; -/*! +/*! returns the closure of `N`. */ Nef_polyhedron_2 closure() ; -/*! +/*! returns the boundary of `N`. */ Nef_polyhedron_2 boundary() ; -/*! +/*! returns the regularized polyhedron (closure of interior). */ Nef_polyhedron_2 regularization() ; -/*! +/*! returns `N` \f$ \cap\f$ `N1`. */ Nef_polyhedron_2 intersection(const Nef_polyhedron_2& N1) ; -/*! +/*! returns `N` \f$ \cup\f$ `N1`. Note that "union" is a keyword of C++ and cannot be used for this operation. */ Nef_polyhedron_2 join(const Nef_polyhedron_2& N1) ; -/*! +/*! returns `N` \f$ -\f$ `N1`. */ Nef_polyhedron_2 difference(const Nef_polyhedron_2& N1) ; -/*! +/*! returns the symmectric difference `N - T` \f$ \cup\f$ `T - N`. */ @@ -339,23 +339,23 @@ public: /// @{ -/*! +/*! The underlying plane map type */ typedef unspecified_type Plane_map; -/*! +/*! The point type of vertices. */ typedef unspecified_type Point; -/*! +/*! All objects (vertices, edges, faces) are attributed by a `Mark` object. */ typedef unspecified_type Mark; -/*! +/*! The size type. */ typedef unspecified_type Size_type; @@ -370,20 +370,20 @@ typedef unspecified_type Size_type; /// following circulators are defined. /// @{ -/*! +/*! circulating the outgoing halfedges in \f$ A(v)\f$. */ typedef unspecified_type Halfedge_around_vertex_const_circulator; -/*! +/*! circulating the halfedges in the face cycle of a face `f`. */ typedef unspecified_type Halfedge_around_face_const_circulator; -/*! +/*! iterating all holes of a face `f`. The type is convertible to `Halfedge_const_handle`. @@ -391,7 +391,7 @@ convertible to `Halfedge_const_handle`. */ typedef unspecified_type Hole_const_iterator; -/*! +/*! iterating all isolated vertices of a face `f`. The type generalizes `Vertex_const_handle`. @@ -404,31 +404,31 @@ typedef unspecified_type Isolated_vertex_const_iterator; /// \name Operations /// @{ -/*! +/*! returns the source of `e`. */ Vertex_const_handle source(Halfedge_const_handle e) ; -/*! +/*! returns the target of `e`. */ Vertex_const_handle target(Halfedge_const_handle e) ; -/*! +/*! returns the twin of `e`. */ Halfedge_const_handle twin(Halfedge_const_handle e) ; -/*! +/*! returns `true` iff \f$ A(v) = \emptyset\f$. */ bool is_isolated(Vertex_const_handle v) ; -/*! +/*! returns one halfedge with source `v`. It's the starting point for the circular iteration over the halfedges with source `v`. @@ -437,7 +437,7 @@ the circular iteration over the halfedges with source `v`. */ Halfedge_const_handle first_out_edge(Vertex_const_handle v) ; -/*! +/*! returns the halfedge with source `v` that is the last in the circular iteration before encountering `first_out_edge(v)` @@ -446,7 +446,7 @@ again. \pre `!is_isolated(v)`. */ Halfedge_const_handle last_out_edge(Vertex_const_handle v) ; -/*! +/*! returns the edge after `e` in the cyclic ordered adjacency list of `source(e)`. @@ -454,7 +454,7 @@ returns the edge after `e` in the cyclic ordered adjacency list of */ Halfedge_const_handle cyclic_adj_succ(Halfedge_const_handle e) ; -/*! +/*! returns the edge before `e` in the cyclic ordered adjacency list of `source(e)`. @@ -462,31 +462,31 @@ returns the edge before `e` in the cyclic ordered adjacency list of */ Halfedge_const_handle cyclic_adj_pred(Halfedge_const_handle e) ; -/*! +/*! returns the next edge in the face cycle containing `e`. */ Halfedge_const_handle next(Halfedge_const_handle e) ; -/*! +/*! returns the previous edge in the face cycle containing `e`. */ Halfedge_const_handle previous(Halfedge_const_handle e) ; -/*! +/*! returns the face incident to `e`. */ Face_const_handle face(Halfedge_const_handle e) ; -/*! +/*! returns the face incident to `v`. \pre `is_isolated(v)`. */ Face_const_handle face(Vertex_const_handle v) ; -/*! +/*! returns a halfedge in the bounding face cycle of `f` (`Halfedge_const_handle()` if there is no bounding face cycle). @@ -499,51 +499,51 @@ Halfedge_const_handle halfedge(Face_const_handle f) ; /// \name Iteration /// @{ -/*! +/*! iterator over vertices of the map. */ Vertex_const_iterator vertices_begin(); -/*! +/*! past-the-end iterator for vertices. */ Vertex_const_iterator vertices_end(); -/*! +/*! iterator over halfedges of the map. */ Halfedge_const_iterator halfedges_begin(); -/*! +/*! past-the-end iterator for halfedges. */ Halfedge_const_iterator halfedges_end(); -/*! +/*! iterator over faces of the map. */ Face_const_iterator faces_begin(); -/*! +/*! past-the-end iterator for faces */ Face_const_iterator faces_end(); -/*! +/*! returns a circulator for the cyclic adjacency list of `v`. */ Halfedge_around_vertex_const_circulator out_edges(Vertex_const_handle v) ; -/*! +/*! returns a circulator for the outer face cycle of `f`. */ Halfedge_around_face_const_circulator face_cycle(Face_const_handle f) ; -/*! +/*! returns an iterator for all holes in the interior of `f`. A `Hole_iterator` can be assigned to a @@ -551,13 +551,13 @@ A `Hole_iterator` can be assigned to a */ Hole_const_iterator holes_begin(Face_const_handle f) ; -/*! +/*! returns the past-the-end iterator of `f`. */ Hole_const_iterator holes_end(Face_const_handle f) ; -/*! +/*! returns an iterator for all isolated vertices in the interior of `f`. @@ -565,7 +565,7 @@ returns an iterator for all isolated vertices in the interior of `f`. Isolated_vertex_const_iterator isolated_vertices_begin( Face_const_handle f) ; -/*! +/*! returns the past the end iterator of `f`. */ @@ -578,25 +578,25 @@ Face_const_handle f) ; /// The type `Mark` is the general attribute of an object. /// @{ -/*! +/*! returns the embedding of `v`. */ const Point& point(Vertex_const_handle v) ; -/*! +/*! returns the mark of `v`. */ const Mark& mark(Vertex_const_handle v) ; -/*! +/*! returns the mark of `e`. */ const Mark& mark(Halfedge_const_handle e) ; -/*! +/*! returns the mark of `f`. */ @@ -607,50 +607,50 @@ const Mark& mark(Face_const_handle f) ; /// \name Statistics and Integrity /// @{ -/*! +/*! returns the number of vertices. */ Size_type number_of_vertices() ; -/*! +/*! returns the number of halfedges. */ Size_type number_of_halfedges() ; -/*! +/*! returns the number of halfedge pairs. */ Size_type number_of_edges() ; -/*! +/*! returns the number of faces. */ Size_type number_of_faces() ; -/*! +/*! returns the number of face cycles. */ Size_type number_of_face_cycles() ; -/*! +/*! calculates the number of connected components of `P`. */ Size_type number_of_connected_components() ; -/*! +/*! print the statistics of `P`: the number of vertices, edges, and faces. */ void print_statistics(std::ostream& os = std::cout) ; -/*! +/*! checks the link structure and the genus of `P`. */ @@ -707,13 +707,13 @@ public: /// Iterators, handles, and circulators are inherited from `Topological_explorer`. /// @{ -/*! +/*! the point type of finite vertices. */ typedef unspecified_type Point; -/*! +/*! the ray type of vertices on the frame. */ @@ -724,25 +724,25 @@ typedef unspecified_type Ray; /// \name Operations /// @{ -/*! +/*! returns true iff `v`'s position is a standard point. */ bool is_standard(Vertex_const_handle v) ; -/*! +/*! returns the standard point that is the embedding of `v`. \pre `E.is_standard(v)`. */ Point point(Vertex_const_handle v) ; -/*! +/*! returns the ray defining the non-standard point on the frame. \pre `!E.is_standard(v)`. */ Ray ray(Vertex_const_handle v) ; -/*! +/*! returns true iff `e` is part of the infinimaximal frame. */ @@ -752,7 +752,7 @@ bool is_frame_edge(Halfedge_const_handle e) ; }; /* end Explorer */ -/*! +/*! a generic handle to an object of the underlying plane map. The kind of object `(vertex, halfedge, face)` can be determined and the object can be assigned to a corresponding @@ -770,7 +770,7 @@ where each function returns `true` iff the assignment to */ typedef unspecified_type Object_handle; -/*! +/*! selectionflag for the point location mode. LMWT stands for Locally Minimum Weight Triangulation, a locally optimized constrained triangulation where the weight corresponds to @@ -783,21 +783,21 @@ enum Location_mode { DEFAULT, NAIVE, LMWT}; /// \name Operations /// @{ -/*! +/*! returns true iff the object `h` is contained in the set represented by `N`. */ bool contains(Object_handle h) ; -/*! +/*! returns true iff the object `h` is contained in the \f$ 1\f$-skeleton of `N`. */ bool contained_in_boundary(Object_handle h) ; -/*! +/*! returns a generic handle `h` to an object (face, halfedge, vertex) of the underlying plane map that contains the point `p` in its relative interior. The point `p` is contained in @@ -808,7 +808,7 @@ point location strategies. Object_handle locate(const Point& p, Location_mode m = DEFAULT) ; -/*! +/*! returns a handle `h` with `N.contains(h)`, that can be converted to a `Vertex_/Halfedge_/Face_const_handle` as described above. The @@ -822,7 +822,7 @@ point location strategies. Object_handle ray_shoot(const Point& p, const Direction& d, Location_mode m = DEFAULT) ; -/*! +/*! returns a handle `h`, that can be converted to a `Vertex_/Halfedge_const_handle` as described above. The object returned is part of the \f$ 1\f$-skeleton of @@ -836,7 +836,7 @@ strategies. Object_handle ray_shoot_to_boundary(const Point& p, const Direction& d, Location_mode m = DEFAULT) ; -/*! +/*! returns a decorator object that allows read-only access of the underlying plane map. See the manual page `Explorer` for its diff --git a/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h b/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h index 1effbce1b76..eee9c388974 100644 --- a/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h +++ b/Nef_2/doc/Nef_2/Concepts/ExtendedKernelTraits_2.h @@ -50,49 +50,49 @@ public: /// \name Affine kernel types /// @{ -/*! +/*! the standard affine kernel. */ typedef unspecified_type Standard_kernel; -/*! +/*! the standard ring type. */ typedef unspecified_type Standard_RT; -/*! +/*! standard points. */ typedef unspecified_type Standard_point_2; -/*! +/*! standard segments. */ typedef unspecified_type Standard_segment_2; -/*! +/*! standard oriented lines. */ typedef unspecified_type Standard_line_2; -/*! +/*! standard directions. */ typedef unspecified_type Standard_direction_2; -/*! +/*! standard rays. */ typedef unspecified_type Standard_ray_2; -/*! +/*! standard affine transformations. */ @@ -103,31 +103,31 @@ typedef unspecified_type Standard_aff_transformation_2; /// \name Extended kernel types /// @{ -/*! +/*! the ring type of our extended kernel. */ typedef unspecified_type RT; -/*! +/*! extended points. */ typedef unspecified_type Point_2; -/*! +/*! extended segments. */ typedef unspecified_type Segment_2; -/*! +/*! extended directions. */ typedef unspecified_type Direction_2; -/*! +/*! a type descriptor for extended points. */ @@ -138,21 +138,21 @@ enum Point_type { SWCORNER, LEFTFRAME, NWCORNER, BOTTOMFRAME, STANDARD, TOPFRAME /// \name Interfacing the affine kernel types /// @{ -/*! +/*! creates an extended point and initializes it to the standard point `p`. */ Point_2 construct_point(const Standard_point_2& p) ; -/*! +/*! creates an extended point and initializes it to the equivalence class of all the rays underlying the oriented line `l`. */ Point_2 construct_point(const Standard_line_2& l) ; -/*! +/*! creates an extended point and initializes it to the equivalence class of all the rays underlying the oriented line `l(p1,p2)`. @@ -160,7 +160,7 @@ to the equivalence class of all the rays underlying the oriented line Point_2 construct_point(const Standard_point_2& p1, const Standard_point_2& p2) ; -/*! +/*! creates an extended point and initializes it to the equivalence class of all the rays underlying the ray starting in `p` in direction `d`. @@ -168,7 +168,7 @@ starting in `p` in direction `d`. Point_2 construct_point(const Standard_point_2& p, const Standard_direction_2& d) ; -/*! +/*! creates an extended point and initializes it to the equivalence class of all the rays underlying the oriented line opposite to `l`. @@ -176,56 +176,56 @@ class of all the rays underlying the oriented line opposite to Point_2 construct_opposite_point(const Standard_line_2& l) ; -/*! +/*! determines the type of `p` and returns it. */ Point_type type(const Point_2& p) ; -/*! +/*! returns `true` iff `p` is a standard point. */ bool is_standard(const Point_2& p) ; -/*! +/*! returns the standard point represented by `p`. \pre `K.is_standard(p)`. */ Standard_point_2 standard_point(const Point_2& p) ; -/*! +/*! returns the oriented line representing the bundle of rays defining `p`. \pre `!K.is_standard(p)`. */ Standard_line_2 standard_line(const Point_2& p) ; -/*! +/*! a ray defining `p`. \pre `!K.is_standard(p)`. */ Standard_ray_2 standard_ray(const Point_2& p) ; -/*! +/*! returns the point on the northeast frame corner. */ Point_2 NE() ; -/*! +/*! returns the point on the southeast frame corner. */ Point_2 SE() ; -/*! +/*! returns the point on the northwest frame corner. */ Point_2 NW() ; -/*! +/*! returns the point on the southwest frame corner. */ @@ -236,86 +236,86 @@ Point_2 SW() ; /// \name Geometric kernel calls /// @{ -/*! +/*! returns the source point of `s`. */ Point_2 source(const Segment_2& s) ; -/*! +/*! returns the target point of `s`. */ Point_2 target(const Segment_2& s) ; -/*! +/*! constructs a segment `pq`. */ Segment_2 construct_segment(const Point_2& p, const Point_2& q) ; -/*! +/*! returns the orientation of `p` with respect to the line through `s`. */ int orientation(const Segment_2& s, const Point_2& p) ; -/*! +/*! returns the orientation of `p3` with respect to the line through `p1p2`. */ int orientation(const Point_2& p1, const Point_2& p2, const Point_2& p3) ; -/*! +/*! return true iff the `p3` is left of the line through `p1p2`. */ bool left_turn(const Point_2& p1, const Point_2& p2, const Point_2& p3) ; -/*! +/*! return true iff `s` is degenerate. */ bool is_degenerate(const Segment_2& s) ; -/*! +/*! returns the lexicographic order of `p1` and `p2`. */ int compare_xy(const Point_2& p1, const Point_2& p2) ; -/*! +/*! returns the order on the \f$ x\f$-coordinates of `p1` and `p2`. */ int compare_x(const Point_2& p1, const Point_2& p2) ; -/*! +/*! returns the order on the \f$ y\f$-coordinates of `p1` and `p2`. */ int compare_y(const Point_2& p1, const Point_2& p2) ; -/*! +/*! returns the point of intersection of the lines supported by `s1` and `s2`. \pre The intersection point exists. */ Point_2 intersection( const Segment_2& s1, const Segment_2& s2) ; -/*! +/*! returns the direction of the vector `p2` - `p1`. */ Direction_2 construct_direction( const Point_2& p1, const Point_2& p2) ; -/*! +/*! returns `true` iff `d2` is in the interior of the counterclockwise angular sector between `d1` and `d3`. @@ -323,27 +323,27 @@ between `d1` and `d3`. bool strictly_ordered_ccw(const Direction_2& d1, const Direction_2& d2, const Direction_2& d3) ; -/*! +/*! returns `true` iff `p2` is in the relative interior of the segment `p1p3`. */ bool strictly_ordered_along_line( const Point_2& p1, const Point_2& p2, const Point_2& p3) ; -/*! +/*! returns true iff `s` contains `p`. */ bool contains(const Segment_2& s, const Point_2& p) ; -/*! +/*! returns true iff \f$ \|p1-p2\| < \|p3-p4\|\f$. */ bool first_pair_closer_than_second( const Point_2& p1, const Point_2& p2, const Point_2& p3, const Point_2& p4) ; -/*! +/*! returns a unique identifier for kernel object Input/Output. Usually this should be the name of the model. 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 ead11560bcb..2419bbdd3e8 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 @@ -35,7 +35,7 @@ public: /// \name Creation /// @{ -/*! +/*! Creates a widget `W` for displaying the 3D Nef polyhedron N. */ Qt_widget_Nef_3(const Nef_polyhedron_3& N); 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 d48ce95ee38..12680890b93 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 @@ -27,7 +27,7 @@ public: /// \name Creation /// @{ -/*! +/*! initialization only. */ Nef_nary_union_3(); @@ -37,12 +37,12 @@ Nef_nary_union_3(); /// \name Member Functions /// @{ -/*! +/*! returns the union of the polyhedra previously added to the class. */ NefPolyhedron_3 get_union() const; -/*! +/*! adds a polyhedron. */ void add_polyhedron(const NefPolyhedron_3& N); diff --git a/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h b/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h index b6e0efac178..98af4c67986 100644 --- a/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h +++ b/Nef_3/doc/Nef_3/CGAL/Nef_polyhedron_3.h @@ -100,32 +100,32 @@ public: /// The following types are the same as in `Nef_polyhedron_3`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! sphere point type stored in Halfedge. */ typedef unspecified_type Sphere_point; -/*! +/*! const handle to vertex. */ typedef unspecified_type Vertex_const_handle; -/*! +/*! const handle to halfedge. */ typedef unspecified_type Halfedge_const_handle; -/*! +/*! const handle to SHalfedge. */ typedef unspecified_type SHalfedge_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; @@ -135,47 +135,47 @@ public: /// \name Operations /// @{ -/*! +/*! the mark of `e` . */ const Mark& mark() const; -/*! +/*! the sphere point of `e` . */ const Sphere_point& point() const; -/*! +/*! returns |true| if `e` has no adjacent sedges. */ bool is_isolated() const; -/*! +/*! the center vertex of the sphere map `e` belongs to. */ Vertex_const_handle center_vertex() const; -/*! +/*! the source vertex of `e` . */ Vertex_const_handle source() const; -/*! +/*! the target vertex `e`. */ Vertex_const_handle target() const; -/*! +/*! the twin of `e` . */ Halfedge_const_handle twin() const; -/*! +/*! the first out sedge of `e` . */ SHalfedge_const_handle out_sedge() const; -/*! +/*! the incident sface of `e` . */ SFace_const_handle incident_sface() const; @@ -204,12 +204,12 @@ public: /// \name Types /// @{ -/*! +/*! const handle to SHalfedge. */ typedef unspecified_type SHalfedge_handle; -/*! +/*! const handle to SHalfloop. */ typedef unspecified_type SHalfloop_handle; @@ -219,7 +219,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Halffacet_cycle_iterator(); @@ -229,22 +229,22 @@ public: /// \name Operations /// @{ -/*! +/*! returns true if `hfc` represents a `SHalfedge_handle`. */ bool is_shalfedge() const; -/*! +/*! returns true if `hfc` represents a `SHalfloop_handle`. */ bool is_shalfloop() const; -/*! +/*! casts `hfc` to `SHalfedge_handle`. */ operator SHalfedge_handle() const; -/*! +/*! casts `hfc` to `SHalfloop_handle`. */ operator SHalfloop_handle() const; @@ -290,32 +290,32 @@ public: /// The following types are the same as in `Nef_polyhedron_3`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! plane type stored in Halffacet. */ typedef unspecified_type Plane_3; -/*! +/*! list of Object handles. */ typedef unspecified_type Object_list; -/*! +/*! const handle to Halffacet. */ typedef unspecified_type Halffacet_const_handle; -/*! +/*! const handle to volume. */ typedef unspecified_type Volume_const_handle; -/*! +/*! const iterator over the entries to all halffacet cycles of a halffacet. */ typedef unspecified_type Halffacet_cycle_const_iterator; @@ -325,32 +325,32 @@ public: /// \name Operations /// @{ -/*! +/*! the mark of `f` . */ const Mark& mark() const; -/*! +/*! the supporting plane of `f` . */ const Plane_3& plane() const; -/*! +/*! the twin of `f` . */ Halffacet_const_handle twin() const; -/*! +/*! the incident volume of `f` . */ Volume_const_handle incident_volume() const; -/*! +/*! iterator over the entries to all halffacet cycles of `f` . */ Halffacet_cycle_const_iterator facet_cycles_begin() const; -/*! +/*! past-the-end iterator. */ Halffacet_cycle_const_iterator facet_cycles_end() const; @@ -381,17 +381,17 @@ public: /// \name Types /// @{ -/*! +/*! const handle to SVertex. */ typedef unspecified_type SVertex_handle; -/*! +/*! const handle to SHalfedge. */ typedef unspecified_type SHalfedge_handle; -/*! +/*! const handle to SHalfloop. */ typedef unspecified_type SHalfloop_handle; @@ -401,7 +401,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ SFace_cycle_iterator(); @@ -411,32 +411,32 @@ public: /// \name Operations /// @{ -/*! +/*! returns true if `sfc` represents a `SVertex_handle`. */ bool is_svertex() const; -/*! +/*! returns true if `sfc` represents a `SHalfedge_handle`. */ bool is_shalfedge() const; -/*! +/*! returns true if `sfc` represents a `SHalfloop_handle`. */ bool is_shalfloop() const; -/*! +/*! casts `sfc` to `SVertex_handle`. */ operator SVertex_handle() const; -/*! +/*! casts `sfc` to `SHalfedge_handle`. */ operator SHalfedge_handle() const; -/*! +/*! casts `sfc` to `SHalfloop_handle`. */ operator SHalfloop_handle() const; @@ -476,32 +476,32 @@ public: /// The following types are the same as in `Nef_polyhedron_3`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! list of Object handles. */ typedef unspecified_type Object_list; -/*! +/*! const handle to Vertex. */ typedef unspecified_type Vertex_const_handle; -/*! +/*! const handle to Volume. */ typedef unspecified_type Volume_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; -/*! +/*! const iterator over the entries to all sface cycles of a sface. */ typedef unspecified_type SFace_cycle_const_iterator; @@ -511,27 +511,27 @@ public: /// \name Operations /// @{ -/*! +/*! the mark of `sf` . */ const Mark& mark() const; -/*! +/*! the center vertex of the sphere map `sf` belongs to. */ Vertex_const_handle center_vertex() const; -/*! +/*! the volume that corresponds to `sf` in the 3D incidence structure. */ Volume_const_handle volume() const; -/*! +/*! iterator over the entries to all sface cycles of `sf` . */ SFace_cycle_const_iterator sface_cycle_begin() const; -/*! +/*! past-the-end iterator. */ SFace_cycle_const_iterator sface_cycle_end() const; @@ -596,32 +596,32 @@ public: /// The following types are the same as in `Nef_polyhedron_3`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! sphere circle type stored in SHalfedge. */ typedef unspecified_type Sphere_circle; -/*! +/*! const handle to Halffacet. */ typedef unspecified_type Halffacet_const_handle; -/*! +/*! const handle to SVertex. */ typedef unspecified_type SVertex_const_handle; -/*! +/*! const handle to SHalfedge. */ typedef unspecified_type SHalfedge_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; @@ -631,91 +631,91 @@ public: /// \name Operations /// @{ -/*! +/*! the mark of `se` . */ const Mark& mark() const; -/*! +/*! the sphere circle of `se` . */ const Sphere_circle& circle() const; -/*! +/*! the twin of `se` . */ SHalfedge_const_handle twin() const; -/*! +/*! the source svertex of `se` . */ SVertex_const_handle source() const; -/*! +/*! equals `twin()->source()`. */ SVertex_const_handle target() const; -/*! +/*! the SHalfedge previous to `se` in a facet cycle. */ SHalfedge_const_handle prev() const; -/*! +/*! the next SHalfedge of `se` in a facet cycle. */ SHalfedge_const_handle next() const; -/*! +/*! the SHalfedge previous to `se` in a sface cycle. */ SHalfedge_const_handle sprev() const; -/*! +/*! the next SHalfedge of `se` in a sface cycle. */ SHalfedge_const_handle snext() const; -/*! +/*! the edge before `se` in the cyclic ordered adjacency list of source(). */ SHalfedge_const_handle cyclic_adj_pred() const; -/*! +/*! the edge after `se` in the cyclic ordered adjacency list of source(). */ SHalfedge_const_handle cyclic_adj_succ() const; -/*! +/*! the facet that corresponds to `se` in the 3D incidence structure. */ Halffacet_const_handle facet() const; -/*! +/*! the incident sface of `se` . */ SFace_const_handle incident_sface() const; -/*! +/*! determines whether `se` is in an outer sface cycle. */ bool in_outer_sface_cycle() const; -/*! +/*! determines whether `se` is in an inner sface cycle. */ bool in_inner_sface_cycle() const; -/*! +/*! determines whether `se` is in an outer facet cycle. */ bool in_outer_facet_cycle() const; -/*! +/*! determines whether `se` is in an inner facet cycle. */ @@ -762,27 +762,27 @@ public: /// The following types are the same as in `Nef_polyhedron_3`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! sphere circle type stored in SHalfloop. */ typedef unspecified_type Sphere_circle; -/*! +/*! const handle to Halffacet. */ typedef unspecified_type Halffacet_const_handle; -/*! +/*! const handle to SHalfloop. */ typedef unspecified_type SHalfloop_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; @@ -792,27 +792,27 @@ public: /// \name Operations /// @{ -/*! +/*! the mark of `se` . */ const Mark& mark() const; -/*! +/*! the sphere circle of `se` . */ const Sphere_circle& circle() const; -/*! +/*! the twin of `se` . */ SHalfloop_const_handle twin() const; -/*! +/*! the facet that corresponds to `se` in the 3D incidence structure. */ Halffacet_const_handle facet() const; -/*! +/*! the incident sface of `se` . */ SFace_const_handle incident_sface() const; @@ -844,12 +844,12 @@ public: /// The following types are the same as in `Nef_polyhedron_3`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! point type stored in Vertex. */ typedef unspecified_type Point_3; @@ -859,12 +859,12 @@ public: /// \name Operations /// @{ -/*! +/*! the mark of `v` . */ const Mark& mark() const; -/*! +/*! the point of `v` . */ const Point_3& point() const; @@ -898,22 +898,22 @@ public: /// The following types are the same as in `Nef_polyhedron_3`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! list of Object handles. */ typedef unspecified_type Object_list; -/*! +/*! const handle to Volume. */ typedef unspecified_type Volume_const_handle; -/*! +/*! const iterator over the entries to all shells adjacent to a volume. */ typedef unspecified_type Shell_entry_const_iterator; @@ -923,17 +923,17 @@ public: /// \name Operations /// @{ -/*! +/*! the mark of `c` . */ const Mark& mark() const; -/*! +/*! const iterator over the entries to all shells adjacent to `c` . */ Shell_entry_const_iterator shells_begin() const; -/*! +/*! past-the-end iterator. */ Shell_entry_const_iterator shells_end() const; @@ -942,133 +942,133 @@ public: }; /* end Volume */ -/*! +/*! traits class selected for `Nef_polyhedronTraits_3`. */ typedef unspecified_type Traits; -/*! +/*! All object (vertices, edges, etc.) are attributed by a Mark. Mark equals bool. */ typedef unspecified_type Mark; -/*! +/*! size type of `Nef_polyhedron_3`. */ typedef unspecified_type size_type; -/*! +/*! non-mutable handle to a vertex. */ typedef unspecified_type Vertex_const_handle; -/*! +/*! non-mutable handle to a halfedge. */ typedef unspecified_type Halfedge_const_handle; -/*! +/*! non-mutable handle to a halffacet. */ typedef unspecified_type Halffacet_const_handle; -/*! +/*! non-mutable handle to a volume. */ typedef unspecified_type Volume_const_handle; -/*! +/*! non-mutable handle to a svertex. */ typedef unspecified_type SVertex_const_handle; -/*! +/*! non-mutable handle to a shalfedge. */ typedef unspecified_type SHalfedge_const_handle; -/*! +/*! non-mutable handle to a shalfloop. */ typedef unspecified_type SHalfloop_const_handle; -/*! +/*! non-mutable handle to a sface. */ typedef unspecified_type SFace_const_handle; -/*! +/*! non-mutable iterator over all vertices. */ typedef unspecified_type Vertex_const_iterator; -/*! +/*! non-mutable iterator over all halfeges. */ typedef unspecified_type Halfedge_const_iterator; -/*! +/*! non-mutable iterator over all halffacets. */ typedef unspecified_type Halffacet_const_iterator; -/*! +/*! non-mutable iterator over all volumes. */ typedef unspecified_type Volume_const_iterator; -/*! +/*! non-mutable iterator over all svertices. */ typedef unspecified_type SVertex_const_iterator; -/*! +/*! non-mutable iterator over all shalfedges. */ typedef unspecified_type SHalfedge_const_iterator; -/*! +/*! non-mutable iterator over all shalfloops. */ typedef unspecified_type SHalfloop_const_iterator; -/*! +/*! non-mutable iterator over all sfaces. */ typedef unspecified_type SFace_const_iterator; -/*! +/*! non-mutable circulator of shalfedges around a svertex (cw). */ typedef unspecified_type SHalfedge_around_svertex_const_circulator; -/*! +/*! non-mutable circulator of shalfedges around a sface (ccw). */ typedef unspecified_type SHalfedge_around_sface_const_circulator; -/*! +/*! non-mutable circulator of shalfedges around a halffacet (ccw). */ typedef unspecified_type SHalfedge_around_facet_const_circulator; -/*! +/*! non-mutable iterator over the cylces of a sface. */ typedef unspecified_type SFace_cycle_const_iterator; -/*! +/*! non-mutable iterator over the cylces of a halffacet. */ typedef unspecified_type Halffacet_cycle_const_iterator; -/*! +/*! non-mutable iterator providing an entry to each shell. */ typedef unspecified_type Shell_entry_const_iterator; -/*! +/*! a generic handle to an object. The kind of object `(vertex, halfedge, halffacet, volume, svertex, shalfedge, shalfloop, sface)` can be determined and the object can be assigned to a corresponding @@ -1095,58 +1095,58 @@ public: */ typedef unspecified_type Object_handle; -/*! +/*! location of vertices. */ typedef unspecified_type Point_3; -/*! +/*! segment represented by a halfedge. */ typedef unspecified_type Segment_3; -/*! +/*! direction of a halfedge. */ typedef unspecified_type Vector_3; -/*! +/*! plane of a halffacet lies in. */ typedef unspecified_type Plane_3; -/*! +/*! affine transformation. */ typedef unspecified_type Aff_transformation_3; -/*! +/*! tag for calling polyline constructor. */ typedef unspecified_type Polylines_tag; -/*! +/*! construction selection. */ enum Boundary { EXCLUDED, INCLUDED }; -/*! +/*! construction selection. */ enum Content { EMPTY, COMPLETE }; -/*! +/*! intersection selection. */ enum Intersection_mode { CLOSED_HALFSPACE, OPEN_HALFSPACE, PLANE_ONLY }; -/*! +/*! a sphere map. */ typedef unspecified_type Nef_polyhedron_S2; -/*! +/*! a polyhedral surface. */ typedef unspecified_type Polyhedron; @@ -1156,14 +1156,14 @@ public: /// \name Creation /// @{ -/*! +/*! creates a Nef polyhedron and initializes it to the empty set if `plane == EMPTY` and to the whole space if `space == COMPLETE`. */ Nef_polyhedron_3(Content space = EMPTY); -/*! +/*! creates a Nef polyhedron containing the halfspace on the negative side of `p` including `p` if `b==INCLUDED`, excluding `p` if @@ -1172,14 +1172,14 @@ public: Nef_polyhedron_3(const Plane_3& p, Boundary b = INCLUDED); -/*! +/*! creates a Nef polyhedron, which represents the same point set as the polyhedral surface `P` does. */ Nef_polyhedron_3(Polyhedron& P); -/*! +/*! creates a Nef polyhedron consisting of a single polygon spanned by the list of points in the iterator range `[begin,end)`. If the points do not on a common @@ -1189,7 +1189,7 @@ public: */ Nef_polyhedron_3(Input_iterator begin, Input_iterator end); -/*! +/*! The iterator range [it, end) defines a set point ranges, each of which defines a polyline. */ @@ -1206,92 +1206,92 @@ public: /// `CGAL_forall_volumes(c,N)` where `N` is a `Nef_polyhedron_3`. /// @{ -/*! +/*! returns true, if `N` is a 2-manifold. */ bool is_simple() const; -/*! +/*! checks the integrity of `N` . */ bool is_valid() const; -/*! +/*! returns the number of vertices. */ Size_type number_of_vertices() const; -/*! +/*! return the number of halfedges. */ Size_type number_of_halfedges() const; -/*! +/*! returns the number of halfedge pairs. */ Size_type number_of_edges() const; -/*! +/*! returns the number of halffacets. */ Size_type number_of_halffacets() const; -/*! +/*! returns the number of halffacet pairs. */ Size_type number_of_facets() const; -/*! +/*! returns the number of volumes. */ Size_type number_of_volumes() const; -/*! +/*! iterator over all vertices. */ Vertex_const_iterator vertices_begin() const; -/*! +/*! past-the-end iterator. */ Vertex_const_iterator vertices_end() const; -/*! +/*! iterator over all halfedges. */ Halfedge_const_iterator halfedges_begin()const; -/*! +/*! past-the-end iterator. */ Halfedge_const_iterator halfedges_end() const; -/*! +/*! iterator over all halffacets. */ Halffacet_const_iterator halffacets_begin() const; -/*! +/*! past-the-end iterator. */ Halffacet_const_iterator halffacets_end() const; -/*! +/*! iterator over all volumes. */ Volume_const_iterator volumes_begin() const; -/*! +/*! past-the-end iterator. */ Volume_const_iterator volumes_end() const; -/*! +/*! returns a generic handle to the object (vertex, edge, facet or volume) which contains the point p in its relative interior. */ Object_handle locate(const Point_3& p) const; -/*! +/*! returns the neighborhood of a vertex modeled by a `Nef_polyhedron_S2`. */ Nef_polyhedron_S2 get_sphere_map(Vertex_const_iterator v) const; @@ -1301,44 +1301,44 @@ public: /// \name Point Set Predicates /// @{ -/*! +/*! returns true, if `N` is the empty point set. */ bool is_empty() const; -/*! +/*! returns true, if `N` is the complete 3D space. */ bool is_space() const; -/*! +/*! returns true, if `N` and N1 comprise the same point sets. */ bool operator==(const Nef_polyhedron_3& N1) const; -/*! +/*! returns true, if `N` and N1 comprise different point sets. */ bool operator!=(const Nef_polyhedron_3& N1) const; -/*! +/*! returns true, if `N` is a proper subset of N1. */ bool operator<(const Nef_polyhedron_3& N1) const; -/*! +/*! returns true, if `N` is a proper superset of N1. */ bool operator>(const Nef_polyhedron_3& N1) const; -/*! +/*! returns true, if `N` is a subset of N1. */ bool operator<=(const Nef_polyhedron_3& N1) const; -/*! +/*! returns true, if `N` is a superset of N1. */ bool operator>=(const Nef_polyhedron_3& N1) const; @@ -1348,32 +1348,32 @@ public: /// \name Unary Set Operations /// @{ -/*! +/*! returns the complement of `N` . */ Nef_polyhedron_3 complement() const; -/*! +/*! returns the interior of `N` . */ Nef_polyhedron_3 interior() const; -/*! +/*! returns the boundary of `N` . */ Nef_polyhedron_3 boundary() const; -/*! +/*! returns the closure of `N` . */ Nef_polyhedron_3 closure() const; -/*! +/*! returns the regularization, i.e.\ the closure of the interior, of `N` . */ Nef_polyhedron_3 regularization() const; -/*! +/*! returns the complement of `N` . */ Nef_polyhedron_3 operator!() const; @@ -1383,27 +1383,27 @@ public: /// \name Binary Set Operations /// @{ -/*! +/*! return the intersection of `N` and N1. */ Nef_polyhedron_3 intersection(const Nef_polyhedron_3& N1) const; -/*! +/*! return the union of `N` and N1. (Note that ''union'' is a C++ keyword and cannot be used for this operation.) */ Nef_polyhedron_3 join(const Nef_polyhedron_3& N1) const; -/*! +/*! return the difference between `N` and N1. */ Nef_polyhedron_3 difference(const Nef_polyhedron_3& N1) const; -/*! +/*! return the symmetric difference of `N` and N1. */ Nef_polyhedron_3 symmetric_difference(const Nef_polyhedron_3& N1) const; -/*! +/*! returns intersection of `N` with plane (`im=PLANE_ONLY`), open halfspace (`im=OPEN_HALFSPACE`), or closed halfspace (`im=CLOSED_HALFSPACE`). In the latter two cases, the @@ -1414,42 +1414,42 @@ public: */ Nef_polyhedron_3 intersection(const Plane_3& p, Intersection_mode im) const; -/*! +/*! return the intersection of `N` and N1. */ Nef_polyhedron_3 operator*(const Nef_polyhedron_3& N1) const; -/*! +/*! return the union of `N` and N1. */ Nef_polyhedron_3 operator+(const Nef_polyhedron_3& N1) const; -/*! +/*! return the difference between `N` and N1. */ Nef_polyhedron_3 operator-(const Nef_polyhedron_3& N1) const; -/*! +/*! return the symmetric difference of `N` and N1. */ Nef_polyhedron_3 operator^(const Nef_polyhedron_3& N1) const; -/*! +/*! intersects `N` and N1. */ void operator*=(const Nef_polyhedron_3& N1); -/*! +/*! unites `N` with N1. */ void operator+=(const Nef_polyhedron_3& N1); -/*! +/*! subtracts N1 from `N` . */ void operator-=(const Nef_polyhedron_3& N1); -/*! +/*! performs a symmetric intersection of `N` and N1. */ void operator^=(const Nef_polyhedron_3& N1); @@ -1459,23 +1459,23 @@ public: /// \name Operations /// @{ -/*! +/*! make `N` the empty set if `space == EMPTY` and the complete 3D space if `space == COMPLETE`. */ void clear(Content space = EMPTY); -/*! +/*! applies an affine transformation to `N` . */ void transform(const Aff_transformation_3& aff); -/*! +/*! converts `N` into a Polyhedron. \pre `N` is simple. */ void convert_to_polyhedron(Polyhedron& P) const; -/*! +/*! calls the visit function of `V` for every item which belongs to the same shell as `sf`. */ void visit_shell_objects(SFace_const_handle f, Visitor& V) const; 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 8c637de07c9..0fd821781ce 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 @@ -37,7 +37,7 @@ public: /// \name Creation /// @{ -/*! +/*! Creates a widget `W` for displaying the `Nef_polyhedron_S2` N. */ Qt_widget_Nef_3(const Nef_polyhedron_S2& N); 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 a9dc9c6c517..1f195a2e78f 100644 --- a/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h +++ b/Nef_S2/doc/Nef_S2/CGAL/Nef_polyhedron_S2.h @@ -91,12 +91,12 @@ public: /// \name Types /// @{ -/*! +/*! ring type. */ typedef unspecified_type RT; -/*! +/*! plane a `Sphere_circle` lies in. */ typedef unspecified_type Plane_3; @@ -106,12 +106,12 @@ typedef unspecified_type Plane_3; /// \name Creation /// @{ -/*! +/*! creates some great circle. */ Sphere_circle(); -/*! +/*! If \f$ p\f$ and \f$ q\f$ are opposite of each other, then we create the unique great circle on \f$ S_2\f$ which contains p and q. This circle is oriented such @@ -122,18 +122,18 @@ we create any great circle that contains \f$ p\f$ and \f$ q\f$. Sphere_circle(const Sphere_point& p, const Sphere_point& q); -/*! +/*! creates the circle corresponding to the plane `h`. \pre `h` contains the origin. */ Sphere_circle(const Plane_3& h); -/*! +/*! creates the circle orthogonal to the vector \f$ (x,y,z)\f$. */ Sphere_circle(const RT& x, const RT& y, const RT& z); -/*! +/*! creates a great circle orthogonal to \f$ c\f$ that contains \f$ p\f$. \pre \f$ p\f$ is not part of \f$ c\f$. */ @@ -145,24 +145,24 @@ p); /// \name Operations /// @{ -/*! +/*! Returns a sphere circle in the opposite direction of `c`. */ Sphere_circle opposite() ; -/*! +/*! returns true iff `c` contains `p`. */ bool has_on(const Sphere_point& p) ; -/*! +/*! returns the plane supporting `c`. */ Plane_3 plane() ; -/*! +/*! returns the point that is the pole of the hemisphere left of `c`. */ @@ -192,7 +192,7 @@ public: /// \name Types /// @{ -/*! +/*! ring number type. */ typedef unspecified_type RT; @@ -202,12 +202,12 @@ typedef unspecified_type RT; /// \name Creation /// @{ -/*! +/*! creates some sphere point. */ Sphere_point(); -/*! +/*! creates a sphere point corresponding to the point of intersection of the ray starting at the origin in direction \f$ (x,y,z)\f$ and the surface of \f$ S_2\f$. @@ -219,32 +219,32 @@ Sphere_point(RT x, RT y, RT z); /// \name Operations /// @{ -/*! +/*! the \f$ x\f$-coordinate. */ RT x() ; -/*! +/*! the \f$ y\f$-coordinate. */ RT y() ; -/*! +/*! the \f$ z\f$-coordinate. */ RT z() ; -/*! +/*! Equality. */ bool operator==(const Nef_polyhedron_S2::Sphere_point& q) ; -/*! +/*! Inequality. */ bool operator!=(const Nef_polyhedron_S2::Sphere_point& q) ; -/*! +/*! returns the antipode of `p`. */ Sphere_point antipode() ; @@ -273,19 +273,19 @@ public: /// \name Creation /// @{ -/*! +/*! creates some sphere segment. */ Sphere_segment(); -/*! +/*! creates a spherical segment spanning the shorter arc from `p1` to `p2` if `shorter_arc == true`. Otherwise the longer arc is created. \pre `p1 != p2` and `p1 != p2.opposite()`. */ Sphere_segment( const Sphere_point& p1, const Sphere_point& p2, bool shorter_arc=true); -/*! +/*! creates a spherical segment spanning the arc from `p1` to `p2` as part of the oriented circle `c` (`p1 == p2` or `p1 == p2.opposite()` are possible.) @@ -294,7 +294,7 @@ arc from `p1` to `p2` as part of the oriented circle `c` Sphere_segment(const Sphere_point& p1, const Sphere_point& p2, const Sphere_circle& c); -/*! +/*! creates the spherical segment as part of `c1` that is part of the halfsphere left of the oriented circle `c2`. \pre `c1 != c2` as unoriented circles. */ @@ -306,69 +306,69 @@ const Sphere_circle& c2); /// \name Operations /// @{ -/*! +/*! the source point of `s`. */ const Sphere_point& source() ; -/*! +/*! the target point of `s`. */ const Sphere_point& target() ; -/*! +/*! the great circle supporting `s`. */ const Sphere_circle& sphere_circle() ; -/*! +/*! returns the sperical segment oriented from `target()` to `source()` with the same point set as `s`. */ Sphere_segment opposite() ; -/*! +/*! returns the sperical segment oriented from `target()` to `source()` with the point set completing `s` to a full circle. */ Sphere_segment complement() ; -/*! +/*! a segment is short iff it is shorter than a half-circle. */ bool is_short() ; -/*! +/*! a segment is long iff it is longer than a half-circle. */ bool is_long() ; -/*! +/*! return true iff `s` is degenerate, i.e.\ source and target are the same. */ bool is_degenerate() ; -/*! +/*! return true iff `s` is a perfect half-circle, i.e.\ `source().antipode == target()`. */ bool is_halfcircle() ; -/*! +/*! return true iff `s` contains `p`. */ bool has_on(const Sphere_point& p) ; -/*! +/*! return true iff `s` contains `p` in its relative interior. @@ -402,17 +402,17 @@ public: /// \name Types /// @{ -/*! +/*! const handle to SVertex. */ typedef unspecified_type SVertex_handle; -/*! +/*! const handle to SHalfedge. */ typedef unspecified_type SHalfedge_handle; -/*! +/*! const handle to SHalfloop. */ typedef unspecified_type SHalfloop_handle; @@ -422,7 +422,7 @@ typedef unspecified_type SHalfloop_handle; /// \name Creation /// @{ -/*! +/*! default constructor. */ SFace_cycle_iterator(); @@ -432,32 +432,32 @@ SFace_cycle_iterator(); /// \name Operations /// @{ -/*! +/*! returns true if the iterator represents a `SVertex_handle`. */ bool is_svertex() const; -/*! +/*! returns true if the iterator represents a `SHalfedge_handle`. */ bool is_shalfedge() const; -/*! +/*! returns true if the iterator represents a `SHalfloop_handle`. */ bool is_shalfloop() const; -/*! +/*! casts the iterator to `SVertex_handle`. */ operator SVertex_handle() const; -/*! +/*! casts the iterator to `SHalfedge_handle`. */ operator SHalfedge_handle() const; -/*! +/*! casts the iterator to `SHalfloop_handle`. */ operator SHalfloop_handle() const; @@ -496,32 +496,32 @@ public: /// The following types are the same as in `Nef_polyhedron_S2`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! list of Object handles. */ typedef unspecified_type Object_list; -/*! +/*! const handle to Vertex. */ typedef unspecified_type Vertex_const_handle; -/*! +/*! const handle to Volume. */ typedef unspecified_type Volume_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; -/*! +/*! const iterator over the entries to all `sface` cycles of a `sface`. */ typedef unspecified_type SFace_cycle_const_iterator; @@ -531,17 +531,17 @@ typedef unspecified_type SFace_cycle_const_iterator; /// \name Operations /// @{ -/*! +/*! the mark of the `sface`. */ const Mark& mark() const; -/*! +/*! iterator over the entries to all sface cycles of the `sface` . */ SFace_cycle_const_iterator sface_cycle_begin() const; -/*! +/*! past-the-end iterator. */ SFace_cycle_const_iterator sface_cycle_end() const; @@ -598,27 +598,27 @@ public: /// The following types are the same as in `Nef_polyhedron_S2`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! sphere circle type stored in SHalfedge. */ typedef unspecified_type Sphere_circle; -/*! +/*! const handle to SVertex. */ typedef unspecified_type SVertex_const_handle; -/*! +/*! const handle to SHalfedge. */ typedef unspecified_type SHalfedge_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; @@ -628,63 +628,63 @@ typedef unspecified_type SFace_const_handle; /// \name Operations /// @{ -/*! +/*! the mark of the `sedge`. */ const Mark& mark() const; -/*! +/*! the sphere circle of the `sedge`. */ const Sphere_circle& circle() const; -/*! +/*! the twin of the `sedge`. */ SHalfedge_const_handle twin() const; -/*! +/*! the source svertex of the `sedge`. */ SVertex_const_handle source() const; -/*! +/*! equals `twin()->source()`. */ SVertex_const_handle target() const; -/*! +/*! the SHalfedge previous to the `sedge` in a sface cycle. */ SHalfedge_const_handle sprev() const; -/*! +/*! the next SHalfedge of the `sedge` in a sface cycle. */ SHalfedge_const_handle snext() const; -/*! +/*! the edge before the `sedge` in the cyclic ordered adjacency list of `source()`. */ SHalfedge_const_handle cyclic_adj_pred() const; -/*! +/*! the edge after the `sedge` in the cyclic ordered adjacency list of `source()`. */ SHalfedge_const_handle cyclic_adj_succ() const; -/*! +/*! the incident `sface` of the `sedge`. */ SFace_const_handle incident_sface() const; -/*! +/*! determines whether the `sedge` is in an outer sface cycle. */ bool in_outer_sface_cycle() const; -/*! +/*! determines whether the `sedge` is in an inner sface cycle. */ @@ -726,22 +726,22 @@ public: /// The following types are the same as in `Nef_polyhedron_S2`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! sphere circle type stored in SHalfloop. */ typedef unspecified_type Sphere_circle; -/*! +/*! const handle to SHalfloop. */ typedef unspecified_type SHalfloop_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; @@ -751,22 +751,22 @@ typedef unspecified_type SFace_const_handle; /// \name Operations /// @{ -/*! +/*! the mark of the halfloop. */ const Mark& mark() const; -/*! +/*! the sphere circle of the halfloop. */ const Sphere_circle& circle() const; -/*! +/*! the twin of the halfloop. */ SHalfloop_const_handle twin() const; -/*! +/*! the incident sface of the halfloop. */ SFace_const_handle incident_sface() const; @@ -802,27 +802,27 @@ public: /// The following types are the same as in `Nef_polyhedron_S2`. /// @{ -/*! +/*! type of mark. */ typedef unspecified_type Mark; -/*! +/*! sphere point type stored in SVertex. */ typedef unspecified_type Sphere_point; -/*! +/*! const handle to SVertex. */ typedef unspecified_type SVertex_const_handle; -/*! +/*! const handle to SHalfedge. */ typedef unspecified_type SHalfedge_const_handle; -/*! +/*! const handle to SFace. */ typedef unspecified_type SFace_const_handle; @@ -832,32 +832,32 @@ typedef unspecified_type SFace_const_handle; /// \name Operations /// @{ -/*! +/*! the mark of the `svertex`. */ const Mark& mark() const; -/*! +/*! the sphere point of the `svertex`. */ const Sphere_point& point() const; -/*! +/*! returns |true| if the `svertex` has no adjacent sedges. */ bool is_isolated() const; -/*! +/*! the twin of the `svertex`. */ SVertex_const_handle twin() const; -/*! +/*! the first out sedge of the `svertex`. */ SHalfedge_const_handle out_sedge() const; -/*! +/*! the incident sface of the `svertex`. */ SFace_const_handle incident_sface() const; @@ -866,59 +866,59 @@ SFace_const_handle incident_sface() const; }; /* end SVertex */ -/*! +/*! non-mutable handle to svertex. */ typedef unspecified_type SVertex_const_handle; -/*! +/*! non-mutable handle to shalfedge. */ typedef unspecified_type SHalfedge_const_handle; -/*! +/*! non-mutable handle to shalfloop. */ typedef unspecified_type SHalfloop_const_handle; -/*! +/*! non-mutable handle to sface. */ typedef unspecified_type SFace_const_handle; -/*! +/*! non-mutable iterator over all svertices. */ typedef unspecified_type SVertex_const_iterator; -/*! +/*! non-mutable iterator over all shalfedges. */ typedef unspecified_type SHalfedge_const_iterator; -/*! +/*! non-mutable iterator over all shalfloops. */ typedef unspecified_type SHalfloop_const_iterator; -/*! +/*! non-mutable iterator over all sfaces. */ typedef unspecified_type SFace_const_iterator; -/*! +/*! circulating the adjacency list of an svertex `v`. */ typedef unspecified_type SHalfedge_around_svertex_const_circulator; -/*! +/*! circulating the sface cycle of an sface `f`. */ typedef unspecified_type SHalfedge_around_sface_const_circulator; -/*! +/*! iterating all sface cycles of an sface `f`. The iterator has method `bool is_svertex()`, `bool is_shalfedge()`, `bool is_shalfloop()`, and can be @@ -927,22 +927,22 @@ converted to the corresponding handles `SVertex_const_handle`, */ typedef unspecified_type SFace_cycle_const_iterator; -/*! +/*! attributes of objects (vertices, edges, faces). */ typedef unspecified_type Mark; -/*! +/*! size type */ typedef unspecified_type size_type; -/*! +/*! construction selection. */ enum Boundary { EXCLUDED, INCLUDED }; -/*! +/*! construction selection. */ enum Content { EMPTY, COMPLETE }; @@ -952,7 +952,7 @@ enum Content { EMPTY, COMPLETE }; /// \name Creation /// @{ -/*! +/*! creates an instance `N` of type `Nef_polyhedron_S2` and initializes it to the empty set if `sphere == EMPTY` and to the @@ -960,7 +960,7 @@ whole sphere if `sphere == COMPLETE`. */ Nef_polyhedron_S2(Content sphere = EMPTY); -/*! +/*! creates a Nef polyhedron `N` containing the half-sphere left of `c` including `c` if `circle==INCLUDED`, excluding `c` if `circle==EXCLUDED`. @@ -969,7 +969,7 @@ half-sphere left of `c` including `c` if Nef_polyhedron_S2(Sphere_circle c, Boundary circle = INCLUDED); -/*! +/*! creates a Nef polyhedron `N` from the set of sphere segments in the iterator range `[first,beyond)`. If the set of sphere segments is a simple @@ -988,19 +988,19 @@ beyond, Boundary b = INCLUDED); /// \name Operations /// @{ -/*! +/*! makes `N` the empty set if `plane == EMPTY` and the full plane if `plane == COMPLETE`. */ void clear(Content plane = EMPTY) ; -/*! +/*! returns true if `N` is empty, false otherwise. */ bool is_empty() ; -/*! +/*! returns true if `N` is the whole sphere, false otherwise. */ @@ -1021,55 +1021,55 @@ bool is_sphere() ; /// @{ -/*! +/*! returns the complement of `N` in the plane. */ Nef_polyhedron_S2 complement() ; -/*! +/*! returns the interior of `N`. */ Nef_polyhedron_S2 interior() ; -/*! +/*! returns the closure of `N`. */ Nef_polyhedron_S2 closure() ; -/*! +/*! returns the boundary of `N`. */ Nef_polyhedron_S2 boundary() ; -/*! +/*! returns the regularized polyhedron (closure of interior). */ Nef_polyhedron_S2 regularization() ; -/*! +/*! returns `N` \f$ \cap\f$ `N1`. */ Nef_polyhedron_S2 intersection(const Nef_polyhedron_S2& N1) ; -/*! +/*! returns `N` \f$ \cup\f$ `N1`. */ Nef_polyhedron_S2 join(const Nef_polyhedron_S2& N1) ; -/*! +/*! returns `N` \f$ -\f$ `N1`. */ Nef_polyhedron_S2 difference(const Nef_polyhedron_S2& N1) ; -/*! +/*! returns the symmectric difference `N - T` \f$ \cup\f$ `T - N`. */ @@ -1081,62 +1081,62 @@ Nef_polyhedron_S2& N1) ; /// \name Statistics and Integrity /// @{ -/*! +/*! returns the number of svertices. */ Size_type number_of_svertices() ; -/*! +/*! returns the number of shalfedges. */ Size_type number_of_shalfedges() ; -/*! +/*! returns the number of sedges. */ Size_type number_of_sedges() ; -/*! +/*! returns the number of shalfloops. */ Size_type number_of_shalfloops() ; -/*! +/*! returns the number of sloops. */ Size_type number_of_sloops() ; -/*! +/*! returns the number of sfaces. */ Size_type number_of_sfaces() ; -/*! +/*! returns the number of sface cycles. */ Size_type number_of_sface_cycles() ; -/*! +/*! calculates the number of connected components of `P`. */ Size_type number_of_connected_components() ; -/*! +/*! print the statistics of `P`: the number of vertices, edges, and faces. */ void print_statistics(std::ostream& os = std::cout) ; -/*! +/*! checks the link structure and the genus of `P`. */ @@ -1148,7 +1148,7 @@ faces=true) ; /// \name Types /// @{ -/*! +/*! a generic handle to an object of the underlying plane map. The kind of object `(vertex, halfedge, face)` can be determined and the object can @@ -1167,20 +1167,20 @@ typedef unspecified_type Object_handle; /// \name Operations /// @{ -/*! +/*! returns true iff the object `h` is contained in the set represented by `N`. */ bool contains(Object_handle h) ; -/*! +/*! returns true iff the object `h` is contained in the \f$ 1\f$-skeleton of `N`. */ bool contained_in_boundary(Object_handle h) ; -/*! +/*! returns a generic handle `h` to an object (face, halfedge, vertex) of the underlying plane map that contains the point `p` in its relative @@ -1191,7 +1191,7 @@ strategies. */ Object_handle locate(const Sphere_point& p) ; -/*! +/*! returns a handle `h` with `N.contains(h)` that can be converted to a `Vertex_/Halfedge_/Face_const_handle` as described above. The @@ -1204,7 +1204,7 @@ operation returns an empty `Object_handle` if the ray shoot along Object_handle ray_shoot(const Sphere_point& p, const Sphere_direction& d) ; -/*! +/*! returns a handle `h` that can be converted to a `Vertex_/Halfedge_const_handle` as described above. The object returned is part of the \f$ 1\f$-skeleton of `N`, @@ -1240,13 +1240,13 @@ const Sphere_direction& d) ; /// @{ -/*! +/*! returns true iff there is a shalfloop. */ bool has_shalfloop() const; -/*! +/*! returns access to the sloop. */ @@ -1256,7 +1256,7 @@ SHalfloop_const_handle shalfloop() const; }; /* end Nef_polyhedron_S2 */ -/*! +/*! returns true iff `c1` and `c2` are equal as unoriented circles. \relates Nef_polyhedron_S2::Sphere_circle diff --git a/Number_types/doc/Number_types/CGAL/FPU.h b/Number_types/doc/Number_types/CGAL/FPU.h index d22ec890fe4..e7f7a353146 100644 --- a/Number_types/doc/Number_types/CGAL/FPU.h +++ b/Number_types/doc/Number_types/CGAL/FPU.h @@ -69,7 +69,7 @@ public: /// \name Creation /// @{ -/*! +/*! The current rounding mode is saved in the object, and rounding mode is set to `r` which can be any of `CGAL_FE_TONEAREST`, `CGAL_FE_TOWARDZERO`, `CGAL_FE_UPWARD` (the default) and `CGAL_FE_DOWNWARD`. @@ -78,7 +78,7 @@ Protect_FPU_rounding(FPU_CW_t r = CGAL_FE_UPWARD); -/*! +/*! The rounding mode is restored to the saved value. */ ~Protect_FPU_rounding(); @@ -158,13 +158,13 @@ public: /// @{ -/*! +/*! Sets the precision of operations on double to 53bits. Note that the rounding mode is set to the nearest in the same process. */ Set_ieee_double_precision(); -/*! +/*! The precision and rounding modes are reset to the values they held before the constructor was called. */ @@ -173,7 +173,7 @@ constructor was called. }; /* end Set_ieee_double_precision */ -/*! +/*! Sets the precision of operations on double to 53bits. Note that the rounding mode is set to the nearest in the same process. diff --git a/Number_types/doc/Number_types/CGAL/Gmpfi.h b/Number_types/doc/Number_types/CGAL/Gmpfi.h index faa3834b43b..88b86733293 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpfi.h +++ b/Number_types/doc/Number_types/CGAL/Gmpfi.h @@ -39,7 +39,7 @@ public: /// \name Types /// @{ -/*! +/*! Type representing the precision (number of bits used to represent the mantissa) of a number. */ @@ -57,12 +57,12 @@ typedef unspecified_type Precision_type; /// included in the constructed interval. /// @{ -/*! +/*! creates an uninitialized `Gmpfi` interval `i`. */ Gmpfi(Precision_type p=get_default_precision()); -/*! +/*! creates a `Gmpfi` initialized with the value of `t`. `T` is `Gmpfr`, `Gmpq`, or any type from which `Gmpfr` can be constructed from. The rounding of the @@ -71,7 +71,7 @@ endpoints will guarantee that `t` is included in `i`. template Gmpfi(const T& t,Precision_type p=get_default_precision()); -/*! +/*! creates a `Gmpfi` initialized with endpoints `left` and `right`. The rounding of the endpoints will guarantee that ([`left`,`right`]) is included in `i`. @@ -80,7 +80,7 @@ Gmpfi(const Gmpfr &left, const Gmpfr &right, Precision_type p=get_default_precision()); -/*! +/*! creates a `Gmpfi` initialized with endpoints `endpoints.first` and `endpoints.second`. `L` and `R` are types from which `Gmpfr` can be constructed @@ -98,35 +98,35 @@ Precision_type p=get_default_precision()); /// @{ -/*! +/*! Returns the smallest (or inferior) `Gmpfr` endpoint of `i`. */ Gmpfr inf() const; -/*! +/*! Returns the largest (or superior) `Gmpfr` endpoint of `i`. */ Gmpfr sup()const; -/*! +/*! Returns the default precision. */ static Precision_type get_default_precision(); -/*! +/*! Sets the default precision to `prec` and returns the old value. */ static Precision_type set_default_precision(Precision_type prec); -/*! +/*! Returns the precision of `i`. */ Precision_type get_precision()const; -/*! +/*! Returns the value of the number, rounded with precision `p`. */ Gmpfi round(Precision_type p)const; @@ -157,42 +157,42 @@ family of functions, it is defined as in the overloaded operators. /// @{ static Gmpfi add (const Gmpfi &a,const Gmpfi &b,Precision_type p=0); -/*! +/*! Returns the absolute value of `i`, with precision `p`. If `p` is not specified, the precision used is the maximum between `i`'s precision and the default. */ Gmpfi abs(Precision_type p)const; -/*! +/*! Returns the square root of `i`, with precision `p`. If `p` is not specified, the precision used is the maximum between `i`'s precision and the default. */ Gmpfi sqrt(Precision_type p)const; -/*! +/*! Returns the k-th root of `i`, with precision `p`. If `p` is not specified, the precision used is the maximum between `i`'s precision and the default. */ Gmpfi kthroot(int k,Precision_type p)const; -/*! +/*! Returns the square of `i`, with precision `p`. If `p` is not specified, the precision used is the maximum between `i`'s precision and the default. */ Gmpfi square(Precision_type p)const; -/*! +/*! Returns an interval of doubles which contains `i`. If a rounded endpoint does not fit in a double, sets its value to plus or minus infinity and the `overflow` or `underflow` flag. */ std::pair to_interval()const; -/*! +/*! Returns \f$ (m,e)\f$ such that \f$ m \times2^e\f$ is the center of `i`, rounded to nearest. If one of the endpoints of `i` is `NaN` or infinity, then the corresponding double is returned, @@ -201,7 +201,7 @@ error flag. */ std::pair to_double_exp()const; -/*! +/*! Returns \f$ ((m_1,m_2),e)\f$, such that \f$ [m_1 \times2^e,m_2 \times2^e]\f$ contains `i`. If one of the endpoints of `i` is `NaN` or infinity, then the corresponding doubles @@ -222,20 +222,20 @@ The class provides also functions to test efficiently some special kinds of comp /// @{ -/*! +/*! Returns `true` iff left endpoints of `i` and `j` are equal and right endpoints of them are also equal. Note that this does not mean equality between `i` and `j`. */ bool is_same(const Gmpfi &j)const; -/*! +/*! Returns `true` iff `i` and `j` overlap, i.e., iff they have points in common. */ bool do_overlap(const Gmpfi &j)const; -/*! +/*! If `i` and `j` do not overlap, this function returns the result of the comparison. Otherwise, it returns `indeterminate`. @@ -247,57 +247,57 @@ Uncertain compare(const Gmpfi &j)const; /// \name Query Functions /// @{ -/*! +/*! Returns `true` iff both endpoints are equal. */ bool is_point()const; -/*! +/*! Returns `true` iff at least one of the endpoints is `NaN`. */ bool is_nan()const; -/*! +/*! Returns `true` iff at least one of the endpoints is plus or minus infinity. */ bool is_inf()const; -/*! +/*! Returns `true` iff `i` is a bounded interval, i.e., its endpoints are neither invalid nor infinite. */ bool is_number()const; -/*! +/*! Returns `true` if both endpoints are zero, `false` if the interval does not contain zero and `indeterminate` otherwise. */ Uncertain is_zero()const; -/*! +/*! Returns `true` if both endpoints are one, `false` if the interval does not contain one and `indeterminate` otherwise. */ Uncertain is_one()const; -/*! +/*! If all numbers contained in the interval have the same sign, this function returns it. Otherwise it returns `indeterminate`. */ Uncertain sign()const; -/*! +/*! Returns `true` if all numbers contained in the interval are positive, false if all of them are negative or zero and `indeterminate` otherwise. */ Uncertain is_positive()const; -/*! +/*! Returns `true` if all numbers contained in the interval are negative, false if all of them are positive or zero and `indeterminate` otherwise. @@ -309,7 +309,7 @@ Uncertain is_negative()const; }; /* end Gmpfi */ -/*! +/*! Reads `i` from `is`. `is` must have the form `[inf,sup]`, where `inf` and `sup` have valid `Gmpfr` input formats. @@ -317,7 +317,7 @@ Reads `i` from `is`. `is` must have the form */ std::istream& operator>>(std::istream &is,Gmpfi i); -/*! +/*! Writes `i` to `os`, in the form `[i.inf(),i.sup()]`. The endpoints are written according to the `Gmpfr` formatting. \relates Gmpfi diff --git a/Number_types/doc/Number_types/CGAL/Gmpfr.h b/Number_types/doc/Number_types/CGAL/Gmpfr.h index 374d282f55c..e8115a12d51 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpfr.h +++ b/Number_types/doc/Number_types/CGAL/Gmpfr.h @@ -57,7 +57,7 @@ public: /// \name Types /// @{ -/*! +/*! Type representing the precision (number of bits used to represent the mantissa) of a number. */ @@ -85,65 +85,65 @@ typedef unspecified_type Precision_type; /// z. /// @{ -/*! +/*! Creates an uninitialized `Gmpfr` `f`. */ Gmpfr(); -/*! +/*! Copy constructor. The copied object inherits the precision of `n`, and thus it is not rounded. */ Gmpfr(const Gmpfr& n); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `si`. */ Gmpfr(long si); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `ui`. */ Gmpfr(unsigned long ui); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `i`. */ Gmpfr(int i); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `d`. */ Gmpfr(double d); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `ld`. */ Gmpfr(long double ld); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `z`. */ Gmpfr(const Gmpz &z); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `zf`. */ Gmpfr(const Gmpzf &zf); -/*! +/*! Creates a `Gmpfr`, initialized with the value of `ie.first`\f$ \times2^{\mathrm{ie.second}} \f$ . */ Gmpfr(const std::pair &ie); -/*! +/*! This returns the current precision used in `Gmpfr` creation by default. */ static Precision_type get_default_precision(); -/*! +/*! This function sets the default Mpfr precision to p, and returns the old one. */ @@ -163,23 +163,23 @@ also functions to get and set the precision of each Gmpfr object. /// @{ -/*! +/*! Returns the precision of `f`. */ Precision_type get_precision()const; -/*! +/*! Returns the value of `f`, rounded with precision `p` in the direction `r`. */ Gmpfr round(Precision_type p, std::float_round_style r)const; -/*! +/*! This function returns the current rounding mode used by Mpfr. */ static std::float_round_style get_default_rndmode(); -/*! +/*! This function sets the Mpfr rounding mode to `r` and returns the old one. */ @@ -199,33 +199,33 @@ flags are: */ /// @{ -/*! +/*! Clears all the flags set by Mpfr(they are not cleared automatically). */ static void clear_flags(); -/*! +/*! Shows whether an operation incurred in underflow. */ static bool underflow_flag(); -/*! +/*! Shows whether an operation incurred in overflow. */ static bool overflow_flag(); -/*! +/*! Shows whether the result of an operation was `NaN`. */ static bool nan_flag(); -/*! +/*! Shows whether an operation was inexact. */ static bool inex_flag(); -/*! +/*! Returns `true` iff a range error occurred. Such an exception occurs when some function which does not return a `Gmpfr` has an invalid result. For example, this flag will be set if @@ -258,22 +258,22 @@ static bool erange_flag(); */ static Gmpfr add (const Gmpfr &a,const Gmpfr &b); -/*! +/*! */ static Gmpfr add (const Gmpfr &a,const Gmpfr &b, std::float_round_style r); -/*! +/*! */ static Gmpfr add (const Gmpfr &a,const Gmpfr &b,Precision_type p); -/*! +/*! */ static Gmpfr add (const Gmpfr &a,const Gmpfr &b,Precision_type p, std::float_round_style r); -/*! +/*! Returns the absolute value of `f`, rounded with precision `p` in the direction `r`. If `p` is not specified, the precision used is the maximum between `f`'s precision @@ -281,7 +281,7 @@ and the default. */ Gmpfr abs(Precision_type p, std::float_round_style r=get_default_rndmode())const; -/*! +/*! Returns the square root of `f`, rounded with precision `p` in the direction `r`. If `p` is not specified, the precision used is the maximum between `f`'s precision @@ -289,7 +289,7 @@ and the default. */ Gmpfr sqrt(Precision_type p, std::float_round_style r=get_default_rndmode())const; -/*! +/*! Returns the k-th root of `f`, rounded with precision `p` in the direction `r`. If `p` is not specified, the precision used is the maximum between `f`'s precision @@ -297,27 +297,27 @@ and the default. */ Gmpfr kthroot(int k, Precision_type p, std::float_round_style r=get_default_rndmode())const; -/*! +/*! Returns the square of `f`, rounded with precision `p` in the direction `r`. If `p` is not specified, the precision used is the maximum between `f`'s precision and the default. */ Gmpfr square(Precision_type p, std::float_round_style r=get_default_rndmode())const; -/*! +/*! Returns a double precision approximation of `f` using the rounding mode `r`. */ double to_double(std::float_round_style r=get_default_rndmode()); -/*! +/*! Returns an interval of doubles which contains `f`. If a rounded endpoint does not fit in a double, the double is set to plus or minus infinity and the `overflow` or `underflow` flag. */ std::pair to_interval(); -/*! +/*! Returns the pair \f$ (d,e) \f$ such that \f$ 0.5 \le|d| < 1 \f$ and \f$ d \times2^e \f$ equals `f` rounded to double precision, using the rounding mode `r`. If `f` is `NaN` or @@ -327,14 +327,14 @@ the exponent undefined and setting the appropriate error flag. std::pair to_double_exp (std::float_round_style r=get_default_rndmode()); -/*! +/*! Returns \f$ ((m,M),e) \f$ such that \f$ m \times2^e \le f \le M \times2^e \f$. If `f` is `NaN` or infinity, then the corresponding doubles are returned, leaving the exponent undefined and setting the appropriate error flag. */ std::pair,long> to_interval_exp(); -/*! +/*! Returns a pair of integers \f$ (m,e) \f$, such that \f$ f = m \times2^e \f$. Note that the returned value of \f$ m\f$ is not necessarily the smallest possible value of \f$ m\f$ (that is, @@ -347,43 +347,43 @@ std::pair to_integer_exp(); /// \name Query Functions /// @{ -/*! +/*! Returns the sign of `f`. */ Sign sign(); -/*! +/*! Returns `true` iff `f` is zero. */ bool is_zero(); -/*! +/*! Returns `true` iff `f` is one. */ bool is_one(); -/*! +/*! Returns `true` iff `f` is NaN (not-a-number). */ bool is_nan(); -/*! +/*! Returns `true` iff `f` is plus or minus infinity. */ bool is_inf(); -/*! +/*! Returns `true` iff `f` is a valid number. */ bool is_number(); -/*! +/*! Returns `true` iff `f` is the square of a number representable by an object of this type. */ bool is_square(); -/*! +/*! Returns `true` iff `f` is the square of a number representable by an object of this type, computing and storing it in `y`. @@ -395,7 +395,7 @@ bool is_square(const Gmpfr &y); }; /* end Gmpfr */ -/*! +/*! Reads a floating-point number from `in`. The number \f$ M \times2^E\f$ must be in the form \f$ MeE\f$, where the mantissa \f$ M\f$ and the exponent \f$ E\f$ are integers in base 10. @@ -403,7 +403,7 @@ Reads a floating-point number from `in`. The number */ std::istream& operator>>(std::istream& in, Gmpfr& f); -/*! +/*! If the ostream `out` is in pretty-print mode, writes a decimal approximation of `f` to `out`. Otherwise, writes `f` to `out` in the form \f$ MeE\f$, where \f$ M\f$ is its mantissa and diff --git a/Number_types/doc/Number_types/CGAL/Gmpq.h b/Number_types/doc/Number_types/CGAL/Gmpq.h index 990f2001422..9393c5507c6 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpq.h +++ b/Number_types/doc/Number_types/CGAL/Gmpq.h @@ -23,59 +23,59 @@ public: /// \name Creation /// @{ -/*! +/*! creates an uninitialized `Gmpq` `q`. */ Gmpq(); -/*! +/*! creates a `Gmpq` initialized with `i`. */ Gmpq(int i); -/*! +/*! creates a `Gmpq` initialized with `n`. */ Gmpq(Gmpz n); -/*! +/*! creates a `Gmpq` initialized with `f`. */ Gmpq(Gmpfr f); -/*! +/*! creates a `Gmpq` initialized with `n/d`. */ Gmpq(int n, int d); -/*! +/*! creates a `Gmpq` initialized with `n/d`. */ Gmpq(signed long n, unsigned long d); -/*! +/*! creates a `Gmpq` initialized with `n/d`. */ Gmpq(unsigned long n, unsigned long d); -/*! +/*! creates a `Gmpq` initialized with `n/d`. */ Gmpq(Gmpz n, Gmpz d); -/*! +/*! creates a `Gmpq` initialized with `d`. */ Gmpq(double d); -/*! +/*! creates a `Gmpq` initialized with `str`, which can be an integer like "41" or a fraction like "41/152". White space is allowed in the string, and ignored. */ Gmpq(const std::string& str); -/*! +/*! creates a `Gmpq` initialized with `str` in base `base`, which is an integer between 2 and 62. White space in the string is ignored. @@ -94,12 +94,12 @@ Gmpq(const std::string& str, int base); /// other operation between these calls. /// @{ -/*! +/*! returns the numerator of `q`. */ Gmpz numerator() const; -/*! +/*! returns the denominator of `q`. */ Gmpz denominator() const; @@ -108,13 +108,13 @@ Gmpz denominator() const; }; /* end Gmpq */ -/*! +/*! writes `q` to the ostream `out`, in the form `n/d`. \relates Gmpq */ std::ostream& operator<<(std::ostream& out, const Gmpq& q); -/*! +/*! reads a number from `in`, then converts it to a `Gmpq`. The number may be an integer, a rational number in the form `n/d`, or a floating-point number. diff --git a/Number_types/doc/Number_types/CGAL/Gmpz.h b/Number_types/doc/Number_types/CGAL/Gmpz.h index abfa2d0456d..24bfd5bd9bb 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpz.h +++ b/Number_types/doc/Number_types/CGAL/Gmpz.h @@ -22,17 +22,17 @@ public: /// \name Creation /// @{ -/*! +/*! creates an uninitialized multiple precision integer `z`. */ Gmpz(); -/*! +/*! creates a multiple-precision integer initialized with `i`. */ Gmpz(int i); -/*! +/*! creates a multiple-precision integer initialized with the integral part of `d`. */ @@ -43,76 +43,76 @@ Gmpz(double d); /// \name Operations /// @{ -/*! +/*! prefix increment. */ Gmpz & operator++(); -/*! +/*! postfix increment. */ Gmpz operator++(int); -/*! +/*! prefix decrement. */ Gmpz & operator--(); -/*! +/*! postfix decrement. */ Gmpz operator--(int); -/*! +/*! rightshift by `i`, where `i >= 0`. */ Gmpz & operator>>=(const long& i); -/*! +/*! leftshift by `i`, where `i >= 0`. */ Gmpz & operator<<=(const long& i); -/*! +/*! bitwise AND. */ Gmpz & operator&=(const Gmpz& b); -/*! +/*! bitwise IOR. */ Gmpz & operator|=(const Gmpz& b); -/*! +/*! bitwise XOR. */ Gmpz & operator^=(const Gmpz& b); -/*! +/*! Returns the sign of `z`. */ Sign sign() const; -/*! +/*! Returns the bit-size (that is, the number of bits needed to represent the mantissa) of `z`. */ size_t bit_size() const; -/*! +/*! Returns the size in limbs of `z`. A limb is the type used by Gmp to represent the integer (usually `long`). */ size_t size() const; -/*! +/*! Returns the approximate number of decimal digits needed to represent `z`. Approximate means either a correct result, either the correct result plus one. */ size_t approximate_decimal_length() const; -/*! +/*! Returns a double approximation of `z`. The integer is truncated if needed. If the exponent of the conversion is too big, the result is system dependent (returning infinity where it is supported). @@ -123,44 +123,44 @@ double to_double() const; }; /* end Gmpz */ -/*! +/*! rightshift by `i`. \relates Gmpz */ Gmpz operator>>(const Gmpz& a, unsigned long i); -/*! +/*! leftshift by `i`. \relates Gmpz */ Gmpz operator<<(const Gmpz& a, unsigned long i); -/*! +/*! bitwise AND. \relates Gmpz */ Gmpz operator&(const Gmpz& a, const Gmpz& b); -/*! +/*! bitwise IOR. \relates Gmpz */ Gmpz operator|(const Gmpz& a, const Gmpz& b); -/*! +/*! bitwise XOR. \relates Gmpz */ Gmpz operator^(const Gmpz& a, const Gmpz& b); -/*! +/*! writes `z` to the ostream `out`. \relates Gmpz */ std::ostream& operator<<(std::ostream& out, const Gmpz& z); -/*! +/*! reads an integer from `in`, then converts it to a `Gmpz`. \relates Gmpz */ diff --git a/Number_types/doc/Number_types/CGAL/Gmpzf.h b/Number_types/doc/Number_types/CGAL/Gmpzf.h index f363b0b2e63..01bf480e7c7 100644 --- a/Number_types/doc/Number_types/CGAL/Gmpzf.h +++ b/Number_types/doc/Number_types/CGAL/Gmpzf.h @@ -27,32 +27,32 @@ public: /// \name Creation /// @{ -/*! +/*! creates a `Gmpzf` initialized with `0`. */ Gmpzf(); -/*! +/*! creates a `Gmpzf` initialized with `i`. */ Gmpzf(int i); -/*! +/*! creates a `Gmpzf` initialized with `l`. */ Gmpzf(long int l); -/*! +/*! creates a `Gmpzf` initialized with `i`. */ Gmpzf(const Gmpz& i); -/*! +/*! creates a `Gmpzf` initialized with `f`. */ Gmpzf(const Gmpfr& f); -/*! +/*! creates a `Gmpzf` initialized with `d`. */ Gmpzf(double d); @@ -61,19 +61,19 @@ Gmpzf(double d); }; /* end Gmpzf */ -/*! +/*! writes a double approximation of `f` to the ostream `out`. \relates Gmpzf */ std::ostream& operator<<(std::ostream& out, const Gmpzf& f); -/*! +/*! writes an exact representation of `f` to the ostream `out`. \relates Gmpzf */ std::ostream& print (std::ostream& out, const Gmpzf& f); -/*! +/*! reads a `double` from `in`, then converts it to a `Gmpzf`. \relates Gmpzf */ diff --git a/Number_types/doc/Number_types/CGAL/Interval_nt.h b/Number_types/doc/Number_types/CGAL/Interval_nt.h index 00e542133fe..313d5b36e2c 100644 --- a/Number_types/doc/Number_types/CGAL/Interval_nt.h +++ b/Number_types/doc/Number_types/CGAL/Interval_nt.h @@ -118,18 +118,18 @@ public: /// The class `Interval_nt` defines the following types: /// @{ -/*! +/*! The type of the bounds of the interval. */ typedef double value_type; -/*! +/*! The type of the exceptions raised when uncertain comparisons are performed. */ typedef Uncertain_conversion_exception unsafe_comparison; -/*! +/*! A type whose default constructor and destructor allow to protect a block of code from FPU rounding modes necessary for the computations with `Interval_nt`. It does nothing for @@ -142,22 +142,22 @@ typedef unspecified_type Protector; /// \name Creation /// @{ -/*! +/*! introduces a small interval containing \a i (possibly a point). */ Interval_nt(long long i); -/*! +/*! introduces the interval [`d`;`d`]. */ Interval_nt(double d); -/*! +/*! introduces the interval [`i`;`s`]. */ Interval_nt(double i, double s); -/*! +/*! introduces the interval [`p.first`;`p.second`]. */ Interval_nt(std::pair p); @@ -168,34 +168,34 @@ Interval_nt(std::pair p); /// All functions required by a class to be considered as a \cgal number type (see \ref Numbertype) are present, as well as the utility functions, sometimes with a particular semantic which is described below. There are also a few additional functions. /// @{ -/*! +/*! returns [\f$ -\infty\f$;\f$ +\infty\f$] when the denominator contains 0. */ Interval_nt operator/(Interval_nt J); -/*! +/*! returns the lower bound of the interval. */ double inf(); -/*! +/*! returns the upper bound of the interval. */ double sup(); -/*! +/*! returns whether both bounds are equal. */ bool is_point(); -/*! +/*! returns whether both intervals have the same bounds. */ bool is_same(Interval_nt J); -/*! +/*! returns whether both intervals have a non empty intersection. */ @@ -227,7 +227,7 @@ to the rounding modes. /// @{ -/*! +/*! The type used by the following functions to deal with rounding modes. This is usually an `int`. */ @@ -237,7 +237,7 @@ typedef int FPU_CW_t; }; /* end Interval_nt */ -/*! +/*! returns [0;\f$ \sqrt{upper\_bound(I)}\f$] when only the lower bound is negative (expectable case with roundoff errors), and is unspecified when the upper bound also is negative (unexpected case). @@ -245,7 +245,7 @@ negative (unexpected case). */ Interval_nt sqrt(Interval_nt I); -/*! +/*! returns the middle of the interval, as a double approximation of the interval. \relates Interval_nt @@ -258,43 +258,43 @@ The comparison operators (\f$ <\f$, \f$ >\f$, \f$ <=\f$, \f$ >=\f$, \f$ ==\f$, \ /// @{ -/*! +/*! \relates Interval_nt */ Uncertain operator<(Interval_nt i, Interval_nt j); -/*! +/*! \relates Interval_nt */ Uncertain operator>(Interval_nt i, Interval_nt j); -/*! +/*! \relates Interval_nt */ Uncertain operator<=(Interval_nt i, Interval_nt j); -/*! +/*! \relates Interval_nt */ Uncertain operator>=(Interval_nt i, Interval_nt j); -/*! +/*! \relates Interval_nt */ Uncertain operator==(Interval_nt i, Interval_nt j); -/*! +/*! \relates Interval_nt */ Uncertain operator!=(Interval_nt i, Interval_nt j); -/*! +/*! \relates Interval_nt */ Uncertain @@ -302,31 +302,31 @@ compare(Interval_nt i, Interval_nt j); /// @} -/*! +/*! \relates Interval_nt */ Uncertain sign(Interval_nt i); -/*! +/*! sets the rounding mode to `R`. \relates Interval_nt */ void FPU_set_cw (FPU_CW_t R); -/*! +/*! returns the current rounding mode. \relates Interval_nt */ FPU_CW_t FPU_get_cw (void); -/*! +/*! sets the rounding mode to `R` and returns the old one. \relates Interval_nt */ FPU_CW_t FPU_get_and_set_cw (FPU_CW_t R); -/*! +/*! \ingroup nt_cgal This typedef (at namespace \cgal scope) exists for backward compatibility, as well as removing the need to remember the Boolean value for the template 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 ec6748accd3..482cb4b5c8e 100644 --- a/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h +++ b/Number_types/doc/Number_types/CGAL/Lazy_exact_nt.h @@ -42,22 +42,22 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an uninitialized variable `m`. */ Lazy_exact_nt(); -/*! +/*! introduces the value \a x, of any built-in arithmetic type (`int`, `double`, etc) (works only if `NT` has a constructor from this type too). */ Lazy_exact_nt(BuiltIn i); -/*! +/*! introduces the value `n`. */ Lazy_exact_nt(NT n); -/*! +/*! introduces the value `n`. `NT1` needs to be convertible to `NT` (and this conversion will only be done if necessary). */ @@ -68,30 +68,30 @@ template Lazy_exact_nt(Lazy_exact_nt n); /// \name Operations /// @{ -/*! +/*! returns the corresponding NT value. */ NT exact(); -/*! +/*! returns an interval containing the exact value. */ Interval_nt approx(); -/*! +/*! returns an interval containing the exact value. */ Interval_nt interval(); -/*! +/*! specifies the relative precision that `to_double()` has to fulfill. The default value is \f$ 10^{-5}\f$. \pre d>0 and d<1. */ static void set_relative_precision_of_to_double(double d); -/*! +/*! returns the relative precision that `to_double()` currently fulfills. */ static double get_relative_precision_of_to_double(); @@ -100,13 +100,13 @@ static double get_relative_precision_of_to_double(); }; /* end Lazy_exact_nt */ -/*! +/*! writes `m` to ostream `out` in an interval format. \relates Lazy_exact_nt */ std::ostream& operator<<(std::ostream& out, const Lazy_exact_nt& m); -/*! +/*! reads a `NT` from `in`, then converts it to a `Lazy_exact_nt`. \relates Lazy_exact_nt */ diff --git a/Number_types/doc/Number_types/CGAL/MP_Float.h b/Number_types/doc/Number_types/CGAL/MP_Float.h index 5d9617a4d51..4686d7ae967 100644 --- a/Number_types/doc/Number_types/CGAL/MP_Float.h +++ b/Number_types/doc/Number_types/CGAL/MP_Float.h @@ -36,32 +36,32 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an uninitialized variable `m`. */ MP_Float(); -/*! +/*! copy constructor. */ MP_Float(const MP_Float &); -/*! +/*! introduces the integral value i. */ MP_Float(int i); -/*! +/*! introduces the floating point value d (exact conversion). */ MP_Float(float d); -/*! +/*! introduces the floating point value d (exact conversion). */ MP_Float(double d); -/*! +/*! introduces the floating point value d (exact conversion). */ MP_Float(long double d); @@ -70,19 +70,19 @@ MP_Float(long double d); }; /* end MP_Float */ -/*! +/*! writes a double approximation of `m` to the ostream `out`. \relates MP_Float */ std::ostream& operator<<(std::ostream& out, const MP_Float& m); -/*! +/*! reads a `double` from `in`, then converts it to an `MP_Float`. \relates MP_Float */ std::istream& operator>>(std::istream& in, MP_Float& m); -/*! +/*! computes an approximation of the division by converting the operands to `double`, performing the division on `double`, and converting back to `MP_Float`. @@ -90,7 +90,7 @@ computes an approximation of the division by converting the operands to */ MP_Float approximate_division(const MP_Float &a, const MP_Float &b); -/*! +/*! computes an approximation of the square root by converting the operand to `double`, performing the square root on `double`, and converting back to `MP_Float`. diff --git a/Number_types/doc/Number_types/CGAL/NT_converter.h b/Number_types/doc/Number_types/CGAL/NT_converter.h index a638337fd31..5373bfc04d6 100644 --- a/Number_types/doc/Number_types/CGAL/NT_converter.h +++ b/Number_types/doc/Number_types/CGAL/NT_converter.h @@ -14,7 +14,7 @@ public: /// \name Operations ///@{ -/*! +/*! convert `a` from NT1 to NT2. */ NT2 operator()(const NT1 &a) const; 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 b99c3a9f583..0d3060216ab 100644 --- a/Number_types/doc/Number_types/CGAL/Number_type_checker.h +++ b/Number_types/doc/Number_types/CGAL/Number_type_checker.h @@ -34,22 +34,22 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an uninitialized variable `c`. */ Number_type_checker(); -/*! +/*! introduces the integral value i. */ Number_type_checker(int i); -/*! +/*! introduces the floating point value d. */ Number_type_checker(double d); -/*! +/*! introduces a variable storing the pair `n1, n2`. */ Number_type_checker(const NT1 &n1, const NT2 &n2); @@ -59,27 +59,27 @@ Number_type_checker(const NT1 &n1, const NT2 &n2); /// \name Operations /// @{ -/*! +/*! returns a const reference to the object of type `NT1`. */ const NT1 & n1() const; -/*! +/*! returns a const reference to the object of type `NT2`. */ const NT2 & n2() const; -/*! +/*! returns a reference to the object of type `NT1`. */ NT1 & n1(); -/*! +/*! returns a reference to the object of type `NT2`. */ NT2 & n2(); -/*! +/*! calls the `Comparator` binary predicate on the two stored objects and returns its result. */ @@ -89,13 +89,13 @@ bool is_valid() const; }; /* end Number_type_checker */ -/*! +/*! writes `c.n1()` to the ostream `out`. \relates Number_type_checker */ std::ostream& operator<<(std::ostream& out, const Number_type_checker& c); -/*! +/*! reads an `NT1` from `in`, then converts it to an `NT2`, so a conversion from `NT1` to `NT2` is required here. \relates Number_type_checker diff --git a/Number_types/doc/Number_types/CGAL/Quotient.h b/Number_types/doc/Number_types/CGAL/Quotient.h index 06d4bd28a1a..49451ec1c89 100644 --- a/Number_types/doc/Number_types/CGAL/Quotient.h +++ b/Number_types/doc/Number_types/CGAL/Quotient.h @@ -46,23 +46,23 @@ public: /// \name Creation /// @{ -/*! +/*! introduces an uninitialized variable `q`. */ Quotient(); -/*! +/*! introduces the quotient `t/1`. NT needs to have a constructor from T. */ template Quotient(const T& t); -/*! +/*! introduces the quotient `NT(t.numerator())/NT(t.denominator())`. NT needs to have a constructor from T. */ template Quotient(const Quotient& t); -/*! +/*! introduces the quotient `n/d`. \pre \f$ d \neq0\f$. @@ -74,12 +74,12 @@ Quotient(const NT& n, const NT& d); /// \name Operations /// @{ -/*! +/*! returns a numerator of `q`. */ NT numerator() const; -/*! +/*! returns a denominator of `q`. */ NT denominator() const; @@ -88,14 +88,14 @@ NT denominator() const; }; /* end Quotient */ -/*! +/*! writes `q` to ostream `out` in format `n/d`, where `n`\f$ ==\f$`q.numerator()` and `d`\f$ ==\f$`q.denominator()`. \relates Quotient */ std::ostream& operator<<(std::ostream& out, const Quotient& q); -/*! +/*! reads `q` from istream `in`. Expected format is `n/d`, where `n` and `d` are of type `NT`. A single `n` which is not followed by a `/` is also @@ -104,25 +104,25 @@ accepted and interpreted as `n/1`. */ std::istream& operator>>(std::istream& in, Quotient& q); -/*! +/*! returns some double approximation to `q`. \relates Quotient */ double to_double(const Quotient& q); -/*! +/*! returns true, if numerator and denominator are valid. \relates Quotient */ bool is_valid(const Quotient& q); -/*! +/*! returns true, if numerator and denominator are finite. \relates Quotient */ bool is_finite(const Quotient& q); -/*! +/*! returns the square root of `q`. This is supported if and only if `NT` supports the square root as well. \relates Quotient diff --git a/Number_types/doc/Number_types/CGAL/Rational_traits.h b/Number_types/doc/Number_types/CGAL/Rational_traits.h index 04d30434077..52f5dbe7fd5 100644 --- a/Number_types/doc/Number_types/CGAL/Rational_traits.h +++ b/Number_types/doc/Number_types/CGAL/Rational_traits.h @@ -16,7 +16,7 @@ public: /// \name Types /// @{ -/*! +/*! the type of the numerator and denominator. */ typedef unspecified_type RT; @@ -26,32 +26,32 @@ typedef unspecified_type RT; /// \name Operations /// @{ -/*! +/*! returns the numerator of `r`. */ RT numerator (const NT & r) const; -/*! +/*! returns the denominator of `r`. */ RT denominator (const NT & r) const; -/*! +/*! returns self. */ NT make_rational(const NT & x) const; -/*! +/*! constructs a rational number `p.first/p.second`. */ NT make_rational(const std::pair & p) const; -/*! +/*! constructs a rational number. */ NT make_rational(const RT & n, const RT & d) const; -/*! +/*! constructs a rational number. */ NT make_rational(const NT & n, const NT & d) const; diff --git a/Number_types/doc/Number_types/CGAL/Root_of_traits.h b/Number_types/doc/Number_types/CGAL/Root_of_traits.h index 3f4b76233ef..b8603a70dca 100644 --- a/Number_types/doc/Number_types/CGAL/Root_of_traits.h +++ b/Number_types/doc/Number_types/CGAL/Root_of_traits.h @@ -120,12 +120,12 @@ public: /// \name Types /// @{ -/*! +/*! A `RealEmbeddable` `Field` representing the quotient field of `RT`. */ typedef unspecified_type Root_of_1; -/*! +/*! Model of `RootOf_2`. */ typedef unspecified_type Root_of_2; diff --git a/Number_types/doc/Number_types/CGAL/Sqrt_extension.h b/Number_types/doc/Number_types/CGAL/Sqrt_extension.h index 07de523f5c0..03eba56ace2 100644 --- a/Number_types/doc/Number_types/CGAL/Sqrt_extension.h +++ b/Number_types/doc/Number_types/CGAL/Sqrt_extension.h @@ -113,32 +113,32 @@ public: /// \name Creation /// @{ -/*! +/*! Introduces a variable `ext` initialized with 0. */ Sqrt_extension (); -/*! +/*! Copy constructor. */ Sqrt_extension (const Sqrt_extension& x); -/*! +/*! Introduces a variable `ext` initialized with \f$ i\f$. */ Sqrt_extension (const int &i); -/*! +/*! Introduces a variable `ext` initialized with \f$ x\f$. */ Sqrt_extension (const NT &x); -/*! +/*! Constructor from int: `ext`\f$ = a0 +a1 \cdot sqrt(r)\f$. \pre \f$ r \neq0\f$ */ Sqrt_extension (int a0, int a1, int r); -/*! +/*! General constructor: `ext`\f$ = a0 + a1 \cdot sqrt(r)\f$. \pre \f$ r \neq0\f$ */ Sqrt_extension (NT a0, NT a1, ROOT r); @@ -152,29 +152,29 @@ Sqrt_extension (NT a0, NT a1, ROOT r); /// form: \f$ a0 + a1 \sqrt(\mathrm{root}) \f$. /// @{ -/*! +/*! Const access operator for a0 */ const NT & a0 () const ; -/*! +/*! Const access operator for a1 */ const NT & a1 () const ; -/*! +/*! Const access operator for root */ const ROOT & root () const; -/*! +/*! Returns true in case root of `ext` is not zero. Note that \f$ a1 == 0 \f$ does not imply \f$ \mathrm{root} == 0\f$. */ bool is_extended () const; -/*! +/*! Simplifies the representation, in particular \f$\mathrm{root}\f$ is set to zero if \f$ a1\f$ is zero, that is, `ext` becomes not extended. @@ -184,24 +184,24 @@ of `ext`. see also: `AlgebraicStructureTraits::Simplify`. */ void simplify (); -/*! +/*! returns true if `ext` represents the value zero. */ bool is_zero () const; -/*! +/*! Determines the sign of `ext` by (repeated) squaring. \pre `Sqrt_extension` is `RealEmbeddable`. */ CGAL::Sign sign () const; -/*! +/*! returns the absolute value of `ext`. \pre `Sqrt_extension` is `RealEmbeddable`. */ Sqrt_extension abs () const; -/*! +/*! Compares `ext` with y. @@ -212,23 +212,23 @@ and \f$ y\f$ are in the same extension of NT. CGAL::Comparison_result compare (const Sqrt_extension& y, bool in_same_extension = !DifferentExtensionComparable::value) const; -/*! +/*! \pre `(this->root()==0 or a.root()==0 or this->root() == a.root())` */ Sqrt_extension & operator+=(const Sqrt_extension& a); -/*! +/*! \pre `(this->root()==0 or a.root()==0 or this->root() == a.root())` */ Sqrt_extension & operator-=(const Sqrt_extension& a); -/*! +/*! \pre `(this->root()==0 or a.root()==0 or this->root() == a.root())` */ Sqrt_extension & operator*=(const Sqrt_extension& a); -/*! +/*! \pre `(this->root()==0 or a.root()==0 or this->root() == a.root())` In case `NT` is only an `IntegralDomain` operator/ implements integral @@ -241,25 +241,25 @@ Sqrt_extension & operator/=(const Sqrt_extension& a); }; /* end Sqrt_extension */ -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension */ Sqrt_extension operator+(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension */ Sqrt_extension operator-(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension */ Sqrt_extension operator*(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension @@ -269,7 +269,7 @@ division. */ Sqrt_extension operator/(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension */ @@ -277,13 +277,13 @@ bool operator==(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension */ bool operator!=(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension @@ -291,28 +291,28 @@ bool operator!=(const Sqrt_extension&a,const Sqrt_extension& b); */ bool operator< (const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension \attention Only exists when `Sqrt_extension` is `RealEmbeddable`. */ bool operator<=(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension \attention Only exists when `Sqrt_extension` is `RealEmbeddable`. */ bool operator> (const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! \pre `(a.root()==0 or b.root()==0 or a.root() == b.root())` \relates Sqrt_extension \attention Only exists when `Sqrt_extension` is `RealEmbeddable`. */ bool operator>=(const Sqrt_extension&a,const Sqrt_extension& b); -/*! +/*! writes `ext` to ostream `os`. The format depends on the `CGAL::IO::MODE` of `os`. In case the mode is `CGAL::IO::ASCII` the format is `EXT[a0,a1,root]`. @@ -325,7 +325,7 @@ In case the mode is `CGAL::IO::PRETTY` the format is human readable. */ std::ostream& operator<<(std::ostream& os, const Sqrt_extension &ext); -/*! +/*! reads `ext` from istream `is` in format `EXT[a0,a1,root]`, the output format in mode `CGAL::IO::ASCII` \attention `operator<<` must be defined exist for `ROOT` and `NT`. diff --git a/Number_types/doc/Number_types/CGAL/double.h b/Number_types/doc/Number_types/CGAL/double.h index b6ee9fffea0..ee506ccdca2 100644 --- a/Number_types/doc/Number_types/CGAL/double.h +++ b/Number_types/doc/Number_types/CGAL/double.h @@ -13,7 +13,7 @@ not exact. namespace CGAL { -/*! +/*! Determines whether the argument represents a value in \f$ \mathbb{R}\f$. */ bool is_finite(double x); diff --git a/Number_types/doc/Number_types/CGAL/float.h b/Number_types/doc/Number_types/CGAL/float.h index 43992a7c551..7fe3ae2e715 100644 --- a/Number_types/doc/Number_types/CGAL/float.h +++ b/Number_types/doc/Number_types/CGAL/float.h @@ -16,7 +16,7 @@ considered as not exact. namespace CGAL { -/*! +/*! Determines whether the argument represents a value in \f$ \mathbb{R}\f$. */ bool is_finite(float x); diff --git a/Number_types/doc/Number_types/CGAL/long_double.h b/Number_types/doc/Number_types/CGAL/long_double.h index fb7d429200e..89d8d251802 100644 --- a/Number_types/doc/Number_types/CGAL/long_double.h +++ b/Number_types/doc/Number_types/CGAL/long_double.h @@ -11,7 +11,7 @@ considered as not exact. namespace CGAL { -/*! +/*! Determines whether the argument represents a value in \f$ \mathbb{R}\f$. */ bool is_finite(long double x); diff --git a/Number_types/doc/Number_types/CGAL/utils_classes.h b/Number_types/doc/Number_types/CGAL/utils_classes.h index 6e0f76e8b3a..da182fb107a 100644 --- a/Number_types/doc/Number_types/CGAL/utils_classes.h +++ b/Number_types/doc/Number_types/CGAL/utils_classes.h @@ -21,7 +21,7 @@ public: /// \name Operations /// @{ -/*! +/*! returns if the argument is valid. */ bool operator()(const T& x); @@ -53,12 +53,12 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Max(); -/*! +/*! The constructed object will use `c` to compare the arguments. */ Max(Less c); @@ -68,7 +68,7 @@ Max(Less c); /// \name Operations /// @{ -/*! +/*! returns the larger of `x` and `y`, with respect to the order induced by `Less`. */ @@ -101,12 +101,12 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Min(); -/*! +/*! The constructed object will use `c` to compare the arguments. */ Min(Less c); @@ -116,7 +116,7 @@ Min(Less c); /// \name Operations /// @{ -/*! +/*! returns the larger of `x` and `y`, with respect to the order induced by `Less`. */ diff --git a/Number_types/doc/Number_types/Concepts/RootOf_2.h b/Number_types/doc/Number_types/Concepts/RootOf_2.h index 941c76d546c..e7b306f93c8 100644 --- a/Number_types/doc/Number_types/Concepts/RootOf_2.h +++ b/Number_types/doc/Number_types/Concepts/RootOf_2.h @@ -53,22 +53,22 @@ public: /// `RT` and `FT`. /// @{ -/*! +/*! \pre `*this` and `a` are defined in the same extension. */ RootOf_2 & operator+=(const RootOf_2& a); -/*! +/*! \pre `a` and `b` are defined in the same extension. */ RootOf_2 operator+(const RootOf_2&a,const RootOf_2& b); -/*! +/*! */ bool operator==(const RootOf_2&a,const RootOf_2& b); -/*! +/*! */ bool operator< (const RootOf_2&a,const RootOf_2& b); 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 9b716bd7578..0907ad2079c 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 @@ -27,32 +27,32 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolygonIsValid Is_valid; -/*! +/*! */ typedef Traits::Point_2 Point_2; -/*! +/*! */ typedef Traits::Polygon_2 Polygon_2; -/*! +/*! */ typedef Traits::Less_xy_2 Less_xy_2; -/*! +/*! */ typedef Traits::Left_turn_2 Left_turn_2; -/*! +/*! */ typedef Traits::Orientation_2 Orientation_2; @@ -65,7 +65,7 @@ typedef Traits::Orientation_2 Orientation_2; /// following member function is defined: /// @{ -/*! +/*! function returning an instance of `Is_valid` */ Is_valid diff --git a/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h b/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h index 88290a96e0a..9996785a690 100644 --- a/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h +++ b/Partition_2/doc/Partition_2/CGAL/Partition_traits_2.h @@ -31,122 +31,122 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef R::Line_2 Line_2; -/*! +/*! */ typedef R::Segment_2 Segment_2; -/*! +/*! */ typedef R::Ray_2 Ray_2; -/*! +/*! */ typedef R::Less_yx_2 Less_yx_2; -/*! +/*! */ typedef R::Less_xy_2 Less_xy_2; -/*! +/*! */ typedef R::Left_turn_2 Left_turn_2; -/*! +/*! */ typedef R::Orientation_2 Orientation_2; -/*! +/*! */ typedef R::Compare_y_2 Compare_y_2; -/*! +/*! */ typedef R::Compare_x_2 Compare_x_2; -/*! +/*! */ typedef R::Construct_line_2 Construct_line_2; -/*! +/*! */ typedef R::Construct_ray_2 Construct_ray_2; -/*! +/*! */ typedef R::Construct_segment_2 Construct_segment_2; -/*! +/*! */ typedef R::Collinear_are_ordered_along_line_2 Collinear_are_ordered_along_line_2; -/*! +/*! */ typedef R::Are_strictly_ordered_along_line_2 Are_strictly_ordered_along_line_2; -/*! +/*! */ typedef CGAL::Polygon_traits_2 Poly_Traits; -/*! +/*! */ typedef Poly_Traits::Point_2 Point_2; -/*! +/*! */ typedef std::list Container; -/*! +/*! */ typedef CGAL::Polygon_2 Polygon_2; -/*! +/*! */ typedef R::Less_xy_2 Less_xy; -/*! +/*! */ typedef Poly_Traits::Vector_2 Vector_2; -/*! +/*! */ typedef R::FT FT; -/*! +/*! */ typedef Partition_traits_2 Self; -/*! +/*! */ typedef CGAL::Is_convex_2 Is_convex_2; -/*! +/*! */ typedef CGAL::Is_y_monotone_2 Is_y_monotone_2; @@ -157,12 +157,12 @@ typedef CGAL::Is_y_monotone_2 Is_y_monotone_2; /// A default constructor and copy constructor are defined. /// @{ -/*! +/*! */ Partition_traits_2(); -/*! +/*! */ Partition_traits_2(Partition_traits_2& tr); @@ -180,7 +180,7 @@ Partition_traits_2(Partition_traits_2& tr); /// following form defined: /// @{ -/*! +/*! Returns an instance of `Pred_object_type`. diff --git a/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h b/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h index aeeac228e3b..912b0111e77 100644 --- a/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h +++ b/Partition_2/doc/Partition_2/CGAL/polygon_function_objects.h @@ -23,7 +23,7 @@ public: /// \name Creation /// @{ -/*! +/*! `Traits` satisfies the requirements of the function `is_convex_2` */ @@ -34,7 +34,7 @@ Is_convex_2(const Traits& t); /// \name Operations /// @{ -/*! +/*! returns `true` iff the points of type `Traits::Point_2` in the range [`first`,`beyond`) define a convex polygon. @@ -72,7 +72,7 @@ public: /// \name Creation /// @{ -/*! +/*! */ Is_vacuously_valid(const Traits& t); @@ -82,7 +82,7 @@ Is_vacuously_valid(const Traits& t); /// \name Operations /// @{ -/*! +/*! returns `true`. @@ -120,7 +120,7 @@ public: /// \name Creation /// @{ -/*! +/*! `Traits` is a model of the concept `IsYMonotoneTraits_2` */ @@ -131,7 +131,7 @@ Is_y_monotone_2(const Traits& t); /// \name Operations /// @{ -/*! +/*! returns `true` iff the points of type `Traits::Point_2` in the range [`first`,`beyond`) define a \f$ y\f$-monotone polygon. diff --git a/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h index 60cfe3f5ad7..bb4d5a7db39 100644 --- a/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/ConvexPartitionIsValidTraits_2.h @@ -22,7 +22,7 @@ public: /// All types required by the concept `PartitionIsValidTraits_2` are /// required except the function object type `Is_valid`. The following /// type is required instead: @{ -/*! +/*! Model of the concept `PolygonIsValid` that tests if a sequence of points is convex or not. */ @@ -34,7 +34,7 @@ typedef unspecified_type Is_convex_2; /// Only a copy constructor is required. /// @{ -/*! +/*! */ ConvexPartitionIsValidTraits_2(ConvexPartitionIsValidTraits_2 tr); @@ -47,7 +47,7 @@ ConvexPartitionIsValidTraits_2(ConvexPartitionIsValidTraits_2 tr); /// `is_valid_object` required by `PartitionIsValidTraits_2`. /// @{ -/*! +/*! */ Is_convex_2 is_convex_2_object(ConvexPartitionIsValidTraits_2 tr); diff --git a/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h b/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h index a47fd1cc2a1..a64126fc1c9 100644 --- a/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/IsYMonotoneTraits_2.h @@ -22,12 +22,12 @@ public: /// The following two types are required: /// @{ -/*! +/*! The point type of the polygon vertices. */ typedef unspecified_type Point_2; -/*! +/*! Predicate object type that compares `Point_2`s lexicographically. Must provide `bool operator()(Point_2 p, Point_2 q)` where `true` @@ -44,7 +44,7 @@ typedef unspecified_type Less_yx_2; /// Only a copy constructor is required. /// @{ -/*! +/*! */ IsYMonotoneTraits_2(IsYMonotoneTraits_2 tr); @@ -55,7 +55,7 @@ IsYMonotoneTraits_2(IsYMonotoneTraits_2 tr); /// The following function that creates an instance of the above predicate object type must exist: /// @{ -/*! +/*! */ Less_yx_2 less_yx_2_object(); diff --git a/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h index a7f4776cecd..d2ac845d7d4 100644 --- a/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/OptimalConvexPartitionTraits_2.h @@ -23,36 +23,36 @@ public: /// `PartitionTraits_2`, the following types are required: /// @{ -/*! +/*! A segment type */ typedef unspecified_type Segment_2; -/*! +/*! A ray type */ typedef unspecified_type Ray_2; -/*! +/*! A general object type that can be either a point or a segment */ typedef unspecified_type Object_2; -/*! +/*! Function object type that provides `Segment_2 operator()(Point_2 p, Point_2 q)`, which constructs and returns the segment defined by the points \f$ p\f$ and \f$ q\f$. */ typedef unspecified_type Construct_segment_2; -/*! +/*! Function object type that provides `Ray_2 operator()(Point_2 p, Point_2 q)`, which constructs and returns the ray from point \f$ p\f$ through point \f$ q\f$. */ typedef unspecified_type Construct_ray_2; -/*! +/*! Predicate object type that determines orderings of `Point_2`s on a line. Must provide `bool operator()(Point_2 p, Point_2 q, Point_2 r)` that @@ -62,7 +62,7 @@ that they are collinear. */ typedef unspecified_type Collinear_are_ordered_along_line_2; -/*! +/*! Predicate object type that determines orderings of `Point_2`s. Must provide `bool operator()(Point_2 p, Point_2 q, Point_2 r)` that @@ -73,7 +73,7 @@ and `r`. Note that `false` should be returned if */ typedef unspecified_type Are_stritcly_ordered_along_line_2; -/*! +/*! Function object type that provides `Object_2 operator()(Segment_2 s1, Segment_2 s2)` that returns the intersection of two segments (which may be either a segment or @@ -81,7 +81,7 @@ a point). */ typedef unspecified_type Intersect_2; -/*! +/*! Function object type that provides `bool operator()(Segment_2 s1, Object_2 o)` that returns `true` if `o` is a segment and assigns the value of `o` @@ -95,7 +95,7 @@ typedef unspecified_type Assign_2; /// Only a copy constructor is required. /// @{ -/*! +/*! */ OptimalConvexPartitionTraits_2(OptimalConvexPartitionTraits_2 tr); @@ -108,22 +108,22 @@ OptimalConvexPartitionTraits_2(OptimalConvexPartitionTraits_2 tr); /// object types must exist: /// @{ -/*! +/*! */ Collinear_are_ordered_along_line_2 collinear_are_ordered_along_line_2_object() const; -/*! +/*! */ Construct_segment_2 construct_segment_2_object() const; -/*! +/*! */ Construct_ray_2 construct_ray_2_object() const; -/*! +/*! */ Are_strictly_ordered_along_line_2 diff --git a/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h index 3f35d13c158..1215058a5f1 100644 --- a/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/PartitionIsValidTraits_2.h @@ -29,24 +29,24 @@ public: /// \name Types /// @{ -/*! +/*! The point type on which the partitioning algorithm operates. */ typedef unspecified_type Point_2; -/*! +/*! The polygon type created by the partitioning function. This type should provide a nested type `Vertex_const_iterator` that is the type of the non-mutable iterator over the polygon vertices. */ typedef unspecified_type Polygon_2; -/*! +/*! A model of the concept `PolygonIsValid` */ typedef unspecified_type Is_valid; -/*! +/*! Predicate object type that compares `Point_2`s lexicographically. Must provide `bool operator()(Point_2 p, Point_2 q)` where `true` @@ -58,7 +58,7 @@ respectively. */ typedef unspecified_type Less_xy_2; -/*! +/*! Predicate object type that provides `bool operator()(Point_2 p,Point_2 q,Point_2 r)`, which @@ -67,7 +67,7 @@ oriented line through `p` and `q`. */ typedef unspecified_type Left_turn_2; -/*! +/*! Predicate object type that provides `CGAL::Orientation operator()(Point_2 p, Point_2 q, Point_2 r)` that returns `CGAL::LEFT_TURN`, if \f$ r\f$ lies to the left of the oriented @@ -83,7 +83,7 @@ typedef unspecified_type Orientation_2; /// Only a copy constructor is required. /// @{ -/*! +/*! */ PartitionIsValidTraits_2(PartitionIsValidTraits_2 tr); @@ -94,22 +94,22 @@ PartitionIsValidTraits_2(PartitionIsValidTraits_2 tr); /// The following functions that create instances of the above predicate object types must exist. /// @{ -/*! +/*! */ Orientation_2 is_valid_object(); -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Left_turn_2 left_turn_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); diff --git a/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h index b26e8431791..d29dc848bf0 100644 --- a/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/PartitionTraits_2.h @@ -23,12 +23,12 @@ public: /// \name Types /// @{ -/*! +/*! The point type on which the partitioning algorithm operates. */ typedef unspecified_type Point_2; -/*! +/*! The polygon type to be created by the partitioning algorithm. For testing the validity postcondition of the partition, this type should provide a nested type `Vertex_const_iterator` that is the @@ -38,7 +38,7 @@ type of the iterator over the polygon vertices and member functions */ typedef unspecified_type Polygon_2; -/*! +/*! Predicate object type that compares `Point_2`s lexicographically. Must provide `bool operator()(Point_2 p, Point_2 q)` where `true` @@ -50,13 +50,13 @@ respectively. */ typedef unspecified_type Less_xy_2; -/*! +/*! Same as `Less_xy_2` with the roles of \f$ x\f$ and \f$ y\f$ interchanged. */ typedef unspecified_type Less_yx_2; -/*! +/*! Predicate object type that provides `bool operator()(Point_2 p,Point_2 q,Point_2 r)`, which @@ -65,7 +65,7 @@ oriented line through `p` and `q`. */ typedef unspecified_type Left_turn_2; -/*! +/*! Predicate object type that provides `CGAL::Orientation operator()(Point_2 p, Point_2 q, Point_2 r)` that returns `CGAL::LEFT_TURN`, if \f$ r\f$ lies to the left of the oriented @@ -75,7 +75,7 @@ on \f$ l\f$. */ typedef unspecified_type Orientation_2; -/*! +/*! Predicate object type that provides `CGAL::Comparision_result operator()(Point_2 p, Point_2 q)` to compare the \f$ y\f$ values of two points. The operator must return @@ -84,7 +84,7 @@ the \f$ y\f$ values of two points. The operator must return */ typedef unspecified_type Compare_y_2; -/*! +/*! The same as `Compare_y_2`, except that \f$ x\f$ coordinates are compared instead of \f$ y\f$. */ @@ -96,12 +96,12 @@ typedef unspecified_type Compare_x_2; /// A copy constructor and default constructor are required. /// @{ -/*! +/*! */ PartitionTraits_2(); -/*! +/*! */ PartitionTraits_2(PartitionTraits_2 tr); @@ -112,32 +112,32 @@ PartitionTraits_2(PartitionTraits_2 tr); /// The following functions that create instances of the above predicate object types must exist. /// @{ -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Left_turn_2 left_turn_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); -/*! +/*! */ Compare_y_2 compare_y_2_object(); -/*! +/*! */ Compare_x_2 compare_x_2_object(); diff --git a/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h b/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h index cf55328742c..daef60f6fe1 100644 --- a/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h +++ b/Partition_2/doc/Partition_2/Concepts/PolygonIsValid.h @@ -25,7 +25,7 @@ public: /// \name Creation /// @{ -/*! +/*! `Traits` is a model of the concept required by the function that checks for validity of the polygon. @@ -38,7 +38,7 @@ PolygonIsValid(const Traits tr); /// \name Operations /// @{ -/*! +/*! returns `true` iff the points of type `Traits::Point_2` in the range [`first`,`beyond`) define a valid polygon. diff --git a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h index c340e930bab..bd81dee898f 100644 --- a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionIsValidTraits_2.h @@ -22,7 +22,7 @@ public: /// type is required instead: /// @{ -/*! +/*! Model of the concept `PolygonIsValid` that tests if a sequence of points is \f$ y\f$-monotone or not. */ @@ -34,7 +34,7 @@ typedef unspecified_type Is_y_monotone_2; /// Only a copy constructor is required. /// @{ -/*! +/*! */ YMonotonePartitionIsValidTraits_2(YMonotonePartitionIsValidTraits_2 tr ); @@ -47,7 +47,7 @@ YMonotonePartitionIsValidTraits_2(YMonotonePartitionIsValidTraits_2 tr ); /// `is_valid_object` required by `PartitionIsValidTraits_2`. /// @{ -/*! +/*! */ Is_y_monotone_2 is_y_monotone_2_object(YMonotonePartitionIsValidTraits_2 tr); diff --git a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h index f4f25ad2cab..f4335c80758 100644 --- a/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h +++ b/Partition_2/doc/Partition_2/Concepts/YMonotonePartitionTraits_2.h @@ -18,12 +18,12 @@ public: /// In addition to the types defined for the concept `PartitionTraits_2`, the following types are also required: /// @{ -/*! +/*! */ typedef unspecified_type Line_2; -/*! +/*! Predicate object type that provides `CGAL::Comparision_result operator()(Point_2 p, Line_2 h)` to compare the \f$ x\f$ coordinate of `p` and the horizontal projection of `p` @@ -31,14 +31,14 @@ on `h`. */ typedef unspecified_type Compare_x_at_y_2; -/*! +/*! Function object type that provides `Line_2 operator()(Point_2 p, Point_2 q)`, which constructs and returns the line defined by the points \f$ p\f$ and \f$ q\f$. */ typedef unspecified_type Construct_line_2; -/*! +/*! Function object type that provides `bool operator()(Line_2 l)`, which returns `true` iff the line `l` is horizontal. @@ -51,12 +51,12 @@ typedef unspecified_type Is_horizontal_2; /// A copy constructor and default constructor are required. /// @{ -/*! +/*! */ YMonotonePartitionTraits(); -/*! +/*! */ YMonotonePartitionTraits(const YMonotonePartitionTraits tr); @@ -69,17 +69,17 @@ YMonotonePartitionTraits(const YMonotonePartitionTraits tr); /// of the above function object types must exist. /// @{ -/*! +/*! */ Construct_line_2 construct_line_2_object(); -/*! +/*! */ Compare_x_at_y_2 compare_x_at_y_2_object(); -/*! +/*! */ Is_horizontal_2 is_horizontal_2_object(); diff --git a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_triangulation_2.h b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_triangulation_2.h index cff4a1c38db..d85f5c6ceae 100644 --- a/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_triangulation_2.h +++ b/Periodic_2_triangulation_2/doc/Periodic_2_triangulation_2/CGAL/Periodic_2_triangulation_2.h @@ -143,7 +143,7 @@ public: */ typedef Geom_traits::Iso_rectangle_2 Iso_rectangle; - /*! + /*! integer tuple to store the number of sheets in each direction of space. */ typedef array Covering_sheets; @@ -435,7 +435,7 @@ public: /// \cgalAdvancedEnd /// @{ - /*! + /*! \cgalAdvancedBegin Returns a reference to the triangulation data structure. \cgalAdvancedEnd diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_Delaunay_triangulation_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_Delaunay_triangulation_3.h index 26206bc6ed3..7a5790f90af 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_Delaunay_triangulation_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_Delaunay_triangulation_3.h @@ -30,7 +30,7 @@ public: /// \name Creation /// @{ -/*! +/*! Creates an empty periodic Delaunay triangulation `dt`, with `domain` as original domain and possibly specifying a traits class `traits`. @@ -40,13 +40,13 @@ Periodic_3_Delaunay_triangulation_3( const Iso_cuboid & domain = Iso_cuboid(0,0,0,1,1,1), const Geom_traits & traits = Geom_traits()); -/*! +/*! Copy constructor. */ Periodic_3_Delaunay_triangulation_3 (const Periodic_3_Delaunay_triangulation_3 & dt1); -/*! +/*! Equivalent to constructing an empty triangulation with the optional domain and traits class arguments and calling `insert(first,last)`. \pre The `value_type` of `first` and `last` are `Point`s lying inside `domain` and `domain` is a cube. @@ -78,7 +78,7 @@ and `Cell_handle`s. /// @{ -/*! +/*! Inserts point `p` in the triangulation and returns the corresponding vertex. The optional argument `start` is used as a starting place for the point location. @@ -87,7 +87,7 @@ for the point location. Vertex_handle insert(const Point & p, Cell_handle start = Cell_handle() ); -/*! +/*! Inserts point `p` in the triangulation and returns the corresponding vertex. Similar to the above `insert()` function, but takes as additional parameter the return values of a previous location query. See description of @@ -106,7 +106,7 @@ The following method allows one to insert several points. It returns the number /// @{ -/*! +/*! Inserts the points in the iterator range \f$ \left[\right.\f$`first`, `last`\f$ \left.\right)\f$. Returns the number of inserted points. This function uses spatial sorting (cf. chapter \ref secspatial_sorting) @@ -126,7 +126,7 @@ bool is_large_point_set = false); /// \name Point moving /// @{ -/*! +/*! Moves the point stored in `v` to `p`, while preserving the Delaunay property. This performs an action semantically equivalent to `remove(v)` followed by `insert(p)`, but is supposedly faster when the point has @@ -154,13 +154,13 @@ proposes a vertex removal. */ /// @{ -/*! +/*! Removes the vertex `v` from the triangulation. When computing in the 27-sheeted covering space it removes all 27 copies of `v`. */ void remove(Vertex_handle v); -/*! +/*! Removes the vertices specified by the iterator range (`first, beyond`) of value type `Vertex_handle`. `remove()` is called for each element of the range. The number of vertices removed is returned; this number does not @@ -177,7 +177,7 @@ std::ptrdiff_t remove(InputIterator first, InputIterator beyond); /// @{ -/*! +/*! Returns a value indicating on which side of the circumscribed sphere of `c` the point-offset pair (`p`,`off`) lies. More precisely, it returns: @@ -194,7 +194,7 @@ Bounded_side side_of_sphere(Cell_handle c, const Point & p, const Offset & off = Offset(0,0,0)) const; -/*! +/*! Returns any nearest vertex to the point `p`, or the default constructed handle if the triangulation is empty. The optional argument `c` is a hint specifying where to start the search. It always returns a vertex @@ -206,7 +206,7 @@ multiply sheeted covering space. Vertex_handle nearest_vertex(Point p, Cell_handle c = Cell_handle()); -/*! +/*! Returns the vertex of the cell `c` that is nearest to the point-offset pair (`p`,`off`). \pre `p` lies in the original domain `domain`. @@ -224,7 +224,7 @@ A point-offset pair (`p`,`off`) is said to be in conflict with a cell `c` iff `d -/*! +/*! Computes the conflict hole induced by `p`. The starting cell `c` must be in conflict. Then this function returns respectively in the output iterators: @@ -252,7 +252,7 @@ OutputIteratorBoundaryFacets bfit, OutputIteratorCells cit, OutputIteratorInternalFacets ifit); -/*! +/*! Similar to `find_conflicts()`, but reports the vertices which are on the boundary of the conflict hole of `p`, in the output iterator `res`. Returns the resulting output iterator. @@ -278,22 +278,22 @@ the Gabriel property of Delaunay faces. /// @{ -/*! +/*! */ bool is_Gabriel(Cell_handle c, int i); -/*! +/*! */ bool is_Gabriel(Cell_handle c, int i, int j); -/*! +/*! */ bool is_Gabriel(const Facet& f); -/*! +/*! */ bool is_Gabriel(const Edge& e); @@ -308,24 +308,24 @@ bool is_Gabriel(const Edge& e); /// only, which requires only exact predicates). /// @{ -/*! +/*! Returns the representative of the circumcenter of the four vertices of c that lies in the original domain `domain`. */ Point dual(Cell_handle c) const; -/*! +/*! Returns the dual of facet `f`, which is a periodic segment. */ Periodic_segment dual(Facet f) const; -/*! +/*! same as the previous method for facet `(c,i)`. \pre \f$ i\in\{0,1,2,3\}\f$ */ Periodic_segment dual(Cell_handle c, int i) const; -/*! +/*! Returns in the output iterator the points of the dual polygon of edge `e` in the same order as the `Facet_circulator` returns facets incident to the edge `e`. The points form the dual polygon @@ -336,7 +336,7 @@ template OutputIterator dual(Edge e, OutputIterator pts) const; -/*! +/*! same as the previous method for edge `(c,i,j)`. \pre \f$ i,j\in\{0,1,2,3\}, i\neq j\f$ */ @@ -344,7 +344,7 @@ template OutputIterator dual(Cell_handle c, int i, int j, OutputIterator pts) const; -/*! +/*! Returns in the output iterator the points of the dual polyhedron of vertex `v` in no particular order. The points form the dual polyhedron in \f$ \mathbb R^3\f$, so they do not necessarily lie all @@ -354,17 +354,17 @@ template OutputIterator dual(Vertex_handle v, OutputIterator pts) const; -/*! +/*! Sends the set of duals to all the facets of `dt` into `os`. */ template Stream & draw_dual(Stream & os); -/*! +/*! Returns the volume of the Voronoi cell dual to `v`. */ Geom_traits::FT dual_volume(Vertex_handle v) const; -/*! +/*! Returns the centroid of the Voronoi cell dual to `v`. */ Point dual_centroid(Vertex_handle v) const; @@ -375,7 +375,7 @@ Point dual_centroid(Vertex_handle v) const; /// These methods are mainly a debugging help for the users of advanced features. /// @{ -/*! +/*! Checks the combinatorial validity of the triangulation and the validity of its geometric embedding (see Section \ref P3Triangulation3secintro). Also checks that all the @@ -387,7 +387,7 @@ invalidity encountered are printed. bool is_valid(bool verbose = false) const; -/*! +/*! Checks the combinatorial and geometric validity of the cell (see Section \ref P3Triangulation3secintro). Also checks that the circumscribing sphere of cells is empty. diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h index f32137269ad..43ebe9e5fa4 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/CGAL/Periodic_3_triangulation_3.h @@ -25,73 +25,73 @@ public: /// @{ -/*! +/*! */ typedef PT Geometric_traits; -/*! +/*! */ typedef TDS Triangulation_data_structure; -/*! +/*! */ typedef Geometric_traits::Periodic_3_offset_3 Offset; -/*! +/*! A type representing an axis-aligned cuboid. It must be a model of `PT::Iso_cuboid_3`. Used to represent the original domain. */ typedef Geometric_traits::Iso_cuboid_3 Iso_cuboid; -/*! +/*! Integer triple to store the number of sheets in each direction of space. */ typedef array Covering_sheets; -/*! +/*! */ typedef Geometric_traits::Point_3 Point; -/*! +/*! */ typedef Geometric_traits::Segment_3 Segment; -/*! +/*! */ typedef Geometric_traits::Triangle_3 Triangle; -/*! +/*! */ typedef Geometric_traits::Tetrahedron_3 Tetrahedron; -/*! +/*! Represents a point-offset pair. The point in the pair lies in the original domain. */ typedef std::pair< Point, Offset > Periodic_point; -/*! +/*! */ typedef array< Periodic_point, 2> Periodic_segment; -/*! +/*! */ typedef array< Periodic_point, 3> Periodic_triangle; -/*! +/*! */ typedef array< Periodic_point, 4> @@ -106,22 +106,22 @@ Only vertices (\f$ 0\f$-faces) and cells (\f$ 3\f$-faces) are stored. Edges (\f$ /// @{ -/*! +/*! */ typedef Triangulation_data_structure::Vertex Vertex; -/*! +/*! */ typedef Triangulation_data_structure::Cell Cell; -/*! +/*! */ typedef Triangulation_data_structure::Edge Edge; -/*! +/*! */ typedef Triangulation_data_structure::Facet Facet; @@ -147,47 +147,47 @@ functions. */ /// @{ -/*! +/*! handle to a vertex */ typedef Triangulation_data_structure::Vertex_handle Vertex_handle; -/*! +/*! handle to a cell */ typedef Triangulation_data_structure::Cell_handle Cell_handle; -/*! +/*! Size type (an unsigned integral type) */ typedef Triangulation_data_structure::size_type size_type; -/*! +/*! Difference type (a signed integral type) */ typedef Triangulation_data_structure::difference_type difference_type; -/*! +/*! iterator over cells */ typedef Triangulation_data_structure::Cell_iterator Cell_iterator; -/*! +/*! iterator over facets */ typedef Triangulation_data_structure::Facet_iterator Facet_iterator; -/*! +/*! iterator over edges */ typedef Triangulation_data_structure::Edge_iterator Edge_iterator; -/*! +/*! iterator over vertices */ typedef Triangulation_data_structure::Vertex_iterator Vertex_iterator; -/*! +/*! iterator over the vertices whose corresponding points lie in the original domain, i.e.\ for each set of periodic copies the `Unique_vertex_iterator` iterates over @@ -195,12 +195,12 @@ exactly one representative. */ typedef unspecified_type Unique_vertex_iterator; -/*! +/*! circulator over all cells incident to a given edge */ typedef Triangulation_data_structure::Cell_circulator Cell_circulator; -/*! +/*! circulator over all facets incident to a given edge */ typedef Triangulation_data_structure::Facet_circulator Facet_circulator; @@ -210,25 +210,25 @@ typedef Triangulation_data_structure::Facet_circulator Facet_circulator; /// \name Geometric Iterators: /// @{ -/*! +/*! iterator over the tetrahedra corresponding to cells of the triangulation. */ typedef unspecified_type Periodic_tetrahedron_iterator; -/*! +/*! iterator over the triangles corresponding to facets of the triangulation. */ typedef unspecified_type Periodic_triangle_iterator; -/*! +/*! iterator over the segments corresponding to edges of the triangulation. */ typedef unspecified_type Periodic_segment_iterator; -/*! +/*! iterator over the points corresponding to vertices of the triangulation. */ @@ -283,7 +283,7 @@ The elements of the enum have the following meaning: /// \name Creation /// @{ -/*! +/*! Introduces an empty triangulation `t` with `domain` as original domain. \pre `domain` is a cube. @@ -292,7 +292,7 @@ Periodic_3_triangulation_3 (const Iso_cuboid & domain = Iso_cuboid(0,0,0,1,1,1), const Geometric_traits & traits = Geometric_traits()); -/*! +/*! Copy constructor. All vertices and faces are duplicated. */ Periodic_3_triangulation_3 (const Periodic_3_triangulation_3 & tr); @@ -302,14 +302,14 @@ Periodic_3_triangulation_3 (const Periodic_3_triangulation_3 & tr); /// \name Assignment /// @{ -/*! +/*! The triangulation `tr` is duplicated, and modifying the copy after the duplication does not modify the original. The previous triangulation held by `t` is deleted. */ Periodic_3_triangulation_3 & operator=(const Periodic_3_triangulation_3 & tr); -/*! +/*! The triangulations `tr` and `t` are swapped. `t`.`swap(tr)` should be preferred to `t` = `tr` or to `t(tr)` if `tr` is deleted after that. Indeed, there is no @@ -317,12 +317,12 @@ copy of cells and vertices, thus this method runs in constant time. */ void swap(Periodic_3_triangulation_3 & tr); -/*! +/*! Deletes all vertices and all cells of `t`. */ void clear(); -/*! +/*! Equality operator. Returns true iff there exist a bijection between the vertices of `t1` and those of `t2` and a bijection between the cells of `t1` and those of `t2`, which preserve the geometry of the @@ -334,7 +334,7 @@ a permutation of their vertices). template < class PT, class TDS1, class TDS2 > bool operator==(const Periodic_3_triangulation_3 & t1, const Periodic_3_triangulation_3 & t2); -/*! +/*! The opposite of `operator==`. \relates Periodic_3_triangulation_3 */ @@ -346,22 +346,22 @@ bool operator!=(const Periodic_3_triangulation_3 & t1, const Periodic_ /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the geometric traits object. */ const Geometric_traits & geom_traits() const; -/*! +/*! Returns a const reference to the triangulation data structure. */ const Triangulation_data_structure & tds() const; -/*! +/*! Returns the original domain. */ Iso_cuboid domain() const; -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Returns the number of sheets of the covering space the triangulation is @@ -375,7 +375,7 @@ Covering_sheets number_of_sheets() const; /// \name Non const access /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Changes the domain. Note that this function calls `clear()`, @@ -384,7 +384,7 @@ i.e., it erases the existing triangulation. */ void set_domain(const Iso_cuboid dom); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Returns a reference to the triangulation data structure. @@ -402,7 +402,7 @@ Triangulation_data_structure & tds(); /// \name Non-constant-time queries and conversions /// @{ -/*! +/*! The current triangulation remains a triangulation in the 1-sheeted covering space even after adding points if this method returns `true`. This test relies on a heuristic, i.e.\ if it answers @@ -413,7 +413,7 @@ criterion \cite cgal:ct-c3pt-09.) */ bool is_extensible_triangulation_in_1_sheet_h1() const; -/*! +/*! The same as `is_extensible_triangulation_in_1_sheet_h1()` but with a more precise heuristic, i.e.\ it might answer `true` in cases in which `is_extensible_triangulation_in_1_sheet_h1()` would not. However, it is @@ -423,13 +423,13 @@ input point set as a criterion \cite cgal:ct-c3pt-09.) */ bool is_extensible_triangulation_in_1_sheet_h2() const; -/*! +/*! Returns `true` if the current triangulation would still be a triangulation in the 1-sheeted covering space, returns `false` otherwise. */ bool is_triangulation_in_1_sheet() const; -/*! +/*! Converts the current triangulation into the same periodic triangulation in the 1-sheeted covering space. @@ -440,7 +440,7 @@ triangulation later. */ void convert_to_1_sheeted_covering() const; -/*! +/*! Converts the current triangulation into the same periodic triangulation in the 27-sheeted covering space. @@ -451,26 +451,26 @@ triangulation later. */ void convert_to_27_sheeted_covering() const; -/*! +/*! Returns the number of vertices. Counts all vertices that are representatives of the same point in \f$ \mathbb T_c^3\f$ as one vertex. */ size_type number_of_vertices() const; -/*! +/*! Returns the number of cells. Counts all cells that are representatives of the same tetrahedron in \f$ \mathbb T_c^3\f$ as one cell. */ size_type number_of_cells() const; -/*! +/*! Returns the number of vertices in the data structure. This is the same as the number of sheets times `number_of_vertices()`. */ size_type number_of_stored_vertices() const; -/*! +/*! Returns the number of cells in the data structure. This is the same as the number of sheets times `number_of_cells()`. */ @@ -481,26 +481,26 @@ size_type number_of_stored_cells() const; /// \name Non-constant-time access functions /// @{ -/*! +/*! Returns the number of edges. Counts all edges that are representatives of the same segment in \f$ \mathbb T_c^3\f$ as one edge. */ size_type number_of_edges() const; -/*! +/*! Returns the number of facets. Counts all facets that are representatives of the same triangle in \f$ \mathbb T_c^3\f$ as one facet. */ size_type number_of_facets() const; -/*! +/*! Returns the number of edges in the data structure. This is the same as the number of sheets times `number_of_edges()`. */ size_type number_of_stored_edges() const; -/*! +/*! Returns the number of facets in the data structure. This is the same as the number of sheets times `number_of_facets()`. */ @@ -511,7 +511,7 @@ size_type number_of_stored_facets() const; /// \name Geometric Access Functions /// @{ -/*! +/*! Returns the periodic point given by vertex `v`. If `t` is represented in the 1-sheeted covering space, the offset is always zero. Otherwise `v` can correspond to a periodic copy outside @@ -519,7 +519,7 @@ zero. Otherwise `v` can correspond to a periodic copy outside */ Periodic_point periodic_point(const Vertex_handle v) const; -/*! +/*! If `t` is represented in the 1-sheeted covering space, this function returns the periodic point given by the \f$ i\f$-th vertex of cell `c`, that is the point in the original domain and the offset of @@ -531,7 +531,7 @@ this offset is possibly added to another offset determining the periodic copy. Periodic_point periodic_point(const Cell_handle c, int i) const; -/*! +/*! Returns the periodic segment formed by the two point-offset pairs corresponding to the two vertices of edge `(c,i,j)`. \pre \f$ i,j \in\{0,1,2,3\}\f$, \f$ i\neq j\f$ @@ -539,12 +539,12 @@ corresponding to the two vertices of edge `(c,i,j)`. Periodic_segment periodic_segment(const Cell_handle c, int i, int j) const; -/*! +/*! Same as the previous method for edge `e`. */ Periodic_segment periodic_segment(const Edge & e) const; -/*! +/*! Returns the periodic triangle formed by the three point-offset pairs corresponding to the three vertices of facet `(c,i)`. The triangle is oriented so that its normal points to the @@ -554,12 +554,12 @@ inside of cell `c`. Periodic_triangle periodic_triangle(const Cell_handle c, int i) const; -/*! +/*! Same as the previous method for facet `f`. */ Periodic_triangle periodic_triangle(const Facet & f) const; -/*! +/*! Returns the periodic tetrahedron formed by the four point-offset pairs corresponding to the four vertices of `c`. */ @@ -573,23 +573,23 @@ Periodic_tetrahedron periodic_tetrahedron(const Cell_handle c) const; /// only exact predicates). /// @{ -/*! +/*! Converts the `Periodic_point` `s` (point-offset pair) to the corresponding `Point` in \f$ \mathbb R^3\f$. */ Point point(const Periodic_point & p ) const; -/*! +/*! Converts the `Periodic_segment` `s` to a `Segment`. */ Segment segment(const Periodic_segment & s) const; -/*! +/*! Converts the `Periodic_triangle` `t` to a `Triangle`. */ Triangle triangle(const Periodic_triangle & t) const; -/*! +/*! Converts the `Periodic_tetrahedron` `t` to a `Tetrahedron`. */ Tetrahedron tetrahedron(const Periodic_tetrahedron & t) @@ -600,19 +600,19 @@ const; /// \name Queries /// @{ -/*! +/*! Tests whether `p` is a vertex of `t` by locating `p` in the triangulation. If `p` is found, the associated vertex `v` is given. */ bool is_vertex(const Point & p, Vertex_handle & v) const; -/*! +/*! Tests whether `v` is a vertex of `t`. */ bool is_vertex(Vertex_handle v) const; -/*! +/*! Tests whether `(u,v)` is an edge of `t`. If the edge is found, it gives a cell `c` having this edge and the indices `i` and `j` of the vertices `u` and `v` in `c`, in this order. @@ -621,7 +621,7 @@ and `j` of the vertices `u` and `v` in `c`, in this order. bool is_edge(Vertex_handle u, Vertex_handle v, Cell_handle & c, int & i, int & j) const; -/*! +/*! Tests whether `((u,offu),(v,offu))` is an edge of `t`. If the edge is found, it gives a cell `c` having this edge and the indices `i` and `j` of the vertices `u` and @@ -632,7 +632,7 @@ bool is_edge(Vertex_handle u, const Offset & offu, Vertex_handle v, const Offset & offv, Cell_handle & c, int & i, int & j) const; -/*! +/*! Tests whether `(u,v,w)` is a facet of `t`. If the facet is found, it computes a cell `c` having this facet and the indices `i`, `j` and `k` of the vertices `u`, `v` and `w` in `c`, @@ -642,7 +642,7 @@ in this order. bool is_facet(Vertex_handle u, Vertex_handle v, Vertex_handle w, Cell_handle & c, int & i, int & j, int & k) const; -/*! +/*! Tests whether `((u,offu),(v,offv),(w,offw))` is a facet of `t`. If the facet is found, it computes a cell `c` having this facet and the indices `i`, @@ -655,12 +655,12 @@ Vertex_handle v, const Offset & offv, Vertex_handle w, const Offset & offw, Cell_handle & c, int & i, int & j, int & k) const; -/*! +/*! Tests whether `c` is a cell of `t`. */ bool is_cell(Cell_handle c) const; -/*! +/*! Tests whether `(u,v,w,x)` is a cell of `t`. If the cell `c` is found, the method computes the indices `i`, `j`, `k` and `l` of the @@ -673,7 +673,7 @@ Vertex_handle w, Vertex_handle x, Cell_handle & c, int & i, int & j, int & k, int & l) const; -/*! +/*! Tests whether `(u,v,w,x)` is a cell of `t` and computes this cell `c`. \pre `u`, `v`, `w` and `x` are vertices of `t`. @@ -682,7 +682,7 @@ bool is_cell(Vertex_handle u, Vertex_handle v, Vertex_handle w, Vertex_handle x, Cell_handle & c) const; -/*! +/*! Tests whether `((u,offu),(v,offv),(w,offv),(x,offx))` is a cell of `t`. If the cell `c` is found, the method @@ -698,7 +698,7 @@ Vertex_handle x, const Offset & offx, Cell_handle & c, int & i, int & j, int & k, int & l) const; -/*! +/*! Tests whether `((u,offu),(v,offv),(w,offv),(x,offx))` is a cell of `t` and computes this cell `c`. @@ -716,25 +716,25 @@ Cell_handle & c) const; /// There is a method `has_vertex` in the cell class. The analogous methods for facets are defined here. /// @{ -/*! +/*! If `v` is a vertex of `f`, then `j` is the index of `v` in the cell `f.first`, and the method returns `true`. */ bool has_vertex(const Facet & f, Vertex_handle v, int & j) const; -/*! +/*! Same for facet `(c,i)`. Computes the index `j` of `v` in `c`. */ bool has_vertex(Cell_handle c, int i, Vertex_handle v, int & j) const; -/*! +/*! */ bool has_vertex(const Facet & f, Vertex_handle v) const; -/*! +/*! Same as the first two methods, but these two methods do not return the index of the vertex. */ @@ -746,17 +746,17 @@ bool has_vertex(Cell_handle c, int i, Vertex_handle v) const; /// The following three methods test whether two facets have the same vertices. /// @{ -/*! +/*! */ bool are_equal(Cell_handle c, int i, Cell_handle n, int j) const; -/*! +/*! */ bool are_equal(const Facet & f, const Facet & g) const; -/*! +/*! */ bool are_equal(const Facet & f, Cell_handle n, int j) const; @@ -771,7 +771,7 @@ bool are_equal(const Facet & f, Cell_handle n, int j) const; /// also provides a `nearest_vertex()` function. /// @{ -/*! +/*! Returns the cell that contains the query in its interior. If `query` lies on a facet, an edge or on a vertex, one of the cells @@ -785,7 +785,7 @@ search. Cell_handle locate(const Point & query, Cell_handle start = Cell_handle()) const; -/*! +/*! The \f$ k\f$-face that contains `query` in its interior is returned, by means of the cell returned together with `lt`, which is set to the locate type of the query (`VERTEX, EDGE, FACET, CELL`) and two indices `li` and `lj` that @@ -808,7 +808,7 @@ Cell_handle locate(const Point & query, Locate_type & lt, int & li, int & lj, Cell_handle start = Cell_handle() ) const; -/*! +/*! Returns a value indicating on which side of the oriented boundary of `c` the point `p` lies. More precisely, it returns: @@ -828,7 +828,7 @@ Locate_type & lt, int & li, int & lj) const; /// @} -/*! +/*! \name Traversal of the Triangulation The periodic triangulation class provides several iterators and circulators @@ -847,51 +847,51 @@ their value types are respectively `Cell`, `Facet`, `Edge` and /// @{ -/*! +/*! Starts at an arbitrary vertex. Iterates over all vertices. Returns `vertices_end()` if `t`.`number_of_vertices()` \f$ =0\f$. */ Vertex_iterator vertices_begin() const; -/*! +/*! Past-the-end iterator */ Vertex_iterator vertices_end() const; -/*! +/*! Starts at an arbitrary edge. Iterates over all edges. Returns `edges_end()` if `t`.`number_of_vertices()` \f$ =0\f$. */ Edge_iterator edges_begin() const; -/*! +/*! Past-the-end iterator */ Edge_iterator edges_end() const; -/*! +/*! Starts at an arbitrary facet. Iterates over all facets. Returns `facets_end()` if `t`.`number_of_vertices()` \f$ =0\f$. */ Facet_iterator facets_begin() const; -/*! +/*! Past-the-end iterator */ Facet_iterator facets_end() const; -/*! +/*! Starts at an arbitrary cell. Iterates over all cells. Returns `cells_end()` if `t`.`number_of_vertices()` \f$ =0\f$. */ Cell_iterator cells_begin() const; -/*! +/*! Past-the-end iterator */ Cell_iterator cells_end() const; -/*! +/*! Starts at an arbitrary vertex. Iterates over all vertices whose corresponding points lie in the original domain, i.e.\ for each set of periodic copies the `Unique_vertex_iterator` iterates over @@ -900,7 +900,7 @@ exactly one representative. Returns `unique_vertices_end()` if */ Unique_vertex_iterator unique_vertices_begin() const; -/*! +/*! Past-the-end iterator */ Unique_vertex_iterator unique_vertices_end() const; @@ -932,7 +932,7 @@ controlled using the enum `Iterator_type`. /// @{ -/*! +/*! Iterates over the points of the triangulation. Its behavior is defined by the `Iterator_type` `it` as described on \ref CGAL::Periodic_3_triangulation_3::Iterator_type. @@ -940,7 +940,7 @@ defined by the `Iterator_type` `it` as described on Periodic_point_iterator periodic_points_begin(Iterator_type it = STORED) const; -/*! +/*! Past-the-end iterator. Note that to match another `Periodic_point_iterator` both must have the same `Iterator_type` `it`. @@ -948,7 +948,7 @@ Past-the-end iterator. Note that to match another Periodic_point_iterator periodic_points_end(Iterator_type it = STORED) const; -/*! +/*! Iterates over the segments of the triangulation. Its behavior is defined by the `Iterator_type` `it` as described on \ref CGAL::Periodic_3_triangulation_3::Iterator_type. @@ -956,7 +956,7 @@ defined by the `Iterator_type` `it` as described on Periodic_segment_iterator periodic_segments_begin(Iterator_type it = STORED) const; -/*! +/*! Past-the-end iterator. Note that to match another `Periodic_segment_iterator` both must have the same `Iterator_type` `it`. @@ -964,7 +964,7 @@ Past-the-end iterator. Note that to match another Periodic_segment_iterator periodic_segments_end(Iterator_type it = STORED) const; -/*! +/*! Iterates over the triangles of the triangulation. Its behavior is defined by the `Iterator_type` `it` as described on \ref CGAL::Periodic_3_triangulation_3::Iterator_type. @@ -972,7 +972,7 @@ defined by the `Iterator_type` `it` as described on Periodic_triangle_iterator periodic_triangles_begin(Iterator_type it = STORED) const; -/*! +/*! Past-the-end iterator. Note that to match another `Periodic_triangle_iterator` both must have the same `Iterator_type` `it`. @@ -980,7 +980,7 @@ Past-the-end iterator. Note that to match another Periodic_triangle_iterator periodic_triangles_end(Iterator_type it = STORED) const; -/*! +/*! Iterates over the tetrahedra of the triangulation. Its behavior is defined by the `Iterator_type` `it` as described on \ref CGAL::Periodic_3_triangulation_3::Iterator_type. @@ -988,7 +988,7 @@ defined by the `Iterator_type` `it` as described on Periodic_tetrahedron_iterator periodic_tetrahedra_begin(Iterator_type it = STORED) const; -/*! +/*! Past-the-end iterator. Note that to match another `Periodic_tetrahedron_iterator` both must have the same `Iterator_type` `it`. @@ -1005,57 +1005,57 @@ STORED) const; /// the cells traversed. /// @{ -/*! +/*! Starts at an arbitrary cell incident to `e`. */ Cell_circulator incident_cells(Edge e) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Cell_circulator incident_cells(Cell_handle c, int i, int j) const; -/*! +/*! Starts at cell `start`. \pre `start` is incident to `e`. */ Cell_circulator incident_cells(Edge e, Cell_handle start) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Cell_circulator incident_cells(Cell_handle c, int i, int j, Cell_handle start) const; -/*! +/*! Starts at an arbitrary facet incident to `e`. */ Facet_circulator incident_facets(Edge e) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Facet_circulator incident_facets(Cell_handle c, int i, int j) const; -/*! +/*! Starts at facet `start`. \pre `start` is incident to `e`. */ Facet_circulator incident_facets(Edge e, Facet start) const; -/*! +/*! Starts at facet of index `f` in `start`. */ Facet_circulator incident_facets(Edge e, Cell_handle start, int f) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Facet_circulator incident_facets(Cell_handle c, int i, int j, Facet start) const; -/*! +/*! As above for edge `(i,j)` of `c` and facet `(start,f)`. */ Facet_circulator incident_facets(Cell_handle c, int i, int j, @@ -1066,7 +1066,7 @@ Cell_handle start, int f) const; /// \name Traversal of the Incident Cells and Facets, and the Adjacent Vertices of a Given Vertex /// @{ -/*! +/*! Copies the `Cell_handle`s of all cells incident to `v` to the output iterator `cells`. Returns the resulting output iterator. \pre `v` \f$ \neq\f$ `Vertex_handle()`, `t`.`is_vertex(v)`. @@ -1075,7 +1075,7 @@ template OutputIterator incident_cells(Vertex_handle v, OutputIterator cells) const; -/*! +/*! Copies the `Facet`s incident to `v` to the output iterator `facets`. Returns the resulting output iterator. @@ -1085,7 +1085,7 @@ template OutputIterator incident_facets(Vertex_handle v, OutputIterator facets) const; -/*! +/*! Copies the `Edge`s incident to `v` to the output iterator `edges`. Returns the resulting output iterator. @@ -1095,7 +1095,7 @@ template OutputIterator incident_edges(Vertex_handle v, OutputIterator edges) const; -/*! +/*! Copies the `Vertex_handle`s of all vertices adjacent to `v` to the output iterator `vertices`. Returns the resulting output iterator. \pre `v` \f$ \neq\f$ `Vertex_handle()`, `t`.`is_vertex(v)`. @@ -1104,7 +1104,7 @@ template OutputIterator adjacent_vertices(Vertex_handle v, OutputIterator vertices) const; -/*! +/*! Returns the degree of a vertex, that is, the number of adjacent vertices. \pre `v` \f$ \neq\f$ `Vertex_handle()`, `t`.`is_vertex(v)`. */ @@ -1115,20 +1115,20 @@ size_type degree(Vertex_handle v) const; /// \name Traversal Between Adjacent Cells /// @{ -/*! +/*! Returns the index of `c` in its \f$ i^{th}\f$ neighbor. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ int mirror_index(Cell_handle c, int i) const; -/*! +/*! Returns the vertex of the \f$ i^{th}\f$ neighbor of `c` that is opposite to `c`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ Vertex_handle mirror_vertex(Cell_handle c, int i) const; -/*! +/*! Returns the same facet viewed from the other adjacent cell. */ Facet mirror_facet(Facet f) const; @@ -1144,7 +1144,7 @@ Facet mirror_facet(Facet f) const; /// \cgalAdvancedEnd /// @{ -/*! +/*! Checks the combinatorial validity of the triangulation. Checks also the validity of its geometric embedding (see Section \ref P3Triangulation3secintro). @@ -1155,7 +1155,7 @@ are printed. bool is_valid(bool verbose = false) const; -/*! +/*! Checks the combinatorial validity of the cell by calling the `is_valid` method of the `Triangulation_data_structure` cell class. Also checks the geometric validity of `c`, if `c` is @@ -1172,7 +1172,7 @@ is_valid(Cell_handle c, bool verbose = false) const; }; /* end Periodic_3_triangulation_3 */ -/*! +/*! Reads a triangulation from `is` and stores it in `t`. \pre `is` has the below described format. @@ -1196,7 +1196,7 @@ corresponds to the preceding list of cells */ istream& operator>> (istream& is, Periodic_3_triangulation_3 &t); -/*! +/*! Writes the triangulation `t` into `os`. The information in the `iostream` is: diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h index cd28d701dc7..585e14f9ea7 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3DelaunayTriangulationTraits_3.h @@ -34,24 +34,24 @@ public: /// \name Types /// @{ -/*! +/*! The point type. It must be a model of `Kernel::Point_3`. */ typedef unspecified_type Point_3; -/*! +/*! The vector type. It must be a model of `Kernel::Vector_3`. */ typedef unspecified_type Vector_3; -/*! +/*! The offset type. It must be a model of the concept `Periodic_3Offset_3`. */ typedef unspecified_type Periodic_3_offset_3; -/*! +/*! A type representing an axis-aligned cuboid. It must be a model of `Kernel::Iso_cuboid_3`. */ @@ -66,24 +66,24 @@ typedef unspecified_type Iso_cuboid_3; /// i.e.\ constructing representatives in \f$ \mathbb R^3\f$. /// @{ -/*! +/*! A segment type. It must be a model of `Kernel::Segment_3`. */ typedef unspecified_type Segment_3; -/*! +/*! A triangle type. It must be a model of `Kernel::Triangle_3`. */ typedef unspecified_type Triangle_3; -/*! +/*! A tetrahedron type. It must be a model of `Kernel::Tetrahedron_3`. */ typedef unspecified_type Tetrahedron_3; -/*! +/*! A predicate object that must provide the function operators `Comparison_result operator()(Point_3 p, Point_3 q)`, @@ -99,7 +99,7 @@ in a same line. */ typedef unspecified_type Compare_xyz_3; -/*! +/*! A predicate object that must provide the function operators `Orientation operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, @@ -120,7 +120,7 @@ returns `NEGATIVE` if `(s,o_s)` lies on the negative side of */ typedef unspecified_type Orientation_3; -/*! +/*! A predicate object that must provide the function operators `Oriented_side operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s, Point_3 t)`, @@ -137,7 +137,7 @@ which determines on which side of the oriented sphere circumscribing */ typedef unspecified_type Side_of_oriented_sphere_3; -/*! +/*! A predicate object that must provide the function operators `Comparison_result operator()(Point_3 p, Point_3 q, Point_3 r)`, @@ -159,7 +159,7 @@ typedef unspecified_type Compare_distance_3; /// In addition, only when vertex removal is used, the traits class must provide the following predicate objects /// @{ -/*! +/*! A predicate object that must provide the function operators `Orientation operator()(Point_3 p, Point_3 q, Point_3 r)`, @@ -177,7 +177,7 @@ three point-offset pairs chosen in a same plane. */ typedef unspecified_type Coplanar_orientation_3; -/*! +/*! A predicate object that must provide the function operators `Bounded_side operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, @@ -201,7 +201,7 @@ typedef unspecified_type Coplanar_side_of_bounded_circle_3; /// provide the following predicate object: /// @{ -/*! +/*! A predicate object that must provide the function operators `Bounded_side operator()(Point_3 p, Point_3 q, Point_3 t)`, @@ -248,7 +248,7 @@ typedef unspecified_type Side_of_bounded_sphere_3; /// guarantee exactness of the following construction functors. /// @{ -/*! +/*! A constructor object that must provide the function operator `Point_3 operator()(Point_3 p, Periodic_3_offset_3 o_p)`, @@ -258,7 +258,7 @@ which constructs a point from a point-offset pair. */ typedef unspecified_type Construct_point_3; -/*! +/*! A constructor object that must provide the function operators `Segment_3 operator()(Point_3 p, Point_3 q)`, @@ -272,7 +272,7 @@ which constructs a segment from two point-offset pairs. */ typedef unspecified_type Construct_segment_3; -/*! +/*! A constructor object that must provide the function operators `Triangle_3 operator()(Point_3 p, Point_3 q, Point_3 r )`, @@ -286,7 +286,7 @@ which constructs a triangle from three point-offset pairs. */ typedef unspecified_type Construct_triangle_3; -/*! +/*! A constructor object that must provide the function operators `Tetrahedron_3 operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, @@ -307,7 +307,7 @@ typedef unspecified_type Construct_tetrahedron_3; /// class must provide the following constructor object: /// @{ -/*! +/*! A constructor object that must provide the function operators `Point_3 operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, @@ -326,12 +326,12 @@ typedef unspecified_type Construct_circumcenter_3; /// \name Creation /// @{ -/*! +/*! Default constructor. */ Periodic_3_triangulation_traits_3(); -/*! +/*! Copy constructor. */ Periodic_3_triangulation_traits_3(const Periodic_triangulation_traits_3 & tr); @@ -341,7 +341,7 @@ Periodic_3_triangulation_traits_3(const Periodic_triangulation_traits_3 & tr); /// \name Access Functions /// @{ -/*! +/*! Set the size of the fundamental domain. This is necessary to evaluate predicates correctly. @@ -355,22 +355,22 @@ void set_domain(Iso_cuboid_3 domain); /// The following functions give access to the predicate and construction objects: /// @{ -/*! +/*! */ Compare_xyz_3 compare_xyz_3_object(); -/*! +/*! */ Orientation_3 orientation_3_object(); -/*! +/*! */ Side_of_oriented_sphere_3 side_of_oriented_sphere_3_object(); -/*! +/*! */ Compare_distance_3 compare_distance_3_object(); @@ -382,12 +382,12 @@ Compare_distance_3 compare_distance_3_object(); /// used; otherwise dummy functions can be provided. /// @{ -/*! +/*! */ Coplanar_orientation_3 coplanar_3_orientation_3_object(); -/*! +/*! */ Coplanar_side_of_bounded_circle_3 @@ -401,22 +401,22 @@ coplanar_side_of_bounded_circle_3_object(); /// otherwise a dummy function can be provided. /// @{ -/*! +/*! */ Side_of_bounded_sphere_3 side_of_bounded_sphere_3_object(); -/*! +/*! */ Construct_segment_3 construct_segment_3_object(); -/*! +/*! */ Construct_triangle_3 construct_triangle_3_object(); -/*! +/*! */ Construct_tetrahedron_3 construct_tetrahedron_3_object(); @@ -430,7 +430,7 @@ Construct_tetrahedron_3 construct_tetrahedron_3_object(); /// provided: /// @{ -/*! +/*! */ Construct_circumcenter_3 construct_circumcenter_3_object(); diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h index 45373519d96..f2507f4e950 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3Offset_3.h @@ -18,12 +18,12 @@ public: /// \name Creation /// @{ -/*! +/*! Default constructor. */ Periodic_3Offset_3(); -/*! +/*! Constructs the offset (x,y,z). */ Periodic_3Offset_3(int x, int y, int z); @@ -33,47 +33,47 @@ Periodic_3Offset_3(int x, int y, int z); /// \name Operations /// @{ -/*! +/*! Return the vector sum of `o` and `other`. */ Periodic_3Offset_3 operator+(const Periodic_3Offset_3 & other) const; -/*! +/*! Return the vector difference of `o` and `other`. */ Periodic_3Offset_3 operator-(const Periodic_3Offset_3 & other) const; -/*! +/*! Return the negative vector of `o`. */ Periodic_3Offset_3 operator-() const; -/*! +/*! Add `other` to `o` using vector addition. */ void operator+=(const Periodic_3Offset_3 & other) const; -/*! +/*! Subtract `other` from `o` using vector subtraction. */ void operator-=(const Periodic_3Offset_3 & other) const; -/*! +/*! Return `true` if `other` and `o` represent the same vector. */ bool operator==(const Periodic_3Offset_3 & other) const; -/*! +/*! Return `true` if `other` and `o` do not represent the same vector. */ bool operator!=(const Periodic_3Offset_3 & other) const; -/*! +/*! Compare `o` and `other` lexicographically. */ bool operator<(const Periodic_3Offset_3 & other) const; @@ -83,37 +83,37 @@ bool operator<(const Periodic_3Offset_3 & other) const; /// \name Access Functions /// @{ -/*! +/*! Return the \f$ i\f$-th entry of `o`. */ int operator[](int i); -/*! +/*! Return the \f$ x\f$-entry of `o`. */ int x() const; -/*! +/*! Return the \f$ y\f$-entry of `o`. */ int y() const; -/*! +/*! Return the \f$ z\f$-entry of `o`. */ int z(); -/*! +/*! Returns `true` if `o` is equal to (0,0,0). */ bool is_null() const; -/*! +/*! Inputs an offset from `is`. */ istream& operator>>(istream & is, Periodic_3_offset_3 & off); -/*! +/*! Outputs an offset from `os`. */ ostream& operator<<(ostream & os, Periodic_3_offset_3 & off) const; diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h index 832bd9f65e3..0997fd07c67 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSCellBase_3.h @@ -32,7 +32,7 @@ public: /// \name Access Functions /// @{ -/*! +/*! Returns the offset of vertex `i`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ @@ -43,7 +43,7 @@ int offset(int i) const; /// \name Setting /// @{ -/*! +/*! Sets the vertex offsets according to `off0` to `off3`. */ void set_offsets(int off0, int off1, int off2, int off3); diff --git a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h index a097c6d843a..e5394c0ea37 100644 --- a/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h +++ b/Periodic_3_triangulation_3/doc/Periodic_3_triangulation_3/Concepts/Periodic_3TriangulationDSVertexBase_3.h @@ -30,7 +30,7 @@ public: /// \name Types /// @{ -/*! +/*! A model of the concept `Periodic_3Offset_3` */ @@ -41,22 +41,22 @@ typedef unspecified_type Periodic_3_offset_3; /// \name Access Functions /// @{ -/*! +/*! Returns the offset stored in the vertex. */ Periodic_3_offset_3 offset() const; -/*! +/*! Returns `true` if the offset has been set, `false` otherwise. */ bool get_offset_flag() const; -/*! +/*! Sets the offset and sets the offset flag to `true`. */ void set_offset(Periodic_3_offset_3 o); -/*! +/*! Sets the offset flag to `false` and clears the offset. */ void clear_offset(); diff --git a/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h b/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h index d372cc4f34b..505d18591cd 100644 --- a/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h +++ b/Point_set_2/doc/Point_set_2/CGAL/Point_set_2.h @@ -22,47 +22,47 @@ public: /// \name Types /// @{ -/*! +/*! the point type */ typedef Gt::Point_2 Point; -/*! +/*! the segment type */ typedef Gt::Segment_2 Segment; -/*! +/*! the circle type */ typedef Gt::Circle_2 Circle; -/*! +/*! the representation field number type. */ typedef Gt::FT Numb_type; -/*! +/*! the underlying triangulation type. */ typedef unspecified_type Triangulation; -/*! +/*! the size type of the underlying triangulation. */ typedef Triangulation::size_type size_type; -/*! +/*! the vertex type of the underlying triangulation. */ typedef Triangulation::Vertex Vertex; -/*! +/*! the edge type of the underlying triangulation. */ typedef Triangulation::Edge Edge; -/*! +/*! handles to vertices. */ typedef Triangulation::Vertex_handle Vertex_handle; @@ -72,12 +72,12 @@ typedef Triangulation::Vertex_handle Vertex_handle; /// \name Creation /// @{ -/*! +/*! creates an empty `Point_set_2`. */ Point_set_2(); -/*! +/*! creates a `Point_set_2` `PS` of the points in the range [`first`,`last`). */ @@ -89,27 +89,27 @@ Point_set_2(InputIterator first, InputIterator last); /// \name Operations /// @{ -/*! +/*! if `PS` contains a vertex `v` with `v.point() == p` the result is a handle to `v` otherwise the result is `NULL`. */ Vertex\_handle lookup(Point p); -/*! +/*! computes a handle to a vertex `v` of `PS` that is closest to `p`. If `PS` is empty, `NULL` is returned. */ Vertex\_handle nearest_neighbor(Point p); -/*! +/*! computes a handle to a vertex `w` of `PS` that is closest to `v`. If `v` is the only vertex in `PS` , `NULL` is returned. */ Vertex\_handle nearest_neighbor(Vertex_handle v); -/*! +/*! computes the `k` nearest neighbors of `p` in `PS`, and places the handles to the corresponding vertices as a sequence of objects of type Vertex_handle in a container of value type of `res` @@ -120,7 +120,7 @@ of the sequence. template OutputIterator nearest_neighbors(Point p, size_type k, OutputIterator res); -/*! +/*! computes the `k` nearest neighbors of `v`, and places them as a sequence of objects of type Vertex_handle in a container of value type of `res` which points to the first object in the sequence. The function @@ -130,7 +130,7 @@ of the sequence. template OutputIterator nearest_neighbors(Vertex_handle v, size_type k,OutputIterator res); -/*! +/*! computes handles to all vertices contained in the closure of disk `C`. The computed vertex handles will be placed as a sequence of objects in a container of value type of `res` @@ -142,7 +142,7 @@ of the sequence. template OutputIterator range_search(const Circle& C, OutputIterator res); -/*! +/*! computes handles to all vertices contained in the closure of the triangle `(a,b,c)`. \pre `a`, `b`, and `c` must not be collinear. @@ -156,7 +156,7 @@ of the sequence. template OutputIterator range_search(const Point& a, const Point& b, const Point& c,OutputIterator res); -/*! +/*! computes handles to all vertices contained in the closure of the iso-rectangle `(a1,b1,c1,d1)`. \pre `a1` is the upper left point, `b1` the lower left, `c1` the lower right and `d1` the upper right point of the iso rectangle. diff --git a/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h b/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h index fe5801e416a..df7681e7330 100644 --- a/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h +++ b/Point_set_2/doc/Point_set_2/Concepts/PointSetTraits.h @@ -14,57 +14,57 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type Point_2; -/*! +/*! */ typedef unspecified_type Circle_2; -/*! +/*! */ typedef unspecified_type Segment_2; -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Orientation_2; -/*! +/*! */ typedef unspecified_type Side_of_oriented_circle_2; -/*! +/*! */ typedef unspecified_type Construct_circle_2; -/*! +/*! */ typedef unspecified_type Compute_squared_distance_2; -/*! +/*! */ typedef unspecified_type Bounded_side_2; -/*! +/*! */ typedef unspecified_type Compare_distance_2; -/*! +/*! */ typedef unspecified_type Construct_center_2; diff --git a/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h b/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h index 500aecd0870..9064c4450c8 100644 --- a/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h +++ b/Polygon/doc/Polygon/Concepts/PolygonTraits_2.h @@ -35,57 +35,57 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type FT; -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The segment type. */ typedef unspecified_type Segment_2; -/*! +/*! */ typedef unspecified_type Construct_segment_2; -/*! +/*! */ typedef unspecified_type Equal_2; -/*! +/*! */ typedef unspecified_type Less_xy_2; -/*! +/*! */ typedef unspecified_type Less_yx_2; -/*! +/*! */ typedef unspecified_type Compare_x_2; -/*! +/*! */ typedef unspecified_type Compare_y_2; -/*! +/*! */ typedef unspecified_type Orientation_2; -/*! +/*! Computes the signed area of the oriented triangle defined by 3 `Point_2` passed as arguments. */ @@ -97,42 +97,42 @@ typedef unspecified_type Compute_area_2; /// The following functions that create instances of the above predicate object types must exist. /// @{ -/*! +/*! */ Equal_2 equal_2_object(); -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Less_yx_2 less_yx_2_object(); -/*! +/*! */ Compare_y_2 compare_y_2_object(); -/*! +/*! */ Compare_x_2 compare_x_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); -/*! +/*! */ Compute_area_2 compute_area_2_object(); -/*! +/*! */ Construct_segment_2 construct_segment_2_object(); diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h index 76814220e44..5e41155c122 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_3.h @@ -170,81 +170,81 @@ public: /// \name Types /// @{ - /*! + /*! type of incident vertices. */ typedef unspecified_type Vertex; - /*! + /*! type of incident facets. */ typedef unspecified_type Facet; - /*! + /*! handle to vertex. */ typedef unspecified_type Vertex_handle; - /*! + /*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; - /*! + /*! handle to facet. */ typedef unspecified_type Facet_handle; - /*! + /*! circulator of halfedges around a vertex. */ typedef unspecified_type Halfedge_around_vertex_circulator; - /*! + /*! circulator of halfedges around a facet. */ typedef unspecified_type Halfedge_around_facet_circulator; - /*! + /*! */ typedef unspecified_type Vertex_const_handle; - /*! + /*! */ typedef unspecified_type Halfedge_const_handle; - /*! + /*! */ typedef unspecified_type Facet_const_handle; - /*! + /*! */ typedef unspecified_type Halfedge_around_vertex_const_circulator; - /*! + /*! */ typedef unspecified_type Halfedge_around_facet_const_circulator; - /*! + /*! \f$ \equiv\f$ `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Supports_halfedge_prev; - /*! + /*! \f$ \equiv\f$ `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Supports_halfedge_vertex; - /*! + /*! \f$ \equiv\f$ `CGAL::Tag_true` or `CGAL::Tag_false`. */ @@ -255,7 +255,7 @@ public: /// \name Creation /// @{ - /*! + /*! default constructor. */ Halfedge(); @@ -265,121 +265,121 @@ public: /// \name Operations /// @{ - /*! + /*! */ Halfedge_handle opposite(); - /*! + /*! the opposite halfedge. */ Halfedge_const_handle opposite() const; - /*! + /*! */ Halfedge_handle next(); - /*! + /*! the next halfedge around the facet. */ Halfedge_const_handle next() const; - /*! + /*! */ Halfedge_handle prev(); - /*! + /*! the previous halfedge around the facet. */ Halfedge_const_handle prev() const; - /*! + /*! */ Halfedge_handle next_on_vertex(); - /*! + /*! the next halfedge around the vertex (clockwise). Is equal to `h.next()->opposite()`. */ Halfedge_const_handle next_on_vertex() const; - /*! + /*! */ Halfedge_handle prev_on_vertex(); - /*! + /*! the previous halfedge around the vertex (counterclockwise). Is equal to `h.%opposite()->%prev()`. */ Halfedge_const_handle prev_on_vertex() const; - /*! + /*! is true if `h` is a border halfedge. */ bool is_border() const; - /*! + /*! is true if this or the opposite halfedge is a border halfedge. */ bool is_border_edge() const; - /*! + /*! */ Halfedge_around_vertex_circulator vertex_begin(); - /*! + /*! circulator of halfedges around the vertex (clockwise). */ Halfedge_around_vertex_const_circulator vertex_begin() const; - /*! + /*! */ Halfedge_around_facet_circulator facet_begin(); - /*! + /*! circulator of halfedges around the facet (counterclockwise). */ Halfedge_around_facet_const_circulator facet_begin() const; - /*! + /*! the degree of the incident vertex, i.e., number of edges emanating from this vertex. */ std::size_t vertex_degree() const; - /*! + /*! returns `true` if the incident vertex has exactly two incident edges. */ bool is_bivalent() const; - /*! + /*! returns `true` if the incident vertex has exactly three incident edges. */ bool is_trivalent() const; - /*! + /*! the degree of the incident facet, i.e., number of edges on the boundary of this facet. */ std::size_t facet_degree() const; - /*! + /*! returns `true` if the incident facet is a triangle. */ bool is_triangle() const; - /*! + /*! returns `true` if the incident facet is a quadrilateral. */ @@ -390,12 +390,12 @@ public: /// \name Operations available if Supports_halfedge_vertex is CGAL::Tag_true /// @{ - /*! + /*! */ Vertex_handle vertex(); - /*! + /*! the incident vertex of the halfedge. */ Vertex_const_handle vertex() const; @@ -405,12 +405,12 @@ public: /// \name Operations available if Supports_halfedge_facet is CGAL::Tag_true /// @{ - /*! + /*! */ Facet_handle facet(); - /*! + /*! the incident facet of the halfedge. If the hafedge is a border halfedge the result is default construction of the handle. */ @@ -447,69 +447,69 @@ public: /// @{ - /*! + /*! type of incident vertices. */ typedef unspecified_type Vertex; - /*! + /*! type of incident halfedges. */ typedef unspecified_type Halfedge; - /*! + /*! plane equation type stored in facets. */ typedef unspecified_type Plane_3; - /*! + /*! handle to vertex. */ typedef unspecified_type Vertex_handle; - /*! + /*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; - /*! + /*! handle to facet. */ typedef unspecified_type Facet_handle; - /*! + /*! circulator of halfedges around a facet. */ typedef unspecified_type Halfedge_around_facet_circulator; - /*! + /*! */ typedef unspecified_type Vertex_const_handle; - /*! + /*! */ typedef unspecified_type Halfedge_const_handle; - /*! + /*! */ typedef unspecified_type Facet_const_handle; - /*! + /*! */ typedef unspecified_type Halfedge_around_facet_const_circulator; - /*! + /*! \f$ \equiv\f$ `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Supports_facet_halfedge; - /*! + /*! \f$ \equiv\f$ `CGAL::Tag_true` or `CGAL::Tag_false`. */ @@ -520,7 +520,7 @@ public: /// \name Creation /// @{ - /*! + /*! default constructor. */ Facet(); @@ -530,12 +530,12 @@ public: /// \name Operations available if Supports_facet_plane is CGAL::Tag_true /// @{ - /*! + /*! */ Plane_3& plane(); - /*! + /*! plane equation. */ const Plane_3& plane() const; @@ -546,46 +546,46 @@ public: /// @{ - /*! + /*! */ Halfedge_handle halfedge(); - /*! + /*! an incident halfedge that points to the facet. */ Halfedge_const_handle halfedge() const; - /*! + /*! */ Halfedge_around_facet_circulator facet_begin(); - /*! + /*! circulator of halfedges around the facet (counterclockwise). */ Halfedge_around_facet_const_circulator facet_begin() const; - /*! + /*! sets incident halfedge to `h`. \pre `h` is incident, i.e., `h->facet() ==` `*this`. */ void set_halfedge( Halfedge_handle h); - /*! + /*! the degree of the facet, i.e., number of edges on the boundary of this facet. */ std::size_t facet_degree() const; - /*! + /*! returns `true` if the facet is a triangle. */ bool is_triangle() const; - /*! + /*! returns `true` if the facet is a quadrilateral. */ @@ -620,69 +620,69 @@ public: /// \name Types /// @{ - /*! + /*! type of incident halfedges. */ typedef unspecified_type Halfedge; - /*! + /*! type of incident facets. */ typedef unspecified_type Facet; - /*! + /*! point type stored in vertices. */ typedef unspecified_type Point_3; - /*! + /*! handle to vertex. */ typedef unspecified_type Vertex_handle; - /*! + /*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; - /*! + /*! handle to facet. */ typedef unspecified_type Facet_handle; - /*! + /*! circulator of halfedges around a vertex. */ typedef unspecified_type Halfedge_around_vertex_circulator; - /*! + /*! */ typedef unspecified_type Vertex_const_handle; - /*! + /*! */ typedef unspecified_type Halfedge_const_handle; - /*! + /*! */ typedef unspecified_type Facet_const_handle; - /*! + /*! */ typedef unspecified_type Halfedge_around_vertex_const_circulator; - /*! + /*! \f$ \equiv\f$ `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Supports_vertex_halfedge; - /*! + /*! \f$ \equiv\f$ `CGAL::Tag_true` or `CGAL::Tag_false`. */ @@ -693,12 +693,12 @@ public: /// \name Creation /// @{ - /*! + /*! default constructor. */ Vertex(); - /*! + /*! vertex initialized with a point. */ Vertex( const Point& p); @@ -708,12 +708,12 @@ public: /// \name Operations available if Supports_vertex_point is CGAL::Tag_true /// @{ - /*! + /*! */ Point_3& point(); - /*! + /*! the point. */ const Point_3& point() const; @@ -723,46 +723,46 @@ public: /// \name Operations available if Supports_vertex_halfedge is CGAL::Tag_true /// @{ - /*! + /*! */ Halfedge_handle halfedge(); - /*! + /*! an incident halfedge that points to `v`. */ Halfedge_const_handle halfedge() const; - /*! + /*! */ Halfedge_around_vertex_circulator vertex_begin(); - /*! + /*! circulator of halfedges around the vertex (clockwise). */ Halfedge_around_vertex_const_circulator vertex_begin() const; - /*! + /*! sets incident halfedge to `h`. \pre `h` is incident, i.e., `h->vertex() ==` `v`. */ void set_halfedge( Halfedge_handle h); - /*! + /*! the degree of the vertex, i.e., number of edges emanating from this vertex. */ std::size_t vertex_degree() const; - /*! + /*! returns `true` if the vertex has exactly two incident edges. */ bool is_bivalent() const; - /*! + /*! returns `true` if the vertex has exactly three incident edges. */ @@ -775,45 +775,45 @@ public: /// \name Types /// @{ - /*! + /*! traits class selected for `PolyhedronTraits_3`. */ typedef unspecified_type Traits; - /*! + /*! items class selected for `PolyhedronItems_3`. */ typedef unspecified_type Items; - /*! + /*! instantiated halfedge data structure. */ typedef unspecified_type HalfedgeDS; - /*! + /*! size type of `HalfedgeDS`. */ typedef unspecified_type size_type; - /*! + /*! difference type of `HalfedgeDS`. */ typedef unspecified_type difference_type; - /*! + /*! iterator category of `HalfedgeDS` for all iterators. */ typedef unspecified_type iterator_category; - /*! + /*! circulator category of all circulators; bidirectional category if the `Items::Halfedge` provides a `Halfedge::prev()` member function, otherwise forward category. */ typedef unspecified_type circulator_category; - /*! + /*! allocator type `Alloc`. */ typedef unspecified_type allocator_type; @@ -838,69 +838,69 @@ public: */ /// @{ - /*! + /*! point stored in vertices. */ typedef unspecified_type Point_3; - /*! + /*! plane equation stored in facets (if supported). */ typedef unspecified_type Plane_3; - /*! + /*! handle to vertex. */ typedef unspecified_type Vertex_handle; - /*! + /*! handle to halfedge. */ typedef unspecified_type Halfedge_handle; - /*! + /*! handle to facet. */ typedef unspecified_type Facet_handle; - /*! + /*! iterator over all vertices. */ typedef unspecified_type Vertex_iterator; - /*! + /*! iterator over all halfedges. */ typedef unspecified_type Halfedge_iterator; - /*! + /*! iterator over all facets. */ typedef unspecified_type Facet_iterator; - /*! + /*! circulator of halfedges around a vertex (cw). */ typedef unspecified_type Halfedge_around_vertex_circulator; - /*! + /*! circulator of halfedges around a facet (ccw). */ typedef unspecified_type Halfedge_around_facet_circulator; - /*! + /*! iterator over all edges (every other halfedge). */ typedef unspecified_type Edge_iterator; - /*! + /*! iterator over all points. */ typedef unspecified_type Point_iterator; - /*! + /*! iterator over all plane equations. */ typedef unspecified_type Plane_iterator; @@ -913,42 +913,42 @@ public: /// supported or not. /// @{ - /*! + /*! `Vertex::halfedge()`. */ typedef unspecified_type Supports_vertex_halfedge; - /*! + /*! `Vertex::point()`. */ typedef unspecified_type Supports_vertex_point; - /*! + /*! `Halfedge::prev()`. */ typedef unspecified_type Supports_halfedge_prev; - /*! + /*! `Halfedge::vertex()`. */ typedef unspecified_type Supports_halfedge_vertex; - /*! + /*! `Halfedge::facet()`. */ typedef unspecified_type Supports_halfedge_facet; - /*! + /*! `Facet::halfedge()`. */ typedef unspecified_type Supports_facet_halfedge; - /*! + /*! `Facet::plane()`. */ typedef unspecified_type Supports_facet_plane; - /*! + /*! supports removal of individual elements. */ typedef unspecified_type Supports_removal; @@ -958,12 +958,12 @@ public: /// \name Creation /// @{ - /*! + /*! %Default constructor. */ Polyhedron_3(const Traits& traits = Traits()); - /*! + /*! Cosntructor of a polyhedron with storage reserved for `v` vertices, `h` halfedges, and `f` facets. The reservation sizes are a hint for optimizing storage @@ -972,7 +972,7 @@ public: Polyhedron_3( size_type v, size_type h, size_type f, const Traits& traits = Traits()); - /*! + /*! reserve storage for `v` vertices, `h` halfedges, and `f` facets. The reservation sizes are a hint for optimizing storage @@ -983,13 +983,13 @@ public: */ void reserve( size_type v, size_type h, size_type f); - /*! + /*! a tetrahedron is added to the polyhedral surface. Returns a halfedge of the tetrahedron. */ Halfedge_handle make_tetrahedron(); - /*! + /*! a tetrahedron is added to the polyhedral surface with its vertices initialized to `p1`, `p2`, `p3`, and `p4`. Returns that @@ -1003,14 +1003,14 @@ public: const Point& p3, const Point& p4); - /*! + /*! a triangle with border edges is added to the polyhedral surface. Returns a non-border halfedge of the triangle. */ Halfedge_handle make_triangle(); - /*! + /*! a triangle with border edges is added to the polyhedral surface with its vertices initialized to `p1`, `p2`, and `p3`. Returns that @@ -1027,119 +1027,119 @@ public: /// \name Access Member Functions /// @{ - /*! + /*! returns true if the polyhedron is empty. */ bool empty() const; - /*! + /*! number of vertices. */ size_type size_of_vertices() const; - /*! + /*! number of halfedges (incl.\ border halfedges). */ size_type size_of_halfedges() const; - /*! + /*! number of facets. */ size_type size_of_facets() const; - /*! + /*! space reserved for vertices. */ size_type capacity_of_vertices() const; - /*! + /*! space reserved for halfedges. */ size_type capacity_of_halfedges() const; - /*! + /*! space reserved for facets. */ size_type capacity_of_facets() const; - /*! + /*! bytes used for the polyhedron. */ size_t bytes() const; - /*! + /*! bytes reserved for the polyhedron. */ size_t bytes_reserved() const; - /*! + /*! allocator object. */ allocator_type get_allocator() const; - /*! + /*! iterator over all vertices. */ Vertex_iterator vertices_begin(); - /*! + /*! past-the-end iterator. */ Vertex_iterator vertices_end(); - /*! + /*! iterator over all halfedges. */ Halfedge_iterator halfedges_begin(); - /*! + /*! past-the-end iterator. */ Halfedge_iterator halfedges_end(); - /*! + /*! iterator over all facets (excluding holes). */ Facet_iterator facets_begin(); - /*! + /*! past-the-end iterator. */ Facet_iterator facets_end(); - /*! + /*! iterator over all edges. */ Edge_iterator edges_begin(); - /*! + /*! past-the-end iterator. */ Edge_iterator edges_end(); - /*! + /*! iterator over all points. */ Point_iterator points_begin(); - /*! + /*! past-the-end iterator. */ Point_iterator points_end(); - /*! + /*! iterator over all plane equations. */ Plane_iterator planes_begin(); - /*! + /*! past-the-end iterator. */ Plane_iterator planes_end(); - /*! + /*! returns the traits class. */ const Traits& traits() const; @@ -1149,43 +1149,43 @@ public: /// \name Combinatorial Predicates /// @{ - /*! + /*! returns `true` if there are no border edges. */ bool is_closed() const; - /*! + /*! returns `true` if all vertices have exactly two incident edges. */ bool is_pure_bivalent() const; - /*! + /*! returns `true` if all vertices have exactly three incident edges. */ bool is_pure_trivalent() const; - /*! + /*! returns `true` if all facets are triangles. */ bool is_pure_triangle() const; - /*! + /*! returns `true` if all facets are quadrilaterals. */ bool is_pure_quad() const; - /*! + /*! `true` iff the connected component denoted by `h` is a triangle. */ bool is_triangle( Halfedge_const_handle h) const; - /*! + /*! `true` iff the connected component denoted by `h` is a tetrahedron. */ @@ -1203,7 +1203,7 @@ public: */ /// @{ - /*! + /*! splits the facet incident to `h` and `g` into two facets with a new diagonal between the two vertices denoted by `h` and `g` respectively. The second (new) facet is a copy of the @@ -1219,7 +1219,7 @@ public: Halfedge_handle split_facet( Halfedge_handle h, Halfedge_handle g); - /*! + /*! joins the two facets incident to `h`. The facet incident to `h->%opposite()` gets removed. Both facets might be holes. Returns the predecessor of `h` around the facet. The invariant @@ -1235,7 +1235,7 @@ public: n */ Halfedge_handle join_facet( Halfedge_handle h); - /*! + /*! splits the vertex incident to `h` and `g` into two vertices, the old vertex remains and a new copy is created, and connects them with a new edge. Let `hnew` be @@ -1262,7 +1262,7 @@ n */ Halfedge_handle split_vertex( Halfedge_handle h, Halfedge_handle g); - /*! + /*! joins the two vertices incident to `h`. The vertex denoted by `h->opposite()` gets removed. Returns the predecessor of `h` around the vertex, i.e., `h->%opposite()->%prev()`. @@ -1278,7 +1278,7 @@ n */ */ Halfedge_handle join_vertex( Halfedge_handle h); - /*! + /*! splits the halfedge `h` into two halfedges inserting a new vertex that is a copy of `h->%opposite()->%vertex()`. Is equivalent to @@ -1292,14 +1292,14 @@ n */ */ Halfedge_handle split_edge( Halfedge_handle h); - /*! + /*! performs an edge flip. It returns `h` after rotating the edge `h` one vertex in the direction of the face orientation. \pre `h != Halfedge_handle()` and both facets incident to `h` are triangles. */ Halfedge_handle flip_edge( Halfedge_handle h); - /*! + /*! barycentric triangulation of `h->facet()`. Creates a new vertex, a copy of `h->vertex()`, and connects it to each vertex incident to `h->facet()` splitting `h->facet()` into triangles. @@ -1314,7 +1314,7 @@ n */ */ Halfedge_handle create_center_vertex( Halfedge_handle h); - /*! + /*! reverses `create_center_vertex()`. Erases the vertex pointed to by `g` and all incident halfedges thereby merging all incident facets. Only `g->facet()` remains. @@ -1335,7 +1335,7 @@ n */ /// \name Euler Operators Modifying Genus /// @{ - /*! + /*! cuts the polyhedron into two parts along the cycle `(h,i,j)` (edge `j` runs on the backside of the three dimensional figure above). Three new vertices (one copy for each vertex in the cycle) and three @@ -1351,7 +1351,7 @@ n */ Halfedge_handle i, Halfedge_handle j); - /*! + /*! glues the boundary of the two facets denoted by `h` and `g` together and returns `h`. Both facets and the vertices along the facet denoted by `g` gets removed. Both facets may be holes. The invariant @@ -1372,7 +1372,7 @@ n */ /// @{ - /*! + /*! removes the incident facet of `h` and changes all halfedges incident to the facet into border edges. Returns `h`. See `erase_facet(h)` for a more generalized variant. @@ -1382,7 +1382,7 @@ n */ */ Halfedge_handle make_hole( Halfedge_handle h); - /*! + /*! fills a hole with a newly created facet. Makes all border halfedges of the hole denoted by `h` incident to the new facet. Returns `h`. @@ -1390,7 +1390,7 @@ n */ */ Halfedge_handle fill_hole( Halfedge_handle h); - /*! + /*! creates a new facet within the hole incident to `h` and `g` by connecting the tip of `g` with the tip of `h` with two new halfedges and a new vertex and filling this separated @@ -1404,7 +1404,7 @@ n */ Halfedge_handle add_vertex_and_facet_to_border( Halfedge_handle h, Halfedge_handle g); - /*! + /*! creates a new facet within the hole incident to `h` and `g` by connecting the vertex denoted by `g` with the vertex denoted by `h` with a new halfedge and filling this separated part of the hole with @@ -1423,7 +1423,7 @@ n */ /// \name Erasing /// @{ - /*! + /*! removes the incident facet of `h` and changes all halfedges incident to the facet into border edges or removes them from the polyhedral surface if they were already border edges. @@ -1439,7 +1439,7 @@ n */ */ void erase_facet( Halfedge_handle h); - /*! + /*! removes the vertices, halfedges, and facets that belong to the connected component of `h`. @@ -1447,7 +1447,7 @@ n */ */ void erase_connected_component( Halfedge_handle h); - /*! + /*! 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). @@ -1456,7 +1456,7 @@ n */ */ unsigned int keep_largest_connected_components(unsigned int nb_components_to_keep); - /*! + /*! removes all vertices, halfedges, and facets. */ void clear(); @@ -1489,7 +1489,7 @@ n */ */ /// @{ - /*! + /*! sorts halfedges such that the non-border edges precede the border edges. For each border edge the halfedge iterator will reference the halfedge incident to the facet right before the @@ -1497,13 +1497,13 @@ n */ */ void normalize_border(); - /*! + /*! number of border halfedges. \pre last `normalize_border()` call still valid, see above. */ size_type size_of_border_halfedges() const; - /*! + /*! number of border edges. Since each border edge of a polyhedral surface has exactly one border halfedge, this number is equal to `size_of_border_halfedges()`. @@ -1511,7 +1511,7 @@ n */ */ size_type size_of_border_edges() const; - /*! + /*! halfedge iterator starting with the border edges. The range [`halfedges_begin(), border_halfedges_begin()`) denotes all non-border halfedges. The range @@ -1521,7 +1521,7 @@ n */ */ Halfedge_iterator border_halfedges_begin(); - /*! + /*! edge iterator starting with the border edges. The range [`edges_begin(), border_edges_begin()`) denotes all non-border edges. The range @@ -1536,12 +1536,12 @@ n */ /// \name Miscellaneous /// @{ - /*! + /*! reverses facet orientations (incl.\ plane equations if supported). */ void inside_out(); - /*! + /*! returns `true` if the polyhedral surface is combinatorially consistent. If `verbose` is `true`, statistics are printed to `cerr`. For `level == 1` the normalization of the @@ -1553,7 +1553,7 @@ n */ */ bool is_valid( bool verbose = false, int level = 0) const; - /*! + /*! returns `true` if the border halfedges are in normalized representation, which is when enumerating all halfedges with the iterator: The non-border edges precede the border edges and for @@ -1565,7 +1565,7 @@ n */ */ bool normalized_border_is_valid( bool verbose = false) const; - /*! + /*! \cgalAdvancedFunction \cgalAdvancedBegin calls the `Modifier_base::operator()()` of the modifier `m`. diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h index ef12d3f15e7..8b66073d83b 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_incremental_builder_3.h @@ -65,32 +65,32 @@ public: /// \name Types /// @{ -/*! +/*! halfedge data structure `HDS`. */ typedef unspecified_type HalfedgeDS; -/*! +/*! point type of the vertex. */ typedef unspecified_type Point_3; -/*! +/*! size type. */ typedef unspecified_type size_type; -/*! +/*! */ typedef typename HalfedgeDS::Vertex_handle Vertex_handle; -/*! +/*! */ typedef typename HalfedgeDS::Halfedge_handle Halfedge_handle; -/*! +/*! */ typedef typename HalfedgeDS::Face_handle Facet_handle; @@ -100,7 +100,7 @@ typedef typename HalfedgeDS::Face_handle Facet_handle; /// \name Constants /// @{ -/*! +/*! two different indexing modes. */ enum { RELATIVE_INDEXING, ABSOLUTE_INDEXING}; @@ -110,7 +110,7 @@ enum { RELATIVE_INDEXING, ABSOLUTE_INDEXING}; /// \name Creation /// @{ -/*! +/*! stores a reference to the halfedge data structure `hds` of a polyhedral surface in its internal state. An existing polyhedral surface in `hds` remains unchanged. The incremental builder @@ -136,7 +136,7 @@ begin_surface ( add_vertex | ( begin_facet add_vertex_to_facet end_facet ) ) */ /// @{ -/*! +/*! starts the construction. `v` is the number of new vertices to expect, `f` the number of new facets, and `h` the number of new halfedges. If `h` is unspecified (`== 0`) it is estimated using @@ -156,19 +156,19 @@ starting with new indices for the new construction. void begin_surface( size_type v, size_type f, size_type h = 0, int mode = RELATIVE_INDEXING); -/*! +/*! adds a new vertex for `p` and returns its handle. */ Vertex_handle add_vertex( const Point_3& p); -/*! +/*! starts a new facet and returns its handle. */ Facet_handle begin_facet(); -/*! +/*! adds a vertex with index `i` to the current facet. The first point added with `add_vertex()` has the index 0 if `mode` was set to @@ -177,7 +177,7 @@ referenced `hds` has the index 0. */ void add_vertex_to_facet( size_type i); -/*! +/*! ends a newly constructed facet. Returns the handle to the halfedge incident to the new facet that points to the vertex added first. The halfedge can be safely used to traverse @@ -185,7 +185,7 @@ the halfedge cycle around the new facet. */ Halfedge_handle end_facet(); -/*! +/*! ends the construction. */ void end_surface(); @@ -195,7 +195,7 @@ void end_surface(); /// \name Additional Operations /// @{ -/*! +/*! is a synonym for `begin_facet()`, a call to `add_vertex_to_facet()` for each value in the range `[first,beyond)`, and a call to `end_facet()`. @@ -205,7 +205,7 @@ Returns the return value of `end_facet()`. template Halfedge_handle add_facet( InputIterator first, InputIterator beyond); -/*! +/*! returns `true` if a facet described by the vertex indices in the range `[first,beyond)` can be successfully inserted, e.g., with @@ -215,19 +215,19 @@ returns `true` if a facet described by the vertex indices in the range template bool test_facet( InputIterator first, InputIterator beyond); -/*! +/*! returns handle for the vertex of index `i`, or `Vertex_handle` if there is no `i`-th vertex. */ Vertex_handle vertex( std::size_t i); -/*! +/*! returns error status of the builder. */ bool error() const; -/*! +/*! undoes all changes made to the halfedge data structure since the last `begin_surface()` in relative indexing, and deletes the whole surface in absolute indexing. @@ -235,7 +235,7 @@ It needs a new call to `begin_surface()` to start inserting again. */ void rollback(); -/*! +/*! returns `true` if unconnected vertices are detected. If `verbose` was set to `true` (see the constructor above) debug information about the @@ -243,7 +243,7 @@ unconnected vertices is printed. */ bool check_unconnected_vertices(); -/*! +/*! returns `true` if all unconnected vertices could be removed successfully. This happens either if no unconnected vertices had appeared or if the diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h index 4065834d746..a67ea634e7d 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_items_3.h @@ -39,13 +39,13 @@ public: /// @{ `Polyhedron_items_3::Vertex_wrapper::Vertex` -/*! +/*! */ typedef Traits::Point_3 Point; `Polyhedron_items_3::Vertex_wrapper::Vertex` -/*! +/*! */ typedef CGAL::Tag_true Supports_vertex_point; @@ -55,12 +55,12 @@ typedef CGAL::Tag_true Supports_vertex_point; /// \name Types in Polyhedron_items_3::Face_wrapper::Face /// @{ -/*! +/*! */ typedef Traits::Plane_3 Plane; -/*! +/*! */ typedef CGAL::Tag_true Supports_face_plane; @@ -70,7 +70,7 @@ typedef CGAL::Tag_true Supports_face_plane; /// \name Creation /// @{ -/*! +/*! default constructor. */ Polyhedron_items_3(); diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h index bfba15d2eb1..122d5d5ff96 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_min_items_3.h @@ -27,13 +27,13 @@ public: /// @{ `Polyhedron_min_items_3::Vertex_wrapper::Vertex` -/*! +/*! */ typedef Traits::Point_3 Point; `Polyhedron_min_items_3::Vertex_wrapper::Vertex` -/*! +/*! */ typedef CGAL::Tag_true Supports_vertex_point; @@ -43,7 +43,7 @@ typedef CGAL::Tag_true Supports_vertex_point; /// \name Types in Polyhedron_min_items_3::Face_wrapper::Face /// @{ -/*! +/*! */ typedef CGAL::Tag_false Supports_face_plane; @@ -53,7 +53,7 @@ typedef CGAL::Tag_false Supports_face_plane; /// \name Creation /// @{ -/*! +/*! default constructor. */ Polyhedron_min_items_3(); diff --git a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h index ee6e38ed166..68df4c08d0d 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_3.h @@ -36,22 +36,22 @@ public: /// \name Types /// @{ -/*! +/*! the `Kernel` model. */ typedef unspecified_type Kernel; -/*! +/*! */ typedef Kernel::Point_3 Point_3; -/*! +/*! */ typedef Kernel::Plane_3 Plane_3; -/*! +/*! */ typedef Kernel::Construct_opposite_plane_3 @@ -62,13 +62,13 @@ Construct_opposite_plane_3; /// \name Creation /// @{ -/*! +/*! default constructor, uses `Kernel()` as local reference to the kernel. */ Polyhedron_traits_3(); -/*! +/*! stores `kernel` as local reference. */ @@ -79,7 +79,7 @@ Polyhedron_traits_3( const Kernel& kernel); /// \name Operations /// @{ -/*! +/*! forwarded to `kernel`. */ 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 ffff91766a0..ab00f7f5e17 100644 --- a/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h +++ b/Polyhedron/doc/Polyhedron/CGAL/Polyhedron_traits_with_normals_3.h @@ -33,22 +33,22 @@ public: /// \name Types /// @{ -/*! +/*! the `Kernel` model. */ typedef unspecified_type Kernel; -/*! +/*! */ typedef Kernel::Point_3 Point_3; -/*! +/*! */ typedef Kernel::Vector_3 Plane_3; -/*! +/*! */ typedef Kernel::Construct_opposite_vector_3 @@ -59,13 +59,13 @@ Construct_opposite_plane_3; /// \name Creation /// @{ -/*! +/*! default constructor, uses `Kernel()` as local reference to the kernel. */ Polyhedron_traits_with_normals_3(); -/*! +/*! stores `kernel` as local reference. */ Polyhedron_traits_with_normals_3( const Kernel& kernel); @@ -75,7 +75,7 @@ Polyhedron_traits_with_normals_3( const Kernel& kernel); /// \name Operations /// @{ -/*! +/*! forwarded to `kernel`. */ diff --git a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h index 5d057321bf5..d483d09f5ef 100644 --- a/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h +++ b/Polyhedron/doc/Polyhedron/Concepts/PolyhedronTraits_3.h @@ -25,19 +25,19 @@ public: /// \name Types /// @{ -/*! +/*! point type. */ typedef unspecified_type Point_3; -/*! +/*! plane equation. Even if plane equations are not supported with a particular polyhedral surface this type has to be defined (some dummy type). */ typedef unspecified_type Plane_3; -/*! +/*! is an unary function object that reverses the plane orientation. Must provide `Plane_3 operator()(Plane_3 plane)` that returns the reversed plane. Required only if plane equations are supported and the `inside_out()` @@ -50,13 +50,13 @@ typedef unspecified_type Construct_opposite_plane_3; /// \name Creation /// @{ -/*! +/*! copy constructor. */ PolyhedronTraits_3( const PolyhedronTraits_3& traits2); -/*! +/*! assignment. */ @@ -67,7 +67,7 @@ PolyhedronTraits_3& operator= ( const PolyhedronTraits_3& traits2); /// \name Operations /// @{ -/*! +/*! returns an instance of this function object. */ diff --git a/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h b/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h index 01d3988a9f4..93db880a3f2 100644 --- a/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h +++ b/Polynomial/doc/Polynomial/CGAL/Exponent_vector.h @@ -38,43 +38,43 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Exponent_vector(); -/*! +/*! The copy constructor. */ Exponent_vector(const Exponent_vector & ev_); -/*! +/*! Creates a vector containing the given element. */ Exponent_vector(int e1); -/*! +/*! Creates a vector containing the given elements. */ Exponent_vector(int e1, int e2); -/*! +/*! Creates a vector containing the given elements. */ Exponent_vector(int e1, int e2, int e3); -/*! +/*! Creates a vector containing the given elements. */ Exponent_vector(int e1, int e2, int e3, int e4); -/*! +/*! Creates a vector with a copy of the given range. \pre `InputIterator` must allow the value type `int`. @@ -88,24 +88,24 @@ Exponent_vector(InputIterator begin, InputIterator end); /// \name Operations /// @{ -/*! +/*! */ Exponent_vector operator+(const Exponent_vector &ev1); -/*! +/*! */ Exponent_vector operator-(const Exponent_vector &ev1); -/*! +/*! \pre ev1.size() == ev2.size(). */ Exponent_vector operator+(const Exponent_vector &ev1, const Exponent_vector &ev2); -/*! +/*! \pre ev1.size() == ev2.size() @@ -113,7 +113,7 @@ operator+(const Exponent_vector &ev1, const Exponent_vector &ev2); Exponent_vector operator-(const Exponent_vector &ev1, const Exponent_vector &ev2); -/*! +/*! \pre `fo`.size() == ev2.size() @@ -121,7 +121,7 @@ operator-(const Exponent_vector &ev1, const Exponent_vector &ev2); Exponent_vector operator+=(const Exponent_vector &ev2); -/*! +/*! \pre `fo`.size() == ev2.size() @@ -129,19 +129,19 @@ operator+=(const Exponent_vector &ev2); Exponent_vector operator-=(const Exponent_vector &ev2); -/*! +/*! */ bool operator==(const Exponent_vector &ev1, const Exponent_vector &ev2); -/*! +/*! */ bool operator!=(const Exponent_vector &ev1, const Exponent_vector &ev2); -/*! +/*! Lexicographic compare, starting with the last variable. */ @@ -152,7 +152,7 @@ operator<(const Exponent_vector &ev1, const Exponent_vector &ev2); }; /* end Exponent_vector */ -/*! +/*! Returns true if all entries of exponent vector `ev` are not negative. \relates Exponent_vector */ diff --git a/Polynomial/doc/Polynomial/CGAL/Polynomial.h b/Polynomial/doc/Polynomial/CGAL/Polynomial.h index cac04ce1bb0..07231c3e767 100644 --- a/Polynomial/doc/Polynomial/CGAL/Polynomial.h +++ b/Polynomial/doc/Polynomial/CGAL/Polynomial.h @@ -71,27 +71,27 @@ public: /// \name Creation /// @{ -/*! +/*! Introduces an variable initialized with 0. */ Polynomial (); -/*! +/*! copy constructor. */ Polynomial (const Polynomial& x); -/*! +/*! Constructor from int. */ Polynomial (const int &i); -/*! +/*! Constructor from type Coeff. */ Polynomial (const Coeff &x); -/*! +/*! Constructor from iterator range with value type Coeff. */ template @@ -102,27 +102,27 @@ Polynomial(Forward_iterator first, Forward_iterator last); /// \name Operations /// @{ -/*! +/*! A const random access iterator pointing to the constant coefficient. */ const_iterator begin() const; -/*! +/*! A const random access iterator pointing beyond the leading coefficient. */ const_iterator end() const; -/*! +/*! The degree of the polynomial in \f$ x\f$. The degree of the zero polynomial is 0. */ int degree() const; -/*! +/*! Const access to the coefficient of \f$ x^i\f$. */ const NT& operator[](unsigned int i) const; -/*! +/*! Const access to the leading coefficient. */ const NT& lcoeff() const; @@ -132,7 +132,7 @@ const NT& lcoeff() const; }; /* end Polynomial */ -/*! +/*! Writes `poly` to ostream `os`. The format depends on the `CGAL::IO::MODE` of `os`. In case the mode is `CGAL::IO::ASCII` the format is \f$ P[d(0,a_0)(1,a_1)\dots(d,a_d)]\f$, @@ -144,7 +144,7 @@ In case the mode is `CGAL::IO::PRETTY` the format is human readable. std::ostream& operator<<(std::ostream& os, const Polynomial &poly); -/*! +/*! Reads `poly` from istream `is` in format \f$ P[d(0,a_0)(1,a_1)\dots(d,a_d)]\f$, the output format in mode `CGAL::IO::ASCII`. \relates Polynomial diff --git a/Polynomial/doc/Polynomial/CGAL/Polynomial_type_generator.h b/Polynomial/doc/Polynomial/CGAL/Polynomial_type_generator.h index 836ee290fd3..5ce7b14122f 100644 --- a/Polynomial/doc/Polynomial/CGAL/Polynomial_type_generator.h +++ b/Polynomial/doc/Polynomial/CGAL/Polynomial_type_generator.h @@ -20,7 +20,7 @@ public: /// \name Types /// @{ -/*! +/*! The generated type. */ typedef unspecified_type Type; diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h index fa9329adcf2..3e5844afeb6 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Canonicalize.h @@ -35,12 +35,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -50,7 +50,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns the canonical representative of \f$ p\f$. */ diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h index 98b5ea0e759..6b4e302f7d5 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Compare.h @@ -24,17 +24,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Comparison_result result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d second_argument_type; @@ -44,7 +44,7 @@ typedef PolynomialTraits_d::Polynomial_d second_argument_type; /// \name Operations /// @{ -/*! +/*! Compares two polynomials. */ result_type operator()(first_argument_type f, diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h index 04fbef006bd..2526b9964e6 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructCoefficientConstIteratorRange.h @@ -22,14 +22,14 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair< PolynomialTraits_d::Coefficient_const_iterator, PolynomialTraits_d::Coefficient_const_iterator > result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -39,7 +39,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns a const iterator range over the coefficients of \f$ p\f$. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h index cc9f447da32..7223ba22f0e 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructInnermostCoefficientConstIteratorRange.h @@ -21,14 +21,14 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef std::pair< PolynomialTraits_d::Innermost_coefficient_const_iterator, PolynomialTraits_d::Innermost_coefficient_const_iterator > result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -38,7 +38,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns a const iterator range over all innermost coefficients of \f$ p\f$. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h index 07720432b89..29743921de0 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ConstructPolynomial.h @@ -21,7 +21,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; @@ -31,29 +31,29 @@ typedef PolynomialTraits_d::Polynomial_d result_type; /// \name Operations /// @{ -/*! +/*! Construct the zero polynomial. */ result_type operator()(); -/*! +/*! Construct the constant polynomial equal to \f$ i\f$. */ result_type operator()(int i); -/*! +/*! Construct the constant polynomial equal to \f$ a\f$. */ result_type operator() (PolynomialTraits_d::Innermost_coefficient_type a); -/*! +/*! Construct the polynomial equal to \f$ a\f$. */ result_type operator() (PolynomialTraits_d::Coefficient_type a); -/*! +/*! \pre The value type of `InputIterator` is `PolynomialTraits_d::Coefficient_type`. The operator constructs the a polynomial from the iterator range, @@ -67,7 +67,7 @@ In case the range is empty, the zero polynomial is constructed. template < class InputIterator > result_type operator()(InputIterator begin, InputIterator end); -/*! +/*! Constructs a `Polynomial_d` from a given iterator range of `std::pair`. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h index 87a87ba9d62..a43bdc62961 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Degree.h @@ -33,12 +33,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef int result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -48,12 +48,12 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Computes the degree of \f$ p\f$ with respect to the outermost variable \f$ x_{d-1}\f$. */ result_type operator()(argument_type p); -/*! +/*! Computes the degree of \f$ p\f$ with respect to variable \f$ x_i\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h index 0591ee78e48..2b42587d538 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--DegreeVector.h @@ -28,12 +28,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Exponent_vector result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -43,7 +43,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns the degree vector. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h index 31bfcf997f3..a10ae0680f9 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Differentiate.h @@ -21,12 +21,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -36,12 +36,12 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p'\f$, with respect to the outermost variable. */ result_type operator()(argument_type p); -/*! +/*! Returns \f$ p'\f$, with respect to variable \f$ x_i\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h index 6eb37dbe5b2..71eb806b8b7 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Evaluate.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type second_argument_type; @@ -41,7 +41,7 @@ typedef PolynomialTraits_d::Coefficient_type second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p(x)\f$, with respect to the outermost variable. */ result_type operator()(first_argument_type p, diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h index 3a850344483..890e40b2f94 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--EvaluateHomogeneous.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type result_type; @@ -35,7 +35,7 @@ typedef PolynomialTraits_d::Coefficient_type result_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p(u,v)\f$, with respect to the outermost variable. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h index ce67f0b7826..07165c12aec 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GcdUpToConstantFactor.h @@ -36,17 +36,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d second_argument_type; @@ -56,7 +56,7 @@ typedef PolynomialTraits_d::Polynomial_d second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes \f$ gcd(f,g)\f$ up to a constant factor. */ result_type operator()(first_argument_type f, diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h index e6e63fe7f17..c51c507a80d 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetCoefficient.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type ; -/*! +/*! */ typedef int second_argument_type; @@ -41,7 +41,7 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! For given polynomial \f$ p\f$ this operator returns the coefficient of \f$ x_{d-1}^e\f$, where \f$ x_{d-1}\f$ is the outermost variable. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h index fa9317e2df7..324c6c7379f 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--GetInnermostCoefficient.h @@ -22,17 +22,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Innermost_coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type ; -/*! +/*! */ typedef CGAL::Exponent_vector second_argument_type; @@ -42,7 +42,7 @@ typedef PolynomialTraits_d::Polynomial_d first_argument_type ; /// \name Operations /// @{ -/*! +/*! For given polynomial \f$ p\f$ this operator returns the innermost coefficient of the monomial corresponding to the given `CGAL::Exponent_vector` \f$ v\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h index 3cf9e6a27b8..2a98f391b11 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--InnermostLeadingCoefficient.h @@ -21,12 +21,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Innermost_coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -36,7 +36,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Computes the innermost leading coefficient of \f$ p\f$. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h index 7fce96a1510..6066e5668d8 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IntegralDivisionUpToConstantFactor.h @@ -25,17 +25,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d second_argument_type; @@ -45,7 +45,7 @@ typedef PolynomialTraits_d::Polynomial_d second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes \f$ f/g\f$ up to a constant factor. */ result_type operator()(first_argument_type f, diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h index 8322d5827d8..aeb19c3dd5b 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Invert.h @@ -28,12 +28,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -43,7 +43,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ x^{degree(p)}p(1/x)\f$, where x refers to the outermost variable \f$ x_{d-1}\f$. @@ -51,7 +51,7 @@ where x refers to the outermost variable \f$ x_{d-1}\f$. */ result_type operator()(argument_type p); -/*! +/*! Return \f$ x^{degree(p,i)}p(1/x)\f$, where x refers to the variable \f$ x_{i}\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h index 6121e543ebf..67930834787 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsSquareFree.h @@ -28,12 +28,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -43,7 +43,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns whether the \f$ p\f$ is square free. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h index 3ff631bb929..f77523f6465 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAt.h @@ -22,7 +22,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; @@ -32,7 +32,7 @@ typedef bool result_type; /// \name Operations /// @{ -/*! +/*! Computes whether \f$ p\f$ is zero at the Cartesian point given by the iterator range, where `begin` is referring to the innermost variable. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h index c16968f12f6..11678fbbf4b 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--IsZeroAtHomogeneous.h @@ -27,7 +27,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef bool result_type; @@ -37,7 +37,7 @@ typedef bool result_type; /// \name Operations /// @{ -/*! +/*! Computes whether \f$ p\f$ is zero at the homogeneous point given by the iterator range, where `begin` is referring to the innermost variable. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h index 891dab41c94..edc4b655777 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--LeadingCoefficient.h @@ -21,12 +21,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -36,7 +36,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Computes the leading coefficient of \f$ p\f$ with respect to the outermost variable \f$ x_{d-1}\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h index d6fa8dc0161..45037a9f87e 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MakeSquareFree.h @@ -32,12 +32,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -47,7 +47,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns the square-free part of \f$ p\f$. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h index 4c7e7b6c954..51ee40588f8 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MonomialRepresentation.h @@ -24,7 +24,7 @@ public: /// \name Operations /// @{ -/*! +/*! Writes the monom representation of \f$ p\f$ into the given output iterator \f$ it\f$. \pre `std::iterator_traits< OutputIterator >::%value_type` must be constructible from `std::pair`. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h index b64834e7f7c..163f7700329 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Move.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; @@ -35,7 +35,7 @@ typedef PolynomialTraits_d::Polynomial_d result_type; /// \name Operations /// @{ -/*! +/*! This function moves the variable at position \f$ i\f$ to its new position \f$ j\f$ and returns the new polynomial. The relative order of the other variables is preserved. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h index c3f7dff9257..82f6de39884 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--MultivariateContent.h @@ -25,12 +25,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Innermost_coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -40,7 +40,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Computes the \f$ gcd\f$ of all innermost coefficients of \f$ p\f$. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h index b8db5453430..d5cf925ca22 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Negate.h @@ -26,12 +26,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -41,12 +41,12 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p(-x)\f$, with respect to the outermost variable. */ result_type operator()(argument_type p); -/*! +/*! Returns \f$ p(-x)\f$, with respect to variable \f$ x_i\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h index 0eb71499310..10b4afba161 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Permute.h @@ -30,7 +30,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; @@ -40,7 +40,7 @@ typedef PolynomialTraits_d::Polynomial_d result_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p\f$ with interchanged variables as defined by the iterator range. \pre (end-begin == `PolynomialTraits_d::d`) diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h index d4cfee7f78d..ec5756a5cf2 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultants.h @@ -41,7 +41,7 @@ public: /// \name Operations /// @{ -/*! +/*! computes the polynomial subresultants of \f$ p\f$ and \f$ q\f$, with respect to the outermost variable. Each element is of type `PolynomialTraits_d::Polynomial_d`. @@ -51,7 +51,7 @@ OutputIterator operator()(Polynomial_d p, Polynomial_d q, OutputIterator out); -/*! +/*! computes the polynomial subresultants of \f$ p\f$ and \f$ q\f$, with respect to the variable \f$ x_i\f$. */ diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h index 357776f65ac..b1981463df7 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PolynomialSubresultantsWithCofactors.h @@ -35,7 +35,7 @@ public: /// \name Operations /// @{ -/*! +/*! computes the subresultants of \f$ p\f$ and \f$ q\f$, and the cofactors, with respect to the outermost variable. Each element is of type `PolynomialTraits_d::Polynomial_d`. @@ -49,7 +49,7 @@ OutputIterator1 sres, OutputIterator2 co_p, OutputIterator3 co_q); -/*! +/*! computes the subresultants of \f$ p\f$ and \f$ q\f$, and the cofactors, with respect to \f$ x_i\f$. Each element is of type `PolynomialTraits_d::Polynomial_d`. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h index c95832dcf65..bd4bd491935 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSturmHabichtSequence.h @@ -38,7 +38,7 @@ public: /// \name Operations /// @{ -/*! +/*! computes the principal coefficients of the Sturm-Habicht sequence of \f$ f\f$, with respect to the outermost variable. Each element is of type @@ -48,7 +48,7 @@ template OutputIterator operator()(Polynomial_d f, OutputIterator out); -/*! +/*! computes the principal coefficients of the Sturm-Habicht sequence of \f$ f\f$ with respect to the variable \f$ x_i\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h index 4e1139b09da..2cddb81e1ed 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PrincipalSubresultants.h @@ -37,7 +37,7 @@ public: /// \name Operations /// @{ -/*! +/*! computes the principal subresultants of \f$ p\f$ and \f$ q\f$, with respect to the outermost variable. Each element is of type `PolynomialTraits_d::Coefficient_type`. @@ -47,7 +47,7 @@ OutputIterator operator()(Polynomial_d p, Polynomial_d q, OutputIterator out); -/*! +/*! computes the principal subresultants of \f$ p\f$ and \f$ q\f$, with respect to the variable \f$ x_i\f$. */ diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h index 8eb1e2d1cec..b5bc9766163 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivision.h @@ -34,7 +34,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef void result_type; @@ -44,7 +44,7 @@ typedef void result_type; /// \name Operations /// @{ -/*! +/*! Computes the pseudo division with respect to the outermost variable \f$ x_{d-1}\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h index c3cffed12a2..3c5778335a4 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionQuotient.h @@ -30,17 +30,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d second_argument_type; @@ -50,7 +50,7 @@ typedef PolynomialTraits_d::Polynomial_d second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns the quotient \f$ q\f$ of the pseudo division of \f$ f\f$ and \f$ g\f$ with respect to the outermost variable \f$ x_{d-1}\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h index c70fbe5af2c..207600aece3 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--PseudoDivisionRemainder.h @@ -30,17 +30,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d second_argument_type; @@ -50,7 +50,7 @@ typedef PolynomialTraits_d::Polynomial_d second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns the remainder \f$ r\f$ of the pseudo division of \f$ f\f$ and \f$ g\f$ with respect to the outermost variable \f$ x_{d-1}\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h index a593c959b62..fd896198a1a 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Resultant.h @@ -61,17 +61,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d second_argument_type; @@ -81,7 +81,7 @@ typedef PolynomialTraits_d::Polynomial_d second_argument_type; /// \name Operations /// @{ -/*! +/*! Computes the resultant of \f$ f\f$ and \f$ g\f$, with respect to the outermost variable. */ diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h index b9fd76f1c77..c6aaa6fe37b 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Scale.h @@ -25,17 +25,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Innermost_coefficient_type second_argument_type; @@ -45,13 +45,13 @@ typedef PolynomialTraits_d::Innermost_coefficient_type second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p(c\cdot x)\f$, with respect to the outermost variable. */ result_type operator()(first_argument_type p, second_argument_type c); -/*! +/*! Same as first operator but for variable \f$ x_i\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h index 4b5546ac4c2..a5d0a91a87e 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--ScaleHomogeneous.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; @@ -35,7 +35,7 @@ typedef PolynomialTraits_d::Polynomial_d result_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ b^{degree}\cdot p(a/b\cdot x)\f$, with respect to the outermost variable. */ @@ -43,7 +43,7 @@ result_type operator()(PolynomialTraits_d::Polynomial_d p, PolynomialTraits_d::Innermost_coefficient_type a, PolynomialTraits_d::Innermost_coefficient_type b); -/*! +/*! Same as first operator but for variable \f$ x_i\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h index 932b61bf5a4..51a456e14f0 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Shift.h @@ -24,17 +24,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef int second_argument_type; @@ -44,14 +44,14 @@ typedef int second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p * x_{d-1}^e\f$. \pre \f$ 0 \leq e\f$. */ result_type operator()(first_argument_type p, second_argument_type e); -/*! +/*! Returns \f$ p * x_{i}^e\f$. \pre \f$ 0 \leq e\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h index 07e268ceab5..26c472dd040 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAt.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Sign result_type; @@ -35,7 +35,7 @@ typedef CGAL::Sign result_type; /// \name Operations /// @{ -/*! +/*! Returns the sign of \f$ p\f$ at the given Cartesian point, where `begin` is referring to the innermost variable. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h index 9024624b101..806bef840c0 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SignAtHomogeneous.h @@ -30,7 +30,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Sign result_type; @@ -40,7 +40,7 @@ typedef CGAL::Sign result_type; /// \name Operations /// @{ -/*! +/*! Returns the sign of \f$ p\f$ at the given homogeneous point, where `begin` is referring to the innermost variable. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h index 9f3b85d33f3..8090e973758 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorize.h @@ -33,7 +33,7 @@ public: /// \name Operations /// @{ -/*! +/*! Computes the square-free factorization of \f$ p\f$ and returns the past-the-end iterator of the written range. \pre `std::iterator_traits< OutputIterator >::%value_type` must be constructible from `std::pair`. @@ -44,7 +44,7 @@ OutputIterator operator()(PolynomialTraits_d::Polynomial_d p, OutputIterator it, PolynomialTraits_d::Innermost_coefficient_type& a); -/*! +/*! As the first operator, just not computing the factor \f$ a\f$. */ template diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h index 475b13e0cb2..5fb61e6a569 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SquareFreeFactorizeUpToConstantFactor.h @@ -35,7 +35,7 @@ public: /// \name Operations /// @{ -/*! +/*! Computes the square-free factorization of \f$ p\f$ and returns the past-the-end iterator of the written range. \pre `std::iterator_traits< OutputIterator >::%value_type` must be constructible from `std::pair`. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h index b878f891912..201bbfba5e9 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequence.h @@ -45,7 +45,7 @@ public: /// \name Operations /// @{ -/*! +/*! computes the Sturm-Habicht sequence of \f$ f\f$, with respect to the outermost variable. Each element is of type `PolynomialTraits_d::Polynomial_d`. @@ -54,7 +54,7 @@ template OutputIterator operator()(Polynomial_d f, OutputIterator out); -/*! +/*! computes the Sturm-Habicht sequence of \f$ f\f$ with respect to the variable \f$ x_i\f$. */ diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h index ae30a22c11f..e77f9b78cd2 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SturmHabichtSequenceWithCofactors.h @@ -35,7 +35,7 @@ public: /// \name Operations /// @{ -/*! +/*! computes the Sturm-Habicht sequence of \f$ f\f$, and the cofactors, with respect to the outermost variable. Each element is of type `PolynomialTraits_d::Polynomial_d`. @@ -48,7 +48,7 @@ OutputIterator1 stha, OutputIterator2 co_f, OutputIterator3 co_fx); -/*! +/*! computes the Sturm-Habicht sequence of \f$ f\f$, and the cofactors, with respect to \f$ x_i\f$. Each element is of type `PolynomialTraits_d::Polynomial_d`. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h index 9e96a1bb170..874f4fb388b 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Substitute.h @@ -32,7 +32,7 @@ public: /// \name Operations /// @{ -/*! +/*! Substitutes each variable of \f$ p\f$ by the values given in the iterator range, where begin refers to the innermost variable \f$ x_0\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h index 193b4c62e2d..954dc924e60 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--SubstituteHomogeneous.h @@ -38,7 +38,7 @@ public: /// \name Operations /// @{ -/*! +/*! Substitutes each variable of \f$ p\f$ by the values given in the iterator range, where \f$ p\f$ is interpreted as a homogeneous polynomial in all variables. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h index 4717432a066..44d158b299c 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Swap.h @@ -20,7 +20,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; @@ -30,7 +30,7 @@ typedef PolynomialTraits_d::Polynomial_d result_type; /// \name Operations /// @{ -/*! +/*! Returns polynomial \f$ p\f$ with interchanged variables \f$ x_i\f$,\f$ x_j\f$. \pre \f$ 0 \leq i < d\f$. \pre \f$ 0 \leq j < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h index 38752332b7c..15c66e37434 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TotalDegree.h @@ -34,12 +34,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef int result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -49,7 +49,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Computes the total degree of \f$ p\f$. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h index 59de09d4055..f4f3b7a222b 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--Translate.h @@ -25,17 +25,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d first_argument_type; -/*! +/*! */ typedef PolynomialTraits_d::Innermost_coefficient_type second_argument_type; @@ -45,13 +45,13 @@ typedef PolynomialTraits_d::Innermost_coefficient_type second_argument_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ p(x+c)\f$, with respect to the outermost variable. */ result_type operator()(first_argument_type p, second_argument_type c); -/*! +/*! Same as first operator but for variable \f$ x_i\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h index 9b5a3a8845b..b1d7d6dcb3e 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--TranslateHomogeneous.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d result_type; @@ -35,7 +35,7 @@ typedef PolynomialTraits_d::Polynomial_d result_type; /// \name Operations /// @{ -/*! +/*! Returns \f$ b^{degree(p)}\cdot p(x+a/b)\f$, with respect to the outermost variable. */ @@ -43,7 +43,7 @@ result_type operator()(PolynomialTraits_d::Polynomial_d p, PolynomialTraits_d::Innermost_coefficient_type a, PolynomialTraits_d::Innermost_coefficient_type b); -/*! +/*! Same as first operator but for variable \f$ x_i\f$. \pre \f$ 0 \leq i < d\f$. diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h index 8eb86dbbce7..bbbd9f54a32 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContent.h @@ -27,12 +27,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -42,7 +42,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Computes the content of \f$ p\f$ with respect to the outermost variable \f$ x_{d-1}\f$. */ result_type operator()(argument_type p); diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h index 9f8bb1160ea..1b93f320bce 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d--UnivariateContentUpToConstantFactor.h @@ -31,12 +31,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef PolynomialTraits_d::Coefficient_type result_type; -/*! +/*! */ typedef PolynomialTraits_d::Polynomial_d argument_type; @@ -46,7 +46,7 @@ typedef PolynomialTraits_d::Polynomial_d argument_type; /// \name Operations /// @{ -/*! +/*! Computes the content up to a constant factor of \f$ p\f$ with respect to the outermost variable \f$ x_{d-1}\f$. */ diff --git a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h index de229269e3a..e9897f9423d 100644 --- a/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h +++ b/Polynomial/doc/Polynomial/Concepts/PolynomialTraits_d.h @@ -41,7 +41,7 @@ public: /// \name Constants /// @{ -/*! +/*! The dimension and the number of variables respectively. */ static const int d; @@ -51,32 +51,32 @@ static const int d; /// \name Types /// @{ -/*! +/*! Type representing \f$ R[x_0,\dots,x_{d-1}]\f$. */ typedef unspecified_type Polynomial_d; -/*! +/*! Type representing \f$ R[x_0,\dots,x_{d-2}]\f$. */ typedef unspecified_type Coefficient_type ; -/*! +/*! Type representing the base ring \f$ R\f$. */ typedef unspecified_type Innermost_coefficient_type; -/*! +/*! Const iterator used to iterate through all coefficients of the polynomial. */ typedef unspecified_type Coefficient_const_iterator; -/*! +/*! Const iterator used to iterate through all innermost coefficients of the polynomial. */ typedef unspecified_type Innermost_coefficient_const_iterator; -/*! +/*! This template class has to define a type `Rebind::%Other` which is a model of the concept `PolynomialTraits_d`, where `d` is the number of variables and `T` the `Innermost_coefficient_type`. @@ -91,109 +91,109 @@ using Rebind = unspecified_type; /// In case a functor is not provided it is set to `CGAL::Null_functor`. /// @{ -/*! +/*! A model of `PolynomialTraits_d::ConstructPolynomial`. */ typedef unspecified_type Construct_polynomial; -/*! +/*! A model of `PolynomialTraits_d::GetCoefficient`. */ typedef unspecified_type Get_coefficient; -/*! +/*! A model of `PolynomialTraits_d::GetInnermostCoefficient`. */ typedef unspecified_type Get_innermost_coefficient; -/*! +/*! A model of `PolynomialTraits_d::ConstructCoefficientConstIteratorRange`. */ typedef unspecified_type Construct_coefficient_const_iterator_range; -/*! +/*! A model of `PolynomialTraits_d::ConstructInnermostCoefficientConstIteratorRange`. */ typedef unspecified_type Construct_innermost_coefficient_const_iterator_range; -/*! +/*! A model of `PolynomialTraits_d::Swap`. */ typedef unspecified_type Swap; -/*! +/*! A model of `PolynomialTraits_d::Move`. */ typedef unspecified_type Move; -/*! +/*! A model of `PolynomialTraits_d::Degree`. */ typedef unspecified_type Degree; -/*! +/*! A model of `PolynomialTraits_d::TotalDegree`. */ typedef unspecified_type Total_degree; -/*! +/*! A model of `PolynomialTraits_d::DegreeVector`. */ typedef unspecified_type Degree_vector; -/*! +/*! A model of `PolynomialTraits_d::LeadingCoefficient`. */ typedef unspecified_type Leading_coefficient; -/*! +/*! A model of `PolynomialTraits_d::InnermostLeadingCoefficient`. */ typedef unspecified_type Innermost_leading_coefficient; -/*! +/*! A model of `PolynomialTraits_d::Canonicalize`. */ typedef unspecified_type Canonicalize; -/*! +/*! A model of `PolynomialTraits_d::Differentiate`. */ typedef unspecified_type Differentiate; -/*! +/*! A model of `PolynomialTraits_d::Evaluate`. */ typedef unspecified_type Evaluate; -/*! +/*! A model of `PolynomialTraits_d::EvaluateHomogeneous`. */ typedef unspecified_type Evaluate_homogeneous; -/*! +/*! A model of `PolynomialTraits_d::Substitute`. */ typedef unspecified_type Substitute; -/*! +/*! A model of `PolynomialTraits_d::SubstituteHomogeneous`. */ typedef unspecified_type Substitute_homogeneous; -/*! +/*! A model of `PolynomialTraits_d::IsZeroAt`. */ typedef unspecified_type Is_zero_at; -/*! +/*! A model of `PolynomialTraits_d::IsZeroAtHomogeneous`. */ typedef unspecified_type Is_zero_at_homogeneous; -/*! +/*! A model of `PolynomialTraits_d::SignAt`. @@ -202,7 +202,7 @@ is `CGAL::Null_functor`. */ typedef unspecified_type Sign_at; -/*! +/*! A model of `PolynomialTraits_d::SignAtHomogeneous`. @@ -211,7 +211,7 @@ is `CGAL::Null_functor`. */ typedef unspecified_type Sign_at_homogeneous; -/*! +/*! A model of `PolynomialTraits_d::Compare`. @@ -220,7 +220,7 @@ is `CGAL::Null_functor`. */ typedef unspecified_type Compare; -/*! +/*! In case `PolynomialTraits_d::Coefficient_type` is not a model of `UniqueFactorizationDomain`, this is `CGAL::Null_functor`, otherwise this is @@ -228,7 +228,7 @@ a model of `PolynomialTraits_d::UnivariateContent`. */ typedef unspecified_type Univariate_content; -/*! +/*! In case `PolynomialTraits_d::Innermost_coefficient_type` is not a model of `UniqueFactorizationDomain`, this is `CGAL::Null_functor`, @@ -237,119 +237,119 @@ otherwise this is a model of */ typedef unspecified_type Multivariate_content; -/*! +/*! A model of `PolynomialTraits_d::Shift`. */ typedef unspecified_type Shift; -/*! +/*! A model of `PolynomialTraits_d::Negate`. */ typedef unspecified_type Negate; -/*! +/*! A model of `PolynomialTraits_d::Invert`. */ typedef unspecified_type Invert; -/*! +/*! A model of `PolynomialTraits_d::Translate`. */ typedef unspecified_type Translate; -/*! +/*! A model of `PolynomialTraits_d::TranslateHomogeneous`. */ typedef unspecified_type Translate_homogeneous; -/*! +/*! A model of `PolynomialTraits_d::Scale`. */ typedef unspecified_type Scale; -/*! +/*! A model of `PolynomialTraits_d::ScaleHomogeneous`. */ typedef unspecified_type Scale_homogeneous; -/*! +/*! A model of `PolynomialTraits_d::MakeSquareFree`. */ typedef unspecified_type Make_square_free; -/*! +/*! In case `PolynomialTraits::Polynomial_d` is not a model of `UniqueFactorizationDomain`, this is of type `CGAL::Null_functor`, otherwise this is a model of `PolynomialTraits_d::SquareFreeFactorize`. */ typedef unspecified_type Square_free_factorize; -/*! +/*! A model of `PolynomialTraits_d::PseudoDivision`. */ typedef unspecified_type Pseudo_division ; -/*! +/*! A model of `PolynomialTraits_d::PseudoDivisionRemainder`. */ typedef unspecified_type Pseudo_division_remainder; -/*! +/*! A model of `PolynomialTraits_d::PseudoDivisionQuotient`. */ typedef unspecified_type Pseudo_division_quotient ; -/*! +/*! A model of `PolynomialTraits_d::GcdUpToConstantFactor`. */ typedef unspecified_type Gcd_up_to_constant_factor; -/*! +/*! A model of `PolynomialTraits_d::IntegralDivisionUpToConstantFactor`. */ typedef unspecified_type Integral_division_up_to_constant_factor; -/*! +/*! A model of `PolynomialTraits_d::UnivariateContentUpToConstantFactor`. */ typedef unspecified_type Content_up_to_constant_factor; -/*! +/*! A model of `PolynomialTraits_d::SquareFreeFactorizeUpToConstantFactor`. */ typedef unspecified_type Square_free_factorize_up_to_constant_factor; -/*! +/*! A model of `PolynomialTraits_d::Resultant`. */ typedef unspecified_type Resultant; -/*! +/*! Either `CGAL::Null_functor` or a model of `PolynomialTraits_d::PolynomialSubresultants`. */ typedef unspecified_type Polynomial_subresultants; -/*! +/*! Either `CGAL::Null_functor` or a model of `PolynomialTraits_d::PolynomialSubresultants_with_cofactors`. */ typedef unspecified_type Polynomial_subresultants_with_cofactors; -/*! +/*! Either `CGAL::Null_functor` or a model of `PolynomialTraits_d::PrincipalSubresultants`. */ typedef unspecified_type Principal_subresultants; -/*! +/*! Either `CGAL::Null_functor` or a model of `PolynomialTraits_d::SturmHabichtSequence`. */ typedef unspecified_type Sturm_habicht_sequence; -/*! +/*! Either `CGAL::Null_functor` or a model of `PolynomialTraits_d::SturmHabichtSequenceWithCofactors`. */ typedef unspecified_type Sturm_habicht_sequence_with_cofactors; -/*! +/*! Either `CGAL::Null_functor` or a model of `PolynomialTraits_d::PrincipalSturmHabichtSequence`. */ typedef unspecified_type Principal_sturm_habicht_sequence; 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 352fa6a9541..c358af11899 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 @@ -61,27 +61,27 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `Traits::Point_d`. Point type used to represent the input points. */ typedef unspecified_type Point; -/*! +/*! typedef to `Traits::FT`. Number type used to return the squared distance between the two polytopes. */ typedef unspecified_type FT; -/*! +/*! typedef to `Traits::ET`. Number type used to do the exact computations in the underlying solver for quadratic programs (cf. Implementation). */ typedef unspecified_type ET; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the points @@ -89,14 +89,14 @@ of the two polytopes. */ typedef unspecified_type Point_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `Point`. Used to access the support points. */ typedef unspecified_type Support_point_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `int`. Used to access the indices of the @@ -105,7 +105,7 @@ in both point sets). */ typedef unspecified_type Support_point_index_iterator; -/*! +/*! non-mutable model of the \stl concept RandomAccessIterator with value type `ET`. Used to access the coordinates of @@ -118,7 +118,7 @@ typedef unspecified_type Coordinate_iterator; /// \name Creation /// @{ -/*! +/*! initializes `poly_dist` to \f$ pd(\emptyset, \emptyset)\f$. */ @@ -126,7 +126,7 @@ Polytope_distance_d( const Traits& traits = Traits(), int verbose = 0, std::ostream& stream = std::cout); -/*! +/*! initializes `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ and \f$ Q\f$ being the sets of points in the range [`p_first`,`p_last`) and @@ -152,122 +152,122 @@ std::ostream& stream = std::cout); /// \name Access Functions /// @{ -/*! +/*! returns the dimension of the points in \f$ P\f$ and \f$ Q\f$. If `poly_dist` is \f$ pd(\emptyset, \emptyset)\f$, the ambient dimension is \f$ -1\f$. */ int ambient_dimension( ) const; -/*! +/*! returns the number of all points of `poly_dist`, i.e.\ \f$ |P|+|Q|\f$. */ int number_of_points( ) const; -/*! +/*! returns the number of points in \f$ P\f$. */ int number_of_points_p( ) const; -/*! +/*! returns the number of points in \f$ Q\f$. */ int number_of_points_q( ) const; -/*! +/*! returns the number of support points of `poly_dist`, i.e.\ \f$ |S_P|+|S_Q|\f$. */ int number_of_support_points( ) const; -/*! +/*! returns the number of support points in \f$ S_P\f$. */ int number_of_support_points_p( ) const; -/*! +/*! returns the number of support points in \f$ S_Q\f$. */ int number_of_support_points_q( ) const; -/*! +/*! returns an iterator referring to the first point in \f$ P\f$. */ Point_iterator points_p_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Point_iterator points_p_end( ) const; -/*! +/*! returns an iterator referring to the first point in \f$ Q\f$. */ Point_iterator points_q_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Point_iterator points_q_end( ) const; -/*! +/*! returns an iterator referring to the first support point in \f$ S_P\f$. */ Support_point_iterator support_points_p_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_point_iterator support_points_p_end( ) const; -/*! +/*! returns an iterator referring to the first support point in \f$ S_Q\f$. */ Support_point_iterator support_points_q_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_point_iterator support_points_q_end( ) const; -/*! +/*! returns an iterator referring to the index of the first support point in \f$ P\f$. */ Support_point_index_iterator support_points_p_indices_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_point_index_iterator support_points_p_indices_end( ) const; -/*! +/*! returns an iterator referring to the index of the first support point in \f$ Q\f$. */ Support_point_index_iterator support_points_q_indices_begin( ) const; -/*! +/*! returns the corresponding past-the-end iterator. */ Support_point_index_iterator support_points_q_indices_end( ) const; -/*! +/*! returns the realizing point of \f$ P\f$. \cgalRequires An implicit conversion from `ET` to `RT` is available. @@ -275,7 +275,7 @@ returns the realizing point of \f$ P\f$. */ Point realizing_point_p( ) const; -/*! +/*! returns the realizing point of \f$ Q\f$. \cgalRequires An implicit conversion from `ET` to `RT` is available. @@ -283,7 +283,7 @@ returns the realizing point of \f$ Q\f$. */ Point realizing_point_q( ) const; -/*! +/*! returns the squared distance of `poly_dist`, i.e.\ \f$ (pd(P,Q))^2\f$. \cgalRequires An implicit conversion from `ET` to `RT` is available. @@ -291,7 +291,7 @@ returns the squared distance of `poly_dist`, i.e.\ \f$ (pd(P,Q))^2\f$. */ FT squared_distance( ) const; -/*! +/*! returns an iterator referring to the first coordinate of the realizing point of \f$ P\f$. @@ -305,14 +305,14 @@ common denominator. Coordinate_iterator realizing_point_p_coordinates_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Coordinate_iterator realizing_point_p_coordinates_end() const; -/*! +/*! returns an iterator referring to the first coordinate of the realizing point of \f$ Q\f$. @@ -326,20 +326,20 @@ common denominator. Coordinate_iterator realizing_point_q_coordinates_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Coordinate_iterator realizing_point_q_coordinates_end() const; -/*! +/*! returns the numerator of the squared distance of `poly_dist`. */ ET squared_distance_numerator( ) const; -/*! +/*! returns the denominator of the squared distance of `poly_dist`. */ @@ -350,21 +350,21 @@ ET squared_distance_denominator( ) const; /// \name Predicates /// @{ -/*! +/*! returns `true`, if \f$ pd(P,Q)\f$ is finite, i.e.\ none of the two polytopes is empty. */ bool is_finite( ) const; -/*! +/*! returns `true`, if \f$ pd(P,Q)\f$ is zero, i.e.\ the two polytopes intersect (this implies degeneracy). */ bool is_zero( ) const; -/*! +/*! returns `true`, iff \f$ pd(P,Q)\f$ is degenerate, i.e.\ \f$ pd(P,Q)\f$ is not finite. @@ -376,13 +376,13 @@ bool is_degenerate( ) const; /// \name Modifiers /// @{ -/*! +/*! resets `poly_dist` to \f$ pd(\emptyset, \emptyset)\f$. */ void clear( ); -/*! +/*! sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ and \f$ Q\f$ being the sets of points in the ranges [`p_first`,`p_last`) and @@ -396,7 +396,7 @@ InputIterator1 p_last, InputIterator2 q_first, InputIterator2 q_last ); -/*! +/*! sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ P\f$ being the set of points in the range [`p_first`,`p_last`) (\f$ Q\f$ remains unchanged). @@ -407,7 +407,7 @@ template < class InputIterator > void set_p( InputIterator p_first, InputIterator p_last ); -/*! +/*! sets `poly_dist` to \f$ pd(P,Q)\f$ with \f$ Q\f$ being the set of points in the range [`q_first`,`q_last`) (\f$ P\f$ remains unchanged). @@ -418,21 +418,21 @@ template < class InputIterator > void set_q( InputIterator q_first, InputIterator q_last ); -/*! +/*! inserts `p` into \f$ P\f$. \pre The dimension of `p` equals `poly_dist``.ambient_dimension()` if `poly_dist` is not \f$ pd(\emptyset, \emptyset)\f$. */ void insert_p( const Point& p); -/*! +/*! inserts `q` into \f$ Q\f$. \pre The dimension of `q` equals `poly_dist``.ambient_dimension()` if `poly_dist` is not \f$ pd(\emptyset, \emptyset)\f$. */ void insert_q( const Point& q); -/*! +/*! inserts the points in the range [`p_first`,`p_last`) and [`q_first`,`q_last`) into \f$ P\f$ and \f$ Q\f$, respectively, @@ -446,7 +446,7 @@ InputIterator1 p_last, InputIterator2 q_first, InputIterator2 q_last ); -/*! +/*! inserts the points in the range [`p_first`,`p_last`) into \f$ P\f$ and recomputes the (squared) distance (\f$ Q\f$ remains unchanged). @@ -457,7 +457,7 @@ template < class InputIterator > void insert_p( InputIterator p_first, InputIterator p_last ); -/*! +/*! inserts the points in the range [`q_first`,`q_last`) into \f$ Q\f$ and recomputes the (squared) distance (\f$ P\f$ remains unchanged). @@ -473,7 +473,7 @@ InputIterator q_last ); /// \name Validity Check /// @{ -/*! +/*! returns `true`, iff `poly_dist` is valid. If `verbose` is `true`, some messages concerning the performed checks are @@ -495,7 +495,7 @@ int level = 0 ) const; /// \name Miscellaneous /// @{ -/*! +/*! returns a const reference to the traits class object. */ @@ -506,7 +506,7 @@ const Traits& traits( ) const; }; /* end Polytope_distance_d */ -/*! +/*! writes `poly_dist` to output stream `os`. \cgalRequires The output operator is defined for `Point_d`. @@ -515,7 +515,7 @@ writes `poly_dist` to output stream `os`. std::ostream& operator << ( std::ostream& os, const Polytope_distance_d& poly_dist); -/*! +/*! reads `poly_dist` from input stream `is`. \cgalRequires The input operator is defined for `Point_d`. 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 445177a5d3b..efe82888ec9 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 @@ -27,47 +27,47 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_2`. */ typedef unspecified_type Point_d; -/*! +/*! typedef to `K::Rep_tag`. */ typedef unspecified_type Rep_tag; -/*! +/*! typedef to `K::RT`. */ typedef unspecified_type RT; -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Access_dimension_2`. */ typedef unspecified_type Access_dimension_d; -/*! +/*! typedef to `K::Access_coordinates_begin_2`. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! typedef to `K::Construct_point_2`. */ typedef unspecified_type Construct_point_d; -/*! +/*! second template parameter (default is `K::RT`). */ typedef unspecified_type ET; -/*! +/*! third template parameter (default is `K::RT`). */ typedef unspecified_type NT; @@ -77,12 +77,12 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Polytope_distance_d_traits_2( ); -/*! +/*! copy constructor. */ Polytope_distance_d_traits_2( @@ -94,19 +94,19 @@ const Polytope_distance_d_traits_2&); /// The following functions just return the corresponding function class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d 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 60580db0a09..fdd520bd1b8 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 @@ -28,47 +28,47 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_3`. */ typedef unspecified_type Point_d; -/*! +/*! typedef to `K::Rep_tag`. */ typedef unspecified_type Rep_tag; -/*! +/*! typedef to `K::RT`. */ typedef unspecified_type RT; -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Access_dimension_3`. */ typedef unspecified_type Access_dimension_d; -/*! +/*! typedef to `K::Access_coordinates_begin_3`. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! typedef to `K::Construct_point_3`. */ typedef unspecified_type Construct_point_d; -/*! +/*! second template parameter (default is `K::RT`). */ typedef unspecified_type ET; -/*! +/*! third template parameter (default is `K::RT`). */ typedef unspecified_type NT; @@ -78,12 +78,12 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Polytope_distance_d_traits_3( ); -/*! +/*! copy constructor. */ Polytope_distance_d_traits_3( @@ -95,19 +95,19 @@ const Polytope_distance_d_traits_3&); /// The following functions just return the corresponding function class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d 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 03333869e4b..9749da82e48 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 @@ -28,47 +28,47 @@ public: /// \name Types /// @{ -/*! +/*! typedef to `K::Point_d`. */ typedef unspecified_type Point_d; -/*! +/*! typedef to `K::Rep_tag`. */ typedef unspecified_type Rep_tag; -/*! +/*! typedef to `K::RT`. */ typedef unspecified_type RT; -/*! +/*! typedef to `K::FT`. */ typedef unspecified_type FT; -/*! +/*! typedef to `K::Access_dimension_d`. */ typedef unspecified_type Access_dimension_d; -/*! +/*! typedef to `K::Access_coordinates_begin_d`. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! typedef to `K::Construct_point_d`. */ typedef unspecified_type Construct_point_d; -/*! +/*! second template parameter (default is `K::RT`). */ typedef unspecified_type ET; -/*! +/*! third template parameter (default is `K::RT`). */ typedef unspecified_type NT; @@ -78,12 +78,12 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Polytope_distance_d_traits_d( ); -/*! +/*! copy constructor. */ Polytope_distance_d_traits_d( @@ -95,19 +95,19 @@ const Polytope_distance_d_traits_d&); /// The following functions just return the corresponding function class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d 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 d7f67c78dd7..5caf9a3c9f7 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 @@ -84,32 +84,32 @@ public: /// \name Types /// @{ -/*! +/*! traits class. */ typedef unspecified_type Traits; -/*! +/*! point type. */ typedef typename Traits::Point_3 Point_3; -/*! +/*! plane type. */ typedef typename Traits::Plane_3 Plane_3; -/*! +/*! vector type. */ typedef typename Traits::Vector_3 Vector_3; -/*! +/*! algebraic ring type. */ typedef typename Traits::RT RT; -/*! +/*! traits class for the 3D convex hull algorithm. */ @@ -120,7 +120,7 @@ typedef typename Traits::ChullTraits ChullTraits; /// \name Creation /// @{ -/*! +/*! 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 @@ -131,7 +131,7 @@ with \f$ \mathcal{S}\f$ being the set of points in the range template < class InputIterator > Width_3( InputIterator first, InputIterator beyond); -/*! +/*! creates a variable `width` initialized to the width of the polyhedron \f$ P\f$. Note that the vertex point coordinates are altered! @@ -150,7 +150,7 @@ Width_3( Polyhedron& P); /// \name Access Functions /// @{ -/*! +/*! returns the squared width. For the reason of exact computation not the width itself is stored, but the squared width as a fraction: The numerator in `width_num` and the @@ -161,14 +161,14 @@ denominator in `width_denom`. The width of the point set void get_squared_width ( RT& width_num, RT& width_denom ); -/*! +/*! The planes `e1` and `e2` are the two parallel supporting planes, which distance is minimal (among all such planes). */ void get_width_planes ( Plane_3& e1, Plane_3& e2 ); -/*! +/*! The returned coefficients `A,B,C,D,K` have the property that width-plane `e1` is given by the equation \f$ Ax+By+Cz+D=0\f$ and width-plane `e2` by \f$ Ax+By+Cz+K=0\f$. @@ -176,7 +176,7 @@ property that width-plane `e1` is given by the equation void get_width_coefficients ( RT& A,RT& B,RT& C, RT& D, RT& K ); -/*! +/*! returns a direction \f$ \mathbf{d}_{opt}\f$ such that the width-planes `e1` and `e2` are perpendicular to \f$ \mathbf{d}_{opt}\f$. The width of the @@ -184,7 +184,7 @@ point set is minimal in this direction. */ Vector_3 get_build_direction ( ); -/*! +/*! All the build directions are stored in the vector `dir`. It might happen that a certain body has several different build directions, but it is also possible to have only one @@ -193,7 +193,7 @@ build direction. void get_all_build_directions ( std::vector& dir ); -/*! +/*! returns the number of optimal solutions, i.e., the number of optimal build directions. 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 abb08ed7af2..c37cae8e2da 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 @@ -22,27 +22,27 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef typename K::Point_3 Point_3; -/*! +/*! */ typedef typename K::Plane_3 Plane_3; -/*! +/*! */ typedef typename K::Vector_3 Vector_3; -/*! +/*! */ typedef typename K::RT RT; -/*! +/*! */ typedef Convex_hull_traits_3 ChullTraits; @@ -52,7 +52,7 @@ typedef Convex_hull_traits_3 ChullTraits; /// \name Creation /// @{ -/*! +/*! default constructor. */ Width_default_traits_3( ); @@ -62,83 +62,83 @@ Width_default_traits_3( ); /// \name Operations /// @{ -/*! +/*! returns the homogeneous \f$ x\f$-coordinate of point \f$ p\f$. */ RT get_hx(const Point_3& p) const; -/*! +/*! returns the homogeneous \f$ y\f$-coordinate of point \f$ p\f$. */ RT get_hy(const Point_3& p) const; -/*! +/*! returns the homogeneous \f$ z\f$-coordinate of point \f$ p\f$. */ RT get_hz(const Point_3& p) const; -/*! +/*! returns the homogenizing coordinate of point \f$ p\f$. */ RT get_hw(const Point_3& p) const; -/*! +/*! returns all homogeneous coordinates of point \f$ p\f$ at once. */ void get_point_coordinates(const Point_3& p, RT& px, RT& py, RT& pz, RT& ph) const; -/*! +/*! returns the first coefficient of plane \f$ f\f$. */ RT get_a(const Plane_3& f) const; -/*! +/*! returns the second coefficient of plane \f$ f\f$. */ RT get_b(const Plane_3& f) const; -/*! +/*! returns the third coefficient of plane \f$ f\f$. */ RT get_c(const Plane_3& f) const; -/*! +/*! returns the fourth coefficient of plane \f$ f\f$. */ RT get_d(const Plane_3& f) const; -/*! +/*! returns all four plane coefficients of \f$ f\f$ at once. */ void get_plane_coefficients(const Plane_3& f, RT& a, RT& b, RT& c, RT& d) const; -/*! +/*! returns a point of type `Point_3` with homogeneous coordinates \f$ hx\f$, \f$ hy\f$, \f$ hz\f$ and \f$ hw\f$. */ Point_3 make_point(const RT& hx, const RT& hy, const RT& hz, const RT& hw) const; -/*! +/*! returns a plane of type `Plane_3` whose coefficients are \f$ a\f$, \f$ b\f$, \f$ c\f$ and \f$ d\f$. */ Plane_3 make_plane(const RT& a, const RT& b, const RT& c, const RT& d) const; -/*! +/*! returns a vector of type `Vector_3` with the four coefficients \f$ a\f$, \f$ b\f$, \f$ c\f$ and 1. */ 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 83222e7358c..4364d8c309b 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 @@ -31,30 +31,30 @@ public: /// \name Types /// @{ -/*! +/*! model for `FieldNumberType`. */ typedef unspecified_type FT; -/*! +/*! model for `Kernel::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! model for `Kernel::Compute_squared_distance_2`. */ typedef unspecified_type Compute_squared_distance_2; -/*! +/*! model for `Kernel::Less_xy_2`. */ typedef unspecified_type Less_xy_2; -/*! +/*! model for `Kernel::Orientation_2`. */ @@ -66,18 +66,18 @@ typedef unspecified_type Orientation_2; /// The following member functions return function objects of the types listed above. /// @{ -/*! +/*! */ Compute_squared_distance_2 compute_squared_distance_2_object(); -/*! +/*! */ Less_xy_2 less_xy_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); diff --git a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h index 7397135c88d..372615e7657 100644 --- a/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h +++ b/Polytope_distance_d/doc/Polytope_distance_d/Concepts/PolytopeDistanceDTraits.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! point type used to represent the input points. */ typedef unspecified_type Point_d; -/*! +/*! compile time tag to distinguish between %Cartesian and homogeneous representation of the input points. `Rep_tag` has to be either `CGAL::``Cartesian_tag` or @@ -33,13 +33,13 @@ representation of the input points. `Rep_tag` has to be either */ typedef unspecified_type Rep_tag; -/*! +/*! number type used to represent the coordinates of the input points. It has to be a model for `RingNumberType`. */ typedef unspecified_type RT; -/*! +/*! number type used to return either the squared radius of the smallest enclosing sphere or annulus, or the squared distance of the polytopes. `FT` has to be either `RT` or `CGAL::``Quotient` if @@ -48,17 +48,17 @@ respectively (cf. `Rep_tag`). */ typedef unspecified_type FT; -/*! +/*! data accessor object used to access the dimension of the input points. */ typedef unspecified_type Access_dimension_d; -/*! +/*! data accessor object used to access the coordinates of the input points. */ typedef unspecified_type Access_coordinates_begin_d; -/*! +/*! constructor object used to construct either the center of the smallest enclosing sphere or annulus, or the points realizing the distance between the two polytopes. @@ -73,7 +73,7 @@ typedef unspecified_type Construct_point_d; /// `CGAL::Polytope_distance_d`. /// @{ -/*! +/*! exact number type used to do the exact computations in the underlying solver for linear programs. It has to to be a model for `RingNumberType`. There must be an implicit conversion from @@ -81,7 +81,7 @@ underlying solver for linear programs. It has to to be a model for */ typedef unspecified_type ET; -/*! +/*! fast (possibly inexact) number type used to speed up the pricing step in the underlying solver for linear programs. It has to be a model for `RingNumberType`. There must be implicit conversions from `RT` to @@ -95,12 +95,12 @@ typedef unspecified_type NT; /// Only default and copy constructor are required. /// @{ -/*! +/*! */ PolytopeDistanceDTraits( ); -/*! +/*! */ PolytopeDistanceDTraits( const PolytopeDistanceDTraits&); @@ -111,19 +111,19 @@ PolytopeDistanceDTraits( const PolytopeDistanceDTraits&); /// The following functions just return the corresponding function class object. /// @{ -/*! +/*! */ Access_dimension_d access_dimension_d_object() const; -/*! +/*! */ Access_coordinates_begin_d access_coordinates_begin_d_object() const; -/*! +/*! */ Construct_point_d 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 da2450c1206..3d88517ef99 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 @@ -25,7 +25,7 @@ public: /// Notes: If you want to compute the width of a polyhedron then you have to make sure that the point type in the traits class and the point type in the polyhedron class are the same! The same holds for `Traits::Plane_3` and `Polyhedron::Plane_3`. /// @{ -/*! +/*! The point type. The (in)equality tests must be available. Access to the point coordinates is done via the `get_.()` functions. Constructing a point is done with the `make_point( )` @@ -33,21 +33,21 @@ operation. */ typedef unspecified_type Point_3; -/*! +/*! The plane type. Access to the coefficients of the plane is made via the `get_.()` functions. Constructing a plane is done with the `make_plane()` operation. */ typedef unspecified_type Plane_3; -/*! +/*! The vector type. There is no need to access the coefficients of a vector; only constructing is required and is done with the `make_vector` operation. */ typedef unspecified_type Vector_3; -/*! +/*! The traits class for using the convex hull algorithm. It must be a model of the concept ConvexHullTraits_3. This class is used only if the width is computed from a set @@ -55,7 +55,7 @@ of points. */ typedef unspecified_type ChullTraits; -/*! +/*! Ring type numbers. Internally all numbers are treated as ring type numbers, i.e., neither \f$ /\f$-operator nor \f$ \sqrt{.}\f$ nor other inexact operations are used. But because the algorithm does not use any @@ -73,67 +73,67 @@ typedef unspecified_type RT; /// Only a default constructor is required. /// @{ -/*! +/*! */ WidthTraits_3( ); -/*! +/*! returns the homogeneous \f$ x\f$-coordinate of point \f$ p\f$. */ RT get_hx(const Point_3& p) const; -/*! +/*! returns the homogeneous \f$ y\f$-coordinate of point \f$ p\f$. */ RT get_hy(const Point_3& p) const; -/*! +/*! returns the homogeneous \f$ z\f$-coordinate of point \f$ p\f$. */ RT get_hz(const Point_3& p) const; -/*! +/*! returns the homogenizing coordinate of point \f$ p\f$. */ RT get_hw(const Point_3& p) const; -/*! +/*! returns all homogeneous coordinates of point \f$ p\f$ at once. */ void get_point_coordinates(const Point_3& p, RT& px, RT& py, RT& pz, RT& ph) const; -/*! +/*! returns the first coefficient of plane \f$ f\f$. */ RT get_a(const Plane_3& f) const; -/*! +/*! returns the second coefficient of plane \f$ f\f$. */ RT get_b(const Plane_3& f) const; -/*! +/*! returns the third coefficient of plane \f$ f\f$. */ RT get_c(const Plane_3& f) const; -/*! +/*! returns the fourth coefficient of plane \f$ f\f$. */ RT get_d(const Plane_3& f) const; -/*! +/*! returns all four plane coefficients of \f$ f\f$ at once. */ void get_plane_coefficients(const Plane_3& f, @@ -144,7 +144,7 @@ const; }; /* end WidthTraits_3 */ -/*! +/*! returns a point of type `Point_3` with homogeneous coordinates \f$ hx\f$, \f$ hy\f$, \f$ hz\f$ and \f$ hw\f$. \relates WidthTraits_3 @@ -152,7 +152,7 @@ returns a point of type Point_3 make_point(const RT& hx, const RT& hy, const RT& hz, const RT& hw) const; -/*! +/*! returns a plane of type `Plane_3` with coefficients \f$ a\f$, \f$ b\f$, \f$ c\f$ and \f$ d\f$. \relates WidthTraits_3 @@ -160,7 +160,7 @@ with coefficients \f$ a\f$, \f$ b\f$, \f$ c\f$ and \f$ d\f$. Plane_3 make_plane(const RT& a, const RT& b, const RT& c, const RT& d) const; -/*! +/*! returns a vector of type `Vector_3` with the four homogeneous coefficients \f$ a\f$, \f$ b\f$, \f$ c\f$ and 1. \relates WidthTraits_3 diff --git a/QP_solver/doc/QP_solver/CGAL/QP_models.h b/QP_solver/doc/QP_solver/CGAL/QP_models.h index bcbaaf90c8f..05683ed006a 100644 --- a/QP_solver/doc/QP_solver/CGAL/QP_models.h +++ b/QP_solver/doc/QP_solver/CGAL/QP_models.h @@ -83,7 +83,7 @@ public: /// \name Creation /// @{ - /*! + /*! constructs `lp` from given random-access iterators and the constant `c0`. The passed iterators are merely stored, no copying of the program data takes place. How these iterators are supposed to encode the linear program is described in `LinearProgram`. */ @@ -351,7 +351,7 @@ public: /// \name Creation /// @{ - /*! + /*! constructs `lp` from given random-access iterators and the constant `c0`. The passed iterators are merely stored, no copying of the program data takes place. How these iterators are supposed to encode the nonnegative @@ -448,7 +448,7 @@ public: /// \name Creation /// @{ - /*! + /*! constructs `qp` from given random-access iterators and the constant `c0`. The passed iterators are merely stored, no copying of the program data takes place. How these iterators are supposed to encode the nonnegative quadratic program is described in `NonnegativeQuadraticProgram`. */ @@ -548,7 +548,7 @@ public: /// \name Creation /// @{ - /*! + /*! constructs `qp` from given random-access iterators and the constant `c0`. The passed iterators are merely stored, no copying of the program data takes place. How these iterators are supposed to encode the quadratic program is described in `QuadraticProgram`. */ @@ -655,7 +655,7 @@ public: /// \name Types /// @{ - /*! + /*! The number type of the program entries. */ typedef unspecified_type NT; @@ -665,7 +665,7 @@ public: /// \name Creation /// @{ - /*! + /*! reads `qp` from the input stream `in`. */ Quadratic_program_from_mps(std::istream& in); @@ -675,54 +675,54 @@ public: /// \name Operations /// @{ - /*! + /*! returns `true` if and only if an MPS-encoded quadratic program could be extracted from the input stream. */ bool is_valid() const; - /*! + /*! if !`qp``.is_valid()`, this method returns an error message explaining why the input does not conform to the `MPSFormat`. */ const std::string& get_error() const; - /*! + /*! returns the name of the \f$ j\f$-th variable. \pre \f$ j\f$ must not refer to a variable that has been added later, using one of the set methods below. */ const std::string& variable_name_by_index (int j) const; - /*! + /*! returns the index of the variable with name `name`. If there is no variable with this name, the result is \f$ -1\f$. */ int variable_index_by_name (const std::string& name) const; - /*! + /*! returns the name of the \f$ i\f$-th constraint. \pre \f$ i\f$ must not refer to a constraint that has been added later, using one of the set methods below. */ const std::string& constraint_name_by_index (int i) const; - /*! + /*! returns the index of the constraint with name `name`. If there is no constraint with this name, the result is \f$ -1\f$. */ int constraint_index_by_name (const std::string& name) const; - /*! + /*! returns `true` if and only if `qp` is a linear program. */ bool is_linear() const; - /*! + /*! returns `true` if and only if `qp` is a nonnegative program. */ bool is_nonnegative() const; - /*! + /*! sets the entry \f$ A_{ij}\f$ in column \f$ j\f$ and row \f$ i\f$ of the constraint matrix \f$ A\f$ of `qp` to `val`. An existing entry is overwritten. `qp` is enlarged if @@ -730,14 +730,14 @@ public: */ void set_a (int j, int i, const NT& val); - /*! + /*! sets the entry \f$ b_i\f$ of `qp` to `val`. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_b (int i, const NT& val); - /*! + /*! sets the entry \f$ \qprel_i\f$ of `qp` to `rel`. `CGAL::SMALLER` means that the \f$ i\f$-th constraint is of type "\f$ \leq\f$", `CGAL::EQUAL` means "\f$ =\f$", and `CGAL::LARGER` encodes "\f$ \geq\f$". An existing entry @@ -745,34 +745,34 @@ public: */ void set_r (int i, CGAL::Comparison_result rel); - /*! + /*! if `is_finite`, this sets the entry \f$ l_j\f$ of `qp` to `val`, otherwise it sets \f$ l_j\f$ to \f$ -\infty\f$. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_l (int j, bool is_finite, const NT& val = NT(0)); - /*! + /*! if `is_finite`, this sets the entry \f$ u_j\f$ of `qp` to `val`, otherwise it sets \f$ u_j\f$ to \f$ \infty\f$. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_u (int j, bool is_finite, const NT& val = NT(0)); - /*! + /*! sets the entry \f$ c_j\f$ of `qp` to `val`. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_c (int j, const NT& val); - /*! + /*! sets the entry \f$ c_0\f$ of `qp` to `val`. An existing entry is overwritten. */ void set_c0 (const NT& val); - /*! + /*! sets the entries \f$ 2D_{ij}\f$ and \f$ 2D_{ji}\f$ of `qp` to `val`. Existing entries are overwritten. `qp` is enlarged if necessary to accomodate these entries. @@ -881,7 +881,7 @@ public: /// \name Types /// @{ - /*! + /*! The number type of the program entries. */ typedef unspecified_type NT; @@ -891,7 +891,7 @@ public: /// \name Creation /// @{ - /*! + /*! constructs a quadratic program with no variables and no constraints, ready for data to be added. Unless relations are explicitly set, they will be of type `default_r`. Unless bounds are explicitly set, they @@ -915,19 +915,19 @@ public: /// \name Operations /// @{ - /*! + /*! returns `true` if and only if `qp` is a linear program. */ bool is_linear() const; - /*! + /*! returns `true` if and only if `qp` is a nonnegative program. */ bool is_nonnegative() const; - /*! + /*! sets the entry \f$ A_{ij}\f$ in column \f$ j\f$ and row \f$ i\f$ of the constraint matrix \f$ A\f$ of `qp` to `val`. An existing entry is overwritten. `qp` is enlarged if @@ -935,14 +935,14 @@ public: */ void set_a (int j, int i, const NT& val); - /*! + /*! sets the entry \f$ b_i\f$ of `qp` to `val`. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_b (int i, const NT& val); - /*! + /*! sets the entry \f$ \qprel_i\f$ of `qp` to `rel`. `CGAL::SMALLER` means that the \f$ i\f$-th constraint is of type "\f$ \leq\f$", `CGAL::EQUAL` means "\f$ =\f$", and `CGAL::LARGER` encodes "\f$ \geq\f$". An existing entry @@ -950,34 +950,34 @@ public: */ void set_r (int i, CGAL::Comparison_result rel); - /*! + /*! if `is_finite`, this sets the entry \f$ l_j\f$ of `qp` to `val`, otherwise it sets \f$ l_j\f$ to \f$ -\infty\f$. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_l (int j, bool is_finite, const NT& val = NT(0)); - /*! + /*! if `is_finite`, this sets the entry \f$ u_j\f$ of `qp` to `val`, otherwise it sets \f$ u_j\f$ to \f$ \infty\f$. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_u (int j, bool is_finite, const NT& val = NT(0)); - /*! + /*! sets the entry \f$ c_j\f$ of `qp` to `val`. An existing entry is overwritten. `qp` is enlarged if necessary to accomodate this entry. */ void set_c (int j, const NT& val); - /*! + /*! sets the entry \f$ c_0\f$ of `qp` to `val`. An existing entry is overwritten. */ void set_c0 (const NT& val); - /*! + /*! sets the entries \f$ 2D_{ij}\f$ and \f$ 2D_{ji}\f$ of `qp` to `val`. Existing entries are overwritten. `qp` is enlarged if necessary to accomodate these entries. diff --git a/QP_solver/doc/QP_solver/CGAL/QP_options.h b/QP_solver/doc/QP_solver/CGAL/QP_options.h index 2cc8b22dda4..658363321e9 100644 --- a/QP_solver/doc/QP_solver/CGAL/QP_options.h +++ b/QP_solver/doc/QP_solver/CGAL/QP_options.h @@ -34,7 +34,7 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an instance of `Quadratic_program_options` where all available options are at their defaults. */ @@ -45,7 +45,7 @@ Quadratic_program_options(); /// \name Verbosity /// @{ -/*! +/*! sets the verbosity of the solver to the value `verbosity` when `options` is passed to any of the four solution functions. The provided value must be a number between \f$ 0\f$ and \f$ 5\f$. Verbosity \f$ 0\f$ is the default and @@ -57,7 +57,7 @@ purposes and have no effect if you compile with */ void set_verbosity (int verbosity); -/*! +/*! returns the verbosity level of `options`. */ int get_verbosity () const; @@ -67,7 +67,7 @@ int get_verbosity () const; /// \name Pricing strategy /// @{ -/*! +/*! sets the pricing strategy of the solver to the value `pricing_strategy` when `options` is passed to any of the four solution functions. The pricing strategy controls how the solver proceeds from any intermediate solution. @@ -77,7 +77,7 @@ class `Quadratic_program_pricing_strategy`. void set_pricing_strategy (Quadratic_program_pricing_strategy pricing_strategy); -/*! +/*! returns the pricing strategy of `options`. */ Quadratic_program_pricing_strategy get_pricing_strategy() const; @@ -87,7 +87,7 @@ Quadratic_program_pricing_strategy get_pricing_strategy() const; /// \name Validation mode /// @{ -/*! +/*! sets the automatic validation mode of the solver to the value `validate`. The default is `false`. By providing value `true` you can tell the solver to automatically check whether the program has @@ -96,7 +96,7 @@ correctly been solved, see the Validity section of the class */ void set_auto_validation(bool validate); -/*! +/*! returns the validation mode of `options`. */ bool get_auto_validation() const; diff --git a/QP_solver/doc/QP_solver/CGAL/QP_solution.h b/QP_solver/doc/QP_solver/CGAL/QP_solution.h index 4d447a18758..b3b9776dbfe 100644 --- a/QP_solver/doc/QP_solver/CGAL/QP_solution.h +++ b/QP_solver/doc/QP_solver/CGAL/QP_solution.h @@ -83,53 +83,53 @@ public: /// \name Types /// @{ -/*! +/*! The exact number type that was used to solve the program. */ typedef unspecified_type ET; -/*! +/*! An iterator type with value type `Quotient` to go over the values of the variables in the solution. */ typedef unspecified_type Variable_value_iterator; -/*! +/*! An iterator type with value type `ET` to go over the numerators of the variable values with respect to a common denominator. */ typedef unspecified_type Variable_numerator_iterator; -/*! +/*! An iterator type with value type `int` to go over the indices of the basic variables and the basic constraints. */ typedef unspecified_type Index_iterator; -/*! +/*! An iterator type with value type `Quotient` to go over an \f$ m\f$-vector \f$ \qplambda\f$ that proves optimality of the solution. */ typedef unspecified_type Optimality_certificate_iterator; -/*! +/*! An iterator type with value type `ET` to go over the numerators of the vector \f$ \qplambda\f$ with respect to a common denominator. */ typedef unspecified_type Optimality_certificate_numerator_iterator; -/*! +/*! An iterator type with value type `ET` to go over an \f$ m\f$-vector \f$ \qplambda\f$ that proves infeasibility of the solution. */ typedef unspecified_type Infeasibility_certificate_iterator; -/*! +/*! An iterator type with value type `ET` to go over an \f$ n\f$-vector \f$ \qpw\f$ that proves unboundedness of the solution. @@ -148,7 +148,7 @@ typedef unspecified_type Unboundedness_certificate_iterator; /// Example: \ref QP_solver/first_qp.cpp /// @{ -/*! +/*! constructs a void instance of `Quadratic_program_solution` that is associated to no program. */ @@ -159,7 +159,7 @@ Quadratic_program_solution(); /// \name Operations /// @{ -/*! +/*! returns `true` iff `sol` is not associated to a program. The condition !`sol``.is_void()` is a precondition for all access methods below. @@ -172,24 +172,24 @@ bool is_void() const; /// Here are the access methods for the status of the solution. /// @{ -/*! +/*! returns `true` iff `sol` is an optimal solution of the associated program. */ bool is_optimal() const; -/*! +/*! returns `true` iff the associated program is infeasible. */ bool is_infeasible() const; -/*! +/*! returns `true` iff the associated program is unbounded. */ bool is_unbounded() const; -/*! +/*! returns the status of the solution; this is one of the values `QP_OPTIMAL`, `QP_INFEASIBLE`, and `QP_UNBOUNDED`, depending on whether the program asociated @@ -197,7 +197,7 @@ to `sol` has an optimal solution, is infeasible, or is unbounded. */ Quadratic_program_status status() const; -/*! +/*! returns the number of iterations that it took to solve the program asociated to `sol`. */ @@ -209,25 +209,25 @@ int number_of_iterations() const; /// The actual solution (variable and objective function values) can be accessed as follows. /// @{ -/*! +/*! returns the objective function value of `sol`. */ Quotient objective_value() const; -/*! +/*! returns the numerator of the objective function value of `sol`. */ ET objective_value_numerator() const; -/*! +/*! returns the denominator of the objective function value of `sol`. */ ET objective_value_denominator() const; -/*! +/*! returns a random-access iterator over the values of the variables in `sol`. The value type is `Quotient`, and the valid @@ -235,13 +235,13 @@ iterator range has length \f$ n\f$. */ Variable_value_iterator variable_values_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Variable_value_iterator variable_values_end() const; -/*! +/*! returns a random-access iterator `it` over the values of the variables in `sol`, with respect to a common denominator of all variables. The value type is `ET`, and the valid @@ -249,12 +249,12 @@ iterator range has length \f$ n\f$. */ Variable_numerator_iterator variable_numerators_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Variable_numerator_iterator variable_numerators_end() const; -/*! +/*! returns the common denominator of the variable values as referred to by the previous two methods. */ @@ -270,7 +270,7 @@ const ET& variables_common_denominator() const; /// QP_solver/important_variables.cpp \ref QP_solver/first_qp_basic_constraints.cpp /// @{ -/*! +/*! returns a random access iterator over the indices of the basic variables. The value type is `int`. It is guaranteed that any variable that is not basic in `sol` attains one of its bounds. @@ -279,18 +279,18 @@ variables have value \f$ 0\f$. */ Index_iterator basic_variable_indices_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Index_iterator basic_variable_indices_end() const; -/*! +/*! returns the number of basic variables, equivalently the length of the range determined by the previous two iterators. */ int number_of_basic_variables() const; -/*! +/*! returns a random access iterator over the indices of the basic constraints in the system \f$ A\qpx\qprel\qpb\f$. The value type is `int`. It is guaranteed that any basic constraint is satisfied with equality. @@ -299,18 +299,18 @@ basic. */ Index_iterator basic_constraint_indices_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. */ Index_iterator basic_constraint_indices_end() const; -/*! +/*! returns the number of basic constraint, equivalently the length of the range determined by the previous two iterators. */ int number_of_basic_constraints() const; -/*! +/*! writes the status of `sol` to the stream `out`. In case the status is `QP_OPTIMAL`, the optimal objective value and the values of the variables at the optimal solution are output as well. For more @@ -339,7 +339,7 @@ std::ostream& operator<<(std::ostream& out, const Quadratic_program_solution /// QP_solver/first_nonnegative_qp.cpp \ref QP_solver/first_nonnegative_lp.cpp /// @{ -/*! +/*! returns `true` iff `sol` solves the quadratic program `qp`. If the result is `false`, you can get a message that describes the problem, through the method `get_error()`. @@ -348,7 +348,7 @@ template bool solves_quadratic_program (const QuadraticProgram& qp); -/*! +/*! returns `true` iff `sol` solves the linear program `lp`. If the result is `false`, you can get a message that describes the problem, through the method `get_error()`. @@ -357,7 +357,7 @@ template bool solves_linear_program (const LinearProgram& lp); -/*! +/*! returns `true` iff `sol` solves the nonnegative quadratic program `qp`. If the result is `false`, you can get a message that describes the @@ -367,7 +367,7 @@ template bool solves_nonnegative_quadratic_program (const NonnegativeQuadraticProgram& qp); -/*! +/*! returns `true` iff `sol` solves the nonnegative linear program `lp`. If the result is `false`, you can get a message that describes the problem, through the method `get_error()`. @@ -376,13 +376,13 @@ template bool solves_nonnegative_linear_program (const NonnegativeLinearProgram& lp); -/*! +/*! returns `false` iff the validation through one of the previous four functions has failed. */ bool is_valid() const; -/*! +/*! returns an error message in case any of the previous four validation functions has returned `false`. */ @@ -398,7 +398,7 @@ correctness of the solution. Any non-void object of */ /// @{ -/*! +/*! returns a random access iterator over the optimality certificate \f$ \qplambda\f$ as given in Lemma 1, with respect to the solution \f$ \qpx^*\f$ obtained from `sol``.variable_values_begin()`. The value type @@ -451,7 +451,7 @@ and since \f$D\f$ is positive semidefinite, we have Optimality_certificate_iterator optimality_certifcate_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. \sa `optimality_certifcate_begin()` @@ -459,7 +459,7 @@ returns the corresponding past-the-end iterator. Optimality_certificate_iterator optimality_certificate_end() const; -/*! +/*! returns a random access iterator over the numerator values of the optimality certificate \f$ \qplambda\f$, with respect to the common denominator returned by `sol`.`variables_common_denominator()`. @@ -470,7 +470,7 @@ The value type is `ET`, and the valid iterator range has length \f$ m\f$. Optimality_certificate_numerator_iterator optimality_certifcate_numerators_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. \sa `optimality_certifcate_begin()` @@ -478,7 +478,7 @@ returns the corresponding past-the-end iterator. Optimality_certificate_numerator_iterator optimality_certificate_numerators_end() const; -/*! +/*! returns a random access iterator over the infeasibility certificate \f$ \qplambda\f$ as given in Lemma 2. The value type is `ET`, and the valid iterator range has length \f$ m\f$. @@ -524,7 +524,7 @@ and this is the desired contradiction \f$0>0\f$. Infeasibility_certificate_iterator infeasibility_certificate_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. \sa `infeasibility_certificate_begin()` @@ -532,7 +532,7 @@ returns the corresponding past-the-end iterator. Infeasibility_certificate_iterator infeasibility_certificate_end() const; -/*! +/*! returns a random acess iterator over the unbounded direction \f$ \qpw\f$ as given in Lemma 3,with respect to the solution \f$ \qpx^*\f$ obtained from `sol``.variable_values_begin()`. The value type @@ -571,7 +571,7 @@ the problem is indeed unbounded. Unboundedness_certificate_iterator unboundedness_certificate_begin() const; -/*! +/*! returns the corresponding past-the-end iterator. \sa `unboundedness_certificate_begin()` diff --git a/QP_solver/doc/QP_solver/Concepts/LinearProgram.h b/QP_solver/doc/QP_solver/Concepts/LinearProgram.h index dcfba1008a7..d3805afe25c 100644 --- a/QP_solver/doc/QP_solver/Concepts/LinearProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/LinearProgram.h @@ -65,7 +65,7 @@ public: /// \name Types /// @{ -/*! +/*! A random access iterator type to go columnwise over the constraint matrix \f$ A\f$. The value type is a random access iterator type for an individual column that @@ -73,46 +73,46 @@ goes over the entries in that column. */ typedef unspecified_type A_iterator; -/*! +/*! A random access iterator type to go over the entries of the right-hand side \f$ \qpb\f$. */ typedef unspecified_type B_iterator; -/*! +/*! A random access iterator type to go over the relations \f$ \qprel\f$. The value type of `R_iterator` is `CGAL::Comparison_result`. */ typedef unspecified_type R_iterator; -/*! +/*! A random access iterator type to go over the existence (finiteness) of the lower bounds \f$ l_j, j=0,\ldots,n-1\f$. The value type of `FL_iterator` is `bool`. */ typedef unspecified_type FL_iterator; -/*! +/*! A random acess iterator type to go over the entries of the lower bound vector \f$ \qpl\f$. */ typedef unspecified_type L_iterator; -/*! +/*! A random access iterator type to go over the existence (finiteness) of the upper bounds \f$ u_j, j=0,\ldots,n-1\f$. The value type of `UL_iterator` is `bool`. */ typedef unspecified_type UL_iterator; -/*! +/*! A random acess iterator type to go over the entries of the upper bound vector \f$ \qpu\f$. */ typedef unspecified_type U_iterator; -/*! +/*! A random access iterator type to go over the entries of the linear objective function vector \f$ c\f$. */ @@ -123,19 +123,19 @@ typedef unspecified_type C_iterator; /// \name Operations /// @{ -/*! +/*! returns the number \f$ n\f$ of variables (number of columns of \f$ A\f$) in `lp`. */ int get_n() const; -/*! +/*! returns the number \f$ m\f$ of constraints (number of rows of \f$ A\f$) in `lp`. */ int get_m() const; -/*! +/*! returns an iterator over the columns of \f$ A\f$. The corresponding past-the-end iterator is `get_a()+get_n()`. For \f$ j=0,\ldots,n-1\f$, `*(get_a()+j)` is a random access @@ -143,14 +143,14 @@ iterator for column \f$ j\f$. */ A_iterator get_a() const; -/*! +/*! returns an iterator over the entries of \f$ \qpb\f$. The corresponding past-the-end iterator is `get_b()+get_m()`. */ B_iterator get_b() const; -/*! +/*! returns an iterator over the entries of \f$ \qprel\f$. The corresponding past-the-end iterator is `get_r()+get_m()`. @@ -160,7 +160,7 @@ stands for \f$ \geq\f$. */ R_iterator get_r() const; -/*! +/*! returns an iterator over the existence of the lower bounds \f$ l_j, j=0,\ldots,n-1\f$. The corresponding past-the-end iterator is `get_fl()+get_n()`. If @@ -169,7 +169,7 @@ bound given by `*(get_l()+j)`, otherwise it has no lower bound. */ FL_iterator get_fl() const; -/*! +/*! returns an iterator over the entries of \f$ \qpl\f$. The corresponding past-the-end iterator is `get_l()+get_n()`. @@ -178,7 +178,7 @@ If `*(get_fl()+j)` has value \f$ false\f$, the value */ L_iterator get_l() const; -/*! +/*! returns an iterator over the existence of the upper bounds \f$ u_j, j=0,\ldots,n-1\f$. The corresponding past-the-end iterator is `get_fu()+get_n()`. If @@ -187,7 +187,7 @@ bound given by `*(get_u()+j)`, otherwise it has no upper bound. */ FU_iterator get_fu() const; -/*! +/*! returns an iterator over the entries of \f$ \qpu\f$. The corresponding past-the-end iterator is `get_u()+get_n()`. @@ -196,14 +196,14 @@ If `*(get_fu()+j)` has value \f$ false\f$, the value */ L_iterator get_u() const; -/*! +/*! returns an iterator over the entries of \f$ \qpc\f$. The corresponding past-the-end iterator is `get_c()+get_n()`. */ C_iterator get_c() const; -/*! +/*! returns the constant term \f$ c_0\f$ of the objective function. */ std::iterator_traits::value_type get_c0() const; diff --git a/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h b/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h index 24795840383..00a325a06c5 100644 --- a/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/NonnegativeLinearProgram.h @@ -65,7 +65,7 @@ public: /// \name Types /// @{ -/*! +/*! A random access iterator type to go columnwise over the constraint matrix \f$ A\f$. The value type is a random access iterator type for an individual column that @@ -73,20 +73,20 @@ goes over the entries in that column. */ typedef unspecified_type A_iterator; -/*! +/*! A random access iterator type to go over the entries of the right-hand side \f$ \qpb\f$. */ typedef unspecified_type B_iterator; -/*! +/*! A random access iterator type to go over the relations \f$ \qprel\f$. The value type of `R_iterator` is `CGAL::Comparison_result`. */ typedef unspecified_type R_iterator; -/*! +/*! A random access iterator type to go over the entries of the linear objective function vector \f$ c\f$. */ @@ -97,19 +97,19 @@ typedef unspecified_type C_iterator; /// \name Operations /// @{ -/*! +/*! returns the number \f$ n\f$ of variables (number of columns of \f$ A\f$) in `lp`. */ int get_n() const; -/*! +/*! returns the number \f$ m\f$ of constraints (number of rows of \f$ A\f$) in `lp`. */ int get_m() const; -/*! +/*! returns an iterator over the columns of \f$ A\f$. The corresponding past-the-end iterator is `get_a()+get_n()`. For \f$ j=0,\ldots,n-1\f$, `*(get_a()+j)` a random access @@ -117,14 +117,14 @@ iterator for column \f$ j\f$. */ A_iterator get_a() const; -/*! +/*! returns an iterator over the entries of \f$ \qpb\f$. The corresponding past-the-end iterator is `get_b()+get_m()`. */ B_iterator get_b() const; -/*! +/*! returns an iterator over the entries of \f$ \qprel\f$. The corresponding past-the-end iterator is `get_r()+get_m()`. @@ -134,14 +134,14 @@ stands for \f$ \geq\f$. */ R_iterator get_r() const; -/*! +/*! returns an iterator over the entries of \f$ \qpc\f$. The corresponding past-the-end iterator is `get_c()+get_n()`. */ C_iterator get_c() const; -/*! +/*! returns the constant term \f$ c_0\f$ of the objective function. */ std::iterator_traits::value_type get_c0() const; diff --git a/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h b/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h index 974617795f7..2ef836af99e 100644 --- a/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/NonnegativeQuadraticProgram.h @@ -65,7 +65,7 @@ public: /// \name Types /// @{ -/*! +/*! A random access iterator type to go columnwise over the constraint matrix \f$ A\f$. The value type is a random access iterator type for an individual column that @@ -73,20 +73,20 @@ goes over the entries in that column. */ typedef unspecified_type A_iterator; -/*! +/*! A random access iterator type to go over the entries of the right-hand side \f$ \qpb\f$. */ typedef unspecified_type B_iterator; -/*! +/*! A random access iterator type to go over the relations \f$ \qprel\f$. The value type of `R_iterator` is `CGAL::Comparison_result`. */ typedef unspecified_type R_iterator; -/*! +/*! A random access iterator type to go rowwise over the matrix \f$ 2D\f$. The value type is a random access iterator type for an individual row that @@ -95,7 +95,7 @@ entry on the main diagonal. */ typedef unspecified_type D_iterator; -/*! +/*! A random access iterator type to go over the entries of the linear objective function vector \f$ c\f$. */ @@ -106,19 +106,19 @@ typedef unspecified_type C_iterator; /// \name Operations /// @{ -/*! +/*! returns the number \f$ n\f$ of variables (number of columns of \f$ A\f$) in `qp`. */ int get_n() const; -/*! +/*! returns the number \f$ m\f$ of constraints (number of rows of \f$ A\f$) in `qp`. */ int get_m() const; -/*! +/*! returns an iterator over the columns of \f$ A\f$. The corresponding past-the-end iterator is `get_a()+get_n()`. For \f$ j=0,\ldots,n-1\f$, `*(get_a()+j)` is a random access @@ -126,14 +126,14 @@ iterator for column \f$ j\f$. */ A_iterator get_a() const; -/*! +/*! returns an iterator over the entries of \f$ \qpb\f$. The corresponding past-the-end iterator is `get_b()+get_m()`. */ B_iterator get_b() const; -/*! +/*! returns an iterator over the entries of \f$ \qprel\f$. The corresponding past-the-end iterator is `get_r()+get_m()`. @@ -143,7 +143,7 @@ stands for \f$ \geq\f$. */ R_iterator get_r() const; -/*! +/*! returns an iterator over the rows of \f$ 2D\f$. The corresponding past-the-end iterator is `get_d()+get_n()`. For \f$ i=0,\ldots,n-1\f$, `*(get_d()+i)` is a random access @@ -154,14 +154,14 @@ of the diagonal are deduced from the symmetry requirement on \f$ D\f$. */ D_iterator get_d() const; -/*! +/*! returns an iterator over the entries of \f$ \qpc\f$. The corresponding past-the-end iterator is `get_c()+get_n()`. */ C_iterator get_c() const; -/*! +/*! returns the constant term \f$ c_0\f$ of the objective function. */ std::iterator_traits::value_type get_c0() const; diff --git a/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h b/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h index 45a38da4e55..32cb3032890 100644 --- a/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h +++ b/QP_solver/doc/QP_solver/Concepts/QuadraticProgram.h @@ -65,7 +65,7 @@ public: /// \name Types /// @{ -/*! +/*! A random access iterator type to go columnwise over the constraint matrix \f$ A\f$. The value type is a random access iterator type for an individual column that @@ -73,46 +73,46 @@ goes over the entries in that column. */ typedef unspecified_type A_iterator; -/*! +/*! A random access iterator type to go over the entries of the right-hand side \f$ \qpb\f$. */ typedef unspecified_type B_iterator; -/*! +/*! A random access iterator type to go over the relations \f$ \qprel\f$. The value type of `R_iterator` is `CGAL::Comparison_result`. */ typedef unspecified_type R_iterator; -/*! +/*! A random access iterator type to go over the existence (finiteness) of the lower bounds \f$ l_j, j=0,\ldots,n-1\f$. The value type of `FL_iterator` is `bool`. */ typedef unspecified_type FL_iterator; -/*! +/*! A random acess iterator type to go over the entries of the lower bound vector \f$ \qpl\f$. */ typedef unspecified_type L_iterator; -/*! +/*! A random access iterator type to go over the existence (finiteness) of the upper bounds \f$ u_j, j=0,\ldots,n-1\f$. The value type of `UL_iterator` is `bool`. */ typedef unspecified_type UL_iterator; -/*! +/*! A random acess iterator type to go over the entries of the upper bound vector \f$ \qpu\f$. */ typedef unspecified_type U_iterator; -/*! +/*! A random access iterator type to go rowwise over the matrix \f$ 2D\f$. The value type is a random access iterator type for an individual row that @@ -121,7 +121,7 @@ entry on the main diagonal. */ typedef unspecified_type D_iterator; -/*! +/*! A random access iterator type to go over the entries of the linear objective function vector \f$ c\f$. */ @@ -132,19 +132,19 @@ typedef unspecified_type C_iterator; /// \name Operations /// @{ -/*! +/*! returns the number \f$ n\f$ of variables (number of columns of \f$ A\f$) in `qp`. */ int get_n() const; -/*! +/*! returns the number \f$ m\f$ of constraints (number of rows of \f$ A\f$) in `qp`. */ int get_m() const; -/*! +/*! returns an iterator over the columns of \f$ A\f$. The corresponding past-the-end iterator is `get_a()+get_n()`. For \f$ j=0,\ldots,n-1\f$, `*(get_a()+j)` is a random access @@ -152,14 +152,14 @@ iterator for column \f$ j\f$. */ A_iterator get_a() const; -/*! +/*! returns an iterator over the entries of \f$ \qpb\f$. The corresponding past-the-end iterator is `get_b()+get_m()`. */ B_iterator get_b() const; -/*! +/*! returns an iterator over the entries of \f$ \qprel\f$. The corresponding past-the-end iterator is `get_r()+get_m()`. @@ -169,7 +169,7 @@ stands for \f$ \geq\f$. */ R_iterator get_r() const; -/*! +/*! returns an iterator over the existence of the lower bounds \f$ l_j, j=0,\ldots,n-1\f$. The corresponding past-the-end iterator is `get_fl()+get_n()`. If @@ -178,7 +178,7 @@ bound given by `*(get_l()+j)`, otherwise it has no lower bound. */ FL_iterator get_fl() const; -/*! +/*! returns an iterator over the entries of \f$ \qpl\f$. The corresponding past-the-end iterator is `get_l()+get_n()`. @@ -187,7 +187,7 @@ If `*(get_fl()+j)` has value \f$ false\f$, the value */ L_iterator get_l() const; -/*! +/*! returns an iterator over the existence of the upper bounds \f$ u_j, j=0,\ldots,n-1\f$. The corresponding past-the-end iterator is `get_fu()+get_n()`. If @@ -196,7 +196,7 @@ bound given by `*(get_u()+j)`, otherwise it has no upper bound. */ FU_iterator get_fu() const; -/*! +/*! returns an iterator over the entries of \f$ \qpu\f$. The corresponding past-the-end iterator is `get_u()+get_n()`. @@ -205,7 +205,7 @@ If `*(get_fu()+j)` has value \f$ false\f$, the value */ L_iterator get_u() const; -/*! +/*! returns an iterator over the rows of \f$ 2D\f$. The corresponding past-the-end iterator is `get_d()+get_n()`. For \f$ i=0,\ldots,n-1\f$, `*(get_d()+i)` is a random access @@ -216,14 +216,14 @@ of the diagonal are deduced from the symmetry requirement on \f$ D\f$. */ D_iterator get_d() const; -/*! +/*! returns an iterator over the entries of \f$ \qpc\f$. The corresponding past-the-end iterator is `get_c()+get_n()`. */ C_iterator get_c() const; -/*! +/*! returns the constant term \f$ c_0\f$ of the objective function. */ std::iterator_traits::value_type get_c0() const; diff --git a/Ridges_3/doc/Ridges_3/CGAL/Ridges.h b/Ridges_3/doc/Ridges_3/CGAL/Ridges.h index be65dcb1694..bb91eb7be78 100644 --- a/Ridges_3/doc/Ridges_3/CGAL/Ridges.h +++ b/Ridges_3/doc/Ridges_3/CGAL/Ridges.h @@ -139,7 +139,7 @@ public: /// \name Types /// @{ -/*! +/*! Order of differential quantities used to distinguish elliptic and hyperbolic ridges. Third (`Tag_3`) or fourth (`Tag_4`) order quantities may be used as @@ -152,7 +152,7 @@ enum Tag_order {Tag_3, Tag_4}; /// \name Creation /// @{ -/*! +/*! The two last property maps may not be used if computations are performed with the parameter `Tag_3`, in which case these @@ -169,21 +169,21 @@ Vertex2VectorPropertyMap& vertex2d2_pm, const Vertex2FTPropertyMap& vertex2P1_pm, const Vertex2FTPropertyMap& vertex2P2_pm); -/*! +/*! Outputs ridges of types `MAX_ELLIPTIC_RIDGE` and `MAX_HYPERBOLIC_RIDGE`. Parameter `it` is an output iterator whose value type is `Ridge_line*`. */ template OutputIterator compute_max_ridges(OutputIterator it, Tag_order ord = Tag_3); -/*! +/*! Outputs ridges of types `MIN_ELLIPTIC_RIDGE` and `MIN_HYPERBOLIC_RIDGE`. Parameter `it` is an output iterator whose value type is `Ridge_line*`. */ template OutputIterator compute_min_ridges(OutputIterator it, Tag_order ord = Tag_3); -/*! +/*! Outputs ridges of types `MAX_CREST_RIDGE` and `MIN_CREST_RIDGE`. Parameter `it` is an output iterator whose value type is `Ridge_line*`. @@ -216,17 +216,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Traits::FT FT; -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Halfedge_handle Halfedge_handle; -/*! +/*! A halfedge crossed by a ridge is paired with the barycentric coordinate of the crossing point. */ @@ -237,7 +237,7 @@ typedef std::pair< Halfedge_handle, FT> Ridge_halfhedge; /// \name Creation /// @{ -/*! +/*! default constructor. */ Ridge_line(); @@ -247,22 +247,22 @@ Ridge_line(); /// \name Access Functions /// @{ -/*! +/*! */ Ridge_type line_type() const; -/*! +/*! */ FT strength() const; -/*! +/*! */ FT sharpness() const; -/*! +/*! */ const std::list* line() const; @@ -303,17 +303,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Traits::FT FT; -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Traits::Vector_3 Vector_3; -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Vertex_handle Vertex_handle; @@ -323,22 +323,22 @@ typedef typename TriangulatedSurfaceMesh::Vertex_handle Vertex_handle; */ struct Vertex_cmp{bool operator();}; -/*! +/*! */ typedef std::map Vertex2FT_map; -/*! +/*! */ typedef boost::associative_property_map< Vertex2FT_map > Vertex2FT_property_map; -/*! +/*! */ typedef std::map Vertex2Vector_map; -/*! +/*! */ typedef boost::associative_property_map< Vertex2Vector_map > Vertex2Vector_property_map; diff --git a/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h b/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h index 8fb5fdc91cf..00155eca771 100644 --- a/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h +++ b/Ridges_3/doc/Ridges_3/CGAL/Umbilics.h @@ -65,7 +65,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Traits::FT FT; @@ -75,7 +75,7 @@ typedef typename TriangulatedSurfaceMesh::Traits::FT FT; /// \name Creation /// @{ -/*! +/*! default constructor. */ Umbilic_approximation(const TriangulatedSurfaceMesh& P, @@ -89,7 +89,7 @@ const Vertex2VectorPropertyMap& vertex2d2_pm); /// \name Operations /// @{ -/*! +/*! Performs the approximation, `size` determines the size of the patches around vertices, taken as `size` times the size of the 1-ring. Umbilics are inserted into the `OutputIterator` `it` with value type `Umbilic*`. @@ -123,12 +123,12 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Vertex_handle Vertex_handle; -/*! +/*! */ typedef typename TriangulatedSurfaceMesh::Halfedge_handle Halfedge_handle; @@ -138,17 +138,17 @@ typedef typename TriangulatedSurfaceMesh::Halfedge_handle Halfedge_handle; /// \name Access Functions /// @{ -/*! +/*! */ Vertex_handle vertex() const; -/*! +/*! */ Umbilic_type umbilic_type() const; -/*! +/*! */ const std::list& contour_list()const; diff --git a/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h b/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h index 019a6e03613..f41b1c48a9f 100644 --- a/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h +++ b/Ridges_3/doc/Ridges_3/Concepts/TriangulatedSurfaceMesh.h @@ -20,155 +20,155 @@ public: /// \name Types /// @{ - /*! + /*! geometric Traits, this is a CGAL::Kernel concept. */ typedef unspecified_type Traits; - /*! + /*! \cgalConcept Opaque type representing a facet of the `TriangulatedSurfaceMesh` . */ class Facet { - /*! + /*! an incident halfedge that points to `facet`. */ Halfedge_const_handle halfedge() const; }; - /*! + /*! \cgalConcept Opaque type representing a vertex of the `TriangulatedSurfaceMesh` . */ class Vertex { public: - /*! + /*! The point associated to the vertex */ Traits::Point_3& point(); }; - /*! + /*! \cgalConcept Opaque type representing a halfedge of the `TriangulatedSurfaceMesh` . */ class Halfedge { public: - /*! + /*! the opposite halfedge. */ Halfedge_const_handle opposite() const; - /*! + /*! the next halfedge around the facet. */ Halfedge_const_handle next() const; - /*! + /*! the previous halfedge around the facet. */ Halfedge_const_handle prev() const; - /*! + /*! is true if `halfedge` or `halfedge.opposite()` is a border halfedge. */ bool is_border_edge() const; - /*! + /*! the incident vertex of `halfedge`. */ Vertex_const_handle vertex() const; - /*! + /*! the incident facet of `halfedge`. If `halfedge` is a border halfedge the result is default construction of the handle. */ Facet_const_handle facet() const; }; - /*! + /*! Handle to a facet. Model of the Handle concept. */ typedef unspecified_type Facet_handle; - /*! + /*! */ typedef unspecified_type Facet_const_handle; - /*! + /*! Iterator over all mesh facets. Model of the ForwardIterator concept. */ typedef unspecified_type Facet_iterator; - /*! + /*! */ typedef unspecified_type Facet_const_iterator; - /*! + /*! Handle to a vertex. Model of the Handle concept. */ typedef unspecified_type Vertex_handle; - /*! + /*! */ typedef unspecified_type Vertex_const_handle; - /*! + /*! Iterator over all vertices of a mesh. Model of the ForwardIterator concept. */ typedef unspecified_type Vertex_iterator; - /*! + /*! */ typedef unspecified_type Vertex_const_iterator; - /*! + /*! Handle to a halfedge. Model of the Handle concept. */ typedef unspecified_type Halfedge_handle; - /*! + /*! */ typedef unspecified_type Halfedge_const_handle; - /*! + /*! Iterator over all halfedges of a `TriangulatedSurfaceMesh` . Model of the ForwardIterator concept. */ typedef unspecified_type Halfedge_iterator; - /*! + /*! */ typedef unspecified_type Halfedge_const_iterator; - /*! + /*! Iterator over all points of a `TriangulatedSurfaceMesh` , its value type is `Traits::Point_3`. Model of the `ForwardIterator` concept. */ typedef unspecified_type Point_iterator; - /*! + /*! */ typedef unspecified_type Point_const_iterator; @@ -178,23 +178,23 @@ public: /// \name Operations /// @{ - /*! + /*! iterator over all facets (excluding holes). */ Facet_const_iterator facets_begin(); - /*! + /*! past-the-end iterator. */ Facet_const_iterator facets_end(); - /*! + /*! iterator over all points. */ Point_iterator points_begin(); - /*! + /*! past-the-end iterator. */ Point_iterator points_end(); diff --git a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h index ac52b139db8..50fa8cb1ada 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Compact_container.h @@ -24,12 +24,12 @@ public: /// \name Operations /// @{ -/*! +/*! Returns the pointer necessary for `Compact_container_traits`. */ void * for_compact_container() const; -/*! +/*! Returns a reference to the pointer necessary for `Compact_container_traits`. */ @@ -120,7 +120,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type value_type; @@ -129,7 +129,7 @@ typedef unspecified_type value_type; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type reference; @@ -138,7 +138,7 @@ typedef unspecified_type reference; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type const_reference; @@ -147,7 +147,7 @@ typedef unspecified_type const_reference; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type pointer; @@ -156,7 +156,7 @@ typedef unspecified_type pointer; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type const_pointer; @@ -165,7 +165,7 @@ typedef unspecified_type const_pointer; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type size_type; @@ -174,7 +174,7 @@ typedef unspecified_type size_type; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type difference_type; @@ -183,7 +183,7 @@ typedef unspecified_type difference_type; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type iterator; @@ -192,7 +192,7 @@ typedef unspecified_type iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type const_iterator; @@ -201,7 +201,7 @@ typedef unspecified_type const_iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type reverse_iterator; @@ -210,7 +210,7 @@ typedef unspecified_type reverse_iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type const_reverse_iterator; @@ -219,7 +219,7 @@ typedef unspecified_type const_reverse_iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type allocator_type; @@ -227,7 +227,7 @@ typedef unspecified_type allocator_type; /// \name Creation /// @{ -/*! +/*! introduces an empty container `cc`, eventually specifying a particular allocator `a` as well. */ @@ -240,7 +240,7 @@ explicit Compact_container(const Allocator &a = Allocator()); /// \name Creation /// @{ -/*! +/*! a container with copies from the range [`first,last`), eventually specifying a particular allocator. */ @@ -255,7 +255,7 @@ const Allocator &a = Allocator()); /// \name Creation /// @{ -/*! +/*! copy constructor. Each item in `cc2` is copied. The allocator is copied. The iterator order is preserved. */ @@ -268,7 +268,7 @@ Compact_container(const Compact_container &cc2); /// \name Creation /// @{ -/*! +/*! assignment. Each item in `cc2` is copied. The allocator is copied. Each item in `c` is deleted. The iterator order is preserved. */ @@ -282,7 +282,7 @@ Compact_container &cc2); /// \name Creation /// @{ -/*! +/*! swaps the contents of `cc` and `cc2` in constant time complexity. No exception is thrown. */ @@ -295,7 +295,7 @@ void swap(Compact_container &cc2); /// \name Creation /// @{ -/*! +/*! if `value` is less than or equal to `capacity()`, this call has no effect. Otherwise, it is a request for allocation of additional memory so that then `capacity()` is greater than or @@ -310,7 +310,7 @@ void reserve(size_type value); /// \name Access Member Functions /// @{ -/*! +/*! returns a mutable iterator referring to the first element in `cc`. */ iterator begin(); @@ -322,7 +322,7 @@ iterator begin(); /// \name Access Member Functions /// @{ -/*! +/*! returns a constant iterator referring to the first element in `cc`. */ const_iterator begin() const; @@ -334,7 +334,7 @@ const_iterator begin() const; /// \name Access Member Functions /// @{ -/*! +/*! returns a mutable iterator which is the past-end-value of `cc`. */ iterator end(); @@ -346,7 +346,7 @@ iterator end(); /// \name Access Member Functions /// @{ -/*! +/*! returns a constant iterator which is the past-end-value of `cc`. */ const_iterator end() const; @@ -358,7 +358,7 @@ const_iterator end() const; /// \name Access Member Functions /// @{ -/*! +/*! */ reverse_iterator rbegin(); @@ -370,7 +370,7 @@ reverse_iterator rbegin(); /// \name Access Member Functions /// @{ -/*! +/*! */ const_reverse_iterator rbegin() const; @@ -382,7 +382,7 @@ const_reverse_iterator rbegin() const; /// \name Access Member Functions /// @{ -/*! +/*! */ reverse_iterator rend(); @@ -394,7 +394,7 @@ reverse_iterator rend(); /// \name Access Member Functions /// @{ -/*! +/*! */ const_reverse_iterator rend() const; @@ -406,7 +406,7 @@ const_reverse_iterator rend() const; /// \name Access Member Functions /// @{ -/*! +/*! returns an iterator which points to `value`. */ iterator iterator_to(reference value) const; @@ -418,7 +418,7 @@ iterator iterator_to(reference value) const; /// \name Access Member Functions /// @{ -/*! +/*! returns an iterator which points to `value`. */ const_iterator iterator_to(const_reference value) const; @@ -430,7 +430,7 @@ const_iterator iterator_to(const_reference value) const; /// \name Access Member Functions /// @{ -/*! +/*! returns an iterator which points to `value`; */ static iterator s_iterator_to(reference value); @@ -442,7 +442,7 @@ static iterator s_iterator_to(reference value); /// \name Access Member Functions /// @{ -/*! +/*! returns an iterator which points to `value`; */ static const_iterator s_iterator_to(const_reference value); @@ -454,7 +454,7 @@ static const_iterator s_iterator_to(const_reference value); /// \name Access Member Functions /// @{ -/*! +/*! returns `true` iff `cc` is empty. */ bool empty() const; @@ -466,7 +466,7 @@ bool empty() const; /// \name Access Member Functions /// @{ -/*! +/*! returns the number of items in `cc`. */ size_type size() const; @@ -478,7 +478,7 @@ size_type size() const; /// \name Access Member Functions /// @{ -/*! +/*! returns the maximum possible size of the container `cc`. */ size_type max_size() const; @@ -490,7 +490,7 @@ size_type max_size() const; /// \name Access Member Functions /// @{ -/*! +/*! returns the total number of elements that `cc` can hold without requiring reallocation. */ @@ -503,7 +503,7 @@ size_type capacity() const; /// \name Access Member Functions /// @{ -/*! +/*! returns the allocator. */ Allocator get_allocator() const; @@ -515,7 +515,7 @@ Allocator get_allocator() const; /// \name Insertion /// @{ -/*! +/*! inserts a copy of `t` in `cc` and returns the iterator pointing to it. */ @@ -528,7 +528,7 @@ iterator insert(const T& t); /// \name Insertion /// @{ -/*! +/*! inserts the range [`first, last`) in `cc`. */ template @@ -541,7 +541,7 @@ void insert(InputIterator first, InputIterator last); /// \name Insertion /// @{ -/*! +/*! erases all the elements of `cc`, then inserts the range [`first, last`) in `cc`. */ @@ -555,7 +555,7 @@ void assign(InputIterator first, InputIterator last); /// \name Insertion /// @{ -/*! +/*! constructs an object of type `T` with the constructor that takes `t1` as argument, inserts it in `cc`, and returns the iterator pointing to it. Overloads of this member function are defined that take additional @@ -571,7 +571,7 @@ iterator emplace(const T1& t1); /// \name Removal /// @{ -/*! +/*! removes the item pointed by `pos` from `cc`. */ void erase(iterator pos); @@ -583,7 +583,7 @@ void erase(iterator pos); /// \name Removal /// @{ -/*! +/*! removes the items from the range [`first, last`) from `cc`. */ void erase(iterator first, iterator last); @@ -595,7 +595,7 @@ void erase(iterator first, iterator last); /// \name Removal /// @{ -/*! +/*! all items in `cc` are deleted, and the memory is deallocated. After this call, `cc` is in the same state as if just default constructed. @@ -627,7 +627,7 @@ bool owns_dereferencable(const_iterator pos); /// \name Merging /// @{ -/*! +/*! adds the items of `cc2` to the end of `cc` and `cc2` becomes empty. The time complexity is O(`cc`.`capacity()`-`cc`.`size()`). \pre `cc2` must not be the same as `cc`, and the allocators of `cc` and `cc2` must be compatible: `cc.get_allocator() == cc2.get_allocator()`. @@ -641,7 +641,7 @@ void merge(Compact_container &cc); /// \name Comparison Operations /// @{ -/*! +/*! test for equality: Two containers are equal, iff they have the same size and if their corresponding elements are equal. */ @@ -654,7 +654,7 @@ bool operator==(const Compact_container &cc) const; /// \name Comparison Operations /// @{ -/*! +/*! test for inequality: returns `!(c == cc)`. */ bool operator!=(const Compact_container &cc) const; @@ -666,7 +666,7 @@ bool operator!=(const Compact_container &cc) const; /// \name Comparison Operations /// @{ -/*! +/*! compares in lexicographical order. */ bool operator<(const Compact_container &cc2) const; @@ -678,7 +678,7 @@ bool operator<(const Compact_container &cc2) const; /// \name Comparison Operations /// @{ -/*! +/*! returns `cc2 (const Compact_container &cc2) const; @@ -690,7 +690,7 @@ bool operator>(const Compact_container &cc2) const; /// \name Comparison Operations /// @{ -/*! +/*! returns `!(cc > cc2)`. */ bool operator<=(const Compact_container &cc2) const; @@ -702,7 +702,7 @@ bool operator<=(const Compact_container &cc2) const; /// \name Comparison Operations /// @{ -/*! +/*! returns `!(cc < cc2)`. */ bool operator>=(const Compact_container &cc2) const; @@ -753,7 +753,7 @@ public: /// \name Operations /// @{ -/*! +/*! Returns the pointer held by `t`. The template version defines this function as: `return t.for_compact_container(); ` @@ -767,7 +767,7 @@ static void * pointer(const T &t); /// \name Operations /// @{ -/*! +/*! Returns a reference to the pointer held by `t`. The template version defines this function as: `return t.for_compact_container();` diff --git a/STL_Extension/doc/STL_Extension/CGAL/Default.h b/STL_Extension/doc/STL_Extension/CGAL/Default.h index 70f65774e2e..c66560b6b9d 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Default.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Default.h @@ -45,7 +45,7 @@ public: /// \name Types /// @{ -/*! +/*! A nested template providing a typedef `type` which equals `Type` if `Parameter` is `Default`, and `Parameter` otherwise. */ diff --git a/STL_Extension/doc/STL_Extension/CGAL/Fourtuple.h b/STL_Extension/doc/STL_Extension/CGAL/Fourtuple.h index 7e14794ac1e..7c672f6a8d9 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Fourtuple.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Fourtuple.h @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef T value_type; @@ -35,7 +35,7 @@ typedef T value_type; /// \name Variables /// @{ -/*! +/*! first element */ T e0; @@ -47,7 +47,7 @@ T e0; /// \name Variables /// @{ -/*! +/*! second element */ T e1; @@ -59,7 +59,7 @@ T e1; /// \name Variables /// @{ -/*! +/*! third element */ T e2; @@ -71,7 +71,7 @@ T e2; /// \name Variables /// @{ -/*! +/*! fourth element */ T e3; @@ -83,7 +83,7 @@ T e3; /// \name Creation /// @{ -/*! +/*! introduces a `Fourtuple` using the default constructor of the elements. */ @@ -96,7 +96,7 @@ Fourtuple(); /// \name Creation /// @{ -/*! +/*! constructs a `Fourtuple` such that `e0` is constructed from `x`, `e1` from `y`, `e2` from `z` and `e3` from `t`. 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 d48578f8e82..a9ba823d6cf 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h +++ b/STL_Extension/doc/STL_Extension/CGAL/In_place_list.h @@ -23,7 +23,7 @@ public: /// \name Variables /// @{ -/*! +/*! forward pointer */ T* next_link; @@ -35,7 +35,7 @@ T* next_link; /// \name Variables /// @{ -/*! +/*! backward pointer */ T* prev_link; @@ -106,7 +106,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type iterator; @@ -115,7 +115,7 @@ typedef unspecified_type iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type const_iterator; @@ -124,7 +124,7 @@ typedef unspecified_type const_iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type value_type; @@ -133,7 +133,7 @@ typedef unspecified_type value_type; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type reference; @@ -142,7 +142,7 @@ typedef unspecified_type reference; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type const_reference; @@ -151,7 +151,7 @@ typedef unspecified_type const_reference; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type size_type; @@ -160,7 +160,7 @@ typedef unspecified_type size_type; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type difference_type; @@ -169,7 +169,7 @@ typedef unspecified_type difference_type; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type reverse_iterator; @@ -178,7 +178,7 @@ typedef unspecified_type reverse_iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type const_reverse_iterator; @@ -187,27 +187,27 @@ typedef unspecified_type const_reverse_iterator; /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type allocator_type; /// @} -/*! +/*! introduces an empty list `ipl`. */ In_place_list(); -/*! +/*! copy constructor. Each item in `l1` is copied. */ In_place_list(const list &l1); -/*! +/*! introduces a list `ipl` with `n` items, all initialized with copies of `t`. */ @@ -216,7 +216,7 @@ In_place_list(size_type n, const T& t = T() -/*! +/*! introduces a list `ipl` with copies from the range [`first,last`). */ @@ -225,7 +225,7 @@ InputIterator first, InputIterator last); -/*! +/*! introduces a list `ipl` with copies from the range [`first,last`). */ @@ -233,7 +233,7 @@ In_place_list( const T* first, const T* last); -/*! +/*! assignment. Each item in `ipl2` is copied. Each item in `ipl` is deleted if the `bool` parameter is `true`. @@ -243,14 +243,14 @@ In_place_list &ipl2); -/*! +/*! swaps the contents of `ipl` with `ipl2`. */ void swap( const In_place_list &ipl2); -/*! +/*! all items in `ipl` are deleted regardless of the `bool` parameter. */ @@ -259,7 +259,7 @@ void destroy(); /// \name Comparison Operations /// @{ -/*! +/*! test for equality: Two lists are equal, iff they have the same size and if their corresponding elements are equal. */ @@ -273,7 +273,7 @@ const; /// \name Comparison Operations /// @{ -/*! +/*! compares in lexicographical order. */ bool operator<(const In_place_list &ipl2) @@ -286,7 +286,7 @@ const; /// \name Access Member Functions /// @{ -/*! +/*! returns a mutable iterator referring to the first element in `ipl`. */ @@ -300,7 +300,7 @@ begin(); /// \name Access Member Functions /// @{ -/*! +/*! returns a constant iterator referring to the first element in `ipl`. */ @@ -313,7 +313,7 @@ const_iterator begin() const; /// \name Access Member Functions /// @{ -/*! +/*! returns a mutable iterator which is the past-end-value of `ipl`. */ @@ -326,7 +326,7 @@ iterator end(); /// \name Access Member Functions /// @{ -/*! +/*! returns a constant iterator which is the past-end-value of `ipl`. */ @@ -339,7 +339,7 @@ const_iterator end() const; /// \name Access Member Functions /// @{ -/*! +/*! returns `true` if `ipl` is empty. */ @@ -352,7 +352,7 @@ bool empty() const; /// \name Access Member Functions /// @{ -/*! +/*! returns the number of items in list `ipl`. */ @@ -365,7 +365,7 @@ size_type size() const; /// \name Access Member Functions /// @{ -/*! +/*! returns the maximum possible size of the list `l`. */ @@ -378,7 +378,7 @@ size_type max_size() const; /// \name Access Member Functions /// @{ -/*! +/*! returns the first item in list `ipl`. */ T& front(); @@ -390,7 +390,7 @@ T& front(); /// \name Access Member Functions /// @{ -/*! +/*! returns the last item in list `ipl`. */ T& back(); @@ -402,7 +402,7 @@ T& back(); /// \name Access Member Functions /// @{ -/*! +/*! returns the allocator. */ allocator_type get_allocator() const; @@ -414,7 +414,7 @@ allocator_type get_allocator() const; /// \name Insertion /// @{ -/*! +/*! inserts an item in front of list `ipl`. */ @@ -427,7 +427,7 @@ void push_front( T&); /// \name Insertion /// @{ -/*! +/*! inserts an item at the back of list `ipl`. */ @@ -440,7 +440,7 @@ void push_back( T&); /// \name Insertion /// @{ -/*! +/*! inserts `t` in front of `pos`. The return value points to the inserted item. @@ -454,7 +454,7 @@ iterator insert(iterator pos, T& t); /// \name Insertion /// @{ -/*! +/*! inserts `t` in front of `pos`. The return value points to the inserted item. @@ -468,7 +468,7 @@ iterator insert(T* pos, T& t); /// \name Insertion /// @{ -/*! +/*! inserts \f$ n\f$ copies of `t` in front of `pos`. */ @@ -481,7 +481,7 @@ void insert(iterator pos, size_type n, const T& t = T()); /// \name Insertion /// @{ -/*! +/*! inserts \f$ n\f$ copies of `t` in front of `pos`. */ @@ -495,7 +495,7 @@ T()); /// \name Insertion /// @{ -/*! +/*! inserts the range [`first, last`) in front of iterator `pos`. */ @@ -509,7 +509,7 @@ InputIterator first, InputIterator last); /// \name Insertion /// @{ -/*! +/*! inserts the range [`first, last`) in front of iterator `pos`. */ @@ -523,7 +523,7 @@ InputIterator first, InputIterator last); /// \name Removal /// @{ -/*! +/*! removes the first item from list `ipl`. */ @@ -536,7 +536,7 @@ void pop_front(); /// \name Removal /// @{ -/*! +/*! removes the last item from list `ipl`. */ @@ -549,7 +549,7 @@ void pop_back(); /// \name Removal /// @{ -/*! +/*! removes the item from list `ipl`, where `pos` refers to. */ @@ -562,7 +562,7 @@ void erase(iterator pos); /// \name Removal /// @{ -/*! +/*! removes the item from list `ipl`, where `pos` refers to. */ @@ -575,7 +575,7 @@ void erase(T* pos); /// \name Removal /// @{ -/*! +/*! */ void erase(iterator first, iterator last); @@ -587,7 +587,7 @@ void erase(iterator first, iterator last); /// \name Removal /// @{ -/*! +/*! removes the items in the range [`first, last`) from `ipl`. */ @@ -600,7 +600,7 @@ void erase(T* first, T* last); /// \name Special List Operations /// @{ -/*! +/*! */ void splice(iterator pos, In_place_list& x); @@ -612,7 +612,7 @@ void splice(iterator pos, In_place_list& x); /// \name Special List Operations /// @{ -/*! +/*! inserts the list `ipl2` before position `pos` and `ipl2` becomes empty. It takes constant time. @@ -628,7 +628,7 @@ ipl2); /// \name Special List Operations /// @{ -/*! +/*! inserts the list `ipl2` before position `pos` and `ipl2` becomes empty. It takes constant time. @@ -644,7 +644,7 @@ iterator i); /// \name Special List Operations /// @{ -/*! +/*! inserts an element pointed to by `i` from list `ipl2` before position `pos` and removes the element from `ipl`. It takes constant time. `i` is a valid dereferenceable iterator of `ipl2`. @@ -659,7 +659,7 @@ void splice(T* pos, In_place_list& ipl2, T* i); /// \name Special List Operations /// @{ -/*! +/*! inserts an element pointed to by `i` from list `ipl2` before position `pos` and removes the element from `ipl`. It takes constant time. `i` is a valid dereferenceable iterator of `ipl2`. @@ -675,7 +675,7 @@ iterator first, iterator last); /// \name Special List Operations /// @{ -/*! +/*! inserts elements in the range [`first, last`) before position `pos` and removes the elements from \f$ x\f$. It takes constant time if `&x == &``l`; @@ -692,7 +692,7 @@ first, T* last); /// \name Special List Operations /// @{ -/*! +/*! erases all elements \f$ e\f$ in the list `ipl` for which `e == value`. It is stable. \pre a suitable `operator==` for the type `T`. @@ -706,7 +706,7 @@ void remove(const T& value); /// \name Special List Operations /// @{ -/*! +/*! erases all but the first element from every consecutive group of equal elements in the list `ipl`. \pre a suitable `operator==` for the type `T`. @@ -720,7 +720,7 @@ void unique(); /// \name Special List Operations /// @{ -/*! +/*! merges the list `ipl2` into the list `ipl` and `ipl2` becomes empty. It is stable. \pre Both lists are increasingly sorted. A suitable `operator<` for the type `T`. @@ -734,7 +734,7 @@ void merge(In_place_list& ipl2); /// \name Special List Operations /// @{ -/*! +/*! reverses the order of the elements in `ipl` in linear time. */ @@ -747,7 +747,7 @@ void reverse(); /// \name Special List Operations /// @{ -/*! +/*! sorts the list `ipl` according to the `operator<` in time \f$ O(n \log n)\f$ where `n = size()`. It is stable. diff --git a/STL_Extension/doc/STL_Extension/CGAL/Multiset.h b/STL_Extension/doc/STL_Extension/CGAL/Multiset.h index 2de0aafac3b..669a01db010 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Multiset.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Multiset.h @@ -126,23 +126,23 @@ In compliance with \stl, the types `value_type` and `key_type` are defined as well. */ /// @{ -/*! +/*! */ typedef unspecified_type iterator; -/*! +/*! bi-directional iterators for the elements stored in the set. */ typedef unspecified_type const_iterator; -/*! +/*! */ typedef unspecified_type reverse_iterator; -/*! +/*! reverse bi-directional iterators for the elements stored in the set. */ typedef unspecified_type const_reverse_iterator; @@ -151,7 +151,7 @@ typedef unspecified_type const_reverse_iterator; /// \name Creation /// @{ -/*! +/*! creates an an empty set `s` that uses a default comparison functor. @@ -165,7 +165,7 @@ Multiset(); /// \name Creation /// @{ -/*! +/*! creates an an empty set `s` that uses the given comparison functor `comp`. @@ -180,7 +180,7 @@ const Compare& comp); /// \name Creation /// @{ -/*! +/*! creates a set `s` containing all elements in the range `[first, last)`, that uses the comparison @@ -198,7 +198,7 @@ const Compare& comp = Compare()); /// \name Creation /// @{ -/*! +/*! copy constructor. */ @@ -212,7 +212,7 @@ const Multiset& other); /// \name Creation /// @{ -/*! +/*! assignment operator. */ @@ -226,7 +226,7 @@ const Multiset& other); /// \name Creation /// @{ -/*! +/*! swaps the contents of `s` with those of the other set. */ @@ -239,7 +239,7 @@ void swap (Multiset& other); /// \name Access Member Functions /// @{ -/*! +/*! the comparison functor used. */ @@ -252,7 +252,7 @@ Compare key_comp() const; /// \name Access Member Functions /// @{ -/*! +/*! the comparison functor used (same as above). Both functions have a non-const version that return a reference @@ -267,7 +267,7 @@ Compare value_comp() const; /// \name Access Member Functions /// @{ -/*! +/*! returns `true` if the set is empty, `false` otherwise. */ @@ -280,7 +280,7 @@ bool empty (); /// \name Access Member Functions /// @{ -/*! +/*! returns the number of elements stored in the set. */ @@ -293,7 +293,7 @@ size_t size (); /// \name Access Member Functions /// @{ -/*! +/*! returns the maximal number of elements the set can store (same as `size()`). @@ -307,7 +307,7 @@ size_t max_size (); /// \name Access Member Functions /// @{ -/*! +/*! returns an iterator pointing to the first element stored in the set (a `const` version is also available). @@ -321,7 +321,7 @@ iterator begin(); /// \name Access Member Functions /// @{ -/*! +/*! returns an iterator pointing beyond the last element stored in the set (a `const` version is also available). @@ -335,7 +335,7 @@ iterator end(); /// \name Access Member Functions /// @{ -/*! +/*! returns a reverse iterator pointing beyond the last element stored in the set (a `const` version is also available). @@ -349,7 +349,7 @@ reverse_iterator rbegin(); /// \name Access Member Functions /// @{ -/*! +/*! returns a reverse iterator pointing to the first element stored in the set (a `const` version is also available). @@ -363,7 +363,7 @@ reverse_iterator rend(); /// \name Comparison Operations /// @{ -/*! +/*! returns `true` if the sequences of elements in the two sets are pairwise equal (using the comparison functor). @@ -378,7 +378,7 @@ const Multiset& other) const; /// \name Comparison Operations /// @{ -/*! +/*! returns `true` if the element sequence in `s` is lexicographically smaller than the element sequence of `other`. @@ -393,7 +393,7 @@ const Multiset& other) const; /// \name Insertion Methods /// @{ -/*! +/*! inserts the element `x` into the set and returns an iterator pointing to the newly inserted element. @@ -407,7 +407,7 @@ iterator insert (const Type& x); /// \name Insertion Methods /// @{ -/*! +/*! inserts all elements in the range `[first, last)` into the set. @@ -422,7 +422,7 @@ void insert (InputIterator first, InputIterator last); /// \name Insertion Methods /// @{ -/*! +/*! inserts the element `x` with a given iterator used as a hint for the position of the new element. It Returns an iterator pointing to the @@ -437,7 +437,7 @@ iterator insert (iterator position, const Type& x); /// \name Insertion Methods /// @{ -/*! +/*! inserts the element `x` as the predecessor of the element at the given position. @@ -454,7 +454,7 @@ iterator insert_before (iterator position, const Type& x); /// \name Insertion Methods /// @{ -/*! +/*! inserts the element `x` as the successor of the element at the given position. @@ -471,7 +471,7 @@ iterator insert_after (iterator position, const Type& x); /// \name Removal Methods /// @{ -/*! +/*! erases all elements equivalent to `x` from the set and returns the number of erased elements. @@ -485,7 +485,7 @@ size_t erase (const Type& x); /// \name Removal Methods /// @{ -/*! +/*! erases the element pointed by `position`. */ @@ -498,7 +498,7 @@ void erase (iterator position); /// \name Removal Methods /// @{ -/*! +/*! clears the set (erases all stored elements). */ @@ -517,7 +517,7 @@ functor, as the `Compare` functor will be used by default. */ /// @{ -/*! +/*! searches for the an element equivalent to `key` in the set. If the set contains objects equivalent to `key`, it returns an iterator @@ -527,14 +527,14 @@ pointing to the first one. Otherwise, `end()` is returned (a template iterator find (const Key& key, const CompareKey& comp_key); -/*! +/*! returns the number of elements equivalent to `key` in the set. */ template size_t count (const Key& key, const CompareKey& comp_key) const; -/*! +/*! returns an iterator pointing to the first element in the set that is not less than `key`. If all set elements are less than `key`, @@ -543,7 +543,7 @@ less than `key`. If all set elements are less than `key`, template iterator lower_bound (const Key& key, const CompareKey& comp_key); -/*! +/*! returns an iterator pointing to the first element in the set that is greater than `key`. If no set element is greater than `key`, @@ -552,7 +552,7 @@ greater than `key`. If no set element is greater than `key`, template iterator upper_bound (const Key& key, const CompareKey& comp_key); -/*! +/*! returns the range of set elements equivalent to the given key, namely `(lower_bound(key), upper_bound(key))` (a `const` version is @@ -563,7 +563,7 @@ std::pair equal_range (const Key& key, const CompareKey& comp_key); -/*! +/*! returns a pair comprised of `lower_bound(key)` and a Boolean flag indicating whether this iterator points to an element equivalent to @@ -579,7 +579,7 @@ find_lower (const Key& key, const CompareKey& comp_key); /// \name Special Operations /// @{ -/*! +/*! replaces the element stored at the given position with `x`. \pre The operation does not violate the set order - that is, @@ -595,7 +595,7 @@ void replace (iterator position, const Type& x); /// \name Special Operations /// @{ -/*! +/*! swaps places between the two elements given by `pos1` and `pos2`. \pre The operation does not violate the set order - that is, @@ -610,7 +610,7 @@ void swap (iterator pos1, iterator pos2); /// \name Special Operations /// @{ -/*! +/*! concatenates all elements in `s_prime` into `s` and clears `s_prime`. @@ -627,7 +627,7 @@ void catenate (Self& s_prime); /// \name Special Operations /// @{ -/*! +/*! splits `s` such that it contains all elements that are less than the given `key` and such that `s_prime` contains all other elements. @@ -643,7 +643,7 @@ void split (Key key, CompareKey comp_key, Self& s_prime); /// \name Special Operations /// @{ -/*! +/*! splits `s` such that it contains all set elements in the range `[begin, position)` and such that `s_prime` contains all elements diff --git a/STL_Extension/doc/STL_Extension/CGAL/Object.h b/STL_Extension/doc/STL_Extension/CGAL/Object.h index a532fd12a08..325ba92e937 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Object.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Object.h @@ -98,12 +98,12 @@ public: /// \name Creation /// Objects of type `Object` are normally created using the global function `make_object`. /// @{ -/*! +/*! introduces an empty object. */ Object(); -/*! +/*! Copy constructor. */ Object(const Object &o); @@ -126,7 +126,7 @@ Object(boost::optional< boost::variant >); /// \name Operations /// @{ -/*! +/*! Assignment. */ Object &operator=(const Object &o); @@ -136,7 +136,7 @@ Object &operator=(const Object &o); /// \name Operations /// @{ -/*! +/*! returns true, if `obj` does not contain an object of type `T`. */ @@ -146,7 +146,7 @@ bool empty(); /// \name Operations /// @{ -/*! +/*! returns true, iff `obj` contains an object of type `T`. */ template bool is(); @@ -158,7 +158,7 @@ template bool is(); /// \name Operations /// @{ -/*! +/*! returns the type information of the contained type, or `typeid(void)` if empty. */ @@ -170,14 +170,14 @@ const std::type_info & type() const; -/*! +/*! Creates an object that contains `t`. \relates Object */ template Object make_object(const T &t); -/*! +/*! assigns `o` to `c` if `o` was constructed from an object of type `T`. Returns `true`, if the assignment was possible. For efficiency @@ -188,14 +188,14 @@ reasons, we recommend using `object_cast` instead. template bool assign(T& c, const Object& o); -/*! +/*! Returns a pointer to the object of type `T` stored by `o`, if any, otherwise returns `NULL`. \relates Object */ template const T * object_cast(const Object * o); -/*! +/*! Returns a copy of the object of type `T` stored by `o`, if any, otherwise throws an exception of type `Bad_object_cast`. \relates Object diff --git a/STL_Extension/doc/STL_Extension/CGAL/Sixtuple.h b/STL_Extension/doc/STL_Extension/CGAL/Sixtuple.h index 089268a25f9..2d8e19cd729 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Sixtuple.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Sixtuple.h @@ -21,7 +21,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef T value_type; @@ -33,7 +33,7 @@ typedef T value_type; /// \name Variables /// @{ -/*! +/*! first element */ T e0; @@ -45,7 +45,7 @@ T e0; /// \name Variables /// @{ -/*! +/*! second element */ T e1; @@ -57,7 +57,7 @@ T e1; /// \name Variables /// @{ -/*! +/*! third element */ T e2; @@ -69,7 +69,7 @@ T e2; /// \name Variables /// @{ -/*! +/*! fourth element */ T e3; @@ -81,7 +81,7 @@ T e3; /// \name Variables /// @{ -/*! +/*! fifth element */ T e4; @@ -93,7 +93,7 @@ T e4; /// \name Variables /// @{ -/*! +/*! sixth element */ T e5; @@ -105,7 +105,7 @@ T e5; /// \name Creation /// @{ -/*! +/*! introduces a `Sixtuple` using the default constructor of the elements. */ @@ -118,7 +118,7 @@ Sixtuple(); /// \name Creation /// @{ -/*! +/*! constructs a `Sixtuple` such that `e0` is constructed from `x`, `e1` from `y`, `e2` from `z`, `e3` from `t`, `e4` from diff --git a/STL_Extension/doc/STL_Extension/CGAL/Twotuple.h b/STL_Extension/doc/STL_Extension/CGAL/Twotuple.h index b78815a62cc..18c5129c19a 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Twotuple.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Twotuple.h @@ -22,7 +22,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef T value_type; @@ -34,7 +34,7 @@ typedef T value_type; /// \name Variables /// @{ -/*! +/*! first element */ T e0; @@ -46,7 +46,7 @@ T e0; /// \name Variables /// @{ -/*! +/*! second element */ T e1; @@ -58,7 +58,7 @@ T e1; /// \name Creation /// @{ -/*! +/*! introduces a `Twotuple` using the default constructor of the elements. */ @@ -71,7 +71,7 @@ Twotuple(); /// \name Creation /// @{ -/*! +/*! constructs a `Twotuple` such that `e0` is constructed from `x` and `e1` is constructed from `y`. diff --git a/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h b/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h index f804a2132f7..47a3df0b660 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h +++ b/STL_Extension/doc/STL_Extension/CGAL/Uncertain.h @@ -52,7 +52,7 @@ public: /// \name Types /// @{ -/*! +/*! The type `T`. */ typedef unspecified_type value_type; @@ -61,7 +61,7 @@ typedef unspecified_type value_type; /// \name Types /// @{ -/*! +/*! The type of the exception thrown for uncertain conversions. It is a typedef to the type `CGAL::Uncertain_conversion_exception` which derives from `std::range_error`. @@ -71,7 +71,7 @@ typedef unspecified_type Uncertain_conversion_exception; /// \name Creation /// @{ -/*! +/*! introduces a certain object with value `T()`. */ Uncertain(); @@ -83,7 +83,7 @@ Uncertain(); /// \name Creation /// @{ -/*! +/*! introduces a certain object with value `t`. */ Uncertain(T t); @@ -95,7 +95,7 @@ Uncertain(T t); /// \name Creation /// @{ -/*! +/*! assigns the certain value `t` to `u`. */ Uncertain& operator=(T t); @@ -107,7 +107,7 @@ Uncertain& operator=(T t); /// \name Creation /// @{ -/*! +/*! introduces an object representing the range with lower bound `i` and upper bound `s`. \pre \f$ i<= s\f$. */ @@ -122,17 +122,17 @@ Uncertain(T i, T s); /// The following functions are meant to be used very rarely, they provide ways to inspect /// the content of an `Uncertain` object. /// @{ -/*! +/*! returns the lower bound of the range represented by `u`. */ T inf() const; -/*! +/*! returns the upper bound of the range represented by `u`. */ T sup() const; -/*! +/*! returns true whether `u` and `u` are the same range (equality as sets). */ bool is_same(Uncertain u) const; @@ -176,13 +176,13 @@ bool is_same(Uncertain u) const; /// on the context. They are listed in the sequel. /// @{ -/*! +/*! returns `true` iff the value is certain, that is, it is unique, the range is a singleton. That is, `u.inf() == u.sup()`. */ bool is_certain() const; -/*! +/*! if `u`.`is_certain()`, then returns the certain value which is represented. Otherwise, throws an exception of type `Uncertain_conversion_exception`. A profile counter of the number of such exceptions thrown during the execution of @@ -190,7 +190,7 @@ the program is available with `CGAL_PROFILE`. */ T make_certain() const; -/*! +/*! conversion operator to `T`. It does and returns the same thing as `u`. `make_certain()`. Note that relying on the automatic conversion can throw exceptions, which defeats the purpose of propagating uncertainty. @@ -201,7 +201,7 @@ operator T() const; ///@} -/*! +/*! returns an indeterminate range. */ static Uncertain indeterminate(); @@ -215,37 +215,37 @@ over the type `T`. */ /// @{ -/*! +/*! returns the extension of the equality operator over `u` and `v`. */ template Uncertain operator==(Uncertain u, Uncertain v); -/*! +/*! returns `u == make_uncertain(v)`. */ template Uncertain operator==(Uncertain u, T v); -/*! +/*! returns `v == u`. */ template Uncertain operator==(T u, Uncertain v); -/*! +/*! returns the extension of the inequality operator over `u` and `v`. */ template Uncertain operator!=(Uncertain u, Uncertain v); -/*! +/*! returns `u != make_uncertain(v)`. */ template Uncertain operator!=(Uncertain u, T v); -/*! +/*! returns `v != u`. */ template @@ -332,43 +332,43 @@ Uncertain res = CGAL_OR( q.x() == 0 , q.y() == 0 ); */ /// @{ -/*! +/*! returns the range containing the negated values of `u`. */ Uncertain operator!(Uncertain u); -/*! +/*! returns the range containing the values computed as logical or from `u` and `v`. */ Uncertain operator|(Uncertain u, Uncertain v); -/*! +/*! returns `u | make_uncertain(v)`. */ Uncertain operator|(Uncertain u, bool v); -/*! +/*! returns `v | u`. */ Uncertain operator|(bool u, Uncertain v); -/*! +/*! returns the range containing the values computed as logical and from `u` and `v`. */ Uncertain operator&(Uncertain u, Uncertain v); -/*! +/*! returns `u & make_uncertain(v)`. */ Uncertain operator&(Uncertain u, bool v); -/*! +/*! returns `v & u`. */ @@ -380,91 +380,91 @@ Uncertain operator&(bool u, Uncertain v); /// \name Overloaded Operators and Functions for Uncertain Only /// @{ -/*! +/*! returns the extension of the less-than operator over `u` and `v`. */ template Uncertain operator<(Uncertain u, Uncertain v); -/*! +/*! returns `u < make_uncertain(v)`. */ template Uncertain operator<(Uncertain u, T v); -/*! +/*! returns `make_uncertain(u) < v`. */ template Uncertain operator<(T u, Uncertain v); -/*! +/*! returns the extension of the greater-than operator over `u` and `v`. */ template Uncertain operator>(Uncertain u, Uncertain v); -/*! +/*! returns `u > make_uncertain(v)`. */ template Uncertain operator>(Uncertain u, T v); -/*! +/*! returns `make_uncertain(u) > v`. */ template Uncertain operator>(T u, Uncertain v); -/*! +/*! returns the extension of the less-than or equal operator over `u` and `v`. */ template Uncertain operator<=(Uncertain u, Uncertain v); -/*! +/*! returns `u <= make_uncertain(v)`. */ template Uncertain operator<=(Uncertain u, T v); -/*! +/*! returns `make_uncertain(u) <= v`. */ template Uncertain operator<=(T u, Uncertain v); -/*! +/*! returns the extension of the greater-than or equal operator over `u` and `v`. */ template Uncertain operator>=(Uncertain u, Uncertain v); -/*! +/*! returns `u > make_uncertain(v)`. */ template Uncertain operator>=(Uncertain u, T v); -/*! +/*! returns `make_uncertain(u) >= v`. */ template Uncertain operator>=(T u, Uncertain v); -/*! +/*! returns the extension of the multiplication operator over `u` and `v`. This requires `T` to have a multiplication operator as well. @@ -472,28 +472,28 @@ This requires `T` to have a multiplication operator as well. template Uncertain operator*(Uncertain u, Uncertain v); -/*! +/*! returns `u * make_uncertain(v)`. */ template Uncertain operator*(Uncertain u, T v); -/*! +/*! returns `make_uncertain(u) * v`. */ template Uncertain operator<(T u, Uncertain v); -/*! +/*! returns the extension of the unary minus operator over `u`. */ template Uncertain operator-(Uncertain u); -/*! +/*! returns the extension of the `enum_cast` function over `u`. */ @@ -504,31 +504,31 @@ Uncertain enum_cast(Uncertain u); }; /* end Uncertain */ -/*! +/*! returns `u.inf()`. \relates Uncertain */ template T inf(Uncertain u); -/*! +/*! returns `u.sup()`. \relates Uncertain */ template T sup(Uncertain u); -/*! +/*! returns `true`. \relates Uncertain */ template bool is_certain(T t); -/*! +/*! returns `u`.`is_certain`(). \relates Uncertain */ template bool is_certain(Uncertain u); -/*! +/*! returns `U::indeterminate()` if `U` is `Uncertain`, and `U()` otherwise. @@ -536,49 +536,49 @@ and `U()` otherwise. */ template U indeterminate(); -/*! +/*! returns `false`. \relates Uncertain */ template bool is_indeterminate(T u); -/*! +/*! returns `!is_certain(u)`. \relates Uncertain */ template bool is_indeterminate(Uncertain u); -/*! +/*! returns `t`. \relates Uncertain */ template T get_certain(T t); -/*! +/*! returns `u`.`make_certain`(). \pre `u`.`is_certain`(). \relates Uncertain */ template T get_certain(Uncertain u); -/*! +/*! returns `t`. \relates Uncertain */ template T make_certain(T t); -/*! +/*! returns `u`.`make_certain`(). \relates Uncertain */ template T make_certain(Uncertain u); -/*! +/*! returns `Uncertain(u)`. \relates Uncertain */ template Uncertain make_uncertain(T t); -/*! +/*! returns `u`. \relates Uncertain */ @@ -596,53 +596,53 @@ template Uncertain make_uncertain(Uncertain u); */ #define CGAL_OR_3 -/*! +/*! returns `true` iff `u`.`is_certain()`, and the `u`.`make_certain`() returns `true`. \relates Uncertain */ bool certainly(Uncertain u); -/*! +/*! returns `u`. \relates Uncertain */ bool certainly(bool u); -/*! +/*! returns `true` iff `u`.`is_certain()` returns `false`, or if `u`.`make_certain`() returns `true`. \relates Uncertain */ bool possibly(Uncertain u); -/*! +/*! returns `u`. \relates Uncertain */ bool possibly(bool u); -/*! +/*! returns `true` iff `u`.`is_certain()`, and the `u`.`make_certain`() returns `false`. \relates Uncertain */ bool certainly_not(Uncertain u); -/*! +/*! returns `!u`. \relates Uncertain */ bool certainly_not(bool u); -/*! +/*! returns `true` iff `u`.`is_certain()` returns `false`, or if `u`.`make_certain`() returns `false`. \relates Uncertain */ bool possibly_not(Uncertain u); -/*! +/*! returns `!u`. \relates Uncertain */ diff --git a/STL_Extension/doc/STL_Extension/CGAL/array.h b/STL_Extension/doc/STL_Extension/CGAL/array.h index 2147ebf378a..5ff4e7c847f 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/array.h +++ b/STL_Extension/doc/STL_Extension/CGAL/array.h @@ -27,7 +27,7 @@ template< typename T, int > class array { }; /* end cpp11::array */ -/*! +/*! \relates cpp11::array \returns `array` where `N` is the number of arguments given to diff --git a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h index 26c2c950e43..a869555935e 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/function_objects.h +++ b/STL_Extension/doc/STL_Extension/CGAL/function_objects.h @@ -23,21 +23,21 @@ public: -/*! +/*! */ typedef Arg argument_type; -/*! +/*! */ typedef Result result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Cast_function_object(); @@ -49,7 +49,7 @@ Cast_function_object(); /// \name Operations /// @{ -/*! +/*! returns `(Result)x`. */ @@ -62,7 +62,7 @@ result_type& operator()(argument_type& x) const; /// \name Operations /// @{ -/*! +/*! returns `(Result)x`. */ const result_type& operator()(const argument_type& @@ -104,7 +104,7 @@ public: /// \name Types /// @{ -/*! +/*! type of the composed functor. */ typedef unspecified_type Type; @@ -160,7 +160,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of argument. */ typedef Arg argument_type; @@ -169,7 +169,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -177,7 +177,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a)`. */ @@ -213,7 +213,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of first argument. */ typedef Arg1 argument1_type; @@ -222,7 +222,7 @@ typedef Arg1 argument1_type; /// \name Requirements /// @{ -/*! +/*! type of second argument. */ typedef Arg2 argument2_type; @@ -231,7 +231,7 @@ typedef Arg2 argument2_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -239,7 +239,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2)`. */ result_type operator()(argument_type1 a1, argument_type2 @@ -277,7 +277,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of first argument. */ typedef Arg1 argument1_type; @@ -286,7 +286,7 @@ typedef Arg1 argument1_type; /// \name Requirements /// @{ -/*! +/*! type of second argument. */ typedef Arg2 argument2_type; @@ -295,7 +295,7 @@ typedef Arg2 argument2_type; /// \name Requirements /// @{ -/*! +/*! type of third argument. */ typedef Arg3 argument3_type; @@ -304,7 +304,7 @@ typedef Arg3 argument3_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -312,7 +312,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3)`. */ @@ -351,7 +351,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of first argument. */ typedef Arg1 argument1_type; @@ -360,7 +360,7 @@ typedef Arg1 argument1_type; /// \name Requirements /// @{ -/*! +/*! type of second argument. */ typedef Arg2 argument2_type; @@ -369,7 +369,7 @@ typedef Arg2 argument2_type; /// \name Requirements /// @{ -/*! +/*! type of third argument. */ typedef Arg3 argument3_type; @@ -378,7 +378,7 @@ typedef Arg3 argument3_type; /// \name Requirements /// @{ -/*! +/*! type of 4th argument. */ typedef Arg4 argument4_type; @@ -387,7 +387,7 @@ typedef Arg4 argument4_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -395,7 +395,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4)`. */ @@ -434,7 +434,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of first argument. */ typedef Arg1 argument1_type; @@ -443,7 +443,7 @@ typedef Arg1 argument1_type; /// \name Requirements /// @{ -/*! +/*! type of second argument. */ typedef Arg2 argument2_type; @@ -452,7 +452,7 @@ typedef Arg2 argument2_type; /// \name Requirements /// @{ -/*! +/*! type of third argument. */ typedef Arg3 argument3_type; @@ -461,7 +461,7 @@ typedef Arg3 argument3_type; /// \name Requirements /// @{ -/*! +/*! type of 4th argument. */ typedef Arg4 argument4_type; @@ -470,7 +470,7 @@ typedef Arg4 argument4_type; /// \name Requirements /// @{ -/*! +/*! type of 5th argument. */ typedef Arg5 argument5_type; @@ -479,7 +479,7 @@ typedef Arg5 argument5_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -487,7 +487,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4, a5)`. */ result_type operator()(argument_type1 a1, argument_type2 @@ -526,7 +526,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arge argument_type; @@ -535,7 +535,7 @@ typedef Arge argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -543,7 +543,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2)`. */ result_type operator()(argument_type a1, argument_type a2) @@ -581,7 +581,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -590,7 +590,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -598,7 +598,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3)`. */ result_type operator()(argument_type a1, argument_type a2, @@ -636,7 +636,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -645,7 +645,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -653,7 +653,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4)`. */ @@ -692,7 +692,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -701,7 +701,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -709,7 +709,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4, a5)`. */ result_type operator()(argument_type a1, argument_type a2, @@ -748,7 +748,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -757,7 +757,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -765,7 +765,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4, a5, a6)`. */ @@ -805,7 +805,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -814,7 +814,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -822,7 +822,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4, a5, a6, a7)`. */ @@ -862,7 +862,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -871,7 +871,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -879,7 +879,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4, a5, a6, a7, a8)`. */ @@ -920,7 +920,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -929,7 +929,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -937,7 +937,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(a1, a2, a3, a4, a5, a6, a7, a8, a9)`. */ @@ -978,7 +978,7 @@ public: /// \name Requirements /// @{ -/*! +/*! type of arguments. */ typedef Arg argument_type; @@ -987,7 +987,7 @@ typedef Arg argument_type; /// \name Requirements /// @{ -/*! +/*! type of object to create. */ typedef Result result_type; @@ -995,7 +995,7 @@ typedef Result result_type; /// \name Requirements /// @{ -/*! +/*! returns `result_type(d, a1, a2)`. */ result_type operator()(argument_type a1, argument_type a2) @@ -1030,18 +1030,18 @@ class Dereference { public: -/*! +/*! */ typedef Value* argument_type; -/*! +/*! */ typedef Value result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Dereference(); @@ -1053,7 +1053,7 @@ Dereference(); /// \name Operations /// @{ -/*! +/*! returns `*x`. */ @@ -1066,7 +1066,7 @@ result_type& operator()(argument_type& x) const; /// \name Operations /// @{ -/*! +/*! returns `*x`. */ const result_type& operator()(const argument_type& @@ -1102,17 +1102,17 @@ class Get_address { public: -/*! +/*! */ typedef Value argument_type; -/*! +/*! */ typedef Value* result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Get_address(); @@ -1124,7 +1124,7 @@ Get_address(); /// \name Operations /// @{ -/*! +/*! returns `&x`. */ @@ -1137,7 +1137,7 @@ result_type& operator()(argument_type& x) const; /// \name Operations /// @{ -/*! +/*! returns `&x`. */ const result_type& operator()(const argument_type& @@ -1172,18 +1172,18 @@ class Identity { public: -/*! +/*! */ typedef Value argument_type; -/*! +/*! */ typedef Value result_type; /// @} /// \name Creation /// @{ -/*! +/*! default constructor. */ Identity(); @@ -1195,7 +1195,7 @@ Identity(); /// \name Operations /// @{ -/*! +/*! returns `x`. */ @@ -1208,7 +1208,7 @@ result_type& operator()(argument_type& x) const; /// \name Operations /// @{ -/*! +/*! returns `x`. */ const result_type& operator()(const argument_type& @@ -1243,18 +1243,18 @@ class Project_facet { public: -/*! +/*! */ typedef Node argument_type; -/*! +/*! */ typedef Node::Facet result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_facet(); @@ -1266,7 +1266,7 @@ Project_facet(); /// \name Operations /// @{ -/*! +/*! returns `n.facet()`. */ result_type& operator()(argument_type& n) const; @@ -1278,7 +1278,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n.facet()`. */ const result_type& operator()(const argument_type& @@ -1314,17 +1314,17 @@ class Project_next { public: -/*! +/*! */ typedef Node* argument_type; -/*! +/*! */ typedef Node* result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_next(); @@ -1336,7 +1336,7 @@ Project_next(); /// \name Operations /// @{ -/*! +/*! returns `n->next()`. */ result_type& operator()(argument_type& n) const; @@ -1348,7 +1348,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n->next()`. */ const result_type& operator()(const argument_type& @@ -1383,18 +1383,18 @@ class Project_next_opposite { public: -/*! +/*! */ typedef Node* argument_type; -/*! +/*! */ typedef Node* result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_next_opposite(); @@ -1406,7 +1406,7 @@ Project_next_opposite(); /// \name Operations /// @{ -/*! +/*! returns `n->next()->opposite()`. */ @@ -1419,7 +1419,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n->next()->opposite()`. */ const result_type& operator()(const argument_type& @@ -1455,18 +1455,18 @@ class Project_normal { public: -/*! +/*! */ typedef Node argument_type; -/*! +/*! */ typedef Node::Normal result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_normal(); @@ -1478,7 +1478,7 @@ Project_normal(); /// \name Operations /// @{ -/*! +/*! returns `n.normal()`. */ @@ -1491,7 +1491,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n.normal()`. */ const result_type& operator()(const argument_type& @@ -1527,18 +1527,18 @@ class Project_opposite_prev { public: -/*! +/*! */ typedef Node* argument_type; -/*! +/*! */ typedef Node* result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_opposite_prev(); @@ -1550,7 +1550,7 @@ Project_opposite_prev(); /// \name Operations /// @{ -/*! +/*! returns `n->opposite()->prev()`. */ @@ -1563,7 +1563,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n->opposite()->prev()`. */ const result_type& operator()(const argument_type& @@ -1599,18 +1599,18 @@ class Project_plane { public: -/*! +/*! */ typedef Node argument_type; -/*! +/*! */ typedef Node::Plane result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_plane(); @@ -1622,7 +1622,7 @@ Project_plane(); /// \name Operations /// @{ -/*! +/*! returns `n.plane()`. */ @@ -1635,7 +1635,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n.plane()`. */ const result_type& operator()(const argument_type& @@ -1670,18 +1670,18 @@ class Project_point { public: -/*! +/*! */ typedef Node argument_type; -/*! +/*! */ typedef Node::Point result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_point(); @@ -1693,7 +1693,7 @@ Project_point(); /// \name Operations /// @{ -/*! +/*! returns `n.point()`. */ @@ -1706,7 +1706,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n.point()`. */ const result_type& operator()(const argument_type& @@ -1741,11 +1741,11 @@ class Project_prev { public: -/*! +/*! */ typedef Node* argument_type; -/*! +/*! */ typedef Node* result_type; @@ -1753,7 +1753,7 @@ typedef Node* result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_prev(); @@ -1765,7 +1765,7 @@ Project_prev(); /// \name Operations /// @{ -/*! +/*! returns `n->prev()`. */ result_type& operator()(argument_type& n) const; @@ -1777,7 +1777,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n->prev()`. */ const result_type& operator()(const argument_type& @@ -1812,18 +1812,18 @@ class Project_vertex { public: -/*! +/*! */ typedef Node argument_type; -/*! +/*! */ typedef Node::Vertex result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Project_vertex(); @@ -1835,7 +1835,7 @@ Project_vertex(); /// \name Operations /// @{ -/*! +/*! returns `n.vertex()`. */ @@ -1848,7 +1848,7 @@ result_type& operator()(argument_type& n) const; /// \name Operations /// @{ -/*! +/*! returns `n.vertex()`. */ const result_type& operator()(const argument_type& diff --git a/STL_Extension/doc/STL_Extension/CGAL/tags.h b/STL_Extension/doc/STL_Extension/CGAL/tags.h index 2352ab3afa9..748f7e0961c 100644 --- a/STL_Extension/doc/STL_Extension/CGAL/tags.h +++ b/STL_Extension/doc/STL_Extension/CGAL/tags.h @@ -17,7 +17,7 @@ public: /// \name Constants /// @{ -/*! +/*! */ static const bool value; diff --git a/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h b/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h index 4d7b01f1b69..9c1c3f8f086 100644 --- a/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h +++ b/STL_Extension/doc/STL_Extension/Concepts/Projection_object.h @@ -35,7 +35,7 @@ public: /// \name Definition /// @{ -/*! +/*! argument type. */ typedef unspecified_type argument_type; @@ -44,7 +44,7 @@ typedef unspecified_type argument_type; /// \name Definition /// @{ -/*! +/*! result type. */ typedef unspecified_type result_type; @@ -52,7 +52,7 @@ typedef unspecified_type result_type; /// \name Creation /// @{ -/*! +/*! default constructor. */ Projection_object(); @@ -64,7 +64,7 @@ Projection_object(); /// \name Operations /// @{ -/*! +/*! */ result_type& operator()(argument_type &) const; @@ -76,7 +76,7 @@ result_type& operator()(argument_type &) const; /// \name Operations /// @{ -/*! +/*! */ const result_type& operator()(const argument_type &) const; diff --git a/SearchStructures/doc/SearchStructures/CGAL/Range_segment_tree_traits.h b/SearchStructures/doc/SearchStructures/CGAL/Range_segment_tree_traits.h index 412d191dffa..b7d677ad267 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Range_segment_tree_traits.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Range_segment_tree_traits.h @@ -16,12 +16,12 @@ public: /// \name Types /// @{ -/*! +/*! */ Point_2 Key; -/*! +/*! */ std::pair Interval; @@ -48,12 +48,12 @@ public: /// \name Types /// @{ -/*! +/*! */ Point_3 Key; -/*! +/*! */ std::pair Interval; @@ -82,12 +82,12 @@ public: /// \name Types /// @{ -/*! +/*! */ std::pair Key; -/*! +/*! */ std::pair Interval; @@ -116,12 +116,12 @@ public: /// \name Types /// @{ -/*! +/*! */ std::pair Key; -/*! +/*! */ std::pair Interval; @@ -150,12 +150,12 @@ public: /// \name Types /// @{ -/*! +/*! */ R::Point_2 Key; -/*! +/*! */ std::pair,T> Interval; @@ -184,12 +184,12 @@ public: /// \name Types /// @{ -/*! +/*! */ std::pair Key; -/*! +/*! */ std::pair,T> Interval; diff --git a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h index d47e4fbab7c..15e8a9b87ca 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_d.h @@ -23,17 +23,17 @@ public: /// \name Types /// @{ -/*! +/*! container `Data`. */ typedef unspecified_type Data; -/*! +/*! container `Window`. */ typedef unspecified_type Window; -/*! +/*! container `Traits`. */ typedef unspecified_type Traits; @@ -43,7 +43,7 @@ typedef unspecified_type Traits; /// \name Creation /// @{ -/*! +/*! A range tree is constructed, such that the subtree of each vertex is of the @@ -83,7 +83,7 @@ r(Tree_base sublayer_tree); /// \name Operations /// @{ -/*! +/*! The tree is constructed according to the data items in the sequence between the element pointed by iterator `first` and iterator `last`. The data items of the iterator must @@ -93,7 +93,7 @@ have type `Data`. template bool make_tree(ForwardIterator first, ForwardIterator last); -/*! +/*! All elements that lay inside the \f$ d\f$-dimensional interval defined through @@ -104,7 +104,7 @@ to the last location the function wrote to is returned. template OutputIterator window_query(Window win, OutputIterator result); -/*! +/*! The tree structure is checked. For each vertex the subtree is checked on being valid and it is checked whether the value of the `Key_type` of a vertex @@ -115,7 +115,7 @@ bool is_valid(); protected: -/*! +/*! returns `true`, if the data of `object` lies between the start and endpoint of interval `win`. Returns `false` otherwise. @@ -123,7 +123,7 @@ interval `win`. Returns `false` otherwise. bool is_inside(Window win, Data object); -/*! +/*! returns false. */ bool is_anchor(); diff --git a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h index 1bb6d79b9fe..3bd397bb3bf 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Range_tree_k.h @@ -73,17 +73,17 @@ public: /// \name Types /// @{ -/*! +/*! the type of the range tree traits class. */ typedef unspecified_type Traits; -/*! +/*! */ typedef Traits::Key Key; -/*! +/*! */ typedef Traits::Interval Interval; @@ -93,12 +93,12 @@ typedef Traits::Interval Interval; /// \name Creation /// @{ -/*! +/*! Introduces an empty range tree `R`. */ Range_tree_k (); -/*! +/*! Introduces a range tree `R` and initializes it with the data in the range `[first, last)`. \pre `value_type(first) == Traits::Key`. @@ -112,7 +112,7 @@ ForwardIterator last); /// \name Operations /// @{ -/*! +/*! Introduces a range tree `R` and initializes it with the data in the range `[first, last)`. This function can only be applied once on an empty range tree. @@ -123,7 +123,7 @@ void make_tree(ForwardIterator first, ForwardIterator last); -/*! +/*! writes all data that are in the interval `window` to the container where `out` points to, and returns an output iterator that points to the last location the function wrote to. diff --git a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h index 3fc61bcc4b9..0ac98512573 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_d.h @@ -21,17 +21,17 @@ public: /// \name Types /// @{ -/*! +/*! container `Data`. */ typedef unspecified_type Data; -/*! +/*! container `Window`. */ typedef unspecified_type Window; -/*! +/*! class `Traits`. */ typedef unspecified_type Traits; @@ -41,7 +41,7 @@ typedef unspecified_type Traits; /// \name Creation /// @{ -/*! +/*! A segment tree is defined, such that the subtree of each vertex is of the same type prototype `sublayer_tree` is. @@ -79,7 +79,7 @@ Traits> s(Tree_base sublayer_tree); /// \name Operations /// @{ -/*! +/*! The tree is constructed according to the data items in the sequence between the element pointed by iterator `first` and iterator `last`. @@ -87,7 +87,7 @@ iterator `last`. */ bool make_tree(In_it first, In_it last); -/*! +/*! `win`\f$ =[a_1,b_1),\ldots, [a_d,b_d)\f$, \f$ a_i,b_i\in T_i\f$, \f$ 1\le i\le d\f$. All elements that intersect the associated \f$ d\f$-dimensional interval of `win` are placed in the @@ -101,7 +101,7 @@ In order to perform an inverse range query, a range query of */ OutputIterator window_query(Window win, OutputIterator result); -/*! +/*! All elements that enclose the associated \f$ d\f$-dimensional interval of `win` are placed in the @@ -110,7 +110,7 @@ to the last location the function wrote to. */ OutputIterator enclosing_query(Window win, OutputIterator result); -/*! +/*! The tree structure is checked. For each vertex either the sublayer tree is a tree anchor, or it stores a (possibly empty) @@ -125,14 +125,14 @@ bool is_valid(); protected: -/*! +/*! returns `true`, if the interval of `object` is contained in the interval of `win`, `false` otherwise. */ bool is_inside(Window win, Data object); -/*! +/*! returns false. */ bool is_anchor(); diff --git a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h index 5cc795a5322..11c401e114a 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Segment_tree_k.h @@ -79,17 +79,17 @@ public: /// \name Types /// @{ -/*! +/*! the type of the segment tree traits class. */ typedef unspecified_type Traits; -/*! +/*! */ typedef Traits::Key Key; -/*! +/*! */ typedef Traits::Interval Interval; @@ -99,12 +99,12 @@ typedef Traits::Interval Interval; /// \name Creation /// @{ -/*! +/*! Introduces an empty segment tree `S`. */ Segment_tree_k (); -/*! +/*! Introduces a segment tree `S` and initializes it with the data in the range `[first, last)`. \pre `value_type(first) == Traits::Interval`. @@ -118,7 +118,7 @@ ForwardIterator last); /// \name Operations /// @{ -/*! +/*! Introduces a segment tree `S` and initializes it with the data in the range `[first, last)`. This function can only be applied once on an empty segment tree. @@ -129,7 +129,7 @@ void make_tree(ForwardIterator first, ForwardIterator last); -/*! +/*! writes all intervals that have non empty intersection with interval `window` to the container where `out` points to, and returns an output iterator that points to the last location the function wrote to. @@ -140,7 +140,7 @@ OutputIterator window_query(Interval window, OutputIterator out); -/*! +/*! writes all intervals that enclose in the interval `window` to the container where `out` points to, and returns an output iterator that points to the last location the function wrote to. diff --git a/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h b/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h index 4e538b210f3..924b151f30a 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Tree_base.h @@ -25,12 +25,12 @@ public: /// \name Types /// @{ -/*! +/*! container `Data`. */ typedef unspecified_type Data; -/*! +/*! container `Window`. */ typedef unspecified_type Window; @@ -40,7 +40,7 @@ typedef unspecified_type Window; /// \name Creation /// @{ -/*! +/*! */ Tree_anchor a(); @@ -50,32 +50,32 @@ Tree_anchor a(); /// \name Operations /// @{ -/*! +/*! */ template OutputIterator window_query(Window win, OutputIterator result); -/*! +/*! */ template OutputIterator enclosing_query(Window win, OutputIterator result); -/*! +/*! returns true; */ bool is_valid(); protected: -/*! +/*! returns true. */ bool is_inside(Window win, Data object); -/*! +/*! returns true. */ bool is_anchor(); diff --git a/SearchStructures/doc/SearchStructures/CGAL/Tree_traits.h b/SearchStructures/doc/SearchStructures/CGAL/Tree_traits.h index 85c5b2147eb..695d77311ef 100644 --- a/SearchStructures/doc/SearchStructures/CGAL/Tree_traits.h +++ b/SearchStructures/doc/SearchStructures/CGAL/Tree_traits.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! the container `Data` - the data type. It may consist of several data slots. Two of these data slots have to be of @@ -32,7 +32,7 @@ type `Key`. */ typedef unspecified_type Data; -/*! +/*! the container `Window` - the query window type. It may consist of several data slots. Two of these data slots have to be of @@ -40,14 +40,14 @@ type `Key`. */ typedef unspecified_type Window; -/*! +/*! the type `Key` of the data slot this traits class provides access to. */ typedef unspecified_type Key; -/*! +/*! `Data_left_func` is a function object providing an @@ -57,7 +57,7 @@ a (the left) component of type `Key`. */ typedef unspecified_type Data_left_func; -/*! +/*! `Data_right_func` is a function object providing an @@ -67,7 +67,7 @@ a (the right) component of type `Key`. */ typedef unspecified_type Data_right_func; -/*! +/*! `Window_left_func` is a function objects that allow to access the @@ -76,7 +76,7 @@ left data slot of container */ typedef unspecified_type Window_left_func; -/*! +/*! `Window_right_func` is a function objects that allow to access the @@ -85,7 +85,7 @@ right data slot of container */ typedef unspecified_type Window_right_func; -/*! +/*! defines a comparison relation which must define a strict ordering of the objects of type `Key`. If defined, `less` @@ -98,7 +98,7 @@ typedef unspecified_type Compare; /// \name Operations /// @{ -/*! +/*! The data slot of the data item of `d` of type `Key` is accessed by function object @@ -106,7 +106,7 @@ accessed by function object */ Key get_left(Data d); -/*! +/*! The data slot of the data item of `d` of type `Key` is accessed by function object @@ -114,7 +114,7 @@ accessed by function object */ Key get_right(Data d); -/*! +/*! The data slot of the data item of `w` of type `Key` is accessed by function object @@ -122,14 +122,14 @@ accessed by function object */ Key get_left_win(Window w); -/*! +/*! The data slot of the data item of `w` of type `Key` is accessed by function object `Window_right_func`. */ Key get_right_win(Window w); -/*! +/*! returns Compare(key1, key2). */ static bool comp(Key& key1, Key& key2); @@ -157,7 +157,7 @@ public: /// \name Types /// @{ -/*! +/*! the container `Data` - defines the Data type. It may consist of several data slots. One of these data slots has to be of @@ -165,7 +165,7 @@ type `Key`. */ typedef unspecified_type Data; -/*! +/*! the container `Window` - defines the type of the query rectangle. It may consist of @@ -174,14 +174,14 @@ type `Key` */ typedef unspecified_type Window; -/*! +/*! the type `Key` of the data slot this traits class provides access to. */ typedef unspecified_type Key; -/*! +/*! `Data_func` is a function object providing an @@ -190,7 +190,7 @@ a component of type `Key`. */ typedef unspecified_type Data_func; -/*! +/*! `Window_left_func` is a function objects that allow to access the @@ -199,7 +199,7 @@ left data slot of container */ typedef unspecified_type Window_left_func; -/*! +/*! `Window_right_func` is a function objects that allow to access the @@ -208,7 +208,7 @@ right data slot of container */ typedef unspecified_type Window_right_func; -/*! +/*! defines a comparison relation which must define a strict ordering of the objects of type `Key`. If defined, `less` @@ -221,14 +221,14 @@ typedef unspecified_type Compare; /// \name Operations /// @{ -/*! +/*! The data slot of the data item of `d` of type `Key` is accessed by function object `Data_func`. */ Key get_key(Data d); -/*! +/*! The data slot of the data item of `w` of type `Key` is accessed by function object @@ -236,20 +236,20 @@ accessed by function object */ Key get_left(Window w); -/*! +/*! The data slot of the data item of `w` of type `Key` is accessed by function object `Window_right_func`. */ Key get_right(Window w); -/*! +/*! returns `Compare(key1, key2)`. */ static bool comp(Key& key1, Key& key2); -/*! +/*! returns `Compare(get_key(data1), get_key(data2))`. */ static bool key_comp(Data& data1, Data& diff --git a/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h b/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h index c6b0c8f03f7..b61c04465b0 100644 --- a/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h +++ b/SearchStructures/doc/SearchStructures/Concepts/RangeSegmentTreeTraits_k.h @@ -82,44 +82,44 @@ public: /// \name Types /// @{ -/*! +/*! The k-dimensional key type. */ typedef unspecified_type Key; -/*! +/*! The k-dimensional interval type. */ typedef unspecified_type Interval; -/*! +/*! The type in dimension \f$ i\f$, with \f$ 1\leq i \leq k\f$. */ typedef unspecified_type Key_i; -/*! +/*! function object providing an `operator()` that takes an argument of type `Key` and returns a component of type `Key_i`. */ typedef unspecified_type key_i; -/*! +/*! function object providing an `operator()` that takes an argument of type `Interval` and returns a component of type `Key_i`. */ typedef unspecified_type low_i; -/*! +/*! function object providing an `operator()` that takes an argument of type `Interval` and returns a component of type `Key_i`. */ typedef unspecified_type high_i; -/*! +/*! function object providing an `operator()` that takes two arguments argument \f$ a\f$, \f$ b\f$ of type `Key_i` and returns true if \f$ a size_type insert(Input_iterator first, Input_iterator beyond); -/*! +/*! Same as the previous method. `Input_iterator` must be a model of `InputIterator` and its value type must be either `Point_2` or `Site_2`. @@ -582,7 +582,7 @@ template std::size_t insert_segments(PointIterator points_first, PointIterator points_beyond, IndicesIterator indices_first, IndicesIterator indices_beyond); -/*! +/*! Inserts the point `p` in the segment Delaunay graph. If `p` has already been inserted, then the vertex handle of its already inserted copy is @@ -591,7 +591,7 @@ returned. If `p` has not been inserted yet, the vertex handle of */ Vertex_handle insert(Point_2 p); -/*! +/*! Inserts `p` in the segment Delaunay graph using the site associated with `vnear` as an estimate for the nearest neighbor of `p`. The vertex handle returned has the same semantics as @@ -600,7 +600,7 @@ the vertex handle returned by the method */ Vertex_handle insert(Point_2 p, Vertex_handle vnear); -/*! +/*! Inserts the closed segment with endpoints `p1` and `p2` in the segment Delaunay graph. If the segment has already been inserted in the @@ -613,7 +613,7 @@ vertex handle to one of its open subsegments is returned. */ Vertex_handle insert(Point_2 p1, Point_2 p2); -/*! +/*! Inserts the segment whose endpoints are `p1` and `p2` in the segment Delaunay graph using the site associated with `vnear` as an estimate for the nearest neighbor @@ -624,7 +624,7 @@ vertex handle returned by the method Vertex_handle insert(Point_2 p1, Point_2 p2, Vertex_handle vnear); -/*! +/*! Inserts the site `s` in the segment Delaunay graph. The vertex handle returned has the same semantics as the vertex handle returned by the methods @@ -634,7 +634,7 @@ represents a point or a segment respectively. */ Vertex_handle insert(Site_2 s); -/*! +/*! Inserts `s` in the segment Delaunay graph using the site associated with `vnear` as an estimate for the nearest neighbor of `s`, if `s` is a point, or the first endpoint of `s`, if @@ -651,7 +651,7 @@ vnear); /// \name Nearest neighbor location /// @{ -/*! +/*! Finds the nearest neighbor of the point `p`. In other words it finds the site whose segment Voronoi diagram cell contains `p`. Ties are broken arbitrarily and one of the nearest neighbors @@ -660,7 +660,7 @@ segment Delaunay graph `Vertex_handle()` is returned. */ Vertex_handle nearest_neighbor(Point_2 p); -/*! +/*! Finds the nearest neighbor of the point `p` using the site associated with `vnear` as an estimate for the nearest neighbor of `p`. Ties are broken @@ -676,7 +676,7 @@ Vertex_handle vnear); /// \name I/O /// @{ -/*! +/*! Draws the segment Voronoi diagram to the stream `str`. The following operators must be defined: @@ -691,7 +691,7 @@ defined: template < class Stream > Stream& draw_dual(Stream& str); -/*! +/*! Draws the segment Voronoi diagram to the stream `str`, except the edges of the diagram corresponding to a segment and its endpoints. @@ -707,7 +707,7 @@ The following operators must be defined: template < class Stream > Stream& draw_skeleton(Stream& str); -/*! +/*! Draws the edge `e` of the segment Voronoi diagram to the stream `str`. The following operators must be defined: @@ -722,7 +722,7 @@ The following operators must be defined: template< class Stream > Stream& draw_dual_edge(Edge e, Stream& str); -/*! +/*! Draws the edge `*ec` of the segment Voronoi diagram to the stream `str`. The following operators must be defined: @@ -737,7 +737,7 @@ The following operators must be defined: template< class Stream > Stream& draw_dual_edge(Edge_circulator ec, Stream& str); -/*! +/*! Draws the edge `*eit` of the segment Voronoi diagram to the stream `str`. The following operators must be defined: @@ -752,7 +752,7 @@ The following operators must be defined: template< class Stream > Stream& draw_dual_edge(All_edges_iterator eit, Stream& str); -/*! +/*! Draws the edge `*eit` of the segment Voronoi diagram to the stream `str`. The following operators must be defined: @@ -766,7 +766,7 @@ The following operators must be defined: template< class Stream > Stream& draw_dual_edge(Finite_edges_iterator eit, Stream& str); -/*! +/*! Writes the current state of the segment Delaunay graph to an output stream. In particular, all sites in the diagram are written to the stream (represented @@ -775,18 +775,18 @@ combinatorial data structure. */ void file_output(std::ostream& os); -/*! +/*! Reads the state of the segment Delaunay graph from an input stream. */ void file_input(std::istream& is); -/*! +/*! Writes the current state of the segment Delaunay graph to an output stream. */ std::ostream& operator<<(std::ostream& os, Segment_Delaunay_graph_2 sdg); -/*! +/*! Reads the state of the segment Delaunay graph from an input stream. */ std::istream& operator>>(std::istream& is, Segment_Delaunay_graph_2 sdg); @@ -796,7 +796,7 @@ std::istream& operator>>(std::istream& is, Segment_Delaunay_graph_2 sdg); /// \name Validity check /// @{ -/*! +/*! Checks the validity of the segment Delaunay graph. If `verbose` is `true` a short message is sent to `std::cerr`. If `level` is 0, only the data structure is validated. If @@ -812,12 +812,12 @@ bool is_valid(bool verbose = false, int level = 1); /// \name Miscellaneous /// @{ -/*! +/*! Clears all contents of the segment Delaunay graph. */ void clear(); -/*! +/*! The segment Delaunay graphs `other` and `*this` are swapped. For a segment Delaunay graph `sdg`, the operation `sdg`.`swap(other)` should be preferred to `sdg``= other` or to `sdg``(other)` if diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h index 53f11217840..4d5cf30a807 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_filtered_traits_2.h @@ -80,64 +80,64 @@ public: /// types: /// @{ -/*! +/*! */ typedef CGAL::Tag_true Intersections_tag; -/*! +/*! */ typedef CK Kernel; -/*! +/*! */ typedef CK Construction_kernel; -/*! +/*! */ typedef FK Filtering_kernel; -/*! +/*! */ typedef EK Exact_kernel; -/*! +/*! */ typedef CM Method_tag; -/*! +/*! */ typedef CM Construction_traits_method_tag; -/*! +/*! */ typedef FM Filtering_traits_method_tag; -/*! +/*! */ typedef EM Exact_traits_method_tag; -/*! +/*! A type for the segment Delaunay graph traits, where the kernel is `CK`. */ typedef unspecified_type Construction_traits; -/*! +/*! A type for the segment Delaunay graph traits, where the kernel is `FK`. */ typedef unspecified_type Filtering_traits; -/*! +/*! A type for the segment Delaunay graph traits, where the kernel is `EK`. */ @@ -231,64 +231,64 @@ public: /// defines the following types: /// @{ -/*! +/*! */ typedef CGAL::Tag_false Intersections_tag; -/*! +/*! */ typedef CK Kernel; -/*! +/*! */ typedef CK Construction_kernel; -/*! +/*! */ typedef FK Filtering_kernel; -/*! +/*! */ typedef EK Exact_kernel; -/*! +/*! */ typedef CM Method_tag; -/*! +/*! */ typedef CM Construction_traits_method_tag; -/*! +/*! */ typedef FM Filtering_traits_method_tag; -/*! +/*! */ typedef EM Exact_traits_method_tag; -/*! +/*! A type for the segment Delaunay graph traits, where the kernel is `CK`. */ typedef unspecified_type Construction_traits; -/*! +/*! A type for the segment Delaunay graph traits, where the kernel is `FK`. */ typedef unspecified_type Filtering_traits; -/*! +/*! A type for the segment Delaunay graph traits, where the kernel is `EK`. */ diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h index efcbaac72f2..ecdef076d2b 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_hierarchy_2.h @@ -82,13 +82,13 @@ public: /// `Segment_Delaunay_graph_2`. /// @{ -/*! +/*! A type for the `STag` template parameter. */ typedef STag Segments_in_hierarchy_tag; -/*! +/*! A type for the base class. */ typedef CGAL::Segment_Delaunay_graph_2 Base; @@ -100,14 +100,14 @@ typedef CGAL::Segment_Delaunay_graph_2 Base; /// constructors are defined: /// @{ -/*! +/*! Creates a hierarchy of segment Delaunay graphs using `gt` as geometric traits. */ Segment_Delaunay_graph_hierarchy_2(Gt gt=Gt()); -/*! +/*! Creates a segment Delaunay graph hierarchy using `gt` as geometric traits and inserts all sites in the range [`first`, `beyond`). `Input_iterator` must be a @@ -123,7 +123,7 @@ first, Input_iterator beyond, Gt gt=Gt()); }; /* end Segment_Delaunay_graph_hierarchy_2 */ -/*! +/*! Writes the current state of the segment Delaunay graph hierarchy to an output stream. In particular, all sites in the diagram are written to the stream (represented through appropriate input sites), @@ -132,7 +132,7 @@ as well as the underlying combinatorial hierarchical data structure. */ std::ostream& operator<<(std::ostream& os, Segment_Delaunay_graph_hierarchy_2 svdh); -/*! +/*! Reads the state of the segment Delaunay graph hierarchy from an input stream. \relates Segment_Delaunay_graph_hierarchy_2 diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h index 5c7e1251459..ff5bcf887c5 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_site_2.h @@ -28,7 +28,7 @@ public: /// `SegmentDelaunayGraphSite_2`. /// @{ -/*! +/*! A type for the template parameter `K`. */ typedef K Kernel; diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h index 94b4cd05154..0744bf5fc78 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_storage_site_2.h @@ -30,7 +30,7 @@ public: /// `SegmentDelaunayGraphStorageSite_2`. /// @{ -/*! +/*! A type for the template parameter `Gt`. */ typedef Gt Geom_traits; diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h index ed20bd0267b..dd304368fd0 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/CGAL/Segment_Delaunay_graph_traits_2.h @@ -41,7 +41,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Intersections_tag; @@ -54,13 +54,13 @@ typedef CGAL::Tag_true Intersections_tag; /// `SegmentDelaunayGraphTraits_2` concept. These are: /// @{ -/*! +/*! A typedef for the template parameter `K`. */ typedef K Kernel; -/*! +/*! A typedef for the template parameter `MTag`. */ @@ -113,7 +113,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_false Intersections_tag; @@ -124,13 +124,13 @@ typedef CGAL::Tag_false Intersections_tag; /// `SegmentDelaunayGraphTraits_2` concept. These are: /// @{ -/*! +/*! A typedef for the template parameter `K`. */ typedef K Kernel; -/*! +/*! A typedef for the template parameter `MTag`. */ diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h index b9b810bb685..3ede3737f5f 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphDataStructure_2.h @@ -49,14 +49,14 @@ public: /// \name Modification /// @{ -/*! +/*! Joins the vertices that are endpoints of the edge `(f,i)`. It returns a vertex handle to common vertex. */ Vertex_handle join_vertices(Face_handle f, int i); -/*! +/*! Splits the vertex `v` into two vertices `v1` and `v2`. The common faces `f` and `g` of `v1` and `v2` are created after (in the counter-clockwise sense) the 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 6c19607d70f..f1cb3c98574 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 @@ -43,27 +43,27 @@ public: /// \name Operations /// @{ -/*! +/*! Returns a handle to the corresponding vertex of the next level segment Delaunay graph. If such a vertex does not exist `Vertex_handle()` is returned. */ Vertex_handle up(); -/*! +/*! Returns a handle to the corresponding vertex of the previous level segment Delaunay graph. If such a vertex does not exist `Vertex_handle()` is returned. */ Vertex_handle down(); -/*! +/*! Sets the handle for the vertex of the next level segment Delaunay graph. */ void set_up(Vertex_handle u); -/*! +/*! Sets the handle for the vertex of the previous level segment Delaunay graph. */ diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h index e8e9154d31a..e2effb77856 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphSite_2.h @@ -27,22 +27,22 @@ public: /// \name Types /// @{ -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The segment type. */ typedef unspecified_type Segment_2; -/*! +/*! The field number type. */ typedef unspecified_type FT; -/*! +/*! The ring number type. */ typedef unspecified_type RT; @@ -54,19 +54,19 @@ typedef unspecified_type RT; /// static methods are available for constructing sites: /// @{ -/*! +/*! Constructs a site from a point: the site represents the point `p`. */ static SegmentDelaunayGraphSite_2 construct_site_2(Point_2 p); -/*! +/*! Constructs a site from two points: the site represents the (open) segment `(p1,p2)`. */ static SegmentDelaunayGraphSite_2 construct_site_2(Point_2 p1, Point_2 p2); -/*! +/*! Constructs a site from four points: the site represents the point of intersection of the segments `(p1,p2)` and `(q1,q2)`. @@ -74,7 +74,7 @@ point of intersection of the segments `(p1,p2)` and static SegmentDelaunayGraphSite_2 construct_site_2(Point_2 p1, Point_2 p2, Point_2 q1, Point_2 q2); -/*! +/*! Constructs a site from four points and a boolean: the site represents a segment. If `b` is `true` the endpoints are `p1` and \f$ p_\times\f$, otherwise \f$ p_\times\f$ and @@ -84,7 +84,7 @@ are `p1` and \f$ p_\times\f$, otherwise \f$ p_\times\f$ and static SegmentDelaunayGraphSite_2 construct_site_2(Point_2 p1, Point_2 p2, Point_2 q1, Point_2 q2, bool b); -/*! +/*! Constructs a site from six points: the site represents the segment with endpoints the points of intersection of the pairs of segments `(p1,p2)`,`(q1,q2)` @@ -99,25 +99,25 @@ static SegmentDelaunayGraphSite_2 construct_site_2(Point_2 p1, Point_2 p2, /// \name Predicates /// @{ -/*! +/*! Returns `true` if the site represents a valid point or segment. */ bool is_defined(); -/*! +/*! Returns `true` if the site represents a point. */ bool is_point(); -/*! +/*! Returns `true` if the site represents a segment. */ bool is_segment(); -/*! +/*! Returns `true` if the site represents an input point or a segment defined by two input points. Returns `false` if it represents a point of intersection @@ -126,7 +126,7 @@ endpoint of which is a point of intersection of two segments. */ bool is_input(); -/*! +/*! Returns `true` if the `i`-th endpoint of the site is an input point. Returns `false` if the `i`-th endpoint of the site is the intersection of two @@ -140,21 +140,21 @@ bool is_input(unsigned int i); /// \name Access Functions /// @{ -/*! +/*! Returns the point represented by the site `s`. \pre `s.is_point()` must be `true`. */ Point_2 point() const; -/*! +/*! Returns the segment represented by the site `s`. \pre `s.is_segment()` must be `true`. */ Segment_2 segment() const; -/*! +/*! Returns the source endpoint of the segment. Note that this method can construct an inexact point if the number type used is inexact. @@ -162,7 +162,7 @@ number type used is inexact. */ Point_2 source() const; -/*! +/*! Returns the target endpoint of the segment. Note that this method can construct an inexact point if the number type used is inexact. @@ -170,7 +170,7 @@ number type used is inexact. */ Point_2 target() const; -/*! +/*! Returns a segment site object representing the segment that supports the segment represented by the site. Both endpoints of the returned site are input points. @@ -178,7 +178,7 @@ endpoints of the returned site are input points. */ SegmentDelaunayGraphSite_2 supporting_site(); -/*! +/*! Returns a segment site object representing the `i`-th segment that supports the point of intersection represented by the site. Both endpoints of the returned site are input @@ -187,7 +187,7 @@ points. */ SegmentDelaunayGraphSite_2 supporting_site(unsigned int i); -/*! +/*! Returns a segment site object representing the `i`-th segment that supports the \f$ i\f$-th endpoint of the site which is not the supporting segment of the site. Both @@ -196,54 +196,54 @@ endpoints of the returned site are input points. */ SegmentDelaunayGraphSite_2 crossing_site(unsigned int i); -/*! +/*! Returns a point site object representing the source point of the site. \pre `s.is_segment()` must be `true`. */ SegmentDelaunayGraphSite_2 source_site(); -/*! +/*! Returns a point site object representing the target point of the site. \pre `s.is_segment()` must be `true`. */ SegmentDelaunayGraphSite_2 target_site(); -/*! +/*! Returns the source point of the supporting site of the this site. \pre `is_segment()` must be `true`. */ Point_2 source_of_supporting_site(); -/*! +/*! Returns the target point of the supporting site of the this site. \pre `is_segment()` must be `true`. */ Point_2 target_of_supporting_site(); -/*! +/*! Returns the source point of the `i`-th supporting site of the this site. \pre `is_point()` must be `true`, `is_input()` must be `false` and `i` must either be `0` or `1`. */ Point_2 source_of_supporting_site(unsigned int i); -/*! +/*! Returns the target point of the `i`-th supporting site of the this site. \pre `is_point()` must be `true`, `is_input()` must be `false` and `i` must either be `0` or `1`. */ Point_2 target_of_supporting_site(unsigned int i); -/*! +/*! Returns the source point of the `i`-th crossing site of the this site. \pre `is_segment()` must be `true`, `is_input(i)` must be `false` and `i` must either be `0` or `1`. */ Point_2 source_of_crossing_site(unsigned int i); -/*! +/*! Returns the target point of the `i`-th supporting site of the this site. \pre `is_segment()` must be `true`, `is_input(i)` must be `false` and `i` must either be `0` or `1`. diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h index ce4f607f224..66362d380cb 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphStorageSite_2.h @@ -31,12 +31,12 @@ public: /// \name Types /// @{ -/*! +/*! The site type. */ typedef unspecified_type Site_2; -/*! +/*! The type for a handle to a point. */ typedef typename std::set::iterator @@ -49,7 +49,7 @@ Point_handle; /// static methods should be available for constructing sites: /// @{ -/*! +/*! Constructs a storage site from a point handle. The storage site represents the point associated with the point handle `hp`. @@ -57,7 +57,7 @@ the point handle `hp`. SegmentDelaunayGraphStorageSite_2 construct_storage_site_2(Point_handle hp); -/*! +/*! Constructs a storage site from two point handles. The storage site represents the segment the endpoints of which are the points associated with the point handles `hp1` and `hp2`. @@ -65,7 +65,7 @@ associated with the point handles `hp1` and `hp2`. SegmentDelaunayGraphStorageSite_2 construct_storage_site_2(Point_handle hp1, Point_handle hp2); -/*! +/*! Constructs a storage site from four point handles. The storage site represents the point of intersection of the segments the endpoints of which are @@ -76,7 +76,7 @@ SegmentDelaunayGraphStorageSite_2 construct_storage_site_2(Point_handle hp1, Point_handle hp2, Point_handle hq1, Point_handle hq2); -/*! +/*! Constructs a site from four point handles and a boolean. The storage site represents a segment. If `b` is `true`, the first endpoint @@ -92,7 +92,7 @@ SegmentDelaunayGraphStorageSite_2 construct_storage_site_2(Point_handle hp1, Point_handle hp2, Point_handle hq1, Point_handle hq2, bool b); -/*! +/*! Constructs a storage site from six point handles. The storage site represents of segment the endpoints of which are points of intersection of two pairs of segments, the @@ -109,25 +109,25 @@ hr1, Point_handle hr2); /// \name Predicates /// @{ -/*! +/*! Returns `true` if the storage site represents a valid point or segment. */ bool is_defined(); -/*! +/*! Returns `true` if the storage site represents a point. */ bool is_point(); -/*! +/*! Returns `true` if the storage site represents a segment. */ bool is_segment(); -/*! +/*! Returns `true` if the storage site represents an input point or a segment defined by two input points. Returns `false` if it represents a point of intersection @@ -136,7 +136,7 @@ endpoint of which is a point of intersection of two segments. */ bool is_input(); -/*! +/*! Returns `true` if the `i`-th endpoint of the corresponding site is an input point. Returns `false` if the `i`-th endpoint of the @@ -150,7 +150,7 @@ bool is_input(unsigned int i); /// \name Access Functions /// @{ -/*! +/*! Returns a storage site object representing the segment that supports the segment represented by the storage site. The returned storage site represents a site, both endpoints @@ -159,21 +159,21 @@ of which are input points. */ SegmentDelaunayGraphStorageSite_2 supporting_site(); -/*! +/*! Returns a storage site that represents the first endpoint of the represented segment. \pre `ss.is_segment()` must be `true`. */ SegmentDelaunayGraphStorageSite_2 source_site(); -/*! +/*! Returns a storage site that represents the second endpoint of the represented segment. \pre `ss.is_segment()` must be `true`. */ SegmentDelaunayGraphStorageSite_2 target_site(); -/*! +/*! Returns a storage site object representing the `i`-th segment that supports the point of intersection represented by the storage site. @@ -183,7 +183,7 @@ of which are input points. */ SegmentDelaunayGraphStorageSite_2 supporting_site(unsigned int i); -/*! +/*! Returns a storage site object representing the `i`-th segment that supports the \f$ i\f$-th endpoint of the site which is not the supporting segment of the site. @@ -193,52 +193,52 @@ of which are input points. */ SegmentDelaunayGraphStorageSite_2 crossing_site(unsigned int i); -/*! +/*! Returns the site represented by the storage site. */ Site_2 site(); -/*! +/*! Returns a handle associated with the represented point. \pre `is_point()` and `is_input()` must both be `true`. */ Point_handle point(); -/*! +/*! Returns a handle to the source point of the supporting site of the this site. \pre `is_segment()` must be `true`. */ Point_handle source_of_supporting_site(); -/*! +/*! Returns a handle to the target point of the supporting site of the this site. \pre `is_segment()` must be `true`. */ Point_handle target_of_supporting_site(); -/*! +/*! Returns a handle to the source point of the `i`-th supporting site of the this site. \pre `is_point()` must be `true`, `is_input()` must be `false` and `i` must either be `0` or `1`. */ Point_handle source_of_supporting_site(unsigned int i); -/*! +/*! Returns a handle to the target point of the `i`-th supporting site of the this site. \pre `is_point()` must be `true`, `is_input()` must be `false` and `i` must either be `0` or `1`. */ Point_handle target_of_supporting_site(unsigned int i); -/*! +/*! Returns a handle to the source point of the `i`-th crossing site of the this site. \pre `is_segment()` must be `true`, `is_input(i)` must be `false` and `i` must either be `0` or `1`. */ Point_handle source_of_crossing_site(unsigned int i); -/*! +/*! Returns a handle to the target point of the `i`-th supporting site of the this site. \pre `is_segment()` must be `true`, `is_input(i)` must be `false` and `i` must either be `0` or `1`. diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h index 0ae1f14c413..adca1753a4b 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphTraits_2.h @@ -36,54 +36,54 @@ public: /// \name Types /// @{ -/*! +/*! Indicates or not whether the intersecting segments are to be supported. The tag must either be `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Intersections_tag; -/*! +/*! A type for a site of the segment Delaunay graph. Must be a model of the concept `SegmentDelaunayGraphSite_2`. */ typedef unspecified_type Site_2; -/*! +/*! A type for a point. */ typedef unspecified_type Point_2; -/*! +/*! A type for a line. Only required if the segment Delaunay graph is inserted in a stream. */ typedef unspecified_type Line_2; -/*! +/*! A type for a ray. Only required if the segment Delaunay graph is inserted in a stream. */ typedef unspecified_type Ray_2; -/*! +/*! A type for a segment. Only required if if the segment Delaunay graph is inserted in a stream. */ typedef unspecified_type Segment_2; -/*! +/*! A type for the field number type of sites, points, etc... */ typedef unspecified_type FT; -/*! +/*! A type for the ring number type of sites, points, etc. */ typedef unspecified_type RT; -/*! +/*! An enumeration type that indicates the type of the arrangement of two sites. The possible values are `DISJOINT`, `IDENTICAL`, `CROSSING`, @@ -101,27 +101,27 @@ concept. */ typedef unspecified_type Arrangement_type; -/*! +/*! A type representing different types of objects in two dimensions, namely: `Point_2`, `Site_2`, `Line_2`, `Ray_2` and `Segment_2`. */ typedef unspecified_type Object_2; -/*! +/*! Must provide `template bool operator() ( T& t, Object_2 o)` which assigns `o` to `t` if `o` was constructed from an object of type `T`. Returns `true`, if the assignment was possible. */ typedef unspecified_type Assign_2; -/*! +/*! Must provide `template Object_2 operator()( T t)` that constructs an object of type `Object_2` that contains `t` and returns it. */ typedef unspecified_type Construct_object_2; -/*! +/*! A constructor for a point of the segment Voronoi diagram equidistant from three sites. Must provide @@ -132,7 +132,7 @@ constructs a point equidistant from the sites `s1`, `s2` and */ typedef unspecified_type Construct_svd_vertex_2; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()(Site_2 s1, Site_2 s2)`, which compares the \f$ x\f$-coordinates of the points represented by the sites `s1` and `s2`. @@ -140,7 +140,7 @@ represented by the sites `s1` and `s2`. */ typedef unspecified_type Compare_x_2; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()(Site_2 s1, Site_2 s2)`, which compares the \f$ y\f$-coordinates of the points represented by the sites `s1` and `s2`. @@ -160,7 +160,7 @@ provide `bool operator()(Point_2 p1, Point_2 p2)`, which returns `true` if `p1.y */ typedef unspecified_type Less_y_2; -/*! +/*! A predicate object type. Must provide `Orientation operator()(Site_2 s1, Site_2 s2, Site_2 s3)`, which performs the usual orientation test for three points. @@ -169,7 +169,7 @@ usual orientation test for three points. */ typedef unspecified_type Orientation_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2)`, which determines is the points represented by the sites `s1` and `s2` are identical. @@ -177,7 +177,7 @@ points represented by the sites `s1` and `s2` are identical. */ typedef unspecified_type Equal_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2)`, which determines is the segments represented by the sites `s1` and `s2` are @@ -186,7 +186,7 @@ parallel. */ typedef unspecified_type Are_parallel_2; -/*! +/*! A predicate object type. Must provide `Oriented_side operator()(Site_2 s1, Site_2 s2, Point_2 p)`, which returns the oriented side of the bisector of `s1` and `s2` that @@ -198,7 +198,7 @@ lies on the bisector of `s1` and `s2`. */ typedef unspecified_type Oriented_side_of_bisector_2; -/*! +/*! A predicate object type. Must provide `Sign operator()(Site_2 s1, Site_2 s2, Site_2 s3, Site_2 q)`, which returns the sign of the distance of `q` from the Voronoi circle @@ -214,7 +214,7 @@ Voronoi circle, with its center at infinity). */ typedef unspecified_type Vertex_conflict_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2, Site_2 s3, Site_2 s4, Site_2 q, Sign sgn)`. The sites `s1`, `s2`, `s3` and `s4` define a Voronoi edge that lies on the @@ -264,7 +264,7 @@ conflict with the Voronoi edge. */ typedef unspecified_type Finite_edge_interior_conflict_2; -/*! +/*! A predicate object type. Must provide `bool operator()(Site_2 s1, Site_2 s2, Site_2 s3, Site_2 q, Sign sgn)`. The sites \f$ s_\infty\f$, `s1`, `s2` and `s3` define a @@ -282,7 +282,7 @@ is not in conflict with the Voronoi edge. */ typedef unspecified_type Infinite_edge_interior_conflict_2; -/*! +/*! A predicate object type. Must provide `Oriented_side operator()(Site_1 s1, Site_2 s2, Site_2 s3, Site_2 s, Site_2 p)`. Determines the oriented side of the line \f$ \ell\f$ that contains the point site `p`, where \f$ \ell\f$ is the line @@ -292,7 +292,7 @@ that passes through the Voronoi vertex of the sites `s1`, */ typedef unspecified_type Oriented_side_2; -/*! +/*! A predicate object type. Must provide `Arrangement_type operator()(Site_2 s1, Site_2 s2)` that returns the type of the arrangement of the two sites `s1` and @@ -305,12 +305,12 @@ typedef unspecified_type Arrangement_type_2; /// \name Access to predicate objects /// @{ -/*! +/*! */ Compare_x_2 compare_x_2_object(); -/*! +/*! */ Compare_y_2 compare_y_2_object(); @@ -325,50 +325,50 @@ Less_x_2 less_x_2_object(); */ Less_y_2 less_y_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); -/*! +/*! */ Equal_2 equal_2_object(); -/*! +/*! */ Are_parallel_2 are_parallel_2_object(); -/*! +/*! */ Oriented_side_of_bisector_2 oriented_side_of_bisector_test_2_object(); -/*! +/*! */ Vertex_conflict_2 vertex_conflict_2_object(); -/*! +/*! */ Finite_edge_interior_conflict_2 finite_edge_interior_conflict_2_object(); -/*! +/*! */ Infinite_edge_interior_conflict_2 infinite_edge_interior_conflict_2_object(); -/*! +/*! */ Oriented_side_2 oriented_side_2_object(); -/*! +/*! */ Arrangement_type_2 arrangement_type_2_object(); @@ -378,13 +378,13 @@ Arrangement_type_2 arrangement_type_2_object(); /// \name Access to contructor objects /// @{ -/*! +/*! */ Construct_object_2 construct_object_2_object(); -/*! +/*! */ Construct_svd_vertex_2 @@ -395,7 +395,7 @@ construct_svd_vertex_2_object(); /// \name Access to other objects /// @{ -/*! +/*! */ Assign_2 assign_2_object(); diff --git a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h index ba75a9c338d..83210eb83d5 100644 --- a/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h +++ b/Segment_Delaunay_graph_2/doc/Segment_Delaunay_graph_2/Concepts/SegmentDelaunayGraphVertexBase_2.h @@ -32,45 +32,45 @@ public: /// \name Types /// @{ -/*! +/*! A type for the geometric traits that defines the site. \pre The type `Geom_traits` must define the type `Site_2`. */ typedef unspecified_type Geom_traits; -/*! +/*! A type for the site. This type must coincide with the type `Geom_traits::Site_2`. */ typedef unspecified_type Site_2; -/*! +/*! A type that indicates what kind of storage type to use. `Storage_site_tag` must either be `CGAL::Tag_true` or `CGAL::Tag_false`. */ typedef unspecified_type Storage_site_tag; -/*! +/*! A type for the internal representation of sites. This type must satisfy the requirements of the concept `SegmentDelaunayGraphStorageSite_2`. */ typedef unspecified_type Storage_site_2; -/*! +/*! A type for the underlying data structure, to which the vertex belongs to. */ typedef unspecified_type Data_structure; -/*! +/*! A type for the vertex handle of the segment Delaunay graph data structure. */ typedef unspecified_type Vertex_handle; -/*! +/*! A type for the face handle of the segment Delaunay graph data structure. */ @@ -83,13 +83,13 @@ typedef unspecified_type Face_handle; /// constructors are required: /// @{ -/*! +/*! Constructs a vertex associated with the site represented by the storage site `ss`. */ SegmentDelaunayGraphVertexBase_2(Storage_site_2 ss); -/*! +/*! Constructs a vertex associated with the site represented by the storage site `ss`, and pointing to the face associated with the face handle `f`. @@ -102,17 +102,17 @@ Face_handle f); /// \name Access Functions /// @{ -/*! +/*! Returns the storage site representing the site. */ Storage_site_2 storage_site(); -/*! +/*! Returns the site. */ Site_2 site(); -/*! +/*! Returns a handle to an incident face. */ Face_handle face(); @@ -122,12 +122,12 @@ Face_handle face(); /// \name Setting /// @{ -/*! +/*! Sets the storage site. */ void set_site(Storage_site_2 ss); -/*! +/*! Sets the incident face. */ void set_face(Face_handle f); @@ -137,7 +137,7 @@ void set_face(Face_handle f); /// \name Checking /// @{ -/*! +/*! Performs any required tests on a vertex. */ bool is_valid(bool verbose, int level) const; diff --git a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h index 32da2b4c1df..8183dd552a9 100644 --- a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurfaceTraits_3.h @@ -23,12 +23,12 @@ public: /// \name Types /// @{ -/*! +/*! The number type. */ typedef unspecified_type RT; -/*! +/*! A constructor object which provides the following function operator: @@ -46,7 +46,7 @@ typedef unspecified_type Construct_anchor_point_3; /// \name Creation /// @{ -/*! +/*! Constructor that takes the shrink factor as argument. For meshing the boundary of the union of a set of balls, the shrink factor is discarded. @@ -59,12 +59,12 @@ SkinSurfaceTraits_3(RT s=.5); /// The following functions give access to the constructor objects: /// @{ -/*! +/*! Returns the shrink factor. */ Regular_RT shrink_factor() const; -/*! +/*! Returns a `Construct_anchor_point_3` object. */ Construct_anchor_point_3 construct_anchor_point_3_object() diff --git a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h index 1179ebb5886..87ec0c646ef 100644 --- a/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h +++ b/Skin_surface_3/doc/Skin_surface_3/Concepts/SkinSurface_3.h @@ -20,25 +20,25 @@ public: /// \name Types /// @{ -/*! +/*! The geometric traits used for the construction of the regular triangulation. */ typedef unspecified_type Geometric_traits; -/*! +/*! The `Weighted_point` type defined by the `Geometric_traits`. */ typedef unspecified_type Weighted_point; -/*! +/*! The `Bare_point` type defined by the `Geometric_traits`. */ typedef unspecified_type Bare_point; -/*! +/*! The `FT` type defined by the `Geometric_traits`. This is the number type used by the weighted points. @@ -50,7 +50,7 @@ typedef unspecified_type FT; /// \name Creation /// @{ -/*! +/*! The mandatory arguments to the constructor are an iterator range `[begin,end)` of weighted points and a shrink factor between 0 and 1. @@ -64,7 +64,7 @@ RT shrink_factor); /// \name Operations /// @{ -/*! +/*! Constructs a coarse mesh in `p`. \tparam Polyhedron must be an instance of `Polyhedron_3`. \pre `Polyhedron::HDS` can be used as the template argument of the `CGAL::Polyhedron_incremental_builder_3`. @@ -72,7 +72,7 @@ Constructs a coarse mesh in `p`. template void mesh_skin_surface_3 (Polyhedron &p); -/*! +/*! Subdivides the skin surface using `nSubdiv` 1-4 split operations (each triangle is split into four sub-triangles) and the new vertices are moved towards the skin surface. diff --git a/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h b/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h index 9cdf9934e49..a4f44c9912c 100644 --- a/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h +++ b/Snap_rounding_2/doc/Snap_rounding_2/Concepts/SnapRoundingTraits_2.h @@ -20,23 +20,23 @@ public: /// \name Types /// @{ -/*! +/*! The number type. This type must fulfill the requirements on `FieldNumberType` */ typedef unspecified_type FT; -/*! +/*! Models the concept `ArrTraits::Point_2`. */ typedef unspecified_type Point_2; -/*! +/*! Models the concept `ArrTraits::XMonotoneCurve_2`. */ typedef unspecified_type Segment_2; -/*! +/*! Models the concept `SRTraits_2::IsoRectangle_2` */ typedef unspecified_type Iso_rectangle_2; @@ -46,49 +46,49 @@ typedef unspecified_type Iso_rectangle_2; /// \name Functor Types /// @{ -/*! +/*! Models the concept `SRTraits_2::ConstructVertex_2`. */ typedef unspecified_type Construct_vertex_2; -/*! +/*! Models the concept `SRTraits_2::ConstructSegment_2`. */ typedef unspecified_type Construct_segment_2; -/*! +/*! Models the concept `SRTraits_2::ConstructIsoRectangle_2`. */ typedef unspecified_type Construct_iso_rectangle_2; -/*! +/*! Models the concept `RealEmbeddableTraits::ToDouble`. The precision of this operation is of not high significance, as it is only used in the implementation of the heuristic technique to exploit a cluster of kd-trees rather than just one. */ typedef unspecified_type To_double; -/*! +/*! Models the concept `SRTraits_2::CompareX_2`. */ typedef unspecified_type Compare_x_2; -/*! +/*! Models the concept `SRTraits_2::CompareY_2`. */ typedef unspecified_type Compare_y_2; -/*! +/*! Models the concept `SRTraits_2::Snap_2`. */ typedef unspecified_type Snap_2; -/*! +/*! Models the concept `SRTraits_2::IntegerGridPoint_2`. */ typedef unspecified_type Integer_grid_point_2; -/*! +/*! Models the concept `SRTraits_2::MinkowskiSumWithPixel_2`. */ typedef unspecified_type Minkowski_sum_with_pixel_2; @@ -98,42 +98,42 @@ typedef unspecified_type Minkowski_sum_with_pixel_2; /// \name Accessing Functor Objects /// @{ -/*! +/*! */ Construct_vertex_2 construct_vertex_2_object(); -/*! +/*! */ Construct_segment_2 construct_segment_2_object(); -/*! +/*! */ Construct_iso_rectangle_2 construct_iso_rectangle_2_object(); -/*! +/*! */ Compare_x_2 compare_x_2_object(); -/*! +/*! */ Compare_y_2 compare_y_2_object(); -/*! +/*! */ Snap_2 snap_2_object(); -/*! +/*! */ Integer_grid_point_2 integer_grid_point_2_object(); -/*! +/*! */ Minkowski_sum_with_pixel_2 minkowski_sum_with_pixel_2_object(); diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h index 5a08369fb1b..f050897cfc0 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Euclidean_distance.h @@ -25,17 +25,17 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Query item type. */ typedef Point_d Query_item; @@ -45,7 +45,7 @@ typedef Point_d Query_item; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Euclidean_distance(Traits t=Traits()); @@ -55,35 +55,35 @@ Euclidean_distance(Traits t=Traits()); /// \name Operations /// @{ -/*! +/*! Returns the squared Euclidean distance between `q` and `p`. */ FT transformed_distance(Query_item q, Point_d p) const; -/*! +/*! Returns the squared Euclidean distance between `q` and the point on the boundary of `r` closest to `q`. */ FT min_distance_to_rectangle(Query_item q, Kd_tree_rectangle r) const; -/*! +/*! Returns the squared Euclidean distance, where \f$ d\f$ denotes the distance between `q` and the point on the boundary of `r` farthest to `q`. */ FT max_distance_to_rectangle(Query_item q, Kd_tree_rectangle r;) const; -/*! +/*! Updates the squared `dist` incrementally and returns the updated squared distance. */ FT new_distance(FT dist, FT old_off, FT new_off, int cutting_dimension) const; -/*! +/*! Returns \f$ d^2\f$. */ FT transformed_distance(FT d) const; -/*! +/*! Returns \f$ d^{1/2}\f$. */ FT inverse_of_transformed_distance(FT d) const; 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 d4d6d2e48aa..d764cee3483 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 @@ -26,17 +26,17 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Query item type. */ typedef Traits::Sphere_d Sphere_d; @@ -46,7 +46,7 @@ typedef Traits::Sphere_d Sphere_d; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Euclidean_distance_sphere_point(Traits t=Traits()); @@ -56,29 +56,29 @@ Euclidean_distance_sphere_point(Traits t=Traits()); /// \name Operations /// @{ -/*! +/*! Returns the distance between `s` and `p`. */ NT transformed_distance(Query_item s, Point_d p) const; -/*! +/*! Returns the minimal distance between a point from the sphere `s` and a point from `r`. */ NT min_distance_to_rectangle(Query_item s, Kd_tree_rectangle r) const; -/*! +/*! Returns the maximal distance between the sphere `s` and a point from `r` furthest to `s`. */ NT max_distance_to_rectangle(Query_item s, Kd_tree_rectangle r) const; -/*! +/*! Returns \f$ d^2\f$. */ NT transformed_distance(NT d) const; -/*! +/*! Returns \f$ d^{1/2}\f$. */ NT inverse_of_transformed_distance(NT d) const; 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 5a6a937be9f..f43e7a57d2c 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_iso_box.h @@ -25,12 +25,12 @@ public: /// \name Types /// @{ -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Number type. */ typedef Traits::FT FT; @@ -40,14 +40,14 @@ typedef Traits::FT FT; /// \name Creation /// @{ -/*! +/*! Constructs a fuzzy iso box specified by the minimal iso box containing `p` and `q` and fuzziness value `epsilon`. \pre `p` must be lexicographically smaller than `q`. */ Fuzzy_iso_box(Point_d p, Point_d q, FT epsilon=FT(0),Traits t=Traits()); -/*! +/*! Constructs a fuzzy iso box specified by the minimal iso box containing `p` and `q` and fuzziness value `epsilon`. \attention Only available in case `Traits` is @@ -62,18 +62,18 @@ Fuzzy_iso_box(Traits::Base::Point_d p, Traits::Base::Point_d q, FT epsilon=FT(0) /// \name Operations /// @{ -/*! +/*! test whether the fuzzy iso box contains `p`. */ bool contains(Point_d p) const; -/*! +/*! test whether the inner box intersects the rectangle associated with a node of a tree. */ bool inner_range_intersects(const Kd_tree_rectangle& rectangle) const; -/*! +/*! test whether the outer box encloses the rectangle associated with a node of a tree. */ bool outer_range_contains(const Kd_tree_rectangle& rectangle) const; diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h index eb07522cecd..624b9b1b87c 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Fuzzy_sphere.h @@ -25,12 +25,12 @@ public: /// \name Types /// @{ -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Number type. */ typedef Traits::FT FT; @@ -41,13 +41,13 @@ typedef Traits::FT FT; /// /// @{ -/*! +/*! Constructs a fuzzy sphere centered at `center` with radius `radius` and fuzziness value `epsilon`. */ Fuzzy_sphere(Point_d center, FT radius, FT epsilon=FT(0),Traits t=Traits()); -/*! +/*! Constructs a fuzzy sphere centered at `center` with radius `radius` and fuzziness value `epsilon`. \attention Only available in case `Traits` is `Search_traits_adapter`. */ @@ -58,18 +58,18 @@ Fuzzy_sphere(Traits::Base::Point_d center, FT radius, FT epsilon=FT(0), Traits t /// \name Operations /// @{ -/*! +/*! test whether the fuzzy sphere contains `p`. */ bool contains(const Point_d& p) const; -/*! +/*! test whether the inner sphere intersects the rectangle associated with a node of a tree. */ bool inner_range_intersects(const Kd_tree_rectangle& rectangle) const; -/*! +/*! test whether the outer sphere encloses the rectangle associated with a node of a tree. */ bool outer_range_contains(const Kd_tree_rectangle& rectangle) const; 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 f91e19257bb..a96c8af594c 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Incremental_neighbor_search.h @@ -34,38 +34,38 @@ public: /// \name Types /// @{ -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Number type. */ typedef Traits::NT NT; -/*! +/*! Distance type. */ typedef GeneralDistance Distance; -/*! +/*! Pair of point and transformed distance. */ typedef std::pair Point_with_transformed_distance; -/*! +/*! const input iterator with value type `Point_with_transformed_distance` for enumerating approximate neighbors. */ typedef unspecified_type iterator; -/*! +/*! Query item type. */ GeneralDistance::Query_item Query_item; -/*! +/*! The tree type. */ SpatialTree Tree; @@ -75,7 +75,7 @@ SpatialTree Tree; /// \name Creation /// @{ -/*! +/*! Constructor for incremental neighbor searching of the query item `q` in the points stored `tree` using a distance `d` and approximation factor `eps`. */ @@ -87,17 +87,17 @@ bool search_nearest=true, GeneralDistance d=GeneralDistance()); /// \name Operations /// @{ -/*! +/*! Returns a const iterator to the approximate nearest or furthest neighbor. */ iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ iterator end() const; -/*! +/*! Inserts statistics of the search process into the output stream `s`. 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 34e6ec0e5c8..487073780a5 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/K_neighbor_search.h @@ -32,38 +32,38 @@ public: /// \name Types /// @{ -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Distance type. */ typedef GeneralDistance Distance; -/*! +/*! Pair of point and transformed distance. */ typedef std::pair Point_with_transformed_distance; -/*! +/*! Bidirectional const iterator with value type `Point_with_distance` for enumerating approximate neighbors. */ typedef unspecified_type iterator; -/*! +/*! Query item type. */ typedef GeneralDistance::Query_item Query_item; -/*! +/*! The tree type. */ typedef SpatialTree Tree; @@ -73,7 +73,7 @@ typedef SpatialTree Tree; /// \name Creation /// @{ -/*! +/*! Constructor for searching approximately `k` neighbors of the query item `q` in the points stored in `tree` using distance class `d` and approximation factor `eps`. `sorted` indicates @@ -87,17 +87,17 @@ bool search_nearest=true, GeneralDistance d=GeneralDistance(),bool sorted=true); /// \name Operations /// @{ -/*! +/*! Returns a const iterator to the approximate nearest or furthest neighbor. */ iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ iterator end() const; -/*! +/*! Inserts statistics of the search process into the output stream `s`. */ std::ostream& statistics(std::ostream& s); diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h index d86f19975d7..7303ff40aa0 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree.h @@ -29,43 +29,43 @@ public: /// \name Types /// @{ -/*! +/*! Point class. */ typedef Traits::Point_d Point_d; -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Splitter type. */ typedef unspecified_type Splitter; -/*! +/*! Bidirectional const iterator with value type `Point_d` that allows to enumerate all points in the tree. */ typedef unspecified_type iterator; -/*! +/*! A handle with value type `Kd_tree_node`. */ typedef unspecified_type Node_handle; -/*! +/*! A const handle with value type `Kd_tree_node`. */ typedef unspecified_type Node_const_handle; -/*! +/*! Random access const iterator with value type `const Point_d*`. */ typedef unspecified_type Point_d_iterator; -/*! +/*! A type that counts the number of elements in a `k-d` tree. */ typedef unspecified_type size_type; @@ -75,12 +75,12 @@ typedef unspecified_type size_type; /// \name Creation /// @{ -/*! +/*! Constructs an empty `k-d` tree. */ Kd_tree(Splitter s=Splitter(),Traits t=Traits()); -/*! +/*! Constructs a `k-d` tree on the elements from the sequence `[first, beyond)` using the splitting rule implemented by `s`. @@ -94,18 +94,18 @@ template Kd_tree(InputIterator first, InputIterator beyond /// \name Operations /// @{ -/*! +/*! Inserts the point `p` in the `k-d` tree. */ void insert(Point_d p); -/*! +/*! Inserts the elements from the sequence `[first, beyond)` in the `k-d` tree. The value type of the `InputIterator` must be `Point_d`. */ template void insert(InputIterator first, InputIterator beyond); -/*! +/*! Reports the points that are approximately contained by `q`. The types `FuzzyQueryItem::Point_d` and `Point_d` must be equivalent. To use this function `Traits` must be a model of the concept `RangeSearchTraits`. @@ -114,47 +114,48 @@ To use this function `Traits` must be a model of the concept `RangeSearchTraits` template OutputIterator search(OutputIterator it, FuzzyQueryItem q) const; -/*! +/*! Returns a const iterator to the first point in the tree. */ iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ iterator end() const; -/*! +/*! Removes all points from the `k-d` tree. */ void clear(); -/*! +/*! Returns the number of points that are stored in the tree. */ size_type size() const; -/*! +/*! return the instance of the traits used to construct the tree. */ Traits traits() const; -/*! +/*! Returns a handle to the root node of the tree. */ Node_handle root(); -/*! +/*! Returns a const handle to the root node of the tree. */ Node_const_handle root() const; -/*! Returns a const reference to the bounding box of the +/*! +Returns a const reference to the bounding box of the root node of the tree. */ const Kd_tree_rectangle& bounding_box() const; -/*! +/*! Inserts statistics of the tree into the output stream `s`. */ std::ostream& statistics(std::ostream& s) const; 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 ae5ccc2eba7..2f83f15fb18 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_node.h @@ -25,38 +25,38 @@ public: /// \name Types /// @{ -/*! +/*! Denotes type of node. */ enum Node_type {LEAF, INTERNAL, EXTENDED_INTERNAL}; -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Separator type. */ typedef Splitter::Separator Separator; -/*! +/*! const iterator over points. */ typedef Kd_tree::Point_d_iterator Point_d_iterator; -/*! +/*! Node handle. */ typedef Kd_tree::Node_handle Node_handle; -/*! +/*! const node handle. */ typedef Kd_tree::Node_const_handle Node_const_handle; @@ -66,70 +66,70 @@ typedef Kd_tree::Node_const_handle Node_const_h /// \name Operations /// @{ -/*! +/*! Reports the points from the subtree of the node, that are approximately contained by q. */ template OutputIterator search(OutputIterator it, FuzzyQueryItem q) const; -/*! +/*! Reports all the points contained by the subtree of the node. */ template OutputIterator tree_items(OutputIterator it) const; -/*! +/*! Indicates whether a node is a leaf node. */ bool is_leaf() const; -/*! +/*! Returns the number of items stored in a leaf node. */ unsigned int size() const; -/*! +/*! Returns a const iterator to the first item in a leaf node. */ Point_d_iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ Point_d_iterator end() const; -/*! +/*! Returns a handle to the lower child of an internal node. */ Node_handle lower(); -/*! +/*! Returns a handle to the upper child of an internal node. */ Node_handle upper(); -/*! +/*! Returns a const handle to the lower child of an internal node. */ Node_const_handle lower() const; -/*! +/*! Returns a const handle to the upper child of an internal node. */ Node_const_handle upper() const; -/*! +/*! Returns a reference to the separator. */ Separator& separator(); -/*! +/*! Returns the lower limit of an extended node's rectangle along the node's cutting dimension. */ FT low_value() const; -/*! +/*! Returns the upper limit of an extended node's rectangle along the node's cutting dimension. */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h index ae130a7529a..3a3101a0de0 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Kd_tree_rectangle.h @@ -14,7 +14,7 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef FT FT; @@ -24,13 +24,13 @@ typedef FT FT; /// \name Creation /// @{ -/*! +/*! Constructs a `d`-dimensional rectangle `r` with lower bound and upper bound set to zero in each dimension. */ Kd_tree_rectangle(int d); -/*! +/*! Constructs the bounding box of the points in the range `[begin,end)`, where the value type of `PointIter` can be used by operators of functors `Construct_cartesian_const_iterator_d` to define iterators with value type `FT`. @@ -43,42 +43,42 @@ Kd_tree_rectangle(int d, PointIter begin, PointIter end,const Construct_cartesia /// \name Operations /// @{ -/*! +/*! Returns the lower bound of the rectangle in dimension `i`. */ FT min_coord(int i) const; -/*! +/*! Returns the upper bound of the rectangle in dimension `i`. */ FT max_coord(int i) const; -/*! +/*! Sets upper bound in dimension `i` to `x`. */ void set_upper_bound(int i, const FT& x); -/*! +/*! Sets lower bound in dimension `i` to `x`. */ void set_lower_bound(int i, const FT& x); -/*! +/*! Returns the maximal span of the rectangle. */ FT max_span() const; -/*! +/*! Returns the smallest coordinate for which the rectangle has its maximal span. */ FT max_span_coord() const; -/*! +/*! Returns the dimension of the rectangle. */ int dimension() const; -/*! +/*! Splits rectangle in dimension `d` at coordinate-value `value` by modifying itself to lower half and by modifying `r` to upper half. */ @@ -88,7 +88,7 @@ void split(Kd_tree_rectangle& r, int d, FT value); }; /* end Kd_tree_rectangle */ -/*! +/*! Inserts rectangle `r` in the output stream `s` and returns `s`. \relates Kd_tree_rectangle */ 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 ee83fbb53ea..93e88bba29f 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 @@ -27,17 +27,17 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Query item type. */ typedef Traits::Iso_box_d Query_item; @@ -47,7 +47,7 @@ typedef Traits::Iso_box_d Query_item; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Manhattan_distance_iso_box_point(Traits t=Traits()); @@ -57,30 +57,30 @@ Manhattan_distance_iso_box_point(Traits t=Traits()); /// \name Operations /// @{ -/*! +/*! Returns the transformed distance between `b` and `p`. */ FT transformed_distance(Query_item b, Point_d p) const; -/*! +/*! Returns the transformed value of of `d`. */ FT transformed_distance(FT d) const; -/*! +/*! Returns the value of the inverse of the transform function applied to `d`. */ FT inverse_of_transformed_distance(FT d) const; -/*! +/*! Returns the minimal distance between a point from `b` and a point from `r`. */ FT min_distance_to_rectangle(Query_item b, Kd_tree_rectangle r) const; -/*! +/*! Returns the maximal distance between the iso-box `b` and a point from `r` furthest to `b`. */ 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 11688f09c84..164c69ae212 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 @@ -34,38 +34,38 @@ public: /// \name Types /// @{ -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Distance type. */ typedef OrthogonalDistance Distance; -/*! +/*! Query item. */ typedef OrthogonalDistance::Query_item Query_item; -/*! +/*! Pair of point and transformed distance. */ typedef std::pair Point_with_transformed_distance; -/*! +/*! const input iterator with value type `Point_with_transformed_distance` for enumerating approximate neighbors. */ typedef unspecified_type iterator; -/*! +/*! The tree type. */ typedef SpatialTree Tree; @@ -75,7 +75,7 @@ typedef SpatialTree Tree; /// \name Creation /// @{ -/*! +/*! Constructor for incremental neighbor searching of the query item `query` in the points stored `tree` using a distance `d` and approximation factor `eps`. */ @@ -88,17 +88,17 @@ OrthogonalDistance d=OrthogonalDistance()); /// \name Operations /// @{ -/*! +/*! Returns a const iterator to the approximate nearest or furthest neighbor. */ iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ iterator end() const; -/*! +/*! Inserts statistics of the search process into the output stream `s`. 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 1292481f7f8..050ff4b3905 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 @@ -38,38 +38,38 @@ public: /// \name Types /// @{ -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Distance type. */ typedef OrthogonalDistance Distance; -/*! +/*! Query item. */ typedef GeneralDistance::Query_item Query_item; -/*! +/*! Pair of point and transformed distance. */ typedef std::pair Point_with_transformed_distance; -/*! +/*! Bidirectional const iterator with value type `Point_with_transformed_distance` for enumerating approximate neighbors. */ typedef unspecified_type iterator; -/*! +/*! The tree type. */ typedef SpatialTree Tree; @@ -79,7 +79,7 @@ typedef SpatialTree Tree; /// \name Operations /// @{ -/*! +/*! Constructor for searching approximately `k` neighbors of the query item `query` in the points stored in `tree` using distance `d` and approximation factor `eps`. `sorted` indicates @@ -89,17 +89,17 @@ Orthogonal_k_neighbor_search(SpatialTree tree, Query_item query, unsigned int k= bool search_nearest=true, OrthogonalDistance d=OrthogonalDistance(),bool sorted=true); -/*! +/*! Returns a const iterator to the approximate nearest or furthest neighbor. */ iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ iterator end() const; -/*! +/*! Inserts statistics of the search process into the output stream `s`. */ std::ostream& statistics(std::ostream& s); diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h b/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h index 3f3c7dc127b..cb83ff72418 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Plane_separator.h @@ -19,13 +19,13 @@ public: /// \name Creation /// @{ -/*! +/*! Constructs a separator that separates two half spaces by a hyperplane defined by `xd=v`, where `v` denotes the `d`th coordinate value. */ Plane_separator(int d, FT v); -/*! +/*! Copy constructor. */ Plane_separator(Plane_separator p); @@ -35,27 +35,27 @@ Plane_separator(Plane_separator p); /// \name Operations /// @{ -/*! +/*! Sets the cutting dimension to `d`. */ void set_cutting_dimension(int d); -/*! +/*! Sets the cutting value to `v`. */ void set_cutting_value(FT v); -/*! +/*! Returns the number of the cutting dimension. */ int cutting_dimension() const; -/*! +/*! Returns the cutting value. */ FT cutting_value() const; -/*! +/*! Assignment operator. */ Plane_separator operator=(Plane_separator s2); @@ -64,7 +64,7 @@ Plane_separator operator=(Plane_separator s2); }; /* end Plane_separator */ -/*! +/*! Inserts the plane separator `s` in the output stream `os` and returns `os`. \relates Plane_separator */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h index dcd354b7c10..56b943862b1 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Point_container.h @@ -25,22 +25,22 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; -/*! +/*! An iterator with value type `Point_d*`. */ typedef unspecified_type iterator; -/*! +/*! A const iterator with value type `const Point_d*`. */ typedef unspecified_type const_iterator; @@ -50,14 +50,14 @@ typedef unspecified_type const_iterator; /// \name Creation /// @{ -/*! +/*! Construct an empty container for storing `d`-dimensional points. */ Point_container(int d); -/*! +/*! Construct the container of `d`-dimensional points of type `Point_d` given by the iterator sequence `[begin, end)`. @@ -70,7 +70,7 @@ Point_container(int d, InputIterator begin, InputIterator end); /// \name Operations /// @{ -/*! +/*! Given an empty container `c2` with the same dimension as `c`, splits `c` into `c`and `c2` using the separator `sep`. If sliding is `true` after splitting each container contains at least one point. Container `c` should contain at least two points. @@ -78,73 +78,73 @@ each container contains at least one point. Container `c` should contain at leas template void split(Point_container &c2, SpatialSeparator sep, bool sliding=false); -/*! +/*! Swap the contents of `c` and `c2` */ void swap(Point_container &c2); -/*! +/*! Recompute the bounding box of the points in the container. */ void recompute_tight_bounding_box(); -/*! +/*! Returns an iterator to a pointer to the first point. */ iterator begin(); -/*! +/*! Returns the appropriate past-the-end iterator. */ iterator end(); -/*! +/*! Returns a const iterator to a pointer to the first point. */ const_iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ const_iterator end() const; -/*! +/*! Returns the dimension. */ int dimension() const; -/*! +/*! Returns coordinate for which the pointer list is built. */ int built_coordinate() const; -/*! +/*! Returns coordinate where the associated rectangle has maximal span. */ int max_span_coord() const; -/*! +/*! Returns coordinate where the point coordinates have maximal span. */ int max_tight_span_coord() const; -/*! +/*! Returns lower value of the interval corresponding to `max_span_coord()`. @@ -152,7 +152,7 @@ Returns lower value of the interval corresponding to */ FT max_span_lower() const; -/*! +/*! Returns lower value of the interval corresponding to `max_tight_span_coord()`. That is, the smallest @@ -162,7 +162,7 @@ Returns lower value of the interval corresponding to */ FT max_tight_span_lower() const; -/*! +/*! Returns upper value of the interval corresponding to `max_span_coord()`. @@ -170,7 +170,7 @@ Returns upper value of the interval corresponding to */ FT max_span_upper() const; -/*! +/*! Returns upper value of the interval over all dimensions without taking dimension `d` into account. @@ -178,7 +178,7 @@ without taking dimension `d` into account. */ FT max_span_upper_without_dim(int d) const; -/*! +/*! Returns upper value of the interval corresponding to `max_tight_span_coord()`. @@ -186,21 +186,21 @@ Returns upper value of the interval corresponding to */ FT max_tight_span_upper() const; -/*! +/*! Returns the size of the interval corresponding to `max_span_coord()`. */ FT max_spread() const; -/*! +/*! Returns the size of the interval corresponding to `max_tight_span_coord()`. */ FT max_tight_spread() const; -/*! +/*! Returns the median value of the points stored in the container for dimension `split_coord`. @@ -208,17 +208,17 @@ dimension `split_coord`. */ FT median(int split_coord) const; -/*! +/*! Returns the associated rectangle. */ const Kd_tree_rectangle & bounding_box() const; -/*! +/*! Returns the bounding box of the items in associated rectangle. */ const Kd_tree_rectangle & tight_bounding_box(); -/*! +/*! Returns the dimension with the maximal point spread, for which after fair splitting the ratio of the length of the longest side and the smallest side of the bounding box of the items in associated rectangle, @@ -226,24 +226,24 @@ does not exceed `aspect_ratio`. */ int max_tight_span_coord_balanced(FT aspect_ratio) const; -/*! +/*! Returns the splitting value for fair splitting. */ FT balanced_fair(int d, FT aspect_ratio); -/*! +/*! Returns the splitting value for sliding fair splitting. */ FT balanced_sliding_fair(int d, FT aspect_ratio); -/*! +/*! Returns the number of points stored. */ std::size_t size() const; -/*! +/*! Returns true if no points are present, false otherwise. @@ -254,7 +254,7 @@ bool empty() const; }; /* end Point_container */ -/*! +/*! Prints the point container `c` to the output stream `s` and returns `s`. \relates Point_container */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h index dc6f1826d5d..37fac8b60c2 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits.h @@ -21,22 +21,22 @@ public: /// \name Types /// @{ -/*! +/*! The number type of the coordinates. */ typedef NT FT; -/*! +/*! Point type. */ typedef Point Point_d; -/*! +/*! An iterator over the coordinates. */ typedef CartesianIterator Cartesian_const_iterator_d; -/*! +/*! A functor with two function operators, which return the begin and past the end iterator for the %Cartesian coordinates. The functor for begin has as argument a `Point_d`. The functor for the past the end iterator, @@ -44,13 +44,13 @@ has as argument a `Point_d` and an `int`. */ typedef ConstructCartesianIterator Construct_Cartesian_const_iterator_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically smallest coordinates of an object of type `Iso_box_d`. */ typedef ConstructMinVertex Construct_min_vertex_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically largest coordinates of an object of type `Iso_box_d`. */ 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 31b419ba39f..a4c74419dee 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_2.h @@ -25,32 +25,32 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Kernel::FT FT; -/*! +/*! Point type. */ typedef Kernel::Point_2 Point_d; -/*! +/*! Iso box type. */ typedef Kernel::Iso_rectangle_2 Iso_box_d; -/*! +/*! Sphere type. */ typedef Kernel::Circle_2 Sphere_d; -/*! +/*! An iterator over the %Cartesian coordinates. */ typedef Kernel::Cartesian_const_iterator_2 Cartesian_const_iterator_d; -/*! +/*! A functor with two function operators, which return the begin and past the end iterator for the %Cartesian coordinates. The functor for begin has as argument a `Point_d`. The functor for the past the end iterator, @@ -58,31 +58,31 @@ has as argument a `Point_d` and an `int`. */ typedef Kernel::Construct_cartesian_const_iterator_2 Construct_cartesian_const_iterator_d; -/*! +/*! Functor with operator to construct the iso box from two points. */ typedef Kernel::Construct_iso_rectangle_2 Construct_iso_box_d; -/*! +/*! Functor with operator to construct the center of an object of type `Sphere_d`. */ typedef Kernel::Construct_center_2 Construct_center_d; -/*! +/*! Functor with operator to compute the squared radius of a an object of type `Sphere_d`. */ typedef Kernel::Compute_squared_radius_2 Construct_squared_radius_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically smallest coordinates of an object of type `Iso_box_d`. */ typedef Kernel::Construct_min_vertex_2 Construct_min_vertex_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically largest coordinates of an object of type `Iso_box_d`. */ 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 2f7e99238a1..f68d21ff3f4 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_3.h @@ -25,33 +25,33 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Kernel::FT FT; -/*! +/*! Point type. */ typedef Kernel::Point_3 Point_d; -/*! +/*! Iso box type. */ typedef Kernel::Iso_cuboid_3 Iso_box_d; -/*! +/*! Sphere type. */ typedef Kernel::Sphere_3 Sphere_d; -/*! +/*! An iterator over the %Cartesian coordinates. */ typedef Kernel::Cartesian_const_iterator_3 Cartesian_const_iterator_d; -/*! +/*! A functor with two function operators, which return the begin and past the end iterator for the %Cartesian coordinates. The functor for begin has as argument a `Point_d`. The functor for the past the end iterator, @@ -65,25 +65,25 @@ the iso box from two points. */ typedef Kernel::Construct_iso_cuboid_3 Construct_iso_box_d; -/*! +/*! Functor with operator to construct the center of an object of type `Sphere_d`. */ typedef Kernel::Construct_center_3 Construct_center_d; -/*! +/*! Functor with operator to compute the squared radius of a an object of type `Sphere_d`. */ typedef Kernel::Compute_squared_radius_3 Construct_squared_radius_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically smallest coordinates of an object of type `Iso_box_d`. */ typedef Kernel::Construct_min_vertex_3 Construct_min_vertex_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically largest coordinates of an object of type `Iso_box_d`. */ 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 c9ed2173b4e..c1c8a693d8f 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_adapter.h @@ -30,17 +30,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Base_distance::FT FT; -/*! +/*! */ typedef Key Point_d; -/*! +/*! */ typedef Base_distance::Query_item Query_item; @@ -50,7 +50,7 @@ typedef Base_distance::Query_item Query_item; /// \name Creation /// @{ -/*! +/*! Constructor initializing the class to `base` and setting the point property map of the class to `ppmap`. */ Distance_adapter(const PointPropertyMap& ppmap=PointPropertyMap(),const Base_distance& base=Base_distance()); @@ -60,7 +60,7 @@ Distance_adapter(const PointPropertyMap& ppmap=PointPropertyMap(),const Base_dis /// \name Operations /// @{ -/*! +/*! Returns the point property map. */ const PointPropertyMap& point_property_map() const; @@ -106,22 +106,22 @@ public: /// \name Types /// @{ -/*! +/*! */ Key Point_d; -/*! +/*! */ BaseTraits::FT FT; -/*! +/*! */ BaseTraits::Cartesian_const_iterator_d Cartesian_const_iterator_d; -/*! +/*! */ BaseTraits Base; @@ -131,7 +131,7 @@ BaseTraits Base; /// \name Creation /// @{ -/*! +/*! Constructor initializing the class to `base` and setting the point property map of the class to `ppmap`. */ Search_traits_adapter(const PointPropertyMap& ppmap=PointPropertyMap(),const BaseTraits& base=BaseTraits()); @@ -141,7 +141,7 @@ Search_traits_adapter(const PointPropertyMap& ppmap=PointPropertyMap(),const Bas /// \name Operations /// @{ -/*! +/*! Returns the point property map. */ const PointPropertyMap& point_property_map() const; 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 2263a1cf0a2..ac8f8ebf44e 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Search_traits_d.h @@ -28,32 +28,32 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Kernel::FT NT; -/*! +/*! Point type. */ typedef Kernel::Point_d Point_d; -/*! +/*! Iso box type. */ typedef Kernel::Iso_box_d Iso_box_d; -/*! +/*! Sphere type. */ typedef Kernel::Sphere_d Sphere_d; -/*! +/*! An iterator over the %Cartesian coordinates. */ typedef Kernel::Cartesian_const_iterator_d Cartesian_const_iterator; -/*! +/*! A functor with two function operators, which return the begin and past the end iterator for the %Cartesian coordinates. The functor for begin has as argument a `Point_d`. The functor for the past the end iterator, @@ -61,13 +61,13 @@ has as argument a `Point_d` and an `int`. */ typedef Kernel::Construct_cartesian_const_iterator_d Construct_cartesian_const_iterator; -/*! +/*! Functor with operator to construct the vertex with lexicographically smallest coordinates of an object of type `Iso_box_d`. */ typedef Kernel::Construct_min_vertex_d Construct_min_vertex_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically largest coordinates of an object of type `Iso_box_d`. */ diff --git a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h index 30969ed189f..3c42aaab3c9 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Splitters.h @@ -36,7 +36,7 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Traits::FT FT; @@ -46,12 +46,12 @@ typedef Traits::FT FT; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Fair(); -/*! +/*! Constructor. */ Fair(unsigned int bucket_size, @@ -94,12 +94,12 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Median_of_max_spread(); -/*! +/*! Constructor. */ Median_of_max_spread(unsigned int bucket_size); @@ -141,12 +141,12 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Median_of_rectangle(); -/*! +/*! Constructor. */ Median_of_rectangle(unsigned int bucket_size); @@ -187,12 +187,12 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Midpoint_of_max_spread(); -/*! +/*! Constructor. */ Midpoint_of_max_spread(unsigned int bucket_size); @@ -232,12 +232,12 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Midpoint_of_rectangle_spread(); -/*! +/*! Constructor. */ Midpoint_of_rectangle(unsigned int bucket_size); @@ -295,7 +295,7 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Traits::FT FT; @@ -305,7 +305,7 @@ typedef Traits::FT FT; /// \name Creation /// @{ -/*! +/*! Constructor. */ Sliding_fair(unsigned int bucket_size, @@ -316,13 +316,13 @@ FT aspect_ratio=FT(3)); /// \name Operations /// @{ -/*! +/*! Returns the maximal ratio between the largest and smallest side of a cell allowed for fair splitting. */ FT aspect_ratio(); -/*! +/*! Returns the bucket size of the leaf nodes. */ unsigned int bucket_size(); @@ -367,7 +367,7 @@ public: /// \name Creation /// @{ -/*! +/*! Constructor. */ Sliding_fair(unsigned int bucket_size); @@ -377,7 +377,7 @@ Sliding_fair(unsigned int bucket_size); /// \name Operations /// @{ -/*! +/*! Returns the bucket size of the leaf nodes. */ unsigned int bucket_size(); 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 e009eb061de..efddd24c473 100644 --- a/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h +++ b/Spatial_searching/doc/Spatial_searching/CGAL/Weighted_Minkowski_distance.h @@ -28,12 +28,12 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef Traits::FT FT; -/*! +/*! Point type. */ typedef Traits::Point_d Point_d; @@ -43,12 +43,12 @@ typedef Traits::Point_d Point_d; /// \name Creation /// @{ -/*! +/*! Constructor implementing \f$ l_2\f$ metric for \f$ d\f$-dimensional points. */ Weighted_Minkowski_distance(int d,Traits t=Traits()); -/*! +/*! Constructor implementing the \f$ l_{power}(weights)\f$ metric. \f$ power \leq0\f$ denotes the \f$ l_{\infty}(weights)\f$ metric. The values in the iterator range `[wb,we)` are the weight. */ @@ -60,36 +60,36 @@ Weighted_Minkowski_distance(FT power, int dim, InputIterator wb, InputIterator w /// \name Operations /// @{ -/*! +/*! Returns \f$ d^{power}\f$, where \f$ d\f$ denotes the distance between `q` and `r`. */ FT transformed_distance(Point_d q, Point_d r) const; -/*! +/*! Returns \f$ d^{power}\f$, where \f$ d\f$ denotes the distance between the query item `q` and the point on the boundary of `r` closest to `q`. */ FT min_distance_to_rectangle(Point_d q, Kd_tree_rectangle r;) const; -/*! +/*! Returns \f$ d^{power}\f$, where \f$ d\f$ denotes the distance between the query item `q` and the point on the boundary of `r` farthest to `q`. */ FT max_distance_to_rectangle(Point_d q, Kd_tree_rectangle r;) const; -/*! +/*! Updates `dist` incrementally and returns the updated distance. */ FT new_distance(FT dist, FT old_off, FT new_off, int cutting_dimension) const; -/*! +/*! Returns \f$ d^p\f$ for \f$ 0 < p <\infty\f$ . Returns \f$ d\f$ for \f$ p=\infty\f$ . */ FT transformed_distance(FT d) const; -/*! +/*! Returns \f$ d^{1/p}\f$ for \f$ 0 < p <\infty\f$. Returns \f$ d\f$ for \f$ p=\infty\f$. */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h b/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h index b8287de4a74..6e392ff8299 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/FuzzyQueryItem.h @@ -15,12 +15,12 @@ public: /// \name Types /// @{ -/*! +/*! represents a `d`-dimensional point. */ typedef unspecified_type Point_d; -/*! +/*! Number type. */ typedef unspecified_type FT; @@ -30,18 +30,18 @@ typedef unspecified_type FT; /// \name Operations /// @{ -/*! +/*! Test whether the query item contains `p`. */ bool contains(Point_d p) const; -/*! +/*! Test whether the inner approximation of the spatial object intersects a rectangle associated with a node of a tree. */ bool inner_range_intersects(const Kd_tree_rectangle& rectangle) const; -/*! +/*! Test whether the outer approximation of the spatial object encloses the rectangle associated with a node of a tree. */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h b/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h index 1d937be043c..3e0000eea8c 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/GeneralDistance.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef unspecified_type FT; -/*! +/*! Point type. */ typedef unspecified_type Point_d; -/*! +/*! Query item type. */ typedef unspecified_type Query_item; @@ -39,29 +39,29 @@ typedef unspecified_type Query_item; /// \name Operations /// @{ -/*! +/*! Returns the transformed distance between `q` and `r`. */ FT transformed_distance(Query_item q, Point_d r); -/*! +/*! Returns the transformed distance between `q` and the point on the boundary of `r` closest to `q`. */ FT min_distance_to_rectangle(Query_item q, Kd_tree_rectangle r) const; -/*! +/*! Returns the transformed distance between `q` and the point on the boundary of `r` furthest to `q`. */ FT max_distance_to_rectangle(Query_item q, Kd_tree_rectangle r) const; -/*! +/*! Returns the transformed distance. */ FT transformed_distance(FT d) const; -/*! +/*! Returns the inverse of the transformed distance. */ FT inverse_of_transformed_distance(FT d) const; diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h b/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h index 464a4e371c4..1a32ccbb36e 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/OrthogonalDistance.h @@ -19,17 +19,17 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef unspecified_type FT; -/*! +/*! Point type. */ typedef unspecified_type Point_d; -/*! +/*! Query item type. */ typedef unspecified_type Query_item; @@ -39,7 +39,7 @@ typedef unspecified_type Query_item; /// \name Creation /// @{ -/*! +/*! Constructor implementing distance for `d`-dimensional points. */ OrthogonalDistance(int d); @@ -49,34 +49,34 @@ OrthogonalDistance(int d); /// \name Operations /// @{ -/*! +/*! Returns the transformed distance between `q` and `r`. */ FT transformed_distance(Query_item q, Point_d r) const; -/*! +/*! Returns the transformed distance between `q` and the point on the boundary of `r` closest to `q`. */ FT min_distance_to_rectangle(Query_item q, Kd_tree_rectangle r) const; -/*! +/*! Returns the transformed distance between `q` and the point on the boundary of `r` farthest to `q`. */ FT max_distance_to_rectangle(Query_item q, Kd_tree_rectangle r) const; -/*! +/*! Returns the transformed distance. */ FT transformed_distance(FT d) const; -/*! +/*! Returns the inverse of the transformed distance. */ FT inverse_of_transformed_distance(FT d) const; -/*! +/*! Updates `dist` incrementally and returns the updated distance. */ FT new_distance(FT dist, FT old_off, FT new_off, int cutting_dimension) const; diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h b/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h index 7097c2b8549..4aec9382492 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/RangeSearchTraits.h @@ -24,40 +24,40 @@ public: /// \name Types /// @{ -/*! +/*! Iso box type, which is only needed for range search queries. */ typedef unspecified_type Iso_box_d; -/*! +/*! Sphere type, which is only needed for range search queries. */ typedef unspecified_type Sphere_d; -/*! +/*! Functor with operator to construct the iso box from two points. */ typedef unspecified_type Construct_iso_box_d; -/*! +/*! Functor with operator to construct the center of an object of type `Sphere_d`. */ typedef unspecified_type Construct_center_d; -/*! +/*! Functor with operator to compute the squared radius of a an object of type `Sphere_d`. */ typedef unspecified_type Construct_squared_radius_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically smallest coordinates of an object of type `Iso_box_d`. */ typedef unspecified_type Construct_min_vertex_d; -/*! +/*! Functor with operator to construct the vertex with lexicographically largest coordinates of an object of type `Iso_box_d`. */ diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h b/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h index de84e357902..89a9fb559d7 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SearchTraits.h @@ -22,24 +22,24 @@ public: /// \name Types /// @{ -/*! +/*! Point type. `CGAL::Kernel_traits` has to be specialized for this type. */ typedef unspecified_type Point_d; -/*! +/*! The number type of the %Cartesian coordinates of types `Point_d` */ typedef unspecified_type FT; -/*! +/*! A random access iterator type to enumerate the %Cartesian coordinates of a point. */ typedef unspecified_type Cartesian_const_iterator_d; -/*! +/*! Functor with operators to construct iterators on the first and the past-the-end iterator for the %Cartesian coordinates of a point. This functor must provide the type `result_type` that must be the same a `Cartesian_const_iterator_d`. @@ -51,7 +51,7 @@ typedef unspecified_type Construct_cartesian_const_iterator_d; /// \name Operations /// @{ -/*! +/*! Function used to construct an object of type `Construct_cartesian_const_iterator_d`. */ Construct_cartesian_const_iterator_d construct_construct_cartesian_const_iterator_d_object(const Point_d& p) const; diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h index 22d4993ee87..52bf32c5272 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialSeparator.h @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! Number type. */ typedef unspecified_type FT; @@ -33,7 +33,7 @@ typedef unspecified_type FT; /// \name Creation /// @{ -/*! +/*! Default constructor. */ Separator(); @@ -43,27 +43,27 @@ Separator(); /// \name Operations /// @{ -/*! +/*! Sets the cutting dimension to `d`. */ void set_cutting_dimension(int d); -/*! +/*! Sets the cutting value to `v`. */ void set_cutting_value(FT v); -/*! +/*! Returns the number of the cutting dimension. */ int cutting_dimension(); -/*! +/*! Returns the cutting value. */ FT cutting_value(); -/*! +/*! Returns true if and only if the point `p` is on the negative side of the separator. */ template diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h index 2a2ecf527b5..4414690b2e1 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/SpatialTree.h @@ -15,43 +15,43 @@ public: /// \name Types /// @{ -/*! +/*! Search traits. */ typedef unspecified_type SearchTraits; -/*! +/*! Point type. */ typedef unspecified_type Point_d; -/*! +/*! Bidirectional const iterator with value type `Point_d` that allows to enumerate all points in the tree. */ typedef unspecified_type iterator; -/*! +/*! Node handle. */ typedef unspecified_type Node_handle; -/*! +/*! const node handle. */ typedef unspecified_type Node_const_handle; -/*! +/*! const iterator with value type `const Point_d*`. */ typedef unspecified_type Point_d_iterator; -/*! +/*! Splitter. */ typedef unspecified_type Splitter; -/*! +/*! Distance. */ typedef unspecified_type Distance; @@ -61,7 +61,7 @@ typedef unspecified_type Distance; /// \name Creation /// @{ -/*! +/*! Constructs a tree on the elements from the sequence `[first,beyond)`. @@ -74,44 +74,44 @@ template Tree(InputIterator first, InputIterator beyond, S /// \name Operations /// @{ -/*! +/*! Reports the points that are approximately contained by `q`. The value type of `OutputIterator` must be `Point_d`. */ template OutputIterator search(OutputIterator it, FuzzyQueryItem q); -/*! +/*! Returns a const iterator to the first point in the tree. */ iterator begin() const; -/*! +/*! Returns the appropriate past-the-end const iterator. */ iterator end() const; -/*! +/*! Returns a handle to the root node of the tree. */ Node_handle root(); -/*! +/*! Returns a const handle to the root node of the tree. */ Node_const_handle root() const; -/*! +/*! Returns a const reference to the bounding box of the root node of the tree. */ const Kd_tree_rectangle& bounding_box() const; -/*! +/*! Returns the number of items that are stored in the tree. diff --git a/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h b/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h index 52db7942d90..234bf5bfa34 100644 --- a/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h +++ b/Spatial_searching/doc/Spatial_searching/Concepts/Splitter.h @@ -23,17 +23,17 @@ public: /// The parameters `aspect_ratio` and `bucket_size` define the way in which \f$k\f$ - \f$d\f$ tree is constructed. /// @{ -/*! +/*! Number type. */ typedef unspecified_type FT; -/*! +/*! Separator. */ typedef unspecified_type Separator; -/*! +/*! Typedef to an instantiation of `CGAL::Point_container`. */ typedef unspecified_type Container; @@ -43,18 +43,18 @@ typedef unspecified_type Container; /// \name Operations /// @{ -/*! +/*! Returns the maximal ratio between the largest and smallest side of a cell allowed for fair splitting. */ FT aspect_ratio() const; -/*! +/*! Returns the bucket size of the leaf nodes. */ unsigned int bucket_size() const; -/*! +/*! Sets up `sep` and splits points of `c0` into `c0` and `c1` using `sep`. Container `c0` should contain at least two points and `c1` must be empty. 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 a28cbd66353..d1ff8f02b61 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_2.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an instance with `traits` as traits class instance. */ Hilbert_sort_2(const Traits &traits = Traits()); @@ -29,7 +29,7 @@ Hilbert_sort_2(const Traits &traits = Traits()); /// \name Operations /// @{ -/*! +/*! sorts the range `[begin, end)`. \tparam RandomAccessIterator must be an iterator with value type `Traits::Point_2`. */ 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 043360162ed..b4fb1dde1a4 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_3.h @@ -17,7 +17,7 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an instance with `traits` as traits class instance. */ Hilbert_sort_3(const Traits &traits = Traits()); @@ -27,7 +27,7 @@ Hilbert_sort_3(const Traits &traits = Traits()); /// \name Operations /// @{ -/*! +/*! sorts the range `[begin, end)`. \tparam RandomAccessIterator must be an iterator with value type `Traits::Point_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 c569d2a0c62..31849dad0d7 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Hilbert_sort_d.h @@ -17,7 +17,7 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an instance with `traits` as traits class instance. */ Hilbert_sort_d(const Traits &traits = Traits()); @@ -27,7 +27,7 @@ Hilbert_sort_d(const Traits &traits = Traits()); /// \name Operations /// @{ -/*! +/*! sorts the range `[begin, end)`. \tparam RandomAccessIterator must be an iteratoe with value type `Traits::Point_d`. */ diff --git a/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h b/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h index 5a71afebff3..2cca298fbe8 100644 --- a/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h +++ b/Spatial_sorting/doc/Spatial_sorting/CGAL/Multiscale_sort.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! constructs an instance with `traits` as traits class instance. */ Multiscale_sort (const Sort &sort = Sort(), std::ptrdiff_t threshold = 1, double ratio = 0.5); @@ -29,7 +29,7 @@ Multiscale_sort (const Sort &sort = Sort(), std::ptrdiff_t threshold = 1, double /// \name Operations /// @{ -/*! +/*! sorts the range `[begin, end)`. \cgalRequires `Sort::operator()(RandomAccessIterator begin, RandomAccessIterator end)` is defined. */ 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 2e873acea16..91b9919732d 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 @@ -22,7 +22,7 @@ public: /// \name Types /// @{ -/*! +/*! */ boost::property_traits::key_type Point_2; @@ -32,12 +32,12 @@ boost::property_traits::key_type Point_2; /// \name Creation /// @{ -/*! +/*! */ Spatial_sort_traits_adapter_2(Base_traits base=Base_traits()); -/*! +/*! */ Spatial_sort_traits_adapter_2(const PointPropertyMap& ppmap,Base_traits base=Base_traits()); @@ -47,7 +47,7 @@ Spatial_sort_traits_adapter_2(const PointPropertyMap& ppmap,Base_traits base=Bas /// \name Operations /// @{ -/*! +/*! Returns a const reference to the point property map. */ const PointPropertyMap& point_property_map() const; 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 3f806d2a9ad..1ed457ea225 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 @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! */ boost::property_traits::key_type Point_3; @@ -33,12 +33,12 @@ boost::property_traits::key_type Point_3; /// \name Creation /// @{ -/*! +/*! */ Spatial_sort_traits_adapter_3(Base_traits base=Base_traits()); -/*! +/*! */ Spatial_sort_traits_adapter_3(const PointPropertyMap& ppmap,Base_traits base=Base_traits()); @@ -48,7 +48,7 @@ Spatial_sort_traits_adapter_3(const PointPropertyMap& ppmap,Base_traits base=Bas /// \name Operations /// @{ -/*! +/*! Returns a const reference to the point property map. */ const PointPropertyMap& point_property_map() const; 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 1a7a2717f3a..c6f00b5c5aa 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 @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! */ boost::property_traits::key_type Point_d; @@ -33,12 +33,12 @@ boost::property_traits::key_type Point_d; /// \name Creation /// @{ -/*! +/*! */ Spatial_sort_traits_adapter_d(Base_traits base=Base_traits()); -/*! +/*! */ Spatial_sort_traits_adapter_d(const PointPropertyMap& ppmap,Base_traits base=Base_traits()); @@ -48,7 +48,7 @@ Spatial_sort_traits_adapter_d(const PointPropertyMap& ppmap,Base_traits base=Bas /// \name Operations /// @{ -/*! +/*! Returns a const reference to the point property map. */ const PointPropertyMap& point_property_map() const; diff --git a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h index 801a25643e5..2524e0cea4c 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h +++ b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_2.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! The point type on which the sorting algorithms operate. */ typedef unspecified_type Point_2; -/*! +/*! Functor object type returning the \f$ x\f$ coordinate of a `Point_2`. Must provide `FT operator()(Point_2 p)` where `FT` can be used as @@ -34,7 +34,7 @@ argument of `CGAL::to_double`. */ typedef unspecified_type Compute_x_2; -/*! +/*! Functor object type returning the \f$ y\f$ coordinate of a `Point_2`. Must provide `FT operator()(Point_2 p)` where `FT` can be used as @@ -43,7 +43,7 @@ argument of `CGAL::to_double`. */ typedef unspecified_type Compute_y_2; -/*! +/*! Binary predicate object type comparing `Point_2`s along the \f$ x\f$ coordinate. Must provide @@ -55,7 +55,7 @@ respectively. */ typedef unspecified_type Less_x_2; -/*! +/*! Binary predicate object type comparing `Point_2`s along the \f$ y\f$ coordinate. Must provide @@ -73,7 +73,7 @@ typedef unspecified_type Less_y_2; /// Only a copy constructor is required. /// @{ -/*! +/*! */ SpatialSortingTraits_2(const SpatialSortingTraits_2& t); @@ -84,22 +84,22 @@ SpatialSortingTraits_2(const SpatialSortingTraits_2& t); /// The following member functions to create instances of the above predicate object types must exist. /// @{ -/*! +/*! */ Compute_x_2 compute_x_2_object(); -/*! +/*! */ Compute_y_2 compute_y_2_object(); -/*! +/*! */ Less_x_2 less_x_2_object(); -/*! +/*! */ Less_y_2 less_y_2_object(); diff --git a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h index ebeca26f791..1c95e7b0232 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h +++ b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_3.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! The point type on which the sorting algorithms operate. */ typedef unspecified_type Point_3; -/*! +/*! Functor object type returning the \f$ x\f$ coordinate of a `Point_3`. Must provide `FT operator()(Point_3 p)` where `FT` can be used as @@ -34,7 +34,7 @@ argument of `CGAL::to_double`. */ typedef unspecified_type Compute_x_3; -/*! +/*! Functor object type returning the \f$ y\f$ coordinate of a `Point_3`. Must provide `FT operator()(Point_3 p)` where `FT` can be used as @@ -43,7 +43,7 @@ argument of `CGAL::to_double`. */ typedef unspecified_type Compute_y_3; -/*! +/*! Functor object type returning the \f$ z\f$ coordinate of a `Point_3`. Must provide `FT operator()(Point_3 p)` where `FT` can be used as @@ -52,7 +52,7 @@ argument of `CGAL::to_double`. */ typedef unspecified_type Compute_z_3; -/*! +/*! Binary predicate object type comparing `Point_3`s along the \f$ x\f$ coordinate. Must provide @@ -64,7 +64,7 @@ respectively. */ typedef unspecified_type Less_x_3; -/*! +/*! Binary predicate object type comparing `Point_3`s along the \f$ y\f$ coordinate. Must provide @@ -76,7 +76,7 @@ respectively. */ typedef unspecified_type Less_y_3; -/*! +/*! Binary predicate object type comparing `Point_3`s along the \f$ z\f$ coordinate. Must provide @@ -94,7 +94,7 @@ typedef unspecified_type Less_z_3; /// Only a copy constructor is required. /// @{ -/*! +/*! */ SpatialSortingTraits_3(const SpatialSortingTraits_3& t); @@ -105,32 +105,32 @@ SpatialSortingTraits_3(const SpatialSortingTraits_3& t); /// The following member functions to create instances of the above predicate object types must exist. /// @{ -/*! +/*! */ Compute_x_3 compute_x_3_object(); -/*! +/*! */ Compute_y_3 compute_y_3_object(); -/*! +/*! */ Compute_z_3 compute_z_3_object(); -/*! +/*! */ Less_x_3 less_x_3_object(); -/*! +/*! */ Less_y_3 less_y_3_object(); -/*! +/*! */ Less_z_3 less_z_3_object(); diff --git a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h index b3cd8044fce..0c6f2f92445 100644 --- a/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h +++ b/Spatial_sorting/doc/Spatial_sorting/Concepts/SpatialSortingTraits_d.h @@ -20,13 +20,13 @@ public: /// \name Types /// @{ -/*! +/*! The point type on which the sorting algorithms operate. */ typedef unspecified_type Point_d; -/*! +/*! Functor object type returning the dimension of a `Point_d`. Must provide `int operator()(Point_d p)` returning the dimension of \f$ p\f$. @@ -34,7 +34,7 @@ Must provide */ typedef unspecified_type Point_dimension_d; -/*! +/*! Functor object type returning the coordinates of a `Point_d`. Must provide `FT operator()(Point_d p, int i)` returning the \f$ i\f$th @@ -44,7 +44,7 @@ argument of `CGAL::to_double`. */ typedef unspecified_type Compute_coordinate_d; -/*! +/*! Binary predicate object type comparing `Point_d`s along some coordinate. Must provide @@ -62,7 +62,7 @@ typedef unspecified_type Less_coordinate_d; /// Only a copy constructor is required. /// @{ -/*! +/*! */ SpatialSortingTraits_d(const SpatialSortingTraits_d& t); @@ -73,17 +73,17 @@ SpatialSortingTraits_d(const SpatialSortingTraits_d& t); /// The following member functions to create instances of the above predicate object types must exist. /// @{ -/*! +/*! */ Point_dimension_d point_dimension_d_object(); -/*! +/*! */ Compute_coordinate_d compute_coordinate_d_object(); -/*! +/*! */ Less_coordinate_d less_coordinate_d_object(); diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h index 0651557e239..10c6b83e636 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Polygon_offset_builder_2.h @@ -26,22 +26,22 @@ public: /// \name Types /// @{ -/*! +/*! The straight skeleton (first template parameter) */ typedef StraightSkeleton_2 Ss; -/*! +/*! The geometric traits (second template parameter) */ typedef StraightSkeletonBuilderTraits_2 Gt; -/*! +/*! The container of 2D vertices that represents each offset contour generated by the algorithm (third template parameter) */ typedef VertexContainer_2 Container; -/*! +/*! The model of `FieldWithSqrt` used to specify the desired offset distance, provided by the geometric traits `Gt`. */ typedef Gt::FT FT; @@ -51,7 +51,7 @@ The model of `FieldWithSqrt` used to specify the desired offset distance, provid /// \name Creation /// @{ -/*! +/*! Constructs the builder class using the given Straight Skeleton instance. */ PolygonOffsetBuilder_2( Ss const& ss ); @@ -61,7 +61,7 @@ PolygonOffsetBuilder_2( Ss const& ss ); /// \name Methods /// @{ -/*! +/*! Given the straight skeleton passed in the constructor which corresponds to the interior of a non-degenerate strictly-simple polygon with holes P, returns all the offset contours of P at the Euclidean distance `t`. Such offset contours are polygons in the interior of P. Provided exact constructions are used, these polygons are simple. 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 aa234a7d4b5..92bb30cd894 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 @@ -87,17 +87,17 @@ public: /// \name Types /// @{ -/*! +/*! The geometric traits (first template parameter) */ typedef StraightSkeletonBuilderTraits_2 Gt; -/*! +/*! The straight skeleton (second template parameter) */ typedef StraightSkeleton_2 Ss; -/*! +/*! The 2D point type as defined by the geometric traits */ typedef unspecified_type Point_2; @@ -107,7 +107,7 @@ typedef unspecified_type Point_2; /// \name Creation /// @{ -/*! +/*! %Default constructs the builder class. */ StraightSkeletonBuilder_2(); @@ -117,7 +117,7 @@ StraightSkeletonBuilder_2(); /// \name Methods /// @{ -/*! +/*! Defines the contours that form the non-degenerate strictly-simple polygon with holes whose straight skeleton is to be built. Each contour must be input in turn starting with the outer contour and following with the holes (if any). The order of the holes is unimportant but the outer contour must be entered first. The outer contour must be oriented counter-clockwise while holes must be oriented clockwise. @@ -130,7 +130,7 @@ InputPointIterator must be an InputIterator whose `value_type` is `Point_ */ template Straight_skeleton_builder_2& enter_contour( InputPointIterator aBegin, InputPointIterator aEnd ); -/*! +/*! Constructs and returns the 2D straight skeleton in the interior of the polygon with holes as defined by the contours entered first by calling `enter_contour`. All the contours of the polygon with holes must be entered before calling `construct_skeleton`. After `construct_skeleton` completes, you cannot enter more contours and/or call `construct_skeleton()` again. If you need another straight skeleton for another polygon you must instantiate and use another builder. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h index e1a33c46de6..29ccafdd6a9 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/CGAL/Straight_skeleton_converter_2.h @@ -51,17 +51,17 @@ public: /// \name Types /// @{ -/*! +/*! The `SrcSs` template parameter corresponding to the source straight skeleton. */ SrcSs Source_skeleton; -/*! +/*! The `TgtSs` template parameter corresponding to the target straight skeleton. */ TgtSs Target_skeleton; -/*! +/*! The `ItemsCvt` template parameter corresponding to the items converter. */ ItemsCvt Items_converter; @@ -71,7 +71,7 @@ ItemsCvt Items_converter; /// \name Creation /// @{ -/*! +/*! %Default constructor . */ Straight_skeleton_converter_2( Items_converter const& c ); @@ -81,7 +81,7 @@ Straight_skeleton_converter_2( Items_converter const& c ); /// \name Operations /// @{ -/*! +/*! returns a new straight skeleton data structure with the same combinatorial and geometric data as `s` using the items converter to convert the geometric embeeding to the types of the target traits. */ boost::shared_ptr operator()( Source_skeleton const& s) const; @@ -121,7 +121,7 @@ public: /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Straight_skeleton_items_converter_2<>(); diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h index 340c3ada6f8..4edf86c914b 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/PolygonOffsetBuilderTraits_2.h @@ -17,38 +17,38 @@ public: /// \name Types /// @{ -/*! +/*! A model of the `Kernel` concept. */ typedef unspecified_type Kernel; -/*! +/*! A model of the `FieldWithSqrt` concept provided by the kernel. This type is used to represent the coordinates of the input points and to specify the desired offset distance. */ typedef unspecified_type FT; -/*! +/*! A 2D point type */ typedef unspecified_type Point_2; -/*! +/*! A pair of (x,y) coordinates representing a 2D Cartesian point. */ boost::tuple Vertex; -/*! +/*! A pair of vertices representing an edge */ boost::tuple Edge; -/*! +/*! A triple of edges representing an event */ boost::tuple EdgeTriple; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()( FT d, EdgeTriple const& et) const`, which compares the Euclidean distance `d` with the event time for `et`. Such event time is the Euclidean distance at which the offset lines intersect in a single point. The source of such offset lines is given by the 3 oriented lines defined by the edge-triple `et` @@ -56,7 +56,7 @@ Must provide `Comparison_result operator()( FT d, EdgeTriple const& et) const`, */ typedef unspecified_type Compare_offset_against_event_time_2; -/*! +/*! A construction object type. Must provide `boost::optional operator()( FT t, Edge const& x, Edge const& y) const`, which constructs the point of intersection of the lines obtained by offsetting the oriented lines given by `x` and `y` an Euclidean distance `t`. @@ -66,21 +66,21 @@ If the point cannot be computed, not even approximately (because of overflow for */ typedef unspecified_type Construct_offset_point_2; -/*! +/*! A construction object type. Must provide `Vertex operator()( Point_2 const& p)`, which given a `Point_2` `p` returns a Vertex encapsulating the corresponding (x,y) pair of Cartesian coordinates. */ typedef unspecified_type Construct_ss_vertex_2; -/*! +/*! A construction object type. Must provide `Edge operator()( Point_2 const& s, Point_2 const& t)`, which given source and target points `s` and `t` returns an Edge encapsulating the corresponding input segment (in Cartesian coordinates.) */ typedef unspecified_type Construct_ss_edge_2; -/*! +/*! A construction object type. Must provide `Triedge operator()( Edge const& e0, Edge const& e1, Edge const& e2)`, which given the 3 edges that define an event, `e0`, `e1` and `e2`, returns a Triedge encapsulating them. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h index 5ed853b208b..2a993490915 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilderTraits_2.h @@ -17,48 +17,48 @@ public: /// \name Types /// @{ -/*! +/*! A model of the `Kernel` concept. */ typedef unspecified_type Kernel; -/*! +/*! A model of the `FieldWithSqrt` concept provided by the kernel. This type is used to represent the coordinates of the input points, of the skeleton nodes and as the event time stored in the skeleton nodes. */ typedef unspecified_type FT; -/*! +/*! A pair of (x,y) coordinates representing a 2D Cartesian point. */ boost::tuple Vertex; -/*! +/*! A pair of vertices representing an edge */ boost::tuple Edge; -/*! +/*! A triple of edges representing an event */ boost::tuple EdgeTriple; -/*! +/*! A predicate object type being a model of the `Kernel::Equal_2` function object concept. */ typedef unspecified_type Equal_2; -/*! +/*! A predicate object type being a model of the `Kernel::LeftTurn_2` function object concept. */ typedef unspecified_type Left_turn_2; -/*! +/*! A predicate object type being a model of the `Kernel::Collinear_2` function object concept. */ typedef unspecified_type Collinear_2; -/*! +/*! A predicate object type. Must provide `bool operator()( EdgeTriple const& et) const`, which determines if, given the 3 oriented lines defined by the 3 input edges (3 pair of points), there exist an Euclidean distance `t >= 0` for which the corresponding 3 offset lines at `t` (parallel lines at an Euclidean distance of `t`) intersect in a single point. @@ -67,7 +67,7 @@ Must provide `bool operator()( EdgeTriple const& et) const`, which determines if */ typedef unspecified_type Do_ss_event_exist_2; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()( EdgeTriple const& x, EdgeTriple const& y) const`, which compares the `times` for the events determined by the edge-triples `x` and `y`. @@ -78,7 +78,7 @@ The time of an event given by an edge triple (which defines 3 oriented lines) is */ typedef unspecified_type Compare_ss_event_times_2; -/*! +/*! A predicate object type. Must provide `Comparison_result operator()( Point_2 const& p, EdgeTriple const& x, EdgeTriple const& y)`, which compares the Euclidean distance of the points of event for `x` and `y` to the point `p`. @@ -91,7 +91,7 @@ It must also provide `Comparison_result operator( EdgeTriple const& seed, EdgeTr */ typedef unspecified_type Compare_ss_event_distance_to_seed_2; -/*! +/*! A predicate object type. Must provide `bool operator()( EdgeTriple const& e, EdgeTriple const& zone)`, which determines if the point of event for `e` is inside the offset zone defined by the 3 oriented lines given by `zone`. @@ -102,7 +102,7 @@ An offset zone given by 3 oriented lines is the intersection of the halfp */ typedef unspecified_type Is_ss_event_inside_offset_zone_2; -/*! +/*! A predicate object type. Must provide `bool operator()( EdgeTriple const& x, EdgeTriple const& y)`, which determines if the events given by `x` and `y` are coincident in time and space; that is, both triples of offset lines intersect at the same point and at the same Euclidean distance from their sources. @@ -111,7 +111,7 @@ Must provide `bool operator()( EdgeTriple const& x, EdgeTriple const& y)`, which */ typedef unspecified_type Are_ss_events_simultaneous_2; -/*! +/*! A construction object type. Must provide `boost::tuple< boost::optional, boost::optional > operator()( EdgeTriple const& e)`, which given the 3 oriented lines defined by the 3 input edges (3 pair of points), returns the Euclidean distance `t >= 0` and intersection point at which the corresponding 3 offset lines at `t` intersect. @@ -122,21 +122,21 @@ If the values cannot be computed, not even approximately (because of overflow fo */ typedef unspecified_type Construct_ss_event_time_and_point_2; -/*! +/*! A construction object type. Must provide `Vertex operator()( Point_2 const& p)`, which given a `Point_2` `p` returns a Vertex encapsulating the corresponding (x,y) pair of Cartesian coordinates. */ typedef unspecified_type Construct_ss_vertex_2; -/*! +/*! A construction object type. Must provide `Edge operator()( Point_2 const& s, Point_2 const& t)`, which given source and target points `s` and `t` returns an Edge encapsulating the corresponding input segment (in Cartesian coordinates.) */ typedef unspecified_type Construct_ss_edge_2; -/*! +/*! A construction object type. Must provide `Triedge operator()( Edge const& e0, Edge const& e1, Edge const& e2)`, which given the 3 edges that define an event, `e0`, `e1` and `e2`, returns a Triedge encapsulating them. diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h index 754d26dfc17..d9410bab95f 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonBuilder_2_Visitor.h @@ -16,12 +16,12 @@ public: /// \name Types /// @{ -/*! +/*! A constant handle to a straight skeleton halfedge. */ typedef unspecified_type Halfedge_const_handle; -/*! +/*! A constant handle to a straight skeleton vertex. */ typedef unspecified_type Vertex_const_handle; @@ -31,17 +31,17 @@ typedef unspecified_type Vertex_const_handle; /// \name Operations /// @{ -/*! +/*! Called for each contour halfedge added to the skeleton). */ void on_contour_edge_entered( Halfedge_const_handle const& ) const; -/*! +/*! Called before the initialization stage (when initial events are discovered) is started. */ void on_initialization_started( std::size_t number_of_vertices ) const; -/*! +/*! Called after the events for contour vertex `v` have been discovered. `is_reflex` is true if this vertex has an internal angle \f$ > \pi\f$, or `is_degenerate` is true if the internal angle is \f$ = \pi\f$. @@ -51,38 +51,38 @@ void on_contour_vertex_processed( Vertex_const_handle const& v , bool is_degenerate ) const; -/*! +/*! Called after an edge event for nodes `node0` and `node1` has been discovered and put on the queue for later processing. */ void on_edge_event_created( Vertex_const_handle const& node0 , Vertex_const_handle const& node1 ) const ; -/*! +/*! Called after a slipt event for node `node` has been discovered and put on the queue for later processing. */ void on_split_event_created( Vertex_const_handle const& node ) const ; -/*! +/*! Called after a pseudo slipt event for nodes `node0` and `node1` has been discovered and put on the queue for later processing. */ void on_pseudo_split_event_created( Vertex_const_handle const& node0 , Vertex_const_handle const& node1 ) const ; -/*! +/*! Called after all initial events have been discovered. */ void on_initialization_finished() const; -/*! +/*! Called before the propagation stage (when events are poped off the queue and processed) is started. */ void on_propagation_started() const; -/*! +/*! Called after an anhiliation event for nodes `node0` and `node1` has been processed. A new skeleton edge between these nodes has been added. */ @@ -90,7 +90,7 @@ void on_anihiliation_event_processed ( Vertex_const_handle const& node0 , Vertex_const_handle const& node1 ) const; -/*! +/*! Called after an edge for nodes `seed0` and `seed1` has been processed. Skeleton vertex `newnode` and edges from `node0` to `newnode` and `node1` to `newnode` has been added. @@ -100,7 +100,7 @@ void on_edge_event_processed( Vertex_const_handle const& seed0 , Vertex_const_handle const& newnode ) const; -/*! +/*! Called after a split event for node `seed` has been processed. Skeleton vertices `newnode0` and `newnode1` have been added. An skeleton edge from `seed` to `newnode0` has been added. @@ -111,7 +111,7 @@ void on_split_event_processed( Vertex_const_handle const& seed , Vertex_const_handle const& newnode1 ) const; -/*! +/*! Called after a pseudo split event for nodes `seed0` and `seed1` has been processed. Skeleton vertices `newnode0` and `newnode1` have been added. Skeleton edges from `seed0` to `newnode0` and `seed1` to `newnode1` has been added. @@ -122,34 +122,34 @@ void on_pseudo_split_event_processed( Vertex_const_handle const& seed0 , Vertex_const_handle const& newnode1 ) const; -/*! +/*! Called after vertex `v` has been marked as already processed. */ void on_vertex_processed( Vertex_const_handle const& v ) const; -/*! +/*! Called after all events have been processed. */ void on_propagation_finished() const; -/*! +/*! Called when the skeleton clean up (when multiple nodes are merged) is started. */ void on_cleanup_started() const; -/*! +/*! Called when clean up finished. */ void on_cleanup_finished() const; -/*! +/*! Called when the algorithm terminated. `finished_ok` is false if it terminated before completion or the resulting skeleton was found to be invalid. */ void on_algorithm_finished ( bool finished_ok ) const; -/*! +/*! Called whenever an error was detected. `msg` is whatever error message accompanies the error. This pointer can be `null`. */ diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h index da850899b3c..262336ddc21 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonFace_2.h @@ -23,12 +23,12 @@ public: /// \name Creation /// @{ -/*! +/*! Default constructor */ StraightSkeletonFace_2(); -/*! +/*! Constructs a face with ID number `id` */ StraightSkeletonFace_2(int id); @@ -38,7 +38,7 @@ StraightSkeletonFace_2(int id); /// \name Access Functions /// @{ -/*! +/*! The ID of the face. */ int id() const; diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h index cd62b041cc9..f21e3499e80 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonHalfedge_2.h @@ -25,12 +25,12 @@ public: /// \name Creation /// @{ -/*! +/*! Default Constructor. */ StraightSkeletonHalfedge_2(); -/*! +/*! Constructs a halfedge with ID `id`. It is the links to other halfedges what determines if this is a contour edge, a contour-skeleton edge or an inner-skeleton edge. @@ -42,12 +42,12 @@ StraightSkeletonHalfedge_2( int id ); /// \name Access Functions /// @{ -/*! +/*! */ Halfedge_handle defining_contour_edge(); -/*! +/*! If this is a bisector halfedge, returns a handle to the inward-facing (non-border) contour halfedge corresponding to the defining contour edge which is to its left; if this is a contour halfedge, returns a handle to itself if `is\_border()` is `false`, or to its opposite if it is `true`. */ Halfedge_const_handle defining_contour_edge() const; @@ -57,12 +57,12 @@ Halfedge_const_handle defining_contour_edge() const; /// \name Queries /// @{ -/*! +/*! Returns `true` iff this is a bisector (or skeleton) halfedge (i.e.\ is not a contour halfedge). */ bool is_bisector() const; -/*! +/*! Returns `true` iff this is a bisector and is inner (i.e.\ is not incident upon a contour vertex). */ bool is_inner_bisector() const; diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h index 9f35713237a..71298e770be 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonItemsConverter_2.h @@ -16,37 +16,37 @@ public: /// \name Types /// @{ -/*! +/*! A constant handle to a model of the `StraightSkeletonVertex_2` concept used to represent the vertices of the straight skeleton of the source type. */ typedef unspecified_type Source_vertex_const_handle; -/*! +/*! A constant handle to model of the `StraightSkeletonHalfedge_2` concept used to represent the halfedges of the straight skeleton of the source type. */ typedef unspecified_type Source_halfedge_const_handle; -/*! +/*! A constant handle to model of the `StraightSkeletonFace_2` concept used to represent the faces of the straight skeleton of the source type. */ typedef unspecified_type Source_face_const_handle; -/*! +/*! A model of the `StraightSkeletonVertex_2` concept used to represent the vertices of the straight skeleton of the target type. */ typedef unspecified_type Tarvet_vertex; -/*! +/*! A model of the `StraightSkeletonHalfedge_2` concept used to represent the halfedges of the straight skeleton of the target type. */ typedef unspecified_type Target_halfedge; -/*! +/*! Any model of the `StraightSkeletonFace_2` concept used to represent the faces of the straight skeleton of the target type. */ @@ -57,17 +57,17 @@ typedef unspecified_type Target_face; /// \name Operations /// @{ -/*! +/*! returns a new vertex with the same data as `v` converted to the corresponding target types. */ Target_vertex operator()( Source_vertex_const_handle v) const; -/*! +/*! returns a new halfedge with the same data as `h` converted to the corresponding target types. */ Target_halfedge operator()( Source_halfedge_const_handle h) const; -/*! +/*! returns a new face with the same data as `f` converted to the corresponding target types. */ Target_face operator()( Source_face_const_handle f) const; diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h index 4abc903f857..55381bcba15 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeletonVertex_2.h @@ -23,32 +23,32 @@ public: /// \name Types /// @{ -/*! +/*! The type of the 2D point being the geometric embedding of the vertex */ typedef unspecified_type Point_2; -/*! +/*! A model of the `FieldWithSqrt` concept representing the time of a vertex (an Euclidean distance) */ typedef unspecified_type FT; -/*! +/*! */ typedef unspecified_type Halfedge_around_vertex_const_circulator; -/*! +/*! The circulator type used to visit all the incident halfedges around a vertex */ typedef unspecified_type Halfedge_around_vertex_circulator; -/*! +/*! */ typedef unspecified_type Defining_contour_halfedge_const_circulator; -/*! +/*! The circulator type used to visit all the defining contour halfedges of a vertex */ typedef unspecified_type Defining_contour_halfedge_circulator; @@ -58,17 +58,17 @@ typedef unspecified_type Defining_contour_halfedge_circulator; /// \name Creation /// @{ -/*! +/*! Default constructor */ StraightSkeletonVertex_2(); -/*! +/*! Constructs a contour vertex with ID number `id`, at the point `p` */ StraightSkeletonVertex_2(int id, Point_2 const& p); -/*! +/*! Constructs a skeleton vertex with ID number `id`, at point `p` and time `time`. */ StraightSkeletonVertex_2(int id, Point_2 const& p, FT time ); @@ -78,37 +78,37 @@ StraightSkeletonVertex_2(int id, Point_2 const& p, FT time ); /// \name Access Functions /// @{ -/*! +/*! The ID of the vertex. */ int id() const; -/*! +/*! The vertex point. */ Point_2 const& point() const; -/*! +/*! The time of the vertex: the distance from the vertex point to the lines supporting the defining contour edges */ FT time() const; -/*! +/*! */ Halfedge_handle primary_bisector(); -/*! +/*! Returns the skeleton halfedge incident upon the vertex (called the primary bisector). */ Halfedge_const_handle primary_bisector() const; -/*! +/*! */ Halfedge_around_vertex_circulator halfedge_around_vertex_begin(); -/*! +/*! Returns a bi-directional circulator pointing to one of the incident halfedges (which one is unspecified). There will always be as many incident halfedges as the degree of the vertex. @@ -121,12 +121,12 @@ Each halfedge pointed to by this circulator is the one which is oriented towards */ Halfedge_around_vertex_const_circulator halfedge_around_vertex_begin() const; -/*! +/*! */ Defining_contour_halfedge_circulator defining_contour_halfedges_begin(); -/*! +/*! Returns a bi-directional circulator pointing to one of the defining contour halfedges of the vertex (which one is unspecified). There will always be as many incident defining contour halfedges as the degree of the vertex. @@ -140,12 +140,12 @@ Defining_contour_halfedge_const_circulator defining_contour_halfedges_begin() co /// \name Queries /// @{ -/*! +/*! Returns `true` iff this is a contour vertex. */ bool is_contour() const; -/*! +/*! Returns `true` iff this is a skeleton vertex. */ bool is_skeleton() const; diff --git a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h index 4c2ab133a6c..cbb14cea547 100644 --- a/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h +++ b/Straight_skeleton_2/doc/Straight_skeleton_2/Concepts/StraightSkeleton_2.h @@ -24,17 +24,17 @@ public: /// \name Types /// @{ -/*! +/*! A model of the `StraightSkeletonVertex_2` concept used to represent the vertices of the straight skeleton */ typedef unspecified_type Vertex; -/*! +/*! A model of the `StraightSkeletonHalfedge_2` concept used to represent the halfedges of the straight skeleton */ typedef unspecified_type Halfedge; -/*! +/*! Any model of the `StraightSkeletonFace_2` concept used to represent the faces of the straight skeleton */ typedef unspecified_type Face; 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 7caca038b6f..41ff8b872d0 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 @@ -17,12 +17,12 @@ public: /// \name Types /// @{ -/*! +/*! A 2D point type used to represent a vertex. Must be a model of the `Kernel::Point_2` concept */ typedef unspecified_type Point_2; -/*! +/*! A unsigned integral type that can represent the number of vertices in the container. */ typedef unspecified_type size_type; @@ -32,17 +32,17 @@ typedef unspecified_type size_type; /// \name Creation /// @{ -/*! +/*! Default constructor */ VertexContainer_2(); -/*! +/*! Returns the number of vertices in the container. */ size_type size() const; -/*! +/*! Adds the vertex v to the container, resizing its capacity if required. */ void push_back( Point_2 const& v) const; diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h index b64ee29eecd..411ee87ee4f 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Euler_integrator_2.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! Creates an Euler integrator with `integration_step` as integration step. */ Euler_integrator_2(const FT & integration_step); diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h index 3eb6a68979a..2fcd5696719 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Regular_grid_2.h @@ -23,17 +23,17 @@ public: /// \name Types /// @{ -/*! +/*! the scalar type. */ typedef StreamLinesTraits_2::FT FT; -/*! +/*! the point type. */ typedef StreamLinesTraits_2::Point_2 Point_2; -/*! +/*! the vector type. */ typedef StreamLinesTraits_2::Vector_2 Vector_2; @@ -43,7 +43,7 @@ typedef StreamLinesTraits_2::Vector_2 Vector_2; /// \name Creation /// @{ -/*! +/*! Generate a regular grid whose size is `x_size` by `y_size`, while `x_samples` and `y_samples` specify the number of samples on `x` and `y`. */ @@ -57,7 +57,7 @@ Regular_grid_2(int x_samples, int y_samples, FT x_size, FT y_size); /// function to fill the vector field with the user data. /// @{ -/*! +/*! Attribute the vector v to the position (i,j) on the regular grid. */ @@ -68,12 +68,12 @@ void set_xy(int i, int j, Vector_2 v); /// \name Access Functions /// @{ -/*! +/*! returns the dimension of the grid. */ std::pair get_dimension(); -/*! +/*! returns the size of the grid. */ std::pair get_size(); diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h index 8dfa330a3fa..9e3e16c6e51 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Runge_kutta_integrator_2.h @@ -19,7 +19,7 @@ public: /// \name Creation /// @{ -/*! +/*! Creates a Runge-Kutta second order integrator with `integration_step` as integration step. */ Runge_kutta_integrator_2(const FT & integration_step); diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h index c279d566c82..d7de6332e56 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Stream_lines_2.h @@ -24,22 +24,22 @@ public: /// \name Types /// @{ -/*! +/*! the traits class. */ typedef VectorField_2::Geom_traits Geom_traits; -/*! +/*! the scalar type. */ typedef VectorField_2::FT FT; -/*! +/*! the point type. */ typedef VectorField_2::Point_2 Point_2; -/*! +/*! the vector type. */ typedef VectorField_2::Vector_2 Vector_2; @@ -52,12 +52,12 @@ typedef VectorField_2::Vector_2 Vector_2; /// @{ -/*! +/*! iterator of points with value type `Point_2`. */ typedef unspecified_type Point_iterator_2; -/*! +/*! an iterator to visit the streamlines with value type `std::pair`. */ typedef unspecified_type Stream_line_iterator_2; @@ -65,7 +65,7 @@ typedef unspecified_type Stream_line_iterator_2; /// @} -/*! +/*! Constructor which generates a streamline placement. */ Stream_lines_2(VectorField_2 vector_field_2, Integrator_2 integrator_2, FT @@ -75,19 +75,19 @@ separating_distance, FT saturation_ratio); /// \name Modifiers /// @{ -/*! +/*! Modify the separating distance. */ void set_separating_distance(FT new_value); -/*! +/*! Modify the saturation ratio. */ void set_saturation_ratio(FT new_value); -/*! +/*! Update the placement after changing the separating distance or the saturation ratio. */ @@ -98,17 +98,17 @@ void update(); /// \name Access Functions /// @{ -/*! +/*! returns the separating distance. */ FT get_separating_distance() const; -/*! +/*! returns the saturation ratio. */ FT get_saturation_ratio() const; -/*! +/*! prints the streamlines to an ASCII file: line by line, and point by point. */ void print_stream_lines(std::ofstream & fw); @@ -118,12 +118,12 @@ void print_stream_lines(std::ofstream & fw); /// \name Streamline Iterators /// @{ -/*! +/*! Starts at the first streamline */ Stream_line_iterator begin() const; -/*! +/*! Past-the-end iterator */ Stream_line_iterator end() const; diff --git a/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h b/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h index 215f8a59bee..eb04eff7d75 100644 --- a/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/CGAL/Triangular_field_2.h @@ -24,17 +24,17 @@ public: /// \name Types /// @{ -/*! +/*! the scalar type. */ typedef StreamLinesTraits_2::FT FT; -/*! +/*! the point type. */ typedef StreamLinesTraits_2::Point_2 Point_2; -/*! +/*! the vector type. */ typedef StreamLinesTraits_2::Vector_2 Vector_2; @@ -44,7 +44,7 @@ typedef StreamLinesTraits_2::Vector_2 Vector_2; /// \name Creation /// @{ -/*! +/*! Defines the points in the range `[first_point, last_point)` as the sample points of the triangular field, with the corresponding number of vectors started at `first_vector`. \tparam PointInputIterator must be an input iterator with the value type `Point_2`. diff --git a/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h b/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h index bac1f103c7a..e7d10c7a256 100644 --- a/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/Concepts/Integrator_2.h @@ -20,22 +20,22 @@ public: /// \name Types /// @{ -/*! +/*! The scalar type. */ typedef unspecified_type FT; -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The vector type. */ typedef unspecified_type Vector_2; -/*! +/*! The vector field type. */ typedef unspecified_type Vector_field_2; @@ -45,7 +45,7 @@ typedef unspecified_type Vector_field_2; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Integrator_2(); @@ -56,19 +56,19 @@ Integrator_2(); /// The following operations return the newly integrated point. /// @{ -/*! +/*! Returns the new position from the actual position defined by `p`, according to the vector given by `vector_field_2` at `p`. \pre `vector_field_2.is_in_domain(p)` must be `true`. */ Point_2 operator()(Point_2 p, Vector_field_2 vector_field_2); -/*! +/*! \brief As above.\ The integration step is defined by `integration_step`. \pre `vector_field_2.is_in_domain(p)` must be `true`. */ Point_2 operator()(Point_2 p, Vector_field_2 vector_field_2, FT integration_step); -/*! +/*! \brief As above.\ In addition, this function integrates forward if `direction` is true, and backward if it is false. \pre `vector_field_2.is_in_domain(p)` must be `true`. */ diff --git a/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h b/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h index ddaee54b31b..7eb8fe2630a 100644 --- a/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/Concepts/StreamLinesTraits_2.h @@ -18,17 +18,17 @@ public: /// \name Types /// @{ -/*! +/*! The scalar type. */ typedef unspecified_type FT; -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The vector type. */ typedef unspecified_type Vector_2; diff --git a/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h b/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h index 8b9d1f05e32..f6fd0f18f8f 100644 --- a/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h +++ b/Stream_lines_2/doc/Stream_lines_2/Concepts/VectorField_2.h @@ -20,22 +20,22 @@ public: /// \name Types /// @{ -/*! +/*! The traits class. */ typedef unspecified_type Geom_traits; -/*! +/*! The scalar type. */ typedef unspecified_type FT; -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The vector type. */ typedef unspecified_type Vector_2; @@ -45,7 +45,7 @@ typedef unspecified_type Vector_2; /// \name Creation /// @{ -/*! +/*! Any constructor has to allow the user to fill the vector values, i.e., assign a vector to each position within the domain. */ VectorField_2(); @@ -55,24 +55,24 @@ VectorField_2(); /// \name Query Functions /// @{ -/*! +/*! returns the bounding box of the whole domain. */ Geom_traits::Iso_rectangle_2 bbox(); -/*! +/*! returns the vector field value and the local density. \pre `is_in_domain(p)` must be `true`. */ std::pair get_field(Point_2 p); -/*! +/*! returns `true` if the point `p` is inside the domain boundaries, `false` otherwise. */ bool is_in_domain(Point_2 p); -/*! +/*! returns the integration step at the point `p`, i.e., the distance between `p` and the next point in the polyline. \pre `is_in_domain(p)` must be `true`. */ diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Color.h b/Stream_support/doc/Stream_support/CGAL/IO/Color.h index 40f260f3d8d..e3ad9813bdc 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Color.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Color.h @@ -19,12 +19,12 @@ public: /// \name Creation /// @{ -/*! +/*! creates a color with rgb-value `(0,0,0)`, i.e.\ black. */ Color(); -/*! +/*! creates a color with rgb-value `(red,green,blue)`. */ Color(unsigned char red, unsigned char green, unsigned char blue); @@ -34,28 +34,28 @@ Color(unsigned char red, unsigned char green, unsigned char blue); /// \name Operations /// @{ -/*! +/*! Test for equality: Two colors are equal, iff their rgb-values are equal. */ bool operator==(const Color &q) const; -/*! +/*! Test for inequality. */ bool operator!=(const Color &q) const; -/*! +/*! returns the red component of `c`. */ unsigned char red() const; -/*! +/*! returns the green component of `c`. */ unsigned char green() const; -/*! +/*! returns the blue component of `c`. */ unsigned char blue() const; @@ -66,37 +66,37 @@ unsigned char blue() const; /// The following constants are predefined: /// @{ -/*! +/*! Black. */ const Color BLACK = Color(0, 0, 0); -/*! +/*! White. */ const Color WHITE = Color(255, 255, 255); -/*! +/*! Red. */ const Color RED = Color(255, 0, 0); -/*! +/*! Green. */ const Color GREEN = Color(0, 255, 0); -/*! +/*! Blue. */ const Color BLUE = Color(0, 0, 255); -/*! +/*! Violet. */ const Color VIOLET = Color(255, 0, 255); -/*! +/*! Orange. */ const Color ORANGE = Color(255, 170, 0); diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h b/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h index 56c12f39f43..cb90ef6695b 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Istream_iterator.h @@ -19,14 +19,14 @@ public: /// \name Creation /// @{ -/*! +/*! creates an end-of-stream iterator. This is a past-the-end iterator, and it is useful when constructing a range. */ Istream_iterator(); -/*! +/*! creates an input iterator reading from `s`. When `s` reaches end of stream, this iterator will compare equal to an end-of-stream iterator diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h b/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h index 537406e87e6..71ea3de2419 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Ostream_iterator.h @@ -22,7 +22,7 @@ public: /// \name Creation /// @{ -/*! +/*! creates an output iterator writing to `s`. */ Ostream_iterator( Stream& s); diff --git a/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h b/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h index b3bcd0066f6..60195fc183d 100644 --- a/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h +++ b/Stream_support/doc/Stream_support/CGAL/IO/Verbose_ostream.h @@ -33,7 +33,7 @@ public: /// \name Creation /// @{ -/*! +/*! creates an output stream with state set to `active` that writes to the stream `out`. */ @@ -45,7 +45,7 @@ std::ostream& out = std::cerr); /// \name Operations /// @{ -/*! +/*! */ template < class T > diff --git a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h index 86ea1845dbe..bf11e4cb160 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_mask_3.h @@ -28,7 +28,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ CatmullClark_mask_3(); @@ -38,28 +38,28 @@ CatmullClark_mask_3(); /// \name Stencil functions /// @{ -/*! +/*! computes the Catmull-Clark facet-point `pt` of the facet `f`. */ void facet_node(Facet_handle f, Point_3& pt); -/*! +/*! computes the Catmull-Clark edge-point `pt` of the edge `e`. */ void edge_node(Edge_handle e, Point_3& pt); -/*! +/*! computes the Catmull-Clark vertex-point `pt` of the vertex `v`. */ void vertex_node(Vertex_handle v, Point_3& pt); -/*! +/*! computes the Catmull-Clark edge-point `ept` and the Catmull-Clark vertex-point `vpt` of the border edge `e`. @@ -101,7 +101,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ DooSabin_mask_3(); @@ -111,7 +111,7 @@ DooSabin_mask_3(); /// \name Stencil functions /// @{ -/*! +/*! computes the Doo-Sabin point `pt` of the vertex pointed by the halfedge `he`. @@ -153,7 +153,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Loop_mask_3(); @@ -163,21 +163,21 @@ Loop_mask_3(); /// \name Stencil functions /// @{ -/*! +/*! computes the Loop edge-point `pt` of the edge `e`. */ void edge_node(Edge_handle e, Point_3& pt); -/*! +/*! computes the Loop vertex-point `pt` of the vertex `v`. */ void vertex_node(Vertex_handle v, Point_3& pt); -/*! +/*! computes the Loop edge-point `ept` and the Loop vertex-point `vpt` of the border edge `e`. @@ -218,7 +218,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Sqrt3_mask_3(); @@ -228,14 +228,14 @@ Sqrt3_mask_3(); /// \name Stencil functions /// @{ -/*! +/*! computes the \f$ \sqrt{3}\f$ facet-point `pt` of the facet `f`. */ void facet_node(Facet_handle f, Point_3& pt); -/*! +/*! computes the \f$ \sqrt{3}\f$ vertex-point `pt` of the vertex `v`. diff --git a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h index 054144a1998..0b4abe0864d 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/CGAL/Subdivision_method_3.h @@ -52,7 +52,7 @@ Catmull-Clark subdivision. */ /// @{ -/*! +/*! applies the PQQ refinement on the control mesh `p` `step` times. The geometry of the refined mesh is computed by the geometry policy `mask`. @@ -62,7 +62,7 @@ This function overwrites the control mesh `p` with the refined mesh. template class Mask> void PQQ(Polyhedron_3& p, Mask mask, int step = 1); -/*! +/*! applies the PTQ refinement on the control mesh `p` `step` times, where `p` contains only triangle facets. @@ -74,7 +74,7 @@ The result of a non-triangle mesh `p` is undefined. template class Mask> void PTQ(Polyhedron_3& p, Mask mask, int step = 1); -/*! +/*! applies the DQQ refinement on the control mesh `p` `step` times. The geometry of the refined mesh is computed by the geometry policy `mask`. @@ -84,7 +84,7 @@ This function overwrites the control mesh `p` with the refined mesh. template class Mask> void DQQ(Polyhedron_3& p, Mask mask, int step = 1); -/*! +/*! applies the \f$ \sqrt{3}\f$ triangulation on the control mesh `p` `step` times, where `p` contains only triangle facets. @@ -96,7 +96,7 @@ The result of a non-triangle mesh `p` is undefined. template class Mask> void Sqrt3(Polyhedron_3& p, Mask mask, int step = 1); -/*! +/*! applies Catmull-Clark subdivision `step` times on the control mesh `p`. This function overwrites the control mesh `p` with the subdivided mesh. @@ -105,7 +105,7 @@ This function overwrites the control mesh `p` with the subdivided mesh. template void CatmullClark_subdivision(Polyhedron_3& p, int step = 1); -/*! +/*! applies Loop subdivision `step` times on the control mesh `p`. This function overwrites the control mesh `p` with the subdivided mesh. @@ -114,7 +114,7 @@ This function overwrites the control mesh `p` with the subdivided mesh. template void Loop_subdivision(Polyhedron_3& p, int step = 1); -/*! +/*! applies Doo-Sabin subdivision `step` times on the control mesh `p`. This function overwrites the control mesh `p` with the subdivided mesh. @@ -123,7 +123,7 @@ This function overwrites the control mesh `p` with the subdivided mesh. template void DooSabin_subdivision(Polyhedron_3& p, int step = 1); -/*! +/*! applies \f$ \sqrt{3}\f$ subdivision `step` times on the control mesh `p`. This function overwrites the control mesh `p` with the subdivided mesh. diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h index a36944ebecf..84499557c8b 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/DQQMask_3.h @@ -20,7 +20,7 @@ public: /// \name Operations /// @{ -/*! +/*! computes the subdivided point `pt` based on the neighborhood of the vertex pointed by the halfedge `he`. diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h index 2aa9504ed60..5cb9dde97ea 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PQQMask_3.h @@ -21,28 +21,28 @@ public: /// \name Operations /// @{ -/*! +/*! computes the facet-point `pt` based on the neighborhood of the facet `f`. */ void facet_node(Facet_handle facet, Point_3& pt); -/*! +/*! computes the edge-point `pt` based on the neighborhood of the edge `e`. */ void edge_node(Edge_handle e, Point_3& pt); -/*! +/*! computes the vertex-point `pt` based on the neighborhood of the vertex `v`. */ void vertex_node(Vertex_handle v, Point_3& pt); -/*! +/*! computes the edge-point `ept` and the vertex-point `vpt` based on the neighborhood of the border edge `e`. diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h index f563da9e0c9..fe23fba938a 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/PTQMask_3.h @@ -18,20 +18,20 @@ public: /// \name Operations /// @{ -/*! +/*! computes the edge-point `pt` based on the neighborhood of the edge `e`. */ void edge_node(Edge_handle e, Point_3& pt); -/*! +/*! computes the vertex-point `pt` based on the neighborhood of the vertex `v`. */ void vertex_node(Vertex_handle v, Point_3& pt); -/*! +/*! computes the edge-point `ept` and the vertex-point `vpt` based on the neighborhood of the border edge `e`. diff --git a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h index 2f38a1d76ba..3b2f9296d51 100644 --- a/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h +++ b/Subdivision_method_3/doc/Subdivision_method_3/Concepts/Sqrt3Mask_3.h @@ -19,14 +19,14 @@ public: /// \name Operations /// @{ -/*! +/*! computes the subdivided point `pt` based on the neighborhood of the facet `f`. */ void facet_node(Facet_handle f, Point_3& pt); -/*! +/*! computes the subdivided point `pt` based on the neighborhood of the vertex `v`. diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h index 06c0f8609e0..095e7b7a9a5 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/BorderParameterizer_3.h @@ -34,14 +34,14 @@ public: /// \name Types /// @{ -/*! +/*! Export `ParameterizationMesh_3` template parameter. */ typedef unspecified_type Adaptor; -/*! +/*! The various errors detected by this package. @@ -53,14 +53,14 @@ typedef unspecified_type Error_code; /// \name Operations /// @{ -/*! +/*! Assign to mesh's border vertices a 2D position (i.e.\ a `(u, v)` pair) on border's shape. Mark them as parameterized. Return false on error. */ Error_code parameterize_border(Adaptor& mesh); -/*! +/*! Indicate if border's shape is convex. diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h index 16cda228d49..afca395c773 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationMesh_3.h @@ -38,135 +38,135 @@ public: /// The following mutable handles, iterators, and circulators have appropriate non-mutable counterparts, i.e.\ `const_handle`, `const_iterator`, and `const_circulator`. The mutable types are assignable to their non-mutable counterparts. Both circulators are assignable to the `Vertex_iterator`. The iterators are assignable to the respective handle types. Wherever the handles appear in function parameter lists, the corresponding iterators can be used as well. /// @{ -/*! +/*! Number type to represent coordinates. */ typedef unspecified_type NT; -/*! +/*! 2D point that represents (u, v) coordinates computed by parameterization methods. Must provide `x()` and `y()` methods. */ typedef unspecified_type Point_2; -/*! +/*! 3D point that represents vertices coordinates. Must provide `x()`, `y()` and `z()` methods. */ typedef unspecified_type Point_3; -/*! +/*! 2D vector. Must provide `x()` and `y()` methods. */ typedef unspecified_type Vector_2; -/*! +/*! 3D vector. Must provide `x()`, `y()` and `z()` methods. */ typedef unspecified_type Vector_3; -/*! +/*! Opaque type representing a facet of the 3D mesh. No methods are expected. */ typedef unspecified_type Facet; -/*! +/*! Handle to a facet. Model of the Handle concept. */ typedef unspecified_type Facet_handle; -/*! +/*! */ typedef unspecified_type Facet_const_handle; -/*! +/*! Iterator over all mesh facets. Model of the `ForwardIterator` concept. */ typedef unspecified_type Facet_iterator; -/*! +/*! */ typedef unspecified_type Facet_const_iterator; -/*! +/*! Opaque type representing a vertex of the 3D mesh. No methods are expected. */ typedef unspecified_type Vertex; -/*! +/*! Handle to a vertex. Model of the Handle concept. */ typedef unspecified_type Vertex_handle; -/*! +/*! */ typedef unspecified_type Vertex_const_handle; -/*! +/*! Iterator over all vertices of a mesh. Model of the `ForwardIterator` concept. */ typedef unspecified_type Vertex_iterator; -/*! +/*! */ typedef unspecified_type Vertex_const_iterator; -/*! +/*! Iterator over vertices of the mesh main border. Model of the `ForwardIterator` concept. */ typedef unspecified_type Border_vertex_iterator; -/*! +/*! */ typedef unspecified_type Border_vertex_const_iterator; -/*! +/*! Counter-clockwise circulator over a facet's vertices. Model of the `BidirectionalCirculator` concept. */ typedef unspecified_type Vertex_around_facet_circulator; -/*! +/*! */ typedef unspecified_type Vertex_around_facet_const_circulator; -/*! +/*! Clockwise circulator over the vertices incident to a vertex. Model of the `BidirectionalCirculator` concept. */ typedef unspecified_type Vertex_around_vertex_circulator; -/*! +/*! */ typedef unspecified_type Vertex_around_vertex_const_circulator; @@ -177,223 +177,223 @@ typedef unspecified_type Vertex_around_vertex_const_circulator; /// The following mutable methods returning a handle, iterator, or circulator have appropriate non-mutable counterpart methods, i.e.\ `const`, returning a `const_handle`, `const_iterator`, or `const_circulator`. /// @{ -/*! +/*! Indicate if the mesh matches the `ParameterizationMesh_3` concept. */ bool is_valid() const; -/*! +/*! Get iterator over first vertex of mesh. */ Vertex_iterator mesh_vertices_begin(); -/*! +/*! */ Vertex_const_iterator mesh_vertices_begin() const; -/*! +/*! Get iterator over past-the-end vertex of mesh. */ Vertex_iterator mesh_vertices_end(); -/*! +/*! */ Vertex_const_iterator mesh_vertices_end() const; -/*! +/*! Count the number of vertices of the mesh. */ int count_mesh_vertices() const; -/*! +/*! Index vertices of the mesh from 0 to `count_mesh_vertices`()-1. */ void index_mesh_vertices(); -/*! +/*! Get iterator over first vertex of mesh's main border. */ Border_vertex_iterator mesh_main_border_vertices_begin(); -/*! +/*! */ Border_vertex_const_iterator mesh_main_border_vertices_begin() const; -/*! +/*! Get iterator over past-the-end vertex of mesh's main border. */ Border_vertex_iterator mesh_main_border_vertices_end(); -/*! +/*! */ Border_vertex_const_iterator mesh_main_border_vertices_end() const; -/*! +/*! Return the border containing `seed_vertex`. Return an empty list if not found. */ std::list get_border(Vertex_handle seed_vertex); -/*! +/*! Get iterator over first facet of mesh. */ Facet_iterator mesh_facets_begin(); -/*! +/*! */ Facet_const_iterator mesh_facets_begin() const; -/*! +/*! Get iterator over past-the-end facet of mesh. */ Facet_iterator mesh_facets_end(); -/*! +/*! */ Facet_const_iterator mesh_facets_end() const; -/*! +/*! Count the number of facets of the mesh. */ int count_mesh_facets() const; -/*! +/*! Return true of all mesh's facets are triangles. */ bool is_mesh_triangular() const; -/*! +/*! Count the number of halfedges of the mesh. */ int count_mesh_halfedges() const; -/*! +/*! Get circulator over facet's vertices. */ Vertex_around_facet_circulator facet_vertices_begin(Facet_handle facet); -/*! +/*! */ Vertex_around_facet_const_circulator facet_vertices_begin(Facet_const_handle facet) const; -/*! +/*! Count the number of vertices of a facet. */ int count_facet_vertices(Facet_const_handle facet) const; -/*! +/*! Get the 3D position of a vertex. */ Point_3 get_vertex_position(Vertex_const_handle vertex) const; -/*! +/*! Get/set the 2D position (u/v pair) of a vertex. Default value is undefined. */ Point_2 get_vertex_uv(Vertex_const_handle vertex) const; -/*! +/*! */ void set_vertex_uv(Vertex_handle vertex, const Point_2& uv); -/*! +/*! Get/set is parameterized field of vertex. Default value is undefined. */ bool is_vertex_parameterized(Vertex_const_handle vertex) const; -/*! +/*! */ void set_vertex_parameterized(Vertex_handle vertex, bool parameterized); -/*! +/*! Get/set vertex index. Default value is undefined. */ int get_vertex_index(Vertex_const_handle vertex) const; -/*! +/*! */ void set_vertex_index(Vertex_handle vertex, int index); -/*! +/*! Get/set vertex' all purpose tag. Default value is undefined. */ int get_vertex_tag(Vertex_const_handle vertex) const; -/*! +/*! */ void set_vertex_tag(Vertex_handle vertex, int tag); -/*! +/*! Return true if a vertex belongs to ANY mesh's border. */ bool is_vertex_on_border(Vertex_const_handle vertex) const; -/*! +/*! Return true if a vertex belongs to the UNIQUE mesh's main border. */ bool is_vertex_on_main_border(Vertex_const_handle vertex) const; -/*! +/*! Get circulator over the vertices incident to `vertex`. `start_position` defines the optional initial position of the circulator. */ Vertex_around_vertex_circulator vertices_around_vertex_begin(Vertex_handle vertex, Vertex_handle start_position = Vertex_handle()); -/*! +/*! */ Vertex_around_vertex_const_circulator vertices_around_vertex_begin(Vertex_const_handle vertex, Vertex_const_handle start_position = Vertex_const_handle()) const; diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h index 7d312370eec..1b9dab2385e 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizationPatchableMesh_3.h @@ -36,70 +36,70 @@ public: /// \name Operations /// @{ -/*! +/*! %Get vertex seaming flag. Default value is undefined. */ int get_vertex_seaming(Vertex_const_handle vertex) const; -/*! +/*! Set vertex seaming flag. Default value is undefined. */ void set_vertex_seaming(Vertex_handle vertex, int seaming); -/*! +/*! %Get oriented edge's seaming flag, i.e.\ position of the oriented edge w.r.t.\ to the UNIQUE main border. */ int get_halfedge_seaming(Vertex_const_handle source, Vertex_const_handle target) const; -/*! +/*! Set oriented edge's seaming flag, i.e.\ position of the oriented edge w.r.t.\ to the UNIQUE main border. */ void set_halfedge_seaming(Vertex_handle source, Vertex_handle target, int seaming); -/*! +/*! %Get the 2D position (= (u, v) pair) of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ Point_2 get_corners_uv(Vertex_const_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex) const; -/*! +/*! Set the 2D position (= (u, v) pair) of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ void set_corners_uv(Vertex_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex, const Point_2& uv); -/*! +/*! %Get is parameterized field of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ bool are_corners_parameterized(Vertex_const_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex) const; -/*! +/*! Set is parameterized field of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ void set_corners_parameterized(Vertex_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex, bool parameterized); -/*! +/*! %Get index of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ int get_corners_index(Vertex_const_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex) const; -/*! +/*! Set index of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ void set_corners_index(Vertex_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex, int index); -/*! +/*! %Get all purpose tag of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ int get_corners_tag(Vertex_const_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex) const; -/*! +/*! Set all purpose tag of corners at the right of the `prev_vertex -> vertex -> next_vertex` line. Default value is undefined. */ void set_corners_tag(Vertex_handle vertex, Vertex_const_handle prev_vertex, Vertex_const_handle next_vertex, int tag); diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h index ee4fe2fb4d5..43e0cb9c336 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/ParameterizerTraits_3.h @@ -33,7 +33,7 @@ public: /// \name Types /// @{ -/*! +/*! Export the type of mesh to parameterize. @@ -63,7 +63,7 @@ typedef unspecified_type Adaptor; /// \name Operations /// @{ -/*! +/*! Compute a one-to-one mapping from a triangular 3D surface `mesh` to a piece of the 2D space. The mapping is linear by pieces (linear in each triangle). The result is the (u, v) pair image of each vertex of the 3D surface. diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h index d84d8e855b0..dd20e79f7f4 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/PolyhedronTraitsWithKernel_3.h @@ -29,7 +29,7 @@ public: /// \name Types /// @{ -/*! +/*! a kernel type providing: a field type `FT`; 2D and 3D point types `Point_2` and `Point_3`; 2D and 3D vector types `Vector_2` and `Vector_3`. */ diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h index 159385474f3..e8872f54e03 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/Concepts/SparseLinearAlgebraTraits_d.h @@ -22,17 +22,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type Matrix; -/*! +/*! */ typedef unspecified_type Vector; -/*! +/*! */ typedef unspecified_type NT; @@ -42,7 +42,7 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! Default constructor. @@ -54,7 +54,7 @@ SparseLinearAlgebraTraits_d(); /// \name Operations /// @{ -/*! +/*! Solve the sparse linear system A\f$ \times \f$ X = B. Return true on success. The solution is then (1/D) \f$ \times \f$ X. @@ -88,7 +88,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type NT; @@ -98,14 +98,14 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! Create a vector initialized with zeros. */ Vector(int rows); -/*! +/*! Copy constructor. @@ -117,14 +117,14 @@ Vector(const Vector& toCopy); /// \name Operations /// @{ -/*! +/*! Return the vector's number of coefficients. */ int dimension() const; -/*! +/*! Read/write access to a vector coefficient. \pre `0 <= row < dimension()`. @@ -132,7 +132,7 @@ Read/write access to a vector coefficient. */ NT operator[](int row) const; -/*! +/*! */ NT& operator[](int row); @@ -164,7 +164,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef unspecified_type NT; @@ -174,14 +174,14 @@ typedef unspecified_type NT; /// \name Creation /// @{ -/*! +/*! Create a square matrix initialized with zeros. */ Matrix(int dimension); -/*! +/*! Create a rectangular matrix initialized with zeros. @@ -193,21 +193,21 @@ Matrix(int rows, int columns); /// \name Operations /// @{ -/*! +/*! Return the matrix number of rows. */ int row_dimension() const; -/*! +/*! Return the matrix number of columns. */ int column_dimension() const; -/*! +/*! Read access to a matrix coefficient. @@ -217,7 +217,7 @@ Read access to a matrix coefficient. */ NT get_coef(int row, int column) const; -/*! +/*! Write access to a matrix coefficient: `a_ij = a_ij + val`. @@ -227,7 +227,7 @@ Write access to a matrix coefficient: `a_ij = a_ij + val`. */ void add_coef(int row, int column, NT value); -/*! +/*! Write access to a matrix coefficient: `a_ij = val`. diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h index d880dddc78e..db99a7ffa9c 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_matrix.h @@ -28,7 +28,7 @@ public: /// \name Types /// @{ -/*! +/*! The internal matrix type from \ref thirdpartyEigen "Eigen". */ typedef unspecified_type EigenType; @@ -67,7 +67,7 @@ public: /// \name Types /// @{ -/*! +/*! The internal matrix type from \ref thirdpartyEigen "Eigen". */ typedef unspecified_type EigenType; diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h index 676bbf82d28..a3d3f9212da 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_solver_traits.h @@ -48,17 +48,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef typename T::Scalar NT; -/*! +/*! */ typedef CGAL::Eigen_vector Vector; -/*! +/*! If `T` is `Eigen::ConjugateGradient` or `Eigen::SimplicialCholesky`, `Matrix` is `CGAL::Eigen_sparse_symmetric_matrix` and `CGAL::Eigen_sparse_matrix` otherwise. @@ -70,7 +70,7 @@ typedef unspecified_type Matrix; /// \name Operations /// @{ -/*! +/*! Returns a reference to the internal \ref thirdpartyEigen "Eigen" solver. This function can be used for example to set specific parameters of the solver. diff --git a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h index 5005fe5f1ee..9b5a0b24521 100644 --- a/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h +++ b/Surface_mesh_parameterization/doc/Surface_mesh_parameterization/include/CGAL/Eigen_vector.h @@ -27,7 +27,7 @@ public: /// \name Types /// @{ -/*! +/*! The internal vector type from \ref thirdpartyEigen "Eigen". */ typedef unspecified_type EigenType; diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h index 07dc27ccf10..87ba35060ec 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_ratio_stop_predicate.h @@ -23,7 +23,7 @@ public: /// \name Creation /// @{ -/*! +/*! Initializes the predicate establishing the `ratio`. */ Count_ratio_stop_predicate( double ratio ); @@ -33,7 +33,7 @@ Count_ratio_stop_predicate( double ratio ); /// \name Operations /// @{ -/*! +/*! Returns ` ( ((double)current_count / (double)initial_count) < ratio)`. All other parameters are ignored (but exist since this is a generic policy). */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h index 7af592c99c1..05d025a069e 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Count_stop_predicate.h @@ -22,7 +22,7 @@ public: /// \name Creation /// @{ -/*! +/*! Initializes the predicate establishing the `threshold` value. */ Count_stop_predicate( size_type threshold ); @@ -32,7 +32,7 @@ Count_stop_predicate( size_type threshold ); /// \name Operations /// @{ -/*! +/*! Returns `(current_count < threshold)`. All other parameters are ignored (but exist since this is a generic policy). */ bool operator()( FT const& current_cost diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h index e09bb107e21..281512ae1a0 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Edge_length_cost.h @@ -21,7 +21,7 @@ public: /// \name Creation /// @{ -/*! +/*! Default constructor */ Edge_length_cost(); @@ -31,7 +31,7 @@ Edge_length_cost(); /// \name Operations /// @{ -/*! +/*! Returns the collapse cost as the squared distance between the points of the source and target vertices (that is, `profile.p0()` and `profile.p1()`. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h index f50b8ee34c7..fe1a4125ceb 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_cost.h @@ -22,7 +22,7 @@ public: /// \name Creation /// @{ -/*! +/*! Initializes the policy with the given weighting unit factor. See \ref SurfaceMeshSimplificationLindstromTurkStrategy for details on the meaning of this factor. */ @@ -33,7 +33,7 @@ LindstromTurk_cost( FT const& factor = FT(0.5) ); /// \name Operations /// @{ -/*! +/*! Returns the cost of collapsing the edge (represented by its profile) considering the new `placement` computed for it. */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h index cf1c6d7a4b4..47ef963a781 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/LindstromTurk_placement.h @@ -24,7 +24,7 @@ public: /// \name Creation /// @{ -/*! +/*! Initializes the policy with the given weighting unit factor. See \ref SurfaceMeshSimplificationLindstromTurkStrategy for details on the meaning of this factor. */ @@ -35,7 +35,7 @@ LindstromTurk_placement( FT const& factor = FT(0.5) ); /// \name Operations /// @{ -/*! +/*! Returns the new position for the remaining vertex after collapsing the edge (represented by its profile). */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h index 50e63a8c4f4..8a4755da053 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/CGAL/Surface_mesh_simplification/Policies/Edge_collapse/Midpoint_placement.h @@ -20,7 +20,7 @@ public: /// \name Creation /// @{ -/*! +/*! Default constructor */ Midpoint_placement(); @@ -30,7 +30,7 @@ Midpoint_placement(); /// \name Operations /// @{ -/*! +/*! Returns the placement (vertex position) as the midpoint between the points of the source and target vertices (`profile.p0()` and `profile.p1()`) 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 cf15e8cb92f..d9c0e9297ca 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapsableMesh.h @@ -81,7 +81,7 @@ class EdgeCollapsableMesh { public: }; /* end EdgeCollapsableMesh */ -/*! +/*! Collapses the undirected edge `(v0v1,v1v0)` replacing it with `v0` or `v1`, as described in the following paragraph. \pre This function requires `mesh` to be an oriented 2-manifold with or without boundaries. Furthermore, the undirected edge `(v0v1,v1v0)` must satisfy the link condition \cite degn-tpec-98, which guarantees that the surface is also 2-manifold after the edge collapse. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h index 402501e87f6..27152586623 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeCollapseSimplificationVisitor.h @@ -15,27 +15,27 @@ public: /// \name Types /// @{ -/*! +/*! The type of the surface to simplify. Must be a model of the `EdgeCollapsableMesh` concept. */ typedef unspecified_type ECM; -/*! +/*! A field type representing the collapse cost */ typedef unspecified_type FT; -/*! +/*! The type of the edge profile cache. Must be a model of the `EdgeProfile` concept. */ typedef unspecified_type Profile; -/*! +/*! The point type for the surface vertex. Must be a model of `Point_3`. */ typename CGAL::halfedge_graph_traits::Point Point; -/*! +/*! An integer type representing the number of edges */ typedef unspecified_type size_type; @@ -45,31 +45,31 @@ typedef unspecified_type size_type; /// \name Operations /// @{ -/*! +/*! Called before the algorithm starts. */ void OnStarted( ECM& surface ); -/*! +/*! Called after the algorithm finishes. */ void OnFinished ( ECM& surface ) ; -/*! +/*! Called when the `StopPredicate` returned `true` (but not if the algorithm terminates because the surface could not be simplified any further). */ void OnStopConditionReached( ECM& surface ) ; -/*! +/*! Called during the collecting phase (when a cost is assigned to the edges), for each edge collected. */ void OnCollected( Profile const& profile, boost::optional cost ); -/*! +/*! Called during the processing phase (when edges are collapsed), for each edge that is selected. @@ -90,7 +90,7 @@ void OnSelected( Profile const& profile , size_type current_count ); -/*! +/*! Called when an edge is about to be collapsed and replaced by a vertex whose position is `*placement`. @@ -102,7 +102,7 @@ void OnCollapsing( Profile const& profile , boost::optional placement ); -/*! +/*! Called for each selected edge which cannot be collapsed because doing so would change the topological type of the surface (turn it into a non-manifold diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h index 6582c952cf7..694d5fa87e4 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/EdgeProfile.h @@ -17,22 +17,22 @@ public: /// \name Types /// @{ -/*! +/*! The type of the surface to simplify. Must be a model of the `EdgeCollapsableMesh` concept. */ typedef unspecified_type ECM; -/*! +/*! A Bgl vertex descriptor representing a vertex of the surface. */ typename boost::graph_traits::vertex_descriptor vertex_descriptor; -/*! +/*! A Bgl edge descriptor representing an edge of the surface. */ typename boost::graph_traits::edge_descriptor edge_descriptor; -/*! +/*! The point type for the surface vertex. Must be a model of `Point_3`. */ typename CGAL::halfedge_graph_traits::Point Point; @@ -42,92 +42,92 @@ typename CGAL::halfedge_graph_traits::Point Point; /// \name Access Functions /// @{ -/*! +/*! One of vertices of the edge to be collapsed. */ vertex_descriptor v0() const; -/*! +/*! The other vertex of the edge to be collapsed. */ vertex_descriptor v1() const; -/*! +/*! One of the directed edges corresponding to the undirected edge being collapsed. */ edge_descriptor v0_v1() const; -/*! +/*! The other directed edge corresponding to the undirected edge being collapsed. */ edge_descriptor v1_v0() const; -/*! +/*! The point of vertex ` v0`. */ Point const& p0() const; -/*! +/*! The point of vertex ` v1`. */ Point const& p1() const; -/*! +/*! If ` v0v1` belongs to a finite face (is not a border edge) the third vertex of that triangular face, a null descriptor otherwise. */ vertex_descriptor vL() const; -/*! +/*! If ` v0v1` belongs to a finite face (is not a border edge) the directed edge from ` v1` to ` vL`, a null descriptor otherwise. */ edge_descriptor v1_vL() const; -/*! +/*! If ` v0v1` belongs to a finite face (is not a border edge) the directed edge from ` vL` to ` v0`, a null descriptor otherwise. */ edge_descriptor vL_v0() const; -/*! +/*! If ` v1v0` belongs to a finite face (is not a border edge) the third vertex of that triangular face, a null descriptor otherwise. */ vertex_descriptor vR() const; -/*! +/*! If ` v1v0` belongs to a finite face (is not a border edge) the directed edge from ` v0` to ` vR`, a null descriptor otherwise. */ edge_descriptor v0_vR() const; -/*! +/*! If ` v1v0` belongs to a finite face (is not a border edge) the directed edge from ` vR` to ` v1`, a null descriptor otherwise. */ edge_descriptor vR_v1() const; -/*! +/*! The unique sequence of the vertices around ` v0v1` in topological order (ccw or ccw depending on the relative ordering of `v0` and `v1` in the profile). */ std::vector link() const; -/*! +/*! The unique collection of the border directed edges incident upon ` v0` and ` v1`. */ std::vector border_edges() const; -/*! +/*! Indicates if `v0v1` belongs to a finite face of the mesh (i.e, `v0v1` is not a border edge). */ bool left_face_exits() const; -/*! +/*! Indicates if `v0v1` belongs to a finite face of the mesh (i.e, `v1v0` is not a border edge). */ bool right_face_exits() const; diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h index 037544a6520..73594c048a3 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetCost.h @@ -25,22 +25,22 @@ public: /// \name Types /// @{ -/*! +/*! The type of the edge profile cache. Must be a model of the `EdgeProfile` concept. */ typedef unspecified_type Profile; -/*! +/*! A field type representing the collapse cost */ typedef unspecified_type FT; -/*! +/*! The point type for the surface vertex. Must be a model of `Point_3`. */ typename CGAL::halfedge_graph_traits::Point Point; -/*! +/*! The type of the result (an optional cost value). */ boost::optional result_type; @@ -50,7 +50,7 @@ boost::optional result_type; /// \name Operations /// @{ -/*! +/*! Computes and returns the cost of collapsing the edge (represented by its profile), using the calculated placement. diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h index f687ee2d54a..ceffc30914e 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/GetPlacement.h @@ -26,17 +26,17 @@ public: /// \name Types /// @{ -/*! +/*! The type of the edge profile cache. Must be a model of the `EdgeProfile` concept. */ typedef unspecified_type Profile; -/*! +/*! The point type for the surface vertex. Must be a model of `Point_3`. */ typename CGAL::halfedge_graph_traits::Point Point; -/*! +/*! The type of the result (an optional point). */ boost::optional result_type; @@ -46,7 +46,7 @@ boost::optional result_type; /// \name Operations /// @{ -/*! +/*! Computes and returns the placement, that is, the position of the vertex which replaces the collapsing edge (represented by its profile). */ diff --git a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h index f7b699571d5..1f88bea3e2d 100644 --- a/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h +++ b/Surface_mesh_simplification/doc/Surface_mesh_simplification/Concepts/StopPredicate.h @@ -16,22 +16,22 @@ public: /// \name Types /// @{ -/*! +/*! The type of the surface to simplify. Must be a model of the `EdgeCollapsableMesh` concept. */ typedef unspecified_type ECM; -/*! +/*! A field type representing the collapse cost */ typedef unspecified_type FT; -/*! +/*! An integer type representing the number of edges */ typedef unspecified_type size_type; -/*! +/*! The type of the edge profile cache. Must be a model of the `EdgeProfile` concept. */ typedef unspecified_type Profile; @@ -41,7 +41,7 @@ typedef unspecified_type Profile; /// \name Operations /// @{ -/*! +/*! This predicate is called each time an edge is selected for processing, before it is collapsed. diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h index b7a32846e70..88b612730c9 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Gray_level_image_3.h @@ -41,12 +41,12 @@ public: /// \name Types /// @{ -/*! +/*! the numerical type `FT`. */ typedef FT_ FT; -/*! +/*! the point type. */ typedef Point_ Point; @@ -57,7 +57,7 @@ typedef Point_ Point; /// \name Creation /// @{ -/*! +/*! `filename` is the path to a file of a type supported by ImageIO. `iso_value` is an isovalue of the interpolation function \f$ f\f$. diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h index 1461eb83080..a78f31fc639 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Implicit_surface_3.h @@ -42,7 +42,7 @@ public: /// \name Creation /// @{ -/*! +/*! `f` is the object of type `Function` that represents the implicit surface. diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h index 7f700caf8f5..bed47295882 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_default_criteria_3.h @@ -39,7 +39,7 @@ public: /// \name Types /// @{ -/*! +/*! The numerical type. */ typedef Tr::FT FT; @@ -49,7 +49,7 @@ typedef Tr::FT FT; /// \name Creation /// @{ -/*! +/*! Returns a `Surface_mesh_default_criteria_3` with `angle_bound`, `radius_bound`, `distance_bound` as bounds for the minimum facet angle in degrees, the radius of the surface Delaunay balls diff --git a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_traits_generator_3.h b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_traits_generator_3.h index 7a5fdc309c3..5d60698b26d 100644 --- a/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_traits_generator_3.h +++ b/Surface_mesher/doc/Surface_mesher/CGAL/Surface_mesh_traits_generator_3.h @@ -32,7 +32,7 @@ template< typename Surface > class Surface_mesh_traits_generator_3 { public: -/*! +/*! A model of the concept `SurfaceMeshTraits_3`. */ typedef unspecified_type Type; diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h index 052cfe86ef1..1df71a27491 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitFunction.h @@ -21,12 +21,12 @@ public: /// \name Types /// @{ -/*! +/*! Number type */ typedef unspecified_type FT; -/*! +/*! Point type */ typedef unspecified_type Point; @@ -36,7 +36,7 @@ typedef unspecified_type Point; /// \name Operations /// @{ -/*! +/*! Returns the value \f$ f(p)\f$, where \f$ p \in\mathbb{R}^3\f$. */ FT operator()(Point p); diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h index c8a5e2f463b..063b8db188e 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/ImplicitSurfaceTraits_3.h @@ -28,44 +28,44 @@ public: /// \name Types /// @{ -/*! +/*! The numerical type. It must be model of `FieldWithSqrt` and constructible from a `double`. */ typedef unspecified_type FT; -/*! +/*! The point type. This point type must have a constructor `Point_3(FT, FT, FT)`. */ typedef unspecified_type Point_3; -/*! +/*! The line type. */ typedef unspecified_type Line_3; -/*! +/*! The ray type. */ typedef unspecified_type Ray_3; -/*! +/*! The segment type. */ typedef unspecified_type Segment_3; -/*! +/*! The vector type. */ typedef unspecified_type Vector_3; -/*! +/*! The sphere type. */ typedef unspecified_type Sphere_3; -/*! +/*! A function object providing the operator `FT operator()(Vector_3 v, Vector_3 w)` which returns the scalar @@ -73,7 +73,7 @@ A function object providing the operator */ typedef unspecified_type Compute_scalar_product_3; -/*! +/*! A function object providing the operator `FT operator()(Point_3, Point_3)` which returns the squared distance @@ -81,7 +81,7 @@ between two points. */ typedef unspecified_type Compute_squared_distance_3; -/*! +/*! A function object providing the operator `FT operator()(const Sphere_3& s)` which returns the squared radius @@ -89,7 +89,7 @@ of `s`. */ typedef unspecified_type Compute_squared_radius_3; -/*! +/*! A function object providing the operator `Point_3 operator()(const Sphere_3& s)` which computes the center of @@ -97,7 +97,7 @@ the sphere `s`. */ typedef unspecified_type Construct_center_3; -/*! +/*! A function object providing the operator `Point_3 operator()(const Point_3& p, const Point_3& q)` which computes @@ -105,7 +105,7 @@ the midpoint of the segment `pq`. */ typedef unspecified_type Construct_midpoint_3; -/*! +/*! A function object providing the following operators: `Point_3 operator()(const Line_3& l,int i)` which returns an @@ -126,7 +126,7 @@ point. */ typedef unspecified_type Construct_point_on_3; -/*! +/*! A function object providing the operator `Segment_3 operator()(const Point_3 &p, const Point_3 &q)` which @@ -135,7 +135,7 @@ source towards the target. */ typedef unspecified_type Construct_segment_3; -/*! +/*! A function object providing the operator `Vector_3 operator()(const Vector_3 &v, const FT& scale)` which returns @@ -143,7 +143,7 @@ the vector `v` scaled by a factor `scale`. */ typedef unspecified_type Construct_scaled_vector_3; -/*! +/*! A function object providing the operator `Point_3 operator()(const Point_3& p, const Vector_3& v)` which returns @@ -151,7 +151,7 @@ the point obtained by translating `p` by the vector `v`. */ typedef unspecified_type Construct_translated_point_3; -/*! +/*! A function object providing the operator `Vector_3 operator()(const Point_3 &a, const Point_3 &b)` which returns @@ -159,7 +159,7 @@ the vector `b-a`. */ typedef unspecified_type Construct_vector_3; -/*! +/*! A function object providing the operator `bool operator()(const Sphere_3&s, const Point_3&p)` which @@ -174,57 +174,57 @@ typedef unspecified_type Has_on_bounded_side_3; /// construction objects: /// @{ -/*! +/*! */ Compute_scalar_product_3 compute_scalar_product_3_object(); -/*! +/*! */ Compute_squared_distance_3 compute_squared_distance_3_object(); -/*! +/*! */ Compute_squared_radius_3 compute_squared_radius_3_object(); -/*! +/*! */ Construct_center_3 construct_center_3_object(); -/*! +/*! */ Construct_midpoint_3 construct_midpoint_3_object(); -/*! +/*! */ Construct_point_on_3 construct_point_on_3_object(); -/*! +/*! */ Construct_scaled_vector_3 construct_scaled_vector_3_object(); -/*! +/*! */ Construct_segment_3 construct_segment_3_object(); -/*! +/*! */ Construct_translated_point_3 construct_translated_point_3_object(); -/*! +/*! */ Construct_vector_3 construct_vector_3_object(); -/*! +/*! */ Has_on_bounded_side_3 has_on_bounded_side_3_object(); diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h index 23b5884b440..3b3335ab1a8 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshCellBase_3.h @@ -53,7 +53,7 @@ public: /// \name Types /// @{ -/*! +/*! The point type, required to match the point type of the three dimensional triangulation in which the surface mesh is embedded. @@ -65,35 +65,35 @@ typedef unspecified_type Point; /// \name Operations /// @{ -/*! +/*! returns `true`, if `facet(i)` is in the 2D complex. */ bool is_facet_on_surface(int i); -/*! +/*! Sets `facet(i)` as part of the 2D complex, if `b` is `true`, and `NOT_IN_COMPLEX`, otherwise. */ void set_facet_on_surface(int i, bool b ); -/*! +/*! Returns `true`, if `facet(i)` has been visited, `false` otherwise. */ bool is_facet_visited (int i); -/*! +/*! Marks `facet(i)` as visited, if `b` is `true`, and non visited otherwise. */ void set_facet_visited (int i, bool b); -/*! +/*! Returns a const reference to the surface center of `facet(i)`. */ const Point& get_facet_surface_center(int i); -/*! +/*! Sets point `p` as the surface center of `facet(i)`. */ void set_facet_surface_center (int i, Point p); diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h index 9a3df79f74c..bed3647997a 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshComplex_2InTriangulation_3.h @@ -43,44 +43,44 @@ public: /// `SurfaceMeshComplex_2InTriangulation_3` provides the following types. /// @{ -/*! +/*! The type of the embedding 3D triangulation. Must be a model of `SurfaceMeshTriangulation_3`. */ typedef unspecified_type Triangulation; -/*! +/*! The type of the embedding triangulation vertex handles. */ typedef Triangulation::Vertex_handle Vertex_handle; -/*! +/*! The type of the embedding triangulation cell handles. */ typedef Triangulation::Cell_handle Cell_handle; -/*! +/*! The type of the embedding triangulation facets. */ typedef Triangulation::Facet Facet; -/*! +/*! The type of the embedding triangulation edges. */ typedef Triangulation::Edge Edge; -/*! +/*! Size type (an unsigned integral type) */ typedef Triangulation::size_type size_type; -/*! +/*! A type to describe the status of a face (facet, edge, or vertex) with respect to the 2D pure complex. A `NOT_IN_COMPLEX` face does not belong to the 2D complex. Facets can only be `NOT_IN_COMPLEX` or `REGULAR` @@ -103,25 +103,25 @@ and `SINGULAR` in any other case. enum Face_status {NOT_IN_COMPLEX, BOUNDARY, REGULAR, SINGULAR}; -/*! +/*! An iterator type to visit the facets of the 2D complex. */ typedef unspecified_type Facet_iterator; -/*! +/*! An iterator type to visit the edges of the 2D complex. */ typedef unspecified_type Edge_iterator; -/*! +/*! An iterator type to visit vertices of the 2D complex. */ typedef unspecified_type Vertex_iterator; -/*! +/*! An iterator type to visit the boundary edges of the 2D complex. */ @@ -132,12 +132,12 @@ typedef unspecified_type Boundary_edges_iterator; /// \name Creation /// @{ -/*! +/*! Builds an empty 2D complex embedded in the triangulation `t3` */ SurfaceMeshComplex_2InTriangulation_3(Triangulation& t3); -/*! +/*! Builds a 2D complex embedded in the triangulation `t3`, including in the 2D complex the facets of `t3` for which the predicate `select` returns `true`. @@ -155,7 +155,7 @@ FacetSelector select); /// \name Member access /// @{ -/*! +/*! Returns the reference to the triangulation. */ Triangulation& triangulation(); @@ -165,22 +165,22 @@ Triangulation& triangulation(); /// \name Modifications /// @{ -/*! +/*! Adds facet `f` to the 2D complex. */ void add_to_complex(Facet f); -/*! +/*! Adds facet `(c,i)` to the 2D complex. */ void add_to_complex(Cell_handle c, int i); -/*! +/*! Removes facet `f` from the 2D complex. */ void remove_from_complex(Facet f); -/*! +/*! Removes facet `(c,i)` from the 2D complex. */ void remove_from_complex(Cell_handle c, int i); @@ -191,63 +191,63 @@ void remove_from_complex(Cell_handle c, int i); /// Queries on the status of individual face with respect to the 2D complex. /// @{ -/*! +/*! Returns the number of facets that belong to the 2D complex. */ size_type number_of_facets() const; -/*! +/*! Returns the status of the facet `f` with respect to the 2D complex. */ Face_status face_status(Facet f); -/*! +/*! Returns the status of the facet `(c,i)` with respect to the 2D complex. */ Face_status face_status(Cell_handle c, int i); -/*! +/*! Returns the status of edge `e` in the 2D complex. */ Face_status face_status(Edge e); -/*! +/*! Returns the status of edge `(c,i,j)` in the 2D complex. */ Face_status face_status(Cell_handle c, int i, int j); -/*! +/*! Returns the status of vertex `v` in the 2D complex. */ Face_status face_status(Vertex_handle v); -/*! +/*! Returns `true`, if the facet `f` belongs to the 2D complex. */ bool is_in_complex(Facet f); -/*! +/*! Returns `true`, if the facet `(c,i)` belongs to the 2D complex. */ bool is_in_complex(Cell_handle c, int i); -/*! +/*! Returns `true`, if the edge `e` belongs to the 2D complex. */ bool is_in_complex(Edge e); -/*! +/*! Returns `true`, if the edge `(c,i,j)` belongs to the 2D complex. */ bool is_in_complex(Cell_handle c, int i, int j); -/*! +/*! Returns `true`, if the vertex `v` belongs to the 2D complex. */ bool is_in_complex(Vertex_handle v); -/*! +/*! Returns true if the status of vertex `v` is `REGULAR` or `BOUNDARY`. \pre All the edges of the complex incident to `v` are `REGULAR` or `BOUNDARY`. */ @@ -261,51 +261,51 @@ bool is_regular_or_boundary_for_vertices (Vertex_handle v); /// and non mutable. /// @{ -/*! +/*! Returns an iterator with value type `Facet` to visit the facets of the 2D complex. */ Facet_iterator facets_begin(); -/*! +/*! Returns the past the end iterator for the above iterator. */ Facet_iterator facets_end(); -/*! +/*! Returns an iterator with value type `Edge` to visit the edges of the 2D complex which are not isolated. */ Edge_iterator edges_begin(); -/*! +/*! Returns the past the end iterator for the above iterator. */ Edge_iterator edges_end(); -/*! +/*! Returns an iterator with value type `Edge` to visit the boundary edges of the complex. */ Boundary_edges_iterator boundary_edges_begin(); -/*! +/*! Returns the past the end iterator for the above iterator. */ Boundary_edges_iterator boundary_edges_end(); -/*! +/*! Returns an iterator with value type `Vertex_handle` to visit the vertices of the 2D complex. */ Vertex_iterator vertices_begin(); -/*! +/*! Returns the past the end iterator for the above iterator. */ Vertex_iterator vertices_end(); -/*! +/*! Copies the facets of the complex incident to `v` to the output iterator `facets`. Returns the resulting output iterator. @@ -321,7 +321,7 @@ incident_facets(Vertex_handle v, OutputIterator facets); /// The following function is the basic function to walk on the 2D complex /// @{ -/*! +/*! Returns the facet of the complex which is the neighbor of the facet `f` opposite to the vertex with index `j` of `f`. @@ -334,7 +334,7 @@ If there is no such neighbor, or if the edge is singular the functions returns ` */ Facet neighbor(Facet f, int j); -/*! +/*! Returns the facet of the complex which is the neighbor of the facet `f` opposite to the vertex with index `j` of `f`. See above. diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h index 8a2fc4a2ecf..067603a9923 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshFacetsCriteria_3.h @@ -45,7 +45,7 @@ public: /// \name Types /// @{ -/*! +/*! The type of facets. This type has to match the `Facet` type in the triangulation type used by the mesher function. (This triangulation type @@ -57,7 +57,7 @@ as first template parameter of */ typedef unspecified_type Facet; -/*! +/*! Default constructible, copy constructible, assignable, and less-than comparable type. */ @@ -68,7 +68,7 @@ typedef unspecified_type Quality; /// \name Operations /// @{ -/*! +/*! Assigns the quality of the facet `f` to `q`, and returns `true` is `f` does not meet the criteria. diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h index bda4afe81ea..5e331f2f850 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTraits_3.h @@ -23,7 +23,7 @@ public: /// \name Types /// @{ -/*! +/*! The type of points. This type is required to match the point type of the @@ -32,27 +32,27 @@ three dimensional embedding triangulation */ typedef unspecified_type Point_3; -/*! +/*! The type of segments. */ typedef unspecified_type Segment_3; -/*! +/*! The type of rays. */ typedef unspecified_type Ray_3; -/*! +/*! The type of lines. */ typedef unspecified_type Line_3; -/*! +/*! The surface type. */ typedef unspecified_type Surface_3; -/*! +/*! A model of this type provides the operator `CGAL::Object operator()(Surface_3 surface, Type1 type1)` @@ -63,7 +63,7 @@ with an object of type `Type1` which may be */ typedef unspecified_type Intersect_3; -/*! +/*! A model of this type provides the following operators to construct initial points on the surface: @@ -87,12 +87,12 @@ typedef unspecified_type Construct_initial_points; /// The following functions give access to the construction objects: /// @{ -/*! +/*! */ Intersect_3 intersect_3_object(); -/*! +/*! */ Construct_initial_points construct_initial_points_object(); diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h index a1f91049328..b489a09d628 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshTriangulation_3.h @@ -37,52 +37,52 @@ public: /// visit all finite vertices, edges and facets of the triangulation. /// @{ -/*! +/*! The point type. It must be DefaultConstructible, CopyConstructible and Assignable. */ typedef unspecified_type Point; -/*! +/*! Handle to a data representing a vertex. `Vertex_handle` must be a model of `Handle` and its value type must be model of `TriangulationDataStructure_3::Vertex`. */ typedef unspecified_type Vertex_handle; -/*! +/*! Handle to a data representing a cell. `Cell_handle` must be a model of `Handle` and its value type must be model of `TriangulationDataStructure_3::Cell`. */ typedef unspecified_type Cell_handle; -/*! +/*! The edge type. */ typedef CGAL::Triple Edge; -/*! +/*! The facet type. */ typedef std::pair Facet; -/*! +/*! Iterator over finite vertices */ typedef unspecified_type Finite_vertices_iterator; -/*! +/*! Iterator over finite edges */ typedef unspecified_type Finite_edges_iterator; -/*! +/*! Iterator over finite facets */ typedef unspecified_type Finite_facets_iterator; -/*! +/*! The geometric traits class. Must be a model of `DelaunayTriangulationTraits_3`. */ @@ -93,12 +93,12 @@ typedef unspecified_type Geom_traits; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ SurfaceMeshTriangulation_3(); -/*! +/*! Copy constructor. All vertices and faces are duplicated. */ SurfaceMeshTriangulation_3(SurfaceMeshTriangulation_3 tr); @@ -108,7 +108,7 @@ SurfaceMeshTriangulation_3(SurfaceMeshTriangulation_3 tr); /// \name Assignment /// @{ -/*! +/*! The triangulation `tr` is duplicated, and modifying the copy after the duplication does not modify the original. The previous triangulation held by `t` is deleted. @@ -116,7 +116,7 @@ by `t` is deleted. SurfaceMeshTriangulation_3 & operator=(const SurfaceMeshTriangulation_3 & tr); -/*! +/*! Deletes all finite vertices and all cells of `t`. */ void clear(); @@ -126,12 +126,12 @@ void clear(); /// \name Access Functions /// @{ -/*! +/*! Returns the dimension of the affine hull. */ int dimension() const; -/*! +/*! Returns a const reference to a model of `DelaunayTriangulationTraits_3`. */ @@ -142,7 +142,7 @@ const DelaunayTriangulationTraits_3 & geom_traits() const; /// \name Voronoi diagram /// @{ -/*! +/*! Returns the dual of facet `f`. In dimension 3: either a segment, if the two cells incident to `f` @@ -163,7 +163,7 @@ Object dual(Facet f) const; /// hole. /// @{ -/*! +/*! Computes the conflict hole induced by `p`. The starting cell (resp.\ facet) `c` must be in conflict. @@ -198,37 +198,37 @@ OutputIteratorInternalFacets ifit); /// edges and vertices of the triangulation. /// @{ -/*! +/*! Starts at an arbitrary finite vertex. */ Finite_vertices_iterator finite_vertices_begin() const; -/*! +/*! Past-the-end iterator */ Finite_vertices_iterator finite_vertices_end() const; -/*! +/*! Starts at an arbitrary finite edge. */ Finite_edges_iterator finite_edges_begin() const; -/*! +/*! Past-the-end iterator */ Finite_edges_iterator finite_edges_end() const; -/*! +/*! Starts at an arbitrary finite facet. */ Finite_facets_iterator finite_facets_begin() const; -/*! +/*! Past-the-end iterator */ Finite_facets_iterator finite_facets_end() const; -/*! +/*! Copies the `Cell_handle`s of all cells incident to `v` to the output iterator `cells`. If `t.dimension() < 3`, then do nothing. Returns the resulting output iterator. @@ -238,7 +238,7 @@ template OutputIterator incident_cells(Vertex_handle v, OutputIterator cells) const; -/*! +/*! Copies the `Cell_handle`s of all cells incident to `v` to the output iterator `cells`. If `t.dimension() < 3`, then do nothing. Returns the resulting output iterator. @@ -247,14 +247,14 @@ template OutputIterator incident_cells(Vertex_handle v, OutputIterator cells) const; -/*! +/*! Tests whether `p` is a vertex of `t` by locating `p` in the triangulation. If `p` is found, the associated vertex `v` is given. */ bool is_vertex(const Point & p, Vertex_handle & v) const; -/*! +/*! Tests whether `(u,v)` is an edge of `t`. If the edge is found, it gives a cell `c` having this edge and the indices `i` and `j` of the vertices `u` and `v` in `c`, in this order. @@ -263,23 +263,23 @@ and `j` of the vertices `u` and `v` in `c`, in this order. bool is_edge(Vertex_handle u, Vertex_handle v, Cell_handle & c, int & i, int & j) const; -/*! +/*! Returns `true`, iff vertex `v` is the infinite vertex. */ bool is_infinite(const Vertex_handle v) const; -/*! +/*! Returns `true`, iff `c` is incident to the infinite vertex. \pre `t.dimension() == 3`. */ bool is_infinite(const Cell_handle c) const; -/*! +/*! Returns the same facet seen from the other adjacent cell. */ Facet mirror_facet(Facet f) const; -/*! +/*! Return the indexes of the `j`th vertex of the facet of a cell opposite to vertex `i`. */ @@ -290,7 +290,7 @@ int vertex_triple_index(const int i, const int j); /// \name Point location /// @{ -/*! +/*! If the point `query` lies inside the convex hull of the points, the cell that contains the query in its interior is returned. If `query` lies on a @@ -313,7 +313,7 @@ The optional argument `start` is used as a starting place for the search. Cell_handle locate(const Point & query, Cell_handle start = Cell_handle()) const; -/*! +/*! If `query` lies inside the affine hull of the points, the `k`-face (finite or infinite) that contains `query` in its interior is returned, by means of the cell returned together with `lt`, which @@ -340,7 +340,7 @@ Cell_handle locate(const Point & query, Locate_type & lt, int & li, int & lj, Cell_handle start = Cell_handle() ) const; -/*! +/*! Creates a new vertex by starring a hole. It takes an iterator range `[cell_begin, cell_end)` of `Cell_handle`s which specifies a hole: a set of connected cells (resp. facets in dimension 2) which is diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h index 255300c47ea..616ec952d26 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/SurfaceMeshVertexBase_3.h @@ -46,22 +46,22 @@ public: /// \name Operations /// @{ -/*! +/*! Returns `true` if the cache is valid. */ bool is_c2t3_cache_valid(); -/*! +/*! Invalidates the cache. */ void invalidate_c2t3_cache(); -/*! +/*! Returns the cached number of facets of the complex incident to the vertex. */ int cached_number_of_incident_facets(); -/*! +/*! This method concerns the adjacency graph of the facets of the complex incident to the vertex and returns a cached value for the number of connected components this graph. diff --git a/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h b/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h index be2bf2c3c8d..bcc2e59de1d 100644 --- a/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h +++ b/Surface_mesher/doc/Surface_mesher/Concepts/Surface_3.h @@ -26,7 +26,7 @@ public: /// `CGAL::Surface_mesh_traits_generator_3` exists. /// @{ -/*! +/*! a model of `SurfaceMesherTraits_3` */ typedef unspecified_type Surface_mesher_traits_3; 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 375ac754126..e11ea0a7c95 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 @@ -57,12 +57,12 @@ public: /// \cgalAdvancedEnd /// @{ -/*! +/*! Vertex container type. */ typedef Compact_container Vertex_range; -/*! +/*! Face container type. */ typedef Compact_container Face_range; @@ -76,22 +76,22 @@ typedef Compact_container Face_range; /// \cgalAdvancedEnd /// @{ -/*! +/*! Returns a reference to the container of faces. */ Face_range & faces() const; -/*! +/*! Returns a reference to the container of faces. */ Face_range & faces(); -/*! +/*! Returns a reference to the container of vertices. */ Vertex_range & vertices() const; -/*! +/*! Returns a reference to the container of vertices. */ Vertex_range & vertices(); @@ -101,7 +101,7 @@ Vertex_range & vertices(); /// \name Modifiers /// @{ -/*! +/*! Joins the vertices that are endpoints of the edge `(f,i)`, and returns a vertex handle to common vertex (see @@ -110,28 +110,28 @@ Fig.\ \ref figtdssplitjoin). */ Vertex_handle join_vertices(Face_handle f, int i); -/*! +/*! Joins the vertices that are endpoints of the edge `e`, and returns a vertex handle to common vertex. */ Vertex_handle join_vertices(Edge e); -/*! +/*! Joins the vertices that are endpoints of the edge `*eit`, and returns a vertex handle to common vertex. */ Vertex_handle join_vertices(Edge_iterator eit); -/*! +/*! Joins the vertices that are endpoints of the edge `*ec`, and returns a vertex handle to common vertex. */ Vertex_handle join_vertices(Edges_circulator ec); -/*! +/*! Splits the vertex `v` into two vertices `v1` and `v2`. The common faces `f` and `g` of `v1` and `v2` are created after (in the counter-clockwise sense) the @@ -144,7 +144,7 @@ Face_handle> split_vertex(Vertex_handle v, Face_handle f1, Face_handle f2); -/*! +/*! Inserts a degree two vertex and two faces adjacent to it that have two common edges. The edge defined by the face handle `f` and the integer @@ -153,7 +153,7 @@ edges. The edge defined by the face handle `f` and the integer */ Vertex_handle insert_degree_2(Face_handle f, int i); -/*! +/*! Removes a degree 2 vertex and the two faces adjacent to it. The two edges of the star of `v` that are not incident to it are collapsed diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h index 702fc1d7220..7c87442928a 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSFaceBase_2.h @@ -67,7 +67,7 @@ public: /// following types. /// @{ -/*! +/*! This template class has to define a type `Rebind_TDS::%Other` which is the rebound face base, where the `CGAL::Triangulation_data_structure_2` is actually plugged in. @@ -78,17 +78,17 @@ of the class `CGAL::Triangulation_data_structure_2::Face`. template using Rebind_TDS = unspecified_type; -/*! +/*! */ typedef TriangulationDataStructure_2 Triangulation_data_structure; -/*! +/*! */ typedef TriangulationDataStructure_2::Vertex_handle Vertex_handle; -/*! +/*! */ typedef TriangulationDataStructure_2::Face_handle Face_handle; @@ -98,12 +98,12 @@ typedef TriangulationDataStructure_2::Face_handle Face_handle; /// \name Creation /// @{ -/*! +/*! default constructor. */ TriangulationDSFaceBase_2(); -/*! +/*! Initializes the vertices with `v0, v1, v2` and the neighbors with `Face_handle()`. */ @@ -111,7 +111,7 @@ TriangulationDSFaceBase_2(Vertex_handle v0, Vertex_handle v1, Vertex_handle v2); -/*! +/*! initializes the vertices with `v0,v1, v2` and the neighbors with `n0, n1, n2`. */ @@ -127,49 +127,49 @@ Face_handle n2); /// \name Access Functions /// @{ -/*! +/*! returns the dimension. */ int dimension(); -/*! +/*! returns the vertex `i` of the face. \pre \f$ 0\leq i \leq2\f$. */ Vertex_handle vertex(int i) const; -/*! +/*! returns `true` if `v` is a vertex of the face. */ bool has_vertex(Vertex_handle v); -/*! +/*! as above, and sets `i` to the index of `v` in the face. */ bool has_vertex(Vertex_handle v, int& i) const; -/*! +/*! returns the index of `v` in the face. */ int index(Vertex_handle v) const; -/*! +/*! returns the neighbor `i` of the face. \pre \f$ 0\leq i \leq2\f$. */ Face_handle neighbor(int i) const; -/*! +/*! returns `true` if `n` is a neighbor of the face. */ bool has_neighbor(Face_handle n); -/*! +/*! as above, and sets i to the index of `n` in the face. */ bool has_neigbor(Face_handle n, int& i) const; -/*! +/*! returns the index of neighbor `n` in the face. */ int index(const Face_handle n) const; @@ -179,36 +179,36 @@ int index(const Face_handle n) const; /// \name Setting /// @{ -/*! +/*! sets vertex `i` to `v`. \pre \f$ 0\leq i \leq2\f$. */ void set_vertex(int i, Vertex_handle v); -/*! +/*! sets the vertices to `Vertex_handle()`. */ void set_vertices(); -/*! +/*! sets the vertices. */ void set_vertices(Vertex_handle v0, Vertex_handle v1, Vertex_handle v2); -/*! +/*! sets neighbor `i` to `n`. \pre \f$ 0\leq i \leq2\f$. */ void set_neighbor(int i, Face_handle n); -/*! +/*! sets the neighbors to `Face_handle()`. */ void set_neighbors(); -/*! +/*! sets the neighbors. */ void set_neighbors(Face_handle n0, @@ -220,19 +220,19 @@ Face_handle n2); /// \name Orientation /// @{ -/*! +/*! Changes the orientation of the face by exchanging `vertex(0)` with `vertex(1)` and `neighbor(0)` with `neighbor(1)`. */ void reorient(); -/*! +/*! performs a counterclockwise permutation of the vertices and neighbors of the face. */ void ccw_permute(); -/*! +/*! performs a clockwise permutation of the vertices and neighbors of the face. */ @@ -243,7 +243,7 @@ void cw_permute(); /// \name Checking /// @{ -/*! +/*! performs any required test on a face. If `verbose` is set to `true`, messages are printed to give @@ -260,12 +260,12 @@ bool is_valid(bool verbose = false) const; /// `Compact_container` for the exact requirements. /// @{ -/*! +/*! */ void * for_compact_container() const; -/*! +/*! */ void * & for_compact_container(); diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h index 03e117c6023..6901f1917d2 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDSVertexBase_2.h @@ -65,7 +65,7 @@ public: /// The concept `TriangulationDSVertexBase_2` has to provide the following types. /// @{ -/*! +/*! This template class has to define a type `Rebind_TDS::%Other` which is the rebound vertex base , where the actual `CGAL::Triangulation_data_structure_2` is plugged in. @@ -76,17 +76,17 @@ of the class `CGAL::Triangulation_data_structure_2::Vertex`. template using Rebind_TDS = unspecified_type; -/*! +/*! */ typedef TriangulationDataStructure_2 Triangulation_data_structure; -/*! +/*! */ typedef TriangulationDataStructure_2::Vertex_handle Vertex_handle; -/*! +/*! */ typedef TriangulationDataStructure_2::Face_handle Face_handle; @@ -96,12 +96,12 @@ typedef TriangulationDataStructure_2::Face_handle Face_handle; /// \name Creation /// @{ -/*! +/*! default constructor. */ TriangulationDSVertexBase_2(); -/*! +/*! Constructs a vertex pointing to face `f`. */ TriangulationDSVertexBase_2(Face_handle f); @@ -115,12 +115,12 @@ TriangulationDSVertexBase_2(Face_handle f); /// `CGAL::Compact_container` for the exact requirements. /// @{ -/*! +/*! */ void * for_compact_container() const; -/*! +/*! */ void * & for_compact_container(); diff --git a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h index 717c57f6113..86e80b73a56 100644 --- a/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h +++ b/Triangulation_2/doc/TDS_2/Concepts/TriangulationDataStructure_2.h @@ -78,39 +78,39 @@ public: /// \name Types /// @{ -/*! +/*! Size type (unsigned integral type) */ typedef unspecified_type size_type; -/*! +/*! Difference type (signed integral type) */ typedef unspecified_type difference_type; -/*! +/*! The vertex type, requirements for this type are described in concept `TriangulationDataStructure_2::Vertex`. */ typedef unspecified_type Vertex; -/*! +/*! The face type, requirements for this type are described in concept `TriangulationDataStructure_2::Face`. */ typedef unspecified_type Face; -/*! +/*! Handle to a vertex. \cgalModels `Handle` */ typedef unspecified_type Vertex_handle; -/*! +/*! Handle to a face. \cgalModels `Handle` */ typedef unspecified_type Face_handle; -/*! +/*! This template class allows to get the type of a triangulation data structure that only changes the vertex type. It has to define a type `Rebind_vertex::%Other` which is a rebound triangulation data structure, that is, the @@ -120,7 +120,7 @@ one whose `TriangulationDSVertexBase_2` will be `Vb2`. template using Rebind_vertex = unspecified_type; -/*! +/*! This template class allows to get the type of a triangulation data structure that only changes the face type. It has to define a type `Rebind_face::%Other` which is a rebound triangulation data structure, that is, the @@ -130,7 +130,7 @@ one whose `TriangulationDSFaceBase_2` will be `Fb2`. template using Rebind_face = unspecified_type; -/*! +/*! The edge type. The `Edge(f,i)` is edge common to faces `f` and `f.neighbor(i)`. It is also the edge joining the vertices @@ -163,32 +163,32 @@ typedef std::pair Edge; /// @{ -/*! +/*! */ typedef unspecified_type Face_iterator; -/*! +/*! */ typedef unspecified_type Edge_iterator; -/*! +/*! */ typedef unspecified_type Vertex_iterator; -/*! +/*! */ typedef unspecified_type Face_circulator; -/*! +/*! */ typedef unspecified_type Edge_circulator; -/*! +/*! */ typedef unspecified_type Vertex_circulator; @@ -198,18 +198,18 @@ typedef unspecified_type Vertex_circulator; /// \name Creation /// @{ -/*! +/*! Default constructor. */ TriangulationDataStructure_2(); -/*! +/*! Copy constructor, performing a deep copy, that is all vertices and faces are duplicated. */ TriangulationDataStructure_2( const TriangulationDataStructure_2& tds1); -/*! +/*! Assignment. All the vertices and faces of `tds1` are duplicated in the triangulation data structure. Former faces and vertices of the triangulation data structure , if any, are @@ -218,7 +218,7 @@ deleted. TriangulationDataStructure_2& operator=( const TriangulationDataStructure_2& tds1); -/*! +/*! `tds1` is copied into the triangulation data structure. If `v != Vertex_handle()`, the vertex of the triangulation data structure corresponding to `v` is returned, otherwise `Vertex_handle()` @@ -251,14 +251,14 @@ otherwise `Vertex_handle()` is returned. template Vertex_handle tds.copy_tds(const TDS_src& tds_src, typename TDS_src::Vertex_handle v, const ConvertVertex& convert_vertex, const ConvertFace& convert_face); -/*! +/*! Swaps the triangulation data structure and `tds1`. Should be preferred to an assignment or copy constructor when `tds1` is deleted after that. */ void swap( TriangulationDataStructure_2 & tds1); -/*! +/*! Deletes all faces and all finite vertices. */ void clear(); @@ -268,7 +268,7 @@ void clear(); /// \name Access Functions /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin returns the dimension of the triangulation data structure. @@ -276,22 +276,22 @@ void clear(); */ int dimension() const; -/*! +/*! returns the number of vertices in the triangulation data structure. */ size_type number_of_vertices() const; -/*! +/*! returns the number of two dimensional faces in the triangulation data structure. */ size_type number_of_faces() const ; -/*! +/*! returns the number of edges in the triangulation data structure. */ size_type number_of_edges() const; -/*! +/*! returns the number of full dimensional faces, i.e.\ faces of dimension equal to the dimension of the triangulation data structure. This is the actual @@ -304,7 +304,7 @@ size_type number_of_full_dim_faces() const; /// \name Setting /// @{ -/*! +/*! sets the dimension. */ void set_dimension (int n); @@ -314,25 +314,25 @@ void set_dimension (int n); /// \name Queries /// @{ -/*! +/*! returns `true` if `v` is a vertex of the triangulation data structure. */ bool is_vertex(Vertex_handle v) const; -/*! +/*! returns `true` if `(fh,i)` is an edge of the triangulation data structure. Returns `false` when `dimension() < 1`. */ bool is_edge(Face_handle fh, int i) const; -/*! +/*! returns `true` if `(va, vb)` is an edge of the triangulation data structure. */ bool is_edge(Vertex_handle va, Vertex_handle vb) const; -/*! +/*! returns `true` if `(va, vb)` is an edge of the triangulation data structure. In addition, if true is returned @@ -343,13 +343,13 @@ of the ordered edge `(va, vb)`. bool is_edge(Vertex_handle va, Vertex_handle vb, Face_handle &fr, int &i) const; -/*! +/*! returns `true` if `fh` is a face of the triangulation data structure. Returns `false` when `dimension() < 2`. */ bool is_face(Face_handle fh) const; -/*! +/*! `true` if there is a face having `v1`, `v2`, and `v3` as vertices. */ @@ -357,7 +357,7 @@ bool is_face(Vertex_handle v1, Vertex_handle v2, Vertex_handle v3) const; -/*! +/*! `true` if there is a face having `v1`, `v2`, and `v3` as vertices. In addition, if `true` is returned, `fr` is a handle @@ -373,66 +373,66 @@ Face_handle &fr) const; /// @{ -/*! +/*! visits all faces. */ Face_iterator faces_begin() const; -/*! +/*! */ Face_iterator faces_end() const; -/*! +/*! visits all vertices. */ Vertex_iterator vertices_begin() const; -/*! +/*! */ Vertex_iterator vertices_end() const; -/*! +/*! visits all edges. */ Edge_iterator edges_begin() const; -/*! +/*! */ Edge_iterator edges_end() const; -/*! +/*! \pre If the face `f` is given, it has to be incident to be a face incident to `v` and the circulator begins with the vertex `f->vertex(ccw(i))` if `i` is the index of `v` in `f`. */ Vertex_circulator incident_vertices(Vertex_handle v, Face_handle f=Face_handle()) const; -/*! +/*! \pre If the face `f` is given, it has to be a face of incident to `v` and the circulator begins with the edge `(f,cw(i))` of `f` if `i` is the index of `v` in `f`. */ Edge_circulator incident_edges(Vertex_handle v, Face_handle f=Face_handle()) const; -/*! +/*! \pre If the face `f` is given, it has to be a face of incident to `v` and the circulator begins with the face `f`. */ Face_circulator incident_faces(Vertex_handle v, Face_handle f=Face_handle()) const; -/*! +/*! returns vertex of `f->neighbor(i)`. */ Vertex_handle mirror_vertex(Face_handle f, int i) const; -/*! +/*! returns the index of `f` as a neighbor of `f->neighbor(i)`. */ int mirror_index(Face_handle f, int i) const; -/*! +/*! returns the same edge seen from the other adjacent face. */ Edge mirror_edge(Edge e) const; @@ -443,7 +443,7 @@ Edge mirror_edge(Edge e) const; /// @{ -/*! +/*! exchanges the edge incident to `f` and `f->neighbor(i)` with the other diagonal of the quadrilateral formed by `f` and `f->neighbor(i)`. @@ -452,26 +452,26 @@ diagonal of the quadrilateral formed by `f` and `f->neighbor(i)`. */ void flip(Face_handle f, int i); -/*! +/*! creates the first vertex and returns a handle to it. */ Vertex_handle insert_first(); -/*! +/*! creates the second vertex and returns a handle to it. */ Vertex_handle insert_second(); -/*! +/*! adds a vertex `v` splitting edge `i` of face `f`. Return a handle to `v`. */ Vertex_handle insert_in_edge(Face_handle f, int i); -/*! +/*! adds a vertex `v` splitting face `f` in three. %Face `f` is modified, @@ -479,7 +479,7 @@ two new faces are created. Return a handle to `v` */ Vertex_handle insert_in_face(Face_handle f); -/*! +/*! adds a vertex `v`, increasing by one the dimension of the triangulation data structure. %Vertex `v` and the existing vertex `w` are linked to all @@ -491,7 +491,7 @@ faces. A handle to vertex `v` is returned. Vertex_handle insert_dim_up(Vertex_handle w, bool orient=true); -/*! +/*! removes a vertex of degree 3. Two of the incident faces are destroyed, the third one is modified. If parameter `f` is specified, it has to be a face incident to `v` @@ -502,25 +502,25 @@ and will be the modified face. */ void remove_degree_3(Vertex_handle v, Face_handle f = Face_handle()); -/*! +/*! removes the before last vertex. */ void remove_second(Vertex_handle v); -/*! +/*! removes the last vertex. */ void remove_first(Vertex_handle v); -/*! +/*! removes vertex `v` incident to all other vertices and decreases by one the dimension of the triangulation data structure. \pre If the dimension is 2, the number of vertices is more than 3, if the dimension is 1, the number of vertices is 2. */ void remove_dim_down(Vertex_handle v); -/*! +/*! must be called when the displacement of a vertex decreases the dimension of the triangulation data structure. The link of a vertex `v` is formed by the edges disjoint from `v` @@ -547,14 +547,14 @@ void dim_down(Face_handle f, int i); /// @{ -/*! +/*! creates a new vertex `v` and use it to star the hole whose boundary is described by the sequence of edges `[edge_begin, edge_end)`. Returns a handle to the vertex. */ template< class EdgeIt> Vertex_handle star_hole(EdgeIt edge_begin,EdgeIt edge_end); -/*! +/*! same as above, except that, to build the new faces, the algorithm first recycles faces in the sequence `[face_begin, face_end)` and create new ones when the sequence is exhausted. */ @@ -564,7 +564,7 @@ EdgeIt edge_end, FaceIt face_begin, FaceIt face_end); -/*! +/*! uses vertex v to star the hole whose boundary is described by the sequence of edges `[edge_begin, edge_end)`. @@ -572,7 +572,7 @@ whose boundary is described by the sequence of edges `[edge_begin, edge_end)`. template< class EdgeIt> void star_hole(Vertex_handle v, EdgeIt edge_begin, EdgeIt edge_end); -/*! +/*! same as above, recycling faces in the sequence `[face_begin, face_end)`. */ template< class EdgeIt, class FaceIt> @@ -582,59 +582,59 @@ EdgeIt edge_end, FaceIt face_begin, FaceIt face_end); -/*! +/*! removes the vertex v, and store in `hole` the list of edges on the boundary of the hole. */ void make_hole(Vertex_handle v, List_edges& hole); -/*! +/*! adds a new vertex. */ Vertex_handle create_vertex(); -/*! +/*! adds a face which is the neighbor `i1` of `f1`, `i2` of `f2` and `i3` of `f3`. */ Face_handle create_face(Face_handle f1, int i1, Face_handle f2, int i2, Face_handle f3, int i3); -/*! +/*! adds a face which is the neighbor `i1` of `f1`, and the neighbor `i2` of `f2`. */ Face_handle create_face(Face_handle f1, int i1, Face_handle f2, int i2); -/*! +/*! adds a face which is the neighbor `i1` of `f1`, and has `v` as vertex. */ Face_handle create_face(Face_handle f1, int i1, Vertex_handle v); -/*! +/*! adds a face with vertices `v1`, `v2` and `v3`. */ Face_handle create_face(Vertex_handle v1, Vertex_handle v2, Vertex_handle v3); -/*! +/*! adds a face with vertices `v1`, `v2` and `v3`, and neighbors `f1`, `f2`, `f3`. */ Face_handle create_face(Vertex_handle v1, Vertex_handle v2, Vertex_handle v3, Face_handle f1, Face_handle f2, Face_handle f3); -/*! +/*! adds a face whose vertices and neighbors are set to `Vertex_handle()` and `Face_handle()`. */ Face_handle create_face(); -/*! +/*! deletes a face. */ void delete_face(Face_handle ); -/*! +/*! deletes a vertex. */ void delete_vertex(Vertex_handle ); @@ -644,17 +644,17 @@ void delete_vertex(Vertex_handle ); /// \name Miscellaneous /// @{ -/*! +/*! returns \f$ i+1\f$ modulo 3, with\f$ 0\leq i \leq2\f$. */ int ccw(int i) const; -/*! +/*! returns \f$ i+2\f$ modulo 3, with \f$ 0\leq i \leq2\f$. */ int cw(int i) const; -/*! +/*! checks the combinatorial validity of the triangulation data structure: call the `is_valid()` member function for each vertex and each face, checks the number of vertices and the Euler relation @@ -662,31 +662,31 @@ between numbers of vertices, faces and edges. */ bool is_valid(); -/*! +/*! Returns the degree of `v` in the triangulation data structure. */ size_type degree(Vertex_handle v) const; -/*! +/*! writes the triangulation data structure into the stream `os`. If `v` is not `Vertex_handle()`, vertex `v` is output first or skipped if `skip_first` is true. */ void file_output( ostream& os, Vertex_handle v = Vertex_handle(), bool skip_first=false); -/*! +/*! inputs the triangulation data structure from file and returns a handle to the first input vertex. If `skip_first` is true, it is assumed that the first vertex has been omitted when output. */ Vertex_handle file_input( istream& is, bool skip_first=false); -/*! +/*! reads a combinatorial triangulation data structure from `is` and assigns it to tthe triangulation data structure. */ istream& operator>> (istream& is, TriangulationDataStructure_3 & tds); -/*! +/*! writes `tds` into the stream `os`. */ ostream& operator<< (ostream& os, const TriangulationDataStructure_3 & tds); @@ -730,7 +730,7 @@ public: /// types as the triangulation data structure except the iterators. /// @{ -/*! +/*! Optional for the triangulation data structure used alone. */ @@ -741,12 +741,12 @@ typedef unspecified_type Point; /// \name Access Functions /// @{ -/*! +/*! returns the geometric information of the vertex. */ Point point() const; -/*! +/*! returns a face of the triangulation having `*this` as a vertex. */ Face_handle face() const; @@ -756,7 +756,7 @@ Face_handle face() const; /// \name Setting /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin sets the geometric information to `p`. @@ -764,7 +764,7 @@ sets the geometric information to `p`. */ void set_point(const Point& p); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin sets the incident face to `f`. @@ -777,7 +777,7 @@ void set_face(Face_handle f); /// \name Checking /// @{ -/*! +/*! Checks the validity of the vertex. Must check that its incident face has this vertex. The validity of the base vertex is also checked. @@ -786,12 +786,12 @@ a precise indication on the kind of invalidity encountered. */ bool is_valid(bool verbose = false) const; -/*! +/*! Inputs the non-combinatorial information possibly stored in the vertex. */ std::istream& operator>> (std::istream& is, TriangulationDataStructure_2::Vertex & v); -/*! +/*! Outputs the non combinatorial operation possibly stored in the vertex. */ @@ -849,23 +849,23 @@ public: /// \name Vertex Access Functions /// @{ -/*! +/*! returns the vertex `i` of the face. \pre \f$ 0\leq i \leq2\f$. */ Vertex_handle vertex(int i) const; -/*! +/*! returns the index of vertex `v` in the face. \pre `v` is a vertex of the face. */ int index(Vertex_handle v) const; -/*! +/*! returns `true` if `v` is a vertex of the face. */ bool has_vertex(Vertex_handle v) const; -/*! +/*! returns `true` if `v` is a vertex of the face, and computes the index `i` of `v` in the face. */ @@ -878,25 +878,25 @@ bool has_vertex(Vertex_handle v, int& i) const; /// the vertex with index `i`. /// @{ -/*! +/*! returns the neighbor `i` of the face. \pre \f$ 0\leq i \leq2\f$. */ Face_handle neighbor(int i) const; -/*! +/*! returns the index of face `n`. \pre `n` is a neighbor of the face. */ int index(Face_handle n) const; -/*! +/*! returns `true` if `n` is a neighbor of the face. */ bool has_neighbor(Face_handle n) const; -/*! +/*! returns `true` if `n` is a neighbor of the face, and compute the index `i` of `n`. */ @@ -907,36 +907,36 @@ bool has_neighbor(Face_handle n, int& i) const; /// \name Setting /// @{ -/*! +/*! sets vertex `i` to be `v`. \pre \f$ 0\leq i \leq2\f$. */ void set_vertex(int i, Vertex_handle v); -/*! +/*! sets neighbor `i` to be `n`. \pre \f$ 0\leq i \leq2\f$. */ void set_neighbor(int i, Face_handle n); -/*! +/*! sets the vertex handles to `Vertex_handle()`. */ void set_vertices(); -/*! +/*! sets the vertex handles. */ void set_vertices(Vertex_handle v0, Vertex_handle v1, Vertex_handle v2); -/*! +/*! sets the neighbors handles to `Face_handle()`. */ void set_neighbors(); -/*! +/*! sets the neighbors handles. */ void set_neighbors(Face_handle n0, @@ -948,7 +948,7 @@ Face_handle n2); /// \name Checking /// @{ -/*! +/*! returns `true` if the function `is_valid()` of the base class returns `true` and if, for each index \f$ i\f$, \f$ 0 \le i < 3\f$, @@ -963,22 +963,22 @@ bool is_valid() const; /// \name Miscellaneous /// @{ -/*! +/*! Returns \f$ i+1\f$ modulo 3, with \f$ 0\leq i \leq2\f$. */ int ccw(int i) const; -/*! +/*! Returns \f$ i+2\f$ modulo 3, with \f$ 0\leq i \leq2\f$. */ int cw(int i) const; -/*! +/*! Inputs any non combinatorial information possibly stored in the face. */ std::istream& operator>> (std::istream& is, TriangulationDataStructure_2::Face & f); -/*! +/*! Outputs any non combinatorial information possibly stored in the face. */ std::ostream& operator<< (std::ostream& os, const TriangulationDataStructure_2::Face & f); 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 212aa402852..43e8b322aa7 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 @@ -94,12 +94,12 @@ public: /// \name Creation /// @{ -/*! +/*! Introduces an empty constrained Delaunay triangulation `cdt`. */ Constrained_Delaunay_triangulation_2(const Traits &t = Traits()); -/*! +/*! Copy constructor: All faces and vertices are duplicated and the constrained status of edges is copied. @@ -107,7 +107,7 @@ is copied. Constrained_Delaunay_triangulation_2(const Constrained_Delaunay_triangulation_2& cdt1); -/*! +/*! A templated constructor which introduces and builds a constrained triangulation with constrained edges in the range `[first,last)`. @@ -126,13 +126,13 @@ const Traits& t=Traits()); /// constrained property after modification of the triangulation. /// @{ -/*! +/*! Inserts point `p` in the triangulation, with face `f` as a hint for the location of `p`. */ Vertex_handle insert(Point p, Face_handle f = Face_handle()); -/*! +/*! Inserts point `p` in the triangulation at the location given by `(lt,loc,i)`. \sa `Triangulation_2::locate()` */ @@ -141,12 +141,12 @@ insert(const Point& p, Locate_type lt, Face_handle loc, int li ); -/*! +/*! Equivalent to `insert(p)`. */ Vertex_handle push_back(const Point& p); -/*! +/*! Inserts the points in the range `[first,last)`. Returns the number of inserted points. \tparam InputIterator must be an input iterator with the value type `Point`. @@ -171,34 +171,34 @@ template < class PointWithInfoInputIterator > std::ptrdiff_t insert(PointWithInfoInputIterator first, PointWithInfoInputIterator last); -/*! +/*! Inserts segment `ab` as a constrained edge in the triangulation. */ void insert_constraint(Point a, Point b); -/*! +/*! Inserts the line segment between the points `c.first` and `c.second` as a constrained edge in the triangulation. */ void push_back(const Constraint& c); -/*! +/*! Inserts the line segment whose endpoints are the vertices `va` and `vb` as a constrained edge e in the triangulation. */ void insert_constraint(Vertex_handle va, Vertex_handle vb); -/*! +/*! Removes vertex v. \pre Vertex `v` is not incident to a constrained edge. */ void remove(Vertex_handle & v); -/*! +/*! Make the edges incident to vertex `v` unconstrained edges. */ void remove_incident_constraints(Vertex_handle v); -/*! +/*! Make the edge `(f,i)` unconstrained. */ void remove_constraint(const Face_handle & f, int i); @@ -215,7 +215,7 @@ void remove_constraint(const Face_handle & f, int i); /// in the circumcircle of `f`. /// @{ -/*! +/*! outputs the faces and boundary edges of the conflict zone of point `p` into output iterators. @@ -241,7 +241,7 @@ OutputItFaces fit, OutputItBoundaryEdges eit, Face_handle start) const; -/*! +/*! outputs the faces of the conflict zone of point `p` into an output iterator. Same as `get_conflicts_and_boundary` except that only the faces in conflict with `p` @@ -254,7 +254,7 @@ get_conflicts (const Point &p, OutputItFaces fit, Face_handle start) const; -/*! +/*! outputs the boundary edges of the conflict zone of point `p` into an output iterator. This functions outputs in the container pointed to by `eit`, @@ -277,7 +277,7 @@ Face_handle start) const; /// \name Checking /// @{ -/*! +/*! checks if the triangulation is valid and if each constrained edge is consistently marked constrained in its two incident faces. */ @@ -288,7 +288,7 @@ bool is_valid() const; /// \name Flips /// @{ -/*! +/*! determines if edge `(f,i)` can be flipped. \cgalAdvancedBegin Returns true if @@ -299,7 +299,7 @@ opposite to edge `(f,i)`. */ bool is_flipable(Face_handle f, int i) const; -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Flip `f` and `f->neighbor(i)`. @@ -307,7 +307,7 @@ Flip `f` and `f->neighbor(i)`. */ void flip(Face_handle& f, int i); -/*! +/*! makes the triangulation constrained Delaunay by flipping edges. \cgalAdvancedBegin 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 dc5125653ec..ba073b84d2e 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_2.h @@ -147,13 +147,13 @@ public: /// \name Types /// @{ -/*! +/*! The type of input constraints */ typedef std::pair Constraint; -/*! +/*! The intersection tag which decides how intersections between input constraints are dealt with. */ @@ -164,12 +164,12 @@ typedef Itag Intersection_tag; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ Constrained_triangulation_2(); -/*! +/*! Copy constructor: All faces and vertices are duplicated and the constrained status of edges is copied. @@ -177,7 +177,7 @@ is copied. Constrained_triangulation_2(const Constrained_triangulation_2& ct1); -/*! +/*! A templated constructor which introduces and builds a constrained triangulation with constrained edges in the range `[first,last)`. @@ -193,18 +193,18 @@ const Traits& t=Traits()); /// \name Queries /// @{ -/*! +/*! Returns `true` if edge `e` is a constrained edge. */ bool is_constrained(Edge e) const; -/*! +/*! Returns `true` if at least one of the edges incident to vertex `v` is constrained. */ bool are_there_incident_constraints(Vertex_handle v) const; -/*! +/*! Outputs the constrained edges incident to `v` into the output iterator `out` and returns the resulting output iterator. @@ -220,14 +220,14 @@ OutputItEdges out) const; /// \name Insertion and Removal /// @{ -/*! +/*! Inserts point `p` and restores the status (constrained or not) of all the touched edges. If present `f` is used as an hint for the location of `p`. */ Vertex_handle insert(Point p, Face_handle f = Face_handle() ); -/*! +/*! Inserts point `p` in the triangulation at the location given by `(lt,loc,i)`. \sa `Triangulation_2::locate()` */ @@ -236,12 +236,12 @@ insert(const Point& p, Locate_type& lt, Face_handle loc, int li ); -/*! +/*! Equivalent to `insert(p)`. */ Vertex_handle push_back(const Point& p); -/*! +/*! Inserts the points in the range `[first,last)`. Returns the number of inserted points. \pre The `value_type` of `first` and `last` is `Point`. @@ -250,7 +250,7 @@ template < class InputIterator > std::ptrdiff_t insert(InputIterator first, InputIterator last); -/*! +/*! Inserts points `a` and `b`, and inserts segment `ab` as a constraint. Removes the faces crossed by segment `ab` and creates new faces instead. If a vertex `c` lies on segment `ab`, constraint `ab` is @@ -261,12 +261,12 @@ removed triangles. */ void insert_constraint(Point a, Point b); -/*! +/*! Equivalent to `insert(c.first, c.second)`. */ void push_back(const Constraint& c); -/*! +/*! Inserts the line segment `s` whose endpoints are the vertices `va` and `vb` as a constrained edge. The triangles intersected by `s` @@ -274,23 +274,23 @@ are removed and new ones are created. */ void insert_constraint(const Vertex_handle & va, const Vertex_handle & vb); -/*! +/*! Removes a vertex `v`. \pre Vertex `v` is not incident to a constrained edge. */ void remove(Vertex_handle v); -/*! +/*! Make the edges incident to vertex `v` unconstrained edges. */ void remove_incident_constraints(Vertex_handle v); -/*! +/*! Make edge `(f,i)` unconstrained. */ void remove_constrained_edge(Face_handle f, int i); -/*! +/*! Checks the validity of the triangulation and the consistency of the constrained marks in edges. */ @@ -301,7 +301,7 @@ is_valid(bool verbose = false, int level = 0) const; }; /* end Constrained_triangulation_2 */ -/*! +/*! Writes the triangulation as for `Triangulation_2` and, for each face `f`, and integers `i=0,1,2`, writes "C" or "N" depending whether edge `(f,i)` is constrained or not. @@ -309,7 +309,7 @@ writes "C" or "N" depending whether edge */ ostream & operator<<(ostream& os, const Constrained_triangulation_2 &Ct); -/*! +/*! Reads a triangulation from stream `is` and assigns it to `t`. Data in the stream must have the same format `operator<<` uses. Note that `t` is first cleared. \relates Constrained_triangulation_2 diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h index 77bbd2303be..16ec50d7e86 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Constrained_triangulation_plus_2.h @@ -48,17 +48,17 @@ public: /// \name Types /// @{ -/*! +/*! The triangulation base class. */ typedef Tr Triangulation; -/*! +/*! The intersection tag. */ typedef Itag Intersection_tag; -/*! +/*! An iterator to visit all the input constraints. The order of visit is arbitrary. The value type of this iterator is a pair @@ -67,7 +67,7 @@ endpoints of the constraint. */ typedef unspecified_type Constraint_iterator; -/*! +/*! An iterator to visit all the sub-constraints of the triangulation. The order of visit is arbitrary. @@ -78,14 +78,14 @@ sub-constraint. */ typedef unspecified_type Subconstraint_iterator; -/*! +/*! An iterator on the vertices of the chain of triangulation edges representing a constraint. The value type of this iterator is `Vertex_handle`. */ typedef unspecified_type Vertices_in_constraint_iterator; -/*! +/*! This type is intended to describe a constraint enclosing a sub-constraint and the position of the sub-constraint in this constraint. @@ -100,7 +100,7 @@ and on the first vertex of the sub-constraint. */ typedef Context; -/*! +/*! An iterator on constraints enclosing a given sub-constraint. The value type of this iterator @@ -113,25 +113,25 @@ typedef Context_iterator; /// \name Creation /// @{ -/*! +/*! Introduces an empty triangulation. */ Constrained_triangulation_plus_2(const Geom_traits& gt=Geom_traits()); -/*! +/*! Copy constructor. */ Constrained_triangulation_plus_2(const Constrained_triangulation_plus_2& ct); -/*! +/*! Introduces a constrained triangulation from the list of constraints `lc`. */ Constrained_triangulation_plus_2(std::list& lc, const Geom_traits& t = Geom_traits()); -/*! +/*! Introduces a constrained triangulation from the constraints in the range `[first,last)`. \tparam InputIterator must be an input iterator with the value type `Constraint`. @@ -148,14 +148,14 @@ const Geom_traits& gt= Geom_traits()); /// \name Assignment /// @{ -/*! +/*! Assignment. All the vertices and faces are duplicated. The constraint hierarchy is also duplicated. */ Constrained_triangulation_plus_2 operator=(const Constrained_triangulation_plus_2& tr); -/*! +/*! The triangulations `tr` and this triangulation are swapped. This operation should be preferred to the assignment or to the copy constructor if `tr` is deleted after that. @@ -170,13 +170,13 @@ void swap(Constrained_triangulation_plus_2 tr); /// constraints. /// @{ -/*! +/*! Inserts point `p` as a vertex of the triangulation. */ Vertex_handle insert(const Point& p, Face_handle start = Face_handle() ); -/*! +/*! Inserts point `p` in the triangulation at the location given by `(lt,loc,i)`. \sa `Triangulation_2::locate()` */ @@ -184,12 +184,12 @@ Vertex_handle insert(const Point& p, Locate_type lt, Face_handle loc, int li ); -/*! +/*! Equivalent to `insert(p)`. */ Vertex_handle push_back(const Point& p); -/*! +/*! Inserts the points in the range `[first,last)`. Returns the number of inserted points. \tparam InputIterator must be an input iterator with the value type `Point`. @@ -198,23 +198,23 @@ template < class InputIterator > size_type insert(InputIterator first, InputIterator last); -/*! +/*! Inserts the constraint segment `ab` in the triangulation. */ void insert_constraint(Point a, Point b); -/*! +/*! Inserts the constraint `c`. */ void push_back(const Constraint& c); -/*! +/*! Inserts a constraint whose endpoints are the vertices pointed by `va` and `vb` in the triangulation. */ void insert_constraint(Vertex_handle va, Vertex_handle vb); -/*! +/*! Removes the constraint joining the vertices pointed by `va` and `vb`. \pre `va` and `vb` have to refer to the endpoint vertices of an input constraint. */ @@ -225,31 +225,31 @@ void remove_constraint(Vertex_handle va, Vertex_handle vb); /// \name Queries /// @{ -/*! +/*! Returns a `Constraint_iterator` pointing on the first constraint. */ Constraint_iterator constraints_begin() const; -/*! +/*! Returns a `Constraint_iterator` pointing past the last constraint. */ Constraint_iterator constraints_end() const; -/*! +/*! Returns a `Subconstraint_iterator` pointing on the first sub-constraint. */ Subconstraint_iterator subconstraints_begin() const; -/*! +/*! Returns a `Subconstraint_iterator` pointing past the last sub-constraint. */ Subconstraint_iterator subconstraints_end() const; -/*! +/*! Returns the number of constraints enclosing the sub-constraint `(va,vb)`. \pre `va` and `vb` refer to the vertices of a constrained edge of the triangulation. @@ -257,14 +257,14 @@ Returns the number of constraints enclosing the sub-constraint int number_of_enclosing_constraints(Vertex_handle va, Vertex_handle vb); -/*! +/*! Returns the `Context` relative to one of the constraints enclosing the sub-constraint `(va,vb)`. \pre `va` and `vb` refer to the vertices of a constrained edge of the triangulation. */ Context context(Vertex_handle va, Vertex_handle vb); -/*! +/*! Returns an iterator pointing on the first `Context` of the sequence of `Contexts` corresponding to the constraints enclosing the sub-constraint`(va,vb)`. @@ -273,7 +273,7 @@ corresponding to the constraints enclosing the sub-constraint`(va,vb)`. Context_iterator contexts_begin(Vertex_handle va, Vertex_handle vb); -/*! +/*! Returns an iterator past the last `Context` of the sequence of `Contexts` corresponding to the constraints enclosing the `(va,vb)`. @@ -282,7 +282,7 @@ corresponding to the constraints enclosing the `(va,vb)`. Context_iterator contexts_end(Vertex_handle va, Vertex_handle vb); -/*! +/*! Returns an iterator on the first vertex on the constraint `(va,vb)`. \pre `va` and `vb` refer to the vertices of an input constraint. @@ -290,7 +290,7 @@ Returns an iterator on the first vertex on the constraint Vertices_in_constraint_iterator vertices_in_constraint_begin(Vertex_handle va, Vertex_handle vb); -/*! +/*! Returns an iterator past the last vertex on the constraint `(va,vb)`. \pre `va` and `vb` refer to the vertices of an input constraints. 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 954c891c413..11a030eed4d 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Delaunay_triangulation_2.h @@ -83,13 +83,13 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Delaunay_triangulation_2(const Traits& gt = Traits()); -/*! +/*! copy constructor. All the vertices and faces are duplicated. */ Delaunay_triangulation_2( @@ -122,7 +122,7 @@ Delaunay_triangulation_2 dt ( InputIterator first, InputIterator las /// triangulation which is no longer a Delaunay triangulation. /// @{ -/*! +/*! inserts point `p`. If point `p` coincides with an already existing vertex, this vertex is returned and the triangulation is not updated. @@ -131,19 +131,19 @@ Optional parameter `f` is used to initialize the location of `p`. */ Vertex_handle insert(const Point& p, Face_handle f=Face_handle()); -/*! +/*! inserts a point `p` at the location given by `(lt,loc,li)`. \sa `Triangulation_2::locate()` */ Vertex_handle insert(const Point& p, Locate_type& lt, Face_handle loc, int li ); -/*! +/*! equivalent to `insert(p)`. */ Vertex_handle push_back(const Point& p); -/*! +/*! inserts the points in the range `[first,last)`. Returns the number of inserted points. Note that this function is not guaranteed to insert the points @@ -155,7 +155,7 @@ template < class PointInputIterator > std::ptrdiff_t insert(PointInputIterator first, PointInputIterator last); -/*! +/*! inserts the points in the iterator range `[first,last)`. Returns the number of inserted points. Note that this function is not guaranteed to insert the points @@ -173,7 +173,7 @@ template < class PointWithInfoInputIterator > std::ptrdiff_t insert(PointWithInfoInputIterator first, PointWithInfoInputIterator last); -/*! +/*! removes the vertex from the triangulation. */ void remove(Vertex_handle v); @@ -183,7 +183,7 @@ void remove(Vertex_handle v); /// \name Displacement /// @{ -/*! +/*! if there is not already another vertex placed on `p`, the triangulation is modified such that the new position of vertex `v` is `p`, and `v` is returned. Otherwise, the triangulation is not @@ -192,7 +192,7 @@ modified and the vertex at point `p` is returned. */ Vertex_handle move_if_no_collision(Vertex_handle v, const Point & p); -/*! +/*! same as `move_if_no_collision()`, if there is no collision. Otherwise, `v` is deleted and the vertex placed on `p` is returned. \pre Vertex `v` must be finite. @@ -204,7 +204,7 @@ Vertex_handle move(Vertex_handle v, const Point & p); /// \name Queries /// @{ -/*! +/*! returns any nearest vertex of `p`. The implemented function begins with a location step and `f` may be used to initialize the location. @@ -212,7 +212,7 @@ begins with a location step and Vertex_handle nearest_vertex(const Point& p, Face_handle f=Face_handle()) const; -/*! +/*! outputs the faces and boundary edges of the conflict zone of point `p` into output iterators. @@ -239,7 +239,7 @@ OutputItFaces fit, OutputItBoundaryEdges eit, Face_handle start) const; -/*! +/*! outputs the faces of the conflict zone of point `p` into an output iterator. same as `get_conflicts_and_boundary()` except that only the faces in conflict with `p` are output. The function returns the resulting output iterator. @@ -251,7 +251,7 @@ get_conflicts (const Point &p, OutputItFaces fit, Face_handle start) const; -/*! +/*! outputs the boundary edges of the conflict zone of point `p` into an output iterator. This function outputs in the container pointed to by `eit`, @@ -276,13 +276,13 @@ Face_handle start) const; /// Voronoi diagram. /// @{ -/*! +/*! Returns the center of the circle circumscribed to face `f`. \pre `f` is not infinite. */ Point dual(const Face_handle &f) const; -/*! +/*! returns a segment, a ray or a line supported by the bisector of the endpoints of `e`. If faces incident to `e` are both finite, a segment whose endpoints are the @@ -294,17 +294,17 @@ are infinite and the bisector line is returned. */ Object dual(const Edge &e) const; -/*! +/*! Idem */ Object dual(const Edge_circulator& ec) const; -/*! +/*! Idem */ Object dual(const Edge_iterator& ei) const; -/*! +/*! output the dual Voronoi diagram to stream `ps`. */ template < class Stream> @@ -315,7 +315,7 @@ Stream& draw_dual(Stream & ps); /// \name Predicates /// @{ -/*! +/*! Returns the side of `p` with respect to the circle circumscribing the triangle associated with `f`. */ @@ -328,7 +328,7 @@ Oriented_side side_of_oriented_circle(Face_handle f, const Point& p) const; /// additionally test the empty circle property. /// @{ -/*! +/*! tests the validity of the triangulation as a `Triangulation_2` and additionally tests the Delaunay property. This method is mainly useful for debugging Delaunay triangulation 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 7cdb74139a3..3121f838271 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Regular_triangulation_2.h @@ -140,44 +140,44 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Traits::Distance Distance; -/*! +/*! */ typedef Traits::Line Line; -/*! +/*! */ typedef Traits::Ray Ray; -/*! +/*! */ typedef Traits::Bare_point Bare_point; -/*! +/*! */ typedef Traits::Weighted_point Weighted_point; -/*! +/*! An iterator that allows to enumerate the vertices that are not hidden. */ typedef unspecified_type All_vertices_iterator; -/*! +/*! An iterator that allows to enumerate the finite vertices that are not hidden. */ typedef unspecified_type Finite_vertices_iterator; -/*! +/*! An iterator that allows to enumerate the hidden vertices. */ @@ -188,12 +188,12 @@ typedef unspecified_type Hidden_vertices_iterator; /// \name Creation /// @{ -/*! +/*! Introduces an empty regular triangulation. */ Regular_triangulation_2(const Traits& gt = Traits()); -/*! +/*! Copy constructor. */ Regular_triangulation_2(const Regular_triangulation_2 &rt); @@ -210,7 +210,7 @@ Regular_triangulation_2 rt ( InputIterator first, InputIterator last /// \name Insertion and Removal /// @{ -/*! +/*! inserts weighted point `p` in the regular triangulation. If the point `p` does not appear as a vertex of the triangulation, the returned vertex is a hidden vertex. @@ -219,7 +219,7 @@ for the place to start the location process of point `p`. */ Vertex_handle insert(const Weighted_point& p, Face_handle f=Face_handle()); -/*! +/*! insert a weighted point `p` whose bare-point is assumed to be located in `lt,loc,li`. See the description of member function @@ -230,12 +230,12 @@ Vertex_handle insert(const Weighted_point &p, Locate_type lt, Face_handle loc, int li ); -/*! +/*! Equivalent to `insert(p)`. */ Vertex_handle push_back(const Point& p); -/*! +/*! inserts the weighted points in the range `[first,last)`. It returns the difference of the number of vertices between after and before the insertions (it may be negative due to hidden points). @@ -248,7 +248,7 @@ template < class InputIterator > std::ptrdiff_t insert(InputIterator first, InputIterator last); -/*! +/*! inserts the weighted points in the range `[first,last)`. It returns the difference of the number of vertices between after and before the insertions (it may be negative due to hidden points). @@ -267,7 +267,7 @@ template < class WeightedPointWithInfoInputIterator > std::ptrdiff_t insert(WeightedPointWithInfoInputIterator first, WeightedPointWithInfoInputIterator last); -/*! +/*! removes the vertex from the triangulation. */ void remove(Vertex_handle v); @@ -277,7 +277,7 @@ void remove(Vertex_handle v); /// \name Queries /// @{ -/*! +/*! outputs the faces, boundary edges, and hidden vertices of the conflict zone of point `p` to output iterators. @@ -308,7 +308,7 @@ get_conflicts_and_boundary_and_hidden_vertices(const Weighted_point &p, OutputItFaces fit, OutputItBoundaryEdges eit, OutputItHiddenVertices vit, Face_handle start) const; -/*! +/*! outputs the faces and boundary edges of the conflict zone of point `p` to output iterators. @@ -322,7 +322,7 @@ std::pair get_conflicts_and_boundary(const Weighted_point &p, OutputItFaces fit, OutputItBoundaryEdges eit, Face_handle start) const; -/*! +/*! outputs the faces and hidden vertices of the conflict zone of point `p` to output iterators. @@ -337,7 +337,7 @@ std::pair get_conflicts_and_hidden_vertices(const Weighted_point &p, OutputItFaces fit, OutputItHiddenVertices vit, Face_handle start) const; -/*! +/*! outputs the boundary edges and hidden vertices of the conflict zone of point `p` to output iterators. @@ -351,7 +351,7 @@ get_boundary_of_conflicts_and_hidden_vertices(const Weighted_point &p, OutputItBoundaryEdges eit, OutputItHiddenVertices vit, Face_handle start) const; -/*! +/*! outputs the faces of the conflict zone of point `p` to output iterators. The function returns the resulting output iterator. @@ -363,7 +363,7 @@ get_conflicts (const Point &p, OutputItFaces fit, Face_handle start) const; -/*! +/*! outputs the boundary edges of the conflict zone of `p` in counterclockwise order where each edge is described through the incident face @@ -376,7 +376,7 @@ get_boundary_of_conflicts(const Point &p, OutputItBoundaryEdges eit, Face_handle start) const; -/*! +/*! outputs the hidden vertices of the conflict zone of `p` into an output iterator. The function returns the resulting output iterator. @@ -387,7 +387,7 @@ get_hidden_vertices(const Point &p, OutputItHiddenVertices vit, Face_handle start) const; -/*! +/*! Returns the vertex of the triangulation which is nearest to `p` with respect to the power distance. This means that the power of the query point `p` with respect to the weighted point in the nearest @@ -402,43 +402,43 @@ Vertex_handle nearest_power_vertex(Bare_point p) const; /// \name Access Functions /// @{ -/*! +/*! returns the number of finite vertices that are not hidden. */ int number_of_vertices() const; -/*! +/*! returns the number of hidden vertices. */ int number_of_hidden_vertices() const; -/*! +/*! starts at an arbitrary hidden vertex. */ Hidden_vertices_iterator hidden_vertices_begin() const; -/*! +/*! past the end iterator for the sequence of hidden vertices. */ Hidden_vertices_iterator hidden_vertices_end() const; -/*! +/*! starts at an arbitrary unhidden finite vertex */ Finite_vertices_iterator finite_vertices_begin() const; -/*! +/*! Past-the-end iterator */ Finite_vertices_iterator finite_vertices_end() const; -/*! +/*! starts at an arbitrary unhidden vertex. */ All_vertices_iterator all_vertices_end() const; -/*! +/*! past the end iterator. */ All_vertices_iterator all_vertices_begin() const; @@ -450,19 +450,19 @@ All_vertices_iterator all_vertices_begin() const; /// power diagram. /// @{ -/*! +/*! returns the center of the circle orthogonal to the three weighted points corresponding to the vertices of face `f`. \pre `f` is not infinite. */ Point weighted_circumcenter(const Face_handle &f) const; -/*! +/*! same as weighted_circumcenter. */ Point dual(const Face_handle &f) const; -/*! +/*! If both incident faces are finite, returns a segment whose endpoints are the duals of each incident face. If only one incident face is finite, returns a ray whose endpoint is the dual of the finite incident face and supported by @@ -472,17 +472,17 @@ otherwise. */ Object dual(const Edge &e) const; -/*! +/*! Idem */ Object dual(const Edge_circulator& ec) const; -/*! +/*! Idem */ Object dual(const Edge_iterator& ei) const; -/*! +/*! output the dual power diagram to stream `ps`. */ template < class Stream> @@ -493,7 +493,7 @@ Stream& draw_dual(Stream & ps); /// \name Predicates /// @{ -/*! +/*! Returns the power test of `p` with respect to the power circle associated with `f`. */ @@ -506,7 +506,7 @@ const Weighted_point& p) const; /// \name Miscellaneous /// @{ -/*! +/*! Tests the validity of the triangulation as a `Triangulation_2` and additionally test the regularity of the triangulation. This method is useful to debug regular triangulation diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h index d58f66de825..ff864c3cfbd 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Triangulation_2.h @@ -171,52 +171,52 @@ public: /// \name Types /// @{ -/*! +/*! the traits class. */ typedef Traits Geom_traits; -/*! +/*! the triangulation data structure type. */ typedef Tds Triangulation_data_structure; -/*! +/*! the point type. */ typedef Traits::Point_2 Point; -/*! +/*! the segment type. */ typedef Traits::Segment_2 Segment; -/*! +/*! the triangle type. */ typedef Traits::Triangle_2 Triangle; -/*! +/*! the vertex type. */ typedef Tds::Vertex Vertex; -/*! +/*! the face type. */ typedef Tds::Face Face; -/*! +/*! the edge type. */ typedef Tds::Edge Edge; -/*! +/*! Size type (an unsigned integral type). */ typedef Tds::size_type size_type; -/*! +/*! Difference type (a signed integral type). */ typedef Tds::difference_type difference_type; @@ -248,69 +248,69 @@ typedef Tds::difference_type difference_type; /// enum type to specify which case occurs when locating a point in /// the triangulation. -/*! +/*! handle to a vertex. */ typedef Tds::Vertex_handle Vertex_handle; -/*! +/*! handle to a face. */ typedef Tds::Face_handle Face_handle; -/*! +/*! iterator over all faces. */ typedef Tds::Face_iterator All_faces_iterator; -/*! +/*! iterator over all edges. */ typedef Tds::Edge_iterator All_edges_iterator; -/*! +/*! iterator over all vertices. */ typedef Tds::Vertex_iterator All_vertices_iterator; -/*! +/*! iterator over finite faces. */ typedef unspecified_type Finite_faces_iterator; -/*! +/*! iterator over finite edges. */ typedef unspecified_type Finite_edges_iterator ; -/*! +/*! iterator over finite vertices. */ typedef unspecified_type Finite_vertices_iterator; -/*! +/*! iterator over the points corresponding the finite vertices of the triangulation. */ typedef unspecified_type Point_iterator; -/*! +/*! circulator over all faces intersected by a line. */ typedef unspecified_type Line_face_circulator; -/*! +/*! circulator over all faces incident to a given vertex. */ typedef unspecified_type Face_circulator; -/*! +/*! circulator over all edges incident to a given vertex. */ typedef unspecified_type Edge_circulator; -/*! +/*! circulator over all vertices incident to a given vertex. */ typedef unspecified_type Vertex_circulator; @@ -333,13 +333,13 @@ specifies which case occurs when locating a point in the triangulation. /// @{ -/*! +/*! Introduces an empty triangulation. */ Triangulation_2( const Traits& gt = Traits() ); -/*! +/*! Copy constructor. All the vertices and faces are duplicated. After the copy, `*this` and `tr` refer to different triangulations: @@ -348,7 +348,7 @@ if `tr` is modified, `*this` is not. Triangulation_2( const Triangulation_2& tr); -/*! +/*! Assignment. All the vertices and faces are duplicated. After the assignment, `*this` and `tr` refer to different triangulations: @@ -356,14 +356,14 @@ if `tr` is modified, `*this` is not. */ Triangulation_2 operator=(const Triangulation_2& tr); -/*! +/*! The triangulations `tr` and `*this` are swapped. This method should be used instead of assignment of copy construtor. if `tr` is deleted after that. */ void swap(Triangulation_2& tr); -/*! +/*! Deletes all faces and finite vertices resulting in an empty triangulation. */ @@ -374,12 +374,12 @@ void clear(); /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the triangulation traits object. */ const Geom_traits& geom_traits() const; -/*! +/*! Returns a const reference to the triangulation data structure. */ const TriangulationDataStructure_2 & tds() const; @@ -393,38 +393,38 @@ const TriangulationDataStructure_2 & tds() const; /// their own triangulation algorithms. /// @{ -/*! +/*! Returns a reference to the triangulation data structure. */ TriangulationDataStructure_2 & tds(); -/*! +/*! Returns the dimension of the convex hull. */ int dimension() const; -/*! +/*! Returns the number of finite vertices. */ size_type number_of_vertices() const; -/*! +/*! Returns the number of finite faces. */ size_type number_of_faces() const; -/*! +/*! a face incident to the infinite vertex. */ Face_handle infinite_face() const; -/*! +/*! the infinite vertex. */ Vertex_handle infinite_vertex(); -/*! +/*! a vertex distinct from the infinite vertex. */ Vertex_handle finite_vertex() const; @@ -438,48 +438,48 @@ Vertex_handle finite_vertex() const; /// face). /// @{ -/*! +/*! `true` iff `v` is the infinite vertex. */ bool is_infinite(Vertex_handle v) const; -/*! +/*! `true` iff face `f` is infinite. */ bool is_infinite(Face_handle f) const; -/*! +/*! `true` iff edge `(f,i)` is infinite. */ bool is_infinite(Face_handle f, int i) const; -/*! +/*! `true` iff edge `e` is infinite. */ bool is_infinite(Edge e) const; -/*! +/*! `true` iff edge `*ec` is infinite. */ bool is_infinite(Edge_circulator ec) const; -/*! +/*! `true` iff edge `*ei` is infinite. */ bool is_infinite(All_edges_iterator ei) const; -/*! +/*! `true` if there is an edge having `va` and `vb` as vertices. */ bool is_edge(Vertex_handle va, Vertex_handle vb); -/*! +/*! as above. In addition, if `true` is returned, the edge with vertices `va` and `vb` is the edge `e=(fr,i)` where `fr` is a handle to the face incident to `e` and @@ -488,7 +488,7 @@ on the right side of `e` oriented from `va` to `vb`. bool is_edge(Vertex_handle va, Vertex_handle vb, Face_handle& fr, int & i); -/*! +/*! `true` if the line segment from `va` to `vb` includes an edge `e` incident to `va`. If `true`, `vb` becomes the other vertex of `e`, `e` is the edge `(fr,i)` where @@ -498,13 +498,13 @@ on the right side `e` oriented from `va` to `vb`. bool includes_edge(Vertex_handle va, Vertex_handle & vb, Face_handle& fr, int & i); -/*! +/*! `true` if there is a face having `v1`, `v2` and `v3` as vertices. */ bool is_face(Vertex_handle v1, Vertex_handle v2, Vertex_handle v3); -/*! +/*! as above. In addition, if `true` is returned, fr is a handle to the face with `v1`, `v2` and `v3` as vertices. @@ -521,7 +521,7 @@ Face_handle &fr); /// triangulation. /// @{ -/*! +/*! If the point `query` lies inside the convex hull of the points, a face that contains the query in its interior or on its boundary is returned. @@ -562,7 +562,7 @@ Face_handle inexact_locate(const Point & query, Face_handle start = Face_handle()) const; -/*! +/*! Same as above. Additionally, the parameters `lt` and `li` describe where the query point is located. @@ -585,7 +585,7 @@ Locate_type& lt, int& li, Face_handle h =Face_handle() ) const; -/*! +/*! Returns on which side of the oriented boundary of `f` lies the point `p`. \pre `f` is finite. */ @@ -593,7 +593,7 @@ Oriented_side oriented_side(Face_handle f, const Point& p) const; -/*! +/*! Returns on which side of the circumcircle of face `f` lies the point `p`. The circle is assumed to be counterclockwise oriented, so its positive @@ -624,7 +624,7 @@ triangulation. */ /// @{ -/*! +/*! Exchanges the edge incident to `f` and `f->neighbor(i)` with the other diagonal of the quadrilateral formed by `f` and `f->neighbor(i)`. @@ -632,7 +632,7 @@ diagonal of the quadrilateral formed by `f` and `f->neighbor(i)`. */ void flip(Face_handle f, int i); -/*! +/*! Inserts point `p` in the triangulation and returns the corresponding vertex. @@ -660,7 +660,7 @@ algorithm of where to start. Vertex_handle insert(const Point& p, Face_handle f = Face_handle()); -/*! +/*! Same as above except that the location of the point `p` to be inserted is assumed to be given by `(lt,loc,i)` (see the description of the `locate` method above.) @@ -670,12 +670,12 @@ insert(const Point& p, Locate_type lt, Face_handle loc, int li ); -/*! +/*! Equivalent to `insert(p)`. */ Vertex_handle push_back(const Point& p); -/*! +/*! Inserts the points in the range `[first,last)`. Returns the number of inserted points. \pre The `value_type` of `InputIterator` is `Point`. @@ -684,14 +684,14 @@ template < class InputIterator > std::ptrdiff_t insert(InputIterator first, InputIterator last); -/*! +/*! Removes the vertex from the triangulation. The created hole is re-triangulated. \pre Vertex `v` must be finite. */ void remove(Vertex_handle v); -/*! +/*! if there is not already another vertex placed on `p`, the triangulation is modified such that the new position of vertex `v` is `p`, and `v` is returned. Otherwise, the triangulation is not @@ -700,7 +700,7 @@ modified and the vertex at point `p` is returned. */ Vertex_handle move_if_no_collision(Vertex_handle v, const Point & p); -/*! +/*! same as above if there is no collision. Otherwise, `v` is deleted and the vertex placed on `p` is returned. \pre Vertex `v` must be finite. @@ -714,17 +714,17 @@ Vertex_handle move(Vertex_handle v, const Point & p); /// be in the corresponding case. /// @{ -/*! +/*! Inserts the first finite vertex . */ Vertex_handle insert_first(const Point& p); -/*! +/*! Inserts the second finite vertex . */ Vertex_handle insert_second(const Point& p); -/*! +/*! Inserts vertex `v` in face `f`. Face `f` is modified, two new faces are created. @@ -732,43 +732,43 @@ two new faces are created. */ Vertex_handle insert_in_face(const Point& p,Face_handle f); -/*! +/*! Inserts vertex v in edge `i` of `f`. \pre The point in vertex `v` lies on the edge opposite to the vertex `i` of face `f`. */ Vertex_handle insert_in_edge(const Point& p, Face_handle f, int i); -/*! +/*! Inserts a point which is outside the convex hull but in the affine hull. \pre The handle `f` points to a face which is a proof of the location of`p`, see the description of the `locate` method above. */ Vertex_handle insert_outside_convex_hull(const Point& p, Face_handle f); -/*! +/*! Inserts a point which is outside the affine hull. */ Vertex_handle insert_outside_affine_hull(const Point& p); -/*! +/*! Removes a vertex of degree three. Two of the incident faces are destroyed, the third one is modified. \pre Vertex `v` is a finite vertex with degree three. */ void remove_degree_3(Vertex_handle v); -/*! +/*! Removes the before last finite vertex. */ void remove_second(Vertex_handle v); -/*! +/*! Removes the last finite vertex. */ void remove_first(Vertex_handle v); -/*! +/*! creates a new vertex `v` and use it to star the hole whose boundary is described by the sequence of edges `[edge_begin, edge_end)`. Returns a handle to the new vertex. @@ -781,7 +781,7 @@ Vertex_handle star_hole( Point p, EdgeIt edge_begin, EdgeIt edge_end); -/*! +/*! same as above, except that the algorithm first recycles faces in the sequence `[face_begin, face_end)` and create new ones only when the sequence is exhausted. @@ -807,43 +807,43 @@ FaceIt face_end); /// by any change in the triangulation. /// @{ -/*! +/*! Starts at an arbitrary finite vertex */ Finite_vertices_iterator finite_vertices_begin() const; -/*! +/*! Past-the-end iterator */ Finite_vertices_iterator finite_vertices_end() const; -/*! +/*! Starts at an arbitrary finite edge */ Finite_edges_iterator finite_edges_begin() const; -/*! +/*! Past-the-end iterator */ Finite_edges_iterator finite_edges_end() const; -/*! +/*! Starts at an arbitrary finite face */ Finite_faces_iterator finite_faces_begin() const; -/*! +/*! Past-the-end iterator */ Finite_faces_iterator finite_faces_end() const; -/*! +/*! */ Point_iterator points_begin() const; -/*! +/*! Past-the-end iterator */ Point_iterator points_end() const; @@ -859,32 +859,32 @@ Point_iterator points_end() const; /// triangulation. /// @{ -/*! +/*! Starts at an arbitrary vertex */ All_vertices_iterator all_vertices_begin() const; -/*! +/*! Past-the-end iterator */ All_vertices_iterator all_vertices_end() const; -/*! +/*! Starts at an arbitrary edge */ All_edges_iterator all_edges_begin() const; -/*! +/*! Past-the-end iterator */ All_edges_iterator all_edges_end() const; -/*! +/*! Starts at an arbitrary face */ All_faces_iterator all_faces_begin() const; -/*! +/*! Past-the-end iterator */ All_faces_iterator all_faces_end() const; @@ -920,7 +920,7 @@ are not enumerated. */ /// @{ -/*! +/*! This function returns a circulator that allows to visit the faces intersected by the line `pq`. If there is no such face the circulator has a singular value. @@ -955,38 +955,38 @@ line_walk(const Point& p, const Point& q, Face_handle f = Face_handle()) const; /// faces incident to the edge pointed to. /// @{ -/*! +/*! Starts at an arbitrary face incident to `v`. */ Face_circulator incident_faces(Vertex_handle v) const; -/*! +/*! Starts at face `f`. \pre Face `f` is incident to vertex `v`. */ Face_circulator incident_faces(Vertex_handle v, Face_handle f) const; -/*! +/*! Starts at an arbitrary edge incident to `v`. */ Edge_circulator incident_edges(Vertex_handle v) const; -/*! +/*! Starts at the first edge of `f` incident to `v`, in counterclockwise order around `v`. \pre Face `f` is incident to vertex `v`. */ Edge_circulator incident_edges(Vertex_handle v, Face_handle f) const; -/*! +/*! Starts at an arbitrary vertex incident to `v`. */ Vertex_circulator incident_vertices(Vertex_handle v) const; -/*! +/*! Starts at the first vertex of `f` adjacent to `v` in counterclockwise order around `v`. \pre Face `f` is incident to vertex `v`. @@ -998,20 +998,20 @@ Vertex_circulator incident_vertices(Vertex_handle v, Face_handle f) ; /// \name Traversal Between Adjacent Faces /// @{ -/*! +/*! returns the vertex of the \f$ i^{th}\f$ neighbor of `f` that is opposite to `f`. \pre \f$ 0\leq i \leq2\f$. */ Vertex_handle mirror_vertex(Face_handle f, int i) const; -/*! +/*! returns the index of `f` in its \f$ i^{th}\f$ neighbor. \pre \f$ 0\leq i \leq2\f$. */ int mirror_index(Face_handle f, int i) const; -/*! +/*! returns the same edge seen from the other adjacent face. \pre \f$ 0\leq i \leq2\f$. */ @@ -1022,24 +1022,24 @@ Edge mirror_edge(Edge e) const; /// \name Miscellaneous /// @{ -/*! +/*! Returns \f$ i+1\f$ modulo 3.\pre \f$ 0\leq i \leq2\f$. */ int ccw(int i) const; -/*! +/*! Returns \f$ i+2\f$ modulo 3.\pre \f$ 0\leq i \leq2\f$. */ int cw(int i) const; -/*! +/*! Returns the triangle formed by the three vertices of `f`. \pre The face is finite. */ Triangle triangle(Face_handle f) const; -/*! +/*! Returns the line segment formed by the vertices `ccw(i)` and `cw(i)` of face `f`. \pre \f$ 0\leq i \leq2\f$. The vertices `ccw(i)` and `cw(i)` of `f` are finite. @@ -1047,28 +1047,28 @@ and `cw(i)` of face `f`. Segment segment(Face_handle f, int i) const; -/*! +/*! Returns the line segment corresponding to edge `e`. \pre `e` is a finite edge. */ Segment segment(const Edge& e) const; -/*! +/*! Returns the line segment corresponding to edge `*ec`. \pre `*ec` is a finite edge. */ Segment segment(const Edge_circulator& ec) const; -/*! +/*! Returns the line segment corresponding to edge `*ei`. \pre `*ei` is a finite edge. */ Segment segment(const Edge_iterator& ei) const; -/*! +/*! Compute the circumcenter of the face pointed to by f. This function is available only if the corresponding function is provided in the geometric traits. @@ -1080,7 +1080,7 @@ Point circumcenter(Face_handle f) const; /// \name Setting /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin This method is meant to be used only if you have done a low-level operation on the underlying tds that invalidated the infinite vertex. @@ -1101,7 +1101,7 @@ void set_infinite_vertex(const Vertex_handle& v); /// \cgalAdvancedEnd /// @{ -/*! +/*! Checks the combinatorial validity of the triangulation and also the validity of its geometric embedding. This method is mainly a debugging help @@ -1115,7 +1115,7 @@ is_valid(bool verbose = false, int level = 0) const; }; /* end Triangulation_2 */ -/*! +/*! Inserts the triangulation into the stream `os`. \pre The insert operator must be defined for `Point`. \relates Triangulation_2 @@ -1123,7 +1123,7 @@ Inserts the triangulation into the stream `os`. ostream& operator<<(ostream& os, const Triangulation_2& T); -/*! +/*! Reads a triangulation from stream `is` and assigns it to the triangulation. \pre The extract operator must be defined for `Point`. @@ -1181,7 +1181,7 @@ public: /// \name Creation /// @{ -/*! +/*! default constructor. */ Triangulation_cw_ccw_2(); @@ -1191,14 +1191,14 @@ Triangulation_cw_ccw_2(); /// \name Operations /// @{ -/*! +/*! returns the index of the neighbor or vertex that is next to the neighbor or vertex with index `i` in counterclockwise order around a face. */ int ccw(const int i) const; -/*! +/*! returns the index of the neighbor or vertex that is next to the neighbor or vertex with index `i` in counterclockwise order around a face. 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 a305703e1be..8456451d6bf 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 @@ -52,27 +52,27 @@ public: /// The following predicates and constructor types are provided /// @{ -/*! +/*! */ typedef Point_3 Point_2; -/*! +/*! */ typedef Segment_3 Segment_2; -/*! +/*! */ typedef Triangle_3 Triangle_2; -/*! +/*! */ typedef Line_3 Line_2; -/*! +/*! A constructor object for `Segment_2`. Provides : @@ -82,7 +82,7 @@ which constructs a segment from two points. */ typedef unspecified_type Construct_segment_2; -/*! +/*! A constructor object for `Triangle_2`. Provides : @@ -92,7 +92,7 @@ which constructs a triangle from three points. */ typedef unspecified_type Construct_triangle_2; -/*! +/*! A constructor object for `Line_2`. Provides : @@ -102,7 +102,7 @@ which constructs a line from two points. */ typedef unspecified_type Construct_line_2; -/*! +/*! A construction object. Provides the operator : @@ -112,7 +112,7 @@ and the projection of `l`. */ typedef unspecified_type Compute_squared_distance_2; -/*! +/*! A construction object. Provides the operator : @@ -128,7 +128,7 @@ middle of the segment `p1``p2`. */ typedef unspecified_type Intersect_2; -/*! +/*! Predicate object. Provides the operator : @@ -141,7 +141,7 @@ according to the */ typedef unspecified_type Compare_x_2; -/*! +/*! Predicate object. Provides the operator : @@ -154,7 +154,7 @@ according to the */ typedef unspecified_type Compare_y_2; -/*! +/*! Predicate object. Provides the operator : @@ -168,7 +168,7 @@ oriented line `pq`. */ typedef unspecified_type Orientation_2; -/*! +/*! Predicate object. Provides the operator : `Oriented_side operator()(Point_2 p, Point_2 q, Point_2 r, Point_2 s)` @@ -181,7 +181,7 @@ and \f$ r\f$. */ typedef unspecified_type Side_of_oriented_circle_2; -/*! +/*! Predicate object. Provides the operator : @@ -197,19 +197,19 @@ typedef unspecified_type Compare_distance_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ Triangulation_euclidean_traits_xy_3(); -/*! +/*! Copy constructor. */ Triangulation_euclidean_traits_xy_3( Triangulation_euclidean_traits_xy_3 tr); -/*! +/*! Assignment operator. */ Triangulation_euclidean_traits_xy_3 operator= @@ -221,54 +221,54 @@ Triangulation_euclidean_traits_xy_3 operator= /// The following access functions are provided /// @{ -/*! +/*! */ Construct_segment_2 construct_segment_2_object(); -/*! +/*! */ Construct_triangle_2 construct_triangle_2_object(); -/*! +/*! */ Construct_line_2 construct_line_2_object(); -/*! +/*! */ Comparison_x_2 compare_x_2_object(); -/*! +/*! */ Comparison_y_2 compare_y_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); -/*! +/*! */ Side_of_oriented_circle_2 side_of_oriented_circle_2_object(); -/*! +/*! */ Compare_distance_2 compare_distance_2_object(); -/*! +/*! */ Intersect_2 intersect_2_object(); -/*! +/*! */ Compute_squared_distance_2 compute_squared_distance_2_object(); 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 776d5030885..1b891de6342 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 @@ -35,7 +35,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Info Info; @@ -45,12 +45,12 @@ typedef Info Info; /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the object of type `Info` stored in the face. */ const Info& info() const; -/*! +/*! Returns a reference to the object of type `Info` stored in the face. */ Info & info(); 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 86254a54741..aa991171fba 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 @@ -39,7 +39,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Info Info; @@ -49,13 +49,13 @@ typedef Info Info; /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the object of type `Info` stored in the vertex. */ const Info& info() const; -/*! +/*! Returns a reference to the object of type `Info` stored in the vertex. */ Info& info(); diff --git a/Triangulation_2/doc/Triangulation_2/CGAL/Weighted_point.h b/Triangulation_2/doc/Triangulation_2/CGAL/Weighted_point.h index f9e0c6d2200..debd4f413d0 100644 --- a/Triangulation_2/doc/Triangulation_2/CGAL/Weighted_point.h +++ b/Triangulation_2/doc/Triangulation_2/CGAL/Weighted_point.h @@ -20,12 +20,12 @@ public: /// \name Types /// @{ -/*! +/*! The point type */ Pt Point; -/*! +/*! The weight type. */ Wt Weight; @@ -35,24 +35,24 @@ Wt Weight; /// \name Creation /// @{ -/*! +/*! copy constructor. */ Weighted_point(Weighted_point wq); -/*! +/*! */ Weighted_point(Point p=Point(), Weight w= Weight(0)); -/*! +/*! Constructs the point from `x` and `y` coordinates, with a weight of 0. Requires that the ambient dimension be 2. */ Weighted_point(FT x, FT y); -/*! +/*! Constructs the point from `x`, `y` and `z` coordinates, with a weight of 0. Requires that the ambient dimension be 3. @@ -64,12 +64,12 @@ Weighted_point(FT x, FT y, FT z); /// \name Access Functions /// @{ -/*! +/*! */ Point point() const; -/*! +/*! */ Weight weight() const; diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h index 38d99d5dde0..e83fb795e92 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationFaceBase_2.h @@ -33,7 +33,7 @@ public: /// \name Access Functions /// @{ -/*! +/*! returns true if the edge between the face and its neighbor `neighbor(i)` is constrained. \pre \f$ 0\leq i \leq2\f$. @@ -45,7 +45,7 @@ bool is_constrained(int i); /// \name Modifiers /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin sets the edge between the face and its neighbor `neighbor(i)` @@ -54,7 +54,7 @@ as a constrained or unconstrained edge according to `b`. */ void set_constraint(int i, bool b); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin sets the status (constrained or unconstrained) of the three edges of the face. @@ -62,7 +62,7 @@ sets the status (constrained or unconstrained) of the three edges of the face. */ void set_constraints(bool c0, bool c1, bool c2); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin changes the orientation of the face by exchanging `vertex(0)` @@ -72,7 +72,7 @@ and the corresponding constrained status. */ void reorient(); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin performs a counterclockwise permutation of the @@ -81,7 +81,7 @@ vertices, neighbors and constrained status of the face. */ void ccw_permute(); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin performs a clockwise permutation of the @@ -95,7 +95,7 @@ void cw_permute(); /// \name Miscellaneous /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h index fadb0486114..70518403f11 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/ConstrainedTriangulationTraits_2.h @@ -36,7 +36,7 @@ public: /// \name Types /// @{ -/*! +/*! A function object whose `operator()` computes the intersection of two segments. `Object_2 operator()(Segment_2 s1, Segment_2 s2);` @@ -48,17 +48,17 @@ typedef unspecified_type Intersect_2; /// When the constrained triangulation is instantiated with the intersection tag `CGAL::Exact_predicates_tag`, the used algorithm needs to be able to compare some distances between points and lines and the following types are further required. /// @{ -/*! +/*! A number type supporting the comparison operator `<`. */ typedef unspecified_type RT; -/*! +/*! The line type. */ typedef unspecified_type Line_2; -/*! +/*! A function object whose `operator()` constructs a line from two points. @@ -66,7 +66,7 @@ constructs a line from two points. */ typedef unspecified_type Construct_line_2; -/*! +/*! A function object whose `operator()` computes the squared distance between a line and a point. @@ -81,18 +81,18 @@ typedef unspecified_type Compute_squared_distance_2; /// \name Access to Constructor Objects /// @{ -/*! +/*! */ Intersect_2 intersect_2_object(); -/*! +/*! required when the intersection tag is `CGAL::Exact_predicates_tag`. */ Construct_line_2 construct_line_2_object(); -/*! +/*! required when the intersection tag is `CGAL::Exact_predicates_tag`. */ diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h index aaa23ed923a..51d31fc43d9 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/DelaunayTriangulationTraits_2.h @@ -37,19 +37,19 @@ public: /// \name Types /// @{ -/*! +/*! The line type. This type is required only if some dual functions are called. */ typedef unspecified_type Line_2; -/*! +/*! The type for ray. This type is required only if some dual functions are called. */ typedef unspecified_type Ray_2; -/*! +/*! A function object to perform an incircle test for a point and three other points. Provides the operator: @@ -61,7 +61,7 @@ with respect to the oriented circle through `p, q` and `r`. */ typedef unspecified_type Side_of_oriented_circle_2; -/*! +/*! A function object to compare two distances for three points. Provides the operator: @@ -73,7 +73,7 @@ than the distance between p and r. This type is only require if */ typedef unspecified_type Compare_distance_2; -/*! +/*! A function object to construct the circumcenter of three points. Provides the operator: @@ -84,7 +84,7 @@ relative to the dual Voronoi diagram are called. */ typedef unspecified_type Construct_circumcenter_2; -/*! +/*! A function object to construct the bisector of two points. Provides the operator: @@ -96,7 +96,7 @@ relative to the dual Voronoi diagram are called. */ typedef unspecified_type Construct_bisector_2; -/*! +/*! A function object to build a ray from a point and a line. Provides the operator: @@ -109,18 +109,18 @@ typedef unspecified_type Construct_ray_2; /// \name Creation /// @{ -/*! +/*! default constructor. */ DelaunayTriangulationTraits_2(); -/*! +/*! copy constructor */ DelaunayTriangulationTraits_2(DelaunayTriangulationTraits_2 dtt); -/*! +/*! Assignment operator. */ DelaunayTriangulationTraits_2 @@ -131,7 +131,7 @@ operator=(traits2); /// \name Access to Predicate and Constructor Objects /// @{ -/*! +/*! */ Side_of_oriented_circle_2 @@ -145,24 +145,24 @@ side_of_oriented_circle_2_object(); /// are called. /// @{ -/*! +/*! */ Compare_distance_2 compare_distance_2_object(); -/*! +/*! */ Construct_circumcenter_2 construct_circumcenter_2_object(); -/*! +/*! */ Construct_bisector_2 construct_bisector_2_object(); -/*! +/*! */ Construct_ray_2 construct_ray_2_object(); diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h index 8323fa04a36..2543e513492 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationFaceBase_2.h @@ -47,7 +47,7 @@ public: /// \name Types /// @{ -/*! +/*! A `std::list` of hidden vertices. */ typedef std::list Vertex_list; @@ -57,7 +57,7 @@ typedef std::list Vertex_list; /// \name Access Functions /// @{ -/*! +/*! Returns a reference to the list of vertices hidden by the face. */ Vertex_list& vertex_list(); diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h index 21c5d4bbd13..2487c6e03ec 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationTraits_2.h @@ -32,18 +32,18 @@ public: /// \name Types /// @{ -/*! +/*! Another name for the point type. */ typedef unspecified_type Bare_point; -/*! +/*! The weighted point type. It has to be a model of the concept `WeightedPoint`. */ typedef unspecified_type Weighted_point_2; -/*! +/*! A function object which must provide operators for the power test applied to two, three, and four points. Must provide the operators: @@ -71,7 +71,7 @@ typedef unspecified_type Power_test_2; /// The following type/predicate is required for a call to `nearest_power_vertex`: /// @{ -/*! +/*! A function object for computing two power distances. Must provide the operator: @@ -81,7 +81,7 @@ power distance between `p` and `r`. */ typedef unspecified_type Compare_power_distance_2; -/*! +/*! A function object which constructs the weighted circumcenter of three weighted points. @@ -92,7 +92,7 @@ Must provide the operator: */ typedef unspecified_type Construct_weighted_circumcenter_2; -/*! +/*! A function object constructs the radical axis of two weighted points. @@ -107,18 +107,18 @@ typedef unspecified_type Construct_radical_axis_2; /// \name Creation /// @{ -/*! +/*! %Default constructor. */ RegularTriangulationTraits_2(); -/*! +/*! Copy constructor. */ RegularTriangulationTraits_2 ( const RegularTriangulatioTraits_2& ); -/*! +/*! Assignment operator. */ RegularTriangulationTraits_2& operator= @@ -129,23 +129,23 @@ RegularTriangulationTraits_2& operator= /// \name Access to Predicate and Constructors Objects /// @{ -/*! +/*! */ Power_test_2 power_test_2_object(); -/*! +/*! */ Compare_power_distance_2 compare_power_distance_2_object(); -/*! +/*! */ Construct_weighted_circumcenter_2 construct_weighted_circumcenter_2_object(); -/*! +/*! */ Construct_radical_axis_2 diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h index 2da59f3a383..d20c09a0f15 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/RegularTriangulationVertexBase_2.h @@ -48,12 +48,12 @@ public: /// \name Access Functions /// @{ -/*! +/*! returns `true`, iff the vertex is hidden. */ bool is_hidden(); -/*! +/*! Mark the vertex as hidden or as not hidden. */ void set_hidden(bool b); diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h index d1192bb4f0d..063b8445e65 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationHierarchyVertexBase_2.h @@ -26,25 +26,25 @@ public: /// \name Operations /// @{ -/*! +/*! returns the corresponding vertex (if any) of the next level triangulation. */ Vertex_handle up(); -/*! +/*! returns the corresponding vertex of the previous level triangulation. */ Vertex_handle down(); -/*! +/*! sets the handle pointing to to the corresponding vertex of the next level triangulation. */ void set_up(Vertex_handle u); -/*! +/*! sets the handle pointing to the corresponding vertex of the previous level triangulation. */ diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h index 39d4912c8ac..34b5cf84263 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationTraits_2.h @@ -26,22 +26,22 @@ public: /// \name Types /// @{ -/*! +/*! The point type. */ typedef unspecified_type Point_2; -/*! +/*! The segment type. */ typedef unspecified_type Segment_2; -/*! +/*! The triangle type. */ typedef unspecified_type Triangle_2; -/*! +/*! A function object to construct a `Segment_2`. Provides: @@ -52,7 +52,7 @@ which constructs a segment from two points. */ typedef unspecified_type Construct_segment_2; -/*! +/*! A function object to construct a `Triangle_2`. Provides: @@ -63,7 +63,7 @@ which constructs a triangle from three points. */ typedef unspecified_type Construct_triangle_2; -/*! +/*! A function object to compare the x-coordinate of two points. Provides the operator: @@ -75,7 +75,7 @@ according to the \f$ x\f$-ordering of points. */ typedef unspecified_type Less_x_2; -/*! +/*! A function object to compare the y-coordinate of two points. Provides the operator: @@ -87,7 +87,7 @@ according to the \f$ y\f$-ordering of points. */ typedef unspecified_type Less_y_2; -/*! +/*! A function object to compare the x-coordinate of two points. Provides the operator: @@ -101,7 +101,7 @@ according to the */ typedef unspecified_type Compare_x_2; -/*! +/*! A function object to compare the y-coordinate of two points. Provides the operator: @@ -114,7 +114,7 @@ according to the */ typedef unspecified_type Compare_y_2; -/*! +/*! A function object to compute the orientation of three points. Provides the operator: @@ -128,7 +128,7 @@ on the left side , on the right side or on the line. */ typedef unspecified_type Orientation_2; -/*! +/*! A function object to perform the incircle test for four points. Provides the operator: @@ -145,7 +145,7 @@ called. */ typedef unspecified_type Side_of_oriented_circle_2; -/*! +/*! A function object to compute the circumcentr of three points. Provides the operator: @@ -166,17 +166,17 @@ typedef unspecified_type Construct_circumcenter_2; /// provided. /// @{ -/*! +/*! default constructor. */ TriangulationTraits_2(); -/*! +/*! Copy constructor */ TriangulationTraits_2(TriangulationTraits_2 gtr); -/*! +/*! Assignment operator. */ TriangulationTraits_2 operator=(TriangulationTraits_2 gtr); @@ -188,32 +188,32 @@ TriangulationTraits_2 operator=(TriangulationTraits_2 gtr); /// constructor objects. /// @{ -/*! +/*! */ Construct_segment_2 construct_segment_2_object(); -/*! +/*! */ Construct_triangle_2 construct_triangle_2_object(); -/*! +/*! */ Comparison_x_2 compare_x_2_object(); -/*! +/*! */ Comparison_y_2 compare_y_2_object(); -/*! +/*! */ Orientation_2 orientation_2_object(); -/*! +/*! Required only if `side_of_oriented_circle` is called called. @@ -221,7 +221,7 @@ called. Side_of_oriented_circle_2 side_of_oriented_circle_2_object(); -/*! +/*! Required only if `circumcenter` is called. */ Construct_circumcenter_2 construct_circumcenter_2_object(); diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h index 1cb5368d90c..26b4e3976b4 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBaseWithInfo_2.h @@ -18,7 +18,7 @@ public: /// \name Types /// @{ -/*! +/*! A type which is `DefaultConstructible` and `Assignable`. */ typedef unspecified_type Info; @@ -28,13 +28,13 @@ typedef unspecified_type Info; /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the object of type `Info` stored in the vertex. */ const Info& info() const; -/*! +/*! Returns a reference to the object of type `Info` stored in the vertex. */ Info& info(); diff --git a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h index 25eb3189106..b5d066b9542 100644 --- a/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h +++ b/Triangulation_2/doc/Triangulation_2/Concepts/TriangulationVertexBase_2.h @@ -29,7 +29,7 @@ public: /// \name Types /// @{ -/*! +/*! Must be the same as the point type `TriangulationTraits_2::Point_2` defined by the geometric traits class of the triangulation. */ @@ -40,12 +40,12 @@ typedef unspecified_type Point; /// \name Creation /// @{ -/*! +/*! constructs a vertex embedded in point `p`. */ TriangulationVertexBase_2(Point p); -/*! +/*! constructs a vertex embedded in point `p` and pointing on face `f`. */ TriangulationVertexBase_2(Point p, Face_handle f); @@ -55,7 +55,7 @@ TriangulationVertexBase_2(Point p, Face_handle f); /// \name Access Functions /// @{ -/*! +/*! returns the point. */ Point point() const; @@ -65,18 +65,18 @@ Point point() const; /// \name Setting /// @{ -/*! +/*! sets the point. */ void set_point(Point p); -/*! +/*! Inputs the non-combinatorial information given by the vertex: the point and other possible information. */ istream& operator>> (istream& is, TriangulationVertexBase_2 & v); -/*! +/*! Outputs the non combinatorial operation given by the vertex: the point and other possible information. */ diff --git a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h index a30951648a3..85984c49ef4 100644 --- a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h +++ b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_data_structure_3.h @@ -43,12 +43,12 @@ public: /// \name Types /// @{ -/*! +/*! Vertex container type. */ typedef Compact_container Vertex_range; -/*! +/*! Cell container type. */ typedef Compact_container Cell_range; @@ -58,22 +58,22 @@ typedef Compact_container Cell_range; /// \name Operations /// @{ -/*! +/*! Returns a reference to the container of cells. */ Cell_range & cells() const; -/*! +/*! Returns a reference to the container of cells. */ Cell_range & cells(); -/*! +/*! Returns a reference to the container of vertices. */ Vertex_range & vertices() const; -/*! +/*! Returns a reference to the container of vertices. */ Vertex_range & vertices(); diff --git a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_utils_3.h b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_utils_3.h index 11abdee50c4..fa5b638c7eb 100644 --- a/Triangulation_3/doc/TDS_3/CGAL/Triangulation_utils_3.h +++ b/Triangulation_3/doc/TDS_3/CGAL/Triangulation_utils_3.h @@ -18,7 +18,7 @@ public: /// \name Operations /// @{ -/*! +/*! In dimension 3, index of the neighbor `n` that is next to the current cell, when turning positively around an oriented edge whose endpoints are indexed `i` and `j`. According to the usual numbering of @@ -28,13 +28,13 @@ opposite to this neighbor `n`. (see Figure \ref Triangulation3figutils). */ static unsigned int next_around_edge(unsigned int i, unsigned int j); -/*! +/*! In dimension 3, index of the `j`'th vertex in counterclockwise order on the face opposite to vertex with `i` of the cell. \pre `( i < 4 ) && ( j < 3 )`. */ static int vertex_triple_index(const int i, const int j); -/*! +/*! Has a meaning only in dimension 2. Computes the index of the vertex that is next to the vertex numbered @@ -44,7 +44,7 @@ Figure \ref Triangulation3figutils). */ static unsigned int ccw(unsigned int i); -/*! +/*! Same for clockwise. */ static unsigned int cw(unsigned int i); diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h index 8fa452e3af1..8fd35376677 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSCellBase_3.h @@ -41,7 +41,7 @@ public: /// A model of the concept `TriangulationDSCellBase_3` has to provide the following types. /// @{ -/*! +/*! This template class has to define a type `Rebind_TDS::%Other` which is the rebound cell, that is, the one whose `Triangulation_data_structure` will be the actually used one. `Rebind_TDS::%Other` will be the real base @@ -51,22 +51,22 @@ class of `Triangulation_data_structure_3::Cell`. template using Rebind_TDS = unspecified_type; -/*! +/*! */ typedef TriangulationDataStructure_3 Triangulation_data_structure; -/*! +/*! */ typedef TriangulationDataStructure_3::Vertex_handle Vertex_handle; -/*! +/*! */ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; -/*! +/*! */ typedef TriangulationDataStructure_3::Cell_data TDS_data; @@ -76,19 +76,19 @@ typedef TriangulationDataStructure_3::Cell_data TDS_data; /// \name Creation /// @{ -/*! +/*! Default constructor */ Cell_base(); -/*! +/*! Initializes the vertices with `v0, v1, v2, v3`. Neighbors are initialized to the default constructed handle. */ Cell_base( Vertex_handle v0, Vertex_handle v1, Vertex_handle v2, Vertex_handle v3); -/*! +/*! Initializes the vertices with `v0, v1, v2, v3` and the neighbors with `n0, n1, n2, n3`. */ @@ -102,47 +102,47 @@ Cell_handle n2, Cell_handle n3); /// \name Access Functions /// @{ -/*! +/*! Returns the vertex `i` of `c`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ Vertex_handle vertex(int i) const; -/*! +/*! Returns the index of `v`. \pre `v` is a vertex of `c` */ int index(Vertex_handle v) const; -/*! +/*! True iff `v` is a vertex of `c`. */ bool has_vertex(Vertex_handle v); -/*! +/*! Returns `true` if `v` is a vertex of `c`, and computes its index `i` in `c`. */ bool has_vertex(Vertex_handle v, int & i) const; -/*! +/*! Returns the neighbor `i` of `c`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ Cell_handle neighbor(int i) const; -/*! +/*! Returns the index of cell `n` in `c`. \pre `n` is a neighbor of `c`. */ int index(Cell_handle n) const; -/*! +/*! Returns `true` if `n` is a neighbor of `c`. */ bool has_neighbor(Cell_handle n); -/*! +/*! Returns `true` if `n` is a neighbor of `c`, and computes its index `i` in `c`. */ @@ -153,35 +153,35 @@ bool has_neighbor(Cell_handle n, int & i) const; /// \name Setting /// @{ -/*! +/*! Sets vertex `i` to `v`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ void set_vertex(int i, Vertex_handle v); -/*! +/*! Sets the vertices to the default constructed handle. */ void set_vertices(); -/*! +/*! Sets the vertices. */ void set_vertices( Vertex_handle v0, Vertex_handle v1, Vertex_handle v2, Vertex_handle v3); -/*! +/*! Sets neighbor `i` to `n`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ void set_neighbor(int i, Cell_handle n); -/*! +/*! Sets the neighbors to the default constructed handle. */ void set_neighbors(); -/*! +/*! Sets the neighbors. */ void set_neighbors(Cell_handle n0, Cell_handle n1, @@ -192,7 +192,7 @@ Cell_handle n2, Cell_handle n3); /// \name Checking /// @{ -/*! +/*! Performs any desired geometric test on a cell. \cgalDebugFunction @@ -215,12 +215,12 @@ bool is_valid(bool verbose = false, int level = 0) const; /// \cgalAdvancedEnd /// @{ -/*! +/*! */ void * for_compact_container() const; -/*! +/*! */ void * & for_compact_container(); @@ -235,12 +235,12 @@ void * & for_compact_container(); /// \cgalAdvancedEnd /// @{ -/*! +/*! */ TDS_data& tds_data(); -/*! +/*! */ const TDS_data& tds_data() const; @@ -250,12 +250,12 @@ const TDS_data& tds_data() const; /// \name I/O /// @{ -/*! +/*! Inputs the possible non combinatorial information given by the cell. */ istream& operator>> (istream& is, TriangulationDSCellBase_3 & c); -/*! +/*! Outputs the possible non combinatorial information given by the cell. */ ostream& operator<< (ostream& os, const TriangulationDSCellBase_3 & c); diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h index 4ccc1934649..c20fae56d8f 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDSVertexBase_3.h @@ -42,7 +42,7 @@ public: /// \name Types /// @{ -/*! +/*! This template class has to define a type `Rebind_TDS::%Other` which is the rebound vertex, that is, the one whose `Triangulation_data_structure` will be the actually used one. `Rebind_TDS::%Other` will be the real base @@ -52,17 +52,17 @@ class of `Triangulation_data_structure_3::Vertex`. template using Rebind_TDS = unspecified_type; -/*! +/*! */ typedef TriangulationDataStructure_3 Triangulation_data_structure; -/*! +/*! */ typedef TriangulationDataStructure_3::Vertex_handle Vertex_handle; -/*! +/*! */ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; @@ -72,12 +72,12 @@ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; /// \name Creation /// @{ -/*! +/*! Default constructor. */ TriangulationVertexBase_3(); -/*! +/*! Constructs a vertex pointing to cell `c`. */ TriangulationVertexBase_3(Cell_handle c); @@ -87,7 +87,7 @@ TriangulationVertexBase_3(Cell_handle c); /// \name Access Functions /// @{ -/*! +/*! Returns the pointer to an incident cell */ Cell_handle cell() const; @@ -97,7 +97,7 @@ Cell_handle cell() const; /// \name Setting /// @{ -/*! +/*! Sets the incident cell. */ void set_cell(Cell_handle c); @@ -107,7 +107,7 @@ void set_cell(Cell_handle c); /// \name Checking /// @{ -/*! +/*! \cgalDebugFunction \cgalDebugBegin Performs any desired test on a vertex. Checks that the @@ -125,22 +125,22 @@ bool is_valid(bool verbose=false, int level=0) const; /// `Compact_container` for the exact requirements. /// @{ -/*! +/*! */ void * for_compact_container() const; -/*! +/*! */ void * & for_compact_container(); -/*! +/*! Inputs the non-combinatorial information given by the vertex. */ istream& operator>> (istream& is, TriangulationDSVertexBase_3 & v); -/*! +/*! Outputs the non-combinatorial information given by the vertex. */ ostream& operator<< (ostream& os, const TriangulationDSVertexBase_3 & v); diff --git a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h index ff8e1a02ccc..dc19ed9a7ec 100644 --- a/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h +++ b/Triangulation_3/doc/TDS_3/Concepts/TriangulationDataStructure_3.h @@ -90,27 +90,27 @@ typedef unspecified_type Vertex; */ typedef unspecified_type Cell; -/*! +/*! Size type (unsigned integral type) */ typedef unspecified_type size_type; -/*! +/*! Difference type (signed integral type) */ typedef unspecified_type difference_type; -/*! +/*! */ typedef unspecified_type Vertex_handle; -/*! +/*! */ typedef unspecified_type Cell_handle; -/*! +/*! This template class allows to get the type of a triangulation data structure that only changes the vertex type. It has to define a type `Rebind_vertex::%Other` which is a rebound triangulation data structure, that is, the @@ -120,7 +120,7 @@ one whose `TriangulationDSVertexBase_3` will be `Vb2`. template using Rebind_vertex = unspecified_type; -/*! +/*! This template class allows to get the type of a triangulation data structure that only changes the cell type. It has to define a type `Rebind_cell::%Other` which is a rebound triangulation data structure, that is, the @@ -130,14 +130,14 @@ one whose `TriangulationDSCellBase_3` will be `Cb2`. template using Rebind_cell = unspecified_type; -/*! +/*! `(c,i,j)` is the edge of cell `c` whose vertices indices are `i` and `j`. (See Section \ref TDS3secintro.) */ typedef Triple Edge; -/*! +/*! `(c,i)` is the facet of `c` opposite to the vertex of index `i`. (See Section \ref TDS3secintro.) @@ -154,22 +154,22 @@ typedef std::pair Facet; /// arguments to the functions. /// @{ -/*! +/*! */ typedef unspecified_type Cell_iterator; -/*! +/*! */ typedef unspecified_type Facet_iterator; -/*! +/*! */ typedef unspecified_type Edge_iterator; -/*! +/*! */ typedef unspecified_type Vertex_iterator; @@ -185,12 +185,12 @@ typedef unspecified_type Vertex_iterator; /// @{ -/*! +/*! */ typedef unspecified_type Facet_circulator; -/*! +/*! */ typedef unspecified_type Cell_circulator; @@ -200,23 +200,23 @@ typedef unspecified_type Cell_circulator; /// \name Creation /// @{ -/*! +/*! Default constructor. */ TriangulationDataStructure_3(); -/*! +/*! Copy constructor. All vertices and cells are duplicated. */ TriangulationDataStructure_3(const TriangulationDataStructure_3 & tds1); -/*! +/*! Assignment operator. All vertices and cells are duplicated, and the former data structure of `tds` is deleted. */ TriangulationDataStructure_3& operator= (const TriangulationDataStructure_3 & tds1); -/*! +/*! `tds1` is copied into `tds`. If `v != Vertex_handle()`, the vertex of `tds` corresponding to `v` is returned, otherwise `Vertex_handle()` is returned. @@ -248,7 +248,7 @@ otherwise `Vertex_handle()` is returned. template Vertex_handle tds.copy_tds(const TDS_src& tds_src, typename TDS_src::Vertex_handle v, const ConvertVertex& convert_vertex, const ConvertCell& convert_cell); -/*! +/*! Swaps `tds` and `tds1`. There is no copy of cells and vertices, thus this method runs in constant time. This method should be preferred to `tds`=`tds1` or `tds`(`tds1`) when `tds1` is deleted after @@ -256,7 +256,7 @@ that. */ void swap(TriangulationDataStructure_3 & tds1); -/*! +/*! Deletes all cells and vertices. `tds` is reset as a triangulation data structure constructed by the default constructor. */ @@ -267,12 +267,12 @@ void clear(); /// \name Access Functions /// @{ -/*! +/*! The dimension of the triangulated topological sphere. */ int dimension() const; -/*! +/*! The number of vertices. Note that the triangulation data structure has one more vertex than an associated geometric triangulation, if there is one, since the infinite vertex is a standard vertex and is thus also @@ -280,7 +280,7 @@ counted. */ size_type number_of_vertices() const; -/*! +/*! The number of cells. Returns 0 if `tds`.`dimension()`\f$ <3\f$. */ size_type number_of_cells() const; @@ -290,12 +290,12 @@ size_type number_of_cells() const; /// \name Non constant-time access functions /// @{ -/*! +/*! The number of facets. Returns 0 if `tds`.`dimension()`\f$ <2\f$. */ size_type number_of_facets() const; -/*! +/*! The number of edges. Returns 0 if `tds`.`dimension()`\f$ <1\f$. */ size_type number_of_edges() const; @@ -305,7 +305,7 @@ size_type number_of_edges() const; /// \name Setting /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Sets the dimension to `n`. @@ -318,19 +318,19 @@ void set_dimension(int n); /// \name Queries /// @{ -/*! +/*! Tests whether `v` is a vertex of `tds`. */ bool is_vertex(Vertex_handle v) const; -/*! +/*! Tests whether `(c,i,j)` is an edge of `tds`. Answers `false` when `dimension()` \f$ <1\f$ . \pre \f$ i,j \in\{0,1,2,3\}\f$ */ bool is_edge(Cell_handle c, int i, int j) const; -/*! +/*! Tests whether `(u,v)` is an edge of `tds`. If the edge is found, it computes a cell `c` having this edge and the indices `i` and `j` of the vertices `u` and `v`, in this order. @@ -338,19 +338,19 @@ and `j` of the vertices `u` and `v`, in this order. bool is_edge(Vertex_handle u, Vertex_handle v, Cell_handle & c, int & i, int & j) const; -/*! +/*! Tests whether `(u,v)` is an edge of `tds`. */ bool is_edge(Vertex_handle u, Vertex_handle v) const; -/*! +/*! Tests whether `(c,i)` is a facet of `tds`. Answers `false` when `dimension()` \f$ <2\f$ . \pre \f$ i \in\{0,1,2,3\}\f$ */ bool is_facet(Cell_handle c, int i) const; -/*! +/*! Tests whether `(u,v,w)` is a facet of `tds`. If the facet is found, it computes a cell `c` having this facet and the indices `i`, `j` and `k` of the vertices `u`, `v` and `w`, in @@ -359,13 +359,13 @@ this order. bool is_facet(Vertex_handle u, Vertex_handle v, Vertex_handle w, Cell_handle & c, int & i, int & j, int & k) const; -/*! +/*! Tests whether `c` is a cell of `tds`. Answers `false` when `dimension()` \f$ <3\f$ . */ bool is_cell(Cell_handle c) const; -/*! +/*! Tests whether `(u,v,w,t)` is a cell of `tds`. If the cell `c` is found, it computes the indices `i`, `j`, `k` and `l` of the vertices `u`, `v`, `w` and `t` in @@ -378,25 +378,25 @@ Cell_handle & c, int & i, int & j, int & k, int & l) const; /// There is a method `has_vertex` in the cell class. The analogous methods for facets are defined here. /// @{ -/*! +/*! If `v` is a vertex of `f`, then `j` is the index of `v` in the cell `f.first`, and the method returns `true`. \pre `tds`.dimension()=3 */ bool has_vertex(const Facet & f, Vertex_handle v, int & j) const; -/*! +/*! Same for facet `(c,i)`. Computes the index `j` of `v` in `c`. */ bool has_vertex(Cell_handle c, int i, Vertex_handle v, int & j) const; -/*! +/*! */ bool has_vertex(const Facet & f, Vertex_handle v) const; -/*! +/*! Same as the first two methods, but these two methods do not return the index of the vertex. */ @@ -408,17 +408,17 @@ bool has_vertex(Cell_handle c, int i, Vertex_handle v) const; /// The following three methods test whether two facets have the same vertices. /// @{ -/*! +/*! */ bool are_equal(const Facet & f, const Facet & g) const; -/*! +/*! */ bool are_equal(Cell_handle c, int i, Cell_handle n, int j) const; -/*! +/*! For these three methods: \pre `tds`.dimension()=3. */ bool are_equal(const Facet & f, Cell_handle n, int j) const; @@ -449,48 +449,48 @@ the affected cells. */ /// @{ -/*! +/*! */ bool flip(Edge e); -/*! +/*! Before flipping, these methods check that edge `e=(c,i,j)` is flippable (which is quite expensive). They return `false` or `true` according to this test. */ bool flip(Cell_handle c, int i, int j); -/*! +/*! */ void flip_flippable(Edge e); -/*! +/*! Should be preferred to the previous methods when the edge is known to be flippable. \pre The edge is flippable. */ void flip_flippable(Cell_handle c, int i, int j); -/*! +/*! */ bool flip(Facet f); -/*! +/*! Before flipping, these methods check that facet `f=(c,i)` is flippable (which is quite expensive). They return `false` or `true` according to this test. */ bool flip(Cell_handle c, int i); -/*! +/*! */ void flip_flippable(Facet f); -/*! +/*! Should be preferred to the previous methods when the facet is known to be flippable. \pre The facet is flippable. @@ -503,7 +503,7 @@ void flip_flippable(Cell_handle c, int i); /// The following modifier member functions guarantee the combinatorial validity of the resulting triangulation. /// @{ -/*! +/*! Creates a new vertex, inserts it in cell `c` and returns its handle. The cell `c` is split into four new cells, each of these cells being formed by the new vertex and a facet of `c`. @@ -511,7 +511,7 @@ formed by the new vertex and a facet of `c`. */ Vertex_handle insert_in_cell(Cell_handle c); -/*! +/*! Creates a new vertex, inserts it in facet `f` and returns its handle. In dimension 3, the two incident cells are split into 3 new cells; in dimension 2, the facet is split into 3 facets. @@ -519,14 +519,14 @@ in dimension 2, the facet is split into 3 facets. */ Vertex_handle insert_in_facet(const Facet & f); -/*! +/*! Creates a new vertex, inserts it in facet `i` of `c` and returns its handle. \pre `tds`.`dimension()` \f$ \geq2\f$, \f$ i \in\{0,1,2,3\}\f$ in dimension 3, \f$ i=3\f$ in dimension 2 and `(c,i)` is a facet of `tds`. */ Vertex_handle insert_in_facet(Cell_handle c, int i); -/*! +/*! Creates a new vertex, inserts it in edge `e` and returns its handle. In dimension 3, all the incident cells are split into 2 new cells; in dimension 2, the 2 @@ -536,14 +536,14 @@ split into 2 new edges. */ Vertex_handle insert_in_edge(Edge e); -/*! +/*! Creates a new vertex, inserts it in edge \f$ (i,j)\f$ of `c` and returns its handle. \pre `tds`.`dimension()` \f$ \geq1\f$. \f$ i\neq j\f$, \f$ i,j \in\{0,1,2,3\}\f$ in dimension 3, \f$ i,j \in\{0,1,2\}\f$ in dimension 2, \f$ i,j \in\{0,1\}\f$ in dimension 1 and `(c,i,j)` is an edge of `tds`. */ Vertex_handle insert_in_edge(Cell_handle c, int i, int j); -/*! +/*! Transforms a triangulation of the sphere \f$ S^d\f$ of \f$ \mathbb{R}^{d+1}\f$ into the triangulation of the sphere \f$ S^{d+1}\f$ of \f$ \mathbb{R}^{d+2}\f$ by adding a new vertex `v`: @@ -571,7 +571,7 @@ A handle to `v` is returned. Vertex_handle insert_increase_dimension(Vertex_handle star = Vertex_handle()); -/*! +/*! Creates a new vertex by starring a hole. It takes an iterator range [`cell_begin`; `cell_end`[ of `Cell_handles` which specifies a set of connected cells (resp. facets in dimension 2) describing a hole. @@ -587,7 +587,7 @@ template Vertex_handle insert_in_hole(CellIt cell_begin, CellIt cell_end, Cell_handle begin, int i); -/*! +/*! Same as above, except that `newv` will be used as the new vertex, which must have been allocated previously with e.g. `create_vertex`. */ @@ -600,7 +600,7 @@ Cell_handle begin, int i, Vertex_handle newv); /// \name Removal /// @{ -/*! +/*! This operation is the reciprocal of `insert_increase_dimension()`. It transforms a triangulation of the sphere \f$ S^d\f$ of \f$ \mathbb{R}^{d+1}\f$ into the triangulation of the sphere \f$ S^{d-1}\f$ of \f$ \mathbb{R}^{d}\f$ by removing the vertex @@ -610,7 +610,7 @@ triangulation of the sphere \f$ S^{d-1}\f$ of \f$ \mathbb{R}^{d}\f$ by removing */ void remove_decrease_dimension(Vertex_handle v, Vertex_handle w = v); -/*! +/*! Removes `v`. The incident simplices of maximal dimension incident to `v` are replaced by a single simplex of the same dimension. This operation is exactly the reciprocal to `tds`.`insert_in_cell(v)` in @@ -627,7 +627,7 @@ Cell_handle remove_from_maximal_dimension_simplex(Vertex_handle v); /// The following operation, decrease_dimension, is necessary when the displacement of a vertex decreases the dimension of the triangulation. /// @{ -/*! +/*! The link of a vertex \f$ v\f$ is formed by the facets disjoint from \f$ v\f$ that are included in the cells incident to \f$ v\f$. When the link of `v = c->vertex(i)` contains all the other vertices, `decrease_dimension` crushes the triangulation of the sphere \f$ S^d\f$ of \f$ \mathbb{R}^{d+1}\f$ onto the @@ -652,7 +652,7 @@ void decrease_dimension(Cell_handle c, int i); /// The following modifiers can affect the validity of the triangulation data structure. /// @{ -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Changes the orientation of all cells of the triangulation data structure. @@ -661,7 +661,7 @@ Changes the orientation of all cells of the triangulation data structure. */ void reorient(); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Adds a copy of the vertex `v` to the triangulation data structure. @@ -669,7 +669,7 @@ Adds a copy of the vertex `v` to the triangulation data structure. */ Vertex_handle create_vertex(const Vertex &v = Vertex()); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Creates a vertex which is a copy of the one pointed to by `v` @@ -678,7 +678,7 @@ and adds it to the triangulation data structure. */ Vertex_handle create_vertex(Vertex_handle v); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Adds a copy of the cell `c` to the triangulation data structure. @@ -686,7 +686,7 @@ Adds a copy of the cell `c` to the triangulation data structure. */ Cell_handle create_cell(const Cell &c = Cell()); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Creates a cell which is a copy of the one pointed to by `c` @@ -695,7 +695,7 @@ and adds it to the triangulation data structure. */ Cell_handle create_cell(Cell_handle c); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Creates a cell and adds it into the triangulation data @@ -706,7 +706,7 @@ being initialized with the default constructed handle. Cell_handle create_cell(Vertex_handle v0, Vertex_handle v1, Vertex_handle v2, Vertex_handle v3); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Creates a cell, initializes its vertices and neighbors, and adds it @@ -718,7 +718,7 @@ Vertex_handle v2, Vertex_handle v3, Cell_handle n0, Cell_handle n1, Cell_handle n2, Cell_handle n3); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Removes the vertex from the triangulation data structure. @@ -727,7 +727,7 @@ Removes the vertex from the triangulation data structure. */ void delete_vertex( Vertex_handle v ); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Removes the cell from the triangulation data structure. @@ -736,7 +736,7 @@ Removes the cell from the triangulation data structure. */ void delete_cell( Cell_handle c ); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Calls `delete_vertex` over an iterator range of value type `Vertex_handle`. @@ -745,7 +745,7 @@ Calls `delete_vertex` over an iterator range of value type `Vertex_handle`. template void delete_vertices(VertexIt first, VertexIt last); -/*! +/*! \cgalAdvancedFunction \cgalAdvancedBegin Calls `delete_cell` over an iterator range of value type `Cell_handle`. @@ -759,53 +759,53 @@ void delete_cells(CellIt first, CellIt last); /// \name Traversing the triangulation /// @{ -/*! +/*! Returns `cells_end()` when `tds.dimension()` \f$ <3\f$. */ Cell_iterator cells_begin() const; -/*! +/*! */ Cell_iterator cells_end() const; -/*! +/*! Low-level access to the cells, does not return `cells_end()` when `tds.dimension()` \f$ <3\f$. */ Cell_iterator raw_cells_begin() const; -/*! +/*! */ Cell_iterator raw_cells_end() const; -/*! +/*! Returns `facets_end()` when `tds.dimension()` \f$ <2\f$. */ Facet_iterator facets_begin() const; -/*! +/*! */ Facet_iterator facets_end() const; -/*! +/*! Returns `edges_end()` when `tds.dimension()` \f$ <1\f$. */ Edge_iterator edges_begin() const; -/*! +/*! */ Edge_iterator edges_end() const; -/*! +/*! */ Vertex_iterator vertices_begin() const; -/*! +/*! */ Vertex_iterator vertices_end() const; @@ -815,30 +815,30 @@ Vertex_iterator vertices_end() const; /// \name Cell and facet circulators /// @{ -/*! +/*! Starts at an arbitrary cell incident to `e`. \pre `tds.dimension()` \f$ =3\f$ */ Cell_circulator incident_cells(const Edge & e) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Cell_circulator incident_cells(Cell_handle c, int i, int j) const; -/*! +/*! Starts at cell `start`. \pre `tds.dimension()` \f$ =3\f$ and `start` is incident to `e`. */ Cell_circulator incident_cells(const Edge & e, Cell_handle start) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Cell_circulator incident_cells(Cell_handle c, int i, int j, Cell_handle start) const; -/*! +/*! Starts at an arbitrary facet incident to `e`. Only defined in dimension 3, though are defined also in dimension 2: @@ -848,7 +848,7 @@ there are only two facets sahring an edge in dimension 2. */ Facet_circulator incident_facets(Edge e) const; -/*! +/*! As above for edge `(i,j)` of `c`. Only defined in dimension 3, though are defined also in dimension 2: @@ -856,7 +856,7 @@ there are only two facets sahring an edge in dimension 2. */ Facet_circulator incident_facets(Cell_handle c, int i, int j) const; -/*! +/*! Starts at facet `start`. Only defined in dimension 3, though are defined also in dimension 2: @@ -866,7 +866,7 @@ there are only two facets sahring an edge in dimension 2. */ Facet_circulator incident_facets(Edge e, Facet start) const; -/*! +/*! Starts at facet of index `f` in `start`. Only defined in dimension 3, though are defined also in dimension 2: @@ -874,7 +874,7 @@ there are only two facets sahring an edge in dimension 2. */ Facet_circulator incident_facets(Edge e, Cell_handle start, int f) const; -/*! +/*! As above for edge `(i,j)` of `c`. Only defined in dimension 3, though are defined also in dimension 2: @@ -883,7 +883,7 @@ there are only two facets sahring an edge in dimension 2. Facet_circulator incident_facets(Cell_handle c, int i, int j, Facet start) const; -/*! +/*! As above for edge `(i,j)` of `c` and facet `(start,f)`. Only defined in dimension 3, though are defined also in dimension 2: @@ -897,7 +897,7 @@ Cell_handle start, int f) const; /// \name Traversal of the incident cells, facets and edges, and the adjacent vertices of a given vertex /// @{ -/*! +/*! Copies the `Cell_handle`s of all cells incident to `v` to the output iterator `cells`. Returns the resulting output iterator. @@ -907,7 +907,7 @@ template OutputIterator incident_cells(Vertex_handle v, OutputIterator cells) const; -/*! +/*! Copies the `Facet`s incident to `v` to the output iterator `facets`. Returns the resulting output iterator. @@ -917,7 +917,7 @@ template OutputIterator incident_facets(Vertex_handle v, OutputIterator facets) const; -/*! +/*! Copies all `Edge`s incident to `v` to the output iterator `edges`. Returns the resulting output iterator. \pre `tds.dimension()` \f$ >0\f$, `v` \f$ \neq\f$ `Vertex_handle()`, `tds.is_vertex(v)`. @@ -926,7 +926,7 @@ template OutputIterator incident_edges(Vertex_handle v, OutputIterator edges) const; -/*! +/*! Copies the `Vertex_handle`s of all vertices adjacent to `v` to the output iterator `vertices`. If `tds.dimension()` \f$ <0\f$, then do nothing. Returns the resulting output iterator. @@ -936,7 +936,7 @@ template OutputIterator adjacent_vertices(Vertex_handle v, OutputIterator vertices) const; -/*! +/*! Returns the degree of a vertex, that is, the number of incident vertices. \pre `v` \f$ \neq\f$ `Vertex_handle()`, `tds.is_vertex(v)`. */ @@ -947,20 +947,20 @@ size_type degree(Vertex_handle v) const; /// \name Traversal between adjacent cells /// @{ -/*! +/*! Returns the index of `c` in its \f$ i^{th}\f$ neighbor. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ int mirror_index(Cell_handle c, int i) const; -/*! +/*! Returns the vertex of the \f$ i^{th}\f$ neighbor of `c` that is opposite to `c`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ Vertex_handle mirror_vertex(Cell_handle c, int i) const; -/*! +/*! Returns the same facet seen from the other adjacent cell. */ Facet mirror_facet(Facet f) const; @@ -970,7 +970,7 @@ Facet mirror_facet(Facet f) const; /// \name Checking /// @{ -/*! +/*! \cgalDebugFunction \cgalDebugBegin Checks the combinatorial validity of the triangulation by checking @@ -984,7 +984,7 @@ a precise indication on the kind of invalidity encountered. */ bool is_valid(bool verbose = false) const; -/*! +/*! \cgalDebugFunction \cgalDebugBegin Checks the local validity of the adjacency relations of the triangulation. @@ -995,7 +995,7 @@ a precise indication on the kind of invalidity encountered. */ bool is_valid(Vertex_handle v, bool verbose = false) const; -/*! +/*! \cgalDebugFunction \cgalDebugBegin Checks the local validity of the adjacency relations of the triangulation. @@ -1006,12 +1006,12 @@ a precise indication on the kind of invalidity encountered. */ bool is_valid(Cell_handle c, bool verbose = false) const; -/*! +/*! Reads a combinatorial triangulation from `is` and assigns it to `tds` */ istream& operator>> (istream& is, TriangulationDataStructure_3 & tds); -/*! +/*! Writes `tds` into the stream `os` */ ostream& operator<< (ostream& os, const TriangulationDataStructure_3 & tds); @@ -1050,22 +1050,22 @@ public: /// `TriangulationDataStructure_3`. /// @{ -/*! +/*! Optional for the triangulation data structure alone. */ typedef unspecified_type Point; -/*! +/*! */ typedef TriangulationDataStructure_3 Triangulation_data_structure; -/*! +/*! */ typedef TriangulationDataStructure_3::Vertex_handle Vertex_handle; -/*! +/*! */ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; @@ -1075,12 +1075,12 @@ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; /// \name Access Functions /// @{ -/*! +/*! Returns a cell of the triangulation having `v` as vertex. */ Cell_handle cell() const; -/*! +/*! Returns the point stored in the vertex. Optional for the triangulation data structure alone. */ @@ -1091,12 +1091,12 @@ Point point() const; /// \name Setting /// @{ -/*! +/*! Sets the incident cell to `c`. */ void set_cell(Cell_handle c); -/*! +/*! Sets the point to `p`. Optional for the triangulation data structure alone. */ @@ -1107,7 +1107,7 @@ void set_point(const Point & p); /// \name Checking /// @{ -/*! +/*! \cgalDebugFunction \cgalDebugBegin Checks the validity of the vertex. Must check that its incident cell @@ -1154,17 +1154,17 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef TriangulationDataStructure_3 Triangulation_data_structure; -/*! +/*! */ typedef TriangulationDataStructure_3::Vertex_handle Vertex_handle; -/*! +/*! */ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; @@ -1174,47 +1174,47 @@ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; /// \name Access Functions /// @{ -/*! +/*! Returns the vertex `i` of `c`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ Vertex_handle vertex(int i) const; -/*! +/*! Returns the index of vertex `v` in `c`. \pre `v` is a vertex of `c`. */ int index(Vertex_handle v) const; -/*! +/*! Returns `true` if `v` is a vertex of `c`. */ bool has_vertex(Vertex_handle v) const; -/*! +/*! Returns `true` if `v` is a vertex of `c`, and computes its index `i` in `c`. */ bool has_vertex(Vertex_handle v, int & i) const; -/*! +/*! Returns the neighbor `i` of `c`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ Cell_handle neighbor(int i) const; -/*! +/*! Returns the index corresponding to neighboring cell `n`. \pre `n` is a neighbor of `c`. */ int index(Cell_handle n) const; -/*! +/*! Returns `true` if `n` is a neighbor of `c`. */ bool has_neighbor(Cell_handle n) const; -/*! +/*! Returns `true` if `n` is a neighbor of `c`, and computes its index `i` in `c`. */ @@ -1226,13 +1226,13 @@ bool has_neighbor(Cell_handle n, int & i) const; /// @{ -/*! +/*! Sets vertex `i` to `v`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ void set_vertex(int i, Vertex_handle v); -/*! +/*! Sets the vertex pointers. */ void set_vertices(Vertex_handle v0, @@ -1240,13 +1240,13 @@ Vertex_handle v1, Vertex_handle v2, Vertex_handle v3); -/*! +/*! Sets neighbor `i` to `n`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ void set_neighbor(int i, Cell_handle n); -/*! +/*! Sets the neighbors pointers. */ void set_neighbors(Cell_handle n0, @@ -1259,7 +1259,7 @@ Cell_handle n3); /// \name Checking /// @{ -/*! +/*! \cgalDebugFunction \cgalDebugBegin User defined local validity checking function. 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 aaa78fcc9f9..22338a6e021 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Delaunay_triangulation_3.h @@ -47,7 +47,7 @@ public: /// @{ -/*! +/*! */ typedef LocationPolicy Location_policy; @@ -59,22 +59,22 @@ In addition to those inherited, the following types are defined, for use by the */ /// @{ -/*! +/*! */ typedef DelaunayTriangulationTraits_3::Line_3 Line; -/*! +/*! */ typedef DelaunayTriangulationTraits_3::Ray_3 Ray; -/*! +/*! */ typedef DelaunayTriangulationTraits_3::Plane_3 Plane; -/*! +/*! */ typedef DelaunayTriangulationTraits_3::Object_3 Object; @@ -84,19 +84,19 @@ typedef DelaunayTriangulationTraits_3::Object_3 Object; /// \name Creation /// @{ -/*! +/*! Creates an empty Delaunay triangulation, possibly specifying a traits class `traits`. */ Delaunay_triangulation_3 (const DelaunayTriangulationTraits_3& traits = DelaunayTriangulationTraits_3()); -/*! +/*! Copy constructor. */ Delaunay_triangulation_3 (const Delaunay_triangulation_3 & dt1); -/*! +/*! Equivalent to constructing an empty triangulation with the optional traits class argument and calling `insert(first,last)`. */ @@ -110,7 +110,7 @@ const DelaunayTriangulationTraits_3& traits = DelaunayTriangulationTraits_3()); /// @{ -/*! +/*! Inserts point `p` in the triangulation and returns the corresponding vertex. Similar to the insertion in a triangulation, but ensures in addition the empty sphere property of all the created faces. @@ -119,12 +119,12 @@ The optional argument `start` is used as a starting place for the search. Vertex_handle insert(const Point & p, Cell_handle start = Cell_handle() ); -/*! +/*! Same as above but uses `hint` as a starting place for the search. */ Vertex_handle insert(const Point & p, Vertex_handle hint); -/*! +/*! Inserts point `p` in the triangulation and returns the corresponding vertex. Similar to the above `insert()` function, but takes as additional parameter the return values of a previous location query. See description of @@ -133,7 +133,7 @@ parameter the return values of a previous location query. See description of Vertex_handle insert(const Point & p, Locate_type lt, Cell_handle loc, int li, int lj); -/*! +/*! Inserts the points in the iterator range `[first,last)`. Returns the number of inserted points. Note that this function is not guaranteed to insert the points following the order of `PointInputIterator`, as `spatial_sort()` @@ -145,7 +145,7 @@ template < class PointInputIterator > std::ptrdiff_t insert(PointInputIterator first, PointInputIterator last); -/*! +/*! Inserts the points in the iterator range `[first,last)`. Returns the number of inserted points. @@ -169,7 +169,7 @@ insert(PointWithInfoInputIterator first, PointWithInfoInputIterator last); /// \name Displacement /// @{ -/*! +/*! if there is not already another vertex placed on `p`, the triangulation is modified such that the new position of vertex `v` is `p`, and `v` is returned. Otherwise, the triangulation is not @@ -178,7 +178,7 @@ modified and the vertex at point `p` is returned. */ Vertex_handle move_if_no_collision(Vertex_handle v, const Point & p); -/*! +/*! same as above if there is no collision. Otherwise, `v` is deleted and the vertex placed on `p` is returned. \pre Vertex `v` must be finite. @@ -206,13 +206,13 @@ decreases drastically, it might be interesting to defragment the */ /// @{ -/*! +/*! Removes the vertex `v` from the triangulation. \pre `v` is a finite vertex of the triangulation. */ void remove(Vertex_handle v); -/*! +/*! Removes the vertices specified by the iterator range `[first, beyond)`. The function `remove(Vertex_handle)` is called over each element of the range. The number of vertices removed is returned. @@ -223,7 +223,7 @@ The number of vertices removed is returned. template < typename InputIterator > int remove(InputIterator first, InputIterator beyond); -/*! +/*! This function has exactly the same result and the same preconditions as `remove(first, beyond)`. The difference is in the implementation and efficiency. This version does not re-triangulate the hole after each point removal but only after removing all vertices. This is more efficient if (and only if) the removed points @@ -240,7 +240,7 @@ int remove_cluster(InputIterator first, InputIterator beyond); /// @{ -/*! +/*! Returns a value indicating on which side of the circumscribed sphere of `c` the point `p` lies. More precisely, it returns: @@ -262,7 +262,7 @@ two previous conditions. Bounded_side side_of_sphere(Cell_handle c, const Point & p) const; -/*! +/*! Returns a value indicating on which side of the circumscribed circle of `f` the point `p` lies. More precisely, it returns: @@ -292,13 +292,13 @@ by `f` and not containing any other point of the triangulation, Bounded_side side_of_circle(const Facet & f, const Point & p) const; -/*! +/*! Same as the previous method for facet `i` of cell `c`. */ Bounded_side side_of_circle(Cell_handle c, int i, const Point & p); -/*! +/*! Returns any nearest vertex to the point `p`, or the default constructed handle if the triangulation is empty. The optional argument `c` is a hint specifying where to start the search. @@ -308,7 +308,7 @@ specifying where to start the search. Vertex_handle nearest_vertex(Point p, Cell_handle c = Cell_handle()); -/*! +/*! Returns the vertex of the cell `c` that is nearest to \f$ p\f$. @@ -326,7 +326,7 @@ A point `p` is said to be in conflict with a cell `c` in dimension 3 (resp.\ a f -/*! +/*! Computes the conflict hole induced by `p`. The starting cell (resp. facet) `c` must be in conflict. Then this function returns respectively in the output iterators: @@ -351,7 +351,7 @@ find_conflicts(Point p, Cell_handle c, OutputIteratorBoundaryFacets bfit, OutputIteratorCells cit); -/*! +/*! Same as the other `find_conflicts()` function, except that it also computes the internal facets, i.e.\ the facets common to two cells which are in conflict with `p`. @@ -381,7 +381,7 @@ OutputIteratorBoundaryFacets bfit, OutputIteratorCells cit, OutputIteratorInternalFacets ifit); -/*! +/*! \deprecated This function is renamed `vertices_on_conflict_zone_boundary` since CGAL-3.8. */ template @@ -389,7 +389,7 @@ OutputIterator vertices_in_conflict(Point p, Cell_handle c, OutputIterator res); -/*! +/*! Similar to `find_conflicts()`, but reports the vertices which are on the boundary of the conflict hole of `p`, in the output iterator `res`. Returns the resulting output iterator. @@ -409,22 +409,22 @@ A face (cell, facet or edge) is said to be a Gabriel face iff its smallest circu */ /// @{ -/*! +/*! */ bool is_Gabriel(Cell_handle c, int i); -/*! +/*! */ bool is_Gabriel(Cell_handle c, int i, int j); -/*! +/*! */ bool is_Gabriel(const Facet& f); -/*! +/*! */ bool is_Gabriel(const Edge& e); @@ -436,13 +436,13 @@ bool is_Gabriel(const Edge& e); */ /// @{ -/*! +/*! Returns the circumcenter of the four vertices of c. \pre `dt`.`dimension()`\f$ =3\f$ and `c` is not infinite. */ Point dual(Cell_handle c) const; -/*! +/*! Returns the dual of facet `f`, which is in dimension 3: either a segment, if the two cells incident to `f` @@ -453,18 +453,18 @@ in dimension 2: a point. */ Object dual(Facet f) const; -/*! +/*! same as the previous method for facet `(c,i)`. */ Object dual(Cell_handle c, int i) const; -/*! +/*! returns the line supporting the dual of the facet. \pre `dt`.`dimension()` \f$ \geq2\f$ and `f` is not infinite. */ Line dual_support(Cell_handle c, int i) const; -/*! +/*! Sends the set of duals to all the facets of `dt` into `os`. */ template Stream & draw_dual(Stream & os); @@ -475,7 +475,7 @@ template Stream & draw_dual(Stream & os); /// These methods are mainly a debugging help for the users of advanced features. /// @{ -/*! +/*! Checks the combinatorial validity of the triangulation and the validity of its geometric embedding (see Section \ref Triangulation3secintro). Also checks that all the @@ -488,7 +488,7 @@ printed. bool is_valid(bool verbose = false) const; -/*! +/*! \cgalDebugFunction \cgalDebugBegin Checks the combinatorial and geometric validity of the cell (see 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 11513257a1f..1b5c4769dda 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Regular_triangulation_3.h @@ -41,13 +41,13 @@ public: /// \name Types /// @{ -/*! +/*! The type for points `p` of weighted points \f$ {p}^{(w)}=(p,w_p)\f$ */ typedef RegularTriangulationTraits_3::Bare_point Bare_point; -/*! +/*! */ typedef RegularTriangulationTraits_3::Weighted_point_3 Weighted_point; @@ -57,20 +57,20 @@ typedef RegularTriangulationTraits_3::Weighted_point_3 Weighted_point; /// \name Creation /// @{ -/*! +/*! Creates an empty regular triangulation, possibly specifying a traits class `traits`. */ Regular_triangulation_3 (const RegularTriangulationTraits_3 & traits = RegularTriangulationTraits_3()); -/*! +/*! Copy constructor. */ Regular_triangulation_3 (const Regular_triangulation_3 & rt1); -/*! +/*! Equivalent to constructing an empty triangulation with the optional traits class argument and calling `insert(first,last)`. \tparam InputIterator must be an input iterator with value type `Weighted_point`. @@ -86,7 +86,7 @@ The following methods, which already exist in `Triangulation_3`, are overloaded */ /// @{ -/*! +/*! Inserts weighted point `p` in the triangulation. The optional argument `start` is used as a starting place for the search. @@ -108,12 +108,12 @@ constructed handle. Vertex_handle insert(const Weighted_point & p, Cell_handle start = Cell_handle() ); -/*! +/*! Same as above but uses `hint` as a starting place for the search. */ Vertex_handle insert(const Weighted_point & p, Vertex_handle hint); -/*! +/*! Inserts weighted point `p` in the triangulation and returns the corresponding vertex. Similar to the above `insert()` function, but takes as additional parameter the return values of a previous location query. See description of @@ -122,7 +122,7 @@ parameter the return values of a previous location query. See description of Vertex_handle insert(const Weighted_point & p, Locate_type lt, Cell_handle loc, int li, int lj); -/*! +/*! Inserts the weighted points in the range `[first,last)`. It returns the difference of the number of vertices between after and before the insertions (it may be negative due to hidden points). @@ -136,7 +136,7 @@ template < class InputIterator > std::ptrdiff_t insert(InputIterator first, InputIterator last); -/*! +/*! Inserts the weighted points in the iterator range `[first,last)`. It returns the difference of the number of vertices between after and @@ -163,7 +163,7 @@ The following methods, which already exist in `Triangulation_3`, are overloaded */ /// @{ -/*! +/*! Creates a new vertex by starring a hole. It takes an iterator range `[cell_begin,cell_end)` of `Cell_handle`s which specifies a hole: a set of connected cells (resp. facets in dimension 2) which is @@ -184,7 +184,7 @@ template Vertex_handle insert_in_hole(Weighted_point p, CellIt cell_begin, CellIt cell_end, Cell_handle begin, int i); -/*! +/*! Same as above, except that `newv` will be used as the new vertex, which must have been allocated previously with, e.g.\ `create_vertex`. */ @@ -197,12 +197,12 @@ Cell_handle begin, int i, Vertex_handle newv); /// \name Removal /// @{ -/*! +/*! Removes the vertex `v` from the triangulation. */ void remove(Vertex_handle v); -/*! +/*! Removes the vertices specified by the iterator range `[first, beyond)`. The function `remove(Vertex_handle)` is called over each element of the range. The number of vertices removed is returned. @@ -224,7 +224,7 @@ Let us remark that \f$ \Pi({p}^{(w)}-{z}^{(w)}) > 0 \f$ is equivalent to `p` lie /// @{ -/*! +/*! Returns the position of the weighted point \f$ p\f$ with respect to the power sphere of `c`. More precisely, it returns: @@ -251,7 +251,7 @@ two previous conditions. Bounded_side side_of_power_sphere(Cell_handle c, const Weighted_point & p) const; -/*! +/*! Returns the position of the point `p` with respect to the power circle of `f`. More precisely, it returns: @@ -304,14 +304,14 @@ Bounded_side side_of_power_circle(const Facet & f, const Weighted_point & p) const; -/*! +/*! Same as the previous method for facet `i` of cell `c`. */ Bounded_side side_of_power_circle(Cell_handle c, int i, const Weighted_point & p) const; -/*! +/*! In dimension 1, returns `ON_BOUNDED_SIDE` if \f$ \Pi({p}^{(w)}-{z(c)}^{(w)})<0\f$, where @@ -327,7 +327,7 @@ Bounded_side side_of_power_segment(Cell_handle c, const Weighted_point & p) const; -/*! +/*! Returns the vertex of the triangulation which is nearest to \f$ p\f$ with respect to the power distance. This means that the power of the query point `p` with respect to the weighted point in @@ -344,7 +344,7 @@ specifying where to start the search. Vertex_handle nearest_power_vertex(Weighted_point p, Cell_handle c = Cell_handle()); -/*! +/*! Returns the vertex of the cell `c` that is nearest to \f$ p\f$ with respect to the power distance. @@ -362,7 +362,7 @@ A weighted point `p` is said to be in conflict with a cell `c` in dimension 3 (r */ /// @{ -/*! +/*! Compute the conflicts with `p`. @@ -390,7 +390,7 @@ OutputIteratorBoundaryFacets bfit, OutputIteratorCells cit, OutputIteratorInternalFacets ifit); -/*! +/*! \deprecated This function is renamed `vertices_on_conflict_zone_boundary` since CGAL-3.8. */ template @@ -398,7 +398,7 @@ OutputIterator vertices_in_conflict(Weighted_point p, Cell_handle c, OutputIterator res); -/*! +/*! Similar to `find_conflicts()`, but reports the vertices which are on the boundary of the conflict zone of `p`, in the output iterator `res`. Returns the resulting output iterator. @@ -410,7 +410,7 @@ OutputIterator vertices_on_conflict_zone_boundary(Weighted_point p, Cell_handle c, OutputIterator res); -/*! +/*! Similar to `find_conflicts()`, but reports the vertices which are in the interior of the conflict zone of `p`, in the output iterator `res`. The vertices that are on the boundary of the conflict zone are @@ -432,27 +432,27 @@ In the weighted setting, a face (cell, facet, edge or vertex) is said to be a Ga */ /// @{ -/*! +/*! */ bool is_Gabriel(Cell_handle c, int i); -/*! +/*! */ bool is_Gabriel(Cell_handle c, int i, int j); -/*! +/*! */ bool is_Gabriel(const Facet& f); -/*! +/*! */ bool is_Gabriel(const Edge& e); -/*! +/*! */ bool is_Gabriel(Vertex_handle v); @@ -464,13 +464,13 @@ bool is_Gabriel(Vertex_handle v); */ /// @{ -/*! +/*! Returns the weighted circumcenter of the four vertices of c. \pre `rt`.`dimension()`\f$ =3\f$ and `c` is not infinite. */ Bare_point dual(Cell_handle c) const; -/*! +/*! Returns the dual of facet `f`, which is in dimension 3: either a segment, if the two cells incident to `f` @@ -481,12 +481,12 @@ in dimension 2: a point. */ Object dual(Facet f) const; -/*! +/*! same as the previous method for facet `(c,i)`. */ Object dual(Cell_handle c, int i) const; -/*! +/*! Sends the set of duals to all the facets of `rt` into `os`. */ template Stream & draw_dual(Stream & os); 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 413ed587356..00e680ad728 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 @@ -37,12 +37,12 @@ public: /// \name Types /// @{ -/*! +/*! The type for point \f$ p\f$ of a weighted point \f$ {p}^{(w)}=(p,w_p)\f$. */ typedef K::Point_3 Bare_point; -/*! +/*! The type for weighted points. */ typedef Weighted_point @@ -53,19 +53,19 @@ Weighted_point_3; /// \name Types for Predicate Functors /// @{ -/*! +/*! A predicate type for power test. Belongs to the `RegularTriangulationTraits_3` concept. */ typedef unspecified_type Power_test_3; -/*! +/*! A predicate type to compare power distance. Belongs to the `RegularTriangulationTraits_3` concept. */ typedef unspecified_type Compare_power_distance_3; -/*! +/*! A predicate type. The operator() takes weighted point(s) as arguments, together with one weight. It compares the weight of the smallest sphere orthogonal to the weighted points with the input weight. @@ -81,7 +81,7 @@ orthogonal to the weighted points with the input weight. */ typedef unspecified_type Compare_weighted_squared_radius_3; -/*! +/*! A predicate type. The operator() takes weighted points as arguments and returns the sign of the power distance of the last one with respect to the smallest sphere orthogonal to the others. @@ -97,7 +97,7 @@ with respect to the smallest sphere orthogonal to the others. */ typedef unspecified_type In_smallest_orthogonal_sphere_3; -/*! +/*! A predicate type. The operator() is similar to the operator() of `In_smallest_orthogonal_sphere_3` except that the returned type is not a `Sign` @@ -115,7 +115,7 @@ corresponding respectively to */ typedef unspecified_type Side_of_bounded_orthogonal_sphere_3; -/*! +/*! A predicate type. The operator() takes weighted points as arguments, considers the subspace of points with equal power distance @@ -143,7 +143,7 @@ typedef unspecified_type Does_simplex_intersect_dual_support_3; /// \name Types for Constructor Functors /// @{ -/*! +/*! A constructor type. The operator() constructs the bare point which is the center of the smallest orthogonal sphere to the input weighted points. @@ -157,7 +157,7 @@ weighted points. */ typedef unspecified_type Construct_weighted_circumcenter_3; -/*! +/*! A functor type. The operator() computes the power distance between its arguments. @@ -166,7 +166,7 @@ arguments. */ typedef unspecified_type Compute_power_product_3; -/*! +/*! A functor type. The operator() computes the squared radius of the smallest sphere orthogonal to the argument(s). @@ -181,7 +181,7 @@ smallest sphere orthogonal to the argument(s). */ typedef unspecified_type Compute_squared_radius_smallest_orthogonal_sphere_3; -/*! +/*! A functor type. The operator() takes weighted points as arguments and computes the squared radius of the sphere centered in the last point and orthogonal @@ -201,60 +201,60 @@ typedef unspecified_type Compute_critical_squared_radius_3; /// \name Operations /// @{ -/*! +/*! */ Power_test_3 power_test_3_object(); -/*! +/*! */ Compare_power_distance_3 compare_power_distance_3_object(); -/*! +/*! */ Compare_weighted_squared_radius_3 compare_weighted_squared_radius_3_object(); -/*! +/*! */ In_smallest_orthogonal_sphere_3 in_smallest_orthogonal_sphere_3_object(); -/*! +/*! */ Side_of_bounded_orthogonal_sphere_3 side_of_bounded_orthogonal_sphere_3_object(); -/*! +/*! */ Does_simplex_intersect_dual_support_3 does_simplex_intersect_dual_support_3_object(); -/*! +/*! */ Construct_weighted_circumcenter_3 construct_weighted_circumcenter_3_object(); -/*! +/*! */ Compute_power_product_3 compute_power_product_3_object() ; -/*! +/*! */ Compute_squared_radius_smallest_orthogonal_sphere_3 compute_squared_radius_smallest_orthogonal_sphere_3_object() ; -/*! +/*! */ Compute_critical_squared_radius_3 diff --git a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h index c51b1b1beaa..087d9b60e42 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_3.h @@ -37,32 +37,32 @@ public: /// The class `Triangulation_3` defines the following types: /// @{ -/*! +/*! */ typedef TriangulationDataStructure_3 Triangulation_data_structure; -/*! +/*! */ typedef TriangulationTraits_3 Geom_traits; -/*! +/*! */ typedef TriangulationTraits_3::Point_3 Point; -/*! +/*! */ typedef TriangulationTraits_3::Segment_3 Segment; -/*! +/*! */ typedef TriangulationTraits_3::Triangle_3 Triangle; -/*! +/*! */ typedef TriangulationTraits_3::Tetrahedron_3 Tetrahedron; @@ -75,22 +75,22 @@ Only vertices (0-faces) and cells (3-faces) are stored. Edges (1-faces) and face /// @{ -/*! +/*! */ typedef TriangulationDataStructure_3::Vertex Vertex; -/*! +/*! */ typedef TriangulationDataStructure_3::Cell Cell; -/*! +/*! */ typedef TriangulationDataStructure_3::Facet Facet; -/*! +/*! */ typedef TriangulationDataStructure_3::Edge Edge; @@ -113,83 +113,83 @@ arguments to the functions. */ /// @{ -/*! +/*! handle to a vertex */ typedef TriangulationDataStructure_3::Vertex_handle Vertex_handle; -/*! +/*! handle to a cell */ typedef TriangulationDataStructure_3::Cell_handle Cell_handle; -/*! +/*! Reference to a simplex (vertex, edge, facet or cell) of the triangulation */ typedef Triangulation_simplex_3 Simplex; -/*! +/*! Size type (an unsigned integral type) */ typedef TriangulationDataStructure_3::size_type size_type; -/*! +/*! Difference type (a signed integral type) */ typedef TriangulationDataStructure_3::difference_type difference_type; -/*! +/*! iterator over cells */ typedef TriangulationDataStructure_3::Cell_iterator All_cells_iterator; -/*! +/*! iterator over facets */ typedef TriangulationDataStructure_3::Facet_iterator All_facets_iterator; -/*! +/*! iterator over edges */ typedef TriangulationDataStructure_3::Edge_iterator All_edges_iterator; -/*! +/*! iterator over vertices */ typedef TriangulationDataStructure_3::Vertex_iterator All_vertices_iterator; -/*! +/*! iterator over finite cells */ typedef unspecified_type Finite_cells_iterator; -/*! +/*! iterator over finite facets */ typedef unspecified_type Finite_facets_iterator; -/*! +/*! iterator over finite edges */ typedef unspecified_type Finite_edges_iterator; -/*! +/*! iterator over finite vertices */ typedef unspecified_type Finite_vertices_iterator; -/*! +/*! iterator over the points corresponding to the finite vertices of the triangulation. */ typedef unspecified_type Point_iterator; -/*! +/*! circulator over all cells incident to a given edge */ typedef TriangulationDataStructure_3::Cell_circulator Cell_circulator; -/*! +/*! circulator over all facets incident to a given edge */ typedef TriangulationDataStructure_3::Facet_circulator Facet_circulator; @@ -199,19 +199,19 @@ typedef TriangulationDataStructure_3::Facet_circulator Facet_circulator; /// \name Creation /// @{ -/*! +/*! Introduces a triangulation `t` having only one vertex which is the infinite vertex. */ Triangulation_3 (const TriangulationTraits_3 & traits = TriangulationTraits_3()); -/*! +/*! Copy constructor. All vertices and faces are duplicated. */ Triangulation_3 (const Triangulation_3 & tr); -/*! +/*! Equivalent to constructing an empty triangulation with the optional traits class argument and calling `insert(first,last)`. */ @@ -224,14 +224,14 @@ const TriangulationTraits_3 & traits = TriangulationTraits_3() ); /// \name Assignment /// @{ -/*! +/*! The triangulation `tr` is duplicated, and modifying the copy after the duplication does not modify the original. The previous triangulation held by `t` is deleted. */ Triangulation_3 & operator=(const Triangulation_3 & tr); -/*! +/*! The triangulations `tr` and `t` are swapped. `t.swap(tr)` should be preferred to `t = tr` or to `t(tr)` if `tr` is deleted after that. Indeed, there is no @@ -239,12 +239,12 @@ copy of cells and vertices, thus this method runs in constant time. */ void swap(Triangulation_3 & tr); -/*! +/*! Deletes all finite vertices and all cells of `t`. */ void clear(); -/*! +/*! Equality operator. Returns true iff there exist a bijection between the vertices of `t1` and those of `t2` and a bijection between the cells of `t1` and those of `t2`, which preserve the geometry of the @@ -255,7 +255,7 @@ a permutation of their vertices). template < class GT, class Tds1, class Tds2 > bool operator==(const Triangulation_3 & t1, const Triangulation_3 & t2); -/*! +/*! The opposite of `operator==`. */ template < class GT, class Tds1, class Tds2 > @@ -266,18 +266,18 @@ bool operator!=(const Triangulation_3 & t1, const Triangulation_3 Vertex_handle insert_in_hole(Point p, CellIt cell_begin, CellIt cell_end, Cell_handle begin, int i); -/*! +/*! Same as above, except that `newv` will be used as the new vertex, which must have been allocated previously with e.g.\ `create_vertex`. */ @@ -971,107 +971,107 @@ The following iterators allow the user to visit cells, facets, edges and vertice */ /// @{ -/*! +/*! Starts at an arbitrary finite vertex. Then `++` and `-` will iterate over finite vertices. Returns `finite_vertices_end()` when `t.number_of_vertices() == 0`. */ Finite_vertices_iterator finite_vertices_begin() const; -/*! +/*! Past-the-end iterator */ Finite_vertices_iterator finite_vertices_end() const; -/*! +/*! Starts at an arbitrary finite edge. Then `++` and `-` will iterate over finite edges. Returns `finite_edges_end()` when `t.dimension() < 1`. */ Finite_edges_iterator finite_edges_begin() const; -/*! +/*! Past-the-end iterator */ Finite_edges_iterator finite_edges_end() const; -/*! +/*! Starts at an arbitrary finite facet. Then `++` and `-` will iterate over finite facets. Returns `finite_facets_end()` when `t.dimension() < 2`. */ Finite_facets_iterator finite_facets_begin() const; -/*! +/*! Past-the-end iterator */ Finite_facets_iterator finite_facets_end() const; -/*! +/*! Starts at an arbitrary finite cell. Then `++` and `-` will iterate over finite cells. Returns `finite_cells_end()` when `t.dimension() < 3`. */ Finite_cells_iterator finite_cells_begin() const; -/*! +/*! Past-the-end iterator */ Finite_cells_iterator finite_cells_end() const; -/*! +/*! Starts at an arbitrary vertex. Iterates over all vertices (even the infinite one). Returns `vertices_end()` when `t.number_of_vertices() == 0`. */ All_vertices_iterator all_vertices_begin() const; -/*! +/*! Past-the-end iterator */ All_vertices_iterator all_vertices_end() const; -/*! +/*! Starts at an arbitrary edge. Iterates over all edges (even infinite ones). Returns `edges_end()` when `t.dimension() < 1`. */ All_edges_iterator all_edges_begin() const; -/*! +/*! Past-the-end iterator */ All_edges_iterator all_edges_end() const; -/*! +/*! Starts at an arbitrary facet. Iterates over all facets (even infinite ones). Returns `facets_end()` when `t.dimension() < 2`. */ All_facets_iterator all_facets_begin() const; -/*! +/*! Past-the-end iterator */ All_facets_iterator all_facets_end() const; -/*! +/*! Starts at an arbitrary cell. Iterates over all cells (even infinite ones). Returns `cells_end()` when `t.dimension() < 3`. */ All_cells_iterator all_cells_begin() const; -/*! +/*! Past-the-end iterator */ All_cells_iterator all_cells_end() const; -/*! +/*! Iterates over the points of the triangulation. */ Point_iterator points_begin() const; -/*! +/*! Past-the-end iterator */ Point_iterator points_end() const; @@ -1083,66 +1083,66 @@ The following circulators respectively visit all cells or all facets incident to */ /// @{ -/*! +/*! Starts at an arbitrary cell incident to `e`. \pre `t.dimension() == 3`. */ Cell_circulator incident_cells(Edge e) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Cell_circulator incident_cells(Cell_handle c, int i, int j) const; -/*! +/*! Starts at cell `start`. \pre `t.dimension() == 3` and `start` is incident to `e`. */ Cell_circulator incident_cells(Edge e, Cell_handle start) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Cell_circulator incident_cells(Cell_handle c, int i, int j, Cell_handle start) const; /// @} -/*! +/*! \name The following circulators on facets are defined only in dimension 3, though facets are defined also in dimension 2: there are only two facets sharing an edge in dimension 2. */ /// @{ -/*! +/*! Starts at an arbitrary facet incident to `e`. \pre `t.dimension() == 3` */ Facet_circulator incident_facets(Edge e) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Facet_circulator incident_facets(Cell_handle c, int i, int j) const; -/*! +/*! Starts at facet `start`. \pre `start` is incident to `e`. */ Facet_circulator incident_facets(Edge e, Facet start) const; -/*! +/*! Starts at facet of index `f` in `start`. */ Facet_circulator incident_facets(Edge e, Cell_handle start, int f) const; -/*! +/*! As above for edge `(i,j)` of `c`. */ Facet_circulator incident_facets(Cell_handle c, int i, int j, Facet start) const; -/*! +/*! As above for edge `(i,j)` of `c` and facet `(start,f)`. */ Facet_circulator incident_facets(Cell_handle c, int i, int j, @@ -1154,7 +1154,7 @@ Cell_handle start, int f) const; /// @{ -/*! +/*! Copies the `Cell_handle`s of all cells incident to `v` to the output iterator `cells`. Returns the resulting output iterator. @@ -1164,7 +1164,7 @@ template OutputIterator incident_cells(Vertex_handle v, OutputIterator cells) const; -/*! +/*! Copies the `Cell_handle`s of all finite cells incident to `v` to the output iterator `cells`. Returns the resulting output iterator. @@ -1174,7 +1174,7 @@ template OutputIterator finite_incident_cells(Vertex_handle v, OutputIterator cells) const; -/*! +/*! Copies all `Facet`s incident to `v` to the output iterator `facets`. Returns the resulting output iterator. @@ -1184,7 +1184,7 @@ template OutputIterator incident_facets(Vertex_handle v, OutputIterator facets) const; -/*! +/*! Copies all finite `Facet`s incident to `v` to the output iterator `facets`. Returns the resulting output iterator. @@ -1194,7 +1194,7 @@ template OutputIterator finite_incident_facets(Vertex_handle v, OutputIterator facets) const; -/*! +/*! Copies all `Edge`s incident to `v` to the output iterator `edges`. Returns the resulting output iterator. \pre `t.dimension() > 0`, `v != Vertex_handle()`, `t.is_vertex(v)`. @@ -1203,7 +1203,7 @@ template OutputIterator incident_edges(Vertex_handle v, OutputIterator edges) const; -/*! +/*! Copies all finite `Edge`s incident to `v` to the output iterator `edges`. Returns the resulting output iterator. \pre `t.dimension() > 0`, `v != Vertex_handle()`, `t.is_vertex(v)`. @@ -1212,7 +1212,7 @@ template OutputIterator finite_incident_edges(Vertex_handle v, OutputIterator edges) const; -/*! +/*! Copies the `Vertex_handle`s of all vertices adjacent to `v` to the output iterator `vertices`. If `t.dimension() < 0`, then do nothing. Returns the resulting output iterator. @@ -1222,7 +1222,7 @@ template OutputIterator adjacent_vertices(Vertex_handle v, OutputIterator vertices) const; -/*! +/*! Copies the `Vertex_handle`s of all finite vertices adjacent to `v` to the output iterator `vertices`. If `t.dimension() < 0`, then do nothing. Returns the resulting output iterator. @@ -1232,7 +1232,7 @@ template OutputIterator finite_adjacent_vertices(Vertex_handle v, OutputIterator vertices) const; -/*! +/*! Returns the degree of a vertex, that is, the number of incident vertices. The infinite vertex is counted. \pre `v != Vertex_handle()`, `t.is_vertex(v)`. @@ -1244,20 +1244,20 @@ size_type degree(Vertex_handle v) const; /// \name Traversal Between Adjacent Cells /// @{ -/*! +/*! Returns the index of `c` in its \f$ i^{th}\f$ neighbor. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ int mirror_index(Cell_handle c, int i) const; -/*! +/*! Returns the vertex of the \f$ i^{th}\f$ neighbor of `c` that is opposite to `c`. \pre \f$ i \in\{0, 1, 2, 3\}\f$. */ Vertex_handle mirror_vertex(Cell_handle c, int i) const; -/*! +/*! Returns the same facet seen from the other adjacent cell. */ Facet mirror_facet(Facet f) const; @@ -1271,7 +1271,7 @@ Facet mirror_facet(Facet f) const; /// methods to help debugging. /// @{ -/*! +/*! \cgalDebugFunction \cgalDebugBegin Checks the combinatorial validity of the triangulation. Checks also the @@ -1284,7 +1284,7 @@ messages describing the first invalidity encountered are printed. bool is_valid(bool verbose = false) const; -/*! +/*! \cgalDebugFunction \cgalDebugBegin Checks the combinatorial validity of the cell by calling the @@ -1322,7 +1322,7 @@ for faces of maximal dimension instead of cells. */ /// @{ -/*! +/*! Reads the underlying combinatorial triangulation from `is` by calling the corresponding input operator of the triangulation data structure class (note that the infinite vertex is numbered 0), and the @@ -1334,7 +1334,7 @@ of the vertex and cell types. Assigns the resulting triangulation to */ istream& operator>> (istream& is, Triangulation_3 &t); -/*! +/*! Writes the triangulation `t` into `os`. */ ostream& operator<< (ostream& os, const Triangulation_3 &t); 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 9cca732ead2..13e23fc09b2 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 @@ -32,7 +32,7 @@ public: /// \name Access Functions /// @{ -/*! +/*! Computes the circumcenter of the tetrahedron, or retrieve it if already computed. */ 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 302af3a510a..545fe055386 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 @@ -34,7 +34,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Info Info; @@ -44,12 +44,12 @@ typedef Info Info; /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the object of type `Info` stored in the cell. */ const Info& info() const; -/*! +/*! Returns a reference to the object of type `Info` stored in the cell. */ Info & info(); 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 9f9e41d366d..963c763b576 100644 --- a/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_simplex_3.h +++ b/Triangulation_3/doc/Triangulation_3/CGAL/Triangulation_simplex_3.h @@ -25,68 +25,68 @@ public: /// \name Types /// @{ -/*! +/*! The simplex class itself. */ typedef Triangulation_simplex_3 Simplex; -/*! +/*! */ typedef Triangulation_3::Vertex_handle Vertex_handle; -/*! +/*! */ typedef Triangulation_3::Edge Edge; -/*! +/*! */ typedef Triangulation_3::Facet Facet; -/*! +/*! */ typedef Triangulation_3::Cell_handle Cell_handle; -/*! +/*! */ typedef Triangulation_3::Cell_circulator Cell_circulator; -/*! +/*! */ typedef Triangulation_3::Facet_circulator Facet_circulator; -/*! +/*! */ typedef Triangulation_3::Edge_iterator Edge_iterator; -/*! +/*! */ typedef Triangulation_3::Facet_iterator Facet_iterator; -/*! +/*! */ typedef Triangulation_3::Finite_vertices_iterator Finite_vertices_iterator; -/*! +/*! */ typedef Triangulation_3::Finite_edges_iterator Finite_edges_iterator; -/*! +/*! */ typedef Triangulation_3::Finite_facets_iterator Finite_facets_iterator; -/*! +/*! */ typedef Triangulation_3::Finite_cells_iterator Finite_cells_iterator; @@ -96,48 +96,48 @@ typedef Triangulation_3::Finite_cells_iterator Finite_cells_iterator; /// \name Creation /// @{ -/*! +/*! Initializes the simplex to an invalid simplex. */ Triangulation_simplex_3(); -/*! +/*! */ Triangulation_simplex_3(Vertex_handle vh); -/*! +/*! */ Triangulation_simplex_3(Edge e); -/*! +/*! */ Triangulation_simplex_3(Facet f); -/*! +/*! */ Triangulation_simplex_3(Cell_handle ch); -/*! +/*! */ Triangulation_simplex_3(Cell_circulator ccir); -/*! +/*! */ Triangulation_simplex_3(Facet_circulator fcir); -/*! +/*! */ Triangulation_simplex_3(Edge_iterator eit); -/*! +/*! */ Triangulation_simplex_3(Facet_iterator fit); @@ -147,50 +147,50 @@ Triangulation_simplex_3(Facet_iterator fit); /// \name Operations /// @{ -/*! +/*! returns the dimension of the simplex. */ int dimension () const; -/*! +/*! Returns the `Vertex_handle` stored in the simplex. \pre dimension() == 0 */ operator Vertex_handle () const; -/*! +/*! Returns the `Edge` stored in the simplex. \pre dimension() == 1 */ operator Edge () const; -/*! +/*! Returns the `Facet` stored in the simplex. \pre dimension() == 2 */ operator Facet () const; -/*! +/*! Returns the `Cell_handle` stored in the simplex. \pre dimension() == 3 */ operator Cell_handle () const; -/*! +/*! Returns a cell incident to the simplex. */ Cell_handle incident_cell () const; -/*! +/*! Test whether two simplices are equal. */ bool operator==(const Triangulation_simplex_3 &s1); -/*! +/*! Defines a ordering on the simplices. This ordering depends on the memory layout and is independent of the geometry. Therefore, the ordering is not intrinsic 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 5991cd13bdf..036630fb1af 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 @@ -38,7 +38,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef TriangulationTraits_3::Point_3 Point; 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 11d92d7e9fd..993704c650c 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 @@ -33,7 +33,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef Info Info; @@ -43,13 +43,13 @@ typedef Info Info; /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the object of type `Info` stored in the vertex. */ const Info& info() const; -/*! +/*! Returns a reference to the object of type `Info` stored in the vertex. */ Info& info(); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h index 7ef6b627f21..db065178a15 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/DelaunayTriangulationTraits_3.h @@ -31,22 +31,22 @@ public: /// @{ -/*! +/*! The line type. */ typedef unspecified_type Line_3; -/*! +/*! The object type. */ typedef unspecified_type Object_3; -/*! +/*! The ray type. */ typedef unspecified_type Ray_3; -/*! +/*! A predicate object that must provide the function operator `Bounded_side operator()(Point p, Point q, Point r, Point s)`, @@ -57,7 +57,7 @@ by `p`, `q`, and `r` on which `s` lies. */ typedef unspecified_type Coplanar_side_of_bounded_circle_3; -/*! +/*! A predicate object that must provide the function operator `Oriented_side operator()(Point p, Point q, Point r, Point s, Point t)`, @@ -67,7 +67,7 @@ which determines on which side of the oriented sphere circumscribing */ typedef unspecified_type Side_of_oriented_sphere_3; -/*! +/*! A predicate object that must provide the function operator `Comparison_result operator()(Point p, Point q, Point r)`, @@ -88,7 +88,7 @@ typedef unspecified_type Compare_distance_3; */ /// @{ -/*! +/*! A constructor object that must provide the function operator `Point_3 operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, @@ -105,7 +105,7 @@ which constructs the circumcenter of three points. */ typedef unspecified_type Construct_circumcenter_3; -/*! +/*! A constructor object that must provide the function operators `Object_3 operator()(Point_3 p)`, @@ -118,7 +118,7 @@ that construct an object respectively from a point, a segment and a ray. */ typedef unspecified_type Construct_object_3; -/*! +/*! A constructor object that must provide the function operator `Line_3 operator()(Point_3 p1, Point_3 p2, Point_3 p3)`, @@ -128,7 +128,7 @@ which constructs the line which is at the same distance from the three points. */ typedef unspecified_type Construct_equidistant_line_3; -/*! +/*! A constructor object that must provide the function operator `Ray_3 operator()(Point_3 p, Line_3 l)`, @@ -143,12 +143,12 @@ typedef unspecified_type Construct_ray_3; /// The following functions give access to the predicate and construction objects: /// @{ -/*! +/*! */ Coplanar_side_of_bounded_circle_3 coplanar_side_of_bounded_circle_3_object(); -/*! +/*! */ Side_of_oriented_sphere_3 side_of_oriented_sphere_3_object(); @@ -161,7 +161,7 @@ When using the `Fast_location` policy or the `CGAL::Delaunay_trioangulation_3::n */ /// @{ -/*! +/*! */ Compare_distance_3 compare_distance_3_object(); @@ -175,22 +175,22 @@ The following functions must be provided only if the methods of `Delaunay_triang */ /// @{ -/*! +/*! */ Construct_circumcenter_3 construct_circumcenter_3_object(); -/*! +/*! */ Construct_object_3 construct_object_3_object(); -/*! +/*! */ Construct_equidistant_line_3 construct_equidistant_line_object(); -/*! +/*! */ Construct_ray_3 construct_ray_3_object(); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h index f92847ed881..97d1930ac38 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationCellBase_3.h @@ -46,13 +46,13 @@ public: /// \name Types /// @{ -/*! +/*! Must be the same as the point type `TriangulationTraits_3::Point_3` defined by the geometric traits class of the triangulation. */ typedef unspecified_type Point; -/*! +/*! Iterator of value type Point */ typedef unspecified_type Point_iterator; @@ -62,12 +62,12 @@ typedef unspecified_type Point_iterator; /// \name Access Functions /// @{ -/*! +/*! Returns an iterator pointing to the first hidden point. */ Point_iterator hidden_points_begin(); -/*! +/*! Returns a past-the-end iterator. */ Point_iterator hidden_points_end(); @@ -77,7 +77,7 @@ Point_iterator hidden_points_end(); /// \name Setting /// @{ -/*! +/*! Adds `p` to the set of hidden points of the cell. */ void hide_point(const Point & p); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h index e66478137ad..e77f278f11b 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/RegularTriangulationTraits_3.h @@ -24,22 +24,22 @@ public: /// \name Types /// @{ -/*! +/*! The line type. */ typedef unspecified_type Line_3; -/*! +/*! The object type. */ typedef unspecified_type Object_3; -/*! +/*! The plane type. */ typedef unspecified_type Plane_3; -/*! +/*! The ray type. */ typedef unspecified_type Ray_3; @@ -55,17 +55,17 @@ or the weighted point \f$ {p}^{(w)}=(p,w_p)\f$. */ /// @{ -/*! +/*! The weighted point type. */ typedef unspecified_type Weighted_point_3; -/*! +/*! The (un-weighted) point type. */ typedef unspecified_type Bare_point; -/*! +/*! A predicate object which must provide the following function operators: `Oriented_side operator()( Weighted_point_3 p, Weighted_point_3 q, Weighted_point_3 r, Weighted_point_3 s, Weighted_point_3 t)`, @@ -118,7 +118,7 @@ have equal coordinates, then it returns the comparison of the weights typedef unspecified_type Power_test_3; -/*! +/*! A predicate object that must provide the function operator `Comparison_result operator()(Point_3 p, Weighted_point_3 q, Weighted_point_3 r)`, @@ -133,7 +133,7 @@ issued. */ typedef unspecified_type Compare_power_distance_3; -/*! +/*! A constructor type. The operator() constructs the bare point which is the center of the smallest orthogonal sphere to the input weighted points. @@ -145,7 +145,7 @@ weighted points. */ typedef unspecified_type Construct_weighted_circumcenter_3; -/*! +/*! A constructor object that must provide the function operators `Object_3 operator()(Point_3 p)`, @@ -160,7 +160,7 @@ that construct an object respectively from a point, a segment and a ray. */ typedef unspecified_type Construct_object_3; -/*! +/*! A constructor object that must provide the function operator `Line_3 operator()(Plane_3 pl, Point_3 p)`, @@ -171,7 +171,7 @@ which constructs the line perpendicular to `pl` passing through `p`. */ typedef unspecified_type Construct_perpendicular_line_3; -/*! +/*! A constructor object that must provide the function operator `Plane_3 operator()(Point_3 p, Point_3 q, Point_3 r)`, @@ -183,7 +183,7 @@ which constructs the plane passing through `p`, `q` and `r`. */ typedef unspecified_type Construct_plane_3; -/*! +/*! A constructor object that must provide the function operator `Ray_3 operator()(Point_3 p, Line_3 l)`, @@ -199,12 +199,12 @@ typedef unspecified_type Construct_ray_3; /// \name Operations /// @{ -/*! +/*! */ Power_test_3 power_test_3_object(); -/*! +/*! /// @} @@ -217,22 +217,22 @@ The following functions must be provided only if the member functions of */ Construct_weighted_circumcenter_3 construct_weighted_circumcenter_3_object(); -/*! +/*! */ Construct_object_3 construct_object_3_object(); -/*! +/*! */ Construct_perpendicular_line_3 construct_perpendicular_line_object(); -/*! +/*! */ Construct_plane_3 construct_plane_3_object(); -/*! +/*! */ Construct_ray_3 construct_ray_3_object(); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h index 14ef609228e..90335ae359b 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationCellBase_3.h @@ -24,7 +24,7 @@ in this case, and only when the dual functions are called. class TriangulationCellBase_3 { public: -/*! +/*! Returns the circumcenter. */ const DelaunayTriangulationTraits_3::Point_3& circumcenter( diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h index d2bbe1ce48f..992471f1061 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationHierarchyVertexBase_3.h @@ -21,12 +21,12 @@ public: /// \name Access Functions /// @{ -/*! +/*! Returns the `Vertex_handle` pointing to the level above. */ Vertex_handle up() const; -/*! +/*! Returns the `Vertex_handle` pointing to the level below. */ Vertex_handle down() const; @@ -36,12 +36,12 @@ Vertex_handle down() const; /// \name Setting /// @{ -/*! +/*! Sets the `Vertex_handle` pointing to the level above to `v`. */ void set_up(Vertex_handle v); -/*! +/*! Sets the `Vertex_handle` pointing to the level below to `v`. */ void set_down(Vertex_handle v); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h index f2ae333a2c6..555e2d71511 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationTraits_3.h @@ -25,28 +25,28 @@ public: /// \name Types /// @{ -/*! +/*! The point type. It must be `DefaultConstructible`, `CopyConstructible` and `Assignable`. */ typedef unspecified_type Point_3; -/*! +/*! The segment type. */ typedef unspecified_type Segment_3; -/*! +/*! The tetrahedron type. */ typedef unspecified_type Tetrahedron_3; -/*! +/*! The triangle type. */ typedef unspecified_type Triangle_3; -/*! +/*! A constructor object that must provide the function operator `Segment_3 operator()(Point_3 p, Point_3 q)`, @@ -55,7 +55,7 @@ which constructs a segment from two points. */ typedef unspecified_type Construct_segment_3; -/*! +/*! A constructor object that must provide the function operator `Triangle_3 operator()(Point_3 p, Point_3 q, Point_3 r )`, @@ -64,7 +64,7 @@ which constructs a triangle from three points. */ typedef unspecified_type Construct_triangle_3; -/*! +/*! A constructor object that must provide the function operator `Tetrahedron_3 operator()(Point_3 p, Point_3 q, Point_3 r, Point_3 s)`, @@ -73,7 +73,7 @@ which constructs a tetrahedron from four points. */ typedef unspecified_type Construct_tetrahedron_3; -/*! +/*! A predicate object that must provide the function operator `Comparison_result operator()(Point p, Point q)`, @@ -83,7 +83,7 @@ return a consistent order for any two points chosen in a same line. */ typedef unspecified_type Compare_xyz_3; -/*! +/*! A predicate object that must provide the function operator `Orientation operator()(Point p, Point q, Point r)`, @@ -94,7 +94,7 @@ return a consistent orientation for any three points chosen in a same plane. */ typedef unspecified_type Coplanar_orientation_3; -/*! +/*! A predicate object that must provide the function operator `Orientation operator()(Point p, Point q, Point r, Point s)`, @@ -111,12 +111,12 @@ typedef unspecified_type Orientation_3; /// \name Creation /// @{ -/*! +/*! Default constructor. */ Triangulation_traits_3(); -/*! +/*! Copy constructor. */ Triangulation_traits_3(const Triangulation_traits_3 & tr); @@ -127,32 +127,32 @@ Triangulation_traits_3(const Triangulation_traits_3 & tr); /// The following functions give access to the predicate and construction objects: /// @{ -/*! +/*! */ Construct_tetrahedron_3 construct_tetrahedron_3_object(); -/*! +/*! */ Construct_triangle_3 construct_triangle_3_object(); -/*! +/*! */ Construct_segment_3 construct_segment_3_object(); -/*! +/*! */ Compare_xyz_3 compare_xyz_3_object(); -/*! +/*! */ Coplanar_orientation_3 coplanar_orientation_3_object(); -/*! +/*! */ Orientation_3 orientation_3_object(); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h index 534253d9e35..3705f9cc3ab 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBaseWithInfo_3.h @@ -18,7 +18,7 @@ public: /// \name Types /// @{ -/*! +/*! A type which is `DefaultConstructible` and `Assignable`. */ typedef unspecified_type Info; @@ -28,13 +28,13 @@ typedef unspecified_type Info; /// \name Access Functions /// @{ -/*! +/*! Returns a const reference to the object of type `Info` stored in the vertex. */ const Info& info() const; -/*! +/*! Returns a reference to the object of type `Info` stored in the vertex. */ Info& info(); diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h index f4fca6a01cb..5f678d38b5a 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/TriangulationVertexBase_3.h @@ -22,7 +22,7 @@ public: /// \name Types /// @{ -/*! +/*! Must be the same as the point type `TriangulationTraits_3::Point_3` defined by the geometric traits class of the triangulation. */ @@ -33,12 +33,12 @@ typedef unspecified_type Point; /// \name Creation /// @{ -/*! +/*! Constructs a vertex whose geometric embedding is point `p`. */ TriangulationVertexBase_3(const Point & p); -/*! +/*! Constructs a vertex embedding the point `p` and pointing to cell `c`. */ TriangulationVertexBase_3(const Point & p, Cell_handle c); @@ -48,7 +48,7 @@ TriangulationVertexBase_3(const Point & p, Cell_handle c); /// \name Access Functions /// @{ -/*! +/*! Returns the point. */ Point point() const; @@ -58,7 +58,7 @@ Point point() const; /// \name Setting /// @{ -/*! +/*! Sets the point. */ void set_point(Point p); @@ -68,13 +68,13 @@ void set_point(Point p); /// \name I/O /// @{ -/*! +/*! Inputs the non-combinatorial information given by the vertex: the point and other possible information. */ istream& operator>> (istream& is, TriangulationVertexBase_3 & v); -/*! +/*! Outputs the non-combinatorial information given by the vertex: the point and other possible information. */ diff --git a/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h b/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h index 76613247313..4b9d761303c 100644 --- a/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h +++ b/Triangulation_3/doc/Triangulation_3/Concepts/WeightedPoint.h @@ -20,17 +20,17 @@ public: /// \name Types /// @{ -/*! +/*! The point type */ typedef unspecified_type Point; -/*! +/*! The weight type */ typedef unspecified_type Weight; -/*! +/*! The ring type */ typedef Point::RT RT; @@ -40,7 +40,7 @@ typedef Point::RT RT; /// \name Creation /// @{ -/*! +/*! */ WeightedPoint(const Point &p=Point(), const Weight &w @@ -51,12 +51,12 @@ WeightedPoint(const Point &p=Point(), const Weight &w /// \name Access Functions /// @{ -/*! +/*! */ Point point() const; -/*! +/*! */ Weight weight() const; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h index 7ff59d0c6cc..84628057f3c 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_policies_2.h @@ -29,7 +29,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; @@ -69,7 +69,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h index 3cb0c95b79a..64a1bae1134 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Apollonius_graph_adaptation_traits_2.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_nearest_site_2; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h index 67c28ee1576..d7ca9cf6124 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_policies_2.h @@ -28,7 +28,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; @@ -66,7 +66,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h index ecabe30d723..6124567b9d1 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Delaunay_triangulation_adaptation_traits_2.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_nearest_site_2; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h index d8aabb4dada..f10fcadff0c 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Identity_policy_2.h @@ -32,7 +32,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h index b968717bb00..51935d0c0b9 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_policies_2.h @@ -28,7 +28,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; @@ -66,7 +66,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h index 0b74b42248f..60a0f677917 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Regular_triangulation_adaptation_traits_2.h @@ -24,7 +24,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_nearest_site_2; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h index 204bf01ce54..34dafd0fe9c 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_policies_2.h @@ -29,7 +29,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_false Has_inserter; @@ -69,7 +69,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_inserter; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h index 469642103e1..3220cd9c450 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Segment_Delaunay_graph_adaptation_traits_2.h @@ -25,7 +25,7 @@ public: /// \name Types /// @{ -/*! +/*! */ typedef CGAL::Tag_true Has_nearest_site_2; diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h index 9ee5a80d2b8..dd98107e487 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/CGAL/Voronoi_diagram_2.h @@ -59,33 +59,33 @@ public: /// \name Types /// @{ - /*! + /*! A type for the vertices of the Voronoi diagram. */ typedef unspecified_type Vertex; - /*! + /*! A type for the halfedges of the Voronoi diagram. */ typedef unspecified_type Halfedge; - /*! + /*! Handle for the vertices of the Voronoi diagram. */ typedef unspecified_type Vertex_handle; - /*! + /*! Handle for the faces of the Voronoi diagram. */ typedef unspecified_type Face_handle; - /*! + /*! Handle for the halfedges of the Voronoi diagram. */ typedef unspecified_type Halfedge_handle; - /*! + /*! A type for a bidirectional circulator over the halfedges on the boundary of the face. The value type of the circulator is @@ -94,13 +94,13 @@ public: */ typedef unspecified_type Ccb_halfedge_circulator; - /*! + /*! A type for the Delaunay graph. It is a model of the `DelaunayGraph_2` concept. */ typedef unspecified_type Delaunay_graph; - /*! + /*! A type for the handle of the dual vertex. */ typedef Delaunay_graph::Vertex_handle @@ -111,20 +111,20 @@ public: /// \name Access Methods /// @{ - /*! + /*! Returns an incident halfedge on the boundary of `f`. */ Halfedge_handle halfedge(); - /*! + /*! Returns a bidirectional circulator for traversing the halfedges on the boundary of `f`. The halfedges are traversed in counterclockwise order. */ Ccb_halfedge_circulator ccb(); - /*! + /*! Returns a handle to the corresponding dual vertex in the Delaunay graph. */ Delaunay_vertex_handle dual(); @@ -134,20 +134,20 @@ public: /// \name Predicate Methods /// @{ - /*! + /*! Returns `true` iff the face is an unbounded face in the Voronoi diagram. */ bool is_unbounded(); - /*! + /*! Returns `true` iff `e` is a halfedge of the boundary of `f`. */ bool is_halfedge_on_ccb(Halfedge e); - /*! + /*! Returns `true` iff the following conditions are met: the face is not rejected by the chosen adaptation policy; @@ -187,33 +187,33 @@ public: /// \name Types /// @{ - /*! + /*! A type for the vertices of the Voronoi diagram. */ typedef unspecified_type Vertex; - /*! + /*! A type for the faces of the Voronoi diagram. */ typedef unspecified_type Face; - /*! + /*! Handle for the vertices of the Voronoi diagram. */ typedef unspecified_type Vertex_handle; - /*! + /*! Handle for the faces of the Voronoi diagram. */ typedef unspecified_type Face_handle; - /*! + /*! Handle for the halfedges of the Voronoi diagram. */ typedef unspecified_type Halfedge_handle; - /*! + /*! A type for a bidirectional circulator over the halfedges of the boundary of a Voronoi face. The value type of the circulator is @@ -222,19 +222,19 @@ public: */ typedef unspecified_type Ccb_halfedge_circulator; - /*! + /*! A type for the Delaunay graph. It is a model of the `DelaunayGraph_2` concept. */ typedef unspecified_type Delaunay_graph; - /*! + /*! A type for the dual edge in the Delaunay graph. */ typedef Delaunay_graph::Edge Delaunay_edge; - /*! + /*! A type for vertex handles in the Delaunay graph. */ typedef Delaunay_graph::Vertex_handle Delaunay_vertex_handle; @@ -244,50 +244,50 @@ public: /// \name Access Methods /// @{ - /*! + /*! Returns the twin halfedge. */ Halfedge_handle twin(); - /*! + /*! Same as `e.twin()`. */ Halfedge_handle opposite(); - /*! + /*! Returns the next halfedge in the counterclockwise sense around the boundary of the face that `e` is incident to. */ Halfedge_handle next(); - /*! + /*! Returns the previous halfedge in the counterclockwise sense around the boundary of the adjacent face. */ Halfedge_handle previous(); - /*! + /*! Returns the face that `e` is incident to. */ Face_handle face(); - /*! + /*! Returns the source vertex of `e`. \pre The source vertex must exist, i.e., `has_source()` must return `true`. */ Vertex_handle source(); - /*! + /*! Returns the target vertex of `e`. \pre The target vertex must exist, i.e., `has_target()` must return `true`. */ Vertex_handle target(); - /*! + /*! Returns a bidirectional circulator to traverse the halfedges on the boundary of the Voronoi face containing `e`. The circulator is initialized to @@ -297,7 +297,7 @@ public: */ Ccb_halfedge_circulator ccb(); - /*! + /*! Returns the corresponding dual edge in the Delaunay graph. */ @@ -310,21 +310,21 @@ public: /// "parallel" to the \f$ x\f$-axis, oriented from left to right. /// @{ - /*! + /*! Returns a handle to the vertex in the Delaunay graph corresponding to the defining site above the Voronoi edge. */ Delaunay_vertex_handle up(); - /*! + /*! Returns a handle to the vertex in the Delaunay graph corresponding to the defining site below the Voronoi edge. */ Delaunay_vertex_handle down(); - /*! + /*! Returns a handle to the vertex in the Delaunay graph corresponding to the defining site to the left of the Voronoi edge. @@ -332,7 +332,7 @@ public: */ Delaunay_vertex_handle left(); - /*! + /*! Returns a handle to the vertex in the Delaunay graph corresponding to the defining site to the right of the Voronoi edge. @@ -345,47 +345,47 @@ public: /// \name Predicate Methods /// @{ - /*! + /*! Returns `true` iff the halfedge corresponds to a bisecting segment or a bisecting ray oriented appropriately so that its apex is its source. */ bool has_source(); - /*! + /*! Returns `true` iff the halfedge corresponds to a bisecting segment or a bisecting ray oriented appropriately so that its apex is its target. */ bool has_target(); - /*! + /*! Returns `true` iff the source or the target of the halfedge does not exist, i.e., if either of `has_source()` or `has_target()` return `false`. */ bool is_unbounded(); - /*! + /*! Returns `true` iff the Voronoi edge is an entire bisector. */ bool is_bisector(); - /*! + /*! Returns `true` iff the Voronoi edge has both a source and a target Voronoi vertex. */ bool is_segment(); - /*! + /*! Returns `true` iff the Voronoi edge has either a source or a target Voronoi vertex, but not both; in other words it is a bisecting ray. */ bool is_ray(); - /*! + /*! Returns `true` if the following conditions are met: the halfedge is not a rejected edge with respect to the chosen adaptation policy; @@ -427,44 +427,44 @@ public: /// \name Types /// @{ - /*! + /*! A type for the halfedges of the Voronoi diagram. */ typedef unspecified_type Halfedge; - /*! + /*! A type for the faces of the Voronoi diagram. */ typedef unspecified_type Face; - /*! + /*! Handle for the vertices of the Voronoi diagram. */ typedef unspecified_type Vertex_handle; - /*! + /*! Handle for the faces of the Voronoi diagram. */ typedef unspecified_type Face_handle; - /*! + /*! Handle for the halfedges of the Voronoi diagram. */ typedef unspecified_type Halfedge_handle; - /*! + /*! A type for the point represented by the vertex. */ typedef unspecified_type Point_2; - /*! + /*! A type for sizes. */ typedef unspecified_type size_type; - /*! + /*! A type for a bidirectional circulator that allows to traverse all incident halfedges, i.e., all halfedges that have the vertex as their target. The value @@ -474,18 +474,18 @@ public: */ typedef unspecified_type Halfedge_around_vertex_circulator; - /*! + /*! A type for the Delaunay graph. It is a model of the `DelaunayGraph_2` concept. */ typedef unspecified_type Delaunay_graph; - /*! + /*! A type for the handle of the dual face. */ typedef Delaunay_graph::Face_handle Delaunay_face_handle; - /*! + /*! A type for the vertex handles in the Delaunay graph. */ typedef Delaunay_graph::Vertex_handle Delaunay_vertex_handle; @@ -495,37 +495,37 @@ public: /// \name Access Methods /// @{ - /*! + /*! Returns an incident halfedge that has `v` as its target. */ Halfedge_handle halfedge(); - /*! + /*! Returns the in-degree of the vertex, i.e.\ the number of halfedges that have `v` as their target. */ size_type degree(); - /*! + /*! Returns the point represented by the vertex. */ Point_2 point(); - /*! + /*! Returns a handle to the corresponding dual face in the Delaunay graph. */ Delaunay_face_handle dual(); - /*! + /*! Returns a handle to the vertex in the Delaunay graph corresponding to the \f$ (i+1)\f$-th generating site of the Voronoi vertex. \pre `i` must be smaller or equal to 2. */ Delaunay_vertex_handle site(unsigned int i); - /*! + /*! Returns a bidirectional circulator that allows the traversal of the halfedges that have `v` as their target. Applying `operator++` (resp. `operator-`) to this circulator returns @@ -538,19 +538,19 @@ public: /// \name Predicate Methods /// @{ - /*! + /*! Returns `true` if the halfedge `e` is incident to `v`. */ bool is_incident_edge(Halfedge_handle e); - /*! + /*! Returns `true` if the face `f` is incident to `v`. */ bool is_incident_face(Face_handle e); - /*! + /*! Returns `true` if the following conditions are met: the dual face is not an infinite face; all incident halfedges have the vertex as their target. @@ -565,55 +565,55 @@ public: /// \name Types /// @{ -/*! +/*! A type for the dual Delaunay graph. */ typedef DG Delaunay_graph; -/*! +/*! A type for the adaptation traits needed by the Voronoi diagram adaptor. */ typedef AT Adaptation_traits; -/*! +/*! A type for the adaptation policy used. */ typedef AP Adaptation_policy; -/*! +/*! A type a point. */ typedef Adaptation_traits::Point_2 Point_2; -/*! +/*! A type for the sites of the Voronoi diagram. */ typedef Adaptation_traits::Site_2 Site_2; -/*! +/*! A type for sizes. */ typedef Delaunay_graph::size_type size_type; -/*! +/*! A type for the geometric traits of the Delaunay graph. */ typedef Delaunay_graph::Geom_traits Delaunay_geom_traits; -/*! +/*! A type for the vertex handles of the Delaunay graph. */ typedef Delaunay_graph::Vertex_handle Delaunay_vertex_handle; -/*! +/*! A type for the face handles of the Delaunay graph. */ typedef Delaunay_graph::Face_handle Delaunay_face_handle; -/*! +/*! A type for the edges of the Delaunay graph. */ typedef Delaunay_graph::Edge Delaunay_edge; @@ -629,96 +629,96 @@ typedef Delaunay_graph::Edge Delaunay_edge; /// handles. /// @{ -/*! +/*! Handle for halfedges. */ typedef unspecified_type Halfedge_handle; -/*! +/*! Handle for vertices. */ typedef unspecified_type Vertex_handle; -/*! +/*! Handle for faces. */ typedef unspecified_type Face_handle; -/*! +/*! A type for an iterator over Voronoi edges. Edges are considered non-oriented. Its value type is `Halfedge`. */ typedef unspecified_type Edge_iterator; -/*! +/*! A type for an iterator over Voronoi halfedges. Halfedges are oriented and come in pairs. Its value type is `Halfedge`. */ typedef unspecified_type Halfedge_iterator; -/*! +/*! A type for an iterator over Voronoi faces. Its value type is `Face`. */ typedef unspecified_type Face_iterator; -/*! +/*! A type for an iterator over Voronoi vertices. Its value type is `Vertex`. */ typedef unspecified_type Vertex_iterator; -/*! +/*! A type for a circulator over the halfedges that have a common vertex as their target. Its value type is `Halfedge`. */ typedef unspecified_type Halfedge_around_vertex_circulator; -/*! +/*! A type for a circulator over the halfedges on the boundary of a Voronoi face. Its value type of is `Halfedge`. */ typedef unspecified_type Ccb_halfedge_circulator; -/*! +/*! A type for an iterator over the unbounded faces of the Voronoi diagram. Its value type is `Face`. */ typedef unspecified_type Unbounded_faces_iterator; -/*! +/*! A type for an iterator over the bounded faces of the Voronoi diagram. Its value type is `Face`. */ typedef unspecified_type Bounded_faces_iterator; -/*! +/*! A type for an iterator over the unbounded halfedges of the Voronoi diagram. Its value type is `Halfedge`. */ typedef unspecified_type Unbounded_halfedges_iterator; -/*! +/*! A type for an iterator over the bounded halfedges of the Voronoi diagram. Its value type is `Halfedge`. */ typedef unspecified_type Bounded_halfedges_iterator; -/*! +/*! A type for an iterator over the sites of the Voronoi diagram. Its value type is `Site_2`. */ typedef unspecified_type Site_iterator; -/*! +/*! The result type of the point location queries. */ typedef boost::variant @@ -729,7 +729,7 @@ Locate_result; /// \name Creation /// @{ -/*! +/*! Creates a Voronoi diagram using `at` as adaptation traits and `ap` as adaptation policy; the underlying Delaunay graph is created using `gt` as geometric traits. @@ -738,7 +738,7 @@ Voronoi_diagram_2(Adaptation_traits at = Adaptation_traits(), Adaptation_policy ap = Adaptation_policy(), Delaunay_geom_traits gt = Delaunay_geom_traits()); -/*! +/*! Creates a Voronoi diagram from the Delaunay graph `dg` and using `at` as adaptation traits and `ap` as adaptation policy. The Delaunay graph `dg` is fully copied if `swap_dg` is set to @@ -749,7 +749,7 @@ Voronoi_diagram_2(Delaunay_graph dg, bool swap_dg = false, Adaptation_traits at = Adaptation_traits(), Adaptation_policy ap = Adaptation_policy()); -/*! +/*! Creates a Voronoi diagram using as sites the sites in the iterator range `[first, beyond)`, `at` as adaptation traits and `ap` as adaptation policy; the underlying Delaunay graph is @@ -767,62 +767,62 @@ Delaunay_geom_traits gt = Delaunay_geom_traits()); /// \name Access Methods /// @{ -/*! +/*! Returns a const reference to the dual graph, i.e., the Delaunay graph. */ Delaunay_graph dual(); -/*! +/*! Returns a handle to the halfedge in the Voronoi diagram that is dual to the edge `e` in the Delaunay graph. */ Halfedge_handle dual(Delaunay_edge e); -/*! +/*! Returns a handle to the face in the Voronoi diagram that is dual to the vertex corresponding to the vertex handle `v` in the Delaunay graph. */ Face_handle dual(Delaunay_vertex_handle v); -/*! +/*! Returns a handle to the vertex in the Voronoi diagram that is dual to the face corresponding to the face handle `f` in the Delaunay graph. */ Vertex_handle dual(Delaunay_face_handle f); -/*! +/*! Returns a reference to the Voronoi traits. */ Adaptation_traits adaptation_traits(); -/*! +/*! Returns a reference to the adaptation policy. */ Adaptation_policy adaptation_policy(); -/*! +/*! Returns the number of Voronoi vertices. */ size_type number_of_vertices(); -/*! +/*! Returns the number of Voronoi faces (bounded and unbounded). */ size_type number_of_faces(); -/*! +/*! Returns the number of halfedges (bounded and unbounded) in the Voronoi diagram. This is always an even number. */ size_type number_of_halfedges(); -/*! +/*! Returns the number of connected components of the Voronoi skeleton. */ size_type number_of_connected_components(); -/*! +/*! Returns one of the unbounded faces of the Voronoi diagram. If no unbounded faces exist (this can happen if the number of sites is zero) the @@ -830,21 +830,21 @@ default constructed face handle is returned. */ Face_handle unbounded_face(); -/*! +/*! Returns one of the bounded faces of the Voronoi diagram. If no bounded faces exist the default constructed face handle is returned. */ Face_handle bounded_face(); -/*! +/*! Returns one of the unbounded halfedges of the Voronoi diagram. If no unbounded halfedges exist the default constructed halfedge handle is returned. */ Halfedge_handle unbounded_halfedge(); -/*! +/*! Returns one of the bounded halfedges of the Voronoi diagram. If no bounded halfedges exist the default constructed halfedge handle is returned. @@ -872,92 +872,92 @@ Halfedge_handle bounded_halfedge(); /// invalidated by any change in the Voronoi diagram. /// @{ -/*! +/*! Starts at an arbitrary Voronoi face. */ Face_iterator faces_begin(); -/*! +/*! Past-the-end iterator. */ Face_iterator faces_end(); -/*! +/*! Starts at an arbitrary unbounded Voronoi face. */ Unbounded_faces_iterator unbounded_faces_begin(); -/*! +/*! Past-the-end iterator. */ Unbounded_faces_iterator unbounded_faces_end(); -/*! +/*! Starts at an arbitrary bounded Voronoi face. */ Bounded_faces_iterator bounded_faces_begin(); -/*! +/*! Past-the-end iterator. */ Bounded_faces_iterator bounded_faces_end(); -/*! +/*! Starts at an arbitrary Voronoi edge. */ Edge_iterator edges_begin(); -/*! +/*! Past-the-end iterator. */ Edge_iterator edges_end(); -/*! +/*! Starts at an arbitrary Voronoi halfedge. */ Halfedge_iterator halfedges_begin(); -/*! +/*! Past-the-end iterator. */ Halfedge_iterator halfedges_end(); -/*! +/*! Starts at an arbitrary unbounded Voronoi edge. */ Unbounded_halfedges_iterator unbounded_halfedges_begin(); -/*! +/*! Past-the-end iterator. */ Unbounded_halfedges_iterator unbounded_halfedges_end(); -/*! +/*! Starts at an arbitrary bounded Voronoi edge. */ Bounded_halfedges_iterator bounded_halfedges_begin(); -/*! +/*! Past-the-end iterator. */ Bounded_halfedges_iterator bounded_halfedges_end(); -/*! +/*! Starts at an arbitrary Voronoi vertex. */ Vertex_iterator vertices_begin(); -/*! +/*! Past-the-end iterator. */ Vertex_iterator vertices_end(); -/*! +/*! Starts at an arbitrary site. */ Site_iterator sites_begin(); -/*! +/*! Past-the-end iterator. */ Site_iterator sites_end(); @@ -989,14 +989,14 @@ Site_iterator sites_end(); /// the face over which it is defined. /// @{ -/*! +/*! Returns a circulator over the halfedges on the boundary of `f`. The circulator is initialized to an arbitrary halfedge on the boundary of the Voronoi face `f`. */ Ccb_halfedge_circulator ccb_halfedges(Face_handle f); -/*! +/*! Returns a circulator over the halfedges on the boundary of `f`. The circulator is initialized with the halfedge `h`. \pre The halfedge `h` must lie on the boundary of `f`. @@ -1004,7 +1004,7 @@ Returns a circulator over the halfedges on the boundary of Ccb_halfedge_circulator ccb_halfedges(Face_handle f, Halfedge_handle h); -/*! +/*! Returns a circulator over the halfedges whose target is the Voronoi vertex `v`. The circulator is initialized to an arbitrary halfedge incident to `v`. @@ -1012,7 +1012,7 @@ halfedge incident to `v`. Halfedge_around_vertex_circulator incident_halfedges(Vertex_handle v); -/*! +/*! Returns a circulator over the halfedges whose target is the Voronoi vertex `v`. The circulator is initialized with the halfedge `h`. @@ -1026,7 +1026,7 @@ incident_halfedges(Vertex_handle v, Halfedge_handle h); /// \name Insertion /// @{ -/*! +/*! Inserts the site `t` in the Voronoi diagram. A handle to the face corresponding to the Voronoi face of `t` in the Voronoi diagram is @@ -1037,7 +1037,7 @@ if `Voronoi_traits::Has_inserter` is set to */ Face_handle insert(Site_2 t); -/*! +/*! Inserts, in the Voronoi diagram, the sites in the iterator range `[first, beyond)`. The value type of `Iterator` must be `Site_2`. The number of sites in the iterator range is @@ -1052,7 +1052,7 @@ size_type insert(Iterator first, Iterator beyond); /// \name Queries /// @{ -/*! +/*! Performs point location for the query point `p`. In other words, the face, halfedge or vertex of the Voronoi diagram is found on which the point `p` @@ -1068,7 +1068,7 @@ Locate_result locate(Point_2 p); /// \name I/O /// @{ -/*! +/*! Writes the current state of the Voronoi diagram to the output stream `os`. @@ -1079,7 +1079,7 @@ The following operator must be defined: */ void file_output(std::ostream& os); -/*! +/*! Reads the current state of the Voronoi diagram from the input stream `is`. @@ -1090,7 +1090,7 @@ The following operator must be defined: */ void file_input(std::istream& is); -/*! +/*! Writes the current state of the Voronoi diagram to the output stream `os`. @@ -1100,7 +1100,7 @@ The following operator must be defined: */ std::ostream& operator<<(std::ostream& os, Voronoi_diagram_2 vd); -/*! +/*! Reads the current state of the Voronoi diagram from the input stream `is`. @@ -1114,7 +1114,7 @@ std::istream& operator>>(std::istream& is, Voronoi_diagram_2 vd); /// \name Validity Check /// @{ -/*! +/*! Checks the validity of the dual Delaunay graph and the Voronoi diagram adaptor. */ @@ -1125,12 +1125,12 @@ bool is_valid(); /// \name Miscellaneous /// @{ -/*! +/*! Clears all contents of the Voronoi diagram. */ void clear(); -/*! +/*! The Voronoi diagrams `other` and `vd` are swapped. `vd`.`swap(other)` should be preferred to diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h index d2ecfb00369..10c4036eb60 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationPolicy_2.h @@ -35,51 +35,51 @@ public: /// \name Types /// @{ -/*! +/*! A type for the sites of the Voronoi diagram. */ typedef unspecified_type Site_2; -/*! +/*! A type for the triangulated Delaunay graph. The type `Delaunay_graph` must be a model of the `DelaunayGraph_2` concept. */ typedef unspecified_type Delaunay_graph; -/*! +/*! */ typedef Delaunay_graph::Vertex_handle Delaunay_vertex_handle; -/*! +/*! */ typedef Delaunay_graph::Face_handle Delaunay_face_handle; -/*! +/*! */ typedef Delaunay_graph::Edge Delaunay_edge; -/*! +/*! */ typedef Delaunay_graph::All_edges_iterator All_Delaunay_edges_iterator; -/*! +/*! */ typedef Delaunay_graph::Finite_edges_iterator Finite_Delaunay_edges_iterator; -/*! +/*! */ typedef Delaunay_graph::Edge_circulator Delaunay_edge_circulator; -/*! +/*! A type for the predicate functor that is responsible for rejecting an edge of the Delaunay graph (or equivalently rejecting its dual edge in the Voronoi diagram). It must be @@ -105,7 +105,7 @@ The functor returns `true` iff the edge is rejected. */ typedef unspecified_type Edge_rejector; -/*! +/*! A type for the predicate functor that is responsible for rejecting a vertex of the Delaunay graph (or equivalently its dual face in the Voronoi diagram - hence the name @@ -119,7 +119,7 @@ The functor returns `true` iff the face is rejected. */ typedef unspecified_type Face_rejector; -/*! +/*! A tag for determining if the adaptation policy class provides a functor for inserting sites in the Delaunay graph. This tag is equal to either `CGAL::Tag_true` (a site @@ -128,7 +128,7 @@ inserter functor is not available). */ typedef unspecified_type Has_inserter; -/*! +/*! A type for a functor that inserts sites in the Delaunay graph. It must be model of the concepts `DefaultConstructible`, `CopyConstructible`, `Assignable`, @@ -152,17 +152,17 @@ typedef unspecified_type Site_inserter; /// \name Access to objects /// @{ -/*! +/*! */ Edge_rejector edge_rejector_object(); -/*! +/*! */ Face_rejector face_rejector_object(); -/*! +/*! This method is required only if `Has_inserter` is equal to `CGAL::Tag_true`. */ @@ -177,12 +177,12 @@ Site_inserter site_inserter_object(); /// rejectors. /// @{ -/*! +/*! Clears the state of the adaptation policy. */ void clear(); -/*! +/*! The adaptation policies `ap` and `other` are swapped. This method should be preferred to `ap=other` or `ap(other)` if @@ -190,12 +190,12 @@ preferred to `ap=other` or `ap(other)` if */ void swap(AdaptationPolicy_2 other); -/*! +/*! Tests the validity of the adaptation policy. */ bool is_valid(); -/*! +/*! Tests the validity of the adaptation policy using extra information from the Delaunay graph `dg`. diff --git a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h index 7c61be63521..55a7c03de6e 100644 --- a/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h +++ b/Voronoi_diagram_2/doc/Voronoi_diagram_2/Concepts/AdaptationTraits_2.h @@ -27,39 +27,39 @@ public: /// \name Types /// @{ -/*! +/*! A type for a point. */ typedef unspecified_type Point_2; -/*! +/*! A type for the sites of the Voronoi diagram. */ typedef unspecified_type Site_2; -/*! +/*! A type for the triangulated Delaunay graph. The type `Delaunay_graph` must be a model of the `DelaunayGraph_2` concept. */ typedef unspecified_type Delaunay_graph; -/*! +/*! The type of the edges of the Delaunay graph */ typedef Delaunay_graph::Edge Delaunay_edge; -/*! +/*! The type of the face handles of the Delaunay graph */ typedef Delaunay_graph::Face_handle Delaunay_face_handle; -/*! +/*! The type of the vertex handles of the Delaunay graph. */ typedef Delaunay_graph::Vertex_handle Delaunay_vertex_handle; -/*! +/*! A type for a functor that accesses the site associated with a vertex. The functor should be a model of the concepts `DefaultConstructible`, `CopyConstructible`, @@ -73,7 +73,7 @@ where the result type `result_type` must be either `Site_2` or */ typedef unspecified_type Access_site_2; -/*! +/*! A type for a functor that constructs the dual point of a (triangular) face in the Delaunay graph. This point is the Voronoi vertex of the three sites defining @@ -87,7 +87,7 @@ The face handle `f` must not correspond to an infinite face. */ typedef unspecified_type Construct_Voronoi_point_2; -/*! +/*! A tag for determining if the adaptation traits class provides a functor for performing nearest site queries. This tag is equal to either `CGAL::Tag_true` (a nearest site @@ -96,7 +96,7 @@ query functor is not available). */ typedef unspecified_type Has_nearest_site_2; -/*! +/*! A type for a functor that performs nearest site queries. Semantically, the result of the query is either a face, edge or vertex of the Delaunay graph. It is a face if @@ -125,17 +125,17 @@ typedef unspecified_type Nearest_site_2; /// \name Access to objects /// @{ -/*! +/*! */ Access_site_2 access_site_2_object(); -/*! +/*! */ Construct_Voronoi_point_2 construct_Voronoi_point_2_object(); -/*! +/*! This method is required only if `Has_nearest_site_2` is equal to `CGAL::Tag_true`. */ 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 7e6fafce223..9242122a60e 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 @@ -38,46 +38,46 @@ public: /// \name Types /// @{ -/*! +/*! A type for sizes. */ typedef unspecified_type size_type; -/*! +/*! A type for the geometric traits associated with the Delaunay graph. */ typedef unspecified_type Geom_traits; -/*! +/*! A type for the underlying triangulation data structure. It must be a model of the concept `TriangulationDataStructure_2.` */ typedef unspecified_type Triangulation_data_structure; -/*! +/*! A type for the vertices of the Delaunay graph. */ typedef unspecified_type Vertex; -/*! +/*! A type for the faces of the Delaunay graph. */ typedef unspecified_type Face; -/*! +/*! The type of the edges of the Delaunay graph. */ typedef std::pair Edge; -/*! +/*! Handle to the vertices of the Delaunay graph. */ typedef unspecified_type Vertex_handle; -/*! +/*! Handle to the faces of the Delaunay graph. */ typedef unspecified_type Face_handle; @@ -90,58 +90,58 @@ typedef unspecified_type Face_handle; /// their corresponding handles. /// @{ -/*! +/*! A type for an iterator over all edges of the Delaunay graph. Its value type must be `Edge`. */ typedef unspecified_type All_edges_iterator; -/*! +/*! A type for an iterator over the finite edges of the Delaunay graph. Its value type must be `Edge`. */ typedef unspecified_type Finite_edges_iterator; -/*! +/*! A type for an iterator over all faces of the Delaunay graph. Its value type must be `Face`. */ typedef unspecified_type All_faces_iterator; -/*! +/*! A type for an iterator over the finite faces of the Delaunay graph. Its value type must be `Face`. */ typedef unspecified_type Finite_faces_iterator; -/*! +/*! A type for an iterator over all vertices of the Delaunay graph. Its value type must be `Vertex`. */ typedef unspecified_type All_vertices_iterator; -/*! +/*! A type for an iterator over the finite vertices of the Delaunay graph. Its value type must be `Vertex`. */ typedef unspecified_type Finite_vertices_iterator; -/*! +/*! A type for a circulator over the adjacent faces of a vertex of the Delaunay graph. Its value type must be `Face`. */ typedef unspecified_type Face_circulator; -/*! +/*! A type for a circulator over the adjacent vertices of a vertex of the Delaunay graph. Its value type must be `Vertex`. */ typedef unspecified_type Vertex_circulator; -/*! +/*! A type for a circulator over the adjacent edges of a vertex of the Delaunay graph. Its value type must be `Edge`. @@ -155,18 +155,18 @@ typedef unspecified_type Edge_circulator; /// assignment operator, the following constructors are required. /// @{ -/*! +/*! Constructor that takes an instance of the geometric traits. */ DelaunayGraph_2(Geom_traits gt); -/*! +/*! Constructor that takes an iterator range. The value type of the iterator must be the type of the sites of the Delaunay graph. */ template DelaunayGraph_2(It first, It beyond); -/*! +/*! Constructor that takes an iterator range and an instance of the geometric traits. The value type of the iterator must be the type of the sites of the Delaunay graph. @@ -179,42 +179,42 @@ Geom_traits gt); /// \name Access methods /// @{ -/*! +/*! Returns a reference to the underlying triangulation data structure. */ Triangulation_data_structure tds(); -/*! +/*! Returns a reference to the geometric traits object. */ Geom_traits geom_traits(); -/*! +/*! Returns a handle to the infinite vertex. */ Vertex_handle infinite_vertex(); -/*! +/*! Returns a handle to a finite vertex, provided there exists one. */ Vertex_handle finite_vertex(); -/*! +/*! Returns a handle to a face incident to the infinite vertex. */ Face_handle infinite_face(); -/*! +/*! Returns the dimension of the Delaunay graph. */ int dimension(); -/*! +/*! Returns the number of finite vertices. */ size_type number_of_vertices(); -/*! +/*! Returns the number of faces (both finite and infinite). */ size_type number_of_faces(); @@ -228,32 +228,32 @@ size_type number_of_faces(); /// their value types are respectively `Face`, `Edge` and `Vertex`. /// @{ -/*! +/*! Starts at an arbitrary finite vertex. */ Finite_vertices_iterator finite_vertices_begin(); -/*! +/*! Past-the-end iterator. */ Finite_vertices_iterator finite_vertices_end(); -/*! +/*! Starts at an arbitrary finite edge. */ Finite_edges_iterator finite_edges_begin(); -/*! +/*! Past-the-end iterator. */ Finite_edges_iterator finite_edges_end(); -/*! +/*! Starts at an arbitrary finite face. */ Finite_faces_iterator finite_faces_begin(); -/*! +/*! Past-the-end iterator. */ Finite_faces_iterator finite_faces_end() @@ -268,32 +268,32 @@ const; /// their value types are respectively `Face`, `Edge` and `Vertex`. /// @{ -/*! +/*! Starts at an arbitrary vertex. */ All_vertices_iterator all_vertices_begin(); -/*! +/*! Past-the-end iterator. */ All_vertices_iterator all_vertices_end(); -/*! +/*! Starts at an arbitrary edge. */ All_edges_iterator all_edges_begin(); -/*! +/*! Past-the-end iterator. */ All_edges_iterator all_edges_end(); -/*! +/*! Starts at an arbitrary face. */ All_faces_iterator all_faces_begin(); -/*! +/*! Past-the-end iterator. */ All_faces_iterator all_faces_end(); @@ -310,35 +310,35 @@ All_faces_iterator all_faces_end(); /// clockwise. /// @{ -/*! +/*! Starts at an arbitrary face incident to `v`. */ Face_circulator incident_faces(Vertex_handle v); -/*! +/*! Starts at face `f`. \pre Face `f` must be incident to vertex `v`. */ Face_circulator incident_faces(Vertex_handle v, Face_handle f); -/*! +/*! Starts at an arbitrary edge incident to `v`. */ Edge_circulator incident_edges(Vertex_handle v); -/*! +/*! Starts at the first edge of `f` incident to `v`, in counterclockwise order around `v`. \pre Face `f` must be incident to vertex `v`. */ Edge_circulator incident_edges(Vertex_handle v, Face_handle f); -/*! +/*! Starts at an arbitrary vertex incident to `v`. */ Vertex_circulator incident_vertices(Vertex_handle v); -/*! +/*! Starts at the first vertex of `f` adjacent to `v` in counterclockwise order around `v`. \pre Face `f` must be incident to vertex `v`. @@ -352,27 +352,27 @@ Vertex_circulator incident_vertices(Vertex_handle v, Face_handle f); /// test the finite or infinite character of any feature. /// @{ -/*! +/*! `true`, iff `v` is the `infinite_vertex`. */ bool is_infinite(Vertex_handle v); -/*! +/*! `true`, iff face `f` is infinite. */ bool is_infinite(Face_handle f); -/*! +/*! `true`, iff edge `(f,i)` is infinite. */ bool is_infinite(Face_handle f, int i); -/*! +/*! `true`, iff edge `e` is infinite. */ bool is_infinite(Edge e); -/*! +/*! `true`, iff edge `*ec` is infinite. */ bool is_infinite(Edge_circulator ec); @@ -382,7 +382,7 @@ bool is_infinite(Edge_circulator ec); /// \name Validity check /// @{ -/*! +/*! Checks the validity of the Delaunay graph. If `verbose` is `true` a short message is sent to `std::cerr`. */ @@ -393,12 +393,12 @@ bool is_valid(bool verbose = false); /// \name Miscellaneous /// @{ -/*! +/*! Clears all contents of the Delaunay graph. */ void clear(); -/*! +/*! The Delaunay graphs `other` and `dg` are swapped. `dg`.`swap(other)` should be preferred to `dg``= other` or to