libostd/ostd/internal/hashtable.hh

/* Internal hash table implementation. Used as a base for set, map etc.
 *
 * This file is part of OctaSTD. See COPYING.md for futher information.
 */

#ifndef OSTD_INTERNAL_HASHTABLE_HH
#define OSTD_INTERNAL_HASHTABLE_HH

#include <string.h>

#include "ostd/types.hh"
#include "ostd/utility.hh"
#include "ostd/memory.hh"
#include "ostd/range.hh"
#include "ostd/initializer_list.hh"

namespace ostd {

namespace detail {
    template<typename T>
    struct HashChain {
        HashChain<T> *next;
        T value;
    };

    template<typename R>
    static inline Size estimate_hrsize(const R &range,
        EnableIf<IsFiniteRandomAccessRange<R>::value, bool> = true
    ) {
        return range.size();
    }

    template<typename R>
    static inline Size estimate_hrsize(const R &,
        EnableIf<!IsFiniteRandomAccessRange<R>::value, bool> = true
    ) {
        /* we have no idea how big the range actually is */
        return 16;
    }
}

template<typename T>
struct HashRange: InputRange<HashRange<T>, ForwardRangeTag, T> {
private:
    template<typename U>
    friend struct HashRange;

    using Chain = detail::HashChain<T>;

    Chain **p_beg;
    Chain **p_end;
    Chain *p_node;

    void advance() {
        while ((p_beg != p_end) && !p_beg[0])
            ++p_beg;
        if (p_beg != p_end) p_node = p_beg[0];
    }
public:
    HashRange(): p_beg(nullptr), p_end(nullptr), p_node(nullptr) {}
    HashRange(const HashRange &v): p_beg(v.p_beg), p_end(v.p_end),
        p_node(v.p_node) {}
    HashRange(Chain **beg, Chain **end): p_beg(beg), p_end(end), p_node() {
        advance();
    }
    HashRange(Chain **beg, Chain **end, Chain *node): p_beg(beg), p_end(end),
        p_node(node) {}

    template<typename U>
    HashRange(const HashRange<U> &v, EnableIf<
        IsSame<RemoveCv<T>, RemoveCv<U>>::value &&
        IsConvertible<U *, T *>::value, bool
    > = true): p_beg((Chain **)v.p_beg), p_end((Chain **)v.p_end),
        p_node((Chain *)v.p_node) {}

    HashRange &operator=(const HashRange &v) {
        p_beg = v.p_beg;
        p_end = v.p_end;
        p_node = v.p_node;
        return *this;
    }

    bool empty() const { return !p_node; }

    bool pop_front() {
        if (!p_node) return false;
        p_node = p_node->next;
        if (p_node) return true;
        ++p_beg;
        advance();
        return true;
    }

    bool equals_front(const HashRange &v) const {
        return p_node == v.p_node;
    }

    T &front() const { return p_node->value; }
};

template<typename T>
struct BucketRange: InputRange<BucketRange<T>, ForwardRangeTag, T> {
private:
    template<typename U>
    friend struct BucketRange;

    using Chain = detail::HashChain<T>;
    Chain *p_node;
public:
    BucketRange(): p_node(nullptr) {}
    BucketRange(Chain *node): p_node(node) {}
    BucketRange(const BucketRange &v): p_node(v.p_node) {}

    template<typename U>
    BucketRange(const BucketRange<U> &v, EnableIf<
        IsSame<RemoveCv<T>, RemoveCv<U>>::value &&
        IsConvertible<U *, T *>::value, bool
    > = true): p_node((Chain *)v.p_node) {}

    BucketRange &operator=(const BucketRange &v) {
        p_node = v.p_node;
        return *this;
    }

    bool empty() const { return !p_node; }

    bool pop_front() {
        if (!p_node) return false;
        p_node = p_node->next;
        return true;
    }

    bool equals_front(const BucketRange &v) const {
        return p_node == v.p_node;
    }

    T &front() const { return p_node->value; }
};

namespace detail {
    template<
        typename B, /* contains methods specific to each ht type */
        typename E, /* element type */
        typename K, /* key type */
        typename T, /* value type */
        typename H, /* hash func */
        typename C, /* equality check */
        typename A, /* allocator */
        bool Multihash
    > struct Hashtable {
private:
        static constexpr Size CHUNKSIZE = 64;

        using Chain = detail::HashChain<E>;

        struct Chunk {
            Chain chains[CHUNKSIZE];
            Chunk *next;
        };

        Size p_size;
        Size p_len;

        Chunk *p_chunks;
        Chain *p_unused;

        using CPA = AllocatorRebind<A, Chain *>;
        using CHA = AllocatorRebind<A, Chunk>;

        using CoreAllocPair = detail::CompressedPair<CPA, CHA>;
        using AllocPair = detail::CompressedPair<A, CoreAllocPair>;
        using FuncPair = detail::CompressedPair<H, C>;
        using FAPair = detail::CompressedPair<AllocPair, FuncPair>;
        using DataPair = detail::CompressedPair<Chain **, FAPair>;

        using Range = HashRange<E>;
        using ConstRange = HashRange<const E>;
        using LocalRange = BucketRange<E>;
        using ConstLocalRange = BucketRange<const E>;

        DataPair p_data;

        float p_maxlf;

        Range iter_from(Chain *c, Size h) {
            return Range(p_data.first() + h + 1,
                p_data.first() + bucket_count(), c);
        }
        ConstRange iter_from(Chain *c, Size h) const {
            using RChain = detail::HashChain<const E>;
            return ConstRange((RChain **)(p_data.first() + h + 1),
                              (RChain **)(p_data.first() + bucket_count()),
                              (RChain *)c);
        }

        bool find(const K &key, Size &h, Chain *&oc) const {
            if (!p_size) return false;
            h = get_hash()(key) & (p_size - 1);
            for (Chain *c = p_data.first()[h]; c; c = c->next) {
                if (get_eq()(key, B::get_key(c->value))) {
                    oc = c;
                    return true;
                }
            }
            return false;
        }

        Chain *insert(Size h) {
            if (!p_unused) {
                Chunk *chunk = allocator_allocate(get_challoc(), 1);
                allocator_construct(get_challoc(), chunk);
                chunk->next = p_chunks;
                p_chunks = chunk;
                for (Size i = 0; i < (CHUNKSIZE - 1); ++i)
                    chunk->chains[i].next = &chunk->chains[i + 1];
                chunk->chains[CHUNKSIZE - 1].next = p_unused;
                p_unused = chunk->chains;
            }
            Chain *c = p_unused;
            p_unused = p_unused->next;
            c->next = p_data.first()[h];
            p_data.first()[h] = c;
            ++p_len;
            return c;
        }

        void delete_chunks(Chunk *chunks) {
            for (Chunk *nc; chunks; chunks = nc) {
                nc = chunks->next;
                allocator_destroy(get_challoc(), chunks);
                allocator_deallocate(get_challoc(), chunks, 1);
            }
        }

        T *access_base(const K &key, Size &h) const {
            if (!p_size) return NULL;
            h = get_hash()(key) & (p_size - 1);
            for (Chain *c = p_data.first()[h]; c; c = c->next) {
                if (get_eq()(key, B::get_key(c->value)))
                    return &B::get_data(c->value);
            }
            return NULL;
        }

        void rehash_ahead(Size n) {
            if (!bucket_count())
                reserve(n);
            else if ((float(size() + n) / bucket_count()) > max_load_factor())
                rehash(Size((size() + 1) / max_load_factor()) * 2);
        }

protected:
        template<typename U>
        T &insert(Size h, U &&key) {
            Chain *c = insert(h);
            B::set_key(c->value, forward<U>(key), get_alloc());
            return B::get_data(c->value);
        }

        T &access_or_insert(const K &key) {
            Size h = 0;
            T *v = access_base(key, h);
            if (v) return *v;
            rehash_ahead(1);
            return insert(h, key);
        }

        T &access_or_insert(K &&key) {
            Size h = 0;
            T *v = access_base(key, h);
            if (v) return *v;
            rehash_ahead(1);
            return insert(h, move(key));
        }

        T &access(const K &key) const {
            Size h;
            return *access_base(key, h);
        }

        template<typename R>
        void assign_range(R range) {
            clear();
            reserve_at_least(detail::estimate_hrsize(range));
            for (; !range.empty(); range.pop_front())
                emplace(range.front());
            rehash_up();
        }

        void assign_init(InitializerList<E> il) {
            const E *beg = il.begin(), *end = il.end();
            clear();
            reserve_at_least(end - beg);
            while (beg != end)
                emplace(*beg++);
        }

        const H &get_hash() const { return p_data.second().second().first(); }
        const C &get_eq() const { return p_data.second().second().second(); }

        A &get_alloc() { return p_data.second().first().first(); }
        const A &get_alloc() const { return p_data.second().first().first(); }

        CPA &get_cpalloc() { return p_data.second().first().second().first(); }
        const CPA &get_cpalloc() const {
            return p_data.second().first().second().first();
        }

        CHA &get_challoc() { return p_data.second().first().second().second(); }
        const CHA &get_challoc() const {
            return p_data.second().first().second().second();
        }

        Hashtable(Size size, const H &hf, const C &eqf, const A &alloc):
        p_size(size), p_len(0), p_chunks(nullptr), p_unused(nullptr),
        p_data(nullptr, FAPair(AllocPair(alloc, CoreAllocPair(alloc, alloc)),
            FuncPair(hf, eqf))),
        p_maxlf(1.0f) {
            if (!size) return;
            p_data.first() = allocator_allocate(get_cpalloc(), size + 1);
            memset(p_data.first(), 0, (size + 1) * sizeof(Chain *));
        }

        Hashtable(const Hashtable &ht, const A &alloc): p_size(ht.p_size),
        p_len(0), p_chunks(nullptr), p_unused(nullptr),
        p_data(nullptr, FAPair(AllocPair(alloc, CoreAllocPair(alloc, alloc)),
            FuncPair(ht.get_hash(), ht.get_eq()))),
        p_maxlf(ht.p_maxlf) {
            if (!p_size) return;
            p_data.first() = allocator_allocate(get_cpalloc(), p_size + 1);
            memset(p_data.first(), 0, (p_size + 1) * sizeof(Chain *));
            Chain **och = ht.p_data.first();
            for (Size h = 0; h < p_size; ++h) {
                Chain *oc = och[h];
                for (; oc; oc = oc->next) {
                    Chain *nc = insert(h);
                    allocator_destroy(get_alloc(), &nc->value);
                    allocator_construct(get_alloc(), &nc->value, oc->value);
                }
            }
        }

        Hashtable(Hashtable &&ht): p_size(ht.p_size), p_len(ht.p_len),
        p_chunks(ht.p_chunks), p_unused(ht.p_unused),
        p_data(move(ht.p_data)), p_maxlf(ht.p_maxlf) {
            ht.p_size = ht.p_len = 0;
            ht.p_chunks = nullptr;
            ht.p_unused = nullptr;
            ht.p_data.first() = nullptr;
        }

        Hashtable(Hashtable &&ht, const A &alloc): p_data(nullptr,
            FAPair(AllocPair(alloc, CoreAllocPair(alloc, alloc)),
                FuncPair(ht.get_hash(), ht.get_eq()))) {
            p_size = ht.p_size;
            if (alloc == ht.get_alloc()) {
                p_len = ht.p_len;
                p_chunks = ht.p_chunks;
                p_unused = ht.p_unused;
                p_data.first() = ht.p_data.first();
                p_maxlf = ht.p_maxlf;
                ht.p_size = ht.p_len = 0;
                ht.p_chunks = nullptr;
                ht.p_unused = nullptr;
                ht.p_data.first() = nullptr;
                return;
            }
            p_len = 0;
            p_chunks = nullptr;
            p_unused = nullptr;
            p_data.first() = allocator_allocate(get_cpalloc(), p_size + 1);
            memset(p_data.first(), 0, (p_size + 1) * sizeof(Chain *));
            Chain **och = ht.p_data.first();
            for (Size h = 0; h < p_size; ++h) {
                Chain *oc = och[h];
                for (; oc; oc = oc->next) {
                    Chain *nc = insert(h);
                    B::swap_elem(oc->value, nc->value);
                }
            }
        }

        Hashtable &operator=(const Hashtable &ht) {
            clear();
            if (AllocatorPropagateOnContainerCopyAssignment<A>::value) {
                if ((get_cpalloc() != ht.get_cpalloc()) && p_size) {
                    allocator_deallocate(get_cpalloc(),
                        p_data.first(), p_size + 1);
                    p_data.first() = allocator_allocate(get_cpalloc(),
                        p_size + 1);
                    memset(p_data.first(), 0, (p_size + 1) * sizeof(Chain *));
                }
                get_alloc() = ht.get_alloc();
                get_cpalloc() = ht.get_cpalloc();
                get_challoc() = ht.get_challoc();
            }
            for (ConstRange range = ht.iter(); !range.empty(); range.pop_front())
                emplace(range.front());
            return *this;
        }

        Hashtable &operator=(Hashtable &&ht) {
            clear();
            swap_adl(p_size, ht.p_size);
            swap_adl(p_len, ht.p_len);
            swap_adl(p_chunks, ht.p_chunks);
            swap_adl(p_unused, ht.p_unused);
            swap_adl(p_data.first(), ht.p_data.first());
            swap_adl(p_data.second().second(), ht.p_data.second().second());
            if (AllocatorPropagateOnContainerMoveAssignment<A>::value)
                swap_adl(p_data.second().first(), ht.p_data.second().first());
            return *this;
        }

        void rehash_up() {
            if (load_factor() <= max_load_factor()) return;
            rehash(Size(size() / max_load_factor()) * 2);
        }

        void reserve_at_least(Size count) {
            Size nc = Size(ceil(count / max_load_factor()));
            if (p_size > nc) return;
            rehash(nc);
        }

        void swap(Hashtable &ht) {
            swap_adl(p_size, ht.p_size);
            swap_adl(p_len, ht.p_len);
            swap_adl(p_chunks, ht.p_chunks);
            swap_adl(p_unused, ht.p_unused);
            swap_adl(p_data.first(), ht.p_data.first());
            swap_adl(p_data.second().second(), ht.p_data.second().second());
            if (AllocatorPropagateOnContainerSwap<A>::value)
                swap_adl(p_data.second().first(), ht.p_data.second().first());
        }

public:
        ~Hashtable() {
            if (p_size) allocator_deallocate(get_cpalloc(),
                p_data.first(), p_size + 1);
            delete_chunks(p_chunks);
        }

        A get_allocator() const {
            return get_alloc();
        }

        void clear() {
            if (!p_len) return;
            memset(p_data.first(), 0, (p_size + 1) * sizeof(Chain *));
            p_len = 0;
            p_unused = nullptr;
            delete_chunks(p_chunks);
        }

        bool empty() const { return p_len == 0; }
        Size size() const { return p_len; }
        Size max_size() const { return Size(~0) / sizeof(E); }

        Size bucket_count() const { return p_size; }
        Size max_bucket_count() const { return Size(~0) / sizeof(Chain); }

        Size bucket(const K &key) const {
            return get_hash()(key) & (p_size - 1);
        }

        Size bucket_size(Size n) const {
            Size ret = 0;
            if (ret >= p_size) return ret;
            Chain *c = p_data.first()[n];
            if (!c) return ret;
            for (; c; c = c->next)
                ++ret;
            return ret;
        }

        template<typename ...Args>
        Pair<Range, bool> emplace(Args &&...args) {
            rehash_ahead(1);
            E elem(forward<Args>(args)...);
            Size h = get_hash()(B::get_key(elem)) & (p_size - 1);
            if (Multihash) {
                /* multihash: always insert */
                Chain *ch = insert(h);
                B::swap_elem(ch->value, elem);
                Chain **hch = p_data.first();
                return make_pair(Range(hch + h + 1, hch + bucket_count(),
                    ch), true);
            }
            Chain *found = nullptr;
            bool ins = true;
            for (Chain *c = p_data.first()[h]; c; c = c->next) {
                if (get_eq()(B::get_key(elem), B::get_key(c->value))) {
                    found = c;
                    ins = false;
                    break;
                }
            }
            if (!found) {
                found = insert(h);
                B::swap_elem(found->value, elem);
            }
            Chain **hch = p_data.first();
            return make_pair(Range(hch + h + 1, hch + bucket_count(),
                found), ins);
        }

        Size erase(const K &key) {
            if (!p_len) return 0;
            Size olen = p_len;
            Size h = get_hash()(key) & (p_size - 1);
            Chain **p = &p_data.first()[h], *c = *p;
            while (c) {
                if (get_eq()(key, B::get_key(c->value))) {
                    --p_len;
                    *p = c->next;
                    c->next = p_unused;
                    p_unused = c;
                    allocator_destroy(get_alloc(), &c->value);
                    allocator_construct(get_alloc(), &c->value);
                    if (!Multihash) return 1;
                } else {
                    p = &c->next;
                }
                c = *p;
            }
            return olen - p_len;
        }

        Size count(const K &key) {
            if (!p_len) return 0;
            Size h = get_hash()(key) & (p_size - 1);
            Size ret = 0;
            for (Chain *c = p_data.first()[h]; c; c = c->next)
                if (get_eq()(key, B::get_key(c->value))) {
                    ++ret;
                    if (!Multihash) break;
                }
            return ret;
        }

        Range find(const K &key) {
            Size h = 0;
            Chain *c;
            if (find(key, h, c)) return iter_from(c, h);
            return Range();
        }

        ConstRange find(const K &key) const {
            Size h = 0;
            Chain *c;
            if (find(key, h, c)) return iter_from(c, h);
            return ConstRange();
        }

        float load_factor() const { return float(p_len) / p_size; }
        float max_load_factor() const { return p_maxlf; }
        void max_load_factor(float lf) { p_maxlf = lf; }

        void rehash(Size count) {
            Size fbcount = Size(p_len / max_load_factor());
            if (fbcount > count) count = fbcount;

            Chain **och = p_data.first();
            Chain **nch = allocator_allocate(get_cpalloc(), count + 1);
            memset(nch, 0, (count + 1) * sizeof(Chain *));
            p_data.first() = nch;

            Size osize = p_size;
            p_size = count;

            for (Size i = 0; i < osize; ++i) {
                for (Chain *oc = och[i]; oc;) {
                    Size h = get_hash()(B::get_key(oc->value)) & (p_size - 1);
                    Chain *nxc = oc->next;
                    oc->next = nch[h];
                    nch[h] = oc;
                    oc = nxc;
                }
            }

            if (och && osize) allocator_deallocate(get_cpalloc(),
                och, osize);
        }

        void reserve(Size count) {
            rehash(Size(ceil(count / max_load_factor())));
        }

        Range iter() {
            return Range(p_data.first(), p_data.first() + bucket_count());
        }
        ConstRange iter() const {
            using Chain = detail::HashChain<const E>;
            return ConstRange((Chain **)p_data.first(),
                              (Chain **)(p_data.first() + bucket_count()));
        }
        ConstRange citer() const {
            using Chain = detail::HashChain<const E>;
            return ConstRange((Chain **)p_data.first(),
                              (Chain **)(p_data.first() + bucket_count()));
        }

        LocalRange iter(Size n) {
            if (n >= p_size) return LocalRange();
            return LocalRange(p_data.first()[n]);
        }
        ConstLocalRange iter(Size n) const {
            using Chain = detail::HashChain<const E>;
            if (n >= p_size) return ConstLocalRange();
            return ConstLocalRange((Chain *)p_data.first()[n]);
        }
        ConstLocalRange citer(Size n) const {
            using Chain = detail::HashChain<const E>;
            if (n >= p_size) return ConstLocalRange();
            return ConstLocalRange((Chain *)p_data.first()[n]);
        }
    };
} /* namespace detail */

} /* namespace ostd */

#endif