TreeContext

class TreeContext : public HPS::Object

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.

Public Functions

bool 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.

inline virtual HPS::Type ObjectType() const

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.

bool 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 &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 &operator=(TreeContext const &in_that)

Shares the source TreeContext.

Parameters:

in_kit – The source TreeContext to share.

Returns:

A reference to this TreeContext.

bool 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.

TreeContext(bool in_create = true)

The default constructor creates a new TreeContext object.

Parameters:

in_create – whether to create the underlying spatial tree context.

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.

TreeContext(TreeContext const &in_that)

The copy constructor shares a TreeContext object.

Parameters:

in_that – The source TreeContext to share.

virtual ~TreeContext()

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

Public Static Attributes

static const HPS::Type staticType = HPS::Type::TreeContext