hxhandle_map.hpp

Go to the documentation of this file.

#pragma once
// SPDX-FileCopyrightText: © 2017-2026 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 "hxallocator.hpp"
#include "hxutility.h"
 
HX_NS_BEGIN_

// Makes the mask a compile time constant when non-0.
template<hxsize_t mask_>
class hxhandle_map_mask_ {
public:
    hxinline_constexpr uint32_t get_mask_(void) const { return static_cast<uint32_t>(mask_); }
    hxinline void set_mask_(uint32_t) const { } // GCOVR_EXCL_LINE. Unreachable code below c++17.
};
 
template<>
class hxhandle_map_mask_<hxallocator_dynamic_capacity> {
public:
    hxinline hxattr_nodiscard uint32_t get_mask_(void) const { return m_mask_; }
    hxinline void set_mask_(uint32_t mask_) { m_mask_ = mask_; }
private:
    uint32_t m_mask_;
};

template<typename T_, uint32_t table_size_bits_=hxallocator_dynamic_capacity>
class hxhandle_map {
public:
    static_assert(table_size_bits_ < 31u, "Slot index must fit in the low 31-bits of the handle");

    using iterator = T_*;

    using const_iterator = const T_*;
 
    using value_t = T_;

    hxhandle_map(void);

    ~hxhandle_map();

    hxinline hxattr_flatten const T_* begin(void) const { return this->data(); }

    hxinline hxattr_flatten T_* begin(void) { return this->data(); }

    hxinline hxattr_nodiscard hxsize_t capacity(void) const { return static_cast<hxsize_t>(m_mask_.get_mask_()); }

    hxinline hxattr_flatten hxattr_nodiscard const T_* cbegin(void) const { return this->data(); }

    hxinline hxattr_flatten hxattr_nodiscard const T_* cend(void) const { return this->data() + this->size(); }

    void clear(void) noexcept;

    hxinline hxattr_flatten hxattr_nodiscard const T_* data(void) const { return m_values_.data(); }

    hxinline hxattr_flatten hxattr_nodiscard T_* data(void) { return m_values_.data(); }

    hxinline hxattr_flatten hxattr_nodiscard const T_* end(void) const { return this->data() + this->size(); }

    hxinline hxattr_flatten hxattr_nodiscard T_* end(void) { return this->data() + this->size(); }

    hxinline hxattr_nodiscard bool empty(void) const { return m_size_ == 0u; }

    bool erase(hxhandle_t handle_) noexcept;

    template<typename callable_t_>
    hxsize_t erase_if(callable_t_&& callable_) noexcept;

    hxattr_nodiscard hxinline hxattr_flatten bool full(void) const { return m_size_ == m_mask_.get_mask_(); }

    hxattr_nodiscard T_* get(hxhandle_t handle_) noexcept;

    hxattr_nodiscard const T_* get(hxhandle_t handle_) const noexcept;

    hxattr_nodiscard hxattr_flatten hxhandle_t handle_at(hxsize_t index_) const noexcept;

    template<typename... args_t_>
    hxhandle_t insert(args_t_&&... args_) noexcept;

    hxinline hxattr_nodiscard hxsize_t max_size(void) const { return this->capacity(); }

    void set_size_bits(uint32_t bits_);

    hxinline hxattr_nodiscard hxsize_t size(void) const { return static_cast<hxsize_t>(m_size_); }
 
private:
    // See detail/hxhandle_map.inl for the design.
    static hxinline_constexpr hxsize_t s_capacity_ =
        table_size_bits_ == hxallocator_dynamic_capacity
            ? hxallocator_dynamic_capacity
            : static_cast<hxsize_t>(1) << table_size_bits_;
 
    static hxinline_constexpr hxsize_t s_value_capacity_ =
        table_size_bits_ == hxallocator_dynamic_capacity
            ? hxallocator_dynamic_capacity
            : s_capacity_ - 1;
 
    struct slot_t_ {
        uint64_t m_handle_;
        uint32_t m_index_;
        uint32_t m_backref_;
    };
 
    void build_free_list_(void);
 
    uint32_t m_size_;
    hxhandle_map_mask_<s_value_capacity_> m_mask_;
    hxallocator<slot_t_, s_capacity_> m_slots_;
    hxallocator<T_, s_value_capacity_> m_values_;
};
 
#include "detail/hxhandle_map.inl"
HX_NS_END_