CGAL 4.4 - dD Spatial Searching
|
#include <CGAL/Incremental_neighbor_search.h>
The class Incremental_neighbor_search
implements incremental nearest and furthest neighbor searching on a tree.
The tree may have extended or unextended nodes.
Parameters
Expects for the first template argument a model of the concept SearchTraits
, for example Search_traits_2<Simple_cartesian<double> >
.
Expects for the second template argument a model of the concept GeneralDistance
. If Traits
is Search_traits_adapter<Key,PointPropertyMap,BaseTraits>
the default type is Distance_adapter<Key,PointPropertyMap,Euclidean_distance<Traits> >
, and Euclidean_distance<Traits>
otherwise.
Expects for third template argument a model of the concept Splitter
. The default type is Sliding_midpoint<Traits>
.
Expects for fourth template argument a model of the concept SpatialTree
. The default type is Kd_tree<Traits,Splitter,Tag_false>
. The template argument Tag_false
makes that the tree is built with unextended nodes.
CGAL::Orthogonal_incremental_neighbor_search<Traits, OrthogonalDistance, Splitter, SpatialTree>
Types | |
typedef Traits::Point_d | Point_d |
Point type. More... | |
typedef Traits::NT | NT |
Number type. More... | |
typedef GeneralDistance | Distance |
Distance type. More... | |
typedef std::pair< Point_d, NT > | Point_with_transformed_distance |
Pair of point and transformed distance. More... | |
typedef unspecified_type | iterator |
const input iterator with value type Point_with_transformed_distance for enumerating approximate neighbors. More... | |
GeneralDistance::Query_item | Query_item |
Query item type. More... | |
SpatialTree | Tree |
The tree type. More... | |
Creation | |
Incremental_neighbor_search (Tree &tree, QueryItem q, NT eps=NT(0.0), bool search_nearest=true, GeneralDistance d=GeneralDistance()) | |
Constructor for incremental neighbor searching of the query item q in the points stored tree using a distance d and approximation factor eps . More... | |
Operations | |
iterator | begin () const |
Returns a const iterator to the approximate nearest or furthest neighbor. More... | |
iterator | end () const |
Returns the appropriate past-the-end const iterator. More... | |
std::ostream & | statistics (std::ostream &s) |
Inserts statistics of the search process into the output stream s . More... | |
typedef GeneralDistance CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Distance |
Distance type.
typedef unspecified_type CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::iterator |
const input iterator with value type Point_with_transformed_distance
for enumerating approximate neighbors.
typedef Traits::NT CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::NT |
Number type.
typedef Traits::Point_d CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Point_d |
Point type.
typedef std::pair<Point_d,NT> CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Point_with_transformed_distance |
Pair of point and transformed distance.
CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Incremental_neighbor_search | ( | Tree & | tree, |
QueryItem | q, | ||
NT | eps = NT(0.0) , |
||
bool | search_nearest = true , |
||
GeneralDistance | d = GeneralDistance() |
||
) |
Constructor for incremental neighbor searching of the query item q
in the points stored tree
using a distance d
and approximation factor eps
.
iterator CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::begin | ( | ) | const |
Returns a const iterator to the approximate nearest or furthest neighbor.
iterator CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::end | ( | ) | const |
Returns the appropriate past-the-end const iterator.
std::ostream& CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::statistics | ( | std::ostream & | s | ) |
Inserts statistics of the search process into the output stream s
.
GeneralDistance::Query_item CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Query_item |
Query item type.
SpatialTree CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Tree |
The tree type.