songsenand
/
cgal
mirror of https://github.com/CGAL/cgal
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

polish

This commit is contained in:
Andreas Fabri 2012-10-04 16:44:41 +00:00
parent 2bd834f5af
commit 9781041c7f
5 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list.h
View File

@ -72,12 +72,12 @@ InputIterator first,
InputIterator last);
/*!
inserts interval `i` in the interval skip list.
Inserts interval `i` in the interval skip list.
*/
void insert(const Interval& i);
/*!
removes interval `i` from the interval skip list. Returns `true` iff removal was successful.
Removes interval `i` from the interval skip list. Returns `true` iff removal was successful.
*/
bool remove(const Interval& i);

4
Interval_skip_list/doc/Interval_skip_list/CGAL/Interval_skip_list_interval.h
View File

@ -42,12 +42,12 @@ bool uc = true);
/// @{
/*!
returns `true`, iff the interval is closed at the lower bound.
Returns `true`, iff the interval is closed at the lower bound.
*/
bool inf_closed() const;
/*!
returns `true`, iff the interval is closed at the upper bound.
Returns `true`, iff the interval is closed at the upper bound.
*/
bool sup_closed() const;

2
Interval_skip_list/doc/Interval_skip_list/CGAL/Level_interval.h
View File

@ -51,7 +51,7 @@ Level_interval(FaceHandle fh);
/// @{
/*!
returns the face handle.
Returns the face handle.
*/
FaceHandle face_handle();

10
Interval_skip_list/doc/Interval_skip_list/Concepts/Interval.h
View File

@ -23,7 +23,7 @@ public:
/// @{
/*!
default constructor.
Default constructor.
*/
Interval();
@ -43,22 +43,22 @@ typedef Hidden_type Value;
/// @{
/*!
returns the lower bound.
Returns the lower bound.
*/
Value inf() const;
/*!
returns the upper bound.
Returns the upper bound.
*/
Value sup() const;
/*!
returns `true`, iff the interval contains `v`.
Returns `true`, iff the interval contains `v`.
*/
bool contains(const Value& v) const;
/*!
returns `true`, iff `in` contains `(i,s)`.
Returns `true`, iff the interval contains `(i,s)`.
*/
bool contains_interval(const Value& i, const Value& s) const;

4
Interval_skip_list/doc/Interval_skip_list/PackageDescription.txt
View File

@ -3,7 +3,7 @@
/// \ingroup PkgIntervalSkipList
/*!
\addtogroup PkgIntervalSkipList
\todo check generated documentation
\PkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary}
\PkgPicture{Interval_skip_list/fig/query.png}
\PkgAuthor{Andreas Fabri}
@ -22,7 +22,7 @@ that is to test whether a point is covered by any of the intervals.
It further allows to find all intervals that contain a point.
The interval skip list is, as far as its functionality is concerned,
related to the `Segment_tree`. Both allow to do stabbing queries
related to the `CGAL::Segment_tree_d`. Both allow to do stabbing queries
and both allow to find all intervals that contain a given point. The
implementation of segment trees in \cgal works in higher
dimensions, whereas the interval skip list is limited to the 1D