Template Struct t8_search

• Defined in File t8_forest_search.hxx

Inheritance Relationships

Base Type

• public t8_search_base (Struct t8_search_base)

Struct Documentation

template<typename Udata = void>
struct t8_search : public t8_search_base

A class that performs a search in a forest.

Template Parameters:

Udata – The type of user data to be used in the search.

Public Functions

inline t8_search(t8_search_element_callback<Udata> element_callback, t8_forest_t forest = nullptr, Udata *user_data = nullptr)

Constructor for the t8_search class.

Parameters:

• element_callback – [in] A callback function to be called for each element during the search.

• forest – [in] A pointer to the forest to be searched. Defaults to nullptr

• user_data – [in] A pointer to user-defined data to be passed to the callback function. Defaults to nullptr.

inline void update_user_data(Udata *udata)

Updates the user data associated with the object.

This function sets the user data pointer to the provided Udata object.

Parameters:

udata – [in] A pointer to the Udata object to be set as the user data.

virtual ~t8_search() = default

Destructor for the t8_search class.

Public Members

Udata *user_data

The user data associated with the object.