numeric::kdtree::KDPoint Class Reference

#include <KDPoint.hh>

Public Member Functions
virtual	~KDPoint ()
	Automatically generated virtual destructor for class deriving directly from ReferenceCount. More...
	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 More...
utility::vector1 < numeric::Real > const &	const_location () const
	Returns a const reference to the location of this point in k-space. More...
numeric::Size	size () const
	Returns the number of dimensions for the space in which this point lives. More...
utility::vector1< numeric::Real >	location () const
	Returns to the location of this point in k-space. More...
utility::pointer::ReferenceCountOP	data () const
	Returns the data associated with this class. More...
numeric::Real	distance () const
	getter for distance() from this point to an arbitrary point in kd-space. More...
void	distance (numeric::Real dist)
	Sets the distance to an arbitrary point. More...
void	location (utility::vector1< numeric::Real > dat)
	sets the location of this point in k-space. More...
KDPoint &	operator= (KDPoint const &src)
	Assignment operator for KDPoint class. More...
bool	operator== (KDPoint const &other) const
	Equality operator. Compares location() and distance(), ignores data(). More...
void	show (std::ostream &out) const
	Prints the definition of this object to the given ostream. More...
std::string	to_string () const
	Returns a stringified version of this object. More...
void	read_data (std::istream &in)
	Reads the definition for this object from the given istream. More...
Public Member Functions inherited from utility::pointer::ReferenceCount
void	ctor ()
virtual	~ReferenceCount ()
	Destructor. More...
Size	ref_count () const
	Reference count. More...

Private Attributes
utility::vector1< numeric::Real >	location_
utility::pointer::ReferenceCountOP	data_
numeric::Real	distance_

Additional Inherited Members
Public Types inherited from utility::pointer::ReferenceCount
typedef platform::Size	Size
typedef platform::Size	size_type
Protected Member Functions inherited from utility::pointer::ReferenceCount
	ReferenceCount ()
	Default constructor. More...
	ReferenceCount (ReferenceCount const &)
	Copy constructor. More...
ReferenceCount &	operator= (ReferenceCount const &)
	Copy assignment. More...

Constructor & Destructor Documentation

numeric::kdtree::KDPoint::~KDPoint ( )

virtual

Automatically generated virtual destructor for class deriving directly from ReferenceCount.

Auto-generated virtual destructor

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.

References location_.

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

(

)

const

Returns the data associated with this class.

References data_.

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.

References distance_.

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

void numeric::kdtree::KDPoint::distance

(

numeric::Real

dist

)

Sets the distance to an arbitrary point.

References distance_.

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

(

)

const

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

References location_.

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

void numeric::kdtree::KDPoint::location

(

utility::vector1< numeric::Real >

dat

)

sets the location of this point in k-space.

References location_.

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

(

KDPoint const &

src

)

Assignment operator for KDPoint class.

References data(), data_, distance(), distance_, location(), 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 data_, and location_.

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.

References location_.

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(), basic::options::OptionKeys::cutoutdomain::end, location_, and size().

Referenced by show().

Member Data Documentation

utility::pointer::ReferenceCountOP numeric::kdtree::KDPoint::data_

private

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

numeric::Real numeric::kdtree::KDPoint::distance_

private

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

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

private

Referenced by const_location(), location(), operator=(), read_data(), size(), and to_string().

---

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

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