numeric::kdtree::KDTree Class Reference

#include <KDTree.hh>

Inheritance diagram for numeric::kdtree::KDTree:

Public Member Functions
	~KDTree () override
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...
	KDTree ()
	Empty constructor. More...
	KDTree (utility::vector1< utility::vector1< numeric::Real > > &pts)
	Constructs a balanced kd-tree from the set of k-dimensional input points. More...
	KDTree (utility::vector1< utility::vector1< numeric::Real > > &pts, utility::vector1< utility::pointer::ReferenceCountOP > &data)
numeric::Size	size () const
	Number of points in the kd-tree. More...
numeric::Size	ndim () const
	Number of dimensions in the kd-tree. This is the "k" in kd. More...
KDNodeOP	root () const
	Returns the KDNodeOP that is the root of the balanced kd-tree. More...
HyperRectangleOP	bounds () const
	Returns the HyperRectangle that bounds all of the points in the kd-tree. More...
void	size (numeric::Size new_size)
	Sets the number of points in this kd-tree. More...
void	root (KDNodeOP new_root)
	Sets the root of the kd-tree. More...
void	extend_bounds (utility::vector1< numeric::Real > const &pt)
	Pushes out the bounds of the HyperRectangle bounding this kd-tree if necessary. More...
Public Member Functions inherited from utility::pointer::ReferenceCount
	ReferenceCount ()
	Default constructor. More...
virtual	~ReferenceCount ()

Private Attributes
numeric::Size	size_
KDNodeOP	root_
HyperRectangleOP	bounds_

Additional Inherited Members
Public Types inherited from utility::pointer::ReferenceCount
typedef platform::Size	Size
typedef platform::Size	size_type

Constructor & Destructor Documentation

numeric::kdtree::KDTree::~KDTree ( )

overridedefault

Automatically generated virtual destructor for class deriving directly from ReferenceCount.

Auto-generated virtual destructor

numeric::kdtree::KDTree::KDTree

(

)

Empty constructor.

numeric::kdtree::KDTree::KDTree

(

utility::vector1< utility::vector1< numeric::Real > > &

pts

)

Constructs a balanced kd-tree from the set of k-dimensional input points.

References bounds_, numeric::kdtree::construct_kd_tree(), numeric::kdtree::make_points(), root_, and size().

numeric::kdtree::KDTree::KDTree	(	utility::vector1< utility::vector1< numeric::Real > > &	pts,
		utility::vector1< utility::pointer::ReferenceCountOP > &	data
	)

References bounds_, numeric::kdtree::construct_kd_tree(), numeric::kdtree::make_points(), root_, and size().

Member Function Documentation

HyperRectangleOP numeric::kdtree::KDTree::bounds

(

)

const

Returns the HyperRectangle that bounds all of the points in the kd-tree.

A HyperRectangle is defined as two vectors upper and lower, with each dimension of lower having the minimum value seen in each dimension, and each dimension of higher having the maximum value seen in each dimension.

References bounds_.

Referenced by numeric::kdtree::nearest_neighbor(), and numeric::kdtree::nearest_neighbors().

void numeric::kdtree::KDTree::extend_bounds

(

utility::vector1< numeric::Real > const &

pt

)

Pushes out the bounds of the HyperRectangle bounding this kd-tree if necessary.

References bounds_.

numeric::Size numeric::kdtree::KDTree::ndim

(

)

const

Number of dimensions in the kd-tree. This is the "k" in kd.

References bounds_.

KDNodeOP numeric::kdtree::KDTree::root

(

)

const

Returns the KDNodeOP that is the root of the balanced kd-tree.

References root_.

Referenced by numeric::kdtree::nearest_neighbor(), and numeric::kdtree::nearest_neighbors().

void numeric::kdtree::KDTree::root

(

KDNodeOP

new_root

)

Sets the root of the kd-tree.

References root_.

numeric::Size numeric::kdtree::KDTree::size

(

)

const

Number of points in the kd-tree.

References size_.

Referenced by KDTree().

void numeric::kdtree::KDTree::size

(

numeric::Size

new_size

)

Sets the number of points in this kd-tree.

References size_.

Member Data Documentation

HyperRectangleOP numeric::kdtree::KDTree::bounds_

private

Referenced by bounds(), extend_bounds(), KDTree(), and ndim().

KDNodeOP numeric::kdtree::KDTree::root_

private

Referenced by KDTree(), and root().

numeric::Size numeric::kdtree::KDTree::size_

private

Referenced by size().

---

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

• src/numeric/kdtree/KDTree.hh
• src/numeric/kdtree/KDTree.cc