A path in an d_tree_point_locator search structure. More...

#include <d_tree_point_locator_path.h>

D_TREE_POINT_LOCATOR_PATH FACET
typedef sheaf::size_type	size_type
	An unsigned integral type used to represent sizes and capacities. More...

static const size_type	DEGREE = 1<<DC
	The maximum number of branches at each node. More...

d_tree_point_locator_path< DC, DB > &	operator= (const d_tree_point_locator_path< DC, DB > &xother)
	Assignment operator. More...

virtual bool	invariant () const
	Class invariant. More...

	d_tree_point_locator_path (const d_tree_point_locator_path< DC, DB > &xother)
	Copy constructor. More...

virtual	~d_tree_point_locator_path ()
	Destructor. More...

	d_tree_point_locator_path (const d_bin_coordinates< DC, DB > &xpt, const d_tree_point_locator< DC, DB > *xtree)
	Creates a path for point xpt in tree xtree. More...

	d_tree_point_locator_path (const d_tree_point_locator< DC, DB > *xtree)
	Creates an empty path for tree xtree. More...

size_type	depth () const
	The current depth. More...

size_type	height () const
	The current height. More...

d_tree_point_locator< DC, DB > *	tree () const
	The tree this is a path in. More...

size_type	head () const
	The branch index of the head of the path. More...

void	ascend ()
	Ascend one level in the path. More...

void	descend ()
	Descend one level in the path. More...

void	put_head (size_type xhead)
	Set the current head to xhead. More...

void	reset ()
	Sets depth to 0. More...

bool	intersects (const d_bounding_box< DC, DB > *xbox) const
	True if the tree box represented by the current head intersects the box with lower bound xlb and upper bound xub. More...

const d_bin_coordinates< DC, DB > &	path () const
	The representation of the path. More...

static size_type	max_height ()
	The height of the root of the longest representable path. More...

static size_type	max_depth ()
	The depth of the head of the longest representable path. More...

static size_type	degree ()
	The degree of the tree this is a path for. More...

Detailed Description

template<int DC, int DB>
class geometry::d_tree_point_locator_path< DC, DB >

A path in an d_tree_point_locator search structure.

Definition at line 54 of file d_tree_point_locator_node.h.

Member Typedef Documentation

◆ size_type

template<int DC, int DB>

typedef sheaf::size_type geometry::d_tree_point_locator_path< DC, DB >::size_type

An unsigned integral type used to represent sizes and capacities.

Definition at line 64 of file d_tree_point_locator_path.h.

Constructor & Destructor Documentation

◆ d_tree_point_locator_path() [1/3]

template<int DC, int DB>

geometry::d_tree_point_locator_path< DC, DB >::d_tree_point_locator_path ( const d_tree_point_locator_path< DC, DB > & xother )

Copy constructor.

Definition at line 87 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::~d_tree_point_locator_path().

◆ ~d_tree_point_locator_path()

template<int DC, int DB>

geometry::d_tree_point_locator_path< DC, DB >::~d_tree_point_locator_path ( )

virtual

Destructor.

Definition at line 95 of file d_tree_point_locator_path.impl.h.

Referenced by geometry::d_tree_point_locator_path< DC, DB >::d_tree_point_locator_path().

◆ d_tree_point_locator_path() [2/3]

template<int DC, int DB>

geometry::d_tree_point_locator_path< DC, DB >::d_tree_point_locator_path	(	const d_bin_coordinates< DC, DB > &	xpt,
		const d_tree_point_locator< DC, DB > *	xtree
	)

Creates a path for point xpt in tree xtree.

Postcondition

depth() == 0

tree() == xtree

Definition at line 101 of file d_tree_point_locator_path.impl.h.

◆ d_tree_point_locator_path() [3/3]

template<int DC, int DB>

geometry::d_tree_point_locator_path< DC, DB >::d_tree_point_locator_path ( const d_tree_point_locator< DC, DB > * xtree )

Creates an empty path for tree xtree.

Postcondition

depth() == 0

tree() == xtree

Definition at line 125 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::depth().

Member Function Documentation

◆ ascend()

template<int DC, int DB>

void geometry::d_tree_point_locator_path< DC, DB >::ascend ( )

Ascend one level in the path.

Precondition

depth() > 0

Postcondition

depth() == old_depth - 1

Definition at line 225 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::descend().

Referenced by geometry::d_tree_point_locator_node< DC, DB >::box_list(), geometry::d_tree_point_locator_node< DC, DB >::contains_box(), geometry::d_tree_point_locator_path< DC, DB >::head(), geometry::d_tree_point_locator_node< DC, DB >::insert_box(), and geometry::d_tree_point_locator_node< DC, DB >::remove_box().

◆ degree()

template<int DC, int DB>

sheaf::size_type geometry::d_tree_point_locator_path< DC, DB >::degree ( )

static

The degree of the tree this is a path for.

Definition at line 379 of file d_tree_point_locator_path.impl.h.

Referenced by geometry::d_tree_point_locator_path< DC, DB >::path().

◆ depth()

template<int DC, int DB>

sheaf::size_type geometry::d_tree_point_locator_path< DC, DB >::depth ( ) const

The current depth.

Postcondition

result <= max_depth()

Definition at line 150 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::height().

Referenced by geometry::d_tree_point_locator_node< DC, DB >::box_list(), geometry::d_tree_point_locator_node< DC, DB >::contains_box(), geometry::d_tree_point_locator_path< DC, DB >::d_tree_point_locator_path(), geometry::d_tree_point_locator_node< DC, DB >::insert_box(), and geometry::d_tree_point_locator_node< DC, DB >::remove_box().

◆ descend()

template<int DC, int DB>

void geometry::d_tree_point_locator_path< DC, DB >::descend ( )

Descend one level in the path.

Precondition

depth() < max_depth()

Postcondition

depth() == old_depth + 1

Definition at line 249 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::put_head().

Referenced by geometry::d_tree_point_locator_path< DC, DB >::ascend(), geometry::d_tree_point_locator_node< DC, DB >::box_list(), geometry::d_tree_point_locator_node< DC, DB >::contains_box(), geometry::d_tree_point_locator_node< DC, DB >::insert_box(), and geometry::d_tree_point_locator_node< DC, DB >::remove_box().

◆ head()

template<int DC, int DB>

sheaf::size_type geometry::d_tree_point_locator_path< DC, DB >::head ( ) const

The branch index of the head of the path.

Postcondition

result < DEGREE

Definition at line 203 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::ascend().

Referenced by geometry::d_tree_point_locator_node< DC, DB >::box_list(), and geometry::d_tree_point_locator_path< DC, DB >::tree().

◆ height()

template<int DC, int DB>

sheaf::size_type geometry::d_tree_point_locator_path< DC, DB >::height ( ) const

The current height.

Postcondition

result <= max_height()

Definition at line 164 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::max_height().

Referenced by geometry::d_tree_point_locator_path< DC, DB >::depth(), and geometry::operator<<().

◆ intersects()

template<int DC, int DB>

bool geometry::d_tree_point_locator_path< DC, DB >::intersects ( const d_bounding_box< DC, DB > * xbox ) const

True if the tree box represented by the current head intersects the box with lower bound xlb and upper bound xub.

Precondition

xbox != 0

Definition at line 315 of file d_tree_point_locator_path.impl.h.

References geometry::d_bounding_box< DC, DB >::lb(), geometry::d_tree_point_locator_path< DC, DB >::path(), and geometry::d_bounding_box< DC, DB >::ub().

Referenced by geometry::d_tree_point_locator_node< DC, DB >::contains_box(), geometry::d_tree_point_locator_node< DC, DB >::insert_box(), geometry::d_tree_point_locator_node< DC, DB >::remove_box(), and geometry::d_tree_point_locator_path< DC, DB >::reset().

◆ invariant()

template<int DC, int DB>

bool geometry::d_tree_point_locator_path< DC, DB >::invariant ( ) const

virtual

Class invariant.

Invariant

height() <= max_height()

depth() == max_height() - height()

max_depth() == max_height()

Definition at line 76 of file d_tree_point_locator_path.impl.h.

Referenced by geometry::d_tree_point_locator_path< DC, DB >::operator=().

◆ max_depth()

template<int DC, int DB>

sheaf::size_type geometry::d_tree_point_locator_path< DC, DB >::max_depth ( )

static

The depth of the head of the longest representable path.

Definition at line 187 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::tree().

Referenced by geometry::d_tree_point_locator_path< DC, DB >::max_height().

◆ max_height()

template<int DC, int DB>

sheaf::size_type geometry::d_tree_point_locator_path< DC, DB >::max_height ( )

static

The height of the root of the longest representable path.

Definition at line 178 of file d_tree_point_locator_path.impl.h.

References geometry::d_bin_coordinates< DC, DB >::leftmost_bit_id(), and geometry::d_tree_point_locator_path< DC, DB >::max_depth().

Referenced by geometry::d_tree_point_locator_path< DC, DB >::height().

◆ operator=()

template<int DC, int DB>

d_tree_point_locator_path< DC, DB > & geometry::d_tree_point_locator_path< DC, DB >::operator= ( const d_tree_point_locator_path< DC, DB > & xother )

Assignment operator.

Definition at line 63 of file d_tree_point_locator_path.impl.h.

References geometry::d_tree_point_locator_path< DC, DB >::invariant().