Document new Iso_rectangle/Iso_cuboid constructor.

This commit is contained in:
Sylvain Pion 2006-08-03 09:40:42 +00:00
parent ea748e53d4
commit 38b7c42bd6
4 changed files with 32 additions and 0 deletions

View File

@ -29,6 +29,13 @@ the user.
opposite vertices $p$ and $q$. Note that the object is
brought in the canonical form.}
\ccConstructor{Iso_cuboid_3(const Point_3<Kernel> &p,
const Point_3<Kernel> &q, int);}
{introduces an iso-oriented cuboid \ccVar\ with diagonal
opposite vertices $p$ and $q$. The \ccc{int} argument value
is only used to distinguish the two overloaded functions.
\ccPrecond{$p.x()<=q.x()$, $p.y()<=q.y()$ and $p.z()<=q.z()$.}}
\ccConstructor{Iso_cuboid_3(const Point_3<Kernel> &left,
const Point_3<Kernel> &right,
const Point_3<Kernel> &bottom,

View File

@ -30,6 +30,15 @@ the user.
opposite vertices $p$ and $q$. Note that the object is
brought in the canonical form.}
\ccConstructor{Iso_rectangle_2(const Point_2<Kernel> &p,
const Point_2<Kernel> &q,
int);}
{introduces an iso-oriented rectangle \ccVar\ with diagonal
opposite vertices $p$ and $q$. The \ccc{int} argument value
is only used to distinguish the two overloaded functions.
\ccPrecond{$p.x()<=q.x()$ and $p.y()<=q.y()$.}}
\ccConstructor{Iso_rectangle_2(const Point_2<Kernel> &left,
const Point_2<Kernel> &right,
const Point_2<Kernel> &bottom,

View File

@ -9,6 +9,14 @@ A model for this must provide:
opposite vertices $p$ and $q$ such that $p$ is the
lexicographically smallest point in the cuboid.}
\ccMemberFunction{Kernel::Iso_cuboid_3 operator()(const Kernel::Point_3 &p,
const Kernel::Point_3 &q,
int);}
{introduces an iso-oriented cuboid with diagonal
opposite vertices $p$ and $q$. The \ccc{int} argument value is
only used to distinguish the two overloaded functions.
\ccPrecond{$p.x()<=q.x()$, $p.y()<=q.y()$ and $p.z()<=q.z()$.}}
\ccMemberFunction{Kernel::Iso_cuboid_3
operator()(const Kernel::Point_3 &left,
const Kernel::Point_3 &right,

View File

@ -9,6 +9,14 @@ A model for this must provide:
opposite vertices $p$ and $q$ such that $p$ is the
lexicographically smallest point in the rectangle.}
\ccMemberFunction{Kernel::Iso_rectangle_2 operator()(const Kernel::Point_2 &p,
const Kernel::Point_2 &q,
int);}
{introduces an iso-oriented rectangle with diagonal
opposite vertices $p$ and $q$. The \ccc{int} argument value is
only used to distinguish the two overloaded functions.
\ccPrecond{$p.x()<=q.x()$ and $p.y()<=q.y()$.}}
\ccMemberFunction{Kernel::Iso_rectangle_2
operator()(const Kernel::Point_2 &left,
const Kernel::Point_2 &right,