mirror of https://github.com/CGAL/cgal
cosmetic: names of arguments changed to avoid spurious links
This commit is contained in:
parent
8feb0edb88
commit
158a455f10
|
|
@ -16,22 +16,22 @@ circle can be degenerate, i.e.\ the squared radius may be zero.
|
||||||
\ccClassTemplateName.}
|
\ccClassTemplateName.}
|
||||||
|
|
||||||
\ccConstructor{Circle_3(Point_3<Kernel> const& center,
|
\ccConstructor{Circle_3(Point_3<Kernel> const& center,
|
||||||
Kernel::FT const& squared_radius,
|
Kernel::FT const& sq_r,
|
||||||
Plane_3<Kernel> const& plane);}
|
Plane_3<Kernel> const& plane);}
|
||||||
{introduces a variable \ccVar\ of type \ccClassTemplateName.
|
{introduces a variable \ccVar\ of type \ccClassTemplateName.
|
||||||
It is initialized to the circle of center \ccc{center} and
|
It is initialized to the circle of center \ccc{center} and
|
||||||
squared radius \ccc{squared_radius} in plane \ccc{plane}.
|
squared radius \ccc{sq_r} in plane \ccc{plane}.
|
||||||
\ccPrecond{\ccc{center} lies in \ccc{plane} and
|
\ccPrecond{\ccc{center} lies in \ccc{plane} and
|
||||||
\ccc{squared_radius} $\geq$ 0.}}
|
\ccc{sq_r} $\geq$ 0.}}
|
||||||
|
|
||||||
\ccConstructor{Circle_3(Point_3<Kernel> const& center,
|
\ccConstructor{Circle_3(Point_3<Kernel> const& center,
|
||||||
Kernel::FT const& squared_radius,
|
Kernel::FT const& sq_r,
|
||||||
Vector_3<Kernel> const& normal);}
|
Vector_3<Kernel> const& n);}
|
||||||
{introduces a variable \ccVar\ of type \ccClassTemplateName.
|
{introduces a variable \ccVar\ of type \ccClassTemplateName.
|
||||||
It is initialized to the circle of center \ccc{center} and
|
It is initialized to the circle of center \ccc{center} and
|
||||||
squared radius \ccc{squared_radius} in a plane normal to
|
squared radius \ccc{sq_r} in a plane normal to
|
||||||
the vector \ccc{normal}.
|
the vector \ccc{n}.
|
||||||
\ccPrecond{\ccc{squared_radius} $\geq$ 0.}}
|
\ccPrecond{\ccc{sq_r} $\geq$ 0.}}
|
||||||
|
|
||||||
\ccConstructor{Circle_3(Sphere_3<Kernel> const& sphere1,
|
\ccConstructor{Circle_3(Sphere_3<Kernel> const& sphere1,
|
||||||
Sphere_3<Kernel> const& sphere2);}
|
Sphere_3<Kernel> const& sphere2);}
|
||||||
|
|
|
||||||
|
|
@ -11,23 +11,23 @@ A model for this must provide:
|
||||||
|
|
||||||
\ccMemberFunction{Kernel::Circle_3 operator()
|
\ccMemberFunction{Kernel::Circle_3 operator()
|
||||||
( Kernel::Point_3 const& center,
|
( Kernel::Point_3 const& center,
|
||||||
Kernel::FT const& squared_radius,
|
Kernel::FT const& sq_r,
|
||||||
Kernel::Plane_3 const& plane);}
|
Kernel::Plane_3 const& plane);}
|
||||||
{introduces a variable of type \ccc{Kernel::Circle_3}.
|
{introduces a variable of type \ccc{Kernel::Circle_3}.
|
||||||
It is initialized to the circle with center \ccc{center},
|
It is initialized to the circle with center \ccc{center},
|
||||||
and squared radius \ccc{squared_radius} in the plane \ccc{plane}.
|
and squared radius \ccc{sq_r} in the plane \ccc{plane}.
|
||||||
\ccPrecond{\ccc{center} lies in \ccc{plane} and
|
\ccPrecond{\ccc{center} lies in \ccc{plane} and
|
||||||
\ccc{squared_radius} $\geq$ 0.}}
|
\ccc{sq_r} $\geq$ 0.}}
|
||||||
|
|
||||||
\ccMemberFunction{Kernel::Circle_3 operator()
|
\ccMemberFunction{Kernel::Circle_3 operator()
|
||||||
( Kernel::Point_3 const& center,
|
( Kernel::Point_3 const& center,
|
||||||
Kernel::FT const& squared_radius,
|
Kernel::FT const& sq_r,
|
||||||
Kernel::Vector_3 const& normal);}
|
Kernel::Vector_3 const& n);}
|
||||||
{introduces a variable of type \ccc{Kernel::Circle_3}.
|
{introduces a variable of type \ccc{Kernel::Circle_3}.
|
||||||
It is initialized to the circle with center \ccc{center},
|
It is initialized to the circle with center \ccc{center},
|
||||||
and squared radius \ccc{squared_radius} in the plane
|
and squared radius \ccc{sq_r} in the plane
|
||||||
containing \ccc{center} and normal to \ccc{normal}.
|
containing \ccc{center} and normal to \ccc{n}.
|
||||||
\ccPrecond{\ccc{squared_radius} $\geq$ 0.}}
|
\ccPrecond{\ccc{sq_r} $\geq$ 0.}}
|
||||||
|
|
||||||
|
|
||||||
\ccMemberFunction{Kernel::Circle_3 operator()
|
\ccMemberFunction{Kernel::Circle_3 operator()
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue