mirror of https://github.com/CGAL/cgal
polish
This commit is contained in:
parent
2bd834f5af
commit
9781041c7f
|
|
@ -72,12 +72,12 @@ InputIterator first,
|
||||||
InputIterator last);
|
InputIterator last);
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
inserts interval `i` in the interval skip list.
|
Inserts interval `i` in the interval skip list.
|
||||||
*/
|
*/
|
||||||
void insert(const Interval& i);
|
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);
|
bool remove(const Interval& i);
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -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;
|
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;
|
bool sup_closed() const;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -51,7 +51,7 @@ Level_interval(FaceHandle fh);
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
returns the face handle.
|
Returns the face handle.
|
||||||
*/
|
*/
|
||||||
FaceHandle face_handle();
|
FaceHandle face_handle();
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -23,7 +23,7 @@ public:
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
default constructor.
|
Default constructor.
|
||||||
*/
|
*/
|
||||||
Interval();
|
Interval();
|
||||||
|
|
||||||
|
|
@ -43,22 +43,22 @@ typedef Hidden_type Value;
|
||||||
/// @{
|
/// @{
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
returns the lower bound.
|
Returns the lower bound.
|
||||||
*/
|
*/
|
||||||
Value inf() const;
|
Value inf() const;
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
returns the upper bound.
|
Returns the upper bound.
|
||||||
*/
|
*/
|
||||||
Value sup() const;
|
Value sup() const;
|
||||||
|
|
||||||
/*!
|
/*!
|
||||||
returns `true`, iff the interval contains `v`.
|
Returns `true`, iff the interval contains `v`.
|
||||||
*/
|
*/
|
||||||
bool contains(const Value& v) const;
|
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;
|
bool contains_interval(const Value& i, const Value& s) const;
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -3,7 +3,7 @@
|
||||||
/// \ingroup PkgIntervalSkipList
|
/// \ingroup PkgIntervalSkipList
|
||||||
/*!
|
/*!
|
||||||
\addtogroup PkgIntervalSkipList
|
\addtogroup PkgIntervalSkipList
|
||||||
\todo check generated documentation
|
|
||||||
\PkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary}
|
\PkgDescriptionBegin{Interval Skip List,PkgIntervalSkipListSummary}
|
||||||
\PkgPicture{Interval_skip_list/fig/query.png}
|
\PkgPicture{Interval_skip_list/fig/query.png}
|
||||||
\PkgAuthor{Andreas Fabri}
|
\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.
|
It further allows to find all intervals that contain a point.
|
||||||
|
|
||||||
The interval skip list is, as far as its functionality is concerned,
|
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
|
and both allow to find all intervals that contain a given point. The
|
||||||
implementation of segment trees in \cgal works in higher
|
implementation of segment trees in \cgal works in higher
|
||||||
dimensions, whereas the interval skip list is limited to the 1D
|
dimensions, whereas the interval skip list is limited to the 1D
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue