Savarese Software Research
Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members
com::savarese::algorithms::spatial_v0_1_1

sava::spatial Namespace Reference

Detailed Description

The sava::spatial package houses data structures and algorithms for spatial data structures and concerns itself primarily with range searching.


Classes

struct  KDTreeTraits
 KDTreeTraits stores metadata about KDTree instances. More...
struct  KDTreeConstTraits
 KDTreeConstTraits stores metadata about const KDTree instances. More...
class  KDTree
 A k-d tree divides a k-dimensional space relative to the points it contains by storing them in a binary tree, discriminating by a different dimension at each level of the tree. More...
struct  PointTraits
 PointTraits stores metadata about Point instances. More...
class  Point
 A Point is a k-dimensional tuple of coordinates. More...
class  Point2D
 A two-dimensional specialization of the Point class. More...
class  Point3D
 A three-dimensional specialization of the Point class. More...

Functions

template<unsigned int Dimensions, class CoordType>
bool operator== (const Point< Dimensions, CoordType > &point1, const Point< Dimensions, CoordType > &point2)
 Returns true if each of the coordinates in point1 is equal to its corresponding coordinate in point2, otherwise false.
template<unsigned int Dimensions, class CoordType>
bool operator< (const Point< Dimensions, CoordType > &point1, const Point< Dimensions, CoordType > &point2)
 Returns true if there is an index j where point1[i] <= point2[i] and point1[j] < point2[j] for all i <= j, otherwise false.
template<unsigned int Dimensions, class CoordType>
bool operator> (const Point< Dimensions, CoordType > &point1, const Point< Dimensions, CoordType > &point2)
 Returns true if there is an index j where point1[i] >= point2[i] and point1[j] > point2[j] for all i <= j, otherwise false.
template<class CoordType>
bool operator== (const Point< 2, CoordType > &point1, const Point< 2, CoordType > &point2)
template<class CoordType>
bool operator< (const Point< 2, CoordType > &point1, const Point< 2, CoordType > &point2)
template<class CoordType>
bool operator> (const Point< 2, CoordType > &point1, const Point< 2, CoordType > &point2)
template<class CoordType>
bool operator== (const Point< 3, CoordType > &point1, const Point< 3, CoordType > &point2)
template<class CoordType>
bool operator< (const Point< 3, CoordType > &point1, const Point< 3, CoordType > &point2)
template<class CoordType>
bool operator> (const Point< 3, CoordType > &point1, const Point< 3, CoordType > &point2)
template<unsigned int Dimensions, class CoordType>
bool operator!= (const Point< Dimensions, CoordType > &point1, const Point< Dimensions, CoordType > &point2)
template<unsigned int Dimensions, class CoordType>
bool operator>= (const Point< Dimensions, CoordType > &point1, const Point< Dimensions, CoordType > &point2)
template<unsigned int Dimensions, class CoordType>
bool operator<= (const Point< Dimensions, CoordType > &point1, const Point< Dimensions, CoordType > &point2)
template<unsigned int Dimensions, class CoordType>
bool isContained (const Point< Dimensions, CoordType > &point, const Point< Dimensions, CoordType > &lower, const Point< Dimensions, CoordType > &upper)
template<class CoordType>
bool isContained (const Point< 2, CoordType > &point, const Point< 2, CoordType > &lower, const Point< 2, CoordType > &upper)
template<class CoordType>
bool isContained (const Point< 3, CoordType > &point, const Point< 3, CoordType > &lower, const Point< 3, CoordType > &upper)

Function Documentation

template<class CoordType>
bool sava::spatial::isContained (  const Point< 3, CoordType > &  point,
const Point< 3, CoordType > &  lower,
const Point< 3, CoordType > &  upper
)  [inline]
 

Definition at line 374 of file Point.h.

template<class CoordType>
bool sava::spatial::isContained (  const Point< 2, CoordType > &  point,
const Point< 2, CoordType > &  lower,
const Point< 2, CoordType > &  upper
)  [inline]
 

Definition at line 364 of file Point.h.

template<unsigned int Dimensions, class CoordType>
bool sava::spatial::isContained (  const Point< Dimensions, CoordType > &  point,
const Point< Dimensions, CoordType > &  lower,
const Point< Dimensions, CoordType > &  upper
)  [inline]
 

Definition at line 350 of file Point.h.

template<unsigned int Dimensions, class CoordType>
bool sava::spatial::operator!= (  const Point< Dimensions, CoordType > &  point1,
const Point< Dimensions, CoordType > &  point2
)  [inline]
 

Definition at line 277 of file Point.h.

template<class CoordType>
bool sava::spatial::operator< (  const Point< 3, CoordType > &  point1,
const Point< 3, CoordType > &  point2
)  [inline]
 

Definition at line 255 of file Point.h.

template<class CoordType>
bool sava::spatial::operator< (  const Point< 2, CoordType > &  point1,
const Point< 2, CoordType > &  point2
)  [inline]
 

Definition at line 231 of file Point.h.

template<unsigned int Dimensions, class CoordType>
bool sava::spatial::operator< (  const Point< Dimensions, CoordType > &  point1,
const Point< Dimensions, CoordType > &  point2
)  [inline]
 

Returns true if there is an index j where point1[i] <= point2[i] and point1[j] < point2[j] for all i <= j, otherwise false.

In other words, the points are ordered lexicographically. This is done only for sorting purposes in STL containers.

Parameters:
point1 The first point to compare.
point2 The second point to compare.
Returns:
true if point1 is lexicographically less than point2, false if not.

Definition at line 185 of file Point.h.

template<unsigned int Dimensions, class CoordType>
bool sava::spatial::operator<= (  const Point< Dimensions, CoordType > &  point1,
const Point< Dimensions, CoordType > &  point2
)  [inline]
 

Definition at line 291 of file Point.h.

template<class CoordType>
bool sava::spatial::operator== (  const Point< 3, CoordType > &  point1,
const Point< 3, CoordType > &  point2
)  [inline]
 

Definition at line 247 of file Point.h.

template<class CoordType>
bool sava::spatial::operator== (  const Point< 2, CoordType > &  point1,
const Point< 2, CoordType > &  point2
)  [inline]
 

Definition at line 224 of file Point.h.

template<unsigned int Dimensions, class CoordType>
bool sava::spatial::operator== (  const Point< Dimensions, CoordType > &  point1,
const Point< Dimensions, CoordType > &  point2
)  [inline]
 

Returns true if each of the coordinates in point1 is equal to its corresponding coordinate in point2, otherwise false.

Parameters:
point1 The first point to compare.
point2 The second point to compare.
Returns:
true if the two points are equal, false if not.

Definition at line 163 of file Point.h.

template<class CoordType>
bool sava::spatial::operator> (  const Point< 3, CoordType > &  point1,
const Point< 3, CoordType > &  point2
)  [inline]
 

Definition at line 266 of file Point.h.

template<class CoordType>
bool sava::spatial::operator> (  const Point< 2, CoordType > &  point1,
const Point< 2, CoordType > &  point2
)  [inline]
 

Definition at line 239 of file Point.h.

template<unsigned int Dimensions, class CoordType>
bool sava::spatial::operator> (  const Point< Dimensions, CoordType > &  point1,
const Point< Dimensions, CoordType > &  point2
)  [inline]
 

Returns true if there is an index j where point1[i] >= point2[i] and point1[j] > point2[j] for all i <= j, otherwise false.

In other words, the points are ordered lexicographically. This is done only for sorting purposes in STL containers.

Parameters:
point1 The first point to compare.
point2 The second point to compare.
Returns:
true if point1 is lexicographically greater than point2, false if not.

Definition at line 210 of file Point.h.

template<unsigned int Dimensions, class CoordType>
bool sava::spatial::operator>= (  const Point< Dimensions, CoordType > &  point1,
const Point< Dimensions, CoordType > &  point2
)  [inline]
 

Definition at line 284 of file Point.h.

Savarese Software Research
Copyright © 2003-2005 Savarese Software Research and Daniel F. Savarese. All rights reserved.