maliput
KDTree< Coordinate, Dimension, Region, Distance, NodeCmp > Class Template Reference

Detailed Description

template<typename Coordinate, ::std::size_t Dimension, typename Region = BoundingRegion<Coordinate>, typename Distance = details::SquaredDistance<Coordinate, Dimension>, typename NodeCmp = details::NodeCmp<Dimension>>
class maliput::math::KDTree< Coordinate, Dimension, Region, Distance, NodeCmp >

N-Dimension KDTree.

See KDTreeBase for details.

#include <include/maliput/math/kd_tree.h>

Inheritance diagram for KDTree< Coordinate, Dimension, Region, Distance, NodeCmp >:
[legend]

Public Member Functions

template<typename Iterator >
 KDTree (Iterator begin, Iterator end)
 
template<typename Collection >
 KDTree (Collection &&points)
 Constructs a KDTreeBase taking a vector of points. More...
 
- Public Member Functions inherited from KDTreeBase< KDTree< Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >, Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >
 KDTreeBase (Iterator begin, Iterator end)
 Constructs a KDTreeBase taking a pair of iterators. More...
 
 KDTreeBase (Collection &&points)
 Constructs a KDTreeBase taking a vector of points. More...
 
const Coordinate & nearest_point (const Coordinate &point) const
 Finds the nearest point in the tree to the given point. More...
 
const Coordinate & nearest_point (const Coordinate &point, double tolerance) const
 Finds the nearest point in the tree to the given point. More...
 

Additional Inherited Members

- Protected Types inherited from KDTreeBase< KDTree< Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >, Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >
using Node = details::Node< Coordinate, BoundingRegion< Coordinate > >
 
- Protected Member Functions inherited from KDTreeBase< KDTree< Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >, Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >
void nearest_point (const Node *node, const Coordinate &point, std::size_t index, double tolerance, Node *&nearest_neighbour_node, double *nearest_neighbour_distance) const
 
- Protected Attributes inherited from KDTreeBase< KDTree< Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >, Coordinate, Dimension, BoundingRegion< Coordinate >, details::SquaredDistance< Coordinate, Dimension >, details::NodeCmp< Dimension > >
Noderoot_
 
std::deque< Nodenodes_
 

Constructor & Destructor Documentation

◆ KDTree() [1/2]

KDTree ( Iterator  begin,
Iterator  end 
)

◆ KDTree() [2/2]

KDTree ( Collection &&  points)

Constructs a KDTreeBase taking a vector of points.

Parameters
pointsVector of points
Template Parameters
Collectiontype of the collection.
Exceptions
maliput::common::assertion_errorWhen the range is empty.

The documentation for this class was generated from the following file: