workaround for a doxygen bug: remove space after /!* to avoid a verbatim env

this happens if you have an empty line or the text directly after /!*
to find them in the generated documentation, grep for "pre class=\"fragment\""
(a few of them are legitimate however)
This commit is contained in:
Sébastien Loriot
2013-07-25 14:58:53 +02:00
parent 67a73344f3
commit 2dfe8a3d73
928 changed files with 10797 additions and 10796 deletions
@@ -17,12 +17,12 @@ public:
/// \name Creation
/// @{
/*!
/*!
Constructs an arc from a full circle.
*/
Circular_arc_2(const Circle_2<CircularKernel> &c);
/*!
/*!
Constructs the circular arc supported by `c`, whose source is
`p` and whose target is `q` when traversing the circle in
counterclockwise direction.
@@ -32,7 +32,7 @@ Circular_arc_2(const Circle_2<CircularKernel> &c,
const Circular_arc_point_2<CircularKernel> &p,
const Circular_arc_point_2<CircularKernel> &q);
/*!
/*!
Constructs an arc that is supported by the circle of type
`Circle_2<CircularKernel>` passing through the points `p`,
`q` and `r`. The source and target are respectively `p`
@@ -51,18 +51,18 @@ const Point_2<CircularKernel> &r);
/// \name Access Functions
/// @{
/*!
/*!
*/
Circle_2<CircularKernel> supporting_circle();
/*!
/*!
returns the center of the supporting circle.
*/
Point_2<CircularKernel> const& center( ) const;
/*!
/*!
returns the squared radius of the supporting circle.
*/
@@ -74,12 +74,12 @@ CircularKernel::FT const& squared_radius( ) const;
/// A circular arc is not oriented. Still, its source and target endpoints can be defined, supposing that its supporting circle in traversed the counterclockwise direction from `source` to `target`.
/// @{
/*!
/*!
*/
Circular_arc_point_2<CircularKernel> source();
/*!
/*!
*/
Circular_arc_point_2<CircularKernel> target();
@@ -95,17 +95,17 @@ Circular_arc_point_2<CircularKernel> target();
/// @{
/*!
/*!
\pre `ca`.`is_x_monotone()`.
*/
Circular_arc_point_2<CircularKernel> left();
/*!
/*!
\pre `ca`.`is_x_monotone()`.
*/
Circular_arc_point_2<CircularKernel> right();
/*!
/*!
Returns a bounding box containing the arc.
*/
Bbox_2 bbox() const;
@@ -115,12 +115,12 @@ Bbox_2 bbox() const;
/// \name Query Functions
/// @{
/*!
/*!
Tests whether the arc is x-monotone.
*/
bool is_x_monotone();
/*!
/*!
Tests whether the arc is y-monotone.
*/
bool is_y_monotone();
@@ -129,7 +129,7 @@ bool is_y_monotone();
}; /* end Circular_arc_2 */
/*!
/*!
Test for equality. Two arcs are equal, iff their non-oriented
supporting circles are equal (i.e.\ they have same center and same
squared radius) and their endpoints are equal.
@@ -137,20 +137,20 @@ squared radius) and their endpoints are equal.
*/
bool operator==(const Circular_arc_2<CircularKernel> &ca1, const Circular_arc_2<CircularKernel> &ca2);
/*!
/*!
Test for non-equality
\relates Circular_arc_2
*/
bool operator!=(const Circular_arc_2<CircularKernel> &ca1, const Circular_arc_2<CircularKernel> &ca2);
/*!
/*!
\relates Circular_arc_2
*/
istream& operator>> (std::istream& is, Circular_arc_2 & ca);
/*!
/*!
\relates Circular_arc_2
*/
@@ -17,12 +17,12 @@ public:
/// \name Creation
/// @{
/*!
/*!
*/
Circular_arc_point_2(const CircularKernel::Point_2 &q);
/*!
/*!
*/
Circular_arc_point_2(const CircularKernel::Root_for_circles_2_2 &r);
@@ -32,17 +32,17 @@ Circular_arc_point_2(const CircularKernel::Root_for_circles_2_2 &r);
/// \name Access Functions
/// @{
/*!
/*!
`x`-coordinate of the point.
*/
const CircularKernel::Root_of_2 & x();
/*!
/*!
`y`-coordinate of the point.
*/
const CircularKernel::Root_of_2 & y();
/*!
/*!
Returns a bounding box around the point.
*/
Bbox_2 bbox() const;
@@ -52,52 +52,52 @@ Bbox_2 bbox() const;
}; /* end Circular_arc_point_2 */
/*!
/*!
Test for equality. Two points are equal, iff their `x` and `y` coordinates are equal.
\relates Circular_arc_point_2
*/
bool operator==(const Circular_arc_point_2<CircularKernel> &p, const Circular_arc_point_2<CircularKernel> &q);
/*!
/*!
Test for nonequality.
\relates Circular_arc_point_2
*/
bool operator!=(const Circular_arc_point_2<CircularKernel> &p, const Circular_arc_point_2<CircularKernel> &q);
/*!
/*!
Returns true iff `p` is lexicographically smaller than `q`, i.e.\ either if `p.x() < q.x()`
or if `p.x() == q.x()` and `p.y() < q.y()`.
\relates Circular_arc_point_2
*/
bool operator<(const Circular_arc_point_2<CircularKernel> &p, const Circular_arc_point_2<CircularKernel> &q);
/*!
/*!
Returns true iff `p` is lexicographically greater than `q`. \relates Circular_arc_point_2
*/
bool operator>(const Circular_arc_point_2<CircularKernel> &p,
const Circular_arc_point_2<CircularKernel> &q);
/*!
/*!
Returns true iff `p` is lexicographically smaller than or equal to `q`.
\relates Circular_arc_point_2
*/
bool operator<=(const Circular_arc_point_2<CircularKernel> &p,
const Circular_arc_point_2<CircularKernel> &q);
/*!
/*!
Returns true iff `p` is lexicographically greater than or equal to `q`.
\relates Circular_arc_point_2
*/
bool operator>=(const Circular_arc_point_2<CircularKernel> &p,
const Circular_arc_point_2<CircularKernel> &q);
/*!
/*!
\relates Circular_arc_point_2
*/
istream& operator>> (std::istream& is, Circular_arc_point_2 & cp);
/*!
/*!
\relates Circular_arc_point_2
*/
@@ -34,12 +34,12 @@ public:
/// well as `AlgebraicKernelForCircles::FT` and `Kernel::FT`.
/// @{
/*!
/*!
Ring number type.
*/
typedef AlgebraicKernelForCircles::RT RT;
/*!
/*!
Field number type.
*/
typedef AlgebraicKernelForCircles::FT FT;
@@ -51,17 +51,17 @@ typedef AlgebraicKernelForCircles::FT FT;
/// functionality on them described in the `CircularKernel` concept.
/// @{
/*!
/*!
*/
typedef Line_arc_2<Circular_kernel_2> Line_arc_2;
/*!
/*!
*/
typedef Circular_arc_2<Circular_kernel_2> Circular_arc_2;
/*!
/*!
*/
typedef Circular_arc_point_2<Circular_kernel_2> Circular_arc_point_2;
@@ -23,7 +23,7 @@ public:
/// \name Creation
/// @{
/*!
/*!
Construct the line segment supported by `l`, whose source
is `p1` and whose target is `p2`.
\pre `p1` and `p2` lie on `l`.
@@ -32,14 +32,14 @@ Line_arc_2(const Line_2<CircularKernel> &l,
const Circular_arc_point_2<CircularKernel> &p1,
const Circular_arc_point_2<CircularKernel> &p2);
/*!
/*!
Same.
*/
Line_arc_2(const Line_2<CircularKernel> &l,
const Point_2<CircularKernel> &p1,
const Point_2<CircularKernel> &p2);
/*!
/*!
*/
Line_arc_2(const Segment_2<CircularKernel> &s);
@@ -49,32 +49,32 @@ Line_arc_2(const Segment_2<CircularKernel> &s);
/// \name Access Functions
/// @{
/*!
/*!
*/
Line_2<CircularKernel> supporting_line();
/*!
/*!
*/
Circular_arc_point_2<CircularKernel> source();
/*!
/*!
*/
Circular_arc_point_2<CircularKernel> target();
/*!
/*!
*/
Circular_arc_point_2<CircularKernel> left();
/*!
/*!
*/
Circular_arc_point_2<CircularKernel> right();
/*!
/*!
Returns a bounding box containing the line segment.
*/
Bbox_2 bbox() const;
@@ -84,7 +84,7 @@ Bbox_2 bbox() const;
/// \name Query Functions
/// @{
/*!
/*!
*/
bool is_vertical();
@@ -94,7 +94,7 @@ bool is_vertical();
}; /* end Line_arc_2 */
/*!
/*!
Test for equality. Two arcs are equal, iff their non-oriented
supporting lines are equal (i.e.\ they contain the same set of
points) and their endpoints are equal.
@@ -102,19 +102,19 @@ points) and their endpoints are equal.
*/
bool operator==(const Line_arc_2<CircularKernel> &la1, const Line_arc_2<CircularKernel> &la2);
/*!
/*!
Test for non-equality.
\relates Line_arc_2
*/
bool operator!=(const Line_arc_2<CircularKernel> &la1, const Line_arc_2<CircularKernel> &la2);
/*!
/*!
\relates Line_arc_2
*/
istream& operator>> (std::istream& is, Line_arc_2 & ca);
/*!
/*!
\relates Line_arc_2
*/
@@ -16,7 +16,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Compares the `x` (first) variables of two `Root_for_circles_2_2`.
*/
template < class OutputIterator >
@@ -16,7 +16,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Compares two `Root_for_circles_2_2` lexicographically.
*/
template < class OutputIterator >
@@ -16,7 +16,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Compares the `y` (second) variables of two `Root_for_circles_2_2`.
*/
template < class OutputIterator >
@@ -15,7 +15,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Constructs polynomial `(x-a)^2 + (y-b)^2 - rsq`.
*/
AlgebraicKernelForCircles::PolynomialForCircles_2_2
@@ -16,7 +16,7 @@ public:
/// @{
/*!
/*!
Constructs polynomial `ax+by+c`.
*/
AlgebraicKernelForCircles::Polynomial_1_2
@@ -26,7 +26,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
*/
bool operator ==(AlgebraicKernelForCircles::const PolynomialForCircles_2_2 & p,
@@ -20,7 +20,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
*/
bool operator ==( const AlgebraicKernelForCircles::RootForCircles_2_2 & p,
@@ -12,7 +12,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Computes the sign of polynomial `p` evaluated at a root `r`.
*/
template < class OutputIterator >
@@ -20,7 +20,7 @@ CGAL::Sign
operator()(const AlgebraicKernelForCircles::Polynomial_1_2 & p,
const AlgebraicKernelForCircles::Root_for_circles_2_2 & r);
/*!
/*!
Same as previous.
*/
template < class OutputIterator >
@@ -12,7 +12,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Copies in the output iterator the common roots of `p1` and `p2`,
with their multiplicity, as objects of type
`std::pair< AlgebraicKernelForCircles::Root_for_circles_2_2, int>`.
@@ -23,7 +23,7 @@ operator()(const AlgebraicKernelForCircles::Polynomial_1_2 &p1,
const AlgebraicKernelForCircles::Polynomial_1_2 &p2,
OutputIterator res);
/*!
/*!
Same as previous.
*/
template < class OutputIterator >
@@ -32,7 +32,7 @@ operator()(const AlgebraicKernelForCircles::Polynomial_1_2 &p1,
const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p2,
OutputIterator res);
/*!
/*!
Same as previous.
*/
template < class OutputIterator >
@@ -41,7 +41,7 @@ operator()(const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p1,
const AlgebraicKernelForCircles::Polynomial_1_2 &p2,
OutputIterator res);
/*!
/*!
Same as previous.
*/
template < class OutputIterator >
@@ -14,7 +14,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Copies in the output iterator the `x`-critical points of polynomial
`p`, as objects of type `AlgebraicKernelForCircles::Root_for_circles_2_2`.
*/
@@ -23,7 +23,7 @@ OutputIterator
operator()(const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p,
OutputIterator res);
/*!
/*!
Computes the `x`-critical point with smallest (resp.\ largest) `x`
of polynomial `p` if `b` is `true` (resp.\ `false`).
*/
@@ -14,7 +14,7 @@ public:
/// A model `fo` of this type must provide:
/// @{
/*!
/*!
Copies in the output iterator the `y`-critical points of polynomial
`p`, as objects of type `AlgebraicKernelForCircles::Root_for_circles_2_2`.
*/
@@ -23,7 +23,7 @@ OutputIterator
operator()(const AlgebraicKernelForCircles::Polynomial_for_circles_2_2 &p,
OutputIterator res);
/*!
/*!
Computes the `y`-critical point with smallest (resp.\ largest) `y`
of polynomial `p` if `b` is `true` (resp.\ `false`).
*/
@@ -21,38 +21,38 @@ public:
/// A model of `AlgebraicKernelForCircles` is supposed to provide
/// @{
/*!
/*!
A model of `RingNumberType`.
*/
typedef unspecified_type RT;
/*!
/*!
A model of `FieldNumberType``<RT>`.
*/
typedef unspecified_type FT;
/*!
/*!
A model of
`AlgebraicKernelForCircles::Polynomial_1_2`, for bivariate polynomials of degree up
to 1.
*/
typedef unspecified_type Polynomial_1_2;
/*!
/*!
A model of
`AlgebraicKernelForCircles::PolynomialForCircles_2_2`, for bivariate polynomials
of degree up to 2 that can store equations of circles.
*/
typedef unspecified_type Polynomial_for_circles_2_2;
/*!
/*!
A model of
`RootOf_2`, for algebraic numbers
of degree up to 2.
*/
typedef unspecified_type Root_of_2;
/*!
/*!
A model of
`AlgebraicKernelForCircles::RootForCircles_2_2`, for
solutions of systems of two models of
@@ -60,54 +60,54 @@ solutions of systems of two models of
*/
typedef unspecified_type Root_for_circles_2_2;
/*!
/*!
A model of
`AlgebraicKernelForCircles::ConstructPolynomial_1_2`.
*/
typedef unspecified_type Construct_polynomial_1_2;
/*!
/*!
A model of
`AlgebraicKernelForCircles::ConstructPolynomialForCircles_2_2`.
*/
typedef unspecified_type Construct_polynomial_for_circles_2_2;
/*!
/*!
A model of the concept
`AlgebraicKernelForCircles::CompareX`.
*/
typedef unspecified_type Compare_x;
/*!
/*!
A model of the concept
`AlgebraicKernelForCircles::CompareY`.
*/
typedef unspecified_type Compare_y;
/*!
/*!
A model of the concept
`AlgebraicKernelForCircles::CompareXY`.
*/
typedef unspecified_type Compare_xy;
/*!
/*!
A model of the concept `AlgebraicKernelForCircles::SignAt`.
*/
typedef unspecified_type Sign_at;
/*!
/*!
A model of the concept
`AlgebraicKernelForCircles::XCriticalPoints`.
*/
typedef unspecified_type X_critical_points;
/*!
/*!
A model of the concept
`AlgebraicKernelForCircles::YCriticalPoints`.
*/
typedef unspecified_type Y_critical_points;
/*!
/*!
A model of the concept `AlgebraicKernelForCircles::Solve`.
*/
typedef unspecified_type Solve;
@@ -17,7 +17,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
*/
Bounded_side
@@ -18,7 +18,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Compares \f$ p\f$ and \f$ q\f$ according to the lexicographic ordering on \f$ x\f$- and \f$ y\f$-coordinates.
*/
Comparison_result operator()
@@ -18,7 +18,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Compares the `x`-coordinates of `p` and `q`.
*/
Comparison_result operator()
@@ -18,7 +18,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Compares the \f$ y\f$-coordinates of \f$ p\f$ and \f$ q\f$.
*/
Comparison_result operator()
@@ -14,7 +14,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
For a circular arc.
\pre The arc `a` must be monotone and `p` must be in the vertical range of `a`.
*/
@@ -22,7 +22,7 @@ Comparison_result operator()
(const CircularKernel::Circular_arc_point_2 &p,
const CircularKernel::Circular_arc_2 &a);
/*!
/*!
Same for a segment.
*/
Comparison_result operator()
@@ -15,7 +15,7 @@ public:
/// @{
/*!
/*!
For two circular arcs.
\pre `p` must be a common point to `a1` and `a2`, and `a1` and `a2` must be defined to the right of `p`.
*/
@@ -24,7 +24,7 @@ Comparison_result operator()
const Circular_kernel_2::Circular_arc_2 &a2,
const Circular_kernel_2::Circular_arc_point_2 &p);
/*!
/*!
Same for two segments.
*/
Comparison_result operator()
@@ -32,7 +32,7 @@ Comparison_result operator()
const Circular_kernel_2::Line_arc_2 &a2,
const Circular_kernel_2::Circular_arc_point_2 &p);
/*!
/*!
For a segment and an arc.
*/
Comparison_result operator()
@@ -40,7 +40,7 @@ Comparison_result operator()
const Circular_kernel_2::Circular_arc_2 &a2,
const Circular_kernel_2::Circular_arc_point_2 &p);
/*!
/*!
Same as previous.
*/
Comparison_result operator()
@@ -12,7 +12,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Computes the `x`-coordinate of the point.
*/
CircularKernel::Root_of_2
@@ -12,7 +12,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Computes the `y`-coordinate of the point.
*/
CircularKernel::Root_of_2
@@ -17,19 +17,19 @@ public:
/// @{
/*!
/*!
*/
CGAL::Bbox_2 operator()
(const CircularKernel::Circular_arc_point_2 & p);
/*!
/*!
*/
CGAL::Bbox_2 operator()
(const CircularKernel::Line_arc_2 & l);
/*!
/*!
*/
CGAL::Bbox_2 operator()
@@ -16,13 +16,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Constructs the supporting circle of a circular arc.
*/
CircularKernel::Circle_2 operator()
(CircularKernel::CircularArc_2);
/*!
/*!
Constructs a circle from an equation.
*/
CircularKernel::Circle_2 operator()
@@ -12,13 +12,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
*/
CircularKernel::Circular_arc_point_2 operator()
(const CircularKernel::Root_for_circles_2_2 & r);
/*!
/*!
*/
CircularKernel::Circular_arc_point_2 operator()
@@ -12,13 +12,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Constructs an arc from a full circle.
*/
CircularKernel::Circular_arc_2 operator()
(const CircularKernel::Circle_2 &c);
/*!
/*!
Construct the circular arc supported by `c`, whose source is
`p1` and whose target is `p2` when traversing the circle in
counterclockwise direction.
@@ -29,7 +29,7 @@ CircularKernel::Circular_arc_2 operator()
const CircularKernel::Circular_arc_point_2 &p1,
const CircularKernel::Circular_arc_point_2 &p2);
/*!
/*!
Constructs the unique circular arc whose supporting circle is
`c`, and whose source is the intersection of `c`
and `c1` with index `b1`, and whose target is the intersection
@@ -43,7 +43,7 @@ CircularKernel::Circular_arc_2 operator()
const CircularKernel::Circle_2 &c1, bool b1,
const CircularKernel::Circle_2 &c2, bool b2);
/*!
/*!
Same, for intersections defined by lines instead of circles.
*/
CircularKernel::Circular_arc_2 operator()
@@ -51,7 +51,7 @@ CircularKernel::Circular_arc_2 operator()
const CircularKernel::Line_2 &l1, bool b1,
const CircularKernel::Line_2 &l2, bool b2);
/*!
/*!
Constructs an arc that is supported by the circle of type
`CircularKernel::Circle_2` passing through the points `p`,
`q` and `r`. The source and target are respectively `p`
@@ -12,14 +12,14 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Constructs the `x`-maximal vertex of `c`.
\pre The arc `c` is `x`-monotone.
*/
CircularKernel::Circular_arc_point_2 operator()
(const CircularKernel::Circular_arc_2 & c);
/*!
/*!
Same, for a line segment.
*/
CircularKernel::Circular_arc_point_2 operator()
@@ -12,14 +12,14 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Constructs the `x`-minimal vertex of `c`.
\pre The arc `c` is `x`-monotone.
*/
CircularKernel::Circular_arc_point_2 operator()
(const CircularKernel::Circular_arc_2 & c);
/*!
/*!
Same, for a line segment.
*/
CircularKernel::Circular_arc_point_2 operator()
@@ -13,13 +13,13 @@ public:
/// @{
/*!
/*!
Constructs the source vertex of `c`.
*/
CircularKernel::Circular_arc_point_2 operator()
(const CircularKernel::Circular_arc_2 & c);
/*!
/*!
Same, for a line segment.
*/
CircularKernel::Circular_arc_point_2 operator()
@@ -13,13 +13,13 @@ public:
/// @{
/*!
/*!
Constructs the target vertex of `c`.
*/
CircularKernel::Circular_arc_point_2 operator()
(const CircularKernel::Circular_arc_2 & c);
/*!
/*!
Same, for a line segment.
*/
CircularKernel::Circular_arc_point_2 operator()
@@ -12,7 +12,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Constructs the line segment supported by `l`, whose source
is `p1` and whose target is `p2`.
\pre `p1` and `p2` lie on `l`.
@@ -22,20 +22,20 @@ CircularKernel::Line_arc_2 operator()
const CircularKernel::Circular_arc_point_2 &p1,
const CircularKernel::Circular_arc_point_2 &p2);
/*!
/*!
*/
CircularKernel::Line_arc_2 operator()
(const CircularKernel::Segment_2 &s);
/*!
/*!
*/
CircularKernel::Line_arc_2 operator()
(const CircularKernel::Point_2 &p1,
const CircularKernel::Point_2 &p2);
/*!
/*!
Constructs the line segment whose supporting line is `l`, whose
source endpoint is the \f$ b_1^{th}\f$ intersection of `l` with `c1`,
and whose target endpoint is the \f$ b_2^{th}\f$ intersection of `l`
@@ -47,7 +47,7 @@ CircularKernel::Line_arc_2 operator()
const CircularKernel::Circle_2 &c1, bool b1,
const CircularKernel::Circle_2 &c2, bool b2);
/*!
/*!
Same, for intersections defined by lines instead of circles.
*/
CircularKernel::Line_arc_2 operator()
@@ -16,13 +16,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Constructs the supporting line of a line segment.
*/
CircularKernel::Line_2 operator()
(CircularKernel::LineArc_2);
/*!
/*!
Constructs a line from an equation.
*/
CircularKernel::Line_2 operator()
@@ -18,7 +18,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
determines if two geometric objects of type `Type1` and `Type2` intersect or not,
for all pairs `Type1` and `Type2`, where the types `Type1` and `Type2` can be any of the
following:
@@ -14,14 +14,14 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
For two line arcs.
*/
bool operator()
(const CircularKernel::Line_arc_2 & l0,
const CircularKernel::Line_arc_2 & l1);
/*!
/*!
For two circular arcs.
*/
bool operator()
@@ -20,21 +20,21 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
For two points.
*/
bool operator()
(const CircularKernel::Circular_arc_point_2 &p0,
const CircularKernel::Circular_arc_point_2 &p1);
/*!
/*!
For two arcs.
*/
bool operator()
(const CircularKernel::Circular_arc_2 &a0,
const CircularKernel::Circular_arc_2 &a1);
/*!
/*!
For two segments.
*/
bool operator()
@@ -15,13 +15,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Returns the equation of the line.
*/
CircularKernel::Polynomial_1_2
operator()(const CircularKernel::Line_2 & c);
/*!
/*!
Returns the equation of the circle.
*/
CircularKernel::Polynomial_for_circles_2_2
@@ -17,7 +17,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
*/
bool
@@ -17,7 +17,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
*/
bool
@@ -15,28 +15,28 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
For a line.
*/
bool operator()
(const CircularKernel::Line_2 & l,
const CircularKernel::Circular_arc_point_2 &p);
/*!
/*!
For a circle.
*/
bool operator()
(const CircularKernel::Circle_2 & c,
const CircularKernel::Circular_arc_point_2 &p);
/*!
/*!
For a line arc.
*/
bool operator()
(const CircularKernel::Line_arc_2 & l,
const CircularKernel::Circular_arc_point_2 &p);
/*!
/*!
For a circular arc.
*/
bool operator()
@@ -14,14 +14,14 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
For a line arc.
*/
bool operator()
(const CircularKernel::Line_arc_2 & l,
const CircularKernel::Circular_arc_point_2 & p);
/*!
/*!
For a circular arc. \pre `c` is `x`-monotone.
*/
bool operator()
@@ -16,7 +16,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Copies in the output iterator the intersection elements between the
two objects. `intersections` iterates on
elements of type `CGAL::Object`, in lexicographic order.
@@ -13,13 +13,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
For a line arc.
*/
bool operator()
(const CircularKernel::Line_arc_2 & l);
/*!
/*!
For a circular arc, always returns `false`.
*/
bool operator()
@@ -12,13 +12,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Tests whether the arc is `x`-monotone.
*/
bool operator()
(const CircularKernel::Circular_arc_2 & c);
/*!
/*!
For a line arc, always returns `true`.
*/
bool operator()
@@ -12,13 +12,13 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Tests whether the arc is `y`-monotone.
*/
bool operator()
(const CircularKernel::Circular_arc_2 & c);
/*!
/*!
For a line arc, always returns `true`.
*/
bool operator()
@@ -14,7 +14,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Splits the arc `ca` into `x`-monotone arcs that are returned through the
output iterator. Note that, to ensure an easy interface with the
`Arrangement_2` package, the arcs are returned as `CGAL::Object`'s
@@ -14,7 +14,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Splits the arc `ca` into `y`-monotone arcs that are returned through the
output iterator. Note that, to ensure an easy interface with the
`Arrangement_2` package, the arcs are returned as `CGAL::Object`'s
@@ -12,7 +12,7 @@ public:
/// A model of this concept must provide:
/// @{
/*!
/*!
Splits arc `a` at point `p`, which creates arcs `a1` and `a2`.
\pre The point lies on the input arc.
*/
@@ -22,7 +22,7 @@ const CircularKernel::Circular_arc_point_2 &p,
CircularKernel::Circular_arc_2 &a1,
CircularKernel::Circular_arc_2 &a2);
/*!
/*!
Same for a line arc.
*/
void operator()
@@ -22,72 +22,72 @@ public:
/// and other functionalities.
/// @{
/*!
/*!
Model of `LinearKernel`.
*/
typedef unspecified_type Linear_kernel;
/*!
/*!
Model of `AlgebraicKernelForCircles`.
*/
typedef unspecified_type Algebraic_kernel;
/*!
/*!
Model of `RingNumberType`.
*/
typedef unspecified_type RT;
/*!
/*!
Model of `FieldNumberType`.
*/
typedef unspecified_type FT;
/*!
/*!
Model of `RootOf_2`.
*/
typedef unspecified_type Root_of_2;
/*!
/*!
Model of `AlgebraicKernelForCircles::RootForCircles_2_2`.
*/
typedef unspecified_type Root_for_circles_2_2;
/*!
/*!
Model of `AlgebraicKernelForCircles::Polynomial_1_2`.
*/
typedef unspecified_type Polynomial_1_2;
/*!
/*!
Model of `AlgebraicKernelForCircles::PolynomialForCircles_2_2`.
*/
typedef unspecified_type Polynomial_for_circles_2_2;
/*!
/*!
Model of `Kernel::Point_2`.
*/
typedef unspecified_type Point_2;
/*!
/*!
Model of `Kernel::Line_2`.
*/
typedef unspecified_type Line_2;
/*!
/*!
Model of `Kernel::Circle_2`.
*/
typedef unspecified_type Circle_2;
/*!
/*!
Model of `CircularKernel::LineArc_2`.
*/
typedef unspecified_type Line_arc_2;
/*!
/*!
Model of `CircularKernel::CircularArc_2`.
*/
typedef unspecified_type Circular_arc_2;
/*!
/*!
Model of `CircularKernel::CircularArcPoint_2`.
*/
typedef unspecified_type Circular_arc_point_2;
@@ -97,82 +97,82 @@ typedef unspecified_type Circular_arc_point_2;
/// \name Predicates
/// @{
/*!
/*!
Model of `CircularKernel::CompareX_2`.
*/
typedef unspecified_type Compare_x_2;
/*!
/*!
Model of `CircularKernel::CompareY_2`.
*/
typedef unspecified_type Compare_y_2;
/*!
/*!
Model of `CircularKernel::CompareXY_2`.
*/
typedef unspecified_type Compare_xy_2;
/*!
/*!
Model of `CircularKernel::Equal_2`.
*/
typedef unspecified_type Equal_2;
/*!
/*!
Model of `CircularKernel::CompareYatX_2`.
*/
typedef unspecified_type Compare_y_at_x_2;
/*!
/*!
Model of `CircularKernel::CompareYtoRight_2`.
*/
typedef unspecified_type Compare_y_to_right_2;
/*!
/*!
Model of `CircularKernel::HasOn_2`.
*/
typedef unspecified_type Has_on_2;
/*!
/*!
Model of `CircularKernel::DoOverlap_2`.
*/
typedef unspecified_type Do_overlap_2;
/*!
/*!
Model of `CircularKernel::DoIntersect_2`.
*/
typedef unspecified_type Do_intersect_2;
/*!
/*!
Model of `CircularKernel::BoundedSide_2`.
*/
typedef unspecified_type Bounded_side_2;
/*!
/*!
Model of `CircularKernel::HasOnBoundedSide_2`.
*/
typedef unspecified_type Has_on_bounded_side_2;
/*!
/*!
Model of `CircularKernel::HasOnUnboundedSide_2`.
*/
typedef unspecified_type Has_on_unbounded_side_2;
/*!
/*!
Model of `CircularKernel::InXRange_2`.
*/
typedef unspecified_type In_x_range_2;
/*!
/*!
Model of `CircularKernel::IsVertical_2`.
*/
typedef unspecified_type Is_vertical_2;
/*!
/*!
Model of `CircularKernel::IsXMonotone_2`.
*/
typedef unspecified_type Is_x_monotone_2;
/*!
/*!
Model of `CircularKernel::IsYMonotone_2`.
*/
typedef unspecified_type Is_y_monotone_2;
@@ -182,12 +182,12 @@ typedef unspecified_type Is_y_monotone_2;
/// \name Constructions
/// @{
/*!
/*!
Model of `CircularKernel::ConstructLine_2`.
*/
typedef unspecified_type Construct_line_2;
/*!
/*!
Model of `CircularKernel::ConstructCircle_2`.
*/
typedef unspecified_type Construct_circle_2;
@@ -197,67 +197,67 @@ Model of `CircularKernel::ConstructBbox_2`.
*/
typedef unspecified_type Construct_bbox_2;
/*!
/*!
Model of `CircularKernel::ConstructCircularArcPoint_2`.
*/
typedef unspecified_type Construct_circular_arc_point_2;
/*!
/*!
Model of `CircularKernel::ConstructLineArc_2`.
*/
typedef unspecified_type Construct_line_arc_2;
/*!
/*!
Model of `CircularKernel::ConstructCircularArc_2`.
*/
typedef unspecified_type Construct_circular_arc_2;
/*!
/*!
Model of `CircularKernel::ComputeCircularX_2`
*/
typedef unspecified_type Compute_circular_x_2;
/*!
/*!
Model of `CircularKernel::ComputeCircularY_2`
*/
typedef unspecified_type Compute_circular_y_2;
/*!
/*!
Model of `CircularKernel::ConstructCircularMinVertex_2`.
*/
typedef unspecified_type Construct_circular_min_vertex_2;
/*!
/*!
Model of `CircularKernel::ConstructCircularMaxVertex_2`.
*/
typedef unspecified_type Construct_circular_max_vertex_2;
/*!
/*!
Model of `CircularKernel::ConstructCircularSourceVertex_2`.
*/
typedef unspecified_type Construct_circular_source_vertex_2;
/*!
/*!
Model of `CircularKernel::ConstructCircularTargetVertex_2`.
*/
typedef unspecified_type Construct_circular_target_vertex_2;
/*!
/*!
Model of `CircularKernel::Intersect_2`.
*/
typedef unspecified_type Intersect_2;
/*!
/*!
Model of `CircularKernel::Split_2`.
*/
typedef unspecified_type Split_2;
/*!
/*!
Model of `CircularKernel::MakeXMonotone_2`.
*/
typedef unspecified_type Make_x_monotone_2;
/*!
/*!
Model of `CircularKernel::MakeXYMonotone_2`.
*/
typedef unspecified_type Make_xy_monotone_2;
@@ -267,7 +267,7 @@ typedef unspecified_type Make_xy_monotone_2;
/// \name Link with the algebraic kernel
/// @{
/*!
/*!
Model of `CircularKernel::GetEquation`.
*/
typedef unspecified_type Get_equation;
@@ -284,7 +284,7 @@ typedef unspecified_type Get_equation;
/// following member function must exist:
/// @{
/*!
/*!
*/
Construct_circular_arc_2 construct_circular_arc_2_object() const;