CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree > Class Template Reference

#include <CGAL/Incremental_neighbor_search.h>

Definition

template<typename Traits, typename GeneralDistance, typename Splitter, typename SpatialTree>
class CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >

The class Incremental_neighbor_search implements incremental nearest and furthest neighbor searching on a tree.

The tree may have extended or unextended nodes.

Template Parameters

Traits	must be a model of the concept SearchTraits, for example Search_traits_2<Simple_cartesian<double> >.
GeneralDistance	must be 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<BaseTraits> >, and Euclidean_distance<Traits> otherwise.
Splitter	must be a model of the concept Splitter. The default type is Sliding_midpoint<Traits>.
SpatialTree	must be a model of the concept SpatialTree. The default type is Kd_tree<Traits, Splitter, Tag_false, Tag_false>. The third template argument Tag_false makes that the tree is built with unextended nodes.

See also

CGAL::Orthogonal_incremental_neighbor_search<Traits, OrthogonalDistance, Splitter, SpatialTree>

Types
typedef Traits::Point_d	Point_d
	Point type.
typedef Traits::NT	NT
	Number type.
typedef GeneralDistance	Distance
	Distance type.
typedef std::pair< Point_d, NT >	Point_with_transformed_distance
	Pair of point and transformed distance.
typedef unspecified_type	iterator
	const input iterator with value type Point_with_transformed_distance for enumerating approximate neighbors.
GeneralDistance::Query_item	Query_item
	Query item type.
SpatialTree	Tree
	The tree type.

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.

Operations
iterator	begin () const
	Returns a const iterator to the approximate nearest or furthest neighbor.
iterator	end () const
	Returns the appropriate past-the-end const iterator.
std::ostream &	statistics (std::ostream &s)
	Inserts statistics of the search process into the output stream s.

Member Typedef Documentation

Distance

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

typedef GeneralDistance CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Distance

Distance type.

iterator

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

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.

NT

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

typedef Traits::NT CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::NT

Number type.

Point_d

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

typedef Traits::Point_d CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Point_d

Point type.

Point_with_transformed_distance

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

typedef std::pair<Point_d,NT> CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Point_with_transformed_distance

Pair of point and transformed distance.

Constructor & Destructor Documentation

Incremental_neighbor_search()

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

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.

Member Function Documentation

begin()

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

iterator CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::begin

(

)

const

Returns a const iterator to the approximate nearest or furthest neighbor.

end()

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

iterator CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::end

(

)

const

Returns the appropriate past-the-end const iterator.

statistics()

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

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.

Member Data Documentation

Query_item

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

GeneralDistance::Query_item CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Query_item

Query item type.

Tree

template<typename Traits , typename GeneralDistance , typename Splitter , typename SpatialTree >

SpatialTree CGAL::Incremental_neighbor_search< Traits, GeneralDistance, Splitter, SpatialTree >::Tree

The tree type.