numeric::kdtree::KDPoint Class Reference

#include <KDPoint.hh>

Inheritance diagram for numeric::kdtree::KDPoint:

Collaboration diagram for numeric::kdtree::KDPoint:

List of all members.

Public Member Functions
	KDPoint ()
	KDPoint (utility::vector1< numeric::Real > location)
	KDPoint (utility::vector1< numeric::Real > location, utility::pointer::ReferenceCountOP data)
	KDPoint (utility::vector1< numeric::Real > location, numeric::Real distance)
	KDPoint (utility::vector1< numeric::Real > location, utility::pointer::ReferenceCountOP data, numeric::Real distance)
	KDPoint (KDPoint const &src)
	copy constructor
utility::vector1 < numeric::Real > const &	const_location () const
	Returns a const reference to the location of this point in k-space.
numeric::Size	size () const
	Returns the number of dimensions for the space in which this point lives.
utility::vector1< numeric::Real >	location () const
	Returns to the location of this point in k-space.
utility::pointer::ReferenceCountOP	data () const
	Returns the data associated with this class.
numeric::Real	distance () const
	getter for distance() from this point to an arbitrary point in kd-space.
void	distance (numeric::Real dist)
	Sets the distance to an arbitrary point.
void	location (utility::vector1< numeric::Real > dat)
	sets the location of this point in k-space.
KDPoint &	operator= (KDPoint const &src)
	Assignment operator for KDPoint class.
bool	operator== (KDPoint const &other) const
	Equality operator. Compares location() and distance(), ignores data().
void	show (std::ostream &out) const
	Prints the definition of this object to the given ostream.
std::string	to_string () const
	Returns a stringified version of this object.
void	read_data (std::istream &in)
	Reads the definition for this object from the given istream.

---

Constructor & Destructor Documentation

numeric::kdtree::KDPoint::KDPoint

(

)

numeric::kdtree::KDPoint::KDPoint

(

utility::vector1< numeric::Real >

location

)

numeric::kdtree::KDPoint::KDPoint	(	utility::vector1< numeric::Real >	location,
		utility::pointer::ReferenceCountOP	data
	)

numeric::kdtree::KDPoint::KDPoint	(	utility::vector1< numeric::Real >	location,
		numeric::Real	distance
	)

numeric::kdtree::KDPoint::KDPoint	(	utility::vector1< numeric::Real >	location,
		utility::pointer::ReferenceCountOP	data,
		numeric::Real	distance
	)

numeric::kdtree::KDPoint::KDPoint

(

KDPoint const &

src

)

copy constructor

---

Member Function Documentation

utility::vector1< numeric::Real > const & numeric::kdtree::KDPoint::const_location

(

)

const

Returns a const reference to the location of this point in k-space.

utility::pointer::ReferenceCountOP numeric::kdtree::KDPoint::data

(

)

const

Returns the data associated with this class.

Referenced by operator=(), and to_string().

numeric::Real numeric::kdtree::KDPoint::distance

(

)

const

getter for distance() from this point to an arbitrary point in kd-space.

Referenced by operator=(), operator==(), and show().

void numeric::kdtree::KDPoint::distance

(

numeric::Real

dist

)

Sets the distance to an arbitrary point.

References basic::options::OptionKeys::orbitals::dist.

utility::vector1< numeric::Real > numeric::kdtree::KDPoint::location

(

)

const

Returns to the location of this point in k-space.

Referenced by operator=(), and operator==().

void numeric::kdtree::KDPoint::location

(

utility::vector1< numeric::Real >

dat

)

sets the location of this point in k-space.

KDPoint & numeric::kdtree::KDPoint::operator=

(

KDPoint const &

src

)

Assignment operator for KDPoint class.

References data(), distance(), and location().

bool numeric::kdtree::KDPoint::operator==

(

KDPoint const &

other

)

const

Equality operator. Compares location() and distance(), ignores data().

References distance(), and location().

void numeric::kdtree::KDPoint::read_data

(

std::istream &

in

)

Reads the definition for this object from the given istream.

References test::T200_Scoring::ii, and color_pdb::token.

void numeric::kdtree::KDPoint::show

(

std::ostream &

out

)

const

Prints the definition of this object to the given ostream.

References distance(), and to_string().

numeric::Size numeric::kdtree::KDPoint::size

(

)

const

Returns the number of dimensions for the space in which this point lives.

Referenced by to_string().

std::string numeric::kdtree::KDPoint::to_string

(

)

const

Returns a stringified version of this object.

should look like: KDPOINT ndim val1 val2 val3 DATA <data definition>="">

References data(), end, size(), and ObjexxFCL::string_of().

Referenced by show().

---

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

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