#include <hps.h>

Inheritance diagram for HPS::TreeContext:
HPS::Object

Public Member Functions

bool Equals (TreeContext const &in_that) const
 
HPS::Type ObjectType () const
 
bool operator!= (TreeContext const &in_that) const
 
TreeContextoperator= (TreeContext &&in_that)
 
TreeContextoperator= (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 ()
 
- Public Member Functions inherited from HPS::Object
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)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
virtual HPS::Type Type () const
 

Static Public Attributes

static const HPS::Type staticType = HPS::Type::TreeContext
 
- Static Public Attributes inherited from HPS::Object
static const HPS::Type staticType = HPS::Type::None
 

Additional Inherited Members

- Static Public Member Functions inherited from HPS::Object
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

◆ TreeContext() [1/3]

HPS::TreeContext::TreeContext ( bool  in_create = true)

The default constructor creates a new TreeContext object.

Parameters
in_createwhether to create the underlying spatial tree context.

◆ TreeContext() [2/3]

HPS::TreeContext::TreeContext ( TreeContext const &  in_that)

The copy constructor shares a TreeContext object.

Parameters
in_thatThe source TreeContext to share.

◆ TreeContext() [3/3]

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_thatAn rvalue reference to a TreeContext to take the impl from.

◆ ~TreeContext()

virtual HPS::TreeContext::~TreeContext ( )
virtual

The destructor cleans up the tree context created by the constructor.

Member Function Documentation

◆ Equals()

bool HPS::TreeContext::Equals ( TreeContext const &  in_that) const

Check if the source TreeContext is the same as this TreeContext.

Parameters
in_kitThe source TreeContext to compare to this TreeContext.
Returns
true if the objects are identical, false otherwise.

◆ ObjectType()

HPS::Type HPS::TreeContext::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared (if the object is derived, this does not give the true type of the derived object).

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from HPS::Object.

◆ operator!=()

bool HPS::TreeContext::operator!= ( TreeContext const &  in_that) const

Check if the source TreeContext is not the same as this TreeContext.

Parameters
in_kitThe source TreeContext to compare to this TreeContext.
Returns
true if the objects are not identical, false otherwise.

◆ operator=() [1/2]

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_thatAn rvalue reference to a TreeContext to take the impl from.
Returns
A reference to this TreeContext.

◆ operator=() [2/2]

TreeContext& HPS::TreeContext::operator= ( TreeContext const &  in_that)

Shares the source TreeContext.

Parameters
in_kitThe source TreeContext to share.
Returns
A reference to this TreeContext.

◆ operator==()

bool HPS::TreeContext::operator== ( TreeContext const &  in_that) const

Check if the source TreeContext is the same as this TreeContext.

Parameters
in_kitThe 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: