#include <hps.h>

Public Member Functions | |
bool | Equals (TreeContext const &in_that) const |
HPS::Type | ObjectType () const |
bool | operator!= (TreeContext const &in_that) const |
TreeContext & | operator= (TreeContext &&in_that) |
TreeContext & | operator= (TreeContext const &in_that) |
bool | operator== (TreeContext const &in_that) const |
TreeContext (bool in_create=true) | |
TreeContext (TreeContext const &in_that) | |
TreeContext (TreeContext &&in_that) | |
virtual | ~TreeContext () |
![]() | |
virtual bool | Empty () const |
intptr_t | GetClassID () const |
intptr_t | GetInstanceID () const |
bool | HasType (HPS::Type in_mask) const |
Object (Object const &that) | |
Object (Object &&in_that) | |
Object & | operator= (Object const &other_object) |
Object & | operator= (Object &&in_that) |
virtual void | Reset () |
virtual HPS::Type | Type () const |
Static Public Attributes | |
static const HPS::Type | staticType = HPS::Type::TreeContext |
![]() | |
static const HPS::Type | staticType = HPS::Type::None |
Additional Inherited Members | |
![]() | |
template<typename T > | |
static intptr_t | ClassID () |
Detailed Description
The TreeContext class is a user space object. It contains a spatial partition used for shell selection and shell relation computations. If many such operations will be performed without modifying the segment tree, using the same TreeContext for all of them can be a significant optimization. If a TreeContext is not specified, a new one is computed internally each time.
Constructor & Destructor Documentation
HPS::TreeContext::TreeContext | ( | bool | in_create = true | ) |
The default constructor creates a new TreeContext object.
- Parameters
-
in_create whether to create the underlying spatial tree context.
HPS::TreeContext::TreeContext | ( | TreeContext const & | in_that | ) |
The copy constructor shares a TreeContext object.
- Parameters
-
in_that The source TreeContext to share.
HPS::TreeContext::TreeContext | ( | TreeContext && | in_that | ) |
The move constructor creates a new TreeContext by transferring the underlying impl of the rvalue reference to this TreeContext thereby avoiding a copy and allocation.
- Parameters
-
in_that An rvalue reference to a TreeContext to take the impl from.
|
virtual |
The destructor cleans up the tree context created by the constructor.
Member Function Documentation
bool HPS::TreeContext::Equals | ( | TreeContext const & | in_that | ) | const |
Check if the source TreeContext is the same as this TreeContext.
- Parameters
-
in_kit The source TreeContext to compare to this TreeContext.
- Returns
- true if the objects are identical, false otherwise.
bool HPS::TreeContext::operator!= | ( | TreeContext const & | in_that | ) | const |
Check if the source TreeContext is not the same as this TreeContext.
- Parameters
-
in_kit The source TreeContext to compare to this TreeContext.
- Returns
- true if the objects are not identical, false otherwise.
TreeContext& HPS::TreeContext::operator= | ( | TreeContext && | in_that | ) |
The move assignment operator transfers the underlying impl of the rvalue reference to this TreeContext thereby avoiding a copy.
- Parameters
-
in_that An rvalue reference to a TreeContext to take the impl from.
- Returns
- A reference to this TreeContext.
TreeContext& HPS::TreeContext::operator= | ( | TreeContext const & | in_that | ) |
Shares the source TreeContext.
- Parameters
-
in_kit The source TreeContext to share.
- Returns
- A reference to this TreeContext.
bool HPS::TreeContext::operator== | ( | TreeContext const & | in_that | ) | const |
Check if the source TreeContext is the same as this TreeContext.
- Parameters
-
in_kit The source TreeContext to compare to this TreeContext.
- Returns
- true if the objects are identical, false otherwise.
The documentation for this class was generated from the following file:
- include/hps.h