numeric::kdtree::KDTree Class Reference

#include <KDTree.hh>

Inheritance diagram for numeric::kdtree::KDTree:

Collaboration diagram for numeric::kdtree::KDTree:

List of all members.

Public Member Functions
	KDTree ()
	Empty constructor.
	KDTree (utility::vector1< utility::vector1< numeric::Real > > &pts)
	Constructs a balanced kd-tree from the set of k-dimensional input points.
	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.
numeric::Size	ndim () const
	Number of dimensions in the kd-tree. This is the "k" in kd.
KDNodeOP	root () const
	Returns the KDNodeOP that is the root of the balanced kd-tree.
HyperRectangleOP	bounds () const
	Returns the HyperRectangle that bounds all of the points in the kd-tree.
void	size (numeric::Size new_size)
	Sets the number of points in this kd-tree.
void	root (KDNodeOP new_root)
	Sets the root of the kd-tree.
void	extend_bounds (utility::vector1< numeric::Real > const &pt)
	Pushes out the bounds of the HyperRectangle bounding this kd-tree if necessary.

---

Constructor & Destructor Documentation

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 numeric::kdtree::construct_kd_tree(), numeric::kdtree::make_points(), and size().

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

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

---

Member Function Documentation

HyperRectangleOP numeric::kdtree::KDTree::bounds

(

)

const

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

Detailed: 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.

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.

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

(

)

const

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

void numeric::kdtree::KDTree::root

(

KDNodeOP

new_root

)

Sets the root of the kd-tree.

KDNodeOP numeric::kdtree::KDTree::root

(

)

const

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

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

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

(

)

const

Number of points in the kd-tree.

Referenced by KDTree().

void numeric::kdtree::KDTree::size

(

numeric::Size

new_size

)

Sets the number of points in this kd-tree.

---

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

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