CK_HT_HASH_DIRECT(3)

✨ ck_ht_hash_direct ✨ — the manual page, section 3, bestie edition 💅

okay so you found yourself staring at ck_ht_hash_direct(3) and you're like "what is this, why is this, who is she" — don't worry, I got you. Sit down, hydrate, let's go 🫶

🌸 NAME 🌸

ck_ht_hash_direct — generate a hash value for a hash table 💖

📚 LIBRARY 📚

Concurrency Kit, aka libck, which you link with -lck. Iconic library, no notes 👑

🎀 SYNOPSIS 🎀

#include <ck_ht.h>

void
ck_ht_hash_direct(ck_ht_hash_t *h, ck_ht_t *ht, uintptr_t key);

look at her. three args, zero drama, void return. main character energy fr fr ✨

🦋 DESCRIPTION 🦋

So here's the tea ☕ — ck_ht_hash_direct() generates a hash value and stashes it in the object that h points to. That hash value is valid for use in the hash table that ht points to, for the key you passed in. And key here is of direct type, meaning it's the key itself, not a pointer to it. It's giving "no middleman, we go direct" 💅

That's it. That's the whole function. Lowkey elegant, highkey essential.

💜 RETURN VALUES 💜

ck_ht_hash_direct() has no return value. Nothing. Nada. She's a void girlie — the result goes into h and that's where you go get it 🌈

💀 ERRORS 💀

okay bestie, this is the part where we get serious for a sec 🚨

Behavior is undefined if key is a 0 or UINTPTR_MAX value, or if ht is uninitialized.

UNDEFINED. Not "an error code", not "a warning", not "she'll be a little grumpy" — undefined behavior. Do not pass 0, do not pass UINTPTR_MAX, do not roll up with an uninitialized ht. It's not the vibe. It will never be the vibe. 🙈

👑 SEE ALSO 👑

the whole friend group, in alphabetical-ish order, all of them serving:

• ck_ht_stat(3)
• ck_ht_init(3)
• ck_ht_destroy(3)
• ck_ht_hash(3)
• ck_ht_set_spmc(3)
• ck_ht_put_spmc(3)
• ck_ht_gc(3)
• ck_ht_get_spmc(3)
• ck_ht_grow_spmc(3)
• ck_ht_remove_spmc(3)
• ck_ht_reset_spmc(3)
• ck_ht_reset_size_spmc(3)
• ck_ht_count(3)
• ck_ht_entry_empty(3)
• ck_ht_entry_key_set(3)
• ck_ht_entry_key_set_direct(3)
• ck_ht_entry_key(3)
• ck_ht_entry_key_length(3)
• ck_ht_entry_value(3)
• ck_ht_entry_set(3)
• ck_ht_entry_set_direct(3)
• ck_ht_entry_key_direct(3)
• ck_ht_entry_value_direct(3)
• ck_ht_iterator_init(3)
• ck_ht_next(3)

and if you want even more lore, additional information is available at http://concurrencykit.org/ 🦋

and that's the page!! this one was dated March 29, 2012 and lives as CK_HT_HASH_DIRECT(3) — yeah she's been iconic since 2012 and she's still serving 💖 mwah, go forth and hash responsibly ✨🎀