CGAL 5.1 - dD Spatial Searching
SpatialTree Class Reference

#include <Concepts/SpatialTree.h>

Definition

The concept SpatialTree defines the requirements for a tree supporting both neighbor searching and approximate range searching.

Has Models:
CGAL::Kd_tree<Traits,Splitter,UseExtendedNode>

Types

typedef unspecified_type SearchTraits
 Search traits. More...
 
typedef unspecified_type D
 Dimension tag. More...
 
typedef unspecified_type Point_d
 Point type. More...
 
typedef unspecified_type iterator
 Bidirectional const iterator with value type Point_d that allows to enumerate all points in the tree. More...
 
typedef unspecified_type Node_handle
 Node handle. More...
 
typedef unspecified_type Node_const_handle
 const node handle. More...
 
typedef unspecified_type Point_d_iterator
 const iterator with value type const Point_d*. More...
 
typedef unspecified_type Splitter
 Splitter. More...
 
typedef unspecified_type Distance
 Distance. More...
 

Creation

template<class InputIterator >
 Tree (InputIterator first, InputIterator beyond, SearchTraits t)
 Constructs a tree on the elements from the sequence [first,beyond). More...
 

Operations

template<class OutputIterator , class FuzzyQueryItem >
OutputIterator search (OutputIterator it, FuzzyQueryItem q)
 Reports the points that are approximately contained by q. More...
 
iterator begin () const
 Returns a const iterator to the first point in the tree. More...
 
iterator end () const
 Returns the appropriate past-the-end const iterator. More...
 
Node_handle root ()
 Returns a handle to the root node of the tree. More...
 
Node_const_handle root () const
 Returns a const handle to the root node of the tree. More...
 
const Kd_tree_rectangle< SearchTraits::FT, D > & bounding_box () const
 Returns a const reference to the bounding box of the root node of the tree. More...
 
unsigned int size () const
 Returns the number of items that are stored in the tree. More...
 

Member Typedef Documentation

◆ D

typedef unspecified_type SpatialTree::D

Dimension tag.

◆ Distance

typedef unspecified_type SpatialTree::Distance

Distance.

◆ iterator

typedef unspecified_type SpatialTree::iterator

Bidirectional const iterator with value type Point_d that allows to enumerate all points in the tree.

◆ Node_const_handle

typedef unspecified_type SpatialTree::Node_const_handle

const node handle.

◆ Node_handle

typedef unspecified_type SpatialTree::Node_handle

Node handle.

◆ Point_d

typedef unspecified_type SpatialTree::Point_d

Point type.

◆ Point_d_iterator

typedef unspecified_type SpatialTree::Point_d_iterator

const iterator with value type const Point_d*.

◆ SearchTraits

typedef unspecified_type SpatialTree::SearchTraits

Search traits.

◆ Splitter

typedef unspecified_type SpatialTree::Splitter

Member Function Documentation

◆ begin()

iterator SpatialTree::begin ( ) const

Returns a const iterator to the first point in the tree.

◆ bounding_box()

const Kd_tree_rectangle<SearchTraits::FT,D>& SpatialTree::bounding_box ( ) const

Returns a const reference to the bounding box of the root node of the tree.

◆ end()

iterator SpatialTree::end ( ) const

Returns the appropriate past-the-end const iterator.

◆ root() [1/2]

Node_handle SpatialTree::root ( )

Returns a handle to the root node of the tree.

◆ root() [2/2]

Node_const_handle SpatialTree::root ( ) const

Returns a const handle to the root node of the tree.

◆ search()

template<class OutputIterator , class FuzzyQueryItem >
OutputIterator SpatialTree::search ( OutputIterator  it,
FuzzyQueryItem  q 
)

Reports the points that are approximately contained by q.

The value type of OutputIterator must be Point_d.

◆ size()

unsigned int SpatialTree::size ( ) const

Returns the number of items that are stored in the tree.

◆ Tree()

template<class InputIterator >
SpatialTree::Tree ( InputIterator  first,
InputIterator  beyond,
SearchTraits  t 
)

Constructs a tree on the elements from the sequence [first,beyond).