Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document exactness of constructions in Epick #7412

Merged
merged 7 commits into from
Nov 29, 2023
Merged

Document exactness of constructions in Epick #7412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
24451c0
Add doc which constructions are trivial/exact.
HoffmannMichael Apr 25, 2023
cfa16aa
Document which constructions are exact in EPIC.
HoffmannMichael Apr 27, 2023
003ce24
Added EPIC exact tag for the (two relevant) global functions.
HoffmannMichael Apr 27, 2023
4ad2561
remove trailing whitespace
HoffmannMichael Apr 27, 2023
721aafd
remove trailing whitespace
HoffmannMichael Apr 27, 2023
a5cfd5e
add cgalepicexact macro for all doxygen versions
HoffmannMichael Apr 28, 2023
87b8695
Merge remote-tracking branch 'cgal/master'
sloriot Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Documentation/doc/resources/1.10.0/BaseDoxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,8 @@ ALIASES = "cgal=%CGAL" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalBigO{1}=\f$O(\1)\f$" \
"cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
"cgalInclude{1}=`#include<\1>`"
"cgalInclude{1}=`#include<\1>`" \
"cgalEpicExact=<dl class=\"section note\"><dt>Exactness</dt><dd>This construction is trivial and therefore always exact in `Exact_predicates_inexact_constructions_kernel`.</dd></dl>"

# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
Expand Down
3 changes: 2 additions & 1 deletion Documentation/doc/resources/1.8.13/BaseDoxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,8 @@ ALIASES = "cgal=%CGAL" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalBigO{1}=\f$O(\1)\f$" \
"cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
"cgalInclude{1}=\#`include<\1>`"
"cgalInclude{1}=\#`include<\1>`" \
"cgalEpicExact=<dl class=\"section note\"><dt>Exactness</dt><dd>This construction is trivial and therefore always exact in `Exact_predicates_inexact_constructions_kernel`.</dd></dl>"

# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
Expand Down
3 changes: 2 additions & 1 deletion Documentation/doc/resources/1.9.6/BaseDoxyfile.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,8 @@ ALIASES = "cgal=%CGAL" \
"cgalParamPrecondition{1}=<li><b>Precondition: </b>\1</li>" \
"cgalBigO{1}=\f$O(\1)\f$" \
"cgalBigOLarge{1}=\f$O\left(\1\right)\f$" \
"cgalInclude{1}=`#include<\1>`"
"cgalInclude{1}=`#include<\1>`" \
"cgalEpicExact=<dl class=\"section note\"><dt>Exactness</dt><dd>This construction is trivial and therefore always exact in `Exact_predicates_inexact_constructions_kernel`.</dd></dl>"

# Doxygen selects the parser to use depending on the extension of the files it
# parses. With this tag you can assign which parser to use for a given
Expand Down
8 changes: 8 additions & 0 deletions Kernel_23/doc/Kernel_23/CGAL/Circle_2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ It is initialized to the circle with center `center`,
squared radius `squared_radius` and orientation
`ori`.
\pre `ori != COLLINEAR` and `squared_radius >= 0`.

\cgalEpicExact
*/
Circle_2(const Point_2<Kernel> &center,
const Kernel::FT &squared_radius,
Expand Down Expand Up @@ -64,6 +66,8 @@ It is initialized to the circle with center `center`, squared
radius zero and orientation `ori`.
\pre `ori != COLLINEAR`.
\post `c.is_degenerate()` = `true`.

\cgalEpicExact
*/
Circle_2( const Point_2<Kernel> &center,
const Orientation &ori = COUNTERCLOCKWISE);
Expand All @@ -76,18 +80,21 @@ Circle_2( const Point_2<Kernel> &center,
/*!

returns the center of `c`.
\cgalEpicExact
*/
const Point_2<Kernel> &center( ) const;

/*!

returns the squared radius of `c`.
\cgalEpicExact
*/
const Kernel::FT& squared_radius( ) const;

/*!

returns the orientation of `c`.
\cgalEpicExact
*/
Orientation orientation( ) const;

Expand Down Expand Up @@ -171,6 +178,7 @@ bool has_on_unbounded_side(const Point_2<Kernel> &p) const;

returns the circle with the same center and squared radius as
`c` but with opposite orientation.
\cgalEpicExact
*/
Circle_2<Kernel> opposite() const;

Expand Down
8 changes: 7 additions & 1 deletion Kernel_23/doc/Kernel_23/CGAL/Circle_3.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ introduces a variable `c` of type `Circle_3`.
It is initialized to the circle of center `center` and
squared radius `sq_r` in plane `plane`.
\pre `center` lies in `plane` and `sq_r >= 0`.

\cgalEpicExact
*/
Circle_3(const Point_3<Kernel> &center,
const Kernel::FT &sq_r,
Expand Down Expand Up @@ -60,7 +62,7 @@ It is initialized to the circle along which the sphere and the
plane intersect.
\pre The sphere and the plane intersect along a circle.
*/
Circle_3(constSphere_3<Kernel> & sphere,
Circle_3(const Sphere_3<Kernel> & sphere,
const Plane_3<Kernel> & plane);

/*!
Expand All @@ -80,24 +82,28 @@ Circle_3(const Plane_3<Kernel> & plane,
/*!

returns the center of `c`.
\cgalEpicExact
*/
const Point_3<Kernel> & center( ) const;

/*!

returns the squared radius of `c`.
\cgalEpicExact
*/
const Kernel::FT & squared_radius( ) const;

/*!

returns the supporting plane of `c`.
\cgalEpicExact
*/
const Plane_3<Kernel> & supporting_plane( ) const;

/*!

returns the diametral sphere of `c`.
\cgalEpicExact
*/
const Sphere_3<Kernel> & diametral_sphere( ) const;

Expand Down
6 changes: 6 additions & 0 deletions Kernel_23/doc/Kernel_23/CGAL/Direction_2.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ class Direction_2 {

/*!
introduces the direction `d` of vector `v`.
\cgalEpicExact
*/
Direction_2(const Vector_2<Kernel> &v);

Expand All @@ -47,6 +48,7 @@ Direction_2(const Segment_2<Kernel> &s);
/*!
introduces a direction `d` passing through the origin
and the point with %Cartesian coordinates \f$ (x, y)\f$.
\cgalEpicExact
*/
Direction_2(const Kernel::RT &x, const Kernel::RT &y);

Expand All @@ -61,16 +63,20 @@ Direction_2(const Kernel::RT &x, const Kernel::RT &y);
/*!
returns values, such that `d``== Direction_2<Kernel>(delta(0),delta(1))`.
\pre `0 <= i <= 1`.

\cgalEpicExact
*/
Kernel::RT delta(int i) const;

/*!
returns `delta(0)`.
\cgalEpicExact
*/
Kernel::RT dx() const;

/*!
returns `delta(1)`.
\cgalEpicExact
*/
Kernel::RT dy() const;

Expand Down
9 changes: 9 additions & 0 deletions Kernel_23/doc/Kernel_23/CGAL/Direction_3.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ class Direction_3 {
/*!
introduces a direction `d` initialized with the
direction of vector `v`.
\cgalEpicExact
*/
Direction_3(const Vector_3<Kernel> &v);

Expand All @@ -47,6 +48,7 @@ Direction_3(const Segment_3<Kernel> &s);
/*!
introduces a direction `d` initialized with the direction
from the origin to the point with %Cartesian coordinates \f$ (x, y, z)\f$.
\cgalEpicExact
*/
Direction_3(const Kernel::RT &x, const Kernel::RT &y, const Kernel::RT &z);

Expand All @@ -58,21 +60,26 @@ Direction_3(const Kernel::RT &x, const Kernel::RT &y, const Kernel::RT &z);
/*!
returns values, such that `d``== Direction_3<Kernel>(delta(0),delta(1),delta(2))`.
\pre `0 <= i <= 2`.

\cgalEpicExact
*/
Kernel::RT delta(int i) const;

/*!
returns `delta(0)`.
\cgalEpicExact
*/
Kernel::RT dx() const;

/*!
returns `delta(1)`.
\cgalEpicExact
*/
Kernel::RT dy() const;

/*!
returns `delta(2)`.
\cgalEpicExact
*/
Kernel::RT dz() const;

Expand All @@ -88,11 +95,13 @@ bool operator!=(const Direction_3<Kernel> &e) const;

/*!
The direction opposite to `d`.
\cgalEpicExact
*/
Direction_3<Kernel> operator-() const;

/*!
returns a vector that has the same direction as `d`.
\cgalEpicExact
*/
Vector_3<Kernel> vector() const;

Expand Down
Loading