Fixed point relative coordinates for a tree domain. More...

#include <d_bin_coordinates.h>

Public Member Functions
template<>
geometry::d_bin_coordinates< 1, 1 >::size_type	branch (d_bin_coordinates< 1, 1 >::size_type xbit) const

template<>
void	put_branch (d_bin_coordinates< 1, 1 >::size_type xbit, d_bin_coordinates< 1, 1 >::size_type xbranch)

template<>
geometry::d_bin_coordinates< 2, 2 >::size_type	branch (d_bin_coordinates< 2, 2 >::size_type xbit) const

template<>
void	put_branch (d_bin_coordinates< 2, 2 >::size_type xbit, d_bin_coordinates< 2, 2 >::size_type xbranch)

template<>
geometry::d_bin_coordinates< 3, 3 >::size_type	branch (d_bin_coordinates< 3, 3 >::size_type xbit) const

template<>
void	put_branch (d_bin_coordinates< 3, 3 >::size_type xbit, d_bin_coordinates< 3, 3 >::size_type xbranch)

template<>
geometry::d_bin_coordinates< 4, 4 >::size_type	branch (d_bin_coordinates< 4, 4 >::size_type xbit) const

template<>
void	put_branch (d_bin_coordinates< 4, 4 >::size_type xbit, d_bin_coordinates< 4, 4 >::size_type xbranch)

template<>
SHEAF_DLL_SPEC d_bin_coordinates< 1, 1 >::size_type	branch (size_type xbit) const

template<>
SHEAF_DLL_SPEC void	put_branch (size_type xbit, size_type xbranch)

template<>
SHEAF_DLL_SPEC d_bin_coordinates< 2, 2 >::size_type	branch (size_type xbit) const

template<>
SHEAF_DLL_SPEC void	put_branch (size_type xbit, size_type xbranch)

template<>
SHEAF_DLL_SPEC d_bin_coordinates< 3, 3 >::size_type	branch (size_type xbit) const

template<>
SHEAF_DLL_SPEC void	put_branch (size_type xbit, size_type xbranch)

template<>
SHEAF_DLL_SPEC d_bin_coordinates< 4, 4 >::size_type	branch (size_type xbit) const

template<>
SHEAF_DLL_SPEC void	put_branch (size_type xbit, size_type xbranch)

D_BIN_COORDINATES FACET
typedef section_evaluator::value_type	value_type
	The type used for floating point coordinates. More...

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

typedef unsigned long long	int_type
	The type used for integer coordinates. More...

	d_bin_coordinates ()
	Default constructor. More...

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

	d_bin_coordinates (const value_type *xcoord)
	Converts xcoord to a d_bin_coordinates. More...

	~d_bin_coordinates ()
	Destructor. More...

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

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

d_bin_coordinates &	operator= (const value_type *xcoord)
	Assignment from value_type. More...

bool	operator== (const d_bin_coordinates< DC, DB > &xother) const
	True if and only if this has the same value as xother. More...

bool	operator== (int_type xother) const
	True if and only if each component of this has the same value as xother. More...

bool	operator< (const d_bin_coordinates< DC, DB > &xother) const
	True if and only if the value of this is less than the value of xother. More...

bool	operator<= (const d_bin_coordinates< DC, DB > &xother) const
	True if and only if the value of this is less than or equal to the value of xother. More...

d_bin_coordinates< DC, DB > &	operator>>= (int xbits)
	Right shift and assignment of this by xbits. More...

d_bin_coordinates &	operator-= (const d_bin_coordinates< DC, DB > &xother)
	Substraction and assignemnt. More...

size_type	branch (size_type xbit) const
	The branch index at bit position xbit. More...

void	put_branch (size_type xbit, size_type xbranch)
	Set the branch index at bit position xbit to xbranch. More...

const int_type *	int_value () const
	The value of this as an int_type. More...

const int_type &	operator[] (size_type xi) const
	The xi-th coordinate of this. More...

int_type &	operator[] (size_type xi)
	The xi-th coordinate of this. More...

static int_type	ub ()
	The upper bound for components. More...

static size_type	bits ()
	The number of bits in a tree coordinate. More...

static size_type	leftmost_bit_id ()
	The index of the leftmost bit. More...

static size_type	rightmost_bit_id ()
	The index of the rightmost bit. More...

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

static size_type	dc ()
	The dimension of the tree this is a coordinate for. More...

Detailed Description

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

Fixed point relative coordinates for a tree domain.

Definition at line 65 of file cylindrical_point_locator.h.

Member Typedef Documentation

◆ int_type

template<int DC, int DB>

typedef unsigned long long geometry::d_bin_coordinates< DC, DB >::int_type

The type used for integer coordinates.

Definition at line 77 of file d_bin_coordinates.h.

◆ size_type

template<int DC, int DB>

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

An unsigned integral type used to represent sizes and capacities.

Definition at line 72 of file d_bin_coordinates.h.

◆ value_type

template<int DC, int DB>

typedef section_evaluator::value_type geometry::d_bin_coordinates< DC, DB >::value_type

The type used for floating point coordinates.

Definition at line 67 of file d_bin_coordinates.h.

Constructor & Destructor Documentation

◆ d_bin_coordinates() [1/3]

template<int DC, int DB>

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

Default constructor.

Postcondition

invariant()

Definition at line 53 of file d_bin_coordinates.impl.h.

Referenced by geometry::d_bin_coordinates< DC, DB >::d_bin_coordinates(), and geometry::d_bin_coordinates< DC, DB >::operator[]().

◆ d_bin_coordinates() [2/3]

template<int DC, int DB>

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

Copy constructor.

Precondition

precondition_of(operator=(xother))

Postcondition

postcondition_of(operator=(xother))

Definition at line 67 of file d_bin_coordinates.impl.h.

References geometry::d_bin_coordinates< DC, DB >::d_bin_coordinates().

◆ d_bin_coordinates() [3/3]

template<int DC, int DB>

geometry::d_bin_coordinates< DC, DB >::d_bin_coordinates ( const value_type * xcoord )

Converts xcoord to a d_bin_coordinates.

Precondition

precondition_of(operator=(xcoord))

Postcondition

postcondition_of(operator=(xcoord))

Definition at line 84 of file d_bin_coordinates.impl.h.

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

◆ ~d_bin_coordinates()

template<int DC, int DB>

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

Destructor.

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

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

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

Member Function Documentation

◆ bits()

template<int DC, int DB>

d_bin_coordinates< DC, DB >::size_type geometry::d_bin_coordinates< DC, DB >::bits ( )

static

The number of bits in a tree coordinate.

Definition at line 322 of file d_bin_coordinates.impl.h.

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

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

◆ branch() [1/5]

template<>

geometry::d_bin_coordinates< 1, 1 >::size_type geometry::d_bin_coordinates< 1, 1 >::branch ( d_bin_coordinates< 1, 1 >::size_type xbit ) const

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

Postcondition

result < degree()

Definition at line 35 of file d_bin_coordinates.cc.

References geometry::d_bin_coordinates< DC, DB >::put_branch().

◆ branch() [2/5]

template<>

geometry::d_bin_coordinates< 2, 2 >::size_type geometry::d_bin_coordinates< 2, 2 >::branch ( d_bin_coordinates< 2, 2 >::size_type xbit ) const

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

Postcondition

result < degree()

Definition at line 86 of file d_bin_coordinates.cc.

References geometry::d_bin_coordinates< DC, DB >::put_branch().

◆ branch() [3/5]

template<>

geometry::d_bin_coordinates< 3, 3 >::size_type geometry::d_bin_coordinates< 3, 3 >::branch ( d_bin_coordinates< 3, 3 >::size_type xbit ) const

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

Postcondition

result < degree()

Definition at line 140 of file d_bin_coordinates.cc.

References geometry::d_bin_coordinates< DC, DB >::put_branch().

◆ branch() [4/5]

template<int DC, int DB>

size_type geometry::d_bin_coordinates< DC, DB >::branch ( size_type xbit ) const

The branch index at bit position xbit.

Not Implemented.

Definition at line 268 of file d_bin_coordinates.impl.h.

References geometry::d_bin_coordinates< DC, DB >::put_branch().

Referenced by geometry::d_bin_coordinates< DC, DB >::operator-=(), and geometry::d_bin_coordinates< DC, DB >::put_branch().

◆ branch() [5/5]

template<>

geometry::d_bin_coordinates< 4, 4 >::size_type geometry::d_bin_coordinates< 4, 4 >::branch ( d_bin_coordinates< 4, 4 >::size_type xbit ) const

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

Postcondition

result < degree()

Definition at line 197 of file d_bin_coordinates.cc.

References geometry::d_bin_coordinates< DC, DB >::put_branch().

◆ dc()

template<int DC, int DB>

size_type geometry::d_bin_coordinates< DC, DB >::dc ( )

static

The dimension of the tree this is a coordinate for.

Definition at line 356 of file d_bin_coordinates.impl.h.

References geometry::d_bin_coordinates< DC, DB >::int_value().

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

◆ degree()

template<int DC, int DB>

size_type geometry::d_bin_coordinates< DC, DB >::degree ( )

static

The degree of the tree this is a coordinate for.

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

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

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

◆ int_value()

template<int DC, int DB>

const d_bin_coordinates< DC, DB >::int_type * geometry::d_bin_coordinates< DC, DB >::int_value ( ) const

The value of this as an int_type.

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

References geometry::d_bin_coordinates< DC, DB >::operator[]().

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

◆ invariant()

template<int DC, int DB>

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

Class invariant.

Invariant

for(int i = ( 0 ); i < ( DC ); ++ i ) int_value()[i] < ub()

Definition at line 107 of file d_bin_coordinates.impl.h.

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

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

◆ leftmost_bit_id()

template<int DC, int DB>

size_type geometry::d_bin_coordinates< DC, DB >::leftmost_bit_id ( )

static

The index of the leftmost bit.

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

References geometry::d_bin_coordinates< DC, DB >::rightmost_bit_id().

Referenced by geometry::d_bin_coordinates< DC, DB >::bits(), geometry::d_tree_point_locator< DC, DB >::max_depth(), and geometry::d_tree_point_locator_path< DC, DB >::max_height().

◆ operator-=()

template<int DC, int DB>

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

Substraction and assignemnt.

Postcondition

invariant()

Definition at line 245 of file d_bin_coordinates.impl.h.

References geometry::d_bin_coordinates< DC, DB >::branch().

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

◆ operator<()

template<int DC, int DB>

bool geometry::d_bin_coordinates< DC, DB >::operator< ( const d_bin_coordinates< DC, DB > & xother ) const

True if and only if the value of this is less than the value of xother.

Definition at line 192 of file d_bin_coordinates.impl.h.

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

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

◆ operator<=()

template<int DC, int DB>

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

True if and only if the value of this is less than or equal to the value of xother.

Definition at line 206 of file d_bin_coordinates.impl.h.

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

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

◆ operator=() [1/2]

template<int DC, int DB>

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

Assignment from d_bin_coordinates.

Postcondition

invariant()

Definition at line 123 of file d_bin_coordinates.impl.h.

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

◆ operator=() [2/2]

template<int DC, int DB>

d_bin_coordinates< DC, DB > & geometry::d_bin_coordinates< DC, DB >::operator= ( const value_type * xcoord )

Assignment from value_type.

Precondition

for(int i = ( 0 ); i < ( DC ); ++ i ) 0.0 <= xcoord[i]

for(int i = ( 0 ); i < ( DC ); ++ i ) floor(xcoord[i]) < ub()

Postcondition

invariant()

Definition at line 140 of file d_bin_coordinates.impl.h.

References fiber_bundle::sec_at0_algebra::floor(), and geometry::d_bin_coordinates< DC, DB >::operator==().

◆ operator==() [1/2]

template<int DC, int DB>

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

True if and only if this has the same value as xother.

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

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

◆ operator==() [2/2]

template<int DC, int DB>

bool geometry::d_bin_coordinates< DC, DB >::operator== ( int_type xother ) const

True if and only if each component of this has the same value as xother.

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

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

◆ operator>>=()

template<int DC, int DB>

d_bin_coordinates< DC, DB > & geometry::d_bin_coordinates< DC, DB >::operator>>= ( int xbits )

Right shift and assignment of this by xbits.

Precondition

xbits < bits()

Postcondition

invariant()

Definition at line 220 of file d_bin_coordinates.impl.h.

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

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

◆ operator[]() [1/2]

template<int DC, int DB>

const d_bin_coordinates< DC, DB >::int_type & geometry::d_bin_coordinates< DC, DB >::operator[] ( size_type xi ) const

The xi-th coordinate of this.

Precondition

xi < DC

Definition at line 372 of file d_bin_coordinates.impl.h.

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

◆ operator[]() [2/2]

template<int DC, int DB>

d_bin_coordinates< DC, DB >::int_type & geometry::d_bin_coordinates< DC, DB >::operator[] ( size_type xi )

The xi-th coordinate of this.

Precondition

xi < DC

Definition at line 386 of file d_bin_coordinates.impl.h.

References geometry::d_bin_coordinates< DC, DB >::d_bin_coordinates().

◆ put_branch() [1/5]

template<>

void geometry::d_bin_coordinates< 1, 1 >::put_branch	(	d_bin_coordinates< 1, 1 >::size_type	xbit,
		d_bin_coordinates< 1, 1 >::size_type	xbranch
	)

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

xbranch < degree()

Postcondition

branch(xbit) == xbranch

Definition at line 59 of file d_bin_coordinates.cc.

References geometry::d_bin_coordinates< DC, DB >::branch().

◆ put_branch() [2/5]

template<>

void geometry::d_bin_coordinates< 2, 2 >::put_branch	(	d_bin_coordinates< 2, 2 >::size_type	xbit,
		d_bin_coordinates< 2, 2 >::size_type	xbranch
	)

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

xbranch < degree()

Postcondition

branch(xbit) == xbranch

Definition at line 111 of file d_bin_coordinates.cc.

References geometry::d_bin_coordinates< DC, DB >::branch().

◆ put_branch() [3/5]

template<int DC, int DB>

void geometry::d_bin_coordinates< DC, DB >::put_branch	(	size_type	xbit,
		size_type	xbranch
	)

Set the branch index at bit position xbit to xbranch.

Not Implemented.

Definition at line 288 of file d_bin_coordinates.impl.h.

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

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

◆ put_branch() [4/5]

template<>

void geometry::d_bin_coordinates< 3, 3 >::put_branch	(	d_bin_coordinates< 3, 3 >::size_type	xbit,
		d_bin_coordinates< 3, 3 >::size_type	xbranch
	)

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

xbranch < degree()

Postcondition

branch(xbit) == xbranch

Definition at line 166 of file d_bin_coordinates.cc.

References geometry::d_bin_coordinates< DC, DB >::branch().

◆ put_branch() [5/5]

template<>

void geometry::d_bin_coordinates< 4, 4 >::put_branch	(	d_bin_coordinates< 4, 4 >::size_type	xbit,
		d_bin_coordinates< 4, 4 >::size_type	xbranch
	)

Precondition

(rightmost_bit_id() <= xbit) && (xbit <= leftmost_bit_id())

xbranch < degree()

Postcondition

branch(xbit) == xbranch

Definition at line 224 of file d_bin_coordinates.cc.

◆ rightmost_bit_id()

template<int DC, int DB>

size_type geometry::d_bin_coordinates< DC, DB >::rightmost_bit_id ( )

static

The index of the rightmost bit.

Definition at line 340 of file d_bin_coordinates.impl.h.

References geometry::d_bin_coordinates< DC, DB >::degree().

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

◆ ub()

template<int DC, int DB>

d_bin_coordinates< DC, DB >::int_type geometry::d_bin_coordinates< DC, DB >::ub ( )

static

The upper bound for components.

Definition at line 308 of file d_bin_coordinates.impl.h.

References geometry::d_bin_coordinates< DC, DB >::bits().

Referenced by geometry::d_bin_coordinates< DC, DB >::put_branch(), geometry::array_cylindrical_point_locator::update_bins(), geometry::d_tree_point_locator< DC, DB >::update_bins(), and geometry::d_array_point_locator< DC, DB >::update_bins().

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

Public Member Functions

D_BIN_COORDINATES FACET

Detailed Description

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

Member Typedef Documentation

◆ int_type

◆ size_type

◆ value_type

Constructor & Destructor Documentation

◆ d_bin_coordinates() [1/3]

◆ d_bin_coordinates() [2/3]

◆ d_bin_coordinates() [3/3]

◆ ~d_bin_coordinates()

Member Function Documentation

◆ bits()

◆ branch() [1/5]

◆ branch() [2/5]

◆ branch() [3/5]

◆ branch() [4/5]

◆ branch() [5/5]

◆ dc()

◆ degree()

◆ int_value()

◆ invariant()

◆ leftmost_bit_id()

◆ operator-=()

◆ operator<()

◆ operator<=()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator==() [1/2]

◆ operator==() [2/2]

◆ operator>>=()

◆ operator[]() [1/2]

◆ operator[]() [2/2]

◆ put_branch() [1/5]

◆ put_branch() [2/5]

◆ put_branch() [3/5]

◆ put_branch() [4/5]

◆ put_branch() [5/5]

◆ rightmost_bit_id()

◆ ub()

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