CK_BITMAP_NEXT(3)

💖 CK_BITMAP_NEXT — iterate to the next set bit in bitmap 💖

okay bestie, welcome to the ck_bitmap_next(3) page, she's a lil function from Concurrency Kit and she's here to walk you through your bits one at a time. no cap, this is genuinely one of the most useful lil guys in the whole bitmap family.

📚 LIBRARY

Concurrency Kit — link with libck, so slap a -lck on that compile line and you're golden. 🫶

✨ SYNOPSIS ✨

#include <ck_bitmap.h>

bool
ck_bitmap_next(ck_bitmap_t *bitmap, ck_bitmap_iterator_t iterator,
    unsigned int *bit);

that's the whole vibe. one include, one call, endless possibilities. 💅

🌸 DESCRIPTION 🌸

okay so here's the tea. ck_bitmap_next() takes the iterator object that iterator points to and increments it so it points at the next set bit in the bitmap. she's literally just scooting your iterator along to the next 1. ✨

and if ck_bitmap_next() returns true? then the pointer that bit points to gets initialized to the number of the current set bit that the iterator object is now pointing at. so you get told which bit, not just that there is one. iconic behaviour honestly. 👑

🚨 IMPORTANT SIS: it is expected that iterator has already been initialized using the ck_bitmap_iterator_init(3) function. do not come in here with a raw uninitialized iterator, she will not be nice about it.

🎀 RETURN VALUES 🎀

• if ck_bitmap_next() returns true — the object pointed to by bit contains a set bit. you got one, bestie! 🎉
• if ck_bitmap_next() returns false — the value of the object pointed to by bit is undefined. like, genuinely undefined. don't look at it, don't touch it, don't make it your whole personality. 💀

🙈 ERRORS

behavior is undefined if iterator or bitmap are uninitialized.

that's it, that's the error section. no error codes, no graceful fallback, just vibes and chaos. init your stuff fr fr. 😭

👀 SEE ALSO

your whole bitmap bestie squad, go read them all:

• ck_bitmap_base(3)
• ck_bitmap_size(3)
• ck_bitmap_init(3)
• ck_bitmap_set(3)
• ck_bitmap_reset(3)
• ck_bitmap_clear(3)
• ck_bitmap_bits(3)
• ck_bitmap_buffer(3)
• ck_bitmap_iterator_init(3)

more info also lives at http://concurrencykit.org/ 🌈

and that's a wrap on this lil cutie. she was documented on April 27, 2012 — a true vintage queen — and the footer of this page lowkey calls her CK_BITMAP_TEST(3) which is a whole different function name, but we don't gatekeep, we just note it and move on. 💜 mwah, go iterate something. 🦋