hxflat_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 "hxkey.hpp"
#include "hxsort.hpp"
 
HX_NS_BEGIN_

template<typename key_t_,
    typename mapped_t_,
    typename compare_t_=hxkey_less_t<key_t_>,
    bool multi_t_=true,
    hxsize_t capacity_=hxallocator_dynamic_capacity>
class hxflat_map {
public:
    using key_t = key_t_;
    using mapped_t = mapped_t_;
    using compare_t = compare_t_;

    class const_iterator {
    public:
        const_iterator(void) : m_map_(hxnull), m_index_(0) { }

        const const_iterator& operator*(void) const { return *this; }

        const_iterator& operator+=(hxsize_t n_);

        const_iterator& operator-=(hxsize_t n_) { return operator+=(-n_); }

        const_iterator operator+(hxsize_t n_) const { const_iterator t_(*this); t_ += n_; return t_; }

        const_iterator operator-(hxsize_t n_) const { const_iterator t_(*this); t_ -= n_; return t_; }

        hxsize_t operator-(const const_iterator& x_) const;

        const_iterator operator[](hxsize_t n_) const { return operator+(n_); }

        const_iterator& operator++(void) { return operator+=(1); }

        const_iterator operator++(int) { const_iterator t_(*this); operator++(); return t_; }

        const_iterator& operator--(void) { return operator+=(-1); }

        const_iterator operator--(int) { const_iterator t_(*this); operator--(); return t_; }

        bool operator==(const const_iterator& x_) const;

        bool operator<(const const_iterator& x_) const;

        bool operator>(const const_iterator& x_) const { return x_ < *this; }

        bool operator<=(const const_iterator& x_) const { return !(x_ < *this); }

        bool operator>=(const const_iterator& x_) const { return !(*this < x_); }
 
#if HX_CPLUSPLUS < 202002L
        bool operator!=(const const_iterator& x_) const;
#endif

        const key_t_& key(void) const;

        const mapped_t_& value(void) const;
 
    protected:
        friend class hxflat_map;
        const_iterator(const hxflat_map* map_, hxsize_t index_)
            : m_map_(map_), m_index_(index_) { }
        const hxflat_map* m_map_;
        hxsize_t m_index_;
    };

    class iterator : public const_iterator {
    public:
        iterator(void) { }

        const iterator& operator*(void) const { return *this; }

        iterator& operator+=(hxsize_t n_) { const_iterator::operator+=(n_); return *this; }

        iterator& operator-=(hxsize_t n_) { return operator+=(-n_); }

        iterator operator+(hxsize_t n_) const { iterator t_(*this); t_ += n_; return t_; }

        iterator operator-(hxsize_t n_) const { iterator t_(*this); t_ -= n_; return t_; }

        hxsize_t operator-(const const_iterator& x_) const { return const_iterator::operator-(x_); }

        iterator operator[](hxsize_t n_) const { return operator+(n_); }

        iterator& operator++(void) { const_iterator::operator++(); return *this; }

        iterator operator++(int) { iterator t_(*this); const_iterator::operator++(); return t_; }

        iterator& operator--(void) { const_iterator::operator--(); return *this; }

        iterator operator--(int) { iterator t_(*this); const_iterator::operator--(); return t_; }

        mapped_t_& value(void) const;
 
    protected:
        friend class hxflat_map;
        iterator(hxflat_map* map_, hxsize_t index_) : const_iterator(map_, index_) { }
    };

    explicit hxflat_map(void);

    hxflat_map(const hxflat_map& x_) noexcept;

    hxflat_map(hxflat_map&& x_) noexcept;

    ~hxflat_map(void) noexcept;

    void operator=(const hxflat_map& x_) noexcept;

    template<hxsize_t capacity_x_>
    void operator=(const hxflat_map<key_t_, mapped_t_, compare_t_, multi_t_,
        capacity_x_>& x_) noexcept;

    void operator=(hxflat_map&& x_) noexcept;

    hxattr_nodiscard const_iterator operator[](hxsize_t index_) const;

    hxattr_nodiscard iterator operator[](hxsize_t index_);

    const_iterator begin(void) const { return const_iterator(this, 0); }

    iterator begin(void) { return iterator(this, 0); }

    hxattr_nodiscard hxsize_t capacity(void) const { return m_keys_.capacity(); }

    const_iterator cbegin(void) const { return const_iterator(this, 0); }

    const_iterator cend(void) const { return const_iterator(this, m_size_); }

    void clear(void) noexcept;

    hxattr_nodiscard hxsize_t count(const key_t_& key_) const;

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

    const_iterator end(void) const { return const_iterator(this, m_size_); }

    iterator end(void) { return iterator(this, m_size_); }

    template<hxsize_t capacity_x_>
    hxattr_nodiscard bool equal(const hxflat_map<key_t_, mapped_t_, compare_t_,
        multi_t_, capacity_x_>& x_) const;

    hxsize_t erase(const key_t_& key_) noexcept;

    iterator erase(iterator pos_) noexcept;

    hxattr_nodiscard const mapped_t_* find(const key_t_& key_) const;

    hxattr_nodiscard mapped_t_* find(const key_t_& key_);

    hxattr_nodiscard bool full(void) const { return m_size_ == m_keys_.capacity(); }

    hxattr_nodiscard const_iterator get(hxsize_t index_) const;

    hxattr_nodiscard iterator get(hxsize_t index_);

    iterator insert(const key_t_& key_, const mapped_t_& mapped_) noexcept;

    iterator insert(const key_t_& key_, mapped_t_&& mapped_) noexcept;

    template<hxsize_t capacity_x_>
    hxattr_nodiscard bool less(const hxflat_map<key_t_, mapped_t_, compare_t_,
        multi_t_, capacity_x_>& x_) const;

    hxattr_nodiscard const_iterator lower_bound(const key_t_& key_) const;

    hxattr_nodiscard iterator lower_bound(const key_t_& key_);

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

    void reserve(hxsize_t cap_,
            hxsystem_allocator_t allocator_=hxsystem_allocator_current,
            hxalignment_t alignment_=hxalignment) noexcept;

    hxattr_nodiscard hxsize_t size(void) const { return m_size_; }

    void swap(hxflat_map& x_) noexcept;

    hxattr_nodiscard const_iterator upper_bound(const key_t_& key_) const;

    hxattr_nodiscard iterator upper_bound(const key_t_& key_);
 
private:
    template<typename, typename, typename, bool, hxsize_t> friend class hxflat_map;
 
    template<typename mapped_u_>
    iterator insert_at_(hxsize_t index_, const key_t_& key_, mapped_u_&& mapped_) noexcept;
 
    hxsize_t m_size_;
    hxallocator<key_t_, capacity_> m_keys_;
    hxallocator<mapped_t_, capacity_> m_values_;
};
 
// Without the "requires" keyword these end up being ambiguous.
#if HX_CPLUSPLUS >= 202002L
template<typename key_t_, typename mapped_t_, typename compare_t_, bool multi_t_,
    hxsize_t capacity_x_, hxsize_t capacity_y_>
hxinline hxattr_flatten bool hxkey_equal(
        const hxflat_map<key_t_, mapped_t_, compare_t_, multi_t_, capacity_x_>& x_,
        const hxflat_map<key_t_, mapped_t_, compare_t_, multi_t_, capacity_y_>& y_) {
    return x_.equal(y_);
}

template<typename key_t_, typename mapped_t_, typename compare_t_, bool multi_t_,
    hxsize_t capacity_x_, hxsize_t capacity_y_>
hxinline hxattr_flatten bool hxkey_less(
        const hxflat_map<key_t_, mapped_t_, compare_t_, multi_t_, capacity_x_>& x_,
        const hxflat_map<key_t_, mapped_t_, compare_t_, multi_t_, capacity_y_>& y_) {
    return x_.less(y_);
}

template<typename key_t_, typename mapped_t_, typename compare_t_, bool multi_t_>
hxinline hxattr_flatten void hxswap(
    hxflat_map<key_t_, mapped_t_, compare_t_, multi_t_, hxallocator_dynamic_capacity>& x_,
    hxflat_map<key_t_, mapped_t_, compare_t_, multi_t_, hxallocator_dynamic_capacity>& y_) noexcept {
    hxswap_memcpy(x_, y_);
}
 
#endif // HX_CPLUSPLUS >= 202002L
#include "detail/hxflat_map.inl"
HX_NS_END_