diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geodesic_arc_on_sphere_traits_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geodesic_arc_on_sphere_traits_2.h index 7039cc0167e..80c03fbf866 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geodesic_arc_on_sphere_traits_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geodesic_arc_on_sphere_traits_2.h @@ -25,7 +25,6 @@ */ #include - #include #include @@ -71,39 +70,39 @@ private: inline Sign z_sign(Direction_3 d) const { return CGAL::sign(d.dz()); } public: - /*! Default constructor */ + /*! constructs default */ Arr_extended_direction_3() : Direction_3(0, 0, 1), m_location(MAX_BOUNDARY_LOC) {} - /*! Constructor */ + /*! constructs */ Arr_extended_direction_3(const Direction_3& dir, Location_type location) : Direction_3(dir), m_location(location) {} - /*! Copy constructor */ + /*! constructs copy */ Arr_extended_direction_3(const Arr_extended_direction_3& other) : Direction_3(static_cast(other)) { m_location = other.discontinuity_type(); } - /*! Assignment operator */ + /*! assigs */ Arr_extended_direction_3& operator=(const Arr_extended_direction_3& other) { *(static_cast(this)) = static_cast(other); m_location = other.discontinuity_type(); return (*this); } - /*! Set the location type of the point. + /*! sets the location type of the point. */ void set_location(Location_type location) { m_location = location; } - /*! Obtain the location type of the point. + /*! obtains the location type of the point. */ Location_type location() const { return m_location; } - /*! Obtain the discontinuity type of the point. + /*! obtains the discontinuity type of the point. * \todo deprecate this one; use the above instead. */ Location_type discontinuity_type() const { return m_location; } @@ -151,7 +150,7 @@ public: using Curve_2 = Arr_geodesic_arc_on_sphere_3; using Multiplicity = std::size_t; - /*! Default constructor */ + /*! constructs default */ Arr_geodesic_arc_on_sphere_traits_2() {} using FT = typename Kernel::FT; @@ -162,7 +161,7 @@ public: using Vector_2 = typename Kernel::Vector_2; protected: - /*! Obtain the intersection of the identification arc and the \f$xy\f$-plane. + /*! obtains the intersection of the identification arc and the \f$xy\f$-plane. * By default, it is the vector directed along the negative \f$x\f$-axis * (\f$x = -\infty\f$). * \return the intersection of the identification arc and the \f$xy\f$-plane. @@ -172,7 +171,7 @@ protected: return d; } - /*! Obtain the normal of the plane that contains the identification arc. + /*! obtains the normal of the plane that contains the identification arc. * By default, it is the vector directed along the positive \f$y\f$-axis * (\f$y = \infty\f$). * \return the normal of the plane that contains the identification arc. @@ -182,7 +181,7 @@ protected: return d; } - /*! Obtain the 2D direction directed along the negative \f$x\f$-axis. + /*! obtains the 2D direction directed along the negative \f$x\f$-axis. * \return the direction directed at \f$x = -\infty\f$. */ inline static const Direction_2& neg_x_2() { @@ -190,7 +189,7 @@ protected: return d; } - /*! Obtain the 2D direction directed along the negative \f$y\f$-axis. + /*! obtains the 2D direction directed along the negative \f$y\f$-axis. * \return the direction directed at \f$y = -\infty\f$. */ inline static const Direction_2& neg_y_2() { @@ -198,19 +197,19 @@ protected: return d; } - /*! Obtain the sign of the \f$x\f$-coordinate of a direction in space + /*! obtains the sign of the \f$x\f$-coordinate of a direction in space * \param d the direction in space. * \return the sign of the \f$x\f$-coordinate of `d`. */ inline static Sign x_sign(Direction_3 d) { return CGAL::sign(d.dx()); } - /*! Obtain the sign of the \f$y\f$-coordinate of a direction in space + /*! obtains the sign of the \f$y\f$-coordinate of a direction in space * \param d the direction in space. * \return the sign of the \f$y\f$-coordinate of `d`. */ inline static Sign y_sign(Direction_3 d) { return CGAL::sign(d.dy()); } - /*! Obtain the sign of the \f$z\f$-coordinate of a direction in space + /*! obtains the sign of the \f$z\f$-coordinate of a direction in space * \param d the direction in space * \return the sign of the \f$z\f$-coordinate of `d`. */ @@ -218,28 +217,28 @@ protected: typedef Direction_2 (*Project)(const Direction_3& d) ; - /*! Project a 3D direction onto the \f$xy\f$-plane + /*! projects a 3D direction onto the \f$xy\f$-plane * \param d the 3D direction. * \return the projection onto the \f$xy\f$-plane. */ inline static Direction_2 project_xy(const Direction_3& d) { return Direction_2(d.dx(), d.dy()); } - /*! Project a 3D direction onto the \f$yz\f$-plane. + /*! projects a 3D direction onto the \f$yz\f$-plane. * \param d the 3D direction. * \return the projection onto the \f$yz\f$-plane. */ inline static Direction_2 project_yz(const Direction_3& d) { return Direction_2(d.dy(), d.dz()); } - /*! Project a 3D direction onto the \f$zx\f$-plane. + /*! projects a 3D direction onto the \f$zx\f$-plane. * \param d the 3D direction. * \return the projection onto the \f$xz\f$-plane. */ inline static Direction_2 project_xz(const Direction_3& d) { return Direction_2(d.dx(), d.dz()); } - /*! Project a 3D direction onto the \f$yz\f$-plane and reflect the + /*! projects a 3D direction onto the \f$yz\f$-plane and reflect the * \f$y\f$-coordinate. * \param d the 3D direction. * \return the projection onto the \f$yz\f$-plane. @@ -247,7 +246,7 @@ protected: inline static Direction_2 project_minus_yz(const Direction_3& d) { return Direction_2(-d.dy(), d.dz()); } - /*! Project a 3D direction onto the \f$zx\f$-plane and reflect the + /*! projects a 3D direction onto the \f$zx\f$-plane and reflect the * \f$x\f$- coordinate. * \param d the 3D direction. * \return the projection onto the \f$xz\f$-plane. @@ -255,7 +254,7 @@ protected: inline static Direction_2 project_minus_xz(const Direction_3& d) { return Direction_2(-d.dx(), d.dz()); } - /*! Compare the relative position of a direction and a plane given by its + /*! compares the relative position of a direction and a plane given by its * normal. * \param normal the direction of the plane. * \param dir the direction. @@ -266,7 +265,7 @@ protected: return CGAL::sign(dot); } - /*! Compute the orientation of two directions. + /*! computes the orientation of two directions. * \param d1 the first direction. * \param d2 the second direction. * \return the relative orientation of `d1` and `d2`. @@ -277,7 +276,7 @@ protected: return kernel.orientation_2_object()(d1.vector(), d2.vector()); } - /*! Constructs a plane that contains two directions. + /*! constructs a plane that contains two directions. * \param d1 the first direction. * \param d2 the second direction. */ @@ -289,7 +288,7 @@ protected: return v.direction(); } - /*! Determined whether a direction is contained in a plane given by its + /*! determines whether a direction is contained in a plane given by its * normal * \param normal the direction of the 3D plane. * \param dir the 3D direction. @@ -302,7 +301,7 @@ protected: } public: - /*! Compare two endpoint directions by v. + /*! compares two endpoint directions by v. * \param d1 the first endpoint direction. * \param d2 the second endpoint direction. * \return SMALLER - v(d1) < v(d2); @@ -336,7 +335,7 @@ public: CGAL::compare(dot_p2 * dot_p2 * norm1, dot_p1 * dot_p1 * norm2); } - /*! Compare two directions contained in the xy plane by u. + /*! compares two directions contained in the xy plane by u. * \param d1 the first direction. * \param d2 the second direction. * \return SMALLER - u(d1) < u(d2); @@ -352,7 +351,7 @@ public: LARGER : SMALLER; } - /*! Compare two endpoint directions by u. + /*! compares two endpoint directions by u. * \param d1 the first endpoint direction. * \param d2 the second endpoint direction. * \return SMALLER - u(d1) < u(d2); @@ -369,7 +368,7 @@ public: return compare_x(d1_2, d2_2); } - /*! Compare two endpoint directions lexigoraphically: by u, then by v. + /*! compares two endpoint directions lexigoraphically: by u, then by v. * \param d1 the first endpoint direction. * \param d2 the second endpoint direction. * \return SMALLER - u(d1) < u(d2); @@ -387,7 +386,7 @@ public: return res; } - /*! Determine whether the given point is in the \f$x\f$-range of the + /*! determines whether the given point is in the \f$x\f$-range of the * spherical_arc. * \param point the query point direction. * \return true if point is in the \f$x\f$-range of the (closed) spherical_arc @@ -420,7 +419,7 @@ public: return kernel.counterclockwise_in_between_2_object()(p, l, r); } - /*! Compute the intersection of a curve and the identification curve. + /*! computes the intersection of a curve and the identification curve. * \param[in] cv the curve. */ void intersection_with_identification(const X_monotone_curve_2& xcv, @@ -432,7 +431,7 @@ public: Direction_3(normal.dz(), 0, -(normal.dx())); } - /*! Compute the intersection of a curve and the identification curve. + /*! computes the intersection of a curve and the identification curve. * \param[in] cv the curve. */ void intersection_with_identification(const X_monotone_curve_2& xcv, @@ -444,7 +443,7 @@ public: dp = Direction_3(atan_x, atan_y, z); } - /*! Compute the intersection of a curve and the identification curve. + /*! computes the intersection of a curve and the identification curve. * \param[in] cv the curve */ bool overlap_with_identification(const X_monotone_curve_2& xcv, @@ -455,7 +454,7 @@ public: ((y_sign(normal) == POSITIVE) && xcv.is_directed_right()))); } - /*! Compute the intersection of a curve and the identification curve. + /*! computes the intersection of a curve and the identification curve. * \param[in] cv the curve. */ bool overlap_with_identification(const X_monotone_curve_2& xcv, @@ -485,7 +484,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Construct_point_2(const Traits& traits) : m_traits(traits) {} @@ -493,7 +492,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Construct a point on the sphere from three coordinates, which define + /*! constructs a point on the sphere from three coordinates, which define * a (not necessarily normalized) direction. * \param[in] x the \f$x\f$-coordinate. * \param[in] y the \f$y\f$-coordinate. @@ -507,7 +506,7 @@ public: return p; } - /*! Construct a point on the sphere from a (not necessarily normalized) + /*! constructs a point on the sphere from a (not necessarily normalized) * direction. * \param other the other direction. */ @@ -519,7 +518,7 @@ public: return p; } - /*! Initialize a point on the sphere, + /*! initializes a point on the sphere, * \param[in] p the point to initialize. */ void init(Point_2& p, std::true_type) const { @@ -537,7 +536,7 @@ public: p.set_location(location); } - /*! Initialize a point on the sphere, + /*! initializes a point on the sphere, * \param[in] p the point to initialize. */ void init(Point_2& p, std::false_type) const { @@ -559,7 +558,7 @@ public: } }; - /*! Obtain a point construction functor. + /*! obtains a point construction functor. */ Construct_point_2 construct_point_2_object() const { return Construct_point_2(*this); } @@ -573,7 +572,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Construct_x_monotone_curve_2(const Traits& traits) : m_traits(traits) {} @@ -581,7 +580,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Construct the minor arc from two endpoint directions. The minor arc + /*! constructs the minor arc from two endpoint directions. The minor arc * is the one with the smaller angle among the two geodesic arcs with * the given endpoints. * 1. Find out whether the arc is \f$x\f$-monotone. @@ -616,7 +615,7 @@ public: return xcv; } - /*! Construct a full spherical_arc from a plane + /*! constructs a full spherical_arc from a plane * \param plane the containing plane. * \pre the plane is not vertical */ @@ -639,7 +638,7 @@ public: xcv.set_target(p); } - /*! Construct a spherical_arc from two endpoints directions contained + /*! constructs a spherical_arc from two endpoints directions contained * in a plane. * \param[in] plane the containing plane. * \param[in] source the source-point direction. @@ -651,7 +650,7 @@ public: { return X_monotone_curve_2(source, target, normal); } private: - /*! Initialize a spherical_arc given that the two endpoint directions + /*! initializes a spherical_arc given that the two endpoint directions * have been set. It is assumed that the arc is the one with the smaller * angle among the two. * 1. Find out whether the arc is \f$x\f$-monotone. @@ -749,7 +748,7 @@ public: } }; - /*! Obtain an \f$x\f$-monotone geodesic arc construction functor. + /*! obtains an \f$x\f$-monotone geodesic arc construction functor. */ Construct_x_monotone_curve_2 construct_x_monotone_curve_2_object() const { return Construct_x_monotone_curve_2(*this); } @@ -762,7 +761,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Construct_curve_2(const Traits& traits) : m_traits(traits) {} @@ -770,7 +769,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Construct a spherical_arc from two endpoint directions. It is assumed + /*! constructs a spherical_arc from two endpoint directions. It is assumed * that the arc is the one with the smaller angle among the two. * 1. Find out whether the arc is \f$x\f$-monotone. * 2. If it is \f$x\f$-monotone, @@ -864,7 +863,7 @@ public: return cv; } - /*! Construct a spherical_arc from two endpoint directions contained + /*! constructs a spherical_arc from two endpoint directions contained * in a plane. * \param[in] source the source-point direction. * \param[in] target the target-point direction. @@ -988,7 +987,7 @@ public: return cv; } - /*! Construct a full spherical_arc from a plane + /*! constructs a full spherical_arc from a plane * \param plane the containing plane. */ Curve_2 operator()(const Direction_3& normal) const { @@ -1004,7 +1003,7 @@ public: } }; - /*! Obtain a geodesic arc construction functor. + /*! obtains a geodesic arc construction functor. */ Construct_curve_2 construct_curve_2_object() const { return Construct_curve_2(*this); } @@ -1018,7 +1017,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_x_2(const Traits& traits) : m_traits(traits) {} @@ -1026,7 +1025,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Compare the \f$x\f$-coordinates of two directional points. + /*! compares the \f$x\f$-coordinates of two directional points. * \param p1 the first directional point. * \param p2 the second directional point. * \return SMALLER - x(p1) < x(p2); @@ -1044,7 +1043,7 @@ public: }; protected: - /*! Obtain the positive (north) pole + /*! obtains the positive (north) pole * \return the positive (north) pole */ inline static const Point_2& pos_pole() { @@ -1052,7 +1051,7 @@ protected: return p; } - /*! Obtain the negative (south) pole + /*! obtains the negative (south) pole * \return the negative (south) pole */ inline static const Point_2& neg_pole() { @@ -1061,7 +1060,7 @@ protected: } public: - /*! Obtain a `Compare_x_2` function object. */ + /*! obtains a `Compare_x_2` function object. */ Compare_x_2 compare_x_2_object() const { return Compare_x_2(*this); } /*! A functor that compares two directional points lexigoraphically: @@ -1074,7 +1073,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_xy_2(const Traits& traits) : m_traits(traits) {} @@ -1082,7 +1081,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Compare two directional points lexigoraphically: by x, then by y. + /*! compares two directional points lexigoraphically: by x, then by y. * \param p1 the first endpoint directional point. * \param p2 the second endpoint directional point. * \return SMALLER - x(p1) < x(p2); @@ -1101,13 +1100,13 @@ public: } }; - /*! Obtain a `Compare_xy_2` function object. */ + /*! obtains a `Compare_xy_2` function object. */ Compare_xy_2 compare_xy_2_object() const { return Compare_xy_2(*this); } /*! A functor that obtain the left endpoint of an \f$x\f$-monotone arc */ class Construct_min_vertex_2 { public: - /*! Obtain the left endpoint of and arc. + /*! obtains the left endpoint of and arc. * \param xc the arc. * \return the left endpoint. */ @@ -1115,14 +1114,14 @@ public: { return xc.left(); } }; - /*! Obtain a `Construct_min_vertex_2` function object. */ + /*! obtains a `Construct_min_vertex_2` function object. */ Construct_min_vertex_2 construct_min_vertex_2_object() const { return Construct_min_vertex_2(); } /*! A functor that obtain the right endpoint of an \f$x\f$-monotone arc */ class Construct_max_vertex_2 { public: - /*! Obtain the right endpoint of an arc. + /*! obtains the right endpoint of an arc. * \param xc the arc. * \return the right endpoint. */ @@ -1130,14 +1129,14 @@ public: { return xc.right(); } }; - /*! Obtain a `Construct_max_vertex_2` function object. */ + /*! obtains a `Construct_max_vertex_2` function object. */ Construct_max_vertex_2 construct_max_vertex_2_object() const { return Construct_max_vertex_2(); } /*! A functor that checks whether an \f$x\f$-monotone arc is a vertical */ class Is_vertical_2 { public: - /*! Check whether a given arc is vertical. + /*! checks whether a given arc is vertical. * \param xc the arc. * \return true if the curve is a vertical spherical_arc; false otherwise. * \pre the arc is not degenerate (consists of a single point) @@ -1148,7 +1147,7 @@ public: } }; - /*! Obtain an `Is_vertical_2` function object. */ + /*! obtains an `Is_vertical_2` function object. */ Is_vertical_2 is_vertical_2_object() const { return Is_vertical_2(); } /*! A functor that compares the \f$y\f$-coordinates of a directional point and @@ -1161,7 +1160,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_at_x_2(const Traits& traits) : m_traits(traits) {} @@ -1169,7 +1168,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Return the location of the given point with respect to the input arc. + /*! returns the location of the given point with respect to the input arc. * \param xc the arc. * \param p the point. * \return SMALLER - y(p) < xc(x(p)), i.e. the point is below the curve; @@ -1206,7 +1205,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_2` function object. */ + /*! obtains a `Compare_y_at_x_2` function object. */ Compare_y_at_x_2 compare_y_at_x_2_object() const { return Compare_y_at_x_2(*this); } @@ -1220,7 +1219,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_at_x_left_2(const Traits& traits) : m_traits(traits) {} @@ -1228,7 +1227,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Compare the \f$y\f$-value of two \f$x\f$-monotone curves immediately to + /*! compares the \f$y\f$-value of two \f$x\f$-monotone curves immediately to * the left of their intersection point. * \param xc1 the first curve. * \param xc2 the second curve. @@ -1322,7 +1321,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_left_2` function object. */ + /*! obtains a `Compare_y_at_x_left_2` function object. */ Compare_y_at_x_left_2 compare_y_at_x_left_2_object() const { return Compare_y_at_x_left_2(*this); } @@ -1336,7 +1335,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_at_x_right_2(const Traits& traits) : m_traits(traits) {} @@ -1344,7 +1343,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Compare the \f$y\f$-value of two \f$x\f$-monotone curves immediately to + /*! compares the \f$y\f$-value of two \f$x\f$-monotone curves immediately to * the right of their intersection point. * \param xc1 the first curve. * \param xc2 the second curve. @@ -1437,7 +1436,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_right_2` function object. */ + /*! obtains a `Compare_y_at_x_right_2` function object. */ Compare_y_at_x_right_2 compare_y_at_x_right_2_object() const { return Compare_y_at_x_right_2(*this); } @@ -1451,7 +1450,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Equal_2(const Traits& traits) : m_traits(traits) {} @@ -1459,7 +1458,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Determines whether the two \f$x\f$-monotone curves are the same (have + /*! determines whether the two \f$x\f$-monotone curves are the same (have * the same graph). * \param xc1 the first curve. * \param xc2 the second curve. @@ -1485,7 +1484,7 @@ public: equal_3(Direction_3(xc1.right()), Direction_3(xc2.right()))); } - /*! Determines whether the two points are the same. + /*! determines whether the two points are the same. * \param p1 the first point. * \param p2 the second point. * \return true if the two point are the same; false otherwise. @@ -1496,7 +1495,7 @@ public: } }; - /*! Obtain an `Equal_2` function object. */ + /*! obtains an `Equal_2` function object. */ Equal_2 equal_2_object() const { return Equal_2(*this); } //@} @@ -1513,7 +1512,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Parameter_space_in_x_2(const Traits& traits) : m_traits(traits) {} @@ -1521,7 +1520,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Obtains the parameter space at the end of an arc along the \f$x\f$-axis. + /*! obtains the parameter space at the end of an arc along the \f$x\f$-axis. * Only called for arcs whose interior lie in the interior of the * parameter space, that is, the arc does not coincide with the * identification. Thus, it returns ARR_LEFT_BOUNDARY or ARR_RIGHT_BOUNDARY @@ -1550,7 +1549,7 @@ public: ((xcv.right().is_no_boundary()) ? ARR_INTERIOR : ARR_RIGHT_BOUNDARY); } - /*! Obtains the parameter space at a point along the \f$x\f$-axis. + /*! obtains the parameter space at a point along the \f$x\f$-axis. * Every non-interior point is assumed to lie on the left-right * identification. * Points at the poles additionally lie on the bottom or top boundary. @@ -1564,7 +1563,7 @@ public: } }; - /*! Obtain a Parameter_space_in_x_2 function object. */ + /*! obtains a Parameter_space_in_x_2 function object. */ Parameter_space_in_x_2 parameter_space_in_x_2_object() const { return Parameter_space_in_x_2(*this); } @@ -1573,7 +1572,7 @@ public: */ class Parameter_space_in_y_2 { public: - /*! Obtains the parameter space at the end of an arc along the \f$y\f$-axis. + /*! obtains the parameter space at the end of an arc along the \f$y\f$-axis. * Only called for arcs whose interior lie in the interior of the * parameter space, that is, the arc does not coincide with the * identification. Thus, it returns ARR_BOTTOM_BOUNDARY or ARR_TOP_BOUNDARY @@ -1597,7 +1596,7 @@ public: ((xcv.right().is_max_boundary()) ? ARR_TOP_BOUNDARY : ARR_INTERIOR); } - /*! Obtains the parameter space of a point along the \f$y\f$-axis. + /*! obtains the parameter space of a point along the \f$y\f$-axis. * That is, ARR_BOTTOM_BOUNDARY is returned if p coincides with the * south pole and ARR_TOP_BOUNDARY if p coincides with the north pole. * Otherwise ARR_INTERIOR is returned. @@ -1611,7 +1610,7 @@ public: } }; - /*! Obtain a `Parameter_space_in_y_2` function object. */ + /*! obtains a `Parameter_space_in_y_2` function object. */ Parameter_space_in_y_2 parameter_space_in_y_2_object() const { return Parameter_space_in_y_2(); } @@ -1626,7 +1625,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_x_on_boundary_2(const Traits& traits) : m_traits(traits) {} @@ -1634,7 +1633,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Compare the \f$x\f$-coordinate of a direction with the + /*! compares the \f$x\f$-coordinate of a direction with the * \f$x\f$-coordinate of an arc end projected onto the boundary. * \param point the point direction. * \param xcv the arc, the endpoint of which is compared. @@ -1673,7 +1672,7 @@ public: return m_traits.compare_x(p, q); } - /*! Compare the \f$x\f$-coordinates of two arc ends projected onto the + /*! compares the \f$x\f$-coordinates of two arc ends projected onto the * boundary of the parameter space. * \param xcv1 the first arc. * \param ce1 the first arc end indicator - @@ -1737,7 +1736,7 @@ public: { CGAL_error(); return EQUAL; } }; - /*! Obtain a `Compare_x_on_boundary_2` function object. + /*! obtains a `Compare_x_on_boundary_2` function object. */ Compare_x_on_boundary_2 compare_x_on_boundary_2_object() const { return Compare_x_on_boundary_2(*this); } @@ -1752,7 +1751,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_x_near_boundary_2(const Traits& traits) : m_traits(traits) {} @@ -1760,8 +1759,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - - /*! Compare the \f$x\f$-coordinates of 2 arc ends near the boundary of the + /*! compares the \f$x\f$-coordinates of 2 arc ends near the boundary of the * parameter space. * \param xcv1 the first arc. * \param xcv2 the second arc. @@ -1801,7 +1799,7 @@ public: } }; - /*! Obtain a `Compare_x_near_boundary_2` function object. */ + /*! obtains a `Compare_x_near_boundary_2` function object. */ Compare_x_near_boundary_2 compare_x_near_boundary_2_object() const { return Compare_x_near_boundary_2(*this); } @@ -1816,7 +1814,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_near_boundary_2(const Traits& traits) : m_traits(traits) {} @@ -1824,7 +1822,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Compare the \f$y\f$-coordinates of 2 curves at their ends near the + /*! compares the \f$y\f$-coordinates of 2 curves at their ends near the * boundary of the parameter space. * \param xcv1 the first arc. * \param xcv2 the second arc. @@ -1945,7 +1943,7 @@ public: } }; - /*! Obtain a `Compare_y_near_boundary_2` function object. */ + /*! obtains a `Compare_y_near_boundary_2` function object. */ Compare_y_near_boundary_2 compare_y_near_boundary_2_object() const { return Compare_y_near_boundary_2(*this); } @@ -1959,7 +1957,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Is_on_y_identification_2(const Traits& traits) : m_traits(traits) {} @@ -1967,14 +1965,14 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Determine whether a point lies on the vertical identification arc. + /*! determines whether a point lies on the vertical identification arc. * \param p the point. * \return a Boolean indicating whether p lies on the vertical * identification arc (including the poles) */ bool operator()(const Point_2& p) const { return !p.is_no_boundary(); } - /*! Determine whether an arc coincides with the vertical identification + /*! determines whether an arc coincides with the vertical identification * arc. * \param xcv the arc. * \return a Boolean indicating whether xcv coincides with the vertical @@ -2003,7 +2001,7 @@ public: } }; - /*! Obtain an `Is_on_y_identification_2` function object. */ + /*! obtains an `Is_on_y_identification_2` function object. */ Is_on_y_identification_2 is_on_y_identification_2_object() const { return Is_on_y_identification_2(*this); } @@ -2017,7 +2015,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_on_boundary_2(const Traits& traits) : m_traits(traits) {} @@ -2025,7 +2023,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Compare the \f$y\f$-coordinate of two given points that lie on the + /*! compares the \f$y\f$-coordinate of two given points that lie on the * vertical identification curve. * \param p1 the first point. * \param p2 the second point. @@ -2059,7 +2057,7 @@ public: }; - /*! Obtain a `Compare_y_on_boundary_2` function object. */ + /*! obtains a `Compare_y_on_boundary_2` function object. */ Compare_y_on_boundary_2 compare_y_on_boundary_2_object() const { return Compare_y_on_boundary_2(*this); } //@} @@ -2078,7 +2076,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Make_x_monotone_2(const Traits& traits) : m_traits(traits) {} @@ -2086,7 +2084,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Subdivide a given curve into \f$x\f$-monotone subcurves and insert them + /*! subdivides a given curve into \f$x\f$-monotone subcurves and insert them * into a given output iterator. As spherical_arcs are always x_monotone, * only one object will be contained in the iterator. * \param xc the curve. @@ -2226,7 +2224,7 @@ public: } }; - /*! Obtain a `Make_x_monotone_2` function object. */ + /*! obtains a `Make_x_monotone_2` function object. */ Make_x_monotone_2 make_x_monotone_2_object() const { return Make_x_monotone_2(*this); } @@ -2238,7 +2236,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Split_2(const Traits& traits) : m_traits(traits) {} @@ -2246,7 +2244,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Split a given \f$x\f$-monotone curve at a given point into two + /*! splits a given \f$x\f$-monotone curve at a given point into two * sub-curves. * \param xc the curve to split * \param p the split point. @@ -2295,7 +2293,7 @@ public: } }; - /*! Obtain a `Split_2` function object. */ + /*! obtains a `Split_2` function object. */ Split_2 split_2_object() const { return Split_2(*this); } /*! The clockwise-in-between function object. */ @@ -2306,7 +2304,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Clockwise_in_between_2(const Traits& traits) : m_traits(traits) {} @@ -2321,7 +2319,7 @@ public: } }; - /*! Obtain a `Clockwise_in_between_2` function object. */ + /*! obtains a `Clockwise_in_between_2` function object. */ Clockwise_in_between_2 clockwise_in_between_2_object() const { return Clockwise_in_between_2(*this); } @@ -2329,7 +2327,7 @@ public: class Intersect_2 { private: - /*! Computes the intersection between two arcs contained in the same plane + /*! computes the intersection between two arcs contained in the same plane * \param l1_3 * \param r1_3 * \param l2_3 @@ -2496,7 +2494,7 @@ public: return oi; } - /*! Determine whether a direction pierces an arc. + /*! determines whether a direction pierces an arc. * \param point the direction. * \param xc the arc. * \return true iff point pierces xc. @@ -2558,7 +2556,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Intersect_2(const Traits& traits) : m_traits(traits) {} @@ -2566,7 +2564,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Find the intersections of the two given curves and insert them into the + /*! finds the intersections of the two given curves and insert them into the * given output iterator. As two spherical_arcs may itersect only once, * only a single intersection will be contained in the iterator. * \param xc1 the first curve. @@ -2613,7 +2611,7 @@ public: return oi; } - /*! If the endpoints of one arc coincide with the 2 poles resp, + /* If the endpoints of one arc coincide with the 2 poles resp, * the other arc is completely overlapping. */ if (xc1.left().is_min_boundary() && xc1.right().is_max_boundary()) { @@ -2624,7 +2622,7 @@ public: *oi++ = xc1; return oi; } - /*! Find an endpoint that does not coincide with a pole, and project + /* Find an endpoint that does not coincide with a pole, and project * it onto the xy plane. If the projection coincide with the negative * x, project onto the zx plane. Otherwise project onto the yz plane. */ @@ -2680,7 +2678,7 @@ public: } }; - /*! Obtain an `Intersect_2` function object. */ + /*! obtains an `Intersect_2` function object. */ Intersect_2 intersect_2_object() const { return Intersect_2(*this); } /*! A functor that tests whether two \f$x\f$-monotone arcs can be merged. */ @@ -2690,7 +2688,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Are_mergeable_2(const Traits& traits) : m_traits(traits) {} @@ -2698,7 +2696,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Check whether it is possible to merge two given \f$x\f$-monotone curves. + /*! checks whether it is possible to merge two given \f$x\f$-monotone curves. * \param xc1 the first curve. * \param xc2 the second curve. * \return true if the two arcs are mergeable; false otherwise. @@ -2749,7 +2747,7 @@ public: } }; - /*! Obtain an `Are_mergeable_2` function object. */ + /*! obtains an `Are_mergeable_2` function object. */ Are_mergeable_2 are_mergeable_2_object() const { return Are_mergeable_2(*this); } @@ -2761,7 +2759,7 @@ public: //! The traits (in case it has state) const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Merge_2(const Traits& traits) : m_traits(traits) {} @@ -2769,7 +2767,7 @@ public: friend class Arr_geodesic_arc_on_sphere_traits_2; public: - /*! Merge two given \f$x\f$-monotone curves into a single curve + /*! merges two given \f$x\f$-monotone curves into a single curve * (spherical_arc). * \param xc1 the first curve. * \param xc2 the second curve. @@ -2851,7 +2849,7 @@ public: } }; - /*! Obtain a `Merge_2` function object. */ + /*! obtains a `Merge_2` function object. */ Merge_2 merge_2_object() const { return Merge_2(*this); } //@} @@ -2865,7 +2863,7 @@ public: class Approximate_2 { public: - /*! Return an approximation of a point coordinate. + /*! returns an approximation of a point coordinate. * \param p the exact point. * \param i the coordinate index (either 0 or 1). * \pre `i` is either 0 or 1. @@ -2878,7 +2876,7 @@ public: ((i == 1) ? CGAL::to_double(p.dy()) : CGAL::to_double(p.dz())); } - /*! Obtain an approximation of a point. + /*! obtains an approximation of a point. */ Approximate_point_2 operator()(const Point_2& p) const { Approximate_kernel::Direction_3 dir(operator()(p, 0), operator()(p, 1), @@ -2887,7 +2885,7 @@ public: return Approximate_point_2(dir, loc); } - /*! Obtain an approximation of an \f$x\f$-monotone curve. + /*! obtains an approximation of an \f$x\f$-monotone curve. */ template OutputIterator operator()(const X_monotone_curve_2& xcv, @@ -2987,7 +2985,7 @@ public: } }; - /*! Obtain an `Approximate_2` function object. */ + /*! obtains an `Approximate_2` function object. */ Approximate_2 approximate_2_object() const { return Approximate_2(); } //@} @@ -2997,7 +2995,7 @@ public: class Compare_endpoints_xy_2 { public: - /*! Compare the endpoints of an $x$-monotone curve lexicographically. + /*! compares the endpoints of an $x$-monotone curve lexicographically. * (assuming the curve has a designated source and target points). * \param xc the curve. * \return SMALLER if the curve is directed right; @@ -3007,13 +3005,13 @@ public: { return (xc.is_directed_right()) ? SMALLER : LARGER; } }; - /*! Obtain a `Compare_endpoints_xy_2` function object. */ + /*! obtains a `Compare_endpoints_xy_2` function object. */ Compare_endpoints_xy_2 compare_endpoints_xy_2_object() const { return Compare_endpoints_xy_2(); } class Construct_opposite_2 { public: - /*! Construct an opposite \f$x\f$-monotone (with swapped source and target). + /*! constructs an opposite \f$x\f$-monotone (with swapped source and target). * \param xc the curve. * \return the opposite curve. */ @@ -3021,7 +3019,7 @@ public: { return xc.opposite(); } }; - /*! Obtain a `Construct_opposite_2` function object. */ + /*! obtains a `Construct_opposite_2` function object. */ Construct_opposite_2 construct_opposite_2_object() const { return Construct_opposite_2(); } //@} @@ -3037,7 +3035,7 @@ public: return os; } - /*! Inserter for the spherical_arc class used by the traits-class */ + /*! inserters a spherical_arc used by the traits-class */ template friend OutputStream& operator<<(OutputStream& os, const X_monotone_curve_2& xc) { @@ -3045,7 +3043,7 @@ public: return os; } - /*! Extractor for the spherical_arc class used by the traits-class */ + /*! extracts a spherical_arc used by the traits-class */ template friend InputStream& operator>>(InputStream& is, X_monotone_curve_2& arc) { CGAL_error_msg("Not implemented yet!"); @@ -3107,7 +3105,7 @@ protected: inline Sign z_sign(Direction_3 d) const { return CGAL::sign(d.dz()); } public: - /*! Default constructor - constructs an empty arc */ + /*! constructs default; constructs an empty arc */ Arr_x_monotone_geodesic_arc_on_sphere_3() : m_is_vertical(false), m_is_directed_right(false), @@ -3116,7 +3114,7 @@ public: m_is_empty(true) {} - /*! Constructor + /*! constructs * \param src the source point of the arc * \param trg the target point of the arc * \param plane the plane that contains the arc @@ -3142,7 +3140,7 @@ public: m_is_empty(is_empty) {} - /*! Copy constructor + /*! constructs copy * \param other the other arc */ Arr_x_monotone_geodesic_arc_on_sphere_3 @@ -3157,7 +3155,7 @@ public: m_is_empty = other.m_is_empty; } - /*! Assignment operator */ + /*! assigns */ Arr_x_monotone_geodesic_arc_on_sphere_3& operator= (const Arr_x_monotone_geodesic_arc_on_sphere_3& other) { m_source = other.m_source; @@ -3171,7 +3169,7 @@ public: return (*this); } - /*! Initialize a spherical_arc given that the two endpoint directions + /*! initializes a spherical_arc given that the two endpoint directions * have been set. It is assumed that the arc is the one with the smaller * angle among the two. * 1. Find out whether the arc is \f$x\f$-monotone. @@ -3265,7 +3263,7 @@ public: Direction_3(m_target))); } - /*! Construct a full spherical_arc from a plane + /*! constructs a full spherical_arc from a plane * \param plane the containing plane. * \pre the plane is not vertical */ @@ -3296,7 +3294,7 @@ public: Arr_extended_direction_3(d, Arr_extended_direction_3::MID_BOUNDARY_LOC); } - /*! Construct a full spherical_arc from a common endpoint and a plane + /*! constructs a full spherical_arc from a common endpoint and a plane * \param plane the containing plane. * \pre the point lies on the plane * \pre the point lies on the open discontinuity arc @@ -3318,7 +3316,7 @@ public: #endif } - /*! Construct a spherical_arc from two endpoints directions contained + /*! constructs a spherical_arc from two endpoints directions contained * in a plane. * \param plane the containing plane. * \param source the source-point direction. @@ -3383,17 +3381,17 @@ public: set_is_directed_right(z_sign(normal) == POSITIVE); } - /*! Set the source endpoint direction. + /*! sets the source endpoint direction. * \param p the endpoint to set. */ void set_source(const Arr_extended_direction_3& p) { m_source = p; } - /*! Set the target endpoint direction. + /*! sets the target endpoint direction. * \param p the endpoint to set. */ void set_target(const Arr_extended_direction_3& p) { m_target = p; } - /*! Set the direction of the underlying plane. + /*! sets the direction of the underlying plane. * \param normal the plane direction. */ void set_normal(const Direction_3& normal) { m_normal = normal; } @@ -3404,46 +3402,46 @@ public: void set_is_degenerate(bool flag) { m_is_degenerate = flag; } void set_is_empty(bool flag) { m_is_empty = flag; } - /*! Obtain the source */ + /*! obtains the source */ const Arr_extended_direction_3& source() const { return m_source; } - /*! Obtain the target */ + /*! obtains the target */ const Arr_extended_direction_3& target() const { return m_target; } - /*! Obtain the normal to the containing plane */ + /*! obtains the normal to the containing plane */ const Direction_3& normal() const { return m_normal; } - /*! Obtain the (lexicographically) left endpoint direction */ + /*! obtains the (lexicographically) left endpoint direction */ const Arr_extended_direction_3& left() const { return (m_is_directed_right ? m_source : m_target); } - /*! Obtain the (lexicographically) right endpoint */ + /*! obtains the (lexicographically) right endpoint */ const Arr_extended_direction_3& right() const { return (m_is_directed_right ? m_target : m_source); } - /*! Determines whether the curve is vertical */ + /*! determines whether the curve is vertical */ bool is_vertical() const { return m_is_vertical; } - /*! Determines whether the curve is directed lexicographically from left to + /*! determines whether the curve is directed lexicographically from left to * right */ bool is_directed_right() const { return m_is_directed_right; } - /*! Determines whether the curve is a full circle */ + /*! determines whether the curve is a full circle */ bool is_full() const { return m_is_full; } - /*! Determines whether the curve is degenerate */ + /*! determines whether the curve is degenerate */ bool is_degenerate() const { return m_is_degenerate; } - /*! Determines whether the curve is degenerate */ + /*! determines whether the curve is degenerate */ bool is_empty() const { return m_is_empty; } - /*! Determines whether the curve is a meridian */ + /*! determines whether the curve is a meridian */ bool is_meridian() const { return left().is_min_boundary() && right().is_max_boundary(); } #if 0 - /*! Create a bounding box for the spherical_arc */ + /*! creates a bounding box for the spherical_arc */ Bbox_2 bbox() const { Kernel kernel; Segment_2 seg = kernel.construct_spherical_arc_2_object()(this->m_source, @@ -3452,7 +3450,7 @@ public: } #endif - /*! Flip the spherical_arc (swap it source and target) */ + /*! flips the spherical_arc (swap it source and target) */ Arr_x_monotone_geodesic_arc_on_sphere_3 opposite() const { Arr_x_monotone_geodesic_arc_on_sphere_3 opp; opp.m_source = this->m_target; @@ -3466,7 +3464,7 @@ public: return opp; } - /*! Determined whether a direction is contained in a plane + /*! determines whether a direction is contained in a plane * \param plane the 3D plane. * \param dir the 3D direction. * \return true if dir is contained in plane; false otherwise. @@ -3512,10 +3510,10 @@ protected: bool m_is_x_monotone; public: - /*! Default constructor - constructs an empty arc */ + /*! constructs default; constructs an empty arc */ Arr_geodesic_arc_on_sphere_3() : Base(), m_is_x_monotone(true) {} - /*! Copy constructor + /*! constructs copy * \param other the other arc */ #ifdef DOXYGEN_RUNNING @@ -3524,7 +3522,7 @@ public: { m_is_x_monotone = other.m_is_x_monotone; } #endif - /*! Constructor + /*! constructs * \param src the source point of the arc * \param trg the target point of the arc * \param normal the normal to the plane that contains the arc @@ -3553,7 +3551,7 @@ public: CGAL_precondition(this->has_on(trg)); } - /*! Construct a spherical_arc from two endpoint directions contained + /*! constructs a spherical_arc from two endpoint directions contained * in a plane. * \param plane the containing plane. * \param source the source-point direction. @@ -3675,7 +3673,7 @@ public: (!plane_is_positive && !ccib(d, t, s))); } - /*! Construct a full spherical_arc from a normal to a plane. + /*! constructs a full spherical_arc from a normal to a plane. * \param normal the normal to the plane containing the arc. */ Arr_geodesic_arc_on_sphere_3(const Direction_3& normal) { @@ -3688,18 +3686,18 @@ public: set_is_x_monotone(false); } - /*! Indicates whether the arc is \f$x\f$-monotone + /*! indicates whether the arc is \f$x\f$-monotone * \return true if the arc is \f$x\f$-monotone; false otherwise */ bool is_x_monotone() const { return m_is_x_monotone; } - /*! Set the flag that indicates whether the arc is \f$x\f$-monotone + /*! sets the flag that indicates whether the arc is \f$x\f$-monotone * \param flag indicates whether the arc is \f$x\f$-monotone */ void set_is_x_monotone(bool flag) { m_is_x_monotone = flag; } }; -/*! Inserter for the spherical_arc class used by the traits-class */ +/*! inserts a spherical_arc used by the traits-class */ template OutputStream& operator<<(OutputStream& os, const Arr_extended_direction_3& ed) { @@ -3721,7 +3719,7 @@ OutputStream& operator<<(OutputStream& os, return os; } -/*! Inserter for the spherical_arc class used by the traits-class */ +/*! inserters a spherical_arc used by the traits-class */ template OutputStream& operator<<(OutputStream& os, @@ -3742,7 +3740,7 @@ operator<<(OutputStream& os, return os; } -/*! Extractor for the spherical-arc point class used by the traits-class */ +/*! extracts a spherical-arc point used by the traits-class */ template InputStream& operator>>(InputStream& is, Arr_extended_direction_3& point) { @@ -3757,7 +3755,7 @@ operator>>(InputStream& is, Arr_extended_direction_3& point) { return is; } -/*! Extractor for the spherical_arc class used by the traits-class */ +/*! extracts a spherical_arc used by the traits-class */ template InputStream& operator>>(InputStream& is, diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_cache.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_cache.h index 0d30f01166c..9598456cd59 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_cache.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_cache.h @@ -63,7 +63,7 @@ public: Algebraic x; // The x-coordinate. Algebraic y; // The y-coordinate. - /*! Constructor. */ + /*! constructs. */ Intersection_point (const Algebraic& _s, const Algebraic& _t, const Algebraic& _x, const Algebraic& _y) : s(_s), t(_t), @@ -124,7 +124,7 @@ private: app_y (0) {} - /*! Constructor. */ + /*! constructs. */ My_point_2 (typename Parameter_list::const_iterator it, const Algebraic& _x, const Algebraic& _y) : prm_it (it), @@ -134,7 +134,7 @@ private: app_y (CGAL::to_double(_y)) {} - /*! Get the parameter value. */ + /*! obtains the parameter value. */ const Algebraic& parameter () const { return (*prm_it); @@ -177,7 +177,7 @@ private: public: - /*! Constructor. */ + /*! constructs. */ _Bezier_cache () {} @@ -869,6 +869,6 @@ _Bezier_cache::_compute_resultant return (det); } -} //namespace CGAL +} // namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_point_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_point_2.h index a2318c0d7d1..83161c83b46 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_point_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_point_2.h @@ -95,7 +95,7 @@ private: public: - /*! Constructor, given an exact algebraic representation. */ + /*! constructs, given an exact algebraic representation. */ Originator (const Curve_2& c, const Algebraic& t) : _curve (c), _xid (0), @@ -104,7 +104,7 @@ private: set_parameter (t); } - /*! Constructor, given an exact algebraic representation. */ + /*! constructs, given an exact algebraic representation. */ Originator (const Curve_2& c, unsigned int xid, const Algebraic& t) : _curve (c), @@ -114,7 +114,7 @@ private: set_parameter (t); } - /*! Constructor with bounding information and no exact representation. */ + /*! constructs with bounding information and no exact representation. */ Originator (const Curve_2& c, const Bez_point_bound& bpb) : _curve (c), _xid (0), @@ -122,7 +122,7 @@ private: p_t (nullptr) {} - /*! Constructor with bounding information and no exact representation. */ + /*! constructs with bounding information and no exact representation. */ Originator (const Curve_2& c, unsigned int xid, const Bez_point_bound& bpb) : _curve (c), @@ -174,19 +174,19 @@ private: return (*this); } - /*! Get the originating curve. */ + /*! obtains the originating curve. */ const Curve_2& curve () const { return (_curve); } - /*! Get the serial number of the originating x-monotone curve. */ + /*! obtains the serial number of the originating x-monotone curve. */ unsigned int xid () const { return (_xid); } - /*! Get the bounding information. */ + /*! obtains the bounding information. */ const Bez_point_bound& point_bound () const { return (_bpb); @@ -264,7 +264,7 @@ private: BoundNT t_min; /*!< Minimal parameter value. */ BoundNT t_max; /*!< Maximal parameter value. */ - /*! Constructor given control points an a t-range. */ + /*! constructs given control points an a t-range. */ Subcurve (const Control_points& _ctrl, const BoundNT& _tmin, const BoundNT& _tmax) : @@ -273,7 +273,7 @@ private: t_max (_tmax) {} - /*! Constructor given a t-range. */ + /*! constructs given a t-range. */ Subcurve (const BoundNT& _tmin, const BoundNT& _tmax) : t_min (_tmin), @@ -924,7 +924,7 @@ public: _rep()._bbox = bbox; } - /*! Get the bounding box of the point. */ + /*! obtains the bounding box of the point. */ void get_bbox (typename Bounding_traits::NT& min_x, typename Bounding_traits::NT& min_y, typename Bounding_traits::NT& max_x, @@ -938,13 +938,13 @@ public: private: - /*! Get the representation (const version). */ + /*! obtains the representation (const version). */ inline const Bpt_rep& _rep () const { return (*(this->ptr())); } - /*! Get the representation (non-const version). */ + /*! obtains the representation (non-const version). */ inline Bpt_rep& _rep () { return (*(this->ptr())); @@ -1701,6 +1701,6 @@ void _Bezier_point_2_rep::_make_exact CGAL_error(); } -} //namespace CGAL +} // namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_x_monotone_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_x_monotone_2.h index 02bd94b4e21..ba17acc09ad 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_x_monotone_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Bezier_x_monotone_2.h @@ -130,7 +130,7 @@ private: Rational t_min; Rational t_max; - /*! Get the rational bounding box of the subcurve. */ + /*! obtains the rational bounding box of the subcurve. */ void bbox(Rational& x_min, Rational& y_min, Rational& x_max, Rational& y_max) const { @@ -464,7 +464,7 @@ private: const Point_2& p, Bezier_cache& cache) const; - /*! Get the range of t-value over which the subcurve is defined. + /*! obtains the range of t-value over which the subcurve is defined. * \param cache Caches the vertical tangency points and intersection points. * \return A pair comprised of the t-value for the source point and the * t-value for the target point. @@ -2585,6 +2585,6 @@ _exact_vertical_position(const Point_2& p, return EQUAL; } -} //namespace CGAL +} // namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Circle_segment_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Circle_segment_2.h index dfa75584c53..9c799d7b76a 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Circle_segment_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Circle_segment_2.h @@ -50,13 +50,13 @@ private: CoordNT _y; public: - /*! Default constructor. */ + /*! constructs default. */ _One_root_point_2_rep() : _x(0), _y(0) {} - /*! Constructor of a point with one-root coefficients. + /*! constructs a point with one-root coefficients. This constructor of a point can also be used with rational coefficients thanks to convertor of CoordNT. */ _One_root_point_2_rep(const CoordNT& x, const CoordNT& y) : @@ -83,28 +83,29 @@ private: public: typedef typename Point_rep::CoordNT CoordNT; - /*! Default constructor. */ + /*! constructs default. */ _One_root_point_2() : Point_handle(Point_rep()) {} - /*! Copy constructor. */ + /*! constructs copy. */ _One_root_point_2(const Self& p) : Point_handle(p) {} _One_root_point_2& operator=(const _One_root_point_2&)=default; - /*! Constructor of a point with one-root coefficients. - This constructor of a point can also be used with rational coefficients - thanks to convertor of CoordNT. */ + /*! constructs a point with one-root coefficients. + * This constructor of a point can also be used with rational coefficients + * thanks to convertor of CoordNT. + */ _One_root_point_2(const CoordNT& x, const CoordNT& y) : Point_handle(Point_rep(x, y)) {} - /*! Get the x-coordinate. */ + /*! obtains the x-coordinate. */ const CoordNT& x() const { return (this->ptr()->_x); } - /*! Get the y-coordinate. */ + /*! obtains the y-coordinate. */ const CoordNT& y() const { return (this->ptr()->_y); } - /*! Check for equality. */ + /*! checks for equality. */ bool equals(const Self& p) const { if (this->identical(p)) return (true); @@ -117,7 +118,7 @@ public: bool operator == (const Self& p) const { return equals(p); } - /*! Set the point coordinates. */ + /*! sets the point coordinates. */ void set(const NT& x, const NT& y) { this->copy_on_write(); @@ -126,7 +127,7 @@ public: return; } - /*! Set the point coordinates. */ + /*! sets the point coordinates. */ void set(const CoordNT& x, const CoordNT& y) { this->copy_on_write(); @@ -136,8 +137,7 @@ public: } }; -/*! - * Exporter for conic arcs. +/*! exports a conic arc. */ template std::ostream& operator<<(std::ostream& os, @@ -187,14 +187,14 @@ protected: Orientation m_orient; // The orientation (COLLINEAR for line segments). public: - /*! Default constructor. */ + /*! constructs default. */ _Circle_segment_2() : m_is_full(false), m_has_radius(false), m_orient(COLLINEAR) {} - /*! Constructor from a line segment. + /*! constructs from a line segment. * \param seg The segment. */ _Circle_segment_2(const Segment_2& seg) : @@ -206,7 +206,7 @@ public: m_orient(COLLINEAR) {} - /*! Constructor from of a line segment. + /*! constructs from of a line segment. * \param ps The source point. * \param pt The target point. */ @@ -220,7 +220,7 @@ public: m_orient(COLLINEAR) {} - /*! Constructor of a segment, given a supporting line and two endpoints, + /*! constructs a segment, given a supporting line and two endpoints, * which need not necessarily have rational coordinates. * \param line The supporting line. * \param source The source point. @@ -243,7 +243,7 @@ public: -target.y() * line.b()) == EQUAL); } - /*! Constructor from a circle. + /*! constructs from a circle. * \param circ The circle. */ _Circle_segment_2(const Circle_2& circ) : @@ -253,7 +253,7 @@ public: m_orient(circ.orientation()) { CGAL_assertion(m_orient != COLLINEAR); } - /*! Constructor from a circle. + /*! constructs from a circle. * \param c The circle center. * \param r The radius. * \param orient The orientation of the circle. @@ -267,7 +267,7 @@ public: m_orient(orient) { CGAL_assertion (orient != COLLINEAR); } - /*! Constructor of a circular arc, given a supporting circle and two + /*! constructs a circular arc, given a supporting circle and two * endpoints, which need not necessarily have rational coordinates. * The orientation of the circle determines the orientation of the arc. * \param circ The supporting circle. @@ -297,7 +297,7 @@ public: CGAL::square(target.y() - circ.center().y())) == EQUAL); } - /*! Constructor of a circular arc, given a supporting circle and two + /*! constructs a circular arc, given a supporting circle and two * endpoints, which need not necessarily have rational coordinates. * \param c The circle center. * \param r The radius. @@ -330,7 +330,7 @@ public: CGAL::square(target.y() - c.y())) == EQUAL); } - /*! Constructor of a circular arc, from the given three points, in case of + /*! constructs a circular arc, from the given three points, in case of * three collinear points, a segment will be constructed. * \param p1 The arc source. * \param p2 A point in the interior of the arc. @@ -408,19 +408,19 @@ public: m_circ = Circle_2(circ_center, sqr_rad, m_orient); } - /*! Get the orientation of the curve. + /*! obtains the orientation of the curve. * \return COLLINEAR in case of a line segment, * CLOCKWISE or COUNTERCLOCKWISE for circular curves. */ inline Orientation orientation() const { return (m_orient); } - /*! Check if the arc is linear. */ + /*! checks if the arc is linear. */ inline bool is_linear() const { return (m_orient == COLLINEAR); } - /*! Check if the arc is circular. */ + /*! checks if the arc is circular. */ inline bool is_circular() const { return (m_orient != COLLINEAR); } - /*! Obtain the supporting line. + /*! obtains the supporting line. * \pre The curve orientation is COLLINEAR. */ const Line_2& supporting_line() const @@ -429,7 +429,7 @@ public: return m_line; } - /*! Obtain the supporting circle. + /*! obtains the supporting circle. * \pre The curve orientation is not COLLINEAR. */ const Circle_2& supporting_circle() const @@ -438,11 +438,10 @@ public: return m_circ; } - /*! Check if the curve is a full circle. */ + /*! checks if the curve is a full circle. */ bool is_full() const { return (m_is_full); } - /*! - * Get the source point. + /*! obtains the source point. * \pre The curve is not a full circle. */ const Point_2& source() const @@ -451,8 +450,7 @@ public: return (m_source); } - /*! - * Get the target point. + /*! obtains the target point. * \pre The curve is not a full circle. */ const Point_2& target() const @@ -461,7 +459,7 @@ public: return (m_target); } - /*! Get the vertical tangency points the arc contains. + /*! obtains the vertical tangency points the arc contains. * \param vpts Output: The vertical tangency points. * \pre The curve is circular. * \return The number of points (0, 1, or 2). @@ -514,7 +512,7 @@ public: } private: - /*! Obtain the vertical tangency points the arc contains, assuming it is + /*! obtains the vertical tangency points the arc contains, assuming it is * counterclockwise oriented. * \param vpts Output: The vertical tangency points. * \return The number of points (0, 1, or 2). @@ -580,7 +578,7 @@ private: return (n_vpts); } - /*! Obtain the index of the quarter-plane containing the given point, + /*! obtains the index of the quarter-plane containing the given point, * where the circle center is considered to be the origin. */ int _quart_index(const Point_2& p) const @@ -606,7 +604,7 @@ private: } }; -/*! Exporter for line segments and circular arcs. +/*! exports a line segments or a circular arc. */ template std::ostream& @@ -648,8 +646,7 @@ public: typedef std::pair Intersection_point; typedef std::list Intersection_list; - /*! - * \struct Less functor for Curve_id_pair. + /*! \struct Less functor for Curve_id_pair. */ struct Less_id_pair { bool operator()(const Curve_id_pair& ip1, const Curve_id_pair& ip2) const @@ -692,7 +689,7 @@ protected: // The rest of the bits represent the curve index. public: - /*! Default constructor. + /*! constructs default. */ _X_monotone_circle_segment_2() : m_first(), @@ -703,7 +700,7 @@ public: m_info(0) {} - /*! Construct an arc from a line segment. + /*! constructs an arc from a line segment. * \param line The supporting line. * \param source The source point. * \param target The target point. @@ -734,7 +731,7 @@ public: if (res == SMALLER) m_info = (m_info | IS_DIRECTED_RIGHT_MASK); } - /*! Construct a segment arc from two kernel points + /*! constructs a segment arc from two kernel points * \param source the source point. * \ param target the target point. * \pre source and target are not equal. @@ -766,7 +763,7 @@ public: if (res == SMALLER) m_info = (m_info | IS_DIRECTED_RIGHT_MASK); } - /*! Construct a circular arc. + /*! constructs a circular arc. * \param line The supporting line. * \param source The source point. * \param target The target point. @@ -795,14 +792,14 @@ public: else m_info = (m_info | CLOCKWISE_CODE); } - /*! Check if the arc is linear. */ + /*! checks if the arc is linear. */ inline bool is_linear () const { return ((m_info & ORIENTATION_MASK) == 0); } - /*! Check if the arc is circular. */ + /*! checks if the arc is circular. */ inline bool is_circular () const { return ((m_info & ORIENTATION_MASK) != 0); } - /*! Obtain the supporting line. + /*! obtains the supporting line. * \pre The arc is linear (a line segment). */ Line_2 supporting_line() const @@ -811,7 +808,7 @@ public: return (Line_2 (a(), b(), c())); } - /*! Obtain the supporting circle. + /*! obtains the supporting circle. * \pre The arc is circular. */ Circle_2 supporting_circle() const @@ -822,13 +819,13 @@ public: return (Circle_2(center , sqr_r(), orientation())); } - /*! Get the source point. */ + /*! obtains the source point. */ inline const Point_2& source() const { return (m_source); } - /*! Get the target point. */ + /*! obtains the target point. */ inline const Point_2& target() const { return (m_target); } - /*! True if the arc is directed right, false otherwise. */ + /*! returns true if the arc is directed right, false otherwise. */ bool is_directed_right() const { return ((m_info & IS_DIRECTED_RIGHT_MASK) != 0); } @@ -836,15 +833,15 @@ public: bool has_right() const { return true; } - /*! Get the left endpoint of the arc. */ + /*! obtains the left endpoint of the arc. */ inline const Point_2& left() const { return (((m_info & IS_DIRECTED_RIGHT_MASK) != 0) ? m_source : m_target); } - /*! Get the right endpoint of the arc. */ + /*! obtains the right endpoint of the arc. */ inline const Point_2& right() const { return (((m_info & IS_DIRECTED_RIGHT_MASK) != 0) ? m_target : m_source); } - /*! Check whether the given point is in the x-range of the arc. + /*! checks whether the given point is in the x-range of the arc. */ bool is_in_x_range(const Point_2& p) const { @@ -856,11 +853,11 @@ public: return (CGAL::compare (p.x(), right().x()) != LARGER); } - /*! Check if the arc is a vertical segment. */ + /*! checks if the arc is a vertical segment. */ inline bool is_vertical() const { return ((m_info & IS_VERTICAL_SEGMENT_MASK) != 0); } - /*! Get the orientation of the arc. */ + /*! obtains the orientation of the arc. */ inline Orientation orientation() const { unsigned int or_ = (m_info & ORIENTATION_MASK); @@ -871,7 +868,7 @@ public: return (CGAL::COLLINEAR); } - /*! Check the position of a given point with respect to the arc. + /*! checks the position of a given point with respect to the arc. */ Comparison_result point_position(const Point_2& p) const { @@ -879,7 +876,7 @@ public: else return (_circ_point_position (p)); } - /*! Compare the two arcs to the right of their intersection point. + /*! compares the two arcs to the right of their intersection point. */ Comparison_result compare_to_right(const Self& cv, const Point_2& p) const { @@ -895,7 +892,7 @@ public: } } - /*! Compare the two arcs to the left of their intersection point. + /*! compares the two arcs to the left of their intersection point. */ Comparison_result compare_to_left(const Self& cv, const Point_2& p) const { @@ -911,7 +908,7 @@ public: } } - /*! Check whether the two arcs have the same supporting curve. + /*! checks whether the two arcs have the same supporting curve. */ bool has_same_supporting_curve(const Self& cv) const { @@ -951,7 +948,7 @@ public: CGAL::compare(fact2*c(), fact1*cv.c()) == EQUAL); } - /*! Check whether the two curves are equal. + /*! checks whether the two curves are equal. */ bool equals(const Self& cv) const { @@ -970,7 +967,7 @@ public: m_source.equals(cv.m_target) && m_target.equals(cv.m_source))); } - /*! Split the curve at a given point into two sub-arcs. + /*! splits the curve at a given point into two sub-arcs. */ void split(const Point_2& p, Self& c1, Self& c2) const { @@ -989,7 +986,7 @@ public: } } - /*! Compute the intersections between the two arcs or segments. + /*! computes the intersections between the two arcs or segments. */ template OutputIterator intersect(const Self& cv, OutputIterator oi, @@ -1076,7 +1073,7 @@ public: return oi; } - /*! Check whether it is possible to merge our arc with the given arc. + /*! checks whether it is possible to merge our arc with the given arc. */ bool can_merge_with(const Self& cv) const { @@ -1089,7 +1086,7 @@ public: return (right().equals(cv.left()) || left().equals(cv.right())); } - /*! Merge our arc with the given arc. + /*! merges our arc with the given arc. * \pre The two arcs are mergeable. */ void merge(const Self& cv) @@ -1111,7 +1108,7 @@ public: } } - /*! construct an opposite arc. */ + /*! constructs an opposite arc. */ Self construct_opposite() const { Self opp_cv; @@ -1153,23 +1150,22 @@ public: } protected: - /*! Get the curve index. */ + /*! obtains the curve index. */ inline unsigned int _index() const { return (m_info >> INDEX_SHIFT_BITS); } /// \name Accessors for circular arcs. //@{ - /*! Get the x-coordinate of the center of the supporting circle. */ + /*! obtains the x-coordinate of the center of the supporting circle. */ inline const NT& x0() const { return (m_first); } - /*! Get the y-coordinate of the center of the supporting circle. */ + /*! obtains the y-coordinate of the center of the supporting circle. */ inline const NT& y0() const { return (m_second); } - /*! Get the squared radius of the supporting circle. */ + /*! obtains the squared radius of the supporting circle. */ inline const NT& sqr_r() const { return (m_third); } - /*! - * Check if the circular arc lies on the upper half of the supporting circle. + /*! checks if the circular arc lies on the upper half of the supporting circle. */ inline bool _is_upper() const { @@ -1186,21 +1182,20 @@ protected: /// \name Accessors for line segments. //@{ - /*! Get the coefficient of x in the equation of the supporting line. */ + /*! obtains the coefficient of x in the equation of the supporting line. */ inline const NT& a() const { return (m_first); } - /*! Get the coefficient of y in the equation of the supporting line. */ + /*! obtains the coefficient of y in the equation of the supporting line. */ inline const NT& b() const { return (m_second); } - /*! Get the free coefficient in the equation of the supporting line. */ + /*! obtains the free coefficient in the equation of the supporting line. */ inline const NT& c() const { return (m_third); } //@} /// \name Auxiliary functions for the point_position predicate. //@{ - /*! - * Check the position of a given point with respect to a line segment. + /*! checks the position of a given point with respect to a line segment. */ Comparison_result _line_point_position(const Point_2& p) const { @@ -1232,8 +1227,7 @@ protected: return (CGAL::compare (p.y(), y_proj)); } - /*! - * Check the position of a given point with respect to a circular arc. + /*! checks the position of a given point with respect to a circular arc. */ Comparison_result _circ_point_position(const Point_2& p) const { @@ -1274,8 +1268,7 @@ protected: /// \name Auxiliary functions for the compare_to_right predicate. //@{ - /*! - * Compare two line segments to the right of their intersection point. + /*! compares two line segments to the right of their intersection point. */ Comparison_result _lines_compare_to_right(const Self& cv, const Point_2& /* p */) const @@ -1295,8 +1288,7 @@ protected: return (CGAL::compare (cv.a()/cv.b(), a()/b())); } - /*! - * Compare a circular arcs (this) and a line segment (cv) to the right of + /*! compares a circular arcs (this) and a line segment (cv) to the right of * their intersection point. */ Comparison_result _circ_line_compare_to_right(const Self& cv, @@ -1339,7 +1331,7 @@ protected: return (_is_upper() ? SMALLER : LARGER); } - /*! Compare two circular arcs to the right of their intersection point. + /*! compares two circular arcs to the right of their intersection point. */ Comparison_result _circs_compare_to_right(const Self& cv, const Point_2& p) const @@ -1471,8 +1463,7 @@ protected: /// \name Auxiliary functions for the compare_to_left predicate. //@{ - /*! - * Compare two line segments to the left of their intersection point. + /*! compares two line segments to the left of their intersection point. */ Comparison_result _lines_compare_to_left(const Self& cv, const Point_2& ) const @@ -1494,7 +1485,7 @@ protected: return (CGAL::compare (a()/b(), cv.a()/cv.b())); } - /*! Compare a circular arcs (this) and a line segment (cv) to the left of + /*! compares a circular arcs (this) and a line segment (cv) to the left of * their intersection point. */ Comparison_result _circ_line_compare_to_left(const Self& cv, @@ -1540,8 +1531,7 @@ protected: return (_is_upper() ? SMALLER : LARGER); } - /*! - * Compare the two arcs to the left of their intersection point. + /*! compares the two arcs to the left of their intersection point. */ Comparison_result _circs_compare_to_left(const Self& cv, const Point_2& p) const @@ -1675,7 +1665,7 @@ protected: /// \name Auxiliary functions for computing intersections. //@{ - /*! Compute the intersections between two line segments. + /*! computes the intersections between two line segments. */ void _lines_intersect(const Self& cv, Intersection_list& inter_list) const @@ -1701,7 +1691,7 @@ protected: inter_list.push_back(Intersection_point(p, mult)); } - /*! Compute the intersections between the supporting circle of (*this) and + /*! computes the intersections between the supporting circle of (*this) and * the supporting line of the segment cv. */ void _circ_line_intersect(const Self& cv, @@ -1826,7 +1816,7 @@ protected: } } - /*! Compute the intersections between two circles. + /*! computes the intersections between two circles. */ void _circs_intersect(const Self& cv, Intersection_list& inter_list) const { @@ -1891,7 +1881,7 @@ protected: } } - /*! Check if the given point lies on the arc. + /*! checks if the given point lies on the arc. * \pre p lies on the supporting curve. */ bool _is_between_endpoints(const Point_2& p) const @@ -1928,7 +1918,7 @@ protected: return (this->is_in_x_range(p)); } - /*! Check whether the given point lies in the interior of the arc. + /*! checks whether the given point lies in the interior of the arc. * \pre p lies on the supporting curve. */ bool _is_strictly_between_endpoints(const Point_2& p) const @@ -1937,7 +1927,7 @@ protected: return (_is_between_endpoints(p)); } - /*! Compute the overlap with a given arc having the same supporting curve. + /*! computes the overlap with a given arc having the same supporting curve. * \param cv The given arc. * \param overlap Output: The overlapping arc (if any). * \return Whether we found an overlap. @@ -2048,7 +2038,7 @@ protected: *oi++ = std::make_pair(x_right, y_right); // The right point. } - /*! Trim the arc given its new endpoints. + /*! trims the arc given its new endpoints. * \param ps The new source point. * \param pt The new target point. * \return The new trimmed arc. @@ -2068,7 +2058,7 @@ protected: //@} }; -/*! Exporter for circular arcs (or line segments). +/*! exports a circular arcs or a line segment */ template std::ostream& @@ -2082,6 +2072,6 @@ operator<<(std::ostream& os, return (os); } -} //namespace CGAL +} // namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_arc_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_arc_2.h index c115673ff53..b0bd7fd018e 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_arc_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_arc_2.h @@ -105,7 +105,7 @@ public: /// \name Deprecated Constructions. //@{ - /*!Construct a conic arc which is the full conic: + /*! constructs a conic arc which is the full conic: * C: r*x^2 + s*y^2 + t*xy + u*x + v*y + w = 0 * \pre The conic C must be an ellipse (so 4rs - t^2 > 0). */ @@ -129,7 +129,7 @@ public: _set_full(rat_coeffs, true); } - /*! Construct a conic arc which lies on the conic: + /*! constructs a conic arc which lies on the conic: * C: r*x^2 + s*y^2 + t*xy + u*x + v*y + w = 0 * \param orient The orientation of the arc (clockwise or counterclockwise). * \param source The source point. @@ -156,7 +156,7 @@ public: _set(rat_coeffs); } - /*! Construct a segment conic arc from two endpoints. + /*! constructs a segment conic arc from two endpoints. * \param source the source point with rational coordinates. */ CGAL_DEPRECATED Conic_arc_2(const Point_2& source, const Point_2& target) : @@ -186,7 +186,7 @@ public: m_extra_data->side = ZERO; } - /*! Construct a conic arc from the given line segment. + /*! constructs a conic arc from the given line segment. * \param seg The line segment with rational endpoints. */ CGAL_DEPRECATED Conic_arc_2 (const Rat_segment_2& seg) : @@ -241,7 +241,7 @@ public: _set(rat_coeffs); } - /*! Set a circular arc that corresponds to a full circle. + /*! sets a circular arc that corresponds to a full circle. * \param circ The circle (with rational center and rational squared radius). */ CGAL_DEPRECATED Conic_arc_2(const Rat_circle_2& circ) : @@ -277,7 +277,7 @@ public: _set_full(rat_coeffs, false); } - /*! Set a circular arc that lies on the given circle: + /*! sets a circular arc that lies on the given circle: * C: (x - x0)^2 + (y - y0)^2 = R^2 * \param orient The orientation of the circle. * \param source The source point. @@ -342,7 +342,7 @@ public: _set(rat_coeffs); } - /*! Construct a circular arc from the given three points. + /*! constructs a circular arc from the given three points. * \param p1 The arc source. * \param p2 A point in the interior of the arc. * \param p3 The arc target. @@ -424,7 +424,7 @@ public: _set(rat_coeffs); } - /*! Construct a conic arc from the given five points, specified by the + /*! constructs a conic arc from the given five points, specified by the * points p1, p2, p3, p4 and p5. * \param p1 The source point of the given arc. * \param p2,p3,p4 Points lying on the conic arc, between p1 and p5. @@ -515,7 +515,7 @@ public: } } - /*! Construct a conic arc which lies on the conic: + /*! constructs a conic arc which lies on the conic: * C: r*x^2 + s*y^2 + t*xy + u*x + v*y + w = 0 * The source and the target are specified by the intersection of the * conic with: @@ -684,7 +684,7 @@ public: _set(rat_coeffs); } - /*! Get a bounding box for the conic arc. + /*! obtains a bounding box for the conic arc. * \return The bounding box. */ CGAL_DEPRECATED Bbox_2 bbox() const { @@ -769,7 +769,7 @@ public: //@} protected: - /*! Calculate the vertical tangency points of the arc. + /*! calculates the vertical tangency points of the arc. * \param vpts The vertical tangency points. * \pre The vpts vector should be allocated at the size of 2. * \return The number of vertical tangency points. @@ -797,7 +797,7 @@ protected: return m; } - /*! Calculate the horizontal tangency points of the arc. + /*! calculates the horizontal tangency points of the arc. * \param hpts The horizontal tangency points. * \pre The hpts vector should be allocated at the size of 2. * \return The number of horizontal tangency points. @@ -825,7 +825,7 @@ protected: return m; } - /*! Check whether the given point is strictly between the source and the + /*! checks whether the given point is strictly between the source and the * target (but not any of them). * The point is assumed to be on the conic's boundary. * \param p The query point. @@ -892,7 +892,7 @@ protected: } } - /*! Find the vertical tangency points of the underlying conic. + /*! finds the vertical tangency points of the underlying conic. * \param ps The output points of vertical tangency. * This area must be allocated at the size of 2. * \return The number of vertical tangency points. @@ -970,7 +970,7 @@ protected: return n; } - /*! Find the horizontal tangency points of the underlying conic. + /*! finds the horizontal tangency points of the underlying conic. * \param ps The output points of horizontal tangency. * This area must be allocated at the size of 2. * \return The number of horizontal tangency points. @@ -1020,7 +1020,7 @@ protected: return n; } - /*! Set the properties of a conic arc that is really a full curve + /*! sets the properties of a conic arc that is really a full curve * (that is, an ellipse). * \param rat_coeffs A vector of size 6, storing the rational coefficients * of x^2, y^2, xy, x, y and the free coefficient resp. @@ -1074,7 +1074,7 @@ protected: else reset_flags(); // invalid arc } - /*! Check whether the given point lies on the supporting conic of the arc. + /*! checks whether the given point lies on the supporting conic of the arc. * \param p The query point. * \return (true) if p lies on the supporting conic; (false) otherwise. */ @@ -1093,7 +1093,7 @@ protected: return (CGAL::sign(val) == ZERO); } - /*! Build the data for hyperbolic arc, containing the characterization of the + /*! builds the data for hyperbolic arc, containing the characterization of the * hyperbolic branch the arc is placed on. */ CGAL_DEPRECATED void _build_hyperbolic_arc_data() { @@ -1189,7 +1189,7 @@ protected: sign_of_extra_data(m_target.x(), m_target.y())); } - /*! Check whether the given point is between the source and the target. + /*! checks whether the given point is between the source and the target. * The point is assumed to be on the conic's boundary. * \param p The query point. * \return (true) if the point is between the two endpoints, @@ -1206,7 +1206,7 @@ protected: else return _is_strictly_between_endpoints(p); } - /*! Find the y coordinates of the underlying conic at a given x coordinate. + /*! finds the y coordinates of the underlying conic at a given x coordinate. * \param x The x coordinate. * \param ys The output y coordinates. * \pre The vector ys must be allocated at the size of 2. @@ -1224,7 +1224,7 @@ protected: return (_solve_quadratic_equation(A, B, C, ys[0], ys[1])); } - /*! Find all points on the arc with a given x-coordinate. + /*! finds all points on the arc with a given x-coordinate. * \param p A placeholder for the x-coordinate. * \param ps The point on the arc at x(p). * \pre The vector ps should be allocated at the size of 2. @@ -1248,7 +1248,7 @@ protected: return m; } - /*! Solve the given quadratic equation: Ax^2 + B*x + C = 0. + /*! solves the given quadratic equation: Ax^2 + B*x + C = 0. * \param x_minus The root obtained from taking -sqrt(discriminant). * \param x_plus The root obtained from taking -sqrt(discriminant). * \return The number of disticnt solutions to the equation. @@ -1289,7 +1289,7 @@ protected: return 2; } - /*! Find the x coordinates of the underlying conic at a given y coordinate. + /*! finds the x coordinates of the underlying conic at a given y coordinate. * \param y The y coordinate. * \param xs The output x coordinates. * \pre The vector xs must be allocated at the size of 2. @@ -1308,7 +1308,7 @@ protected: return (_solve_quadratic_equation(A, B, C, xs[0], xs[1])); } - /*! Find all points on the arc with a given y-coordinate. + /*! finds all points on the arc with a given y-coordinate. * \param p A placeholder for the y-coordinate. * \param ps The point on the arc at x(p). * \pre The vector ps should be allocated at the size of 2. @@ -1332,7 +1332,7 @@ protected: return m; } - /*! Set the properties of a conic arc (for the usage of the constructors). + /*! sets the properties of a conic arc (for the usage of the constructors). * \param rat_coeffs A vector of size 6, storing the rational coefficients * of x^2, y^2, xy, x, y and the free coefficient resp. */ @@ -1454,7 +1454,7 @@ public: /// \name Construction and destruction functions. //@{ - /*! Default constructor. + /*! constructs default. */ Conic_arc_2() : m_r(0), m_s(0), m_t(0), m_u(0), m_v(0), m_w(0), @@ -1463,7 +1463,7 @@ public: m_extra_data(nullptr) {} - /*! Copy constructor. + /*! constructs copy. * \param arc The copied arc. */ Conic_arc_2(const Self& arc) : @@ -1478,11 +1478,11 @@ public: new Extra_data(*(arc.m_extra_data)) : nullptr; } - /*! Destructor. + /*! destructs. */ virtual ~Conic_arc_2() { if (m_extra_data != nullptr) delete m_extra_data; } - /*! Assignment operator. + /*! assigns. * \param arc The copied arc. */ const Self& operator=(const Self& arc) { @@ -1515,15 +1515,15 @@ public: /// \name Get the arc properties. //@{ - /*! Determine whether the arc is valid. + /*! determines whether the arc is valid. */ bool is_valid() const { return test_flag(IS_VALID); } - /*! Determine whether the arc represents a full conic curve. + /*! determines whether the arc represents a full conic curve. */ bool is_full_conic() const { return test_flag(IS_FULL_CONIC); } - /*! Obtain the coefficients of the underlying conic. + /*! obtains the coefficients of the underlying conic. */ const Integer& r() const { return (m_r); } const Integer& s() const { return (m_s); } @@ -1532,7 +1532,7 @@ public: const Integer& v() const { return (m_v); } const Integer& w() const { return (m_w); } - /*! Obtain the arc's source. + /*! obtains the arc's source. * \return The source point. * \pre The arc does not represent a full conic curve. */ @@ -1541,14 +1541,14 @@ public: return m_source; } - /*! Obtain the non const reference to the curve source point. + /*! obtains the non const reference to the curve source point. */ Point_2& source() { CGAL_precondition(! is_full_conic()); return (this->m_source); } - /*! Obtain the arc's target. + /*! obtains the arc's target. * \return The target point. * \pre The arc does not represent a full conic curve. */ @@ -1557,19 +1557,19 @@ public: return m_target; } - /*! Obtain the non const reference to the curve source point. + /*! obtains the non const reference to the curve source point. */ Point_2& target() { CGAL_precondition(! is_full_conic()); return this->m_target; } - /*! Obtain the orientation of the arc. + /*! obtains the orientation of the arc. * \return The orientation. */ Orientation orientation() const { return m_orient; } - /*! Obtain the extra data. + /*! obtains the extra data. */ const Extra_data* extra_data() const { return m_extra_data; } //@} @@ -1603,17 +1603,17 @@ public: // only friends have the privilege to use. //@{ - /*! Set the source point of the conic arc. + /*! sets the source point of the conic arc. * \param ps The new source point. */ void set_source(const Point_2& ps) { m_source = ps; } - /*! Set the target point of the conic arc. + /*! sets the target point of the conic arc. * \param pt The new source point. */ void set_target(const Point_2& pt) { m_target = pt; } - /*! Set the coefficients. + /*! sets the coefficients. */ void set_coefficients(Integer r, Integer s, Integer t, Integer u, Integer v, Integer w) { @@ -1625,22 +1625,22 @@ public: m_w = w; } - /*! Set the orientation. + /*! sets the orientation. */ void set_orientation(Orientation orient) { m_orient = orient; } - /*! Set the endpoints. + /*! sets the endpoints. */ void set_endpoints(const Point_2& source, const Point_2& target) { m_source = source; m_target = target; } - /*! Set the extra data field. + /*! sets the extra data field. */ void set_extra_data(Extra_data* extra_data) { m_extra_data = extra_data; } - /*! Set the extra data field. + /*! sets the extra data field. */ void set_extra_data(const Algebraic& a, const Algebraic& b, const Algebraic& c, Sign side) @@ -1652,7 +1652,7 @@ public: m_extra_data->side = side; } - /*! Update the extra data field. + /*! updates the extra data field. */ void update_extra_data() { const Algebraic x1 = source().x(); @@ -1675,7 +1675,7 @@ public: /// \name Auxiliary functions. //@{ - /*! Evaluate the sign of (a*x + b*y + c) stored with the extra data field + /*! evaluates the sign of (a*x + b*y + c) stored with the extra data field * at a given point. * \param px The x-coordinate of query point. * \param py The y-coordinate of query point. @@ -1691,7 +1691,7 @@ public: //@} }; -/*! Exporter for conic arcs. +/*! exports a conic arc. */ template std::ostream& @@ -1721,6 +1721,6 @@ operator<< (std::ostream& os, return os; } -} //namespace CGAL +} // namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_x_monotone_arc_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_x_monotone_arc_2.h index 97f8dd74181..c9e17b4d85f 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_x_monotone_arc_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Conic_x_monotone_arc_2.h @@ -88,7 +88,7 @@ public: /// \name Deprecated Constructions. //@{ - // /*! Construct an x-monotone arc from a conic arc. + // /*! constructs an x-monotone arc from a conic arc. // * \param arc The given (base) arc. // * \param id The ID of the base arc. // */ @@ -100,7 +100,7 @@ public: // _set(); // } - /*! Construct an x-monotone sub-arc from a conic arc. + /*! constructs an x-monotone sub-arc from a conic arc. * \param arc The given (base) arc. * \param source The source point. * \param target The target point. @@ -118,7 +118,7 @@ public: _set(); } - /*! Construct a special segment connecting to given endpoints (for the usage + /*! constructs a special segment connecting to given endpoints (for the usage * of the landmarks point-location strategy). * \param source The source point. * \param target The target point. @@ -141,7 +141,7 @@ public: set_flag(IS_SPECIAL_SEGMENT); } - /*! Construct a special segment of a given line connecting to given + /*! constructs a special segment of a given line connecting to given * endpoints. * \param a, b, c The coefficients of the supporting line (ax + by + c = 0). * \param source The source point. @@ -200,7 +200,7 @@ public: //@} private: - /*! Set the properties of the x-monotone conic arc (for the usage of the + /*! sets the properties of the x-monotone conic arc (for the usage of the * constructors). */ CGAL_DEPRECATED void _set() { @@ -304,11 +304,11 @@ public: /// \name Public constructors, assignment operators, and destructors. //@{ - /*! Default constructor. + /*! constructs default. */ Conic_x_monotone_arc_2() : Base(), m_id() {} - /*! Copy constructor. + /*! constructs copy. * \param arc The copied arc. */ Conic_x_monotone_arc_2(const Self& arc) : @@ -322,7 +322,7 @@ public: m_id(arc.m_id) {} - /*! Assignment operator. + /*! assigns. * \param arc The copied arc. */ const Self& operator=(const Self& arc) { @@ -353,13 +353,13 @@ private: /// \name private constructors to be used only by the traits class template. //@{ - /*! Construct an x-monotone arc from a conic arc. + /*! constructs an x-monotone arc from a conic arc. * \param arc The given (base) arc. * \pre The given arc is x-monotone. */ Conic_x_monotone_arc_2(const Base& arc) : Base(arc), m_id() {} - /*! Construct an x-monotone arc from a conic arc. + /*! constructs an x-monotone arc from a conic arc. * \param arc The given (base) arc. * \param id The ID of the base arc. */ @@ -373,15 +373,15 @@ public: /// \name Accessing the arc properties. //@{ - /*! Obtain the facing mask. + /*! obtains the facing mask. */ size_t facing_mask() const { return this->m_info & FACING_MASK; } - /*! Obtain the degree mask. + /*! obtains the degree mask. */ size_t degree_mask() const { return this->m_info & DEGREE_MASK; } - /*! Obtain the coefficients of the underlying conic. + /*! obtains the coefficients of the underlying conic. */ const Integer& r() const { return ( this->m_r); } const Integer& s() const { return ( this->m_s); } @@ -390,50 +390,50 @@ public: const Integer& v() const { return ( this->m_v); } const Integer& w() const { return ( this->m_w); } - /*! Obtain the left endpoint of the arc. + /*! obtains the left endpoint of the arc. */ const Point_2& left() const { if (this->test_flag(IS_DIRECTED_RIGHT)) return this->source(); else return this->target(); } - /*! Obtain the right endpoint of the arc. + /*! obtains the right endpoint of the arc. */ const Point_2& right() const { if (this->test_flag(IS_DIRECTED_RIGHT)) return this->target(); else return this->source(); } - /*! Determine whether the conic arc is directed iexicographically right. + /*! determines whether the conic arc is directed iexicographically right. */ bool is_directed_right() const { return this->test_flag(IS_DIRECTED_RIGHT); } - /*! Determine whether the conic arc is a vertical segment. + /*! determines whether the conic arc is a vertical segment. */ bool is_vertical() const { return this->test_flag(IS_VERTICAL_SEGMENT); } - /*! Determine whether the conic arc is a facing up. + /*! determines whether the conic arc is a facing up. */ bool is_upper() const { return this->test_flag(FACING_UP); } - /*! Determine whether the conic arc is a facing down. + /*! determines whether the conic arc is a facing down. */ bool is_lower() const { return this->test_flag(FACING_DOWN); } - /*! Check whether the arc is a special segment connecting two algebraic + /*! checks whether the arc is a special segment connecting two algebraic * endpoints (and has no underlying integer conic coefficients). */ bool is_special_segment() const { return this->test_flag(IS_SPECIAL_SEGMENT); } - /*! Obtain the mask of the DEGREE_1 flag. + /*! obtains the mask of the DEGREE_1 flag. */ static constexpr size_t degree_1_mask() { return flag_mask(DEGREE_1); } - /*! Obtain the mask of the DEGREE_1 flag. + /*! obtains the mask of the DEGREE_1 flag. */ static constexpr size_t degree_2_mask() { return flag_mask(DEGREE_2); } - /*! Obtain the algebraic coefficients. + /*! obtains the algebraic coefficients. */ Algebraic alg_r() const { return m_alg_r; } Algebraic alg_s() const { return m_alg_s; } @@ -442,11 +442,11 @@ public: Algebraic alg_v() const { return m_alg_v; } Algebraic alg_w() const { return m_alg_w; } - /*! Obtain the conic id. + /*! obtains the conic id. */ Conic_id id() const { return m_id; } - /*! Check whether the given point lies on the arc. + /*! checks whether the given point lies on the arc. * \param p The query point. * \param (true) if p lies on the arc; (false) otherwise. */ @@ -474,7 +474,7 @@ public: return _is_between_endpoints(p); } - /*! Obtain a bounding box for the conic arc. + /*! obtains a bounding box for the conic arc. * \return The bounding box. */ CGAL_DEPRECATED Bbox_2 bbox() const { return Base::bbox(); } @@ -483,7 +483,7 @@ public: // Setters //@{ - /*! Set the algebraic coefficients. + /*! sets the algebraic coefficients. */ void set_alg_coefficients(const Algebraic& alg_r, const Algebraic& alg_s, const Algebraic& alg_t, const Algebraic& alg_u, @@ -497,7 +497,7 @@ public: m_alg_w = alg_w; } - /*! Add a generating conic ID. + /*! adds a generating conic ID. */ void set_generating_conic(const Conic_id& id) { this->m_source.set_generating_conic(id); @@ -505,7 +505,7 @@ public: } //@} - /*! Compute a point on an arc with the same \f$x\f$-coordiante as the given + /*! computes a point on an arc with the same \f$x\f$-coordiante as the given * point. * \param p The given point. * \pre The arc is not vertical and `p` is in the \f$x\f$-range of the arc. @@ -590,7 +590,7 @@ public: /// \name Constructing points on the arc. //@{ - /*! Obtain a polyline approximating the conic arc. + /*! obtains a polyline approximating the conic arc. * \param n The maximal number of sample points. * \param oi An output iterator, whose value-type is pair * (representing an approximated point). @@ -659,7 +659,7 @@ public: /// \name Constructing x-monotone arcs. //@{ - /*! Flip the arc. + /*! flips the arc. * \return An arc with swapped source and target and a reverse orientation. */ Self flip() const { @@ -680,7 +680,7 @@ public: return arc; } - /*! Trim the arc given its new endpoints. + /*! trims the arc given its new endpoints. * \param ps The new source point. * \param pt The new target point. * \return The new trimmed arc. @@ -730,7 +730,7 @@ public: //@} - /*! Compare two arcs immediately to the leftt of their intersection point. + /*! compares two arcs immediately to the leftt of their intersection point. * \param xcv1 The first compared arc. * \param xcv2 The second compared arc. * \param p The reference intersection point. @@ -855,7 +855,7 @@ public: return slope_res; } - /*! Compare two arcs immediately to the right of their intersection point. + /*! compares two arcs immediately to the right of their intersection point. * \param xcv1 The first compared arc. * \param xcv2 The second compared arc. * \param p The reference intersection point. @@ -972,7 +972,7 @@ public: return slope_res; // both are facing down } - /*! Check whether two arcs are equal (have the same graph). + /*! checks whether two arcs are equal (have the same graph). * \param xcv1 The first compared arc. * \param xcv2 The second compared arc. * \return `true` if the two arcs have the same graph; `false` otherwise. @@ -1007,7 +1007,7 @@ public: eq(xcv1.target(), xcv2.source())); } - /*! Check whether it is possible to merge the arc with the given arc. + /*! checks whether it is possible to merge the arc with the given arc. * \param xcv1 The first arc. * \param xcv2 The second arc. * \return `true` if it is possible to merge the two arcs; @@ -1028,7 +1028,7 @@ public: return (eq(xcv1.right(), xcv2.left()) || eq(xcv1.left(), xcv2.right())); } - /*! Merge the current arc with the given arc. + /*! merges the current arc with the given arc. * \param xcv1 The first arc to merge with. * \param xcv2 The second arc to merge with. * \pre The two arcs are mergeable. @@ -1060,7 +1060,7 @@ private: /// \name Auxiliary (private) functions. //@{ - /*! Check whether the given point lies on the supporting conic of the arc. + /*! checks whether the given point lies on the supporting conic of the arc. * \param px The x-coordinate of query point. * \param py The y-coordinate of query point. * \return (true) if p lies on the supporting conic; (false) otherwise. @@ -1078,7 +1078,7 @@ private: } public: - /*! Obtain the i'th order derivative by x of the conic at the point p=(x,y). + /*! obtains the i'th order derivative by x of the conic at the point p=(x,y). * \param p The point where we derive. * \param i The order of the derivatives (either 1, 2 or 3). * \param slope_numer The numerator of the slope. @@ -1187,7 +1187,7 @@ public: CGAL_error(); } - /*! Obtain the i'th order derivative by y of the conic at the point p=(x,y). + /*! obtains the i'th order derivative by y of the conic at the point p=(x,y). * \param p The point where we derive. * \param i The order of the derivatives (either 1, 2 or 3). * \param slope_numer The numerator of the slope. @@ -1297,7 +1297,7 @@ public: } private: - /*! Compute the multiplicity of an intersection point. + /*! computes the multiplicity of an intersection point. * \param arc The arc to intersect with. * \param p The intersection point. * \return The multiplicity of the intersection point. @@ -1348,7 +1348,7 @@ private: }; -/*! Exporter for x-monotone conic arcs. +/*! exports an x-monotone conic arc. */ template std::ostream& operator<<(std::ostream& os, diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Consolidated_curve_data_aux.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Consolidated_curve_data_aux.h index 41564af33a6..d8dd55e7653 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Consolidated_curve_data_aux.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Consolidated_curve_data_aux.h @@ -42,19 +42,19 @@ private: public: - /*! Default constructor. */ + /*! constructs default. */ _Unique_list () : m_list() {} - /*! Construct a singleton list. */ + /*! constructs a singleton list. */ _Unique_list (const Data& data) : m_list () { m_list.push_back (data); } - /*! Go over the data objects in list. */ + /*! traverses the data objects in list. */ const_iterator begin () const { return (m_list.begin()); @@ -65,13 +65,13 @@ public: return (m_list.end()); } - /*! Get the list size. */ + /*! obtains the list size. */ std::size_t size () const { return (m_list.size()); } - /*! Get the first (or last) data object. */ + /*! obtains the first (or last) data object. */ const Data& front () const { return (m_list.front()); @@ -105,8 +105,7 @@ public: return (true); } - /*! - * Find the given data object is contained in the list. + /*! finds the given data object is contained in the list. * \param data The data object. * \return An iterator for the data object, or end() if it is not found. */ @@ -123,8 +122,7 @@ public: return (iter); } - /*! - * Insert an object into the list. + /*! inserts an object into the list. * \param data The data object. * \return (true) if the data object has been successfully inserted; * (false) otherwise (if it already exists). @@ -138,8 +136,7 @@ public: return (true); } - /*! - * Erase an object from the list. + /*! erases an object from the list. * \param data The data object. * \return (true) if the data object has been successfully erased; * (false) otherwise (if it is not in the list). @@ -163,7 +160,7 @@ public: return (false); } - /*! Clear the list. */ + /*! clears the list. */ void clear () { m_list.clear(); diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polycurve_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polycurve_2.h index addc072c217..5f9ca2187bb 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polycurve_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polycurve_2.h @@ -53,10 +53,10 @@ public: typedef typename Subcurves_container::size_type Size; typedef typename Subcurves_container::size_type size_type; - /*! Construct default. */ + /*! constructs default. */ Polycurve_2() : m_subcurves() {} - /*! Construct from a subcurve. */ + /*! constructs from a subcurve. */ Polycurve_2(const Subcurve_type_2& seg) : m_subcurves() { m_subcurves.push_back(seg); } @@ -70,7 +70,7 @@ public: * this class. */ - /*! Construct from a range. The range can be either: + /*! constructs from a range. The range can be either: * * For the sake of backwards compatibility we have to keep the possibility * of construction from a range of points. Therefore, we have to test the @@ -100,7 +100,7 @@ public: construct_polycurve(begin, end, Is_point()); } - /*! Construct a polycurve from a range of subcurves. + /*! constructs a polycurve from a range of subcurves. * \param begin An iterator pointing to the first subcurve in the range. * \param end An iterator pointing after the past-the-end subcurve * in the range. @@ -111,7 +111,7 @@ public: std::false_type) { m_subcurves.assign(begin, end); } - /*! Construct a polycurve from a range of points. + /*! constructs a polycurve from a range of points. * \param begin An iterator pointing to the first point in the range. * \param end An iterator pointing after the last point in the range. * \pre There are at least 2 points in the range. @@ -150,7 +150,7 @@ public: * becomes friendly...) */ - /*! Append a subcurve to the (x-monotone) polycurve. + /*! appends a subcurve to the (x-monotone) polycurve. * Warning: This is a risky function! Don't use it! Prefer the * provided implementation in the traits class. * \param seg The new subcurve to be appended to the polycurve. @@ -160,7 +160,7 @@ public: inline void push_back(const Subcurve_type_2& seg) { this->m_subcurves.push_back(seg); } - /*! Append a subcurve to the (x-monotone) polycurve. + /*! appends a subcurve to the (x-monotone) polycurve. * Warning: This is a risky function! Don't use it! Prefer the * provided implementation in the traits class. * \param seg The new subcurve to be appended to the polycurve. @@ -170,7 +170,7 @@ public: inline void push_front(const Subcurve_type_2& seg) { this->m_subcurves.insert(this->m_subcurves.begin(), seg); } - /*! Append a point to the polycurve. + /*! appends a point to the polycurve. * To properly implemented this function the traits class is needed, * thus it is deprecated. */ @@ -182,7 +182,7 @@ public: m_subcurves.push_back(Subcurve_type_2(ps, pt)); } - /*! Compute the bounding box of the polycurve. + /*! computes the bounding box of the polycurve. * \return The bounding-box. */ Bbox_2 bbox() const @@ -235,14 +235,14 @@ public: { return m_index != std::numeric_limits::max BOOST_PREVENT_MACRO_SUBSTITUTION (); } public: - /*! Default constructor. */ + /*! constructs default. */ Point_const_iterator() : m_cvP(nullptr), m_num_pts(0), m_index(std::numeric_limits::max BOOST_PREVENT_MACRO_SUBSTITUTION ()) {} - /*! Dereference operator. + /*! dereferences. * \return The current point. */ const Point_type_2& operator*() const @@ -275,7 +275,7 @@ public: return temp; } - /*! Decrement operators. */ + /*! decrements. */ Point_const_iterator& operator--() { if ((m_cvP != nullptr) && (is_index_valid())) --m_index; @@ -303,39 +303,39 @@ public: typedef Point_const_iterator const_iterator; typedef Point_const_reverse_iterator const_reverse_iterator; - /*! Obtain an iterator for the polycurve points.*/ + /*! obtains an iterator for the polycurve points.*/ Point_const_iterator points_begin() const { if (number_of_subcurves() == 0) return (Point_const_iterator()); else return (Point_const_iterator(this, 0)); } - /*! Obtain an iterator for the polycurve points.*/ + /*! obtains an iterator for the polycurve points.*/ CGAL_DEPRECATED Point_const_iterator begin() const { return points_begin(); } - /*! Obtain a past-the-end iterator for the polycurve points.*/ + /*! obtains a past-the-end iterator for the polycurve points.*/ Point_const_iterator points_end() const { if (number_of_subcurves() == 0) return (Point_const_iterator()); else return (Point_const_iterator(this, number_of_subcurves() + 1)); } - /*! Obtain a past-the-end iterator for the polycurve points.*/ + /*! obtains a past-the-end iterator for the polycurve points.*/ CGAL_DEPRECATED Point_const_iterator end() const { return points_end(); } - /*! Obtain a reverse iterator for the polycurve points. */ + /*! obtains a reverse iterator for the polycurve points. */ Point_const_reverse_iterator points_rbegin() const { return Point_const_reverse_iterator(points_end()); } - /*! Obtain a reverse iterator for the polycurve points. */ + /*! obtains a reverse iterator for the polycurve points. */ CGAL_DEPRECATED Point_const_reverse_iterator rbegin() const { return points_rbegin(); } - /*! Obtain a reverse past-the-end iterator for the polycurve points. */ + /*! obtains a reverse past-the-end iterator for the polycurve points. */ Point_const_reverse_iterator points_rend() const { return Point_const_reverse_iterator(points_begin()); } - /*! Obtain a reverse past-the-end iterator for the polycurve points. */ + /*! obtains a reverse past-the-end iterator for the polycurve points. */ CGAL_DEPRECATED Point_const_reverse_iterator rend() const { return points_rend(); } @@ -345,7 +345,7 @@ public: typedef typename std::reverse_iterator Subcurve_const_reverse_iterator; - /*! Obtain an iterator for the polycurve subcurves. */ + /*! obtains an iterator for the polycurve subcurves. */ Subcurve_const_iterator subcurves_begin() const { return m_subcurves.begin(); } @@ -353,7 +353,7 @@ public: CGAL_DEPRECATED Subcurve_const_iterator begin_subcurves() const { return subcurves_begin(); } - /*! Obtain a past-the-end iterator for the polycurve subcurves. */ + /*! obtains a past-the-end iterator for the polycurve subcurves. */ Subcurve_const_iterator subcurves_end() const { return m_subcurves.end(); } @@ -361,11 +361,11 @@ public: CGAL_DEPRECATED Subcurve_const_iterator end_subcurves() const { return subcurves_end(); } - /*! Obtain a reverse iterator for the polycurve subcurves. */ + /*! obtains a reverse iterator for the polycurve subcurves. */ Subcurve_const_reverse_iterator subcurves_rbegin() const { return (Subcurve_const_reverse_iterator(subcurves_end())); } - /*! Obtain a reverse past-the-end iterator for the polycurve points. */ + /*! obtains a reverse past-the-end iterator for the polycurve points. */ Subcurve_const_reverse_iterator subcurves_rend() const { return (Subcurve_const_reverse_iterator(subcurves_begin())); } @@ -379,7 +379,7 @@ public: CGAL_DEPRECATED std::size_t points() const { return (number_of_subcurves() == 0) ? 0 : number_of_subcurves() + 1; } - /*! Obtain the number of subcurves that comprise the poyline. + /*! obtains the number of subcurves that comprise the poyline. * \return The number of subcurves. */ size_type number_of_subcurves() const @@ -388,7 +388,7 @@ public: /*! Deprecated! Replaced by number_of_subcurves(). */ CGAL_DEPRECATED size_type size() const { return number_of_subcurves(); } - /*! Obtain the ith subcurve of the polycurve. + /*! obtains the ith subcurve of the polycurve. * \param[in] i The subcurve index(from 0 to size()-1). * \return A const reference to the subcurve. */ @@ -398,7 +398,7 @@ public: return (m_subcurves[i]); } - /*! Clear the polycurve. */ + /*! clears the polycurve. */ inline void clear() { m_subcurves.clear(); } }; @@ -416,13 +416,13 @@ public: typedef Polycurve_2 Base; - /*! Construct default. */ + /*! constructs default. */ X_monotone_polycurve_2() : Base() {} - /*! Construct from a subcurve. */ + /*! constructs from a subcurve. */ X_monotone_polycurve_2(Subcurve_type_2 seg) : Base(seg) {} - /*! Construct from a range. + /*! constructs from a range. * Similar to the constructor of a general polycurve. * Like in the case of general polycurve, for the sake of backwards * compatibility we have to keep an implementation of construction @@ -437,7 +437,7 @@ public: construct_x_monotone_polycurve(begin, end, Is_point()); } - /*! Construct from a range of subcurves. + /*! constructs from a range of subcurves. * This constructor is expected to be called only from the * traits class, after the input was verified there. * \pre The range of subcurves form an x-monotone polycurve. @@ -447,7 +447,7 @@ public: std::false_type) {} - /*! Construct from a range of points, defining the endpoints of the + /*! constructs from a range of points, defining the endpoints of the * polycurve subcurves. */ template @@ -458,6 +458,7 @@ public: }; } // namespace polycurve + } //namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polyline_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polyline_2.h index 288ec0166fb..5cf4aabb31f 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polyline_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Polyline_2.h @@ -47,33 +47,33 @@ public: typedef typename Base::Subcurve_const_reverse_iterator Segment_const_reverse_iterator; - /*! Construct default. */ + /*! constructs default. */ Polyline_2() : Base() {} - /*! Construct from a subcurve. */ + /*! constructs from a subcurve. */ Polyline_2(const Subcurve_type_2& subcurve) : Base(subcurve) {} - /*! Construct from a range. */ + /*! constructs from a range. */ template Polyline_2(InputIterator begin, InputIterator end) : Base(begin, end) {} - /*! Obtain an iterator for the polycurve subcurves. */ + /*! obtains an iterator for the polycurve subcurves. */ Segment_const_iterator begin_segments() const { return this->subcurves_begin(); } - /*! Obtain a past-the-end iterator for the polycurve subcurves. */ + /*! obtains a past-the-end iterator for the polycurve subcurves. */ Segment_const_iterator end_segments() const { return this->subcurves_end(); } - /*! Obtain a reverse iterator for the polycurve subcurves. */ + /*! obtains a reverse iterator for the polycurve subcurves. */ Segment_const_reverse_iterator rbegin_segments() const { return this->subcurves_rbegin(); } - /*! Obtain a reverse past-the-end iterator for the polycurve points. */ + /*! obtains a reverse past-the-end iterator for the polycurve points. */ Segment_const_reverse_iterator rend_segments() const { return this->subcurves_rend() ; } - /*! Obtain the number of subcurves that comprise the poyline. + /*! obtains the number of subcurves that comprise the poyline. * \return The number of subcurves. */ Segments_size_type number_of_segments() const @@ -96,13 +96,13 @@ public: typedef typename Base::Subcurve_const_reverse_iterator Segment_const_reverse_iterator; - /*! Construct default. */ + /*! constructs default. */ X_monotone_polyline_2() : Base() {} - /*! Construct from a subcurve. */ + /*! constructs from a subcurve. */ X_monotone_polyline_2(Subcurve_type_2 seg) : Base(seg) {} - /*! Construct from a range. + /*! constructs from a range. * Similar to the constructor of a general polycurve. * Like in the case of general polycurve, for the sake of backwards * compatibility we have to keep an implementation of construction @@ -113,23 +113,23 @@ public: Base(begin, end) {} - /*! Obtain an iterator for the polycurve subcurves. */ + /*! obtains an iterator for the polycurve subcurves. */ Segment_const_iterator begin_segments() const { return this->subcurves_begin(); } - /*! Obtain a past-the-end iterator for the polycurve subcurves. */ + /*! obtains a past-the-end iterator for the polycurve subcurves. */ Segment_const_iterator end_segments() const { return this->subcurves_end(); } - /*! Obtain a reverse iterator for the polycurve subcurves. */ + /*! obtains a reverse iterator for the polycurve subcurves. */ Segment_const_reverse_iterator rbegin_segments() const { return this->subcurves_rbegin(); } - /*! Obtain a reverse past-the-end iterator for the polycurve points. */ + /*! obtains a reverse past-the-end iterator for the polycurve points. */ Segment_const_reverse_iterator rend_segments() const { return this->subcurves_rend() ; } - /*! Obtain the number of subcurves that comprise the poyline. + /*! obtains the number of subcurves that comprise the poyline. * \return The number of subcurves. */ Segments_size_type number_of_segments() const diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Rational_arc_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Rational_arc_2.h index aea70d5331a..fe37236feb4 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Rational_arc_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_geometry_traits/Rational_arc_2.h @@ -98,15 +98,13 @@ public: /// \name Construction methods. //@{ - /*! - * Default constructor. + /*! constructs default. */ _Base_rational_arc_2 () : _info (0) {} - /*! - * Constructor of a whole polynomial curve. + /*! constructs a whole polynomial curve. * \param pcoeffs The rational coefficients of the polynomial p(x). */ _Base_rational_arc_2 (const Rat_vector& pcoeffs) : @@ -178,8 +176,7 @@ public: _info = (_info | IS_VALID); } - /*! - * Constructor of a polynomial ray, defined by y = p(x), for x_s <= x if the + /*! constructs a polynomial ray, defined by y = p(x), for x_s <= x if the * ray is directed to the right, or for x_s >= x if it is directed to the * left. * \param pcoeffs The rational coefficients of the polynomial p(x). @@ -266,8 +263,7 @@ public: _info = (_info | IS_VALID); } - /*! - * Constructor of a polynomial arc, defined by y = p(x), x_min <= x <= x_max. + /*! constructs a polynomial arc, defined by y = p(x), x_min <= x <= x_max. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param x_s The x-coordinate of the source point. * \param x_t The x-coordinate of the target point. @@ -313,8 +309,7 @@ public: _info = (_info | IS_VALID); } - /*! - * Constructor of a polynomial function, defined by y = p(x)/q(x) for any x. + /*! constructs a polynomial function, defined by y = p(x)/q(x) for any x. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param qcoeffs The rational coefficients of the polynomial q(x). */ @@ -368,8 +363,7 @@ public: (IS_CONTINUOUS | IS_VALID) : IS_VALID ) ); } - /*! - * Constructor of a ray of a rational function, defined by y = p(x)/q(x), + /*! constructs a ray of a rational function, defined by y = p(x)/q(x), * for x_s <= x if the ray is directed to the right, or for x_s >= x if it * is directed to the left. * \param pcoeffs The rational coefficients of the polynomial p(x). @@ -461,8 +455,7 @@ public: (IS_CONTINUOUS | IS_VALID) : IS_VALID ) ); } - /*! - * Constructor of a bounded rational arc, defined by y = p(x)/q(x), + /*! constructs a bounded rational arc, defined by y = p(x)/q(x), * where: x_min <= x <= x_max. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param qcoeffs The rational coefficients of the polynomial q(x). @@ -550,19 +543,19 @@ public: /// \name Accessing the arc properties. //@{ - /*! Get the numerator polynomial of the underlying rational function. */ + /*! obtains the numerator polynomial of the underlying rational function. */ const Polynomial& numerator () const { return (_numer); } - /*! Get the denominator polynomial of the underlying rational function. */ + /*! obtains the denominator polynomial of the underlying rational function. */ const Polynomial& denominator () const { return (_denom); } - /*! Check if the x-coordinate of the source point is infinite. */ + /*! checks if the x-coordinate of the source point is infinite. */ Arr_parameter_space source_infinite_in_x () const { return @@ -571,7 +564,7 @@ public: ARR_INTERIOR; } - /*! Check if the y-coordinate of the source point is infinite. */ + /*! checks if the y-coordinate of the source point is infinite. */ Arr_parameter_space source_infinite_in_y () const { return @@ -580,7 +573,7 @@ public: ARR_INTERIOR; } - /*! Check if the x-coordinate of the target point is infinite. */ + /*! checks if the x-coordinate of the target point is infinite. */ Arr_parameter_space target_infinite_in_x () const { return @@ -589,7 +582,7 @@ public: ARR_INTERIOR; } - /*! Check if the y-coordinate of the target point is infinite. */ + /*! checks if the y-coordinate of the target point is infinite. */ Arr_parameter_space target_infinite_in_y () const { return @@ -598,7 +591,7 @@ public: ARR_INTERIOR; } - /*! Get the source point. */ + /*! obtains the source point. */ const Point_2& source () const { CGAL_precondition ((_info & IS_VALID) != 0 && @@ -607,7 +600,7 @@ public: return (_ps); } - /*! Get the x-coordinate of the source point. */ + /*! obtains the x-coordinate of the source point. */ Algebraic source_x () const { CGAL_precondition ((_info & IS_VALID) != 0 && @@ -615,7 +608,7 @@ public: return (_ps.x()); } - /*! Get the y-coordinate of the source point. */ + /*! obtains the y-coordinate of the source point. */ Algebraic source_y () const { CGAL_precondition ((_info & IS_VALID) != 0 && @@ -623,7 +616,7 @@ public: return (_ps.y()); } - /*! Get the target point. */ + /*! obtains the target point. */ const Point_2& target () const { CGAL_precondition ((_info & IS_VALID) != 0 && @@ -632,7 +625,7 @@ public: return (_pt); } - /*! Get the x-coordinate of the target point. */ + /*! obtains the x-coordinate of the target point. */ Algebraic target_x () const { CGAL_precondition ((_info & IS_VALID) != 0 && @@ -640,7 +633,7 @@ public: return (_pt.x()); } - /*! Get the y-coordinate of the target point. */ + /*! obtains the y-coordinate of the target point. */ Algebraic target_y () const { CGAL_precondition ((_info & IS_VALID) != 0 && @@ -648,35 +641,35 @@ public: return (_pt.y()); } - /*! Check if the x-coordinate of the left point is infinite. */ + /*! checks if the x-coordinate of the left point is infinite. */ Arr_parameter_space left_infinite_in_x () const { return ((_info & IS_DIRECTED_RIGHT) != 0) ? source_infinite_in_x() : target_infinite_in_x(); } - /*! Check if the y-coordinate of the left point is infinite. */ + /*! checks if the y-coordinate of the left point is infinite. */ Arr_parameter_space left_infinite_in_y () const { return ((_info & IS_DIRECTED_RIGHT) != 0) ? source_infinite_in_y() : target_infinite_in_y(); } - /*! Check if the x-coordinate of the right point is infinite. */ + /*! checks if the x-coordinate of the right point is infinite. */ Arr_parameter_space right_infinite_in_x () const { return ((_info & IS_DIRECTED_RIGHT) != 0) ? target_infinite_in_x() : source_infinite_in_x(); } - /*! Check if the y-coordinate of the right point is infinite. */ + /*! checks if the y-coordinate of the right point is infinite. */ Arr_parameter_space right_infinite_in_y () const { return ((_info & IS_DIRECTED_RIGHT) != 0) ? target_infinite_in_y() : source_infinite_in_y(); } - /*! Get the left endpoint. */ + /*! obtains the left endpoint. */ const Point_2& left () const { CGAL_precondition (left_infinite_in_x() == ARR_INTERIOR && @@ -684,7 +677,7 @@ public: return ((_info & IS_DIRECTED_RIGHT) ? _ps : _pt); } - /*! Get the right endpoint. */ + /*! obtains the right endpoint. */ const Point_2& right () const { CGAL_precondition (right_infinite_in_x() == ARR_INTERIOR && @@ -692,19 +685,19 @@ public: return ((_info & IS_DIRECTED_RIGHT) ? _pt : _ps); } - /*! Check if the arc is valid. */ + /*! checks if the arc is valid. */ bool is_valid () const { return ((_info & IS_VALID) != 0); } - /*! Check if the arc is continuous. */ + /*! checks if the arc is continuous. */ bool is_continuous () const { return ((_info & IS_CONTINUOUS) != 0); } - /*! Check if the arc is directed right. */ + /*! checks if the arc is directed right. */ bool is_directed_right () const { return ((_info & IS_DIRECTED_RIGHT) != 0); @@ -714,20 +707,19 @@ public: /// \name Modifiers. //@{ - /*! Mark the arc as being continuous. */ + /*! marks the arc as being continuous. */ void set_continuous () { _info = (_info | IS_CONTINUOUS); } - /*! Mark the arc as being invalid. */ + /*! marks the arc as being invalid. */ void set_invalid () { _info = (_info & ~IS_VALID); } - /*! - * Split the arc into two at a given pole. The function returns the sub-arc + /*! splits the arc into two at a given pole. The function returns the sub-arc * to the left of the pole and sets (*this) to be the right sub-arc. * \param x0 The x-coordinate of the pole. * \pre x0 lies in the interior of the arc. @@ -791,8 +783,7 @@ public: /// \name Predicates. //@{ - /*! - * Get the relative position of the point with respect to the rational arc. + /*! obtains the relative position of the point with respect to the rational arc. * \param p The query point. * \pre p is in the x-range of the arc. * \return SMALLER if the point is below the arc; @@ -816,8 +807,7 @@ public: return (CGAL::compare (p.y(), y)); } - /*! - * Compare the x-coordinate of a vertical asymptote of the arc (one of its + /*! compares the x-coordinate of a vertical asymptote of the arc (one of its * ends) and the given point. */ Comparison_result compare_end (const Point_2& p, @@ -852,8 +842,7 @@ public: return ((ce == ARR_MIN_END) ? SMALLER : LARGER); } - /*! - * Compare the x-coordinate of a vertical asymptotes of the two arcs. + /*! compares the x-coordinate of a vertical asymptotes of the two arcs. */ Comparison_result compare_ends (Arr_curve_end ind1, const Self& arc, Arr_curve_end ind2) const @@ -1021,8 +1010,7 @@ public: return (val_res); } - /*! - * Compare the slopes of the arc with another given arc at their given + /*! compares the slopes of the arc with another given arc at their given * intersection point. * \param cv The given arc. * \param p The intersection point. @@ -1106,8 +1094,7 @@ public: return (EQUAL); } - /*! - * Compare the two arcs at x = -oo. + /*! compares the two arcs at x = -oo. * \param arc The given arc. * \pre Both arcs have a left end which is unbounded in x. * \return SMALLER if (*this) lies below the other arc; @@ -1162,8 +1149,7 @@ public: return (flip_res ? SMALLER : LARGER); } - /*! - * Compare the two arcs at x = +oo. + /*! compares the two arcs at x = +oo. * \param arc The given arc. * \pre Both arcs are have a right end which is unbounded in x. * \return SMALLER if (*this) lies below the other arc; @@ -1218,8 +1204,7 @@ public: return (flip_res ? SMALLER : LARGER); } - /*! - * Check whether the two arcs are equal (have the same graph). + /*! checks whether the two arcs are equal (have the same graph). * \param arc The compared arc. * \return (true) if the two arcs have the same graph; (false) otherwise. */ @@ -1276,8 +1261,7 @@ public: return (true); } - /*! - * Check whether it is possible to merge the arc with the given arc. + /*! checks whether it is possible to merge the arc with the given arc. * \param arc The query arc. * \return (true) if it is possible to merge the two arcs; * (false) otherwise. @@ -1311,8 +1295,7 @@ public: /// \name Constructions of points and curves. //@{ - /*! - * Flip the arc (swap its source and target). + /*! flips the arc (swap its source and target). * \return The flipped arc. */ Self flip () const @@ -1341,8 +1324,7 @@ public: return (arc); } - /*! - * Print the rational arc. + /*! prints the rational arc. */ std::ostream& print (std::ostream& os) const { @@ -1386,8 +1368,7 @@ protected: /// \name Auxiliary (protected) functions. //@{ - /*! - * Check if the given x-value is in the x-range of the arc. + /*! checks if the given x-value is in the x-range of the arc. * \param x The x-value. * \param eq_src Output: Is this value equal to the x-coordinate of the * source point. @@ -1470,8 +1451,7 @@ protected: return (true); } - /*! - * Check if the given x-value is in the x-range of the arc, excluding its + /*! checks if the given x-value is in the x-range of the arc, excluding its * open ends. */ bool _is_in_true_x_range (const Algebraic& x) const @@ -1494,8 +1474,7 @@ protected: return (true); } - /*! - * Check if the underlying rational function is the same in the given arc. + /*! checks if the underlying rational function is the same in the given arc. * \param arc The given arc. * \return (true) if arc's underlying rational function is the same * as of *this; (false) otherwise. @@ -1506,8 +1485,7 @@ protected: return (_numer * arc._denom == _denom * arc._numer); } - /*! - * Compute the sign of the given polynomial at x = -oo. + /*! computes the sign of the given polynomial at x = -oo. */ CGAL::Sign _sign_at_minus_infinity (const Polynomial& poly) const { @@ -1531,8 +1509,7 @@ protected: return ((lead_sign == CGAL::POSITIVE) ? CGAL::NEGATIVE : CGAL::POSITIVE); } - /*! - * Compute the sign of the given polynomial at x = +oo. + /*! computes the sign of the given polynomial at x = +oo. */ CGAL::Sign _sign_at_plus_infinity (const Polynomial& poly) const { @@ -1548,8 +1525,7 @@ protected: return (CGAL::sign (nt_traits.get_coefficient (poly, degree))); } - /*! - * Compute infinity type of the rational function P(x)/Q(x) at x = -oo. + /*! computes infinity type of the rational function P(x)/Q(x) at x = -oo. * \param y Output: The value of the horizontal asymptote (if exists). * \return The infinity type for the y-coordinate at x = -oo. */ @@ -1588,8 +1564,7 @@ protected: ((def_diff % 2 == 0) ? ARR_BOTTOM_BOUNDARY : ARR_TOP_BOUNDARY); } - /*! - * Compute infinity type of the rational function P(x)/Q(x) at x = +oo. + /*! computes infinity type of the rational function P(x)/Q(x) at x = +oo. * \param y Output: The value of the horizontal asymptote (if exists). * \return The infinity type for the y-coordinate at x = +oo. */ @@ -1625,8 +1600,7 @@ protected: ARR_TOP_BOUNDARY : ARR_BOTTOM_BOUNDARY; } - /*! - * Compute all zeros of the denominator polynomial that lie within the + /*! computes all zeros of the denominator polynomial that lie within the * x-range of the arc. */ template @@ -1673,7 +1647,7 @@ protected: return (oi); } - /*! Check whether the arc is continuous. */ + /*! checks whether the arc is continuous. */ bool _is_continuous () { // Compute the roots of the denominator polynomial, and make sure @@ -1687,8 +1661,7 @@ protected: return (q_roots.empty()); } - /*! - * Determine the signs of the rational functions infinitisimally to the left + /*! determines the signs of the rational functions infinitisimally to the left * and to the right of the given pole. * \param x0 The x-coordinate of the pole. * \pre x0 lies in the interior of the arc. @@ -1754,8 +1727,7 @@ protected: return (std::make_pair (sign_left, sign_right)); } - /*! - * Print a polynomial nicely. + /*! prints a polynomial nicely. */ std::ostream& _print_polynomial (std::ostream& os, const Polynomial& poly, @@ -1797,8 +1769,7 @@ protected: //@} }; -/*! - * Exporter for rational arcs. +/*! exports a rational arc. */ template std::ostream& @@ -1836,15 +1807,13 @@ public: /// \name Construction methods. //@{ - /*! - * Default constructor. + /*! constructs default. */ _Continuous_rational_arc_2 () : Base() {} - /*! - * Constructor from a base arc. + /*! constructors from a base arc. */ _Continuous_rational_arc_2 (const Base& arc) : Base (arc) @@ -1852,16 +1821,14 @@ public: CGAL_precondition (arc.is_continuous()); } - /*! - * Constructor of a whole polynomial curve. + /*! constructs a whole polynomial curve. * \param pcoeffs The rational coefficients of the polynomial p(x). */ _Continuous_rational_arc_2 (const Rat_vector& pcoeffs) : Base (pcoeffs) {} - /*! - * Constructor of a polynomial ray, defined by y = p(x), for x_s <= x if the + /*! constructs a polynomial ray, defined by y = p(x), for x_s <= x if the * ray is directed to the right, or for x_s >= x if it is directed to the * left. * \param pcoeffs The rational coefficients of the polynomial p(x). @@ -1874,8 +1841,7 @@ public: Base (pcoeffs, x_s, dir_right) {} - /*! - * Constructor of a polynomial arc, defined by y = p(x), x_min <= x <= x_max. + /*! constructors a polynomial arc, defined by y = p(x), x_min <= x <= x_max. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param x_s The x-coordinate of the source point. * \param x_t The x-coordinate of the target point. @@ -1886,8 +1852,7 @@ public: Base (pcoeffs, x_s, x_t) {} - /*! - * Constructor of a polynomial function, defined by y = p(x)/q(x) for any x. + /*! constructs a polynomial function, defined by y = p(x)/q(x) for any x. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param qcoeffs The rational coefficients of the polynomial q(x). * \pre The denominator polynomial q(x) does not have any roots. @@ -1903,8 +1868,7 @@ public: } } - /*! - * Constructor of a ray of a rational function, defined by y = p(x)/q(x), + /*! constructs a ray of a rational function, defined by y = p(x)/q(x), * for x_s <= x if the ray is directed to the right, or for x_s >= x if it * is directed to the left. * \param pcoeffs The rational coefficients of the polynomial p(x). @@ -1927,8 +1891,7 @@ public: } } - /*! - * Constructor of a bounded rational arc, defined by y = p(x)/q(x), + /*! constructs a bounded rational arc, defined by y = p(x)/q(x), * where: x_min <= x <= x_max. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param qcoeffs The rational coefficients of the polynomial q(x). @@ -1954,8 +1917,7 @@ public: /// \name Constructions of points and curves. //@{ - /*! - * Compute the intersections with the given arc. + /*! computes the intersections with the given arc. * \param arc The given intersecting arc. * \param oi The output iterator. * \return The past-the-end iterator. @@ -2148,8 +2110,7 @@ public: return oi; } - /*! - * Split the arc into two at a given split point. + /*! splits the arc into two at a given split point. * \param p The split point. * \param c1 Output: The first resulting arc, lying to the left of p. * \param c2 Output: The first resulting arc, lying to the right of p. @@ -2195,8 +2156,7 @@ public: return; } - /*! - * Merge the current arc with the given arc. + /*! merges the current arc with the given arc. * \param arc The arc to merge with. * \pre The two arcs are mergeable. */ @@ -2349,23 +2309,20 @@ public: /// \name Construction methods. //@{ - /*! - * Default constructor. + /*! constructs default. */ _Rational_arc_2 () : Base() {} - /*! - * Constructor of a whole polynomial curve. + /*! constructs a whole polynomial curve. * \param pcoeffs The rational coefficients of the polynomial p(x). */ _Rational_arc_2 (const Rat_vector& pcoeffs) : Base (pcoeffs) {} - /*! - * Constructor of a polynomial ray, defined by y = p(x), for x_s <= x if the + /*! constructs a polynomial ray, defined by y = p(x), for x_s <= x if the * ray is directed to the right, or for x_s >= x if it is directed to the * left. * \param pcoeffs The rational coefficients of the polynomial p(x). @@ -2378,8 +2335,7 @@ public: Base (pcoeffs, x_s, dir_right) {} - /*! - * Constructor of a polynomial arc, defined by y = p(x), x_min <= x <= x_max. + /*! constructs a polynomial arc, defined by y = p(x), x_min <= x <= x_max. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param x_s The x-coordinate of the source point. * \param x_t The x-coordinate of the target point. @@ -2390,8 +2346,7 @@ public: Base (pcoeffs, x_s, x_t) {} - /*! - * Constructor of a polynomial function, defined by y = p(x)/q(x) for any x. + /*! constructs a polynomial function, defined by y = p(x)/q(x) for any x. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param qcoeffs The rational coefficients of the polynomial q(x). */ @@ -2399,8 +2354,7 @@ public: Base (pcoeffs, qcoeffs) {} - /*! - * Constructor of a ray of a rational function, defined by y = p(x)/q(x), + /*! constructs a ray of a rational function, defined by y = p(x)/q(x), * for x_s <= x if the ray is directed to the right, or for x_s >= x if it * is directed to the left. * \param pcoeffs The rational coefficients of the polynomial p(x). @@ -2414,8 +2368,7 @@ public: Base (pcoeffs, qcoeffs, x_s, dir_right) {} - /*! - * Constructor of a bounded rational arc, defined by y = p(x)/q(x), + /*! constructs a bounded rational arc, defined by y = p(x)/q(x), * where: x_min <= x <= x_max. * \param pcoeffs The rational coefficients of the polynomial p(x). * \param qcoeffs The rational coefficients of the polynomial q(x). @@ -2429,8 +2382,7 @@ public: {} //@} - /*! - * Subdivide the given portion of a rational function into continuous + /*! subdivides the given portion of a rational function into continuous * sub-arcs, splitting it at the roots of the denominator polynomial. * \param oi An output iterator of _Continuous_rational_arc_2 objects. */ @@ -2475,7 +2427,7 @@ public: protected: - /*! Check whether the arc is continuous. */ + /*! checks whether the arc is continuous. */ void _check_continuity () { if (this->_is_continuous()) @@ -2489,6 +2441,6 @@ protected: } }; -} //namespace CGAL +} // namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_linear_traits_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_linear_traits_2.h index 623aa0934e6..bf8792fdac5 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_linear_traits_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_linear_traits_2.h @@ -70,8 +70,7 @@ public: typedef CGAL::Segment_assertions > Segment_assertions; - /*! - * \class Representation of a linear with cached data. + /*! \class Representation of a linear with cached data. */ class _Linear_object_cached_2 { public: @@ -100,7 +99,7 @@ public: public: - /*! Default constructor. + /*! constructs default. */ _Linear_object_cached_2() : has_source(true), @@ -111,7 +110,7 @@ public: is_degen(true) {} - /*! Constructor for segment from two points. + /*! constructs from two points. * \param p1 source point. * \param p2 target point. * \pre The two points must not be equal. @@ -137,7 +136,7 @@ public: has_pos_slope = _has_positive_slope(); } - /*! Constructor from a segment. + /*! constructs from a segment. * \param seg The segment. * \pre The segment is not degenerate. */ @@ -165,7 +164,7 @@ public: has_pos_slope = _has_positive_slope(); } - /*! Constructor from a ray. + /*! constructs from a ray. * \param ray The ray. * \pre The ray is not degenerate. */ @@ -193,7 +192,7 @@ public: has_pos_slope = _has_positive_slope(); } - /*! Constructor from a line. + /*! constructs from a line. * \param ln The line. * \pre The line is not degenerate. */ @@ -221,7 +220,7 @@ public: has_pos_slope = _has_positive_slope(); } - /*! Check whether the \f$x\f$-coordinate of the left point is infinite. + /*! checks whether the \f$x\f$-coordinate of the left point is infinite. * \return `ARR_LEFT_BOUNDARY` if the left point is near the boundary; * `ARR_INTERIOR` if the \f$x\f$-coordinate is finite. */ @@ -234,7 +233,7 @@ public: (has_target ? ARR_INTERIOR : ARR_LEFT_BOUNDARY); } - /*! Check whether the \f$y\f$-coordinate of the left point is infinite. + /*! checks whether the \f$y\f$-coordinate of the left point is infinite. * \return `ARR_BOTTOM_BOUNDARY` if the left point is at \f$y = -\infty\f$; * `ARR_INTERIOR` if the \f$y\f$-coordinate is finite. * `ARR_TOP_BOUNDARY` if the left point is at \f$y = +\infty\f$; @@ -255,11 +254,11 @@ public: return (has_pos_slope ? ARR_BOTTOM_BOUNDARY : ARR_TOP_BOUNDARY); } - /*! Check whether the left point is finite. + /*! checks whether the left point is finite. */ bool has_left() const { return (is_right ? has_source : has_target); } - /*! Obtain the (lexicographically) left endpoint. + /*! obtains the (lexicographically) left endpoint. * \pre The left point is finite. */ const Point_2& left() const @@ -268,7 +267,7 @@ public: return (is_right ? ps : pt); } - /*! Set the (lexicographically) left endpoint. + /*! sets the (lexicographically) left endpoint. * \param p The point to set. * \pre p lies on the supporting line to the left of the right endpoint. */ @@ -293,7 +292,7 @@ public: } } - /*! Set the (lexicographically) left endpoint as infinite. + /*! sets the (lexicographically) left endpoint as infinite. */ void set_left() { @@ -303,7 +302,7 @@ public: else has_target = false; } - /*! Check whether the \f$x\f$-coordinate of the right point is infinite. + /*! checks whether the \f$x\f$-coordinate of the right point is infinite. * \return `ARR_RIGHT_BOUNDARY` if the right point is near the boundary; * `ARR_INTERIOR` if the \f$x\f$-coordinate is finite. */ @@ -316,7 +315,7 @@ public: (has_source ? ARR_INTERIOR : ARR_RIGHT_BOUNDARY); } - /*! Check whether the \f$y\f$-coordinate of the right point is infinite. + /*! checks whether the \f$y\f$-coordinate of the right point is infinite. * \return `ARR_BOTTOM_BOUNDARY` if the right point is at \f$y = -\infty\f$; * `ARR_INTERIOR` if the \f$y\f$-coordinate is finite. * `ARR_TOP_BOUNDARY` if the right point is at \f$y = +\infty\f$; @@ -337,11 +336,11 @@ public: return (has_pos_slope ? ARR_TOP_BOUNDARY : ARR_BOTTOM_BOUNDARY); } - /*! Check whether the right point is finite. + /*! checks whether the right point is finite. */ bool has_right() const { return (is_right ? has_target : has_source); } - /*! Obtain the (lexicographically) right endpoint. + /*! obtains the (lexicographically) right endpoint. * \pre The right endpoint is finite. */ const Point_2& right() const @@ -350,7 +349,7 @@ public: return (is_right ? pt : ps); } - /*! Set the (lexicographically) right endpoint. + /*! sets the (lexicographically) right endpoint. * \param p The point to set. * \pre p lies on the supporting line to the right of the left endpoint. */ @@ -374,7 +373,7 @@ public: } } - /*! Set the (lexicographically) right endpoint as infinite. + /*! sets the (lexicographically) right endpoint as infinite. */ void set_right() { @@ -384,7 +383,7 @@ public: else has_source = false; } - /*! Obtain the supporting line. + /*! obtains the supporting line. */ const Line_2& supp_line() const { @@ -392,7 +391,7 @@ public: return (l); } - /*! Check whether the curve is vertical. + /*! checks whether the curve is vertical. */ bool is_vertical() const { @@ -400,15 +399,15 @@ public: return (is_vert); } - /*! Check whether the curve is degenerate. + /*! checks whether the curve is degenerate. */ bool is_degenerate() const { return (is_degen); } - /*! Check whether the curve is directed lexicographic from left to right + /*! checks whether the curve is directed lexicographic from left to right */ bool is_directed_right() const { return (is_right); } - /*! Check whether the given point is in the \f$x\f$-range of the object. + /*! checks whether the given point is in the \f$x\f$-range of the object. * \param p The query point. * \return (true) is in the \f$x\f$-range of the segment; (false) if it is * not. @@ -447,7 +446,7 @@ public: return (res2 != LARGER); } - /*! Check whether the given point is in the \f$y\f$-range of the object. + /*! checks whether the given point is in the \f$y\f$-range of the object. * \param p The query point. * \pre The object is vertical. * \return (true) is in the \f$y\f$-range of the segment; (false) if it is @@ -480,7 +479,7 @@ public: } private: - /*! Determine if the supporting line has a positive slope. + /*! determines if the supporting line has a positive slope. */ bool _has_positive_slope() const { @@ -503,7 +502,7 @@ public: typedef unsigned int Multiplicity; public: - /*! Default constructor. + /*! constructs default. */ Arr_linear_traits_2() {} @@ -518,7 +517,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -530,7 +529,7 @@ public: friend class Arr_linear_traits_2; public: - /*! Compare the \f$x\f$-coordinates of two points. + /*! compares the \f$x\f$-coordinates of two points. * \param p1 The first point. * \param p2 The second point. * \return LARGER if x(p1) > x(p2); @@ -544,13 +543,13 @@ public: } }; - /*! Obtain a `Compare_x_2` functor. */ + /*! obtains a `Compare_x_2` functor. */ Compare_x_2 compare_x_2_object() const { return Compare_x_2(*this); } /*! A functor that compares the he endpoints of an $x$-monotone curve. */ class Compare_endpoints_xy_2{ public: - /*! Compare the endpoints of an $x$-monotone curve lexicographically. + /*! compares the endpoints of an $x$-monotone curve lexicographically. * (assuming the curve has a designated source and target points). * \param cv The curve. * \return SMALLER if the curve is directed right; @@ -560,7 +559,7 @@ public: { return (xcv.is_directed_right()) ? (SMALLER) : (LARGER); } }; - /*! Obtain a `Compare_endpoints_xy_2` functor. */ + /*! obtains a `Compare_endpoints_xy_2` functor. */ Compare_endpoints_xy_2 compare_endpoints_xy_2_object() const { return Compare_endpoints_xy_2(); } @@ -571,7 +570,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -613,7 +612,7 @@ public: } }; - /*! Obtain a `Trim_2` functor object. */ + /*! obtains a `Trim_2` functor object. */ Trim_2 trim_2_object() const { return Trim_2(*this); } class Construct_opposite_2{ @@ -623,7 +622,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -652,14 +651,14 @@ public: } }; - /*! Get a Construct_opposite_2 functor object. */ + /*! obtains a Construct_opposite_2 functor object. */ Construct_opposite_2 construct_opposite_2_object() const { return Construct_opposite_2(*this); } /*! A functor that compares the \f$x\f$-coordinates of two points */ class Compare_xy_2 { public: - /*! Compare two points lexigoraphically: by \f$x\f$, then by \f$y\f$. + /*! compares two points lexigoraphically: by \f$x\f$, then by \f$y\f$. * \param p1 The first point. * \param p2 The second point. * \return LARGER if x(p1) > x(p2), or if x(p1) = x(p2) and y(p1) > y(p2); @@ -673,13 +672,13 @@ public: } }; - /*! Obtain a `Compare_xy_2` functor object. */ + /*! obtains a `Compare_xy_2` functor object. */ Compare_xy_2 compare_xy_2_object() const { return Compare_xy_2(); } /*! A functor that obtains the left endpoint of a segment or a ray. */ class Construct_min_vertex_2 { public: - /*! Obtain the left endpoint of the \f$x\f$-monotone curve (segment). + /*! obtains the left endpoint of the \f$x\f$-monotone curve (segment). * \param cv The curve. * \pre The left end of cv is a valid (bounded) point. * \return The left endpoint. @@ -693,14 +692,14 @@ public: } }; - /*! Obtain a `Construct_min_vertex_2` functor object. */ + /*! obtains a `Construct_min_vertex_2` functor object. */ Construct_min_vertex_2 construct_min_vertex_2_object() const { return Construct_min_vertex_2(); } /*! A functor that obtains the right endpoint of a segment or a ray. */ class Construct_max_vertex_2 { public: - /*! Obtain the right endpoint of the \f$x\f$-monotone curve (segment). + /*! obtains the right endpoint of the \f$x\f$-monotone curve (segment). * \param cv The curve. * \pre The right end of cv is a valid (bounded) point. * \return The right endpoint. @@ -714,14 +713,14 @@ public: } }; - /*! Obtain a `Construct_max_vertex_2` functor object. */ + /*! obtains a `Construct_max_vertex_2` functor object. */ Construct_max_vertex_2 construct_max_vertex_2_object() const { return Construct_max_vertex_2(); } /*! A functor that checks whether a given linear curve is vertical. */ class Is_vertical_2 { public: - /*! Check whether the given \f$x\f$-monotone curve is a vertical segment. + /*! checks whether the given \f$x\f$-monotone curve is a vertical segment. * \param cv The curve. * \return (true) if the curve is a vertical segment; (false) otherwise. */ @@ -732,7 +731,7 @@ public: } }; - /*! Obtain an `Is_vertical_2` functor object. */ + /*! obtains an `Is_vertical_2` functor object. */ Is_vertical_2 is_vertical_2_object() const { return Is_vertical_2(); } /*! A functor that compares the \f$y\f$-coordinates of a point and a line at @@ -745,7 +744,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -757,7 +756,7 @@ public: friend class Arr_linear_traits_2; public: - /*! Obtain the location of the given point with respect to the input curve. + /*! obtains the location of the given point with respect to the input curve. * \param cv The curve. * \param p The point. * \pre p is in the \f$x\f$-range of cv. @@ -787,7 +786,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_2` functor object. */ + /*! obtains a `Compare_y_at_x_2` functor object. */ Compare_y_at_x_2 compare_y_at_x_2_object() const { return Compare_y_at_x_2(*this); } @@ -796,7 +795,7 @@ public: */ class Compare_y_at_x_left_2 { public: - /*! Compare the \f$y\f$-value of two \f$x\f$-monotone curves immediately to + /*! compares the \f$y\f$-value of two \f$x\f$-monotone curves immediately to * the left of their intersection point. * \param cv1 The first curve. * \param cv2 The second curve. @@ -839,7 +838,7 @@ public: } }; - /*! Obtain a Compare_y_at_x_left_2 functor object. */ + /*! obtains a Compare_y_at_x_left_2 functor object. */ Compare_y_at_x_left_2 compare_y_at_x_left_2_object() const { return Compare_y_at_x_left_2(); } @@ -848,7 +847,7 @@ public: */ class Compare_y_at_x_right_2 { public: - /*! Compare the \f$y\f$-value of two \f$x\f$-monotone curves immediately to + /*! compares the \f$y\f$-value of two \f$x\f$-monotone curves immediately to * the right of their intersection point. * \param cv1 The first curve. * \param cv2 The second curve. @@ -889,7 +888,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_right_2` functor object. */ + /*! obtains a `Compare_y_at_x_right_2` functor object. */ Compare_y_at_x_right_2 compare_y_at_x_right_2_object() const { return Compare_y_at_x_right_2(); } @@ -898,7 +897,7 @@ public: */ class Equal_2 { public: - /*! Check whether the two \f$x\f$-monotone curves are the same (have the + /*! checks whether the two \f$x\f$-monotone curves are the same (have the * same graph). * \param cv1 The first curve. * \param cv2 The second curve. @@ -935,7 +934,7 @@ public: (! cv1.has_right() || equal (cv1.right(), cv2.right()))); } - /*! Check whether the two points are the same. + /*! checks whether the two points are the same. * \param p1 The first point. * \param p2 The second point. * \return (true) if the two point are the same; (false) otherwise. @@ -947,7 +946,7 @@ public: } }; - /*! Obtain an `Equal_2` functor object. */ + /*! obtains an `Equal_2` functor object. */ Equal_2 equal_2_object() const { return Equal_2(); } //@} @@ -959,7 +958,7 @@ public: */ class Parameter_space_in_x_2 { public: - /*! Obtains the parameter space at the end of a line along the \f$x\f$-axis. + /*! obtains the parameter space at the end of a line along the \f$x\f$-axis. * \param xcv the line * \param ce the line end indicator: * ARR_MIN_END - the minimal end of xc or @@ -979,7 +978,7 @@ public: xcv.left_infinite_in_x() : xcv.right_infinite_in_x(); } - /*! Obtains the parameter space at a point along the \f$x\f$-axis. + /*! obtains the parameter space at a point along the \f$x\f$-axis. * \param p the point. * \return the parameter space at `p`. */ @@ -987,7 +986,7 @@ public: { return ARR_INTERIOR; } }; - /*! Obtain a `Parameter_space_in_x_2` function object. */ + /*! obtains a `Parameter_space_in_x_2` function object. */ Parameter_space_in_x_2 parameter_space_in_x_2_object() const { return Parameter_space_in_x_2(); } @@ -996,7 +995,7 @@ public: */ class Parameter_space_in_y_2 { public: - /*! Obtains the parameter space at the end of a line along the \f$y\f$-axis. + /*! obtains the parameter space at the end of a line along the \f$y\f$-axis. * Note that if the line end coincides with a pole, then unless the line * coincides with the identification arc, the line end is considered to * be approaching the boundary, but not on the boundary. @@ -1022,7 +1021,7 @@ public: xcv.left_infinite_in_y() : xcv.right_infinite_in_y(); } - /*! Obtains the parameter space at a point along the \f$y\f$-axis. + /*! obtains the parameter space at a point along the \f$y\f$-axis. * \param p the point. * \return the parameter space at `p`. */ @@ -1030,7 +1029,7 @@ public: { return ARR_INTERIOR; } }; - /*! Obtain a `Parameter_space_in_y_2` function object. */ + /*! obtains a `Parameter_space_in_y_2` function object. */ Parameter_space_in_y_2 parameter_space_in_y_2_object() const { return Parameter_space_in_y_2(); } @@ -1044,7 +1043,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -1056,7 +1055,7 @@ public: friend class Arr_linear_traits_2; public: - /*! Compare the \f$x\f$-limit of a vertical line at a point with the + /*! compares the \f$x\f$-limit of a vertical line at a point with the * \f$x\f$-limit of a line end on the boundary at \f$y = +/- \infty\f$. * \param p the point direction. * \param xcv the line, the endpoint of which is compared. @@ -1082,7 +1081,7 @@ public: return (kernel.compare_x_at_y_2_object()(p, xcv.supp_line())); } - /*! Compare the \f$x\f$-limits of 2 arcs ends on the boundary of the + /*! compares the \f$x\f$-limits of 2 arcs ends on the boundary of the * parameter space at \f$y = +/- \infty\f$. * \param xcv1 the first arc. * \param ce1 the first arc end indicator - @@ -1104,7 +1103,7 @@ public: Comparison_result operator()(const X_monotone_curve_2 & xcv1, Arr_curve_end /* ce1 */, const X_monotone_curve_2 & xcv2, - Arr_curve_end /*! ce2 */) const + Arr_curve_end /* ce2 */) const { CGAL_precondition(! xcv1.is_degenerate()); CGAL_precondition(! xcv2.is_degenerate()); @@ -1118,7 +1117,7 @@ public: } }; - /*! Obtain a `Compare_x_on_boundary_2` function object. */ + /*! obtains a `Compare_x_on_boundary_2` function object. */ Compare_x_on_boundary_2 compare_x_on_boundary_2_object() const { return Compare_x_on_boundary_2(*this); } @@ -1127,7 +1126,7 @@ public: */ class Compare_x_near_boundary_2 { public: - /*! Compare the \f$x\f$-coordinates of 2 arcs ends near the boundary of the + /*! compares the \f$x\f$-coordinates of 2 arcs ends near the boundary of the * parameter space at y\f$ = +/- \infty\f$. * \param xcv1 the first arc. * \param ce1 the first arc end indicator - @@ -1151,7 +1150,7 @@ public: Comparison_result operator()(const X_monotone_curve_2& CGAL_precondition_code(xcv1), const X_monotone_curve_2& CGAL_precondition_code(xcv2), - Arr_curve_end /*! ce2 */) const + Arr_curve_end /* ce2 */) const { CGAL_precondition(! xcv1.is_degenerate()); CGAL_precondition(! xcv2.is_degenerate()); @@ -1161,7 +1160,7 @@ public: } }; - /*! Obtain a `Compare_x_near_boundary_2` function object. */ + /*! obtains a `Compare_x_near_boundary_2` function object. */ Compare_x_near_boundary_2 compare_x_near_boundary_2_object() const { return Compare_x_near_boundary_2(); } @@ -1175,7 +1174,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -1187,7 +1186,7 @@ public: friend class Arr_linear_traits_2; public: - /*! Compare the \f$y\f$-limits of 2 lines at their ends on the boundary + /*! compares the \f$y\f$-limits of 2 lines at their ends on the boundary * of the parameter space at \f$x = +/- \infty\f$. * \param xcv1 the first arc. * \param xcv2 the second arc. @@ -1230,7 +1229,7 @@ public: } }; - /*! Obtain a `Compare_y_near_boundary_2` function object. */ + /*! obtains a `Compare_y_near_boundary_2` function object. */ Compare_y_near_boundary_2 compare_y_near_boundary_2_object() const { return Compare_y_near_boundary_2(*this); } @@ -1241,9 +1240,9 @@ public: class Make_x_monotone_2 { public: - /*! Cut the given curve into \f$x\f$-monotone subcurves and insert them into - * the given output iterator. As segments are always x_monotone, only one - * object will be contained in the iterator. + /*! cuts the given curve into \f$x\f$-monotone subcurves and insert them + * into the given output iterator. As segments are always x_monotone, only + * one object will be contained in the iterator. * \param cv The curve. * \param oi an output iterator for the result. Its dereference type is a * variant that wraps a \c Point_2 or an \c X_monotone_curve_2 @@ -1261,13 +1260,13 @@ public: } }; - /*! Obtain a `Make_x_monotone_2` functor object. */ + /*! obtains a `Make_x_monotone_2` functor object. */ Make_x_monotone_2 make_x_monotone_2_object() const { return Make_x_monotone_2(); } class Split_2 { public: - /*! Split a given \f$x\f$-monotone curve at a given point into two + /*! splits a given \f$x\f$-monotone curve at a given point into two * sub-curves. * \param cv The curve to split * \param p The split point. @@ -1300,7 +1299,7 @@ public: } }; - /*! Obtain a `Split_2` functor object. */ + /*! obtains a `Split_2` functor object. */ Split_2 split_2_object() const { return Split_2(); } class Intersect_2 { @@ -1310,7 +1309,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Intersect_2(const Traits& traits) : m_traits(traits) {} @@ -1318,7 +1317,7 @@ public: friend class Arr_linear_traits_2; public: - /*! Find the intersections of the two given curves and insert them into the + /*! finds the intersections of the two given curves and insert them into the * given output iterator. As two segments may itersect only once, only a * single intersection will be contained in the iterator. * \param cv1 The first curve. @@ -1416,12 +1415,12 @@ public: } }; - /*! Obtain an Intersect_2 functor object. */ + /*! obtains an Intersect_2 functor object. */ Intersect_2 intersect_2_object () const { return Intersect_2(*this); } class Are_mergeable_2 { public: - /*! Check whether it is possible to merge two given \f$x\f$-monotone curves. + /*! checks whether it is possible to merge two given \f$x\f$-monotone curves. * \param cv1 The first curve. * \param cv2 The second curve. * \return (true) if the two curves are mergeable - if they are supported @@ -1451,7 +1450,7 @@ public: } }; - /*! Obtain an Are_mergeable_2 functor object. */ + /*! obtains an Are_mergeable_2 functor object. */ Are_mergeable_2 are_mergeable_2_object () const { return Are_mergeable_2(); } /*! \class Merge_2 @@ -1464,7 +1463,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Merge_2(const Traits& traits) : m_traits(traits) {} @@ -1472,7 +1471,7 @@ public: friend class Arr_linear_traits_2; public: - /*! Merge two given \f$x\f$-monotone curves into a single curve (segment). + /*! merges two given \f$x\f$-monotone curves into a single curve (segment). * \param cv1 The first curve. * \param cv2 The second curve. * \param c Output: The merged curve. @@ -1512,7 +1511,7 @@ public: } }; - /*! Obtain a `Merge_2` functor object. */ + /*! obtains a `Merge_2` functor object. */ Merge_2 merge_2_object() const { return Merge_2(*this); } //@} @@ -1522,7 +1521,7 @@ public: class Approximate_2 { public: - /*! Obtain an approximation of a point coordinate. + /*! obtains an approximation of a point coordinate. * \param p The exact point. * \param i The coordinate index (either 0 or 1). * \pre `i` is either 0 or 1. @@ -1536,13 +1535,13 @@ public: } }; - /*! Obtain an `Approximate_2` functor object. */ + /*! obtains an `Approximate_2` functor object. */ Approximate_2 approximate_2_object() const { return Approximate_2(); } //! Functor class Construct_x_monotone_curve_2 { public: - /*! Obtain an \f$x\f$-monotone curve connecting the two given endpoints. + /*! obtains an \f$x\f$-monotone curve connecting the two given endpoints. * \param p The first point. * \param q The second point. * \pre p and q must not be the same. @@ -1557,7 +1556,7 @@ public: } }; - /*! Obtain a `Construct_x_monotone_curve_2` functor object. */ + /*! obtains a `Construct_x_monotone_curve_2` functor object. */ Construct_x_monotone_curve_2 construct_x_monotone_curve_2_object() const { return Construct_x_monotone_curve_2(); } //@} @@ -1568,14 +1567,13 @@ public: //! Functor typedef Construct_x_monotone_curve_2 Construct_curve_2; - /*! Obtain a `Construct_curve_2` functor object. */ + /*! obtains a `Construct_curve_2` functor object. */ Construct_curve_2 construct_curve_2_object() const { return Construct_x_monotone_curve_2(*this); } //@} }; -/*! - * \class A representation of a segment, as used by the Arr_segment_traits_2 +/*! \class A representation of a segment, as used by the Arr_segment_traits_2 * traits-class. */ template @@ -1594,41 +1592,41 @@ public: typedef typename Kernel::Line_2 Line_2; public: - /*! Default constructor. + /*! constructs default. */ Arr_linear_object_2() : Base() {} - /*! Constructor from two points. + /*! constructs from two points. * \param s The source point. * \param t The target point. * \pre The two points must not be the same. */ Arr_linear_object_2(const Point_2& s, const Point_2& t) : Base(s, t) {} - /*! Constructor from a segment. + /*! constructs from a segment. * \param seg The segment. * \pre The segment is not degenerate. */ Arr_linear_object_2(const Segment_2& seg) : Base(seg) {} - /*! Constructor from a ray. + /*! constructs from a ray. * \param ray The segment. * \pre The ray is not degenerate. */ Arr_linear_object_2(const Ray_2& ray) : Base(ray) {} - /*! Constructor from a line. + /*! constructs from a line. * \param line The line. * \pre The line is not degenerate. */ Arr_linear_object_2(const Line_2& line) : Base(line) {} - /*! Check whether the object is actually a segment. + /*! checks whether the object is actually a segment. */ bool is_segment() const { return (! this->is_degen && this->has_source && this->has_target); } - /*! Cast to a segment. + /*! casts to a segment. * \pre The linear object is really a segment. */ Segment_2 segment() const @@ -1640,12 +1638,12 @@ public: return seg; } - /*! Check whether the object is actually a ray. + /*! checks whether the object is actually a ray. */ bool is_ray() const { return (! this->is_degen && (this->has_source != this->has_target)); } - /*! Cast to a ray. + /*! casts to a ray. * \pre The linear object is really a ray. */ Ray_2 ray() const @@ -1660,12 +1658,12 @@ public: return ray; } - /*! Check whether the object is actually a line. + /*! checks whether the object is actually a line. */ bool is_line() const { return (! this->is_degen && ! this->has_source && ! this->has_target); } - /*! Cast to a line. + /*! casts to a line. * \pre The linear object is really a line. */ Line_2 line() const @@ -1674,7 +1672,7 @@ public: return (this->l); } - /*! Get the supporting line. + /*! obtains the supporting line. * \pre The object is not a point. */ const Line_2& supporting_line() const @@ -1683,7 +1681,7 @@ public: return (this->l); } - /*! Get the source point. + /*! obtains the source point. * \pre The object is a point, a segment or a ray. */ const Point_2& source() const @@ -1695,7 +1693,7 @@ public: else return (this->pt); // For a "flipped" ray. } - /*! Get the target point. + /*! obtains the target point. * \pre The object is a point or a segment. */ const Point_2& target() const @@ -1704,7 +1702,7 @@ public: return (this->pt); } - /*! Create a bounding box for the linear object. + /*! creates a bounding box for the linear object. */ Bbox_2 bbox() const { diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_basic_traits_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_basic_traits_2.h index 2d2fa2e609f..b15cf639204 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_basic_traits_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_basic_traits_2.h @@ -73,9 +73,8 @@ public: typedef Arr_oblivious_side_tag Top_side_category; typedef Arr_oblivious_side_tag Right_side_category; - /*! Default Constructor */ - Arr_non_caching_segment_basic_traits_2() - {} + /*! constructs default */ + Arr_non_caching_segment_basic_traits_2() {} /// \name Types and functor inherited from the kernel //@{ @@ -116,8 +115,7 @@ public: */ class Compare_y_at_x_left_2 { public: - - /* Compare the \f$y\f$-value of two segments immediately to the left of + /* compares the \f$y\f$-value of two segments immediately to the left of * their intersection point. * \param cv1 The first segment. * \param cv2 The second segment. @@ -163,19 +161,16 @@ public: } }; - /*! Obtain a Compare_y_at_x_left_2 functor object. */ + /*! obtains a `Compare_y_at_x_left_2` functor object. */ Compare_y_at_x_left_2 compare_y_at_x_left_2_object() const - { - return Compare_y_at_x_left_2(); - } + { return Compare_y_at_x_left_2(); } /*! \class * A functor for comparing two segments to the right of a point. */ class Compare_y_at_x_right_2 { public: - - /*! Compare the \f$y\f$-value of two segments immediately to the right of + /*! compares the \f$y\f$-value of two segments immediately to the right of * their intersection point. * \param cv1 The first segment. * \param cv2 The second segment. @@ -220,11 +215,9 @@ public: } }; - /*! Obtain a `Compare_y_at_x_right_2` functor object. */ + /*! obtains a `Compare_y_at_x_right_2` functor object. */ Compare_y_at_x_right_2 compare_y_at_x_right_2_object() const - { - return Compare_y_at_x_right_2(); - } + { return Compare_y_at_x_right_2(); } //@} /// \name Functor definitions for the landmarks point-location strategy. @@ -240,7 +233,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits. */ Approximate_2(const Traits& traits) : m_traits(traits) {} @@ -248,7 +241,7 @@ public: friend class Arr_non_caching_segment_basic_traits_2; public: - /*! Return an approximation of a point coordinate. + /*! obtains an approximation of a point coordinate. * \param p The exact point. * \param i The coordinate index (either 0 or 1). * \pre `i` is either 0 or 1. @@ -260,12 +253,12 @@ public: return (i == 0) ? (CGAL::to_double(p.x())) : (CGAL::to_double(p.y())); } - /*! Obtain an approximation of a point. + /*! obtains an approximation of a point. */ Approximate_point_2 operator()(const Point_2& p) const { return Approximate_point_2(operator()(p, 0), operator()(p, 1)); } - /*! Obtain an approximation of an \f$x\f$-monotone curve. + /*! obtains an approximation of an \f$x\f$-monotone curve. */ template OutputIterator operator()(const X_monotone_curve_2& xcv, double /* error */, @@ -284,20 +277,18 @@ public: } }; - /*! Get an Approximate_2 functor object. */ + /*! obtains an Approximate_2 functor object. */ Approximate_2 approximate_2_object () const { return Approximate_2(*this); } typedef typename Kernel::Construct_segment_2 Construct_x_monotone_curve_2; - /*! Get a `Construct_x_monotone_curve_2` functor object. */ + /*! obtains a `Construct_x_monotone_curve_2` functor object. */ Construct_x_monotone_curve_2 construct_x_monotone_curve_2_object () const - { - return (this->construct_segment_2_object()); - } + { return (this->construct_segment_2_object()); } //@} }; -} //namespace CGAL +} // namespace CGAL #include diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_traits_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_traits_2.h index 58acefda211..4029a7be681 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_traits_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_non_caching_segment_traits_2.h @@ -52,7 +52,7 @@ public: typedef typename Base::Segment_assertions Segment_assertions; typedef typename Base::Has_exact_division Has_exact_division; - /*! Default constructor */ + /*! constructs default */ Arr_non_caching_segment_traits_2() : Base() {} /// \name Types and functors inherited from the base @@ -118,7 +118,7 @@ public: */ class Make_x_monotone_2 { public: - /*! Subdivide a given curve into x-monotone subcurves and insert them into + /*! subdivides a given curve into x-monotone subcurves and insert them into * a given output iterator. As segments are always x_monotone, only one * x-monotone curve is inserted into the output iterator. * \param cv the segment. @@ -138,7 +138,7 @@ public: } }; - /*! Obtain a Make_x_monotone_2 functor object. */ + /*! obtains a Make_x_monotone_2 functor object. */ Make_x_monotone_2 make_x_monotone_2_object() const { return Make_x_monotone_2(); } @@ -149,7 +149,7 @@ public: typedef Arr_non_caching_segment_traits_2 Self; public: - /*! Split a given x-monotone curve at a given point into two sub-curves. + /*! splits a given x-monotone curve at a given point into two sub-curves. * \param cv The curve to split * \param p The split point. * \param c1 Output: The left resulting subcurve (p is its right endpoint). @@ -189,7 +189,7 @@ public: } }; - /*! Obtain a Split_2 functor object. */ + /*! obtains a Split_2 functor object. */ Split_2 split_2_object() const { return Split_2(); } /*! \class @@ -202,7 +202,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Intersect_2(const Traits& traits) : m_traits(traits) {} @@ -210,7 +210,7 @@ public: friend class Arr_non_caching_segment_traits_2; public: - /*! Find the intersections of the two given segments and insert them into + /*! finds the intersections of the two given segments and insert them into * the given output iterator. As two segments may itersect only once, only * a single intersection will be contained in the iterator. * \param cv1 The first curve. @@ -264,7 +264,7 @@ public: } }; - /*! Obtain an Intersect_2 functor object. */ + /*! obtains an Intersect_2 functor object. */ Intersect_2 intersect_2_object() const { return Intersect_2(*this); } /*! \class @@ -277,7 +277,7 @@ public: /*! The traits (in case it has state) */ const Traits* m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Are_mergeable_2(const Traits* traits) : m_traits(traits) {} @@ -285,7 +285,7 @@ public: friend class Arr_non_caching_segment_traits_2; public: - /*! Check whether it is possible to merge two given x-monotone curves. + /*! checks whether it is possible to merge two given x-monotone curves. * \param cv1 The first curve. * \param cv2 The second curve. * \return (true) if the two curves are mergeable, that is, if they are @@ -308,7 +308,7 @@ public: } }; - /*! Obtain an Are_mergeable_2 functor object */ + /*! obtains an Are_mergeable_2 functor object */ Are_mergeable_2 are_mergeable_2_object() const { return Are_mergeable_2(this); } @@ -322,7 +322,7 @@ public: /*! The traits (in case it has state) */ const Traits* m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Merge_2(const Traits* traits) : m_traits(traits) {} @@ -330,7 +330,7 @@ public: friend class Arr_non_caching_segment_traits_2; public: - /*! Merge two given segments into a single segment. + /*! merges two given segments into a single segment. * \param cv1 The first curve. * \param cv2 The second curve. * \param c Output: The merged curve. @@ -365,7 +365,7 @@ public: } }; - /*! Obtain a Merge_2 functor object */ + /*! obtains a Merge_2 functor object */ Merge_2 merge_2_object() const { return Merge_2(this); } //@} @@ -373,14 +373,13 @@ public: //@{ typedef typename Kernel::Construct_opposite_segment_2 Construct_opposite_2; - /*! Obtain a Construct_opposite_2 functor object */ + /*! obtains a Construct_opposite_2 functor object */ Construct_opposite_2 construct_opposite_2_object() const { return Construct_opposite_2(); } class Compare_endpoints_xy_2 { public: - /*! - * Compare the two endpoints of a given curve lexigoraphically. + /*! compares the two endpoints of a given curve lexigoraphically. * \param cv The curve. * \return SMALLER if cv is directed from left to right and LARGER * otherwise. @@ -397,7 +396,7 @@ public: } }; - /*! Obtain a Compare_endpoints_xy_2 functor object */ + /*! obtains a Compare_endpoints_xy_2 functor object */ Compare_endpoints_xy_2 compare_endpoints_xy_2_object() const { return Compare_endpoints_xy_2(); } //@} @@ -408,14 +407,14 @@ public: //! Functor typedef typename Kernel::Construct_segment_2 Construct_curve_2; - /*! Obtain a Construct_curve_2 functor object. */ + /*! obtains a Construct_curve_2 functor object. */ Construct_curve_2 construct_curve_2_object() const { return this->construct_segment_2_object(); } //@} }; -} //namespace CGAL +} // namespace CGAL #include diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_batched_point_location_traits_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_batched_point_location_traits_2.h index b83ca0189e2..2a356de0179 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_batched_point_location_traits_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_batched_point_location_traits_2.h @@ -77,7 +77,7 @@ protected: const Base_traits_2* m_base_traits; public: - /*! Constructor. */ + /*! constructs. */ Arr_batched_point_location_traits_2(const Base_traits_2& tr) : m_base_traits(&tr) {} @@ -184,7 +184,7 @@ public: //! The base operator. Base_construct_min_vertex_2 m_base_min_v; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -197,8 +197,7 @@ public: friend class Arr_batched_point_location_traits_2; public: - /*! - * Get the left endpoint of the x-monotone curve (segment). + /*! obtains the left endpoint of the x-monotone curve (segment). * \param xcv The curve. * \return The left endpoint. */ @@ -211,7 +210,7 @@ public: } }; - /*! Obtain a Construct_min_vertex_2 functor object. */ + /*! obtains a Construct_min_vertex_2 functor object. */ Construct_min_vertex_2 construct_min_vertex_2_object() const { return @@ -224,7 +223,7 @@ public: //! The base operator. Base_construct_max_vertex_2 m_base_max_v; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -237,8 +236,7 @@ public: friend class Arr_batched_point_location_traits_2; public: - /*! - * Get the right endpoint of the x-monotone curve . + /*! obtains the right endpoint of the x-monotone curve . * \param xcv The curve. * \return The right endpoint. */ @@ -251,7 +249,7 @@ public: } }; - /*! Obtain a Construct_min_vertex_2 functor object. */ + /*! obtains a Construct_min_vertex_2 functor object. */ Construct_max_vertex_2 construct_max_vertex_2_object() const { return @@ -266,7 +264,7 @@ public: Vertex_const_handle invalid_v; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -280,8 +278,7 @@ public: friend class Arr_batched_point_location_traits_2; public: - /*! - * Get the left endpoint of the x-monotone curve (segment). + /*! obtains the left endpoint of the x-monotone curve (segment). * \param xcv The curve. * \return The left endpoint. */ @@ -295,7 +292,7 @@ public: } }; - /*! Obtain a Construct_min_vertex_2 functor object. */ + /*! obtains a Construct_min_vertex_2 functor object. */ Compare_xy_2 compare_xy_2_object() const { return Compare_xy_2(m_base_traits->compare_xy_2_object()); } @@ -307,7 +304,7 @@ public: //! The base operator. Base_compare_y_at_x_2 m_base_cmp_y_at_x; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -325,7 +322,7 @@ public: { return (m_base_cmp_y_at_x(p.base(), xcv.base())); } }; - /*! Obtain a Compare_y_at_x_2 function object. */ + /*! obtains a Compare_y_at_x_2 function object. */ Compare_y_at_x_2 compare_y_at_x_2_object() const { return (Compare_y_at_x_2(m_base_traits->compare_y_at_x_2_object())); } @@ -337,7 +334,7 @@ public: //! The base operator. Base_compare_y_at_x_right_2 m_base_cmp_y_at_x_right; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -356,7 +353,7 @@ public: { return (m_base_cmp_y_at_x_right(xcv1.base(), xcv2.base(), p.base())); } }; - /*! Obtain a Compare_y_at_x_right_2 function object. */ + /*! obtains a Compare_y_at_x_right_2 function object. */ Compare_y_at_x_right_2 compare_y_at_x_right_2_object() const { return (Compare_y_at_x_right_2 @@ -374,7 +371,7 @@ public: Vertex_const_handle invalid_v; Halfedge_const_handle invalid_he; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -389,7 +386,7 @@ public: friend class Arr_batched_point_location_traits_2; public: - /*! Check if two curves are the same. */ + /*! checks if two curves are the same. */ bool operator()(const X_monotone_curve_2& xcv1, const X_monotone_curve_2& xcv2) const { @@ -400,7 +397,7 @@ public: return (m_base_eq(xcv1.base(), xcv2.base())); } - /*! Check if the two points are the same. */ + /*! checks if the two points are the same. */ bool operator()(const Point_2& p1, const Point_2& p2) const { if (p1.vertex_handle() == p2.vertex_handle() && @@ -411,7 +408,7 @@ public: } }; - /*! Obtain an `Equal_2` function object. */ + /*! obtains an `Equal_2` function object. */ Equal_2 equal_2_object() const { return (Equal_2(m_base_traits->equal_2_object())); } @@ -421,7 +418,7 @@ public: //! The base operator. Base_compare_x_2 m_base_cmp_x; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -436,7 +433,7 @@ public: { return (m_base_cmp_x(p1.base(), p2.base())); } }; - /*! Obtain a Compare_x_2 function object. */ + /*! obtains a Compare_x_2 function object. */ Compare_x_2 compare_x_2_object() const { return (Compare_x_2(m_base_traits->compare_x_2_object())); } @@ -446,7 +443,7 @@ public: //! The base operator. Base_is_vertical_2 m_base_is_vert; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -461,7 +458,7 @@ public: { return (m_base_is_vert(xcv.base())); } }; - /*! Obtain a Is_vertical_2 function object. */ + /*! obtains a Is_vertical_2 function object. */ Is_vertical_2 is_vertical_2_object() const { return (Is_vertical_2(m_base_traits->is_vertical_2_object())); } @@ -476,7 +473,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -498,7 +495,7 @@ public: { return m_base->parameter_space_in_x_2_object() (xcv.base()); } }; - /*! Obtain a Parameter_space_in_x_2 function object */ + /*! obtains a Parameter_space_in_x_2 function object */ Parameter_space_in_x_2 parameter_space_in_x_2_object() const { return Parameter_space_in_x_2(m_base_traits); } @@ -510,7 +507,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -528,7 +525,7 @@ public: { return m_base->is_on_x_identification_2_object()(xcv.base()); } }; - /*! Obtain a Is_on_x_identification_2 function object */ + /*! obtains a Is_on_x_identification_2 function object */ Is_on_x_identification_2 is_on_x_identification_2_object() const { return Is_on_x_identification_2(m_base_traits); } @@ -540,7 +537,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * \param tr The base traits class. It must be passed, to handle * non stateless traits (e.g., it stores data). * The constructor is declared private to allow only the functor @@ -574,7 +571,7 @@ public: } }; - /*! Obtain a Compare_y_on_boundary_2 functor object. */ + /*! obtains a Compare_y_on_boundary_2 functor object. */ Compare_y_on_boundary_2 compare_y_on_boundary_2_object() const { return Compare_y_on_boundary_2(m_base_traits); } @@ -586,7 +583,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * \param tr The base traits class. It must be passed, to handle * non stateless traits (e.g., it stores data). * The constructor is declared private to allow only the functor @@ -610,7 +607,7 @@ public: } }; - /*! Obtain a Compare_y_near_boundary_2 functor object. */ + /*! obtains a Compare_y_near_boundary_2 functor object. */ Compare_y_near_boundary_2 compare_y_near_boundary_2_object() const { return Compare_y_near_boundary_2(m_base_traits); } @@ -624,7 +621,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -646,7 +643,7 @@ public: { return m_base->parameter_space_in_y_2_object()(xcv.base()); } }; - /*! Obtain a Parameter_space_in_y_2 function object */ + /*! obtains a Parameter_space_in_y_2 function object */ Parameter_space_in_y_2 parameter_space_in_y_2_object() const { return Parameter_space_in_y_2(m_base_traits); } @@ -658,7 +655,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, * constructing it. @@ -676,7 +673,7 @@ public: { return m_base->is_on_y_identification_2_object()(xcv.base()); } }; - /*! Obtain a Is_on_y_identification_2 function object */ + /*! obtains a Is_on_y_identification_2 function object */ Is_on_y_identification_2 is_on_y_identification_2_object() const { return Is_on_y_identification_2(m_base_traits); } @@ -688,7 +685,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * \param tr The base traits class. It must be passed, to handle * non stateless traits (e.g., it stores data). * The constructor is declared private to allow only the functor @@ -722,7 +719,7 @@ public: } }; - /*! Obtain a Compare_x_on_boundary_2 functor object. */ + /*! obtains a Compare_x_on_boundary_2 functor object. */ Compare_x_on_boundary_2 compare_x_on_boundary_2_object() const { return Compare_x_on_boundary_2(m_base_traits); } @@ -734,7 +731,7 @@ public: //! The base traits. const Base_traits_2* m_base; - /*! Constructor. + /*! constructs. * \param tr The base traits class. It must be passed, to handle * non stateless traits (e.g., it stores data). * The constructor is declared private to allow only the functor @@ -757,11 +754,11 @@ public: } }; - /*! Obtain a Compare_x_near_boundary_2 function object. */ + /*! obtains a Compare_x_near_boundary_2 function object. */ Compare_x_near_boundary_2 compare_x_near_boundary_2_object() const { return Compare_x_near_boundary_2(m_base_traits); } }; -} //namespace CGAL +} // namespace CGAL #endif diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_lm_generator_base.h b/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_lm_generator_base.h index c7bd903ee70..f40b9e1edea 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_lm_generator_base.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Arr_lm_generator_base.h @@ -98,14 +98,14 @@ public: bool is_empty() const { return nn.is_empty(); } private: - /*! Copy constructor - not supported. */ + /*! Copy constructor not supported. */ Arr_landmarks_generator_base(const Self&); - /*! Assignment operator - not supported. */ + /*! Assignment operator not supported. */ Self& operator=(const Self& ); public: - /*! Constructor from an arrangement. + /*! constructs from an arrangement. * \param arr (in) The arrangement. */ Arr_landmarks_generator_base(const Base_aos& arr) : @@ -120,7 +120,7 @@ public: // inherited class. } - /*! Create the landmarks set (choosing the landmarks) , + /*! creates the landmarks set (choosing the landmarks) , * and saving them in the nearest-neighbor search structure. */ virtual void build_landmark_set() { @@ -136,7 +136,7 @@ public: updated = true; } - /*! clear the set of landmarks. + /*! clears the set of landmarks. */ virtual void clear_landmark_set() { nn.clear(); @@ -144,7 +144,7 @@ public: updated = false; } - /*! Obtain the nearest neighbor (landmark) to the given point. + /*! obtains the nearest neighbor (landmark) to the given point. * \param p The query point. * \param obj Output: The location of the nearest landmark point in the * arrangement (a vertex, halfedge, or face handle). @@ -399,7 +399,7 @@ public: //@} protected: - /*! Create the list of landmarks with their location. + /*! creates the list of landmarks with their location. * This is a pure virtual function, and the class that inherites from * this generator must implement it. */ diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Td_traits.h b/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Td_traits.h index 391fb264658..729b3fcc831 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Td_traits.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_point_location/Td_traits.h @@ -171,7 +171,7 @@ public: /*! The traits (in case it has state) */ const Traits* m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -352,7 +352,7 @@ public: }; - /*! Obtain a Compare_curve_end_x_2 functor object. */ + /*! obtains a Compare_curve_end_x_2 functor object. */ Compare_curve_end_x_2 compare_curve_end_x_2_object () const { return Compare_curve_end_x_2(this); @@ -371,7 +371,7 @@ public: /*! The traits (in case it has state) */ const Traits* m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -481,7 +481,7 @@ public: }; - /*! Obtain a Compare_y_at_x_2 functor object. */ + /*! obtains a Compare_y_at_x_2 functor object. */ Compare_curve_end_y_at_x_2 compare_curve_end_y_at_x_2_object () const { return Compare_curve_end_y_at_x_2(this); @@ -498,7 +498,7 @@ public: const Traits* m_traits; const Traits_base* m_traits_base; //MICHAL: rational-upd - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -586,7 +586,7 @@ public: }; - /*! Obtain an Equal_curve_end_2 functor object. */ + /*! obtains an Equal_curve_end_2 functor object. */ Equal_curve_end_2 equal_curve_end_2_object () const { return Equal_curve_end_2(this); @@ -601,7 +601,7 @@ public: /*! The traits (in case it has state) */ const Traits* m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) * The constructor is declared private to allow only the functor * obtaining function, which is a member of the nesting class, @@ -613,8 +613,7 @@ public: friend class Td_traits; public: - /*! - * Compare two edge ends lexigoraphically: by x, then by y. + /*! compares two edge ends lexigoraphically: by x, then by y. * \param cv1, cv1_end The first cv end. * \param cv2, cv2_end The second cv end. * \return LARGER if x(cv1-end) > x(cv2-end), @@ -860,15 +859,12 @@ public: } }; - /*! Obtain a Compare_curve_end_xy_2 functor object. */ + /*! obtains a Compare_curve_end_xy_2 functor object. */ Compare_curve_end_xy_2 compare_curve_end_xy_2_object () const { return Compare_curve_end_xy_2(this); } - - - // Td_traits class ctors and dtor Td_traits(const Traits_base& t) : Traits_base(t) diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_polycurve_basic_traits_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_polycurve_basic_traits_2.h index f540146b2cb..aef731fa798 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_polycurve_basic_traits_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_polycurve_basic_traits_2.h @@ -85,20 +85,20 @@ protected: enum { INVALID_INDEX = 0xffffffff }; public: - /*! Construct default. */ + /*! constructs default. */ Arr_polycurve_basic_traits_2() : m_subcurve_traits(new Subcurve_traits_2()), m_own_traits(true) {} - /*! Construct from a subcurve traits. + /*! constructs from a subcurve traits. * \param seg_traits an already existing subcurve tarits, which is passed in; * it will be used by the class. */ Arr_polycurve_basic_traits_2(const Subcurve_traits_2* geom_traits) : m_subcurve_traits(geom_traits), m_own_traits(false) {} - /*! Construct copy. + /*! constructs copy. * If the 'other' polycurve traits owns its subcurve traits, then make * this polycurve traits own its subcurve traits as well * \param other the other traits. @@ -117,7 +117,7 @@ public: ~Arr_polycurve_basic_traits_2() { if (m_own_traits) delete m_subcurve_traits; } - /*! Obtain the subcurve traits. + /*! obtains the subcurve traits. * \return the subcurve traits. */ const Subcurve_traits_2* subcurve_traits_2() const @@ -147,13 +147,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_x_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare the \f$x\f$-coordinates of two directional points. + /*! compares the \f$x\f$-coordinates of two directional points. * \param p1 the first directional point. * \param p2 the second directional point. * \return `SMALLER` - \f$x\f$(`p1`) < \f$x\f$(`p2`); @@ -165,7 +165,7 @@ public: Comparison_result operator()(const Point_2& p1, const Point_2& p2) const { return m_poly_traits.subcurve_traits_2()->compare_x_2_object()(p1, p2); } - /*! Compare two ends of \f$x\f$-monotone curves in \f$x\f$. + /*! compares two ends of \f$x\f$-monotone curves in \f$x\f$. * \param xs1 the first curve. * \param ce1 the curve-end indicator of the first \f$x\f$-monotone curve * `xs1`: @@ -177,7 +177,7 @@ public: Arr_curve_end ce1, const Point_2& p2) { return operator()(xs1, ce1, p2, All_sides_oblivious_category()); } - /*! Compare two ends of \f$x\f$-monotone curves in x. + /*! compares two ends of \f$x\f$-monotone curves in x. * \param xs1 the first curve. * \param ce1 the curve-end indicator of the first \f$x\f$-monotone curve * `xs1`: @@ -296,7 +296,7 @@ public: } }; - /*! Obtain a Compare_x_2 functor object. */ + /*! obtains a Compare_x_2 functor object. */ Compare_x_2 compare_x_2_object() const { return Compare_x_2(*this); } //! Compare two curve-ends or points lexigoraphically: by x, then by y. @@ -310,13 +310,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_xy_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare two directional points lexigoraphically: by \f$x\f$, then by + /*! compares two directional points lexigoraphically: by \f$x\f$, then by * \f$y\f$. * \param p1 the first endpoint directional point. * \param p2 the second endpoint directional point. @@ -332,7 +332,7 @@ public: Comparison_result operator()(const Point_2& p1, const Point_2& p2) const { return m_poly_traits.subcurve_traits_2()->compare_xy_2_object()(p1, p2); } - /*! Compare two ends of \f$x\f$-monotone curves lexicographically. + /*! compares two ends of \f$x\f$-monotone curves lexicographically. * \param xs1 the first curve. * \param ce1 the curve-end indicator of the first \f$x\f$-monotone curve * `xs1`: @@ -344,7 +344,7 @@ public: Arr_curve_end ce1, const Point_2& p2) { return operator()(xs1, ce1, p2, All_sides_oblivious_category()); } - /*! Compare two ends of \f$x\f$-monotone curves lexicographically. + /*! compares two ends of \f$x\f$-monotone curves lexicographically. * \param xs1 the first curve. * \param ce1 the curve-end indicator of the first \f$x\f$-monotone curve * `xs1`: @@ -517,7 +517,7 @@ public: } }; - /*! Obtain a Compare_xy_2 functor object. */ + /*! obtains a Compare_xy_2 functor object. */ Compare_xy_2 compare_xy_2_object() const { return Compare_xy_2(*this); } /*! A functor that obtain the lexicographically smallest endpoint of an @@ -533,13 +533,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /* Constructor. */ + /*! constructs. */ Construct_min_vertex_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Obtain the left endpoint of the \f$x\f$-monotone polycurve. The return + /*! obtains the left endpoint of the \f$x\f$-monotone polycurve. The return * type is the same as the return type of the corresponding operator in the * functor of the subtraits, which is either by value or by reference. * \param xcv the polycurve curve. @@ -561,7 +561,7 @@ public: } }; - /*! Obtain a Construct_min_vertex_2 functor object. */ + /*! obtains a Construct_min_vertex_2 functor object. */ Construct_min_vertex_2 construct_min_vertex_2_object() const { return Construct_min_vertex_2(*this); } @@ -578,13 +578,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Construct_max_vertex_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Obtain the right endpoint of the \f$x\f$-monotone polycurve. The return + /*! obtains the right endpoint of the \f$x\f$-monotone polycurve. The return * type is the same as the return type of the corresponding operator in the * functor of the subtraits, which is either by value or by reference. * \param xcv the polycurve. @@ -603,7 +603,7 @@ public: } }; - /*! Obtain a Construct_max_vertex_2 functor object. */ + /*! obtains a Construct_max_vertex_2 functor object. */ Construct_max_vertex_2 construct_max_vertex_2_object() const { return Construct_max_vertex_2(*this); } @@ -618,13 +618,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Is_vertical_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Check whether the given \f$x\f$-monotone curve is a vertical segment. + /*! checks whether the given \f$x\f$-monotone curve is a vertical segment. * \param cv the curve. * \return `true` if the curve is a vertical segment; `false` otherwise. */ @@ -637,7 +637,7 @@ public: } }; - /*! Obtain an Is_vertical_2 functor object. */ + /*! obtains an Is_vertical_2 functor object. */ Is_vertical_2 is_vertical_2_object() const { return Is_vertical_2(*this); } /*! A functor that compares the \f$y\f$-coordinates of a point and an @@ -762,13 +762,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_y_at_x_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Obtain the location of the given point with respect to the input curve. + /*! obtains the location of the given point with respect to the input curve. * \param p the point. * \param xcv the polycurve curve. * \pre `p` is in the \f$x\f$-range of `xcv`. @@ -781,7 +781,7 @@ public: const X_monotone_curve_2& xcv) const { return operator()(p, xcv, All_sides_oblivious_category()); } - /*! Obtain the location of the given curve_end with respect to the input + /*! obtains the location of the given curve_end with respect to the input * curve. * \param xcv The polycurve curve. * \param ce the curve-end indicator of the \f$x\f$-monotone subcurve xl: @@ -801,7 +801,7 @@ public: { return operator()(xs1, ce1, xs2, All_sides_oblivious_category()); } }; - /*! Obtain a Compare_y_at_x_2 functor object. */ + /*! obtains a Compare_y_at_x_2 functor object. */ Compare_y_at_x_2 compare_y_at_x_2_object() const { return Compare_y_at_x_2(*this); } @@ -818,13 +818,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_y_at_x_left_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare the y value of two \f$x\f$-monotone curves immediately to the + /*! compares the y value of two \f$x\f$-monotone curves immediately to the * left of their intersection point. * \param cv1 the first polycurve curve. * \param cv2 the second polycurve curve. @@ -851,7 +851,7 @@ public: } }; - /*! Obtain a Compare_y_at_x_left_2 functor object. */ + /*! obtains a Compare_y_at_x_left_2 functor object. */ Compare_y_at_x_left_2 compare_y_at_x_left_2_object() const { return Compare_y_at_x_left_2(*this); } @@ -868,13 +868,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_y_at_x_right_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare the \f$y\f$-value of two \f$x\f$-monotone curves immediately to + /*! compares the \f$y\f$-value of two \f$x\f$-monotone curves immediately to * the right of their intersection point. * \param cv1 the first curve. * \param cv2 the second curve. @@ -901,7 +901,7 @@ public: } }; - /*! Obtain a Compare_y_at_x_right_2 functor object. + /*! obtains a Compare_y_at_x_right_2 functor object. */ Compare_y_at_x_right_2 compare_y_at_x_right_2_object() const { return Compare_y_at_x_right_2(*this); } @@ -919,11 +919,11 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Equal_2(const Polycurve_basic_traits_2& poly_tr) : m_poly_traits(poly_tr) {} public: - /*! Check whether the two points are the same. + /*! checks whether the two points are the same. * \param p1 the first point. * \param p2 the second point. * \return `true` if the two point are the same; `false` otherwise. @@ -931,7 +931,7 @@ public: bool operator()(const Point_2& p1, const Point_2& p2) const { return m_poly_traits.subcurve_traits_2()->equal_2_object()(p1, p2); } - /*! Check whether the two \f$x\f$-monotone curves are the same (have the + /*! checks whether the two \f$x\f$-monotone curves are the same (have the * same graph). * \param cv1 the first curve. * \param cv2 the second curve. @@ -1008,7 +1008,7 @@ public: } }; - /*! Obtain an Equal_2 functor object. */ + /*! obtains an Equal_2 functor object. */ Equal_2 equal_2_object() const { return Equal_2(*this); } /*! A functor that lexicographically compares the endpoints of a curve. */ @@ -1022,13 +1022,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_endpoints_xy_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare the endpoints of an \(x\)-monotone curve lexicographically. + /*! compares the endpoints of an \(x\)-monotone curve lexicographically. * (assuming the curve has a designated source and target points). * \param cv the curve. * \return `SMALLER` if `cv` is oriented left-to-right; @@ -1062,13 +1062,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor */ + /*! constructs */ Construct_opposite_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Construct the reversed \f$x\f$-monotone polycurve of the input. + /*! constructs the reversed \f$x\f$-monotone polycurve of the input. * Note that the functor constructs the opposites of _all_ subcurves * constituting `xcv`. * \param xcv the \f$x\f$-monotone polycurve to be reveres @@ -1132,7 +1132,7 @@ public: using Approximate_point_2 = typename has_approximate_2::Approximate_point_2; - /*! Obtain an Approximate_2 functor object. */ + /*! obtains an Approximate_2 functor object. */ Approximate_2 approximate_2_object_impl(std::false_type) const { return subcurve_traits_2()->approximate_2_object(); } @@ -1152,7 +1152,7 @@ public: //! The polycurve traits (in case it has state). const Polycurve_basic_traits_2& m_poly_traits; - /*! Constructor. */ + /*! constructs. */ Construct_point_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} @@ -1160,7 +1160,7 @@ public: friend class Arr_polycurve_basic_traits_2; public: - /*! Construct a point. + /*! constructs a point. * Apply perfect forwarding. */ template @@ -1171,7 +1171,7 @@ public: } }; - /*! Obtain a Construct_x_monotone_curve_2 functor object. */ + /*! obtains a Construct_x_monotone_curve_2 functor object. */ Construct_point_2 construct_point_2_object() const { return Construct_point_2(*this); } @@ -1186,13 +1186,14 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Construct_x_monotone_curve_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Obtain an \f$x\f$-monotone polycurve that consists of one given subcurve. + /*! obtains an \f$x\f$-monotone polycurve that consists of one given + * subcurve. * \param seg input subcurve. * \pre seg is not degenerated. * \return an \f$x\f$-monotone polycurve with one subcurve. @@ -1223,7 +1224,7 @@ public: return X_monotone_curve_2(seg); } - /*! Construct an \f$x\f$-monotone polycurve, which is well-oriented, from a + /*! constructs an \f$x\f$-monotone polycurve, which is well-oriented, from a * range of elements. * \pre the elements in the range should form a continuous well-oriented * \f$x\f$-monotone polycurve. @@ -1238,7 +1239,7 @@ public: return constructor_impl(begin, end, Is_point()); } - /*! Construct an \f$x\f$-monotone polycurve from a range of points. + /*! constructs an \f$x\f$-monotone polycurve from a range of points. * The polycurve may be oriented left-to-right or right-to-left * depending on the lexicographical order of the points in the input. * \pre range contains at least two points. @@ -1253,7 +1254,7 @@ public: std::true_type) const { CGAL_error_msg("Cannot construct a polycurve from a range of points!"); } - /*! Obtain an \f$x\f$-monotone polycurve from a range of subcurves. + /*! obtains an \f$x\f$-monotone polycurve from a range of subcurves. * \param begin An iterator pointing to the first subcurve in the range. * \param end An iterator pointing to the past-the-end subcurve * in the range. @@ -1345,7 +1346,7 @@ public: } }; - /*! Obtain a Construct_x_monotone_curve_2 functor object. */ + /*! obtains a Construct_x_monotone_curve_2 functor object. */ Construct_x_monotone_curve_2 construct_x_monotone_curve_2_object() const { return Construct_x_monotone_curve_2(*this); } @@ -1368,13 +1369,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Parameter_space_in_x_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Obtains the parameter space at the end of a curve along the + /*! obtains the parameter space at the end of a curve along the * \f$x\f$-axis. Note that if the curve-end coincides with a pole, then * unless the curve coincides with the identification curve, the curve-end * is considered to be approaching the boundary, but not on the boundary. @@ -1405,7 +1406,7 @@ public: return geom_traits->parameter_space_in_x_2_object()(xs, ce); } - /*! Obtains the parameter space at a point along the \f$x\f$-axis. + /*! obtains the parameter space at a point along the \f$x\f$-axis. * \param p the point. * \return the parameter space at `p`. * \pre `p` does not lie on the vertical identification curve. @@ -1416,7 +1417,7 @@ public: } }; - /*! Obtain a Parameter_space_in_x_2 function object */ + /*! obtains a Parameter_space_in_x_2 function object */ Parameter_space_in_x_2 parameter_space_in_x_2_object() const { return Parameter_space_in_x_2(*this); } @@ -1433,13 +1434,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Parameter_space_in_y_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Obtains the parameter space at the end of an curve along the + /*! obtains the parameter space at the end of an curve along the * \f$y\f$-axis. Note that if the curve-end coincides with a pole, then * unless the curve coincides with the identification curve, the curve-end * is considered to be approaching the boundary, but not on the boundary. @@ -1470,7 +1471,7 @@ public: return geom_traits->parameter_space_in_y_2_object()(xs, ce); } - /*! Obtains the parameter space at a point along the \f$y\f$-axis. + /*! obtains the parameter space at a point along the \f$y\f$-axis. * \param p the point. * \return the parameter space at `p`. * \pre p does not lie on the horizontal identification curve. @@ -1482,7 +1483,7 @@ public: } }; - /*! Obtain a Parameter_space_in_y_2 function object */ + /*! obtains a Parameter_space_in_y_2 function object */ Parameter_space_in_y_2 parameter_space_in_y_2_object() const { return Parameter_space_in_y_2(*this); } @@ -1499,13 +1500,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_x_on_boundary_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare the \f$x\f$-coordinates of a point with the \f$x\f$-coordinate + /*! compares the \f$x\f$-coordinates of a point with the \f$x\f$-coordinate * of an \f$x\f$-curve-end on the boundary. * \param point the point. * \param xcv the \f$x\f$-monotone curve, the endpoint of which is compared. @@ -1525,7 +1526,7 @@ public: Arr_curve_end ce) const { return operator()(point, xcv, ce, Bottom_or_top_sides_category()); } - /*! Compare the \f$x\f$-coordinates of 2 curve-ends on the boundary of the + /*! compares the \f$x\f$-coordinates of 2 curve-ends on the boundary of the * parameter space. * \param xcv1 the first curve. * \param ce1 the first curve-end indicator: @@ -1553,7 +1554,7 @@ public: { return operator()(xcv1, ce1, xcv2, ce2, Bottom_or_top_sides_category()); } private: - /*! \brief compares the \f$x\f$-coordinates of a point with the + /*! compares the \f$x\f$-coordinates of a point with the * \f$x\f$-coordinate of an \f$x\f$-monotone curve-end on the boundary. */ Comparison_result operator()(const Point_2& point, @@ -1570,7 +1571,7 @@ public: return geom_traits->compare_x_on_boundary_2_object()(point, xs, ce); } - /*! \brief compares the \f$x\f$-coordinates of 2 curve-ends on the boundary + /*! compares the \f$x\f$-coordinates of 2 curve-ends on the boundary * of the parameter space. */ Comparison_result operator()(const X_monotone_curve_2& xcv1, @@ -1597,13 +1598,12 @@ public: const Arr_curve_end ce) const { return (ce == ARR_MIN_END) ? 0 : xcv.number_of_subcurves() - 1; } - /*! Given a point \f$p\f$, an x-monotone curve \f$C(t) = (X(t),Y(t))\f$, - * and an enumerator that specifies either the minimum end or the - * maximum end of the curve, and thus maps to a parameter value - * \f$d \in \{0,1\}\f$, compare x_p and limit{t => d} X(t). - * If the parameter space is unbounded, a precondition ensures that \f$C\f$ - * has a vertical asymptote at its \f$d\f$-end; that is - * limit{t => d} X(t) is finite. + /*! given a point \f$p\f$, an \f$x\f$-monotone curve \f$C(t) = + * (X(t),Y(t))\f$, and an enumerator that specifies either the minimum end + * or the maximum end of the curve, and thus maps to a parameter value \f$d + * \in \{0,1\}\f$, compares x_p and limit{t => d} X(t). If the parameter + * space is unbounded, a precondition ensures that \f$C\f$ has a vertical + * asymptote at its \f$d\f$-end; that is limit{t => d} X(t) is finite. */ Comparison_result operator()(const Point_2& p, const X_monotone_curve_2& xcv, @@ -1616,7 +1616,7 @@ public: return cmp_x_on_boundary(p, xcv[index], ce); } - /*! Given two \f$x\f$-monotone curves \f$C_1(t) = (X_1(t),Y_1(t))\f$ and + /*! given two \f$x\f$-monotone curves \f$C_1(t) = (X_1(t),Y_1(t))\f$ and * \f$C2_(t) = (X_2(t),Y_2(t))\f$ and two enumerators that specify either * the minimum ends or the maximum ends of the curves, and thus map to * parameter values \f$d_1 \in \{0,1\}\f$ and \f$d_2 \in \{0,1\}\f$ for @@ -1624,7 +1624,7 @@ public: * limit{t => d1} X1(t) and limit{t => d2} X2(t). * If the parameter space is unbounded, a precondition ensures that * \f$C_1\f$ and \f$C_2\f$ have vertical asymptotes at their respective - * ends; that is, limit{t => d1} X1(t) and limit{t =? d2} X2(t) are finite. + * ends; that is, limit{t => d1} X1(t) and limit{t => d2} X2(t) are finite. */ Comparison_result operator()(const X_monotone_curve_2& xcv1, Arr_curve_end ce1/* for xcv1 */, @@ -1649,7 +1649,7 @@ public: } }; - /*! Obtain a Compare_x_on_boundary_2 function object. */ + /*! obtains a Compare_x_on_boundary_2 function object. */ Compare_x_on_boundary_2 compare_x_on_boundary_2_object() const { return Compare_x_on_boundary_2(*this); } @@ -1703,13 +1703,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_y_on_boundary_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare the \f$y\f$-coordinate of two given points that lie on the + /*! compares the \f$y\f$-coordinate of two given points that lie on the * vertical identification curve. * \param p1 the first point. * \param p2 the second point. @@ -1725,7 +1725,7 @@ public: } }; - /*! Obtain a Compare_y_on_boundary_2 function object */ + /*! obtains a Compare_y_on_boundary_2 function object */ Compare_y_on_boundary_2 compare_y_on_boundary_2_object() const { return Compare_y_on_boundary_2(*this); } @@ -1742,13 +1742,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Compare_y_near_boundary_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Compare the \f$y\f$-coordinates of 2 curves at their ends near the + /*! compares the \f$y\f$-coordinates of 2 curves at their ends near the * boundary of the parameter space. * \param xcv1 the first curve. * \param xcv2 the second curve. @@ -1780,7 +1780,7 @@ public: } }; - /*! Obtain a Compare_y_near_boundary_2 function object */ + /*! obtains a Compare_y_near_boundary_2 function object */ Compare_y_near_boundary_2 compare_y_near_boundary_2_object() const { return Compare_y_near_boundary_2(*this); } @@ -1797,13 +1797,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Is_on_y_identification_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Determine whether a point lies in the vertical boundary. + /*! determines whether a point lies in the vertical boundary. * \param p the point. * \return a Boolean indicating whether `p` lies in the vertical boundary. */ @@ -1812,7 +1812,7 @@ public: return geom_traits->is_on_y_identification_2_object()(p); } - /*! Determine whether an \f$x\f$-monotone curve lies in the vertical + /*! determines whether an \f$x\f$-monotone curve lies in the vertical * boundary. * \param xcv the \f$x\f$-monotone curve. * \return a Boolean indicating whether `xcv` lies in the vertical boundary. @@ -1825,7 +1825,7 @@ public: } }; - /*! Obtain a Is_on_y_identification_2 function object */ + /*! obtains a Is_on_y_identification_2 function object */ Is_on_y_identification_2 is_on_y_identification_2_object() const { return Is_on_y_identification_2(*this); } @@ -1842,13 +1842,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Is_on_x_identification_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Determine whether a point lies in the vertical boundary. + /*! determines whether a point lies in the vertical boundary. * \param p the point. * \return a Boolean indicating whether `p` lies in the vertical boundary. */ @@ -1857,7 +1857,7 @@ public: return geom_traits->is_on_x_identification_2_object()(p); } - /*! Determine whether an \f$x\f$-monotone curve lies in the vertical + /*! determines whether an \f$x\f$-monotone curve lies in the vertical * boundary. * \param `xcv` the \f$x\f$-monotone curve. * \return a Boolean indicating whether `xcv` lies in the vertical boundary. @@ -1870,7 +1870,7 @@ public: } }; - /*! Obtain a Is_on_x_identification_2 function object */ + /*! obtains a Is_on_x_identification_2 function object */ Is_on_x_identification_2 is_on_x_identification_2_object() const { return Is_on_x_identification_2(*this); } @@ -1906,13 +1906,13 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Push_back_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! Append a subcurve to an existing \f$x\f$-monotone polycurve at the back. + /*! appends a subcurve to an existing \f$x\f$-monotone polycurve at the back. */ void operator()(X_monotone_curve_2& xcv, const X_monotone_subcurve_2& seg) const @@ -2071,7 +2071,7 @@ public: } }; - /*! Obtain a Push_back_2 functor object. */ + /*! obtains a Push_back_2 functor object. */ Push_back_2 push_back_2_object() const { return Push_back_2(*this); } /* Functor to augment a polycurve by adding a subcurve at the front. @@ -2087,7 +2087,7 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Push_front_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} @@ -2225,7 +2225,7 @@ public: } }; - /*! Obtain a Push_front_2 functor object. */ + /*! obtains a Push_front_2 functor object. */ Push_front_2 push_front_2_object() const { return Push_front_2(*this); } //! A functor that trimps an \f$x\f$-monotone curve. @@ -2239,11 +2239,11 @@ public: friend class Arr_polycurve_basic_traits_2; - /*! Constructor. */ + /*! constructs. */ Trim_2(const Polycurve_basic_traits_2& traits) : m_poly_traits(traits) {} public: - /*! \brief returns a trimmed version of the polycurve with `source` and + /*! returns a trimmed version of the polycurve with `source` and * `target` as end points. */ X_monotone_curve_2 operator()(const X_monotone_curve_2& xcv, @@ -2339,7 +2339,7 @@ public: } }; - /*! Obtain a Trim_2 functor object. */ + /*! obtains a Trim_2 functor object. */ Trim_2 trim_2_object() const { return Trim_2(*this); } ///@} @@ -2349,7 +2349,7 @@ protected: * Roadmap: locate() should return an iterator to the located subcurve */ - /*! Obtain the index of the subcurve in the polycurve that contains a point + /*! obtains the index of the subcurve in the polycurve that contains a point * \f$q\f$ in its \f$x\f$-range. The function performs a binary search, so if * the point \f$q\f$ is in the \f$x\f$-range of the polycurve with \f$n\f$ * subcurves, the subcurve containing it can be located in \cgalBigO{log n} @@ -2491,7 +2491,7 @@ protected: { return m_compare(xs, ce, m_x_monotone_subcurve, m_curve_end); } }; - /*! Locate the index of a curve in a polycurve that contains an endpoint + /*! locates the index of a curve in a polycurve that contains an endpoint * of a curve. * This implementation is used in the case where at least one side of the * parameter space is not oblivious. @@ -2521,7 +2521,7 @@ protected: return locate_gen(xcv, compare); } - /*! Locate the index of a curve in a polycurve that contains an endpoint + /*! locates the index of a curve in a polycurve that contains an endpoint * of a curve. * This implementation is used in the case where all sides of the parameter * space is oblivious. @@ -2540,7 +2540,7 @@ protected: return locate(xcv, p); } - /*! Locate the index of a curve in a polycurve that contains a point. + /*! locates the index of a curve in a polycurve that contains a point. * This implementation is used in the case where at least one side of the * parameter space is not oblivious. * \param(in) xcv the given polycurve. @@ -2567,7 +2567,7 @@ protected: return locate_gen(xcv, compare); } - /*! Locate the index of a curve in a polycurve that contains a point. + /*! locates the index of a curve in a polycurve that contains a point. * This implementation is used in the case where all sides of the parameter * space are oblivious. * \param(in) xcv the given polycurve. @@ -2599,7 +2599,7 @@ protected: return locate_gen(xcv, compare); } - /*! Find the index of the subcurve in the polycurve that is defined to the + /*! finds the index of the subcurve in the polycurve that is defined to the * left (or to the right) of the point `q`. * \param cv the polycurve curve. * \param q the point. diff --git a/Arrangement_on_surface_2/include/CGAL/Arr_segment_traits_2.h b/Arrangement_on_surface_2/include/CGAL/Arr_segment_traits_2.h index 287c4ea0967..0e2d4819b1b 100644 --- a/Arrangement_on_surface_2/include/CGAL/Arr_segment_traits_2.h +++ b/Arrangement_on_surface_2/include/CGAL/Arr_segment_traits_2.h @@ -96,23 +96,23 @@ public: /// \name Creation //@{ - /*! Construct default. */ + /*! constructs default. */ _Segment_cached_2(); - /*! Construct a segment from a Kernel segment. + /*! constructs a segment from a Kernel segment. * \param seg the segment. * \pre the segment is not degenerate. */ _Segment_cached_2(const Segment_2& seg); - /*! Construct a segment from two endpoints. + /*! constructs a segment from two endpoints. * \param source the source point. * \param target the target point. * \param `source` and `target` are not equal. */ _Segment_cached_2(const Point_2& source, const Point_2& target); - /*! Construct a segment from two endpoints on a supporting line. + /*! constructs a segment from two endpoints on a supporting line. * \param line the supporting line. * \param source the source point. * \param target the target point. @@ -121,7 +121,7 @@ public: _Segment_cached_2(const Line_2& line, const Point_2& source, const Point_2& target); - /*! Construct a segment from all fields. + /*! constructs a segment from all fields. * \param line the supporting line. * \param source the source point. * \param target the target point. @@ -133,7 +133,7 @@ public: const Point_2& source, const Point_2& target, bool is_directed_right, bool is_vert, bool is_degen); - /*! Assign. + /*! assigns. * \param seg the source segment to copy from * \pre the segment is not degenerate. */ @@ -144,44 +144,44 @@ public: /// \name Accessors //@{ - /*! Obtain the supporting line. + /*! obtains the supporting line. * \return the supporting line. */ const Line_2& line() const; - /*! Obtain the segment source. + /*! obtains the segment source. * \return the segment source. */ const Point_2& source() const; - /*! Obtain the segment target. + /*! obtains the segment target. * \return the segment target. */ const Point_2& target() const; - /*! Determine whether the curve is vertical. + /*! determines whether the curve is vertical. * \return a Boolean flag indicating whether the curve is vertical. */ bool is_vertical() const; - /*! Determine whether the curve is degenerate. + /*! determines whether the curve is degenerate. * return a Boolean flag indicating whether the curve is degenerate. */ bool is_degenerate() const; - /*! Determine whether the curve is lexicographically directed from left to + /*! determines whether the curve is lexicographically directed from left to * right. * \return a Boolean flag indicating whether the curve is lexicographically * directed from left to right. */ bool is_directed_right() const; - /*! Obtain the (lexicographically) left endpoint. + /*! obtains the (lexicographically) left endpoint. * \return the (lexicographically) left endpoint. */ const Point_2& left() const; - /*! Obtain the (lexicographically) right endpoint. + /*! obtains the (lexicographically) right endpoint. * \return the (lexicographically) right endpoint. */ const Point_2& right() const; @@ -191,13 +191,13 @@ public: /// \name Modifiers //@{ - /*! Set the (lexicographically) left endpoint. + /*! sets the (lexicographically) left endpoint. * \param p the point to set. * \pre p lies on the supporting line to the left of the right endpoint. */ void set_left(const Point_2& p); - /*! Set the (lexicographically) right endpoint. + /*! sets the (lexicographically) right endpoint. * \param p the point to set. * \pre p lies on the supporting line to the right of the left endpoint. */ @@ -208,14 +208,15 @@ public: /// \name Deprecated //@{ - /*! Determine whether the given point is in the \f$x\f$-range of the segment. + /*! determine whether the given point is in the \f$x\f$-range of the segment. * \param p the query point. * \return (true) is in the \f$x\f$-range of the segment; (false) if it is * not. */ CGAL_DEPRECATED bool is_in_x_range(const Point_2& p) const; - /*! Determine whether the given point is in the \f$y\f$-range of the segment. + /*! determines whether the given point is in the \f$y\f$-range of the + * segment. * \param p the query point. * \return (true) is in the \f$y\f$-range of the segment; (false) if it is * not. @@ -233,7 +234,7 @@ public: typedef unsigned int Multiplicity; public: - /*! Construct default. */ + /*! constructs default. */ Arr_segment_traits_2() {} /// \name Basic functor definitions. @@ -246,7 +247,7 @@ public: //! The traits (in case it has state). const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_x_2(const Traits& traits) : m_traits(traits) {} @@ -254,7 +255,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Compare the \f$x\f$-coordinates of two points. + /*! compares the \f$x\f$-coordinates of two points. * \param p1 the first point. * \param p2 the second point. * \return `LARGER` if x(p1) > x(p2); @@ -268,7 +269,7 @@ public: } }; - /*! Obtain a `Compare_x_2` functor object. */ + /*! obtains a `Compare_x_2` functor object. */ Compare_x_2 compare_x_2_object() const { return Compare_x_2(*this); } class Compare_xy_2 { @@ -278,7 +279,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_xy_2(const Traits& traits) : m_traits(traits) {} @@ -286,7 +287,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Compare two points lexicographically: by x, then by y. + /*! compares two points lexicographically: by x, then by y. * \param p1 the first point. * \param p2 the second point. * \return LARGER if x(p1) > x(p2), or if x(p1) = x(p2) and y(p1) > y(p2); @@ -300,12 +301,12 @@ public: } }; - /*! Obtain a `Compare_xy_2` functor object. */ + /*! obtains a `Compare_xy_2` functor object. */ Compare_xy_2 compare_xy_2_object() const { return Compare_xy_2(*this); } class Construct_min_vertex_2 { public: - /*! Obtain the left endpoint of the \f$x\f$-monotone curve (segment). + /*! obtains the left endpoint of the \f$x\f$-monotone curve (segment). * \param cv the curve. * \return the left endpoint. */ @@ -313,13 +314,13 @@ public: { return (cv.left()); } }; - /*! Obtain a `Construct_min_vertex_2` functor object. */ + /*! obtains a `Construct_min_vertex_2` functor object. */ Construct_min_vertex_2 construct_min_vertex_2_object() const { return Construct_min_vertex_2(); } class Construct_max_vertex_2 { public: - /*! Obtain the right endpoint of the \f$x\f$-monotone curve (segment). + /*! obtains the right endpoint of the \f$x\f$-monotone curve (segment). * \param cv the curve. * \return the right endpoint. */ @@ -327,13 +328,13 @@ public: { return (cv.right()); } }; - /*! Obtain a `Construct_max_vertex_2` functor object. */ + /*! obtains a `Construct_max_vertex_2` functor object. */ Construct_max_vertex_2 construct_max_vertex_2_object() const { return Construct_max_vertex_2(); } class Is_vertical_2 { public: - /*! Check whether the given \f$x\f$-monotone curve is a vertical segment. + /*! checks whether the given \f$x\f$-monotone curve is a vertical segment. * \param cv the curve. * \return (true) if the curve is a vertical segment; (false) otherwise. */ @@ -341,17 +342,17 @@ public: { return (cv.is_vertical()); } }; - /*! Obtain an `Is_vertical_2` functor object. */ + /*! obtains an `Is_vertical_2` functor object. */ Is_vertical_2 is_vertical_2_object () const { return Is_vertical_2(); } class Compare_y_at_x_2 { protected: typedef Arr_segment_traits_2 Traits; - /*! the traits (in case it has state) */ + /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_at_x_2(const Traits& traits) : m_traits(traits) {} @@ -359,7 +360,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Return the location of the given point with respect to the input curve. + /*! returns the location of the given point with respect to the input curve. * \param cv the curve. * \param p the point. * \pre `p` is in the \f$x\f$-range of `cv`. @@ -389,7 +390,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_2` functor object. */ + /*! obtains a `Compare_y_at_x_2` functor object. */ Compare_y_at_x_2 compare_y_at_x_2_object() const { return Compare_y_at_x_2(*this); } @@ -400,7 +401,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_at_x_left_2(const Traits& traits) : m_traits(traits) {} @@ -408,7 +409,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Compare the \f$y\f$-value of two \f$x\f$-monotone curves immediately to + /*! compares the \f$y\f$-value of two \f$x\f$-monotone curves immediately to * the left of their intersection point. * \param cv1 the first curve. * \param cv2 the second curve. @@ -443,7 +444,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_left_2` functor object. */ + /*! obtains a `Compare_y_at_x_left_2` functor object. */ Compare_y_at_x_left_2 compare_y_at_x_left_2_object() const { return Compare_y_at_x_left_2(*this); } @@ -454,7 +455,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Compare_y_at_x_right_2(const Traits& traits) : m_traits(traits) {} @@ -462,7 +463,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Compare the \f$y\f$-value of two \f$x\f$-monotone curves immediately to + /*! compares the \f$y\f$-value of two \f$x\f$-monotone curves immediately to * the right of their intersection point. * \param cv1 the first curve. * \param cv2 the second curve. @@ -495,7 +496,7 @@ public: } }; - /*! Obtain a `Compare_y_at_x_right_2` functor object. */ + /*! obtains a `Compare_y_at_x_right_2` functor object. */ Compare_y_at_x_right_2 compare_y_at_x_right_2_object() const { return Compare_y_at_x_right_2(*this); } @@ -506,7 +507,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Equal_2(const Traits& traits) : m_traits(traits) {} @@ -514,7 +515,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Check whether the two \f$x\f$-monotone curves are the same (have the + /*! checks whether the two \f$x\f$-monotone curves are the same (have the * same graph). * \param cv1 the first curve. * \param cv2 the second curve. @@ -530,7 +531,7 @@ public: equal(cv1.right(), cv2.right())); } - /*! Determine whether the two points are the same. + /*! determines whether the two points are the same. * \param p1 the first point. * \param p2 the second point. * \return (true) if the two point are the same; (false) otherwise. @@ -542,7 +543,7 @@ public: } }; - /*! Obtain an `Equal_2` functor object. */ + /*! obtains an `Equal_2` functor object. */ Equal_2 equal_2_object() const { return Equal_2(*this); } //@} @@ -555,7 +556,7 @@ public: */ class Make_x_monotone_2 { public: - /*! Subdivide a given curve into \f$x\f$-monotone subcurves and insert them + /*! subdivides a given curve into \f$x\f$-monotone subcurves and insert them * into a given output iterator. As segments are always \f$x\f$_monotone a * single object is inserted. * \param cv the curve. @@ -575,7 +576,7 @@ public: } }; - /*! Obtain a `Make_x_monotone_2` functor object. */ + /*! obtains a `Make_x_monotone_2` functor object. */ Make_x_monotone_2 make_x_monotone_2_object() const { return Make_x_monotone_2(); } @@ -586,7 +587,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Split_2(const Traits& traits) : m_traits(traits) {} @@ -594,7 +595,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Split a given \f$x\f$-monotone curve at a given point into two + /*! split a given \f$x\f$-monotone curve at a given point into two * sub-curves. * \param cv the curve to split * \param p the split point. @@ -622,7 +623,7 @@ public: } }; - /*! Obtain a `Split_2` functor object. */ + /*! obtains a `Split_2` functor object. */ Split_2 split_2_object() const { return Split_2(*this); } class Intersect_2 { @@ -632,7 +633,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Construct + /*! constructs * \param traits the traits (in case it has state) */ Intersect_2(const Traits& traits) : m_traits(traits) {} @@ -682,7 +683,7 @@ public: return false; } - /*! Determine whether the bounding boxes of two segments overlap + /*! determines whether the bounding boxes of two segments overlap */ bool do_bboxes_overlap(const X_monotone_curve_2& cv1, const X_monotone_curve_2& cv2) const @@ -695,7 +696,7 @@ public: } public: - /*! Find the intersections of the two given curves and insert them into the + /*! finds the intersections of the two given curves and insert them into the * given output iterator. As two segments may intersect only once, only a * single intersection will be contained in the iterator. * \param cv1 the first curve. @@ -781,7 +782,7 @@ public: } }; - /*! Obtain an `Intersect_2` functor object. */ + /*! obtains an `Intersect_2` functor object. */ Intersect_2 intersect_2_object() const { return Intersect_2(*this); } class Are_mergeable_2 { @@ -791,7 +792,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Are_mergeable_2(const Traits& traits) : m_traits(traits) {} @@ -799,7 +800,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Check whether it is possible to merge two given \f$x\f$-monotone curves. + /*! checks whether it is possible to merge two given \f$x\f$-monotone curves. * \param cv1 the first curve. * \param cv2 the second curve. * \return (true) if the two curves are mergeable, that is, if they are @@ -822,7 +823,7 @@ public: } }; - /*! Obtain an `Are_mergeable_2` functor object. */ + /*! obtains an `Are_mergeable_2` functor object. */ Are_mergeable_2 are_mergeable_2_object() const { return Are_mergeable_2(*this); } @@ -836,7 +837,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Merge_2(const Traits& traits) : m_traits(traits) {} @@ -844,7 +845,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Merge two given \f$x\f$-monotone curves into a single curve (segment). + /*! merges two given \f$x\f$-monotone curves into a single curve (segment). * \param cv1 the first curve. * \param cv2 the second curve. * \param c Output: the merged curve. @@ -875,7 +876,7 @@ public: } }; - /*! Obtain a `Merge_2` functor object. */ + /*! obtains a `Merge_2` functor object. */ Merge_2 merge_2_object() const { return Merge_2(*this); } //@} @@ -892,7 +893,7 @@ public: /*! The traits (in case it has state) */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits. */ Approximate_2(const Traits& traits) : m_traits(traits) {} @@ -900,7 +901,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Obtain an approximation of a point coordinate. + /*! obtains an approximation of a point coordinate. * \param p the exact point. * \param i the coordinate index (either 0 or 1). * \pre `i` is either 0 or 1. @@ -912,12 +913,12 @@ public: return (i == 0) ? (CGAL::to_double(p.x())) : (CGAL::to_double(p.y())); } - /*! Obtain an approximation of a point. + /*! obtains an approximation of a point. */ Approximate_point_2 operator()(const Point_2& p) const { return Approximate_point_2(operator()(p, 0), operator()(p, 1)); } - /*! Obtain an approximation of an \f$x\f$-monotone curve. + /*! obtains an approximation of an \f$x\f$-monotone curve. */ template OutputIterator operator()(const X_monotone_curve_2& xcv, double /* error */, @@ -936,7 +937,7 @@ public: } }; - /*! Obtain an `Approximate_2` functor object. */ + /*! obtains an `Approximate_2` functor object. */ Approximate_2 approximate_2_object() const { return Approximate_2(*this); } //! Functor @@ -947,7 +948,7 @@ public: //! The traits (in case it has state). const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Construct_x_monotone_curve_2(const Traits& traits) : m_traits(traits) {} @@ -957,7 +958,7 @@ public: public: typedef typename Kernel::Segment_2 Segment_2; - /*! Obtain an \f$x\f$-monotone curve connecting two given endpoints. + /*! obtains an \f$x\f$-monotone curve connecting two given endpoints. * \param source the first point. * \param target the second point. * \pre `source` and `target` must not be equal. @@ -978,7 +979,7 @@ public: is_directed_right, is_vert, is_degen); } - /*! Obtain an \f$x\f$-monotone curve given a Kernel segment. + /*! obtains an \f$x\f$-monotone curve given a Kernel segment. * \param seg the segment. * \return the \f$x\f$-monotone curve. * \pre the segment is not degenerate. @@ -1001,7 +1002,7 @@ public: is_directed_right, is_vert, is_degen); } - /*! Obtain an \f$x\f$-monotone curve given two endpoints and the supporting + /*! obtains an \f$x\f$-monotone curve given two endpoints and the supporting * line. * \param line the supporting line. * \param the source point. @@ -1029,7 +1030,7 @@ public: } }; - /*! Obtain a `Construct_x_monotone_curve_2` functor object. */ + /*! obtains a `Construct_x_monotone_curve_2` functor object. */ Construct_x_monotone_curve_2 construct_x_monotone_curve_2_object() const { return Construct_x_monotone_curve_2(*this); } //@} @@ -1040,7 +1041,7 @@ public: //! Functor typedef Construct_x_monotone_curve_2 Construct_curve_2; - /*! Obtain a `Construct_curve_2` functor object. */ + /*! obtains a `Construct_curve_2` functor object. */ Construct_curve_2 construct_curve_2_object() const { return Construct_x_monotone_curve_2(*this); } //@} @@ -1055,14 +1056,14 @@ public: /*! The traits (in case it has state). */ const Traits& m_traits; - /*! Constructor + /*! constructs * \param traits the traits (in case it has state) */ Trim_2(const Traits& traits) : m_traits(traits) {} friend class Arr_segment_traits_2; - /*! Obtain a trimmed version of a line. + /*! obtains a trimmed version of a line. * \param xseg the \f$x\f$-monotone segment. * \param src the new start endpoint. * \param tgt the new end endpoint. @@ -1097,12 +1098,12 @@ public: } }; - /*! Obtain a `Trim_2` functor object */ + /*! obtains a `Trim_2` functor object */ Trim_2 trim_2_object() const { return Trim_2(*this); } class Compare_endpoints_xy_2 { public: - /*! Compare the endpoints of an $x$-monotone curve lexicographically. + /*! compares the endpoints of an $x$-monotone curve lexicographically. * (assuming the curve has a designated source and target points). * \param cv the curve. * \return SMALLER if the curve is directed right; @@ -1112,7 +1113,7 @@ public: { return (cv.is_directed_right()) ? (SMALLER) : (LARGER); } }; - /*! Obtain a `Compare_endpoints_xy_2` functor object. */ + /*! obtains a `Compare_endpoints_xy_2` functor object. */ Compare_endpoints_xy_2 compare_endpoints_xy_2_object() const { return Compare_endpoints_xy_2(); } @@ -1126,7 +1127,7 @@ public: { return (cv.flip()); } }; - /*! Obtain a `Construct_opposite_2` functor object. */ + /*! obtains a `Construct_opposite_2` functor object. */ Construct_opposite_2 construct_opposite_2_object() const { return Construct_opposite_2(); } //@} @@ -1149,7 +1150,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Determine whether a given point is in the \f$x\f$-range of a given + /*! determines whether a given point is in the \f$x\f$-range of a given * segment. * \param cv the segment. * \param p the point. @@ -1169,7 +1170,7 @@ public: } }; - /*! Obtain an `Is_in_x_range_2` functor object */ + /*! obtains an `Is_in_x_range_2` functor object */ Is_in_x_range_2 is_in_x_range_2_object() const { return Is_in_x_range_2(*this); } @@ -1188,7 +1189,7 @@ public: friend class Arr_segment_traits_2; public: - /*! Determine whether a given point is in the \f$y\f$-range of a given + /*! determines whether a given point is in the \f$y\f$-range of a given * segment. * \param cv the segment. * \param p the point. @@ -1208,7 +1209,7 @@ public: } }; - /*! Obtain an `Is_in_y_range_2` functor object */ + /*! obtains an `Is_in_y_range_2` functor object */ Is_in_y_range_2 is_in_y_range_2_object() const { return Is_in_y_range_2(*this); } @@ -1370,7 +1371,7 @@ template bool Arr_segment_traits_2::_Segment_cached_2::is_directed_right() const { return m_is_directed_right; } -//! \brief obtain the segment source. +//! \brief obtains the segment source. template const typename Kernel::Point_2& Arr_segment_traits_2::_Segment_cached_2::source() const { return m_ps; }