Function t8_element_compare

Function Documentation

int t8_element_compare(const t8_scheme_c *scheme, const t8_eclass_t tree_class, const t8_element_t *elem1, const t8_element_t *elem2)

Compare two elements with respect to the scheme.

Parameters:

  • scheme – [in] The scheme of the forest.

  • tree_class – [in] The eclass of tree the elements are part of.

  • elem1 – [in] The first element.

  • elem2 – [in] The second element.

Returns:

negative if elem1 < elem2, zero if elem1 equals elem2 and positive if elem1 > elem2. If elem2 is a copy of elem1 then the elements are equal.