A bounding box that can be strung together into a list. More...

#include <d_bounding_box.h>

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

CANONICAL FACET
	d_bounding_box ()
	Default constructor. More...

	d_bounding_box (const d_bounding_box< DC, DB > &xbox)
	Copy constructor. More...

d_bounding_box< DC, DB > &	operator= (const d_bounding_box< DC, DB > &xbox)
	Assignment operator. More...

	~d_bounding_box ()
	Destructor. More...

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

bool	operator== (const d_bounding_box< DC, DB > &xbox) const
	Equality operator. More...

D_BOUNDING_BOX FACET
bool	contains_point (const d_bin_coordinates< DC, DB > &xpt) const
	True if this contains point xpt. More...

void	to_stream (std::ostream &xos) const
	Insert this into stream xos. More...

const d_bin_coordinates< DC, DB > &	lb () const
	The lower bound; the lower, left, front corner. More...

void	put_lb (const d_bin_coordinates< DC, DB > &xlb)
	Copies the contents of xlb to lb(). More...

const d_bin_coordinates< DC, DB > &	ub () const
	The upper bound; the upper, right, rear corner. More...

void	put_ub (const d_bin_coordinates< DC, DB > &xub)
	Copies the contents of xub to ub(). More...

const scoped_index &	member_id () const
	Index of the evaluation member this bounds. More...

void	put_member_id (const scoped_index &xid)
	Sets member_id() to xid. More...

const scoped_index &	branch_id () const
	Index of the branch that contains the evaluation member this bounds. More...

void	put_branch_id (const scoped_index &xid)
	Sets branch_id() to xid. More...

section_evaluator *	evaluator () const
	Evaluator for the evaluation member this bounds. More...

void	put_evaluator (section_evaluator *xevaluator)
	Sets evaluator() to xevaluator. More...

size_type	dofs_index () const
	Index into the gathered dofs array for the evaluation member this bounds. More...

void	put_dofs_index (size_type xindex)
	Sets dofs_index() to xindex. More...

size_type	dof_ct () const
	The number of dofs in the gathered dofs array for the evaluation member this bounds. More...

void	put_dof_ct (size_type xct)
	Sets dof_ct() to xct. More...

void	size_pa (d_bin_coordinates< DC, DB > &xresult) const
	The size of each side of the box; pre-allocated. More...

static int	dc ()
	The number of spatial dimensions. More...

Detailed Description

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

A bounding box that can be strung together into a list.

Definition at line 36 of file array_cylindrical_point_locator.h.

Member Typedef Documentation

◆ size_type

template<int DC, int DB>

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

An unsigned integral type used to represent sizes and capacities.

Definition at line 66 of file d_bounding_box.h.

Constructor & Destructor Documentation

◆ d_bounding_box() [1/2]

template<int DC, int DB>

geometry::d_bounding_box< DC, DB >::d_bounding_box ( )

Default constructor.

Postcondition

invariant()

lb() == 0

ub() == 0

!member_id().is_valid()

evaluator() == 0

dofs_index() == 0

dof_ct() == 0

Definition at line 47 of file d_bounding_box.impl.h.

References sheaf::is_valid().

◆ d_bounding_box() [2/2]

template<int DC, int DB>

geometry::d_bounding_box< DC, DB >::d_bounding_box ( const d_bounding_box< DC, DB > & xbox )

Copy constructor.

Postcondition

invariant()

lb() == xbox.lb()

ub() == xbox.ub()

member_id() == xbox.member_id()

evaluator() == xbox.evaluator()

dofs_index() == xbox.dofs_index()

dof_ct() == xbox.dof_ct()

Definition at line 73 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::dof_ct(), geometry::d_bounding_box< DC, DB >::dofs_index(), geometry::d_bounding_box< DC, DB >::evaluator(), geometry::d_bounding_box< DC, DB >::lb(), geometry::d_bounding_box< DC, DB >::member_id(), geometry::d_bounding_box< DC, DB >::operator=(), and geometry::d_bounding_box< DC, DB >::ub().

◆ ~d_bounding_box()

template<int DC, int DB>

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

Destructor.

Definition at line 126 of file d_bounding_box.impl.h.

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

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

Member Function Documentation

◆ branch_id()

template<int DC, int DB>

const scoped_index & geometry::d_bounding_box< DC, DB >::branch_id ( ) const

Index of the branch that contains the evaluation member this bounds.

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

References geometry::d_bounding_box< DC, DB >::put_branch_id().

Referenced by geometry::d_bin_point_locator< DC, DB >::branch_points_at_value(), geometry::cylindrical_point_locator::branch_points_at_value(), and geometry::d_bounding_box< DC, DB >::put_member_id().

◆ contains_point()

template<int DC, int DB>

bool geometry::d_bounding_box< DC, DB >::contains_point ( const d_bin_coordinates< DC, DB > & xpt ) const

True if this contains point xpt.

Postcondition

invariant()

Definition at line 181 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::to_stream().

Referenced by geometry::d_bin_point_locator< DC, DB >::all_points_at_value(), geometry::cylindrical_point_locator::all_points_at_value(), geometry::d_bin_point_locator< DC, DB >::branch_points_at_value(), geometry::cylindrical_point_locator::branch_points_at_value(), geometry::d_bounding_box< DC, DB >::operator==(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), and geometry::cylindrical_point_locator::point_at_value().

◆ dc()

template<int DC, int DB>

int geometry::d_bounding_box< DC, DB >::dc ( )

static

The number of spatial dimensions.

Postcondition

result == DC

Definition at line 467 of file d_bounding_box.impl.h.

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

◆ dof_ct()

template<int DC, int DB>

size_type geometry::d_bounding_box< DC, DB >::dof_ct ( ) const

The number of dofs in the gathered dofs array for the evaluation member this bounds.

Definition at line 414 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::put_dof_ct().

Referenced by geometry::d_bin_point_locator< DC, DB >::all_points_at_value(), geometry::cylindrical_point_locator::all_points_at_value(), geometry::d_bin_point_locator< DC, DB >::branch_points_at_value(), geometry::cylindrical_point_locator::branch_points_at_value(), geometry::d_bounding_box< DC, DB >::d_bounding_box(), geometry::d_bounding_box< DC, DB >::operator=(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), and geometry::d_bounding_box< DC, DB >::put_dofs_index().

◆ dofs_index()

template<int DC, int DB>

size_type geometry::d_bounding_box< DC, DB >::dofs_index ( ) const

Index into the gathered dofs array for the evaluation member this bounds.

Definition at line 381 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::put_dofs_index().

Referenced by geometry::d_bin_point_locator< DC, DB >::all_points_at_value(), geometry::cylindrical_point_locator::all_points_at_value(), geometry::d_bin_point_locator< DC, DB >::branch_points_at_value(), geometry::cylindrical_point_locator::branch_points_at_value(), geometry::d_bounding_box< DC, DB >::d_bounding_box(), geometry::line_surface_intersecter::intersect(), geometry::d_bounding_box< DC, DB >::operator=(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), geometry::d_bounding_box< DC, DB >::put_evaluator(), and geometry::d_bin_point_locator< DC, DB >::update_box().

◆ evaluator()

template<int DC, int DB>

section_evaluator * geometry::d_bounding_box< DC, DB >::evaluator ( ) const

Evaluator for the evaluation member this bounds.

Definition at line 348 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::put_evaluator().

Referenced by geometry::d_bin_point_locator< DC, DB >::all_points_at_value(), geometry::cylindrical_point_locator::all_points_at_value(), geometry::d_bin_point_locator< DC, DB >::branch_points_at_value(), geometry::cylindrical_point_locator::branch_points_at_value(), geometry::d_bounding_box< DC, DB >::d_bounding_box(), geometry::d_bounding_box< DC, DB >::operator=(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), geometry::d_bounding_box< DC, DB >::put_branch_id(), and geometry::d_bin_point_locator< DC, DB >::update_box().

◆ invariant()

template<int DC, int DB>

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

Class invariant.

Definition at line 135 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::operator==().

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

◆ lb()

template<int DC, int DB>

const d_bin_coordinates< DC, DB > & geometry::d_bounding_box< DC, DB >::lb ( ) const

The lower bound; the lower, left, front corner.

Definition at line 226 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::put_lb().

Referenced by geometry::d_array_point_locator< DC, DB >::box_list(), geometry::d_array_point_locator< DC, DB >::contains_box(), geometry::array_cylindrical_point_locator::contains_box(), geometry::d_bounding_box< DC, DB >::d_bounding_box(), geometry::d_array_point_locator< DC, DB >::insert_box(), geometry::array_cylindrical_point_locator::insert_box(), geometry::d_tree_point_locator_path< DC, DB >::intersects(), geometry::d_bounding_box< DC, DB >::operator=(), geometry::array_cylindrical_point_locator::remove_box(), geometry::d_array_point_locator< DC, DB >::remove_box(), and geometry::d_bounding_box< DC, DB >::to_stream().

◆ member_id()

template<int DC, int DB>

const scoped_index & geometry::d_bounding_box< DC, DB >::member_id ( ) const

Index of the evaluation member this bounds.

Definition at line 282 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::put_member_id().

Referenced by geometry::d_bin_point_locator< DC, DB >::all_points_at_value(), geometry::cylindrical_point_locator::all_points_at_value(), geometry::d_bin_point_locator< DC, DB >::branch_points_at_value(), geometry::cylindrical_point_locator::branch_points_at_value(), geometry::d_bounding_box< DC, DB >::d_bounding_box(), geometry::d_bounding_box< DC, DB >::operator=(), geometry::d_bin_point_locator< DC, DB >::point_at_value(), geometry::cylindrical_point_locator::point_at_value(), and geometry::d_bounding_box< DC, DB >::put_ub().

◆ operator=()

template<int DC, int DB>

d_bounding_box< DC, DB > & geometry::d_bounding_box< DC, DB >::operator= ( const d_bounding_box< DC, DB > & xbox )

Assignment operator.

Postcondition

invariant()

lb() == xbox.lb()

ub() == xbox.ub()

member_id() == xbox.member_id()

evaluator() == xbox.evaluator()

dofs_index() == xbox.dofs_index()

dof_ct() == xbox.dof_ct()

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

References geometry::d_bounding_box< DC, DB >::dof_ct(), geometry::d_bounding_box< DC, DB >::dofs_index(), geometry::d_bounding_box< DC, DB >::evaluator(), geometry::d_bounding_box< DC, DB >::lb(), geometry::d_bounding_box< DC, DB >::member_id(), geometry::d_bounding_box< DC, DB >::ub(), and geometry::d_bounding_box< DC, DB >::~d_bounding_box().

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

◆ operator==()

template<int DC, int DB>

bool geometry::d_bounding_box< DC, DB >::operator== ( const d_bounding_box< DC, DB > & xbox ) const

Equality operator.

Postcondition

invariant()

Definition at line 146 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::contains_point().

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

◆ put_branch_id()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::put_branch_id ( const scoped_index & xid )

Sets branch_id() to xid.

Postcondition

branch_id() == xid

Definition at line 331 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::evaluator().

Referenced by geometry::d_bin_point_locator< DC, DB >::assign_box(), geometry::d_bounding_box< DC, DB >::branch_id(), geometry::cylindrical_point_locator::make_quad_bounding_box(), geometry::cylindrical_point_locator::make_triangle_bounding_box(), and geometry::d_bin_point_locator< DC, DB >::update().

◆ put_dof_ct()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::put_dof_ct ( size_type xct )

Sets dof_ct() to xct.

Postcondition

dof_ct() == xct

Definition at line 430 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::size_pa().

Referenced by geometry::d_bin_point_locator< DC, DB >::assign_box(), geometry::d_bounding_box< DC, DB >::dof_ct(), geometry::cylindrical_point_locator::make_quad_bounding_box(), geometry::cylindrical_point_locator::make_triangle_bounding_box(), and geometry::d_bin_point_locator< DC, DB >::update().

◆ put_dofs_index()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::put_dofs_index ( size_type xindex )

Sets dofs_index() to xindex.

Postcondition

dofs_index() == xindex

Definition at line 397 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::dof_ct().

Referenced by geometry::d_bin_point_locator< DC, DB >::assign_box(), geometry::d_bounding_box< DC, DB >::dofs_index(), geometry::cylindrical_point_locator::make_quad_bounding_box(), geometry::cylindrical_point_locator::make_triangle_bounding_box(), and geometry::d_bin_point_locator< DC, DB >::update().

◆ put_evaluator()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::put_evaluator ( section_evaluator * xevaluator )

Sets evaluator() to xevaluator.

Postcondition

evaluator() == xevaluator

Definition at line 364 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::dofs_index().

Referenced by geometry::d_bin_point_locator< DC, DB >::assign_box(), geometry::d_bounding_box< DC, DB >::evaluator(), geometry::cylindrical_point_locator::make_quad_bounding_box(), geometry::cylindrical_point_locator::make_triangle_bounding_box(), and geometry::d_bin_point_locator< DC, DB >::update().

◆ put_lb()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::put_lb ( const d_bin_coordinates< DC, DB > & xlb )

Copies the contents of xlb to lb().

Postcondition

lb() == xlb

Definition at line 234 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::ub().

Referenced by geometry::d_bin_point_locator< DC, DB >::assign_box(), geometry::line_surface_intersecter::intersect(), geometry::d_bounding_box< DC, DB >::lb(), geometry::cylindrical_point_locator::make_quad_bounding_box(), geometry::cylindrical_point_locator::make_triangle_bounding_box(), geometry::d_bin_point_locator< DC, DB >::update(), and geometry::d_bin_point_locator< DC, DB >::update_box().

◆ put_member_id()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::put_member_id ( const scoped_index & xid )

Sets member_id() to xid.

Postcondition

member_id() == xid

Definition at line 298 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::branch_id().

Referenced by geometry::d_bin_point_locator< DC, DB >::assign_box(), geometry::cylindrical_point_locator::make_quad_bounding_box(), geometry::cylindrical_point_locator::make_triangle_bounding_box(), geometry::d_bounding_box< DC, DB >::member_id(), and geometry::d_bin_point_locator< DC, DB >::update().

◆ put_ub()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::put_ub ( const d_bin_coordinates< DC, DB > & xub )

Copies the contents of xub to ub().

Postcondition

ub() == xub

Definition at line 262 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::member_id().

Referenced by geometry::d_bin_point_locator< DC, DB >::assign_box(), geometry::line_surface_intersecter::intersect(), geometry::cylindrical_point_locator::make_quad_bounding_box(), geometry::cylindrical_point_locator::make_triangle_bounding_box(), geometry::d_bounding_box< DC, DB >::ub(), geometry::d_bin_point_locator< DC, DB >::update(), and geometry::d_bin_point_locator< DC, DB >::update_box().

◆ size_pa()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::size_pa ( d_bin_coordinates< DC, DB > & xresult ) const

The size of each side of the box; pre-allocated.

Definition at line 447 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::dc().

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

◆ to_stream()

template<int DC, int DB>

void geometry::d_bounding_box< DC, DB >::to_stream ( std::ostream & xos ) const

Insert this into stream xos.

Postcondition

invariant()

Definition at line 201 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::lb().

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

◆ ub()

template<int DC, int DB>

const d_bin_coordinates< DC, DB > & geometry::d_bounding_box< DC, DB >::ub ( ) const

The upper bound; the upper, right, rear corner.

Definition at line 254 of file d_bounding_box.impl.h.

References geometry::d_bounding_box< DC, DB >::put_ub().

Referenced by geometry::d_array_point_locator< DC, DB >::box_list(), geometry::d_bounding_box< DC, DB >::d_bounding_box(), geometry::d_array_point_locator< DC, DB >::insert_box(), geometry::array_cylindrical_point_locator::insert_box(), geometry::d_tree_point_locator_path< DC, DB >::intersects(), geometry::d_bounding_box< DC, DB >::operator=(), geometry::d_bounding_box< DC, DB >::put_lb(), geometry::array_cylindrical_point_locator::remove_box(), and geometry::d_array_point_locator< DC, DB >::remove_box().

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

Public Types

CANONICAL FACET

D_BOUNDING_BOX FACET

Detailed Description

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

Member Typedef Documentation

◆ size_type

Constructor & Destructor Documentation

◆ d_bounding_box() [1/2]

◆ d_bounding_box() [2/2]

◆ ~d_bounding_box()

Member Function Documentation

◆ branch_id()

◆ contains_point()

◆ dc()

◆ dof_ct()

◆ dofs_index()

◆ evaluator()

◆ invariant()

◆ lb()

◆ member_id()

◆ operator=()

◆ operator==()

◆ put_branch_id()

◆ put_dof_ct()

◆ put_dofs_index()

◆ put_evaluator()

◆ put_lb()

◆ put_member_id()

◆ put_ub()

◆ size_pa()

◆ to_stream()

◆ ub()

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