hxbitset.hpp

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2025 Adrian Johnston.
// SPDX-License-Identifier: MIT
// This file is licensed under the MIT license found in the LICENSE.md file.

 
#include "libhatchet.h"
 
// HX_USE_MACROS_WITH_MODULE allows including macros alongside the module.
#if HX_USE_MACROS_WITH_MODULE
#error Header does not provide macros alone.
#endif
 
#include "hxinitializer_list.hpp"
 
HX_NS_BEGIN_

template<size_t bit_count_>
class hxbitset {
public:
    hxconstexpr hxbitset(void) { this->reset(); }

    hxconstexpr explicit hxbitset(size_t val_);

    hxconstexpr hxbitset(const hxbitset& x_);

    template<typename int_t_>
    hxconstexpr hxbitset(std::initializer_list<int_t_> x_);

    hxconstexpr void operator=(const hxbitset& x_);

    hxattr_nodiscard hxconstexpr bool operator[](size_t pos_) const;

    hxconstexpr hxbitset& operator&=(const hxbitset& x_);

    hxconstexpr hxbitset& operator|=(const hxbitset& x_);

    hxconstexpr hxbitset& operator^=(const hxbitset& x_);

    hxconstexpr hxbitset& operator<<=(size_t count_);

    hxconstexpr hxbitset& operator>>=(size_t count_);

    hxattr_nodiscard hxconstexpr bool operator==(const hxbitset& x_) const;
 
#if HX_CPLUSPLUS < 202002L // C++20 defaults != from ==.
    hxattr_nodiscard hxinline hxconstexpr bool operator!=(const hxbitset& x_) const;
#endif

    hxattr_nodiscard hxconstexpr bool all(void) const;

    hxattr_nodiscard hxconstexpr bool any(void) const;

    hxattr_nodiscard static hxinline constexpr size_t bytes(void) { return s_words_ * sizeof(size_t); }

    hxattr_nodiscard hxinline hxconstexpr const size_t* data(void) const { return m_data_; }
 
    hxattr_nodiscard hxinline hxconstexpr size_t* data(void) { return m_data_; }

    hxconstexpr hxbitset& flip(void);

    hxconstexpr hxbitset& flip(size_t pos_);

    hxattr_nodiscard hxinline hxconstexpr bool none(void) const { return !this->any(); }

    hxconstexpr hxbitset& reset(void);

    hxconstexpr hxbitset& reset(size_t pos_);

    hxconstexpr hxbitset& set(void);

    hxconstexpr hxbitset& set(size_t pos_, bool value_=true);

    hxattr_nodiscard static hxinline constexpr size_t size(void) { return bit_count_; }

    hxattr_nodiscard hxconstexpr bool test(size_t pos_) const;
 
private:
    static_assert(bit_count_ > 0, "hxbitset requires bit_count > 0");
    static hxinline_constexpr size_t s_bits_per_word_ = sizeof(size_t) * 8u;
    static hxinline_constexpr size_t s_log2_bits_per_word_ = (s_bits_per_word_ > 32u) ? 6u : 5u;
    static hxinline_constexpr size_t s_bit_mask_ = s_bits_per_word_ - 1u;
    static hxinline_constexpr size_t s_words_ = (bit_count_ + s_bit_mask_) >> s_log2_bits_per_word_;
    static hxinline_constexpr size_t s_trailing_bits_ = bit_count_ & s_bit_mask_;
    static hxinline_constexpr size_t s_trailing_mask_ = s_trailing_bits_ != 0u
        ? (static_cast<size_t>(1u) << s_trailing_bits_) - 1u
        : ~static_cast<size_t>(0u);
 
    size_t m_data_[s_words_];
};
 
#include "detail/hxbitset.inl"
HX_NS_END_