Template Class t8_search_with_queries

Inheritance Relationships

Base Type

Class Documentation

template<typename Query_T, typename Udata = void>
class t8_search_with_queries : public t8_search<void>

A class that performs a search in a forest with queries. Uses a filter-view to filter out the active queries. It is recommended to use this version of the search if the number of queries is small or if the queries do not need any further computations to be evaluated.

Template Parameters:

  • Query_T – The type of queries

  • Udata – The type of the user data, defaults to void.

Public Functions

inline t8_search_with_queries(t8_search_element_callback<Udata> element_callback, t8_search_query_callback<Query_T, Udata> queries_callback, std::vector<Query_T> &queries, const t8_forest_t forest = nullptr, Udata *user_data = nullptr)

Constructor for the t8_search_with_queries class.

Parameters:

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

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

  • queries – [in] A reference to a vector of queries to be processed.

  • 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_queries(std::vector<Query_T> &queries)

Update the queries for the search.

Parameters:

queries – [in] A reference to a vector of queries to be processed.

inline ~t8_search_with_queries()

Destructor for the t8_search_with_queries class.