numeric::kdtree::KDPointList Class Reference

Class for keeping track of the closest N KDPoint objects by distance. More...

#include <KDPointList.hh>

Inheritance diagram for numeric::kdtree::KDPointList:

Public Types
typedef utility::vector1 < KDPointOP >::iterator	iterator
typedef utility::vector1 < KDPointOP >::const_iterator	const_iterator

Public Member Functions
	~KDPointList () override
	Automatically generated virtual destructor for class deriving directly from VirtualBase. More...
const_iterator	begin () const
const_iterator	end () const
iterator	begin ()
iterator	end ()
	KDPointList (numeric::Size const n_to_keep)
void	insert (KDPointOP pt)
numeric::Real	worst_distance () const
KDPointOP	operator[] (numeric::Size const pos) const
numeric::Size	size () const
numeric::Size	max_values () const
numeric::Real	distance_cutoff () const
void	distance_cutoff (numeric::Real const cutoff)
utility::vector1< KDPointOP >	sorted_values ()
void	merge (KDPointList const &other)
	merge another KDPointList with this KDPointList. This calls insert which is a little slow, and is a candidate for optimization if the insert() method shows up in profiling. More...
void	show (std::ostream &out) const
Public Member Functions inherited from utility::VirtualBase
	VirtualBase ()=default
	Default constructor. More...
virtual	~VirtualBase ()=default
	The virtual destructor is one of the main reasons for the VirtualBase class. More...
	VirtualBase (VirtualBase const &)=default
	VirtualBase (VirtualBase &&)=default
VirtualBase &	operator= (VirtualBase const &)=default
VirtualBase &	operator= (VirtualBase &&)=default

Private Member Functions
void	update_heap_ ()
void	update_size_ ()

Private Attributes
numeric::Size	max_vals_
numeric::Real	distance_cutoff_
utility::vector1< KDPointOP >	container_

Detailed Description

Class for keeping track of the closest N KDPoint objects by distance.

Member Typedef Documentation

typedef utility::vector1< KDPointOP >::const_iterator numeric::kdtree::KDPointList::const_iterator

typedef utility::vector1< KDPointOP >::iterator numeric::kdtree::KDPointList::iterator

Constructor & Destructor Documentation

numeric::kdtree::KDPointList::~KDPointList ( )

overridedefault

Automatically generated virtual destructor for class deriving directly from VirtualBase.

Auto-generated virtual destructor

numeric::kdtree::KDPointList::KDPointList

(

numeric::Size const

n_to_keep

)

Member Function Documentation

utility::vector1< KDPointOP >::const_iterator numeric::kdtree::KDPointList::begin

(

)

const

References container_.

utility::vector1< KDPointOP >::iterator numeric::kdtree::KDPointList::begin

(

)

References container_.

numeric::Real numeric::kdtree::KDPointList::distance_cutoff

(

)

const

References distance_cutoff_.

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

void numeric::kdtree::KDPointList::distance_cutoff

(

numeric::Real const

cutoff

)

References basic::options::OptionKeys::cp::cutoff, and distance_cutoff_.

utility::vector1< KDPointOP >::const_iterator numeric::kdtree::KDPointList::end

(

)

const

References container_.

utility::vector1< KDPointOP >::iterator numeric::kdtree::KDPointList::end

(

)

References container_.

void numeric::kdtree::KDPointList::insert

(

KDPointOP

pt

)

References container_, update_heap_(), and update_size_().

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

numeric::Size numeric::kdtree::KDPointList::max_values

(

)

const

References max_vals_.

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

void numeric::kdtree::KDPointList::merge

(

KDPointList const &

other

)

merge another KDPointList with this KDPointList. This calls insert which is a little slow, and is a candidate for optimization if the insert() method shows up in profiling.

References insert().

Referenced by numeric::kdtree::nearest_neighbors().

KDPointOP numeric::kdtree::KDPointList::operator[]

(

numeric::Size const

pos

)

const

References container_, make_symmdef_file_denovo::pos, and size().

void numeric::kdtree::KDPointList::show

(

std::ostream &

out

)

const

References container_, and size().

Referenced by pyrosetta.distributed.viewer.core.Viewer::__call__().

numeric::Size numeric::kdtree::KDPointList::size

(

)

const

References container_.

Referenced by operator[](), and show().

utility::vector1< KDPointOP > numeric::kdtree::KDPointList::sorted_values

(

)

References container_, and test.T040_Types::values.

void numeric::kdtree::KDPointList::update_heap_ ( )

private

References container_.

Referenced by insert().

void numeric::kdtree::KDPointList::update_size_ ( )

private

References container_, and max_vals_.

Referenced by insert().

numeric::Real numeric::kdtree::KDPointList::worst_distance

(

)

const

References container_, distance_cutoff(), max_values(), and min().

Referenced by numeric::kdtree::nearest_neighbors().

Member Data Documentation

utility::vector1< KDPointOP > numeric::kdtree::KDPointList::container_

private

Referenced by begin(), end(), insert(), operator[](), show(), size(), sorted_values(), update_heap_(), update_size_(), and worst_distance().

numeric::Real numeric::kdtree::KDPointList::distance_cutoff_

private

Referenced by distance_cutoff().

numeric::Size numeric::kdtree::KDPointList::max_vals_

private

Referenced by max_values(), and update_size_().

---

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

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