Navigation: Up   Table of Contents   Package Overview   Bibliography   Index   Title   Acknowledging CGAL
Function

CGAL::range_search

Definition

There are six versions of the function template range_search that perform range searches on Delaunay triangulations. The first performs circular range searches, the second triangular range searches and the third performs iso-rectangular range searches. The other three range search function templates perform enhanced variants of the three aforementioned operations.
They get a user-defined object that has to control the range search operation. This way one can for instance stop the search, when n points were found.

#include <CGAL/range_search_delaunay_2.h>

template<class Dt, class Circle, class OutputIterator>
OutputIterator range_search ( Dt& delau, Circle C, OutputIterator res)
computes handles to all vertices contained in the closure of disk C. The computed vertex handles will be placed as a sequence of objects in a container of value type of res which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end of the sequence. delau is the Cgal Delaunay triangulation on which we perform the range search operation.

Requirements

template<class Dt, class OutputIterator>
OutputIterator range_search ( Dt& delau, Dt::Point a, Dt::Point b, Dt::Point c, OutputIterator res)
computes handles to all vertices contained in the closure of the triangle (a,b,c).
Precondition: a, b, and c must not be collinear. The computed vertex handles will be placed as a sequence of objects in a container of value type of res which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end of the sequence. delau is the Cgal Delaunay triangulation on which we perform the range search operation.

Requirements

Dt is a Cgal Delaunay triangulation and contains the following subset of types from the concept PointSetTraits and from the Delaunay triangulation data type:

template<class Dt, class OutputIterator>
OutputIterator range_search ( Dt& delau, Dt::Point a, Dt::Point b, Dt::Point c, Dt::Point d, OutputIterator res)
computes handles to all vertices contained in the closure of the iso-rectangle (a,b,c,d).
Precondition: a is the upper left point, b the lower left, c the lower right and d the upper right point of the iso rectangle. The computed vertex handles will be placed as a sequence of objects in a container of value type of res which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end of the sequence. delau is the Cgal Delaunay triangulation on which we perform the range search operation.

Requirements

Dt is a Cgal Delaunay triangulation and contains the following subset of types from the concept PointSetTraits and from the Delaunay triangulation data type:

template<class Dt, class Circle, class OutputIterator, class Pred>
OutputIterator range_search ( Dt& delau, Circle C, OutputIterator res, Pred& pred, bool return_if_succeded)
computes handles to all vertices contained in the closure of disk C. The computed vertex handles will be placed as a sequence of objects in a container of value type of res which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end of the sequence. delau is the Cgal Delaunay triangulation on that we perform the range search operation. pred controls the search operation. If return_if_succeded is true, we will end the search after the first success of the predicate, otherwise we will continue till the search is finished.

Requirements

For the requirements of Dt see the description for the non-predicate version.
Requirements of Pred: The operator() is used for testing the current point in the search operation. If this operator returns true and return_if_succeded is true, the range search will stop. Otherwise the range search operation will continue. Member function set_result can be used to store the result of the range search in the function object. The result will be true if the last call to the operator() of the predicate returned true, false otherwise.

template<class Dt, class OutputIterator, class Pred>
OutputIterator
range_search ( Dt& delau,
Dt::Point a,
Dt::Point b,
Dt::Point c,
OutputIterator res,
Pred& pred,
bool return_if_succeded)
computes handles to all vertices contained in the closure of the triangle (a,b,c).
Precondition: a, b, and c must not be collinear. The computed vertex handles will be placed as a sequence of objects in a container of value type of res which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end of the sequence. delau is the Cgal Delaunay triangulation on which we perform the range search operation. pred controls the search operation. If return_if_succeded is true, we will end the search after the first success of the predicate, otherwise we will continue till the search is finished.

Requirements

For the requirements of Dt see the description for the non-predicate version.
For the requirements of Pred see the description above.

template<class Dt, class OutputIterator, class Pred>
OutputIterator
range_search ( Dt& delau,
Dt::Point a,
Dt::Point b,
Dt::Point c,
Dt::Point d,
OutputIterator res,
Pred& pred,
bool return_if_succeded)
computes handles to all vertices contained in the closure of the iso-rectangle (a,b,c,d).
Precondition: a is the upper left point, b the lower left, c the lower right and d the upper right point of the iso rectangle. The computed vertex handles will be placed as a sequence of objects in a container of value type of res which points to the first object in the sequence. The function returns an output iterator pointing to the position beyond the end of the sequence. delau is the Cgal Delaunay triangulation on which we perform the range search operation. pred controls the search operation. If return_if_succeded is true, we will end the search after the first success of the predicate, otherwise we will continue till the search is finished.

Requirements

For the requirements of Dt see the description for the non-predicate version.
For the requirements of Pred see the description above.

Navigation: Up   Table of Contents   Package Overview   Bibliography   Index   Title   Acknowledging CGAL
CGAL Open Source Project. Release 4.1. 23 October 2012.