CK_HS_GC(3)

💖 CK_HS_GC(3) — ck_hs_gc 💖

okay bestie, welcome to the CK_HS_GC(3) page, aka the one where we give our hash set a lil spa day ✨ this lives in the Concurrency Kit library, so you'll be linking with libck, i.e. -lck. yes she's that girl. 🎀

🌸 LIBRARY 🌸

Concurrency Kit — link it with libck, or -lck if you're being fancy at the command line. 💅

✨ SYNOPSIS ✨

#include <ck_hs.h>

bool
ck_hs_gc(ck_hs_t *hs, unsigned long cycles, unsigned long seed);

that's it. that's the whole vibe check. she takes three args and gives you back a bool. 🫶

🧚 DESCRIPTION 🧚

so like, ck_hs_gc(3) is the maintenance function — it does a bunch of upkeep routines on the hash set that hs points at, no cap. what kind of upkeep, you ask? 👀

• defragmentation of probe sequences with respect to tombstones (yes, tombstones, very gothic of her 💀), and
• if the delete workload hint has been passed, recalculation of probe sequence bounds.

now let's talk about the args, because they matter fr fr:

• cycles — tells her how many hash set entries should be subject to attempted maintenance. and listen, if cycles is 0, then maintenance happens on the complete hash set. the whole thing. every last entry. periodt.
• seed — this one decides the start location of the maintenance process. if cycles is non-zero, it is recommended that seed is some random value. like, please randomize her, she deserves it. 🎲

⚠️ important heads up: if the delete hint has been passed, the function will require an additional 12% of memory (with respect to the existing memory usage of the set) until operation completion. so she's hungry. feed her. 😭

🦋 RETURN VALUES 🦋

when everything goes well, ck_hs_gc(3) returns true 👑 and if it doesn't, it returns false on failure due to memory allocation failure. that's the whole story, bestie. 💜

🍓 ERRORS 🍓

this function will only return false if there are internal memory allocation failures. that's it. that's the only way she fumbles. 🙈

🌈 SEE ALSO 🌈

the whole friend group, obviously — go read these too:

• ck_hs_init(3)
• ck_hs_move(3)
• ck_hs_destroy(3)
• CK_HS_HASH(3)
• ck_hs_iterator_init(3)
• ck_hs_next(3)
• ck_hs_get(3)
• ck_hs_put(3)
• ck_hs_put_unique(3)
• ck_hs_grow(3)
• ck_hs_rebuild(3)
• ck_hs_set(3)
• ck_hs_fas(3)
• ck_hs_remove(3)
• ck_hs_count(3)
• ck_hs_reset(3)
• ck_hs_reset_size(3)
• ck_hs_stat(3)

Additional information available at http://concurrencykit.org/ 🌐

and that's a wrap, my love 💖 this page is dated December 17, 2013, and it's page CK_HS_GC(3) — she's been iconic since 2013 and she's still serving. go defrag something. slay. 💅✨🦋🌸