flat_bitset.h

Go to the documentation of this file.

 
#ifndef CCC_FLAT_BITSET_H
#define CCC_FLAT_BITSET_H
 
#include <stddef.h>
#include <stdint.h>
#include "private/private_flat_bitset.h"
#include "types.h" /* IWYU pragma: export */
 
typedef uint8_t CCC_Bit;
 
typedef struct CCC_Flat_bitset CCC_Flat_bitset;
 
enum : size_t {
    CCC_FLAT_BITSET_BLOCK_BITS = CCC_PRIVATE_FLAT_BITSET_BLOCK_BITS,
};
 
#define CCC_flat_bitset_block_count(bit_capacity)                              \
    CCC_private_flat_bitset_block_count(bit_capacity)
 
#define CCC_flat_bitset_block_bytes(bit_capacity)                              \
    CCC_private_flat_bitset_block_bytes(bit_capacity)
 
#define CCC_flat_bitset_default() CCC_private_flat_bitset_default()
 
#define CCC_flat_bitset_with_storage(                                          \
    count, compound_literal_array, optional_storage_specifier...               \
)                                                                              \
    CCC_private_flat_bitset_with_storage(                                      \
        count, compound_literal_array, optional_storage_specifier              \
    )
 
#define CCC_flat_bitset_from(                                                  \
    allocator,                                                                 \
    start_string_index,                                                        \
    count,                                                                     \
    bit_on_char,                                                               \
    input_string,                                                              \
    optional_capacity...                                                       \
)                                                                              \
    CCC_private_flat_bitset_from(                                              \
        allocator,                                                             \
        start_string_index,                                                    \
        count,                                                                 \
        bit_on_char,                                                           \
        input_string,                                                          \
        optional_capacity                                                      \
    )
 
#define CCC_flat_bitset_with_capacity(allocator, capacity, optional_count...)  \
    CCC_private_flat_bitset_with_capacity(allocator, capacity, optional_count)
 
#define CCC_flat_bitset_storage_for(                                           \
    bit_compound_literal_array, optional_storage_specifier...                  \
)                                                                              \
    CCC_private_flat_bitset_storage_for(                                       \
        bit_compound_literal_array, optional_storage_specifier                 \
    )
 
#define CCC_flat_bitset_for(cap, count, bitblock_pointer...)                   \
    CCC_private_flat_bitset_for(cap, count, bitblock_pointer)
 
CCC_Result CCC_flat_bitset_copy(
    CCC_Flat_bitset *destination,
    CCC_Flat_bitset const *source,
    CCC_Allocator const *allocator
);
 
CCC_Result CCC_flat_bitset_reserve(
    CCC_Flat_bitset *bitset, size_t to_add, CCC_Allocator const *allocator
);
 
CCC_Tribool CCC_flat_bitset_test(CCC_Flat_bitset const *bitset, size_t index);
 
CCC_Tribool
CCC_flat_bitset_set(CCC_Flat_bitset *bitset, size_t index, CCC_Tribool bit);
 
CCC_Result CCC_flat_bitset_set_all(CCC_Flat_bitset *bitset, CCC_Tribool bit);
 
CCC_Result CCC_flat_bitset_set_range(
    CCC_Flat_bitset *bitset,
    size_t range_start_index,
    size_t range_bit_count,
    CCC_Tribool bit
);
 
CCC_Tribool CCC_flat_bitset_reset(CCC_Flat_bitset *bitset, size_t index);
 
CCC_Result CCC_flat_bitset_reset_all(CCC_Flat_bitset *bitset);
 
CCC_Result CCC_flat_bitset_reset_range(
    CCC_Flat_bitset *bitset, size_t range_start_index, size_t range_bit_count
);
 
CCC_Tribool CCC_flat_bitset_flip(CCC_Flat_bitset *bitset, size_t index);
 
CCC_Result CCC_flat_bitset_flip_all(CCC_Flat_bitset *bitset);
 
CCC_Result CCC_flat_bitset_flip_range(
    CCC_Flat_bitset *bitset, size_t range_start_index, size_t range_bit_count
);
 
CCC_Tribool CCC_flat_bitset_any(CCC_Flat_bitset const *bitset);
 
CCC_Tribool CCC_flat_bitset_any_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count
);
 
CCC_Tribool CCC_flat_bitset_none(CCC_Flat_bitset const *bitset);
 
CCC_Tribool CCC_flat_bitset_none_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count
);
 
CCC_Tribool CCC_flat_bitset_all(CCC_Flat_bitset const *bitset);
 
CCC_Tribool CCC_flat_bitset_all_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count
);
 
CCC_Count CCC_flat_bitset_first_trailing_one(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_first_trailing_one_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count
);
 
CCC_Count CCC_flat_bitset_first_trailing_ones(
    CCC_Flat_bitset const *bitset, size_t ones_count
);
 
CCC_Count CCC_flat_bitset_first_trailing_ones_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count,
    size_t ones_count
);
 
CCC_Count CCC_flat_bitset_first_trailing_zero(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_first_trailing_zero_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count
);
 
CCC_Count CCC_flat_bitset_first_trailing_zeros(
    CCC_Flat_bitset const *bitset, size_t zeros_count
);
 
CCC_Count CCC_flat_bitset_first_trailing_zeros_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count,
    size_t zeros_count
);
 
CCC_Count CCC_flat_bitset_first_leading_one(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_first_leading_one_range(
    CCC_Flat_bitset const *bitset, size_t index, size_t count
);
 
CCC_Count CCC_flat_bitset_first_leading_ones(
    CCC_Flat_bitset const *bitset, size_t ones_count
);
 
CCC_Count CCC_flat_bitset_first_leading_ones_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count,
    size_t ones_count
);
 
CCC_Count CCC_flat_bitset_first_leading_zero(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_first_leading_zero_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count
);
 
CCC_Count CCC_flat_bitset_first_leading_zeros(
    CCC_Flat_bitset const *bitset, size_t zeros_count
);
 
CCC_Count CCC_flat_bitset_first_leading_zeros_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count,
    size_t zeros_count
);
 
CCC_Result
CCC_flat_bitset_or(CCC_Flat_bitset *destination, CCC_Flat_bitset const *source);
 
CCC_Result CCC_flat_bitset_and(
    CCC_Flat_bitset *destination, CCC_Flat_bitset const *source
);
 
CCC_Result CCC_flat_bitset_xor(
    CCC_Flat_bitset *destination, CCC_Flat_bitset const *source
);
 
CCC_Result
CCC_flat_bitset_shift_left(CCC_Flat_bitset *bitset, size_t left_shifts);
 
CCC_Result
CCC_flat_bitset_shift_right(CCC_Flat_bitset *bitset, size_t right_shifts);
 
CCC_Tribool CCC_flat_bitset_is_equal(
    CCC_Flat_bitset const *left, CCC_Flat_bitset const *right
);
 
CCC_Tribool CCC_flat_bitset_is_proper_subset(
    CCC_Flat_bitset const *subset, CCC_Flat_bitset const *set
);
 
CCC_Tribool CCC_flat_bitset_is_subset(
    CCC_Flat_bitset const *subset, CCC_Flat_bitset const *set
);
 
void *CCC_flat_bitset_data(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_capacity(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_count(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_blocks_capacity(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_blocks_count(CCC_Flat_bitset const *bitset);
 
CCC_Tribool CCC_flat_bitset_is_empty(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_popcount(CCC_Flat_bitset const *bitset);
 
CCC_Count CCC_flat_bitset_popcount_range(
    CCC_Flat_bitset const *bitset,
    size_t range_start_index,
    size_t range_bit_count
);
 
CCC_Result CCC_flat_bitset_clear(CCC_Flat_bitset *bitset);
 
CCC_Result CCC_flat_bitset_clear_and_free(
    CCC_Flat_bitset *bitset, CCC_Allocator const *allocator
);
 
CCC_Result CCC_flat_bitset_push_back(
    CCC_Flat_bitset *bitset, CCC_Tribool bit, CCC_Allocator const *allocator
);
 
CCC_Tribool CCC_flat_bitset_pop_back(CCC_Flat_bitset *bitset);
 
#ifdef FLAT_BITSET_USING_NAMESPACE_CCC
/* NOLINTBEGIN(readability-identifier-naming) */
typedef CCC_Bit Bit;
typedef CCC_Flat_bitset Flat_bitset;
#    define FLAT_BITSET_BLOCK_BITS CCC_FLAT_BITSET_BLOCK_BITS
#    define flat_bitset_block_count(arguments...)                              \
        CCC_flat_bitset_block_count(arguments)
#    define flat_bitset_block_bytes(arguments...)                              \
        CCC_flat_bitset_block_bytes(arguments)
#    define flat_bitset_storage_for(arguments...)                              \
        CCC_flat_bitset_storage_for(arguments)
#    define flat_bitset_default(arguments...) CCC_flat_bitset_default(arguments)
#    define flat_bitset_for(arguments...) CCC_flat_bitset_for(arguments)
#    define flat_bitset_from(arguments...) CCC_flat_bitset_from(arguments)
#    define flat_bitset_with_capacity(arguments...)                            \
        CCC_flat_bitset_with_capacity(arguments)
#    define flat_bitset_with_storage(arguments...)                             \
        CCC_flat_bitset_with_storage(arguments)
#    define flat_bitset_copy(arguments...) CCC_flat_bitset_copy(arguments)
#    define flat_bitset_reserve(arguments...) CCC_flat_bitset_reserve(arguments)
#    define flat_bitset_test(arguments...) CCC_flat_bitset_test(arguments)
#    define flat_bitset_set(arguments...) CCC_flat_bitset_set(arguments)
#    define flat_bitset_set_all(arguments...) CCC_flat_bitset_set_all(arguments)
#    define flat_bitset_set_range(arguments...)                                \
        CCC_flat_bitset_set_range(arguments)
#    define flat_bitset_reset(arguments...) CCC_flat_bitset_reset(arguments)
#    define flat_bitset_reset_all(arguments...)                                \
        CCC_flat_bitset_reset_all(arguments)
#    define flat_bitset_reset_range(arguments...)                              \
        CCC_flat_bitset_reset_range(arguments)
#    define flat_bitset_flip(arguments...) CCC_flat_bitset_flip(arguments)
#    define flat_bitset_flip_all(arguments...)                                 \
        CCC_flat_bitset_flip_all(arguments)
#    define flat_bitset_flip_range(arguments...)                               \
        CCC_flat_bitset_flip_range(arguments)
#    define flat_bitset_any(arguments...) CCC_flat_bitset_any(arguments)
#    define flat_bitset_any_range(arguments...)                                \
        CCC_flat_bitset_any_range(arguments)
#    define flat_bitset_none(arguments...) CCC_flat_bitset_none(arguments)
#    define flat_bitset_none_range(arguments...)                               \
        CCC_flat_bitset_none_range(arguments)
#    define flat_bitset_all(arguments...) CCC_flat_bitset_all(arguments)
#    define flat_bitset_all_range(arguments...)                                \
        CCC_flat_bitset_all_range(arguments)
#    define flat_bitset_first_trailing_one(arguments...)                       \
        CCC_flat_bitset_first_trailing_one(arguments)
#    define flat_bitset_first_trailing_one_range(arguments...)                 \
        CCC_flat_bitset_first_trailing_one_range(arguments)
#    define flat_bitset_first_trailing_ones(arguments...)                      \
        CCC_flat_bitset_first_trailing_ones(arguments)
#    define flat_bitset_first_trailing_ones_range(arguments...)                \
        CCC_flat_bitset_first_trailing_ones_range(arguments)
#    define flat_bitset_first_trailing_zero(arguments...)                      \
        CCC_flat_bitset_first_trailing_zero(arguments)
#    define flat_bitset_first_trailing_zero_range(arguments...)                \
        CCC_flat_bitset_first_trailing_zero_range(arguments)
#    define flat_bitset_first_trailing_zeros(arguments...)                     \
        CCC_flat_bitset_first_trailing_zeros(arguments)
#    define flat_bitset_first_trailing_zeros_range(arguments...)               \
        CCC_flat_bitset_first_trailing_zeros_range(arguments)
#    define flat_bitset_first_leading_one(arguments...)                        \
        CCC_flat_bitset_first_leading_one(arguments)
#    define flat_bitset_first_leading_one_range(arguments...)                  \
        CCC_flat_bitset_first_leading_one_range(arguments)
#    define flat_bitset_first_leading_ones(arguments...)                       \
        CCC_flat_bitset_first_leading_ones(arguments)
#    define flat_bitset_first_leading_ones_range(arguments...)                 \
        CCC_flat_bitset_first_leading_ones_range(arguments)
#    define flat_bitset_first_leading_zero(arguments...)                       \
        CCC_flat_bitset_first_leading_zero(arguments)
#    define flat_bitset_first_leading_zero_range(arguments...)                 \
        CCC_flat_bitset_first_leading_zero_range(arguments)
#    define flat_bitset_first_leading_zeros(arguments...)                      \
        CCC_flat_bitset_first_leading_zeros(arguments)
#    define flat_bitset_first_leading_zeros_range(arguments...)                \
        CCC_flat_bitset_first_leading_zeros_range(arguments)
#    define flat_bitset_or(arguments...) CCC_flat_bitset_or(arguments)
#    define flat_bitset_and(arguments...) CCC_flat_bitset_and(arguments)
#    define flat_bitset_xor(arguments...) CCC_flat_bitset_xor(arguments)
#    define flat_bitset_shift_left(arguments...)                               \
        CCC_flat_bitset_shift_left(arguments)
#    define flat_bitset_shift_right(arguments...)                              \
        CCC_flat_bitset_shift_right(arguments)
#    define flat_bitset_is_equal(arguments...)                                 \
        CCC_flat_bitset_is_equal(arguments)
#    define flat_bitset_is_proper_subset(arguments...)                         \
        CCC_flat_bitset_is_proper_subset(arguments)
#    define flat_bitset_is_subset(arguments...)                                \
        CCC_flat_bitset_is_subset(arguments)
#    define flat_bitset_data(arguments...) CCC_flat_bitset_data(arguments)
#    define flat_bitset_capacity(arguments...)                                 \
        CCC_flat_bitset_capacity(arguments)
#    define flat_bitset_blocks_capacity(arguments...)                          \
        CCC_flat_bitset_blocks_capacity(arguments)
#    define flat_bitset_count(arguments...) CCC_flat_bitset_count(arguments)
#    define flat_bitset_blocks_count(arguments...)                             \
        CCC_flat_bitset_blocks_count(arguments)
#    define flat_bitset_is_empty(arguments...)                                 \
        CCC_flat_bitset_is_empty(arguments)
#    define flat_bitset_popcount(arguments...)                                 \
        CCC_flat_bitset_popcount(arguments)
#    define flat_bitset_popcount_range(arguments...)                           \
        CCC_flat_bitset_popcount_range(arguments)
#    define flat_bitset_clear(arguments...) CCC_flat_bitset_clear(arguments)
#    define flat_bitset_clear_and_free(arguments...)                           \
        CCC_flat_bitset_clear_and_free(arguments)
#    define flat_bitset_push_back(arguments...)                                \
        CCC_flat_bitset_push_back(arguments)
#    define flat_bitset_pop_back(arguments...)                                 \
        CCC_flat_bitset_pop_back(arguments)
/* NOLINTEND(readability-identifier-naming) */
#endif /* FLAT_BITSET_USING_NAMESPACE_CCC */
 
#endif /* CCC_FLAT_BITSET_H */