phdmesh::OctTreeKey Class Reference

List of all members.

Detailed Description

Definition at line 50 of file OctTree.hpp.

Public Types

typedef unsigned value_type
 MaxDepth = 16
 MaskIndex = 0x0f
 BitsPerIndex = 4
 BitsPerWord = std::numeric_limits<value_type>::digits
 IndexPerWord = BitsPerWord / BitsPerIndex
 NWord = MaxDepth / IndexPerWord
 OKBits = StaticAssert< 0 == BitsPerWord % BitsPerIndex >::OK
 OKWord = StaticAssert< 0 == MaxDepth % IndexPerWord >::OK
enum  { MaxDepth = 16 }
enum  { MaskIndex = 0x0f }
enum  { BitsPerIndex = 4 }
enum  { BitsPerWord = std::numeric_limits<value_type>::digits }
enum  { IndexPerWord = BitsPerWord / BitsPerIndex }
enum  { NWord = MaxDepth / IndexPerWord }
enum  { OKBits = StaticAssert< 0 == BitsPerWord % BitsPerIndex >::OK }
enum  { OKWord = StaticAssert< 0 == MaxDepth % IndexPerWord >::OK }

Public Member Functions

 OctTreeKey ()
 OctTreeKey (const OctTreeKey &k)
OctTreeKeyoperator= (const OctTreeKey &k)
bool operator== (const OctTreeKey &k) const
bool operator!= (const OctTreeKey &k) const
bool operator< (const OctTreeKey &k) const
unsigned depth () const
template<unsigned Depth>
unsigned index () const
unsigned index (const unsigned Depth) const
template<unsigned D>
OctTreeKeyclear_index ()
OctTreeKeyclear_index (const unsigned Depth)
template<unsigned D>
OctTreeKeyset_index (const unsigned)
OctTreeKeyset_index (const unsigned Depth, const unsigned)
OctTreeKeyclear ()
OctTreeKeyset_maximum ()
const value_typevalue () const
OctTreeKeyset_value (const value_type *)
bool intersect (const OctTreeKey &k) const


Member Function Documentation

unsigned phdmesh::OctTreeKey::depth (  )  const

Query depth of this key

template<unsigned Depth>
unsigned phdmesh::OctTreeKey::index (  )  const [inline]

Index of the key at the depth [1..8] A zero value indicates it is not defined at that depth.

Definition at line 170 of file OctTree.hpp.

unsigned phdmesh::OctTreeKey::index ( const unsigned  Depth  )  const

Index of the key at depth

template<unsigned Depth>
OctTreeKey & phdmesh::OctTreeKey::clear_index (  )  [inline]

Clear index at depth

Definition at line 181 of file OctTree.hpp.

OctTreeKey& phdmesh::OctTreeKey::clear_index ( const unsigned  Depth  ) 

Clear index at depth

template<unsigned Depth>
OctTreeKey & phdmesh::OctTreeKey::set_index ( const   unsigned  )  [inline]

Set index at depth, range is [1..8]

Definition at line 196 of file OctTree.hpp.

OctTreeKey& phdmesh::OctTreeKey::set_index ( const unsigned  Depth,
const   unsigned 
)

Set index at depth

OctTreeKey& phdmesh::OctTreeKey::clear (  ) 

Clear the value (root node)

OctTreeKey& phdmesh::OctTreeKey::set_maximum (  ) 

Set to the maximum value

const value_type* phdmesh::OctTreeKey::value (  )  const [inline]

Query raw value

Definition at line 113 of file OctTree.hpp.

OctTreeKey& phdmesh::OctTreeKey::set_value ( const value_type  ) 

Set raw value

bool phdmesh::OctTreeKey::intersect ( const OctTreeKey k  )  const

Intersects if either key contains the other.


The documentation for this class was generated from the following file:
Generated on Tue Jul 13 09:22:43 2010 for phdMesh by  doxygen 1.4.7