ck_bitmap_next man page

ck_bitmap_next ā€” iterate to the next set bit in bitmap

Library

Concurrency Kit (libck, -lck)

Synopsis

#include <ck_bitmap.h>

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

Description

The ck_bitmap_next() function will increment the iterator object pointed to by iterator to point to the next set bit in the bitmap. If ck_bitmap_next() returns true then the pointer pointed to by bit is initialized to the number of the current set bit pointed to by the iterator object.

It is expected that iterator has been initialized using the ck_bitmap_iterator_init(3) function.

Return Values

If ck_bitmap_next() returns true then the object pointed to by bit contains a set bit. If ck_bitmap_next() returns false then value of the object pointed to by bit is undefined.

Errors

Behavior is undefined if iterator or bitmap are uninitialized.

See Also

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)

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

Referenced By

ck_bitmap_iterator_init(3).

April 27, 2012