Class t8_search_base

Inheritance Relationships

Derived Types

Class Documentation

class t8_search_base

A base class that performs a search in a forest.

Subclassed by t8_search< void >, t8_search< Udata >

Public Functions

inline t8_search_base(t8_forest_t forest = nullptr)

Constructor for the t8_search_base class.

This constructor initializes a t8_search_base object with the given forest. If the forest is not null, it increments the reference count of the forest and asserts that the forest is committed.

Parameters:

forest – [in] A pointer to a t8_forest_t object. Defaults to nullptr.

inline void update_forest(t8_forest_t forest)

Update the forest for the search.

This function updates the forest for the search. If the current forest is not null, it decrements the reference count of the forest. It then asserts that the new forest is not null and is committed. Finally, it increments the reference count of the new forest.

Parameters:

forest – [in] A pointer to a t8_forest_t object.

inline ~t8_search_base()

Destructor for the t8_search_base class.

This destructor decrements the reference count of the forest if it is not null.

void do_search()

Perform the search.

This function performs the search in the forest.

Public Members

t8_forest_t forest

The forest on which the search is performed.