Simple bitset

Simple bitset. More...

Collaboration diagram for Simple bitset:

Data Structures
struct	bitset_t
	a bitset More...

Macros
#define	CT_BITSET_ARRAY(arr)   { sizeof(arr), arr }

Functions
CT_NODISCARD CT_BASE_API bitset_t	bitset_of (STA_READS(words) void *data, size_t words)
	create a bitset from a buffer More...
CT_NODISCARD CT_BASE_API size_t	bitset_set_first (bitset_t set, size_t start)
	scan for the next free bit and set it More...
CT_PUREFN CT_BASE_API bool	bitset_any (bitset_t set, bitset_t mask)
	test if any bits in a given mask are set More...
CT_PUREFN CT_BASE_API bool	bitset_all (bitset_t set, bitset_t mask)
	test if all bits in a given mask are set More...
CT_PUREFN CT_BASE_API bool	bitset_test (bitset_t set, size_t index)
	test if a bit is set More...
CT_BASE_API void	bitset_set (bitset_t set, size_t index)
	set a bit More...
CT_BASE_API void	bitset_clear (bitset_t set, size_t index)
	clear a bit More...
CT_BASE_API void	bitset_reset (bitset_t set)
	reset all bits in a bitset More...
CT_PUREFN CT_BASE_API size_t	bitset_len (bitset_t set)
	get the number of bits in a bitset More...

Detailed Description

Simple bitset.

Macro Definition Documentation

CT_BITSET_ARRAY

#define CT_BITSET_ARRAY

(

arr

)

{ sizeof(arr), arr }

Definition at line 31 of file bitset.h.

Function Documentation

bitset_all()

CT_PUREFN CT_BASE_API bool bitset_all	(	bitset_t	set,
		bitset_t	mask
	)

test if all bits in a given mask are set

Parameters

set	the bitset to test
mask	the mask to test

Returns

true if all bits in the mask are set

Definition at line 100 of file bitset.c.

bitset_any()

CT_PUREFN CT_BASE_API bool bitset_any	(	bitset_t	set,
		bitset_t	mask
	)

test if any bits in a given mask are set

Parameters

set	the bitset to test
mask	the mask to test

Returns

true if any bits in the mask are set

Definition at line 82 of file bitset.c.

bitset_clear()

CT_BASE_API void bitset_clear	(	bitset_t	set,
		size_t	index
	)

clear a bit

Parameters

set	the bitset to modify
index	the index of the bit to clear

Definition at line 138 of file bitset.c.

bitset_len()

CT_PUREFN CT_BASE_API size_t bitset_len

(

bitset_t

set

)

get the number of bits in a bitset

Parameters

set	the bitset to get the length of

Returns

the number of bits in the bitset

Definition at line 154 of file bitset.c.

bitset_of()

CT_NODISCARD CT_BASE_API bitset_t bitset_of	(	STA_READS(words) void *	data,
		size_t	words
	)

create a bitset from a buffer

Precondition

data is not NULL

words > 0

Parameters

data	the buffer to use for the bitset
words	the number of bytes in the buffer

Returns

the new bitset

bitset_reset()

CT_BASE_API void bitset_reset

(

bitset_t

set

)

reset all bits in a bitset

Parameters

set	the bitset to reset

Definition at line 148 of file bitset.c.

bitset_set()

CT_BASE_API void bitset_set	(	bitset_t	set,
		size_t	index
	)

set a bit

Parameters

set	the bitset to modify
index	the index of the bit to set

Definition at line 128 of file bitset.c.

bitset_set_first()

CT_NODISCARD CT_BASE_API size_t bitset_set_first	(	bitset_t	set,
		size_t	start
	)

scan for the next free bit and set it

Parameters

set	the bitset to scan
start	the index to start scanning from

Returns

the index of the next free bit, or SIZE_MAX if none are free

Definition at line 55 of file bitset.c.

bitset_test()

CT_PUREFN CT_BASE_API bool bitset_test	(	bitset_t	set,
		size_t	index
	)

test if a bit is set

Parameters

set	the bitset to test
index	the index of the bit to test

Returns

true if the bit is set

Definition at line 118 of file bitset.c.