ImplicitSurfaceNetwork/shared_module/container/detail/static_bitset_base.hpp

// BITSET2
//
//  Copyright Claas Bontus
//
//  Use, modification and distribution is subject to the
//  Boost Software License, Version 1.0. (See accompanying
//  file LICENSE.txt or copy at
//  http://www.boost.org/LICENSE_1_0.txt)
//
// Project home: https://github.com/ClaasBontus/bitset2
//

#pragma once

#include <bitset>
#include <stdexcept>

#include "static_bitset/bit_chars.hpp"
#include "static_bitset/array_funcs.hpp"
#include "static_bitset/array_ops.hpp"
#include "static_bitset/array2array.hpp"
#include "static_bitset/ull2array.hpp"
#include "static_bitset/array2ull.hpp"

namespace detail
{
template <size_t N, class T>
class __bitset_base
{
    using b_chars = bit_chars<N, T>;
    using h_t     = h_types<T>;

public:
    enum : size_t { n_array = b_chars::n_array, npos = h_t::npos };

    using base_t   = T;
    using ULONG_t  = typename b_chars::ULONG_t;
    using ULLONG_t = typename b_chars::ULLONG_t;
    using LRGST_t  = typename b_chars::LRGST_t;
    using array_t  = typename h_types<T>::template array_t<n_array>;

protected:
    enum : size_t {
        n_words       = b_chars::n_words,
        ulong_n_bits  = b_chars::ulong_n_bits,
        ullong_n_bits = b_chars::ullong_n_bits,
        base_t_n_bits = b_chars::base_t_n_bits
    };

    enum : ULONG_t { ulong_max = b_chars::ulong_max };

    enum : base_t {
        low_bit_pattern = b_chars::low_bit_pattern,
        hgh_bit_pattern = b_chars::hgh_bit_pattern,
        all_one         = b_chars::all_one
    };

    template <size_t n_arr_src, class Tsrc>
    using a2a = array2array<n_array, n_arr_src, T, Tsrc>;

    /* ----------------------------------------------------------------------- */
    constexpr __bitset_base() noexcept {}

    constexpr __bitset_base(__bitset_base const &) noexcept = default;

    constexpr __bitset_base(__bitset_base &&) noexcept = default;

    constexpr __bitset_base &operator=(__bitset_base const &) noexcept = default;

    constexpr __bitset_base &operator=(__bitset_base &&) noexcept = default;

    explicit constexpr __bitset_base(LRGST_t v) noexcept : m_value(lrgst2array<N, T>()(v)) {}

    template <size_t n, class Tsrc>
    explicit constexpr __bitset_base(std::array<Tsrc, n> const &value) noexcept
        : m_value(a2a<n, Tsrc>()(hgh_bit_pattern, value))
    {
    }

    explicit __bitset_base(const std::bitset<N> &bs) noexcept
    {
        if (N == 0) return;
        if (ullong_n_bits >= base_t_n_bits && n_words == 1) {
            m_value[0] = bs.to_ullong();
            return;
        }

        size_t offset = 0;
        for (size_t ct = 0; ct < n_words; ++ct) {
            base_t     val       = base_t(0);
            auto const bit_limit = (ct < n_words - 1) ? base_t_n_bits : N - offset;
            for (size_t bit_ct = 0; bit_ct < bit_limit; ++bit_ct) {
                auto const test_bit   = offset + bit_limit - bit_ct - 1;
                val                 <<= 1;
                if (bs.test(test_bit)) val |= base_t(1);
            } // for bit_ct
            m_value[ct]  = val;
            offset      += base_t_n_bits;
        }     // for ct
    }         // __bitset_base( const std::bitset<N> &bs )

    template <class CharT, class Traits, class Alloc>
    explicit __bitset_base(std::basic_string<CharT, Traits, Alloc> const              &str,
                           typename std::basic_string<CharT, Traits, Alloc>::size_type pos,
                           typename std::basic_string<CharT, Traits, Alloc>::size_type n,
                           CharT                                                       zero,
                           CharT                                                       one)
    {
        auto const str_sz = str.size();
        if (pos > str_sz)
            throw std::out_of_range("bitset2: String submitted to "
                                    "constructor smaller than pos");
        auto const n_bits = std::min(N, std::min(n, str_sz - pos));

        for (size_t bit_ct = 0; bit_ct < n_bits; ++bit_ct) {
            auto const chr = str[bit_ct + pos];
            if (Traits::eq(one, chr))
                set(n_bits - bit_ct - 1);
            else if (!Traits::eq(zero, chr))
                throw std::invalid_argument("bitset2: Invalid argument in "
                                            "string submitted to constructor");
        } // for bit_ct
    }

    /* ----------------------------------------------------------------------- */


    //**********************************************************


    constexpr array_t &get_data() noexcept { return m_value; }

    constexpr bool operator[](size_t bit) const noexcept { return test_noexcept(bit); }

    constexpr bool test_noexcept(size_t bit) const noexcept
    {
        return m_value[bit / base_t_n_bits] & (T(1) << (bit % base_t_n_bits));
    }

    constexpr __bitset_base &set(size_t bit, bool value = true)
    {
        if (bit >= N) throw std::out_of_range("bitset2: Setting of bit out of range");
        set_noexcept(bit, value);
        return *this;
    } // set

    constexpr __bitset_base &set() noexcept
    {
        if (N > 0) {
            size_t c = 0;
            for (; c < n_words - 1; ++c) m_value[c] = ~base_t(0);
            m_value[c] = hgh_bit_pattern;
        }
        return *this;
    } // set

    constexpr __bitset_base &reset() noexcept
    {
        for (size_t c = 0; c < n_array; ++c) m_value[c] = base_t(0);
        return *this;
    }

    constexpr bool test_set(size_t bit, bool value = true)
    {
        if (bit >= N) throw std::out_of_range("bitset2: test_set out of range");
        return test_set_noexcept(bit, value);
    } // test_set

    constexpr __bitset_base &flip_noexcept(size_t bit) noexcept
    {
        m_value[bit / base_t_n_bits] ^= (base_t(1) << (bit % base_t_n_bits));
        return *this;
    }

    constexpr __bitset_base &flip(size_t bit)
    {
        if (bit >= N) throw std::out_of_range("bitset2: Flipping of bit out of range");
        return flip_noexcept(bit);
    } // flip

    constexpr __bitset_base &flip() noexcept
    {
        if (N > 0) {
            size_t c = 0;
            for (; c < n_words - 1; ++c) m_value[c] ^= ~base_t(0);
            m_value[c] ^= hgh_bit_pattern;
        }
        return *this;
    } // flip

public:
    constexpr array_t const &data() const noexcept { return m_value; }

    constexpr ULONG_t to_ulong() const
    {
        using a2l = array2u_long_t<N, T, ULONG_t>;
        return (N == 0)                        ? 0ul
               : a2l().check_overflow(m_value) ? throw std::overflow_error("Cannot convert bitset2 "
                                                                           "to unsigned long")
                                               : a2l()(m_value);
    } // to_ulong

    constexpr ULLONG_t to_ullong() const
    {
        using a2l = array2u_long_t<N, T, ULLONG_t>;
        return (N == 0)                        ? 0ull
               : a2l().check_overflow(m_value) ? throw std::overflow_error("Cannot convert bitset2 "
                                                                           "to unsigned long long")
                                               : a2l()(m_value);
    } // to_ullong

#ifdef __SIZEOF_INT128__
    constexpr LRGST_t to_u128() const
    {
        using a2l = array2u_long_t<N, T, LRGST_t>;
        return (N == 0)                        ? LRGST_t(0)
               : a2l().check_overflow(m_value) ? throw std::overflow_error("Cannot convert bitset2 "
                                                                           "to unsigned __int128")
                                               : a2l()(m_value);
    } // to_u128
#endif

    constexpr bool test(size_t bit) const
    {
        return (bit >= N) ? throw std::out_of_range("bitset2: Testing of bit out of range") : operator[](bit);
    }

    constexpr void set_noexcept(size_t bit, bool value = true) noexcept
    {
        if (value)
            m_value[bit / base_t_n_bits] |= base_t(base_t(1) << (bit % base_t_n_bits));
        else
            m_value[bit / base_t_n_bits] &= base_t(~(base_t(1) << (bit % base_t_n_bits)));
    }

    constexpr bool test_set_noexcept(size_t bit, bool value = true) noexcept
    {
        auto const dv      = bit / base_t_n_bits;
        auto const md      = bit % base_t_n_bits;
        auto const pttrn   = (base_t(1) << md);
        auto const ret_val = bool(m_value[dv] & pttrn);

        if (value)
            m_value[dv] |= pttrn;
        else
            m_value[dv] &= ~pttrn;

        return ret_val;
    } // test_set_noexcept

    constexpr bool none() const noexcept { return array_funcs<n_array, T>().none(m_value); }

    constexpr bool any() const noexcept { return (N > 0) && !none(); }

    constexpr bool all() const noexcept { return (N > 0) && array_ops<N, T>(0).all(m_value); }

    constexpr size_t count() const noexcept { return array_funcs<n_array, T>().count(m_value); }

    /// True if exactly one bit set.
    constexpr bool has_single_bit() const noexcept { return array_funcs<n_array, T>().has_single_bit(m_value); }

    /// \brief Returns index of first (least significant) bit set.
    /// Returns npos if all bits are zero.
    constexpr size_t find_first() const noexcept
    {
        return array_funcs<n_array, T>().idx_lsb_set(m_value, m_value[0], 0, base_t(2));
    }

    /// \brief Returns index of first (least significant) bit unset.
    /// Returns npos if all bits are set.
    constexpr size_t find_first_zero() const noexcept
    {
        return array_funcs<n_array, T>().idx_lsb_set(m_value, ~m_value[0], 0, hgh_bit_pattern);
    }

    /// \brief Returns index of last (most significant) bit set.
    /// Returns npos if all bits are zero.
    constexpr size_t find_last() const noexcept { return array_funcs<n_array, T>().idx_msb_set(m_value, base_t(2)); }

    /// \brief Returns index of last (most significant) bit unset.
    /// Returns npos if all bits are set.
    constexpr size_t find_last_zero() const noexcept { return array_funcs<n_array, T>().idx_msb_set(m_value, hgh_bit_pattern); }

    /// \brief Returns index of next (> idx) bit set.
    /// Returns npos if no more bits set.
    /// Throws out_of_range if idx >= N.
    constexpr size_t find_next(size_t idx) const
    {
        size_t const arr_idx = (idx + 1) / base_t_n_bits;
        size_t const idx_mod = (idx + 1) % base_t_n_bits;
        return idx >= N ? throw std::out_of_range("bitset2: find_next index out of range")
               : idx + 1 == N
                   ? npos
                   : array_funcs<n_array, T>().idx_lsb_set(m_value,
                                                           base_t(m_value[arr_idx] & ce_left_shift(T(~T(0)), idx_mod)),
                                                           arr_idx,
                                                           base_t(2));
    } // find_next

    /// \brief Returns index of next (> idx) bit unset.
    /// Returns npos if no more bits unset.
    /// Throws out_of_range if idx >= N.
    constexpr size_t find_next_zero(size_t idx) const
    {
        size_t const arr_idx = (idx + 1) / base_t_n_bits;
        size_t const idx_mod = (idx + 1) % base_t_n_bits;
        return idx >= N ? throw std::out_of_range("bitset2: find_next index out of range")
               : idx + 1 == N
                   ? npos
                   : array_funcs<n_array, T>().idx_lsb_set(m_value,
                                                           base_t(~(m_value[arr_idx]) & ce_left_shift(T(~T(0)), idx_mod)),
                                                           arr_idx,
                                                           hgh_bit_pattern);
    } // find_next_zero

    constexpr bool operator==(__bitset_base const &v2) const noexcept
    {
        return array_funcs<n_array, T>().equal(m_value, v2.m_value);
    }

    constexpr bool operator!=(__bitset_base const &v2) const noexcept { return !(*this == v2); }

    constexpr bool operator<(__bitset_base const &v2) const noexcept
    {
        return array_funcs<n_array, T>().less_than(m_value, v2.m_value);
    }

    constexpr bool operator<=(__bitset_base const &v2) const noexcept { return !(*this > v2); }

    constexpr bool operator>(__bitset_base const &v2) const noexcept
    {
        return array_funcs<n_array, T>().less_than(v2.m_value, m_value);
    }

    constexpr bool operator>=(__bitset_base const &v2) const noexcept { return !(*this < v2); }

    explicit operator std::bitset<N>() const
    {
        using b_t = std::bitset<N>;
        if (N == 0) return b_t{};
        if (n_words == 1 && base_t_n_bits <= ullong_n_bits) return b_t(to_ullong());

        b_t ret_val;
        for (size_t ct = 0; ct < N; ++ct) ret_val[ct] = operator[](ct);

        return ret_val;
    }

private:
    array_t m_value = (gen_empty_array<n_array, T>)();
}; // class __bitset_base
} // namespace detail