sys: Add Disjoint-set (union-find) data structure #93300
Conversation
rruuaanng
changed the title
| #include <stdint.h> | ||
|
|
||
| /** | ||
| * @brief Disjoint-set node structure |
There was a problem hiding this comment.
As this is part of sys directory, what about adding sys prefix to make it clear what the name space is. So I propose that these are called sys_uf_...
There was a problem hiding this comment.
or maybe sys_set_*? uf is not very descriptive on its purpose.
There was a problem hiding this comment.
I got the idea for the name from this:
zephyr/include/zephyr/sys/rb.h
Lines 119 to 127 in 413b789
There was a problem hiding this comment.
IIRC, that's before we started adding namespace for various subsys. You can grep and see that most under sys/ has sys_ prefix.
As for naming with set instead of uf, we may add other set operations in the future (e.g. difference and subtraction) so that naming should not be restrictive.
rruuaanng
force-pushed
the
add-uf
branch
2 times, most recently
from
f37ab3c to
8583e82
Compare
Add a set of Disjoint-set functions (`find`, `union`) to handle queries between sets. Signed-off-by: James Roy <[email protected]>
Add unit tests for functions (`uf_makeset`, `uf_union` and `uf_find`). Signed-off-by: James Roy <[email protected]>
|
| /** | ||
| * @brief Initialize a disjoint-set. | ||
| */ | ||
| static inline void uf_makeset(struct uf_node *node) | ||
| { | ||
| node->parent = node; | ||
| node->rank = 0; | ||
| } | ||
|
|
||
| /** | ||
| * @brief Find the root of the disjoint-set. | ||
| */ | ||
| struct uf_node *uf_find(struct uf_node *node); | ||
|
|
||
| /** | ||
| * @brief Merge two nodes into the same disjoint-set. | ||
| */ | ||
| void uf_union(struct uf_node *node1, struct uf_node *node2); |
There was a problem hiding this comment.
Needs full Doxygen comments, including parameters and return values
| * Add a set of Disjoint-set functions (:c:func:`uf_find`, :c:func:`uf_union`) to | ||
| handle queries between sets. They are declared in :zephyr_file:`include/zephyr/sys/uf.h`. |
There was a problem hiding this comment.
| * Add a set of Disjoint-set functions (:c:func:`uf_find`, :c:func:`uf_union`) to | |
| handle queries between sets. They are declared in :zephyr_file:`include/zephyr/sys/uf.h`. | |
| * :c:struct:`uf_node` | |
| * :c:func:`uf_makeset` | |
| * :c:func:`uf_find` | |
| * :c:func:`uf_union` |
| */ | ||
| struct uf_node { | ||
| /** @cond INTERNAL_HIDDEN */ | ||
| struct uf_node *parent; |
There was a problem hiding this comment.
This looks suspiciously like an slist, no? Not like linked list handling is that big a deal, but every byte of code savings helps.
Add a set of Disjoint-set functions (
find,union) to handle queries between sets.