diff --git a/luprex/core/cpp/bytell-hash-map.hpp b/luprex/core/cpp/bytell-hash-map.hpp new file mode 100644 index 00000000..19c4b8be --- /dev/null +++ b/luprex/core/cpp/bytell-hash-map.hpp @@ -0,0 +1,1260 @@ +// Copyright Malte Skarupke 2017. +// Distributed under the Boost Software License, Version 1.0. +// (See http://www.boost.org/LICENSE_1_0.txt) + +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include "flat-hash-map.hpp" +#include +#include + +namespace ska +{ + +namespace detailv8 +{ +using ska::detailv3::functor_storage; +using ska::detailv3::KeyOrValueHasher; +using ska::detailv3::KeyOrValueEquality; +using ska::detailv3::AssignIfTrue; +using ska::detailv3::HashPolicySelector; + +template +struct sherwood_v8_constants +{ + static constexpr int8_t magic_for_empty = int8_t(0b11111111); + static constexpr int8_t magic_for_reserved = int8_t(0b11111110); + static constexpr int8_t bits_for_direct_hit = int8_t(0b10000000); + static constexpr int8_t magic_for_direct_hit = int8_t(0b00000000); + static constexpr int8_t magic_for_list_entry = int8_t(0b10000000); + + static constexpr int8_t bits_for_distance = int8_t(0b01111111); + inline static int distance_from_metadata(int8_t metadata) + { + return metadata & bits_for_distance; + } + + static constexpr int num_jump_distances = 126; + // jump distances chosen like this: + // 1. pick the first 16 integers to promote staying in the same block + // 2. add the next 66 triangular numbers to get even jumps when + // the hash table is a power of two + // 3. add 44 more triangular numbers at a much steeper growth rate + // to get a sequence that allows large jumps so that a table + // with 10000 sequential numbers doesn't endlessly re-allocate + static constexpr size_t jump_distances[num_jump_distances] + { + 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, + + 21, 28, 36, 45, 55, 66, 78, 91, 105, 120, 136, 153, 171, 190, 210, 231, + 253, 276, 300, 325, 351, 378, 406, 435, 465, 496, 528, 561, 595, 630, + 666, 703, 741, 780, 820, 861, 903, 946, 990, 1035, 1081, 1128, 1176, + 1225, 1275, 1326, 1378, 1431, 1485, 1540, 1596, 1653, 1711, 1770, 1830, + 1891, 1953, 2016, 2080, 2145, 2211, 2278, 2346, 2415, 2485, 2556, + + 3741, 8385, 18915, 42486, 95703, 215496, 485605, 1091503, 2456436, + 5529475, 12437578, 27986421, 62972253, 141700195, 318819126, 717314626, + 1614000520, 3631437253, 8170829695, 18384318876, 41364501751, + 93070021080, 209407709220, 471167588430, 1060127437995, 2385287281530, + 5366895564381, 12075513791265, 27169907873235, 61132301007778, + 137547673121001, 309482258302503, 696335090510256, 1566753939653640, + 3525196427195653, 7931691866727775, 17846306747368716, + 40154190394120111, 90346928493040500, 203280588949935750, + 457381324898247375, 1029107980662394500, 2315492957028380766, + 5209859150892887590, + }; +}; +template +constexpr int8_t sherwood_v8_constants::magic_for_empty; +template +constexpr int8_t sherwood_v8_constants::magic_for_reserved; +template +constexpr int8_t sherwood_v8_constants::bits_for_direct_hit; +template +constexpr int8_t sherwood_v8_constants::magic_for_direct_hit; +template +constexpr int8_t sherwood_v8_constants::magic_for_list_entry; + +template +constexpr int8_t sherwood_v8_constants::bits_for_distance; + +template +constexpr int sherwood_v8_constants::num_jump_distances; +template +constexpr size_t sherwood_v8_constants::jump_distances[num_jump_distances]; + +template +struct sherwood_v8_block +{ + sherwood_v8_block() + { + } + ~sherwood_v8_block() + { + } + int8_t control_bytes[BlockSize]; + union + { + T data[BlockSize]; + }; + + static sherwood_v8_block * empty_block() + { + static std::array empty_bytes = [] + { + std::array result; + result.fill(sherwood_v8_constants<>::magic_for_empty); + return result; + }(); + return reinterpret_cast(&empty_bytes); + } + + int first_empty_index() const + { + for (int i = 0; i < BlockSize; ++i) + { + if (control_bytes[i] == sherwood_v8_constants<>::magic_for_empty) + return i; + } + return -1; + } + + void fill_control_bytes(int8_t value) + { + std::fill(std::begin(control_bytes), std::end(control_bytes), value); + } +}; + +template +class sherwood_v8_table : private ByteAlloc, private Hasher, private Equal +{ + using AllocatorTraits = std::allocator_traits; + using BlockType = sherwood_v8_block; + using BlockPointer = BlockType *; + using BytePointer = typename AllocatorTraits::pointer; + struct convertible_to_iterator; + using Constants = sherwood_v8_constants<>; + +public: + + using value_type = T; + using size_type = size_t; + using difference_type = std::ptrdiff_t; + using hasher = ArgumentHash; + using key_equal = ArgumentEqual; + using allocator_type = ByteAlloc; + using reference = value_type &; + using const_reference = const value_type &; + using pointer = value_type *; + using const_pointer = const value_type *; + + sherwood_v8_table() + { + } + explicit sherwood_v8_table(size_type bucket_count, const ArgumentHash & hash = ArgumentHash(), const ArgumentEqual & equal = ArgumentEqual(), const ArgumentAlloc & alloc = ArgumentAlloc()) + : ByteAlloc(alloc), Hasher(hash), Equal(equal) + { + if (bucket_count) + rehash(bucket_count); + } + sherwood_v8_table(size_type bucket_count, const ArgumentAlloc & alloc) + : sherwood_v8_table(bucket_count, ArgumentHash(), ArgumentEqual(), alloc) + { + } + sherwood_v8_table(size_type bucket_count, const ArgumentHash & hash, const ArgumentAlloc & alloc) + : sherwood_v8_table(bucket_count, hash, ArgumentEqual(), alloc) + { + } + explicit sherwood_v8_table(const ArgumentAlloc & alloc) + : ByteAlloc(alloc) + { + } + template + sherwood_v8_table(It first, It last, size_type bucket_count = 0, const ArgumentHash & hash = ArgumentHash(), const ArgumentEqual & equal = ArgumentEqual(), const ArgumentAlloc & alloc = ArgumentAlloc()) + : sherwood_v8_table(bucket_count, hash, equal, alloc) + { + insert(first, last); + } + template + sherwood_v8_table(It first, It last, size_type bucket_count, const ArgumentAlloc & alloc) + : sherwood_v8_table(first, last, bucket_count, ArgumentHash(), ArgumentEqual(), alloc) + { + } + template + sherwood_v8_table(It first, It last, size_type bucket_count, const ArgumentHash & hash, const ArgumentAlloc & alloc) + : sherwood_v8_table(first, last, bucket_count, hash, ArgumentEqual(), alloc) + { + } + sherwood_v8_table(std::initializer_list il, size_type bucket_count = 0, const ArgumentHash & hash = ArgumentHash(), const ArgumentEqual & equal = ArgumentEqual(), const ArgumentAlloc & alloc = ArgumentAlloc()) + : sherwood_v8_table(bucket_count, hash, equal, alloc) + { + if (bucket_count == 0) + rehash(il.size()); + insert(il.begin(), il.end()); + } + sherwood_v8_table(std::initializer_list il, size_type bucket_count, const ArgumentAlloc & alloc) + : sherwood_v8_table(il, bucket_count, ArgumentHash(), ArgumentEqual(), alloc) + { + } + sherwood_v8_table(std::initializer_list il, size_type bucket_count, const ArgumentHash & hash, const ArgumentAlloc & alloc) + : sherwood_v8_table(il, bucket_count, hash, ArgumentEqual(), alloc) + { + } + sherwood_v8_table(const sherwood_v8_table & other) + : sherwood_v8_table(other, AllocatorTraits::select_on_container_copy_construction(other.get_allocator())) + { + } + sherwood_v8_table(const sherwood_v8_table & other, const ArgumentAlloc & alloc) + : ByteAlloc(alloc), Hasher(other), Equal(other), _max_load_factor(other._max_load_factor) + { + rehash_for_other_container(other); + try + { + insert(other.begin(), other.end()); + } + catch(...) + { + clear(); + deallocate_data(entries, num_slots_minus_one); + throw; + } + } + sherwood_v8_table(sherwood_v8_table && other) noexcept + : ByteAlloc(std::move(other)), Hasher(std::move(other)), Equal(std::move(other)) + , _max_load_factor(other._max_load_factor) + { + swap_pointers(other); + } + sherwood_v8_table(sherwood_v8_table && other, const ArgumentAlloc & alloc) noexcept + : ByteAlloc(alloc), Hasher(std::move(other)), Equal(std::move(other)) + , _max_load_factor(other._max_load_factor) + { + swap_pointers(other); + } + sherwood_v8_table & operator=(const sherwood_v8_table & other) + { + if (this == std::addressof(other)) + return *this; + + clear(); + if (AllocatorTraits::propagate_on_container_copy_assignment::value) + { + if (static_cast(*this) != static_cast(other)) + { + reset_to_empty_state(); + } + AssignIfTrue()(*this, other); + } + _max_load_factor = other._max_load_factor; + static_cast(*this) = other; + static_cast(*this) = other; + rehash_for_other_container(other); + insert(other.begin(), other.end()); + return *this; + } + sherwood_v8_table & operator=(sherwood_v8_table && other) noexcept + { + if (this == std::addressof(other)) + return *this; + else if (AllocatorTraits::propagate_on_container_move_assignment::value) + { + clear(); + reset_to_empty_state(); + AssignIfTrue()(*this, std::move(other)); + swap_pointers(other); + } + else if (static_cast(*this) == static_cast(other)) + { + swap_pointers(other); + } + else + { + clear(); + _max_load_factor = other._max_load_factor; + rehash_for_other_container(other); + for (T & elem : other) + emplace(std::move(elem)); + other.clear(); + } + static_cast(*this) = std::move(other); + static_cast(*this) = std::move(other); + return *this; + } + ~sherwood_v8_table() + { + clear(); + deallocate_data(entries, num_slots_minus_one); + } + + const allocator_type & get_allocator() const + { + return static_cast(*this); + } + const ArgumentEqual & key_eq() const + { + return static_cast(*this); + } + const ArgumentHash & hash_function() const + { + return static_cast(*this); + } + + template + struct templated_iterator + { + private: + friend class sherwood_v8_table; + BlockPointer current = BlockPointer(); + size_t index = 0; + + public: + templated_iterator() + { + } + templated_iterator(BlockPointer entries, size_t index) + : current(entries) + , index(index) + { + } + + using iterator_category = std::forward_iterator_tag; + using value_type = ValueType; + using difference_type = ptrdiff_t; + using pointer = ValueType *; + using reference = ValueType &; + + friend bool operator==(const templated_iterator & lhs, const templated_iterator & rhs) + { + return lhs.index == rhs.index; + } + friend bool operator!=(const templated_iterator & lhs, const templated_iterator & rhs) + { + return !(lhs == rhs); + } + + templated_iterator & operator++() + { + do + { + if (index % BlockSize == 0) + --current; + if (index-- == 0) + break; + } + while(current->control_bytes[index % BlockSize] == Constants::magic_for_empty); + return *this; + } + templated_iterator operator++(int) + { + templated_iterator copy(*this); + ++*this; + return copy; + } + + ValueType & operator*() const + { + return current->data[index % BlockSize]; + } + ValueType * operator->() const + { + return current->data + index % BlockSize; + } + + operator templated_iterator() const + { + return { current, index }; + } + }; + using iterator = templated_iterator; + using const_iterator = templated_iterator; + + iterator begin() + { + size_t num_slots = num_slots_minus_one ? num_slots_minus_one + 1 : 0; + return ++iterator{ entries + num_slots / BlockSize, num_slots }; + } + const_iterator begin() const + { + size_t num_slots = num_slots_minus_one ? num_slots_minus_one + 1 : 0; + return ++iterator{ entries + num_slots / BlockSize, num_slots }; + } + const_iterator cbegin() const + { + return begin(); + } + iterator end() + { + return { entries - 1, std::numeric_limits::max() }; + } + const_iterator end() const + { + return { entries - 1, std::numeric_limits::max() }; + } + const_iterator cend() const + { + return end(); + } + + inline iterator find(const FindKey & key) + { + size_t index = hash_object(key); + size_t num_slots_minus_one = this->num_slots_minus_one; + BlockPointer entries = this->entries; + index = hash_policy.index_for_hash(index, num_slots_minus_one); + bool first = true; + for (;;) + { + size_t block_index = index / BlockSize; + int index_in_block = index % BlockSize; + BlockPointer block = entries + block_index; + int8_t metadata = block->control_bytes[index_in_block]; + if (first) + { + if ((metadata & Constants::bits_for_direct_hit) != Constants::magic_for_direct_hit) + return end(); + first = false; + } + if (compares_equal(key, block->data[index_in_block])) + return { block, index }; + int8_t to_next_index = metadata & Constants::bits_for_distance; + if (to_next_index == 0) + return end(); + index += Constants::jump_distances[to_next_index]; + index = hash_policy.keep_in_range(index, num_slots_minus_one); + } + } + inline const_iterator find(const FindKey & key) const + { + return const_cast(this)->find(key); + } + size_t count(const FindKey & key) const + { + return find(key) == end() ? 0 : 1; + } + std::pair equal_range(const FindKey & key) + { + iterator found = find(key); + if (found == end()) + return { found, found }; + else + return { found, std::next(found) }; + } + std::pair equal_range(const FindKey & key) const + { + const_iterator found = find(key); + if (found == end()) + return { found, found }; + else + return { found, std::next(found) }; + } + + + template + inline std::pair emplace(Key && key, Args &&... args) + { + size_t index = hash_object(key); + size_t num_slots_minus_one = this->num_slots_minus_one; + BlockPointer entries = this->entries; + index = hash_policy.index_for_hash(index, num_slots_minus_one); + bool first = true; + for (;;) + { + size_t block_index = index / BlockSize; + int index_in_block = index % BlockSize; + BlockPointer block = entries + block_index; + int8_t metadata = block->control_bytes[index_in_block]; + if (first) + { + if ((metadata & Constants::bits_for_direct_hit) != Constants::magic_for_direct_hit) + return emplace_direct_hit({ index, block }, std::forward(key), std::forward(args)...); + first = false; + } + if (compares_equal(key, block->data[index_in_block])) + return { { block, index }, false }; + int8_t to_next_index = metadata & Constants::bits_for_distance; + if (to_next_index == 0) + return emplace_new_key({ index, block }, std::forward(key), std::forward(args)...); + index += Constants::jump_distances[to_next_index]; + index = hash_policy.keep_in_range(index, num_slots_minus_one); + } + } + + std::pair insert(const value_type & value) + { + return emplace(value); + } + std::pair insert(value_type && value) + { + return emplace(std::move(value)); + } + template + iterator emplace_hint(const_iterator, Args &&... args) + { + return emplace(std::forward(args)...).first; + } + iterator insert(const_iterator, const value_type & value) + { + return emplace(value).first; + } + iterator insert(const_iterator, value_type && value) + { + return emplace(std::move(value)).first; + } + + template + void insert(It begin, It end) + { + for (; begin != end; ++begin) + { + emplace(*begin); + } + } + void insert(std::initializer_list il) + { + insert(il.begin(), il.end()); + } + + void rehash(size_t num_items) + { + num_items = std::max(num_items, static_cast(std::ceil(num_elements / static_cast(_max_load_factor)))); + if (num_items == 0) + { + reset_to_empty_state(); + return; + } + auto new_prime_index = hash_policy.next_size_over(num_items); + if (num_items == num_slots_minus_one + 1) + return; + size_t num_blocks = num_items / BlockSize; + if (num_items % BlockSize) + ++num_blocks; + size_t memory_requirement = calculate_memory_requirement(num_blocks); + unsigned char * new_memory = &*AllocatorTraits::allocate(*this, memory_requirement); + + BlockPointer new_buckets = reinterpret_cast(new_memory); + + BlockPointer special_end_item = new_buckets + num_blocks; + for (BlockPointer it = new_buckets; it <= special_end_item; ++it) + it->fill_control_bytes(Constants::magic_for_empty); + using std::swap; + swap(entries, new_buckets); + swap(num_slots_minus_one, num_items); + --num_slots_minus_one; + hash_policy.commit(new_prime_index); + num_elements = 0; + if (num_items) + ++num_items; + size_t old_num_blocks = num_items / BlockSize; + if (num_items % BlockSize) + ++old_num_blocks; + for (BlockPointer it = new_buckets, end = new_buckets + old_num_blocks; it != end; ++it) + { + for (int i = 0; i < BlockSize; ++i) + { + int8_t metadata = it->control_bytes[i]; + if (metadata != Constants::magic_for_empty && metadata != Constants::magic_for_reserved) + { + emplace(std::move(it->data[i])); + AllocatorTraits::destroy(*this, it->data + i); + } + } + } + deallocate_data(new_buckets, num_items - 1); + } + + void reserve(size_t num_elements) + { + size_t required_buckets = num_buckets_for_reserve(num_elements); + if (required_buckets > bucket_count()) + rehash(required_buckets); + } + + // the return value is a type that can be converted to an iterator + // the reason for doing this is that it's not free to find the + // iterator pointing at the next element. if you care about the + // next iterator, turn the return value into an iterator + convertible_to_iterator erase(const_iterator to_erase) + { + LinkedListIt current = { to_erase.index, to_erase.current }; + if (current.has_next()) + { + LinkedListIt previous = current; + LinkedListIt next = current.next(*this); + while (next.has_next()) + { + previous = next; + next = next.next(*this); + } + AllocatorTraits::destroy(*this, std::addressof(*current)); + AllocatorTraits::construct(*this, std::addressof(*current), std::move(*next)); + AllocatorTraits::destroy(*this, std::addressof(*next)); + next.set_metadata(Constants::magic_for_empty); + previous.clear_next(); + } + else + { + if (!current.is_direct_hit()) + find_parent_block(current).clear_next(); + AllocatorTraits::destroy(*this, std::addressof(*current)); + current.set_metadata(Constants::magic_for_empty); + } + --num_elements; + return { to_erase.current, to_erase.index }; + } + + iterator erase(const_iterator begin_it, const_iterator end_it) + { + if (begin_it == end_it) + return { begin_it.current, begin_it.index }; + if (std::next(begin_it) == end_it) + return erase(begin_it); + if (begin_it == begin() && end_it == end()) + { + clear(); + return { end_it.current, end_it.index }; + } + std::vector> depth_in_chain; + for (const_iterator it = begin_it; it != end_it; ++it) + { + LinkedListIt list_it(it.index, it.current); + if (list_it.is_direct_hit()) + depth_in_chain.emplace_back(0, list_it); + else + { + LinkedListIt root = find_direct_hit(list_it); + int distance = 1; + for (;;) + { + LinkedListIt next = root.next(*this); + if (next == list_it) + break; + ++distance; + root = next; + } + depth_in_chain.emplace_back(distance, list_it); + } + } + std::sort(depth_in_chain.begin(), depth_in_chain.end(), [](const auto & a, const auto & b) { return a.first < b.first; }); + for (auto it = depth_in_chain.rbegin(), end = depth_in_chain.rend(); it != end; ++it) + { + erase(it->second.it()); + } + + if (begin_it.current->control_bytes[begin_it.index % BlockSize] == Constants::magic_for_empty) + return ++iterator{ begin_it.current, begin_it.index }; + else + return { begin_it.current, begin_it.index }; + } + + size_t erase(const FindKey & key) + { + auto found = find(key); + if (found == end()) + return 0; + else + { + erase(found); + return 1; + } + } + + void clear() + { + if (!num_slots_minus_one) + return; + size_t num_slots = num_slots_minus_one + 1; + size_t num_blocks = num_slots / BlockSize; + if (num_slots % BlockSize) + ++num_blocks; + for (BlockPointer it = entries, end = it + num_blocks; it != end; ++it) + { + for (int i = 0; i < BlockSize; ++i) + { + if (it->control_bytes[i] != Constants::magic_for_empty) + { + AllocatorTraits::destroy(*this, std::addressof(it->data[i])); + it->control_bytes[i] = Constants::magic_for_empty; + } + } + } + num_elements = 0; + } + + void shrink_to_fit() + { + rehash_for_other_container(*this); + } + + void swap(sherwood_v8_table & other) + { + using std::swap; + swap_pointers(other); + swap(static_cast(*this), static_cast(other)); + swap(static_cast(*this), static_cast(other)); + if (AllocatorTraits::propagate_on_container_swap::value) + swap(static_cast(*this), static_cast(other)); + } + + size_t size() const + { + return num_elements; + } + size_t max_size() const + { + return (AllocatorTraits::max_size(*this)) / sizeof(T); + } + size_t bucket_count() const + { + return num_slots_minus_one ? num_slots_minus_one + 1 : 0; + } + size_type max_bucket_count() const + { + return (AllocatorTraits::max_size(*this)) / sizeof(T); + } + size_t bucket(const FindKey & key) const + { + return hash_policy.index_for_hash(hash_object(key), num_slots_minus_one); + } + float load_factor() const + { + return static_cast(num_elements) / (num_slots_minus_one + 1); + } + void max_load_factor(float value) + { + _max_load_factor = value; + } + float max_load_factor() const + { + return _max_load_factor; + } + + bool empty() const + { + return num_elements == 0; + } + +private: + BlockPointer entries = BlockType::empty_block(); + size_t num_slots_minus_one = 0; + typename HashPolicySelector::type hash_policy; + float _max_load_factor = 0.9375f; + size_t num_elements = 0; + + size_t num_buckets_for_reserve(size_t num_elements) const + { + return static_cast(std::ceil(num_elements / static_cast(_max_load_factor))); + } + void rehash_for_other_container(const sherwood_v8_table & other) + { + rehash(std::min(num_buckets_for_reserve(other.size()), other.bucket_count())); + } + bool is_full() const + { + if (!num_slots_minus_one) + return true; + else + return num_elements + 1 > (num_slots_minus_one + 1) * static_cast(_max_load_factor); + } + + void swap_pointers(sherwood_v8_table & other) + { + using std::swap; + swap(hash_policy, other.hash_policy); + swap(entries, other.entries); + swap(num_slots_minus_one, other.num_slots_minus_one); + swap(num_elements, other.num_elements); + swap(_max_load_factor, other._max_load_factor); + } + + struct LinkedListIt + { + size_t index = 0; + BlockPointer block = nullptr; + + LinkedListIt() + { + } + LinkedListIt(size_t index, BlockPointer block) + : index(index), block(block) + { + } + + iterator it() const + { + return { block, index }; + } + int index_in_block() const + { + return index % BlockSize; + } + bool is_direct_hit() const + { + return (metadata() & Constants::bits_for_direct_hit) == Constants::magic_for_direct_hit; + } + bool is_empty() const + { + return metadata() == Constants::magic_for_empty; + } + bool has_next() const + { + return jump_index() != 0; + } + int8_t jump_index() const + { + return Constants::distance_from_metadata(metadata()); + } + int8_t metadata() const + { + return block->control_bytes[index_in_block()]; + } + void set_metadata(int8_t metadata) + { + block->control_bytes[index_in_block()] = metadata; + } + + LinkedListIt next(sherwood_v8_table & table) const + { + int8_t distance = jump_index(); + size_t next_index = table.hash_policy.keep_in_range(index + Constants::jump_distances[distance], table.num_slots_minus_one); + return { next_index, table.entries + next_index / BlockSize }; + } + void set_next(int8_t jump_index) + { + int8_t & metadata = block->control_bytes[index_in_block()]; + metadata = (metadata & ~Constants::bits_for_distance) | jump_index; + } + void clear_next() + { + set_next(0); + } + + value_type & operator*() const + { + return block->data[index_in_block()]; + } + bool operator!() const + { + return !block; + } + explicit operator bool() const + { + return block != nullptr; + } + bool operator==(const LinkedListIt & other) const + { + return index == other.index; + } + bool operator!=(const LinkedListIt & other) const + { + return !(*this == other); + } + }; + + template + SKA_NOINLINE(std::pair) emplace_direct_hit(LinkedListIt block, Args &&... args) + { + using std::swap; + if (is_full()) + { + grow(); + return emplace(std::forward(args)...); + } + if (block.metadata() == Constants::magic_for_empty) + { + AllocatorTraits::construct(*this, std::addressof(*block), std::forward(args)...); + block.set_metadata(Constants::magic_for_direct_hit); + ++num_elements; + return { block.it(), true }; + } + else + { + LinkedListIt parent_block = find_parent_block(block); + std::pair free_block = find_free_index(parent_block); + if (!free_block.first) + { + grow(); + return emplace(std::forward(args)...); + } + value_type new_value(std::forward(args)...); + for (LinkedListIt it = block;;) + { + AllocatorTraits::construct(*this, std::addressof(*free_block.second), std::move(*it)); + AllocatorTraits::destroy(*this, std::addressof(*it)); + parent_block.set_next(free_block.first); + free_block.second.set_metadata(Constants::magic_for_list_entry); + if (!it.has_next()) + { + it.set_metadata(Constants::magic_for_empty); + break; + } + LinkedListIt next = it.next(*this); + it.set_metadata(Constants::magic_for_empty); + block.set_metadata(Constants::magic_for_reserved); + it = next; + parent_block = free_block.second; + free_block = find_free_index(free_block.second); + if (!free_block.first) + { + grow(); + return emplace(std::move(new_value)); + } + } + AllocatorTraits::construct(*this, std::addressof(*block), std::move(new_value)); + block.set_metadata(Constants::magic_for_direct_hit); + ++num_elements; + return { block.it(), true }; + } + } + + template + SKA_NOINLINE(std::pair) emplace_new_key(LinkedListIt parent, Args &&... args) + { + if (is_full()) + { + grow(); + return emplace(std::forward(args)...); + } + std::pair free_block = find_free_index(parent); + if (!free_block.first) + { + grow(); + return emplace(std::forward(args)...); + } + AllocatorTraits::construct(*this, std::addressof(*free_block.second), std::forward(args)...); + free_block.second.set_metadata(Constants::magic_for_list_entry); + parent.set_next(free_block.first); + ++num_elements; + return { free_block.second.it(), true }; + } + + LinkedListIt find_direct_hit(LinkedListIt child) const + { + size_t to_move_hash = hash_object(*child); + size_t to_move_index = hash_policy.index_for_hash(to_move_hash, num_slots_minus_one); + return { to_move_index, entries + to_move_index / BlockSize }; + } + LinkedListIt find_parent_block(LinkedListIt child) + { + LinkedListIt parent_block = find_direct_hit(child); + for (;;) + { + LinkedListIt next = parent_block.next(*this); + if (next == child) + return parent_block; + parent_block = next; + } + } + + std::pair find_free_index(LinkedListIt parent) const + { + for (int8_t jump_index = 1; jump_index < Constants::num_jump_distances; ++jump_index) + { + size_t index = hash_policy.keep_in_range(parent.index + Constants::jump_distances[jump_index], num_slots_minus_one); + BlockPointer block = entries + index / BlockSize; + if (block->control_bytes[index % BlockSize] == Constants::magic_for_empty) + return { jump_index, { index, block } }; + } + return { 0, {} }; + } + + void grow() + { + rehash(std::max(size_t(10), 2 * bucket_count())); + } + + size_t calculate_memory_requirement(size_t num_blocks) + { + size_t memory_required = sizeof(BlockType) * num_blocks; + memory_required += BlockSize; // for metadata of past-the-end pointer + return memory_required; + } + + void deallocate_data(BlockPointer begin, size_t num_slots_minus_one) + { + if (begin == BlockType::empty_block()) + return; + + ++num_slots_minus_one; + size_t num_blocks = num_slots_minus_one / BlockSize; + if (num_slots_minus_one % BlockSize) + ++num_blocks; + size_t memory = calculate_memory_requirement(num_blocks); + unsigned char * as_byte_pointer = reinterpret_cast(begin); + AllocatorTraits::deallocate(*this, typename AllocatorTraits::pointer(as_byte_pointer), memory); + } + + void reset_to_empty_state() + { + deallocate_data(entries, num_slots_minus_one); + entries = BlockType::empty_block(); + num_slots_minus_one = 0; + hash_policy.reset(); + } + + template + size_t hash_object(const U & key) + { + return static_cast(*this)(key); + } + template + size_t hash_object(const U & key) const + { + return static_cast(*this)(key); + } + template + bool compares_equal(const L & lhs, const R & rhs) + { + return static_cast(*this)(lhs, rhs); + } + + struct convertible_to_iterator + { + BlockPointer it; + size_t index; + + operator iterator() + { + if (it->control_bytes[index % BlockSize] == Constants::magic_for_empty) + return ++iterator{it, index}; + else + return { it, index }; + } + operator const_iterator() + { + if (it->control_bytes[index % BlockSize] == Constants::magic_for_empty) + return ++iterator{it, index}; + else + return { it, index }; + } + }; +}; +template +struct AlignmentOr8Bytes +{ + static constexpr size_t value = 8; +}; +template +struct AlignmentOr8Bytes= 1>::type> +{ + static constexpr size_t value = alignof(T); +}; +template +struct CalculateBytellBlockSize; +template +struct CalculateBytellBlockSize +{ + static constexpr size_t this_value = AlignmentOr8Bytes::value; + static constexpr size_t base_value = CalculateBytellBlockSize::value; + static constexpr size_t value = this_value > base_value ? this_value : base_value; +}; +template<> +struct CalculateBytellBlockSize<> +{ + static constexpr size_t value = 8; +}; +} + +template, typename E = std::equal_to, typename A = std::allocator > > +class bytell_hash_map + : public detailv8::sherwood_v8_table + < + std::pair, + K, + H, + detailv8::KeyOrValueHasher, H>, + E, + detailv8::KeyOrValueEquality, E>, + A, + typename std::allocator_traits::template rebind_alloc, + detailv8::CalculateBytellBlockSize::value + > +{ + using Table = detailv8::sherwood_v8_table + < + std::pair, + K, + H, + detailv8::KeyOrValueHasher, H>, + E, + detailv8::KeyOrValueEquality, E>, + A, + typename std::allocator_traits::template rebind_alloc, + detailv8::CalculateBytellBlockSize::value + >; +public: + + using key_type = K; + using mapped_type = V; + + using Table::Table; + bytell_hash_map() + { + } + + inline V & operator[](const K & key) + { + return emplace(key, convertible_to_value()).first->second; + } + inline V & operator[](K && key) + { + return emplace(std::move(key), convertible_to_value()).first->second; + } + V & at(const K & key) + { + auto found = this->find(key); + if (found == this->end()) + throw std::out_of_range("Argument passed to at() was not in the map."); + return found->second; + } + const V & at(const K & key) const + { + auto found = this->find(key); + if (found == this->end()) + throw std::out_of_range("Argument passed to at() was not in the map."); + return found->second; + } + + using Table::emplace; + std::pair emplace() + { + return emplace(key_type(), convertible_to_value()); + } + template + std::pair insert_or_assign(const key_type & key, M && m) + { + auto emplace_result = emplace(key, std::forward(m)); + if (!emplace_result.second) + emplace_result.first->second = std::forward(m); + return emplace_result; + } + template + std::pair insert_or_assign(key_type && key, M && m) + { + auto emplace_result = emplace(std::move(key), std::forward(m)); + if (!emplace_result.second) + emplace_result.first->second = std::forward(m); + return emplace_result; + } + template + typename Table::iterator insert_or_assign(typename Table::const_iterator, const key_type & key, M && m) + { + return insert_or_assign(key, std::forward(m)).first; + } + template + typename Table::iterator insert_or_assign(typename Table::const_iterator, key_type && key, M && m) + { + return insert_or_assign(std::move(key), std::forward(m)).first; + } + + friend bool operator==(const bytell_hash_map & lhs, const bytell_hash_map & rhs) + { + if (lhs.size() != rhs.size()) + return false; + for (const typename Table::value_type & value : lhs) + { + auto found = rhs.find(value.first); + if (found == rhs.end()) + return false; + else if (value.second != found->second) + return false; + } + return true; + } + friend bool operator!=(const bytell_hash_map & lhs, const bytell_hash_map & rhs) + { + return !(lhs == rhs); + } + +private: + struct convertible_to_value + { + operator V() const + { + return V(); + } + }; +}; + +template, typename E = std::equal_to, typename A = std::allocator > +class bytell_hash_set + : public detailv8::sherwood_v8_table + < + T, + T, + H, + detailv8::functor_storage, + E, + detailv8::functor_storage, + A, + typename std::allocator_traits::template rebind_alloc, + detailv8::CalculateBytellBlockSize::value + > +{ + using Table = detailv8::sherwood_v8_table + < + T, + T, + H, + detailv8::functor_storage, + E, + detailv8::functor_storage, + A, + typename std::allocator_traits::template rebind_alloc, + detailv8::CalculateBytellBlockSize::value + >; +public: + + using key_type = T; + + using Table::Table; + bytell_hash_set() + { + } + + template + std::pair emplace(Args &&... args) + { + return Table::emplace(T(std::forward(args)...)); + } + std::pair emplace(const key_type & arg) + { + return Table::emplace(arg); + } + std::pair emplace(key_type & arg) + { + return Table::emplace(arg); + } + std::pair emplace(const key_type && arg) + { + return Table::emplace(std::move(arg)); + } + std::pair emplace(key_type && arg) + { + return Table::emplace(std::move(arg)); + } + + friend bool operator==(const bytell_hash_set & lhs, const bytell_hash_set & rhs) + { + if (lhs.size() != rhs.size()) + return false; + for (const T & value : lhs) + { + if (rhs.find(value) == rhs.end()) + return false; + } + return true; + } + friend bool operator!=(const bytell_hash_set & lhs, const bytell_hash_set & rhs) + { + return !(lhs == rhs); + } +}; + +} // end namespace ska diff --git a/luprex/core/cpp/flat-hash-map.hpp b/luprex/core/cpp/flat-hash-map.hpp new file mode 100644 index 00000000..a8723ee8 --- /dev/null +++ b/luprex/core/cpp/flat-hash-map.hpp @@ -0,0 +1,1496 @@ +// Copyright Malte Skarupke 2017. +// Distributed under the Boost Software License, Version 1.0. +// (See http://www.boost.org/LICENSE_1_0.txt) + +#pragma once + +#include +#include +#include +#include +#include +#include +#include +#include + +#ifdef _MSC_VER +#define SKA_NOINLINE(...) __declspec(noinline) __VA_ARGS__ +#else +#define SKA_NOINLINE(...) __VA_ARGS__ __attribute__((noinline)) +#endif + +namespace ska +{ +struct prime_number_hash_policy; +struct power_of_two_hash_policy; +struct fibonacci_hash_policy; + +namespace detailv3 +{ +template +struct functor_storage : Functor +{ + functor_storage() = default; + functor_storage(const Functor & functor) + : Functor(functor) + { + } + template + Result operator()(Args &&... args) + { + return static_cast(*this)(std::forward(args)...); + } + template + Result operator()(Args &&... args) const + { + return static_cast(*this)(std::forward(args)...); + } +}; +template +struct functor_storage +{ + typedef Result (*function_ptr)(Args...); + function_ptr function; + functor_storage(function_ptr function) + : function(function) + { + } + Result operator()(Args... args) const + { + return function(std::forward(args)...); + } + operator function_ptr &() + { + return function; + } + operator const function_ptr &() + { + return function; + } +}; +template +struct KeyOrValueHasher : functor_storage +{ + typedef functor_storage hasher_storage; + KeyOrValueHasher() = default; + KeyOrValueHasher(const hasher & hash) + : hasher_storage(hash) + { + } + size_t operator()(const key_type & key) + { + return static_cast(*this)(key); + } + size_t operator()(const key_type & key) const + { + return static_cast(*this)(key); + } + size_t operator()(const value_type & value) + { + return static_cast(*this)(value.first); + } + size_t operator()(const value_type & value) const + { + return static_cast(*this)(value.first); + } + template + size_t operator()(const std::pair & value) + { + return static_cast(*this)(value.first); + } + template + size_t operator()(const std::pair & value) const + { + return static_cast(*this)(value.first); + } +}; +template +struct KeyOrValueEquality : functor_storage +{ + typedef functor_storage equality_storage; + KeyOrValueEquality() = default; + KeyOrValueEquality(const key_equal & equality) + : equality_storage(equality) + { + } + bool operator()(const key_type & lhs, const key_type & rhs) + { + return static_cast(*this)(lhs, rhs); + } + bool operator()(const key_type & lhs, const value_type & rhs) + { + return static_cast(*this)(lhs, rhs.first); + } + bool operator()(const value_type & lhs, const key_type & rhs) + { + return static_cast(*this)(lhs.first, rhs); + } + bool operator()(const value_type & lhs, const value_type & rhs) + { + return static_cast(*this)(lhs.first, rhs.first); + } + template + bool operator()(const key_type & lhs, const std::pair & rhs) + { + return static_cast(*this)(lhs, rhs.first); + } + template + bool operator()(const std::pair & lhs, const key_type & rhs) + { + return static_cast(*this)(lhs.first, rhs); + } + template + bool operator()(const value_type & lhs, const std::pair & rhs) + { + return static_cast(*this)(lhs.first, rhs.first); + } + template + bool operator()(const std::pair & lhs, const value_type & rhs) + { + return static_cast(*this)(lhs.first, rhs.first); + } + template + bool operator()(const std::pair & lhs, const std::pair & rhs) + { + return static_cast(*this)(lhs.first, rhs.first); + } +}; +static constexpr int8_t min_lookups = 4; +template +struct sherwood_v3_entry +{ + sherwood_v3_entry() + { + } + sherwood_v3_entry(int8_t distance_from_desired) + : distance_from_desired(distance_from_desired) + { + } + ~sherwood_v3_entry() + { + } + static sherwood_v3_entry * empty_default_table() + { + static sherwood_v3_entry result[min_lookups] = { {}, {}, {}, {special_end_value} }; + return result; + } + + bool has_value() const + { + return distance_from_desired >= 0; + } + bool is_empty() const + { + return distance_from_desired < 0; + } + bool is_at_desired_position() const + { + return distance_from_desired <= 0; + } + template + void emplace(int8_t distance, Args &&... args) + { + new (std::addressof(value)) T(std::forward(args)...); + distance_from_desired = distance; + } + + void destroy_value() + { + value.~T(); + distance_from_desired = -1; + } + + int8_t distance_from_desired = -1; + static constexpr int8_t special_end_value = 0; + union { T value; }; +}; + +inline int8_t log2(size_t value) +{ + static constexpr int8_t table[64] = + { + 63, 0, 58, 1, 59, 47, 53, 2, + 60, 39, 48, 27, 54, 33, 42, 3, + 61, 51, 37, 40, 49, 18, 28, 20, + 55, 30, 34, 11, 43, 14, 22, 4, + 62, 57, 46, 52, 38, 26, 32, 41, + 50, 36, 17, 19, 29, 10, 13, 21, + 56, 45, 25, 31, 35, 16, 9, 12, + 44, 24, 15, 8, 23, 7, 6, 5 + }; + value |= value >> 1; + value |= value >> 2; + value |= value >> 4; + value |= value >> 8; + value |= value >> 16; + value |= value >> 32; + return table[((value - (value >> 1)) * 0x07EDD5E59A4E28C2) >> 58]; +} + +template +struct AssignIfTrue +{ + void operator()(T & lhs, const T & rhs) + { + lhs = rhs; + } + void operator()(T & lhs, T && rhs) + { + lhs = std::move(rhs); + } +}; +template +struct AssignIfTrue +{ + void operator()(T &, const T &) + { + } + void operator()(T &, T &&) + { + } +}; + +inline size_t next_power_of_two(size_t i) +{ + --i; + i |= i >> 1; + i |= i >> 2; + i |= i >> 4; + i |= i >> 8; + i |= i >> 16; + i |= i >> 32; + ++i; + return i; +} + +template using void_t = void; + +template +struct HashPolicySelector +{ + typedef fibonacci_hash_policy type; +}; +template +struct HashPolicySelector> +{ + typedef typename T::hash_policy type; +}; + +template +class sherwood_v3_table : private EntryAlloc, private Hasher, private Equal +{ + using Entry = detailv3::sherwood_v3_entry; + using AllocatorTraits = std::allocator_traits; + using EntryPointer = typename AllocatorTraits::pointer; + struct convertible_to_iterator; + +public: + + using value_type = T; + using size_type = size_t; + using difference_type = std::ptrdiff_t; + using hasher = ArgumentHash; + using key_equal = ArgumentEqual; + using allocator_type = EntryAlloc; + using reference = value_type &; + using const_reference = const value_type &; + using pointer = value_type *; + using const_pointer = const value_type *; + + sherwood_v3_table() + { + } + explicit sherwood_v3_table(size_type bucket_count, const ArgumentHash & hash = ArgumentHash(), const ArgumentEqual & equal = ArgumentEqual(), const ArgumentAlloc & alloc = ArgumentAlloc()) + : EntryAlloc(alloc), Hasher(hash), Equal(equal) + { + rehash(bucket_count); + } + sherwood_v3_table(size_type bucket_count, const ArgumentAlloc & alloc) + : sherwood_v3_table(bucket_count, ArgumentHash(), ArgumentEqual(), alloc) + { + } + sherwood_v3_table(size_type bucket_count, const ArgumentHash & hash, const ArgumentAlloc & alloc) + : sherwood_v3_table(bucket_count, hash, ArgumentEqual(), alloc) + { + } + explicit sherwood_v3_table(const ArgumentAlloc & alloc) + : EntryAlloc(alloc) + { + } + template + sherwood_v3_table(It first, It last, size_type bucket_count = 0, const ArgumentHash & hash = ArgumentHash(), const ArgumentEqual & equal = ArgumentEqual(), const ArgumentAlloc & alloc = ArgumentAlloc()) + : sherwood_v3_table(bucket_count, hash, equal, alloc) + { + insert(first, last); + } + template + sherwood_v3_table(It first, It last, size_type bucket_count, const ArgumentAlloc & alloc) + : sherwood_v3_table(first, last, bucket_count, ArgumentHash(), ArgumentEqual(), alloc) + { + } + template + sherwood_v3_table(It first, It last, size_type bucket_count, const ArgumentHash & hash, const ArgumentAlloc & alloc) + : sherwood_v3_table(first, last, bucket_count, hash, ArgumentEqual(), alloc) + { + } + sherwood_v3_table(std::initializer_list il, size_type bucket_count = 0, const ArgumentHash & hash = ArgumentHash(), const ArgumentEqual & equal = ArgumentEqual(), const ArgumentAlloc & alloc = ArgumentAlloc()) + : sherwood_v3_table(bucket_count, hash, equal, alloc) + { + if (bucket_count == 0) + rehash(il.size()); + insert(il.begin(), il.end()); + } + sherwood_v3_table(std::initializer_list il, size_type bucket_count, const ArgumentAlloc & alloc) + : sherwood_v3_table(il, bucket_count, ArgumentHash(), ArgumentEqual(), alloc) + { + } + sherwood_v3_table(std::initializer_list il, size_type bucket_count, const ArgumentHash & hash, const ArgumentAlloc & alloc) + : sherwood_v3_table(il, bucket_count, hash, ArgumentEqual(), alloc) + { + } + sherwood_v3_table(const sherwood_v3_table & other) + : sherwood_v3_table(other, AllocatorTraits::select_on_container_copy_construction(other.get_allocator())) + { + } + sherwood_v3_table(const sherwood_v3_table & other, const ArgumentAlloc & alloc) + : EntryAlloc(alloc), Hasher(other), Equal(other), _max_load_factor(other._max_load_factor) + { + rehash_for_other_container(other); + try + { + insert(other.begin(), other.end()); + } + catch(...) + { + clear(); + deallocate_data(entries, num_slots_minus_one, max_lookups); + throw; + } + } + sherwood_v3_table(sherwood_v3_table && other) noexcept + : EntryAlloc(std::move(other)), Hasher(std::move(other)), Equal(std::move(other)) + { + swap_pointers(other); + } + sherwood_v3_table(sherwood_v3_table && other, const ArgumentAlloc & alloc) noexcept + : EntryAlloc(alloc), Hasher(std::move(other)), Equal(std::move(other)) + { + swap_pointers(other); + } + sherwood_v3_table & operator=(const sherwood_v3_table & other) + { + if (this == std::addressof(other)) + return *this; + + clear(); + if (AllocatorTraits::propagate_on_container_copy_assignment::value) + { + if (static_cast(*this) != static_cast(other)) + { + reset_to_empty_state(); + } + AssignIfTrue()(*this, other); + } + _max_load_factor = other._max_load_factor; + static_cast(*this) = other; + static_cast(*this) = other; + rehash_for_other_container(other); + insert(other.begin(), other.end()); + return *this; + } + sherwood_v3_table & operator=(sherwood_v3_table && other) noexcept + { + if (this == std::addressof(other)) + return *this; + else if (AllocatorTraits::propagate_on_container_move_assignment::value) + { + clear(); + reset_to_empty_state(); + AssignIfTrue()(*this, std::move(other)); + swap_pointers(other); + } + else if (static_cast(*this) == static_cast(other)) + { + swap_pointers(other); + } + else + { + clear(); + _max_load_factor = other._max_load_factor; + rehash_for_other_container(other); + for (T & elem : other) + emplace(std::move(elem)); + other.clear(); + } + static_cast(*this) = std::move(other); + static_cast(*this) = std::move(other); + return *this; + } + ~sherwood_v3_table() + { + clear(); + deallocate_data(entries, num_slots_minus_one, max_lookups); + } + + const allocator_type & get_allocator() const + { + return static_cast(*this); + } + const ArgumentEqual & key_eq() const + { + return static_cast(*this); + } + const ArgumentHash & hash_function() const + { + return static_cast(*this); + } + + template + struct templated_iterator + { + templated_iterator() = default; + templated_iterator(EntryPointer current) + : current(current) + { + } + EntryPointer current = EntryPointer(); + + using iterator_category = std::forward_iterator_tag; + using value_type = ValueType; + using difference_type = ptrdiff_t; + using pointer = ValueType *; + using reference = ValueType &; + + friend bool operator==(const templated_iterator & lhs, const templated_iterator & rhs) + { + return lhs.current == rhs.current; + } + friend bool operator!=(const templated_iterator & lhs, const templated_iterator & rhs) + { + return !(lhs == rhs); + } + + templated_iterator & operator++() + { + do + { + ++current; + } + while(current->is_empty()); + return *this; + } + templated_iterator operator++(int) + { + templated_iterator copy(*this); + ++*this; + return copy; + } + + ValueType & operator*() const + { + return current->value; + } + ValueType * operator->() const + { + return std::addressof(current->value); + } + + operator templated_iterator() const + { + return { current }; + } + }; + using iterator = templated_iterator; + using const_iterator = templated_iterator; + + iterator begin() + { + for (EntryPointer it = entries;; ++it) + { + if (it->has_value()) + return { it }; + } + } + const_iterator begin() const + { + for (EntryPointer it = entries;; ++it) + { + if (it->has_value()) + return { it }; + } + } + const_iterator cbegin() const + { + return begin(); + } + iterator end() + { + return { entries + static_cast(num_slots_minus_one + max_lookups) }; + } + const_iterator end() const + { + return { entries + static_cast(num_slots_minus_one + max_lookups) }; + } + const_iterator cend() const + { + return end(); + } + + iterator find(const FindKey & key) + { + size_t index = hash_policy.index_for_hash(hash_object(key), num_slots_minus_one); + EntryPointer it = entries + ptrdiff_t(index); + for (int8_t distance = 0; it->distance_from_desired >= distance; ++distance, ++it) + { + if (compares_equal(key, it->value)) + return { it }; + } + return end(); + } + const_iterator find(const FindKey & key) const + { + return const_cast(this)->find(key); + } + size_t count(const FindKey & key) const + { + return find(key) == end() ? 0 : 1; + } + std::pair equal_range(const FindKey & key) + { + iterator found = find(key); + if (found == end()) + return { found, found }; + else + return { found, std::next(found) }; + } + std::pair equal_range(const FindKey & key) const + { + const_iterator found = find(key); + if (found == end()) + return { found, found }; + else + return { found, std::next(found) }; + } + + template + std::pair emplace(Key && key, Args &&... args) + { + size_t index = hash_policy.index_for_hash(hash_object(key), num_slots_minus_one); + EntryPointer current_entry = entries + ptrdiff_t(index); + int8_t distance_from_desired = 0; + for (; current_entry->distance_from_desired >= distance_from_desired; ++current_entry, ++distance_from_desired) + { + if (compares_equal(key, current_entry->value)) + return { { current_entry }, false }; + } + return emplace_new_key(distance_from_desired, current_entry, std::forward(key), std::forward(args)...); + } + + std::pair insert(const value_type & value) + { + return emplace(value); + } + std::pair insert(value_type && value) + { + return emplace(std::move(value)); + } + template + iterator emplace_hint(const_iterator, Args &&... args) + { + return emplace(std::forward(args)...).first; + } + iterator insert(const_iterator, const value_type & value) + { + return emplace(value).first; + } + iterator insert(const_iterator, value_type && value) + { + return emplace(std::move(value)).first; + } + + template + void insert(It begin, It end) + { + for (; begin != end; ++begin) + { + emplace(*begin); + } + } + void insert(std::initializer_list il) + { + insert(il.begin(), il.end()); + } + + void rehash(size_t num_buckets) + { + num_buckets = std::max(num_buckets, static_cast(std::ceil(num_elements / static_cast(_max_load_factor)))); + if (num_buckets == 0) + { + reset_to_empty_state(); + return; + } + auto new_prime_index = hash_policy.next_size_over(num_buckets); + if (num_buckets == bucket_count()) + return; + int8_t new_max_lookups = compute_max_lookups(num_buckets); + EntryPointer new_buckets(AllocatorTraits::allocate(*this, num_buckets + new_max_lookups)); + EntryPointer special_end_item = new_buckets + static_cast(num_buckets + new_max_lookups - 1); + for (EntryPointer it = new_buckets; it != special_end_item; ++it) + it->distance_from_desired = -1; + special_end_item->distance_from_desired = Entry::special_end_value; + std::swap(entries, new_buckets); + std::swap(num_slots_minus_one, num_buckets); + --num_slots_minus_one; + hash_policy.commit(new_prime_index); + int8_t old_max_lookups = max_lookups; + max_lookups = new_max_lookups; + num_elements = 0; + for (EntryPointer it = new_buckets, end = it + static_cast(num_buckets + old_max_lookups); it != end; ++it) + { + if (it->has_value()) + { + emplace(std::move(it->value)); + it->destroy_value(); + } + } + deallocate_data(new_buckets, num_buckets, old_max_lookups); + } + + void reserve(size_t num_elements) + { + size_t required_buckets = num_buckets_for_reserve(num_elements); + if (required_buckets > bucket_count()) + rehash(required_buckets); + } + + // the return value is a type that can be converted to an iterator + // the reason for doing this is that it's not free to find the + // iterator pointing at the next element. if you care about the + // next iterator, turn the return value into an iterator + convertible_to_iterator erase(const_iterator to_erase) + { + EntryPointer current = to_erase.current; + current->destroy_value(); + --num_elements; + for (EntryPointer next = current + ptrdiff_t(1); !next->is_at_desired_position(); ++current, ++next) + { + current->emplace(next->distance_from_desired - 1, std::move(next->value)); + next->destroy_value(); + } + return { to_erase.current }; + } + + iterator erase(const_iterator begin_it, const_iterator end_it) + { + if (begin_it == end_it) + return { begin_it.current }; + for (EntryPointer it = begin_it.current, end = end_it.current; it != end; ++it) + { + if (it->has_value()) + { + it->destroy_value(); + --num_elements; + } + } + if (end_it == this->end()) + return this->end(); + ptrdiff_t num_to_move = std::min(static_cast(end_it.current->distance_from_desired), end_it.current - begin_it.current); + EntryPointer to_return = end_it.current - num_to_move; + for (EntryPointer it = end_it.current; !it->is_at_desired_position();) + { + EntryPointer target = it - num_to_move; + target->emplace(it->distance_from_desired - num_to_move, std::move(it->value)); + it->destroy_value(); + ++it; + num_to_move = std::min(static_cast(it->distance_from_desired), num_to_move); + } + return { to_return }; + } + + size_t erase(const FindKey & key) + { + auto found = find(key); + if (found == end()) + return 0; + else + { + erase(found); + return 1; + } + } + + void clear() + { + for (EntryPointer it = entries, end = it + static_cast(num_slots_minus_one + max_lookups); it != end; ++it) + { + if (it->has_value()) + it->destroy_value(); + } + num_elements = 0; + } + + void shrink_to_fit() + { + rehash_for_other_container(*this); + } + + void swap(sherwood_v3_table & other) + { + using std::swap; + swap_pointers(other); + swap(static_cast(*this), static_cast(other)); + swap(static_cast(*this), static_cast(other)); + if (AllocatorTraits::propagate_on_container_swap::value) + swap(static_cast(*this), static_cast(other)); + } + + size_t size() const + { + return num_elements; + } + size_t max_size() const + { + return (AllocatorTraits::max_size(*this)) / sizeof(Entry); + } + size_t bucket_count() const + { + return num_slots_minus_one ? num_slots_minus_one + 1 : 0; + } + size_type max_bucket_count() const + { + return (AllocatorTraits::max_size(*this) - min_lookups) / sizeof(Entry); + } + size_t bucket(const FindKey & key) const + { + return hash_policy.index_for_hash(hash_object(key), num_slots_minus_one); + } + float load_factor() const + { + size_t buckets = bucket_count(); + if (buckets) + return static_cast(num_elements) / bucket_count(); + else + return 0; + } + void max_load_factor(float value) + { + _max_load_factor = value; + } + float max_load_factor() const + { + return _max_load_factor; + } + + bool empty() const + { + return num_elements == 0; + } + +private: + EntryPointer entries = Entry::empty_default_table(); + size_t num_slots_minus_one = 0; + typename HashPolicySelector::type hash_policy; + int8_t max_lookups = detailv3::min_lookups - 1; + float _max_load_factor = 0.5f; + size_t num_elements = 0; + + static int8_t compute_max_lookups(size_t num_buckets) + { + int8_t desired = detailv3::log2(num_buckets); + return std::max(detailv3::min_lookups, desired); + } + + size_t num_buckets_for_reserve(size_t num_elements) const + { + return static_cast(std::ceil(num_elements / std::min(0.5, static_cast(_max_load_factor)))); + } + void rehash_for_other_container(const sherwood_v3_table & other) + { + rehash(std::min(num_buckets_for_reserve(other.size()), other.bucket_count())); + } + + void swap_pointers(sherwood_v3_table & other) + { + using std::swap; + swap(hash_policy, other.hash_policy); + swap(entries, other.entries); + swap(num_slots_minus_one, other.num_slots_minus_one); + swap(num_elements, other.num_elements); + swap(max_lookups, other.max_lookups); + swap(_max_load_factor, other._max_load_factor); + } + + template + SKA_NOINLINE(std::pair) emplace_new_key(int8_t distance_from_desired, EntryPointer current_entry, Key && key, Args &&... args) + { + using std::swap; + if (num_slots_minus_one == 0 || distance_from_desired == max_lookups || num_elements + 1 > (num_slots_minus_one + 1) * static_cast(_max_load_factor)) + { + grow(); + return emplace(std::forward(key), std::forward(args)...); + } + else if (current_entry->is_empty()) + { + current_entry->emplace(distance_from_desired, std::forward(key), std::forward(args)...); + ++num_elements; + return { { current_entry }, true }; + } + value_type to_insert(std::forward(key), std::forward(args)...); + swap(distance_from_desired, current_entry->distance_from_desired); + swap(to_insert, current_entry->value); + iterator result = { current_entry }; + for (++distance_from_desired, ++current_entry;; ++current_entry) + { + if (current_entry->is_empty()) + { + current_entry->emplace(distance_from_desired, std::move(to_insert)); + ++num_elements; + return { result, true }; + } + else if (current_entry->distance_from_desired < distance_from_desired) + { + swap(distance_from_desired, current_entry->distance_from_desired); + swap(to_insert, current_entry->value); + ++distance_from_desired; + } + else + { + ++distance_from_desired; + if (distance_from_desired == max_lookups) + { + swap(to_insert, result.current->value); + grow(); + return emplace(std::move(to_insert)); + } + } + } + } + + void grow() + { + rehash(std::max(size_t(4), 2 * bucket_count())); + } + + void deallocate_data(EntryPointer begin, size_t num_slots_minus_one, int8_t max_lookups) + { + if (begin != Entry::empty_default_table()) + { + AllocatorTraits::deallocate(*this, begin, num_slots_minus_one + max_lookups + 1); + } + } + + void reset_to_empty_state() + { + deallocate_data(entries, num_slots_minus_one, max_lookups); + entries = Entry::empty_default_table(); + num_slots_minus_one = 0; + hash_policy.reset(); + max_lookups = detailv3::min_lookups - 1; + } + + template + size_t hash_object(const U & key) + { + return static_cast(*this)(key); + } + template + size_t hash_object(const U & key) const + { + return static_cast(*this)(key); + } + template + bool compares_equal(const L & lhs, const R & rhs) + { + return static_cast(*this)(lhs, rhs); + } + + struct convertible_to_iterator + { + EntryPointer it; + + operator iterator() + { + if (it->has_value()) + return { it }; + else + return ++iterator{it}; + } + operator const_iterator() + { + if (it->has_value()) + return { it }; + else + return ++const_iterator{it}; + } + }; + +}; +} + +struct prime_number_hash_policy +{ + static size_t mod0(size_t) { return 0llu; } + static size_t mod2(size_t hash) { return hash % 2llu; } + static size_t mod3(size_t hash) { return hash % 3llu; } + static size_t mod5(size_t hash) { return hash % 5llu; } + static size_t mod7(size_t hash) { return hash % 7llu; } + static size_t mod11(size_t hash) { return hash % 11llu; } + static size_t mod13(size_t hash) { return hash % 13llu; } + static size_t mod17(size_t hash) { return hash % 17llu; } + static size_t mod23(size_t hash) { return hash % 23llu; } + static size_t mod29(size_t hash) { return hash % 29llu; } + static size_t mod37(size_t hash) { return hash % 37llu; } + static size_t mod47(size_t hash) { return hash % 47llu; } + static size_t mod59(size_t hash) { return hash % 59llu; } + static size_t mod73(size_t hash) { return hash % 73llu; } + static size_t mod97(size_t hash) { return hash % 97llu; } + static size_t mod127(size_t hash) { return hash % 127llu; } + static size_t mod151(size_t hash) { return hash % 151llu; } + static size_t mod197(size_t hash) { return hash % 197llu; } + static size_t mod251(size_t hash) { return hash % 251llu; } + static size_t mod313(size_t hash) { return hash % 313llu; } + static size_t mod397(size_t hash) { return hash % 397llu; } + static size_t mod499(size_t hash) { return hash % 499llu; } + static size_t mod631(size_t hash) { return hash % 631llu; } + static size_t mod797(size_t hash) { return hash % 797llu; } + static size_t mod1009(size_t hash) { return hash % 1009llu; } + static size_t mod1259(size_t hash) { return hash % 1259llu; } + static size_t mod1597(size_t hash) { return hash % 1597llu; } + static size_t mod2011(size_t hash) { return hash % 2011llu; } + static size_t mod2539(size_t hash) { return hash % 2539llu; } + static size_t mod3203(size_t hash) { return hash % 3203llu; } + static size_t mod4027(size_t hash) { return hash % 4027llu; } + static size_t mod5087(size_t hash) { return hash % 5087llu; } + static size_t mod6421(size_t hash) { return hash % 6421llu; } + static size_t mod8089(size_t hash) { return hash % 8089llu; } + static size_t mod10193(size_t hash) { return hash % 10193llu; } + static size_t mod12853(size_t hash) { return hash % 12853llu; } + static size_t mod16193(size_t hash) { return hash % 16193llu; } + static size_t mod20399(size_t hash) { return hash % 20399llu; } + static size_t mod25717(size_t hash) { return hash % 25717llu; } + static size_t mod32401(size_t hash) { return hash % 32401llu; } + static size_t mod40823(size_t hash) { return hash % 40823llu; } + static size_t mod51437(size_t hash) { return hash % 51437llu; } + static size_t mod64811(size_t hash) { return hash % 64811llu; } + static size_t mod81649(size_t hash) { return hash % 81649llu; } + static size_t mod102877(size_t hash) { return hash % 102877llu; } + static size_t mod129607(size_t hash) { return hash % 129607llu; } + static size_t mod163307(size_t hash) { return hash % 163307llu; } + static size_t mod205759(size_t hash) { return hash % 205759llu; } + static size_t mod259229(size_t hash) { return hash % 259229llu; } + static size_t mod326617(size_t hash) { return hash % 326617llu; } + static size_t mod411527(size_t hash) { return hash % 411527llu; } + static size_t mod518509(size_t hash) { return hash % 518509llu; } + static size_t mod653267(size_t hash) { return hash % 653267llu; } + static size_t mod823117(size_t hash) { return hash % 823117llu; } + static size_t mod1037059(size_t hash) { return hash % 1037059llu; } + static size_t mod1306601(size_t hash) { return hash % 1306601llu; } + static size_t mod1646237(size_t hash) { return hash % 1646237llu; } + static size_t mod2074129(size_t hash) { return hash % 2074129llu; } + static size_t mod2613229(size_t hash) { return hash % 2613229llu; } + static size_t mod3292489(size_t hash) { return hash % 3292489llu; } + static size_t mod4148279(size_t hash) { return hash % 4148279llu; } + static size_t mod5226491(size_t hash) { return hash % 5226491llu; } + static size_t mod6584983(size_t hash) { return hash % 6584983llu; } + static size_t mod8296553(size_t hash) { return hash % 8296553llu; } + static size_t mod10453007(size_t hash) { return hash % 10453007llu; } + static size_t mod13169977(size_t hash) { return hash % 13169977llu; } + static size_t mod16593127(size_t hash) { return hash % 16593127llu; } + static size_t mod20906033(size_t hash) { return hash % 20906033llu; } + static size_t mod26339969(size_t hash) { return hash % 26339969llu; } + static size_t mod33186281(size_t hash) { return hash % 33186281llu; } + static size_t mod41812097(size_t hash) { return hash % 41812097llu; } + static size_t mod52679969(size_t hash) { return hash % 52679969llu; } + static size_t mod66372617(size_t hash) { return hash % 66372617llu; } + static size_t mod83624237(size_t hash) { return hash % 83624237llu; } + static size_t mod105359939(size_t hash) { return hash % 105359939llu; } + static size_t mod132745199(size_t hash) { return hash % 132745199llu; } + static size_t mod167248483(size_t hash) { return hash % 167248483llu; } + static size_t mod210719881(size_t hash) { return hash % 210719881llu; } + static size_t mod265490441(size_t hash) { return hash % 265490441llu; } + static size_t mod334496971(size_t hash) { return hash % 334496971llu; } + static size_t mod421439783(size_t hash) { return hash % 421439783llu; } + static size_t mod530980861(size_t hash) { return hash % 530980861llu; } + static size_t mod668993977(size_t hash) { return hash % 668993977llu; } + static size_t mod842879579(size_t hash) { return hash % 842879579llu; } + static size_t mod1061961721(size_t hash) { return hash % 1061961721llu; } + static size_t mod1337987929(size_t hash) { return hash % 1337987929llu; } + static size_t mod1685759167(size_t hash) { return hash % 1685759167llu; } + static size_t mod2123923447(size_t hash) { return hash % 2123923447llu; } + static size_t mod2675975881(size_t hash) { return hash % 2675975881llu; } + static size_t mod3371518343(size_t hash) { return hash % 3371518343llu; } + static size_t mod4247846927(size_t hash) { return hash % 4247846927llu; } + static size_t mod5351951779(size_t hash) { return hash % 5351951779llu; } + static size_t mod6743036717(size_t hash) { return hash % 6743036717llu; } + static size_t mod8495693897(size_t hash) { return hash % 8495693897llu; } + static size_t mod10703903591(size_t hash) { return hash % 10703903591llu; } + static size_t mod13486073473(size_t hash) { return hash % 13486073473llu; } + static size_t mod16991387857(size_t hash) { return hash % 16991387857llu; } + static size_t mod21407807219(size_t hash) { return hash % 21407807219llu; } + static size_t mod26972146961(size_t hash) { return hash % 26972146961llu; } + static size_t mod33982775741(size_t hash) { return hash % 33982775741llu; } + static size_t mod42815614441(size_t hash) { return hash % 42815614441llu; } + static size_t mod53944293929(size_t hash) { return hash % 53944293929llu; } + static size_t mod67965551447(size_t hash) { return hash % 67965551447llu; } + static size_t mod85631228929(size_t hash) { return hash % 85631228929llu; } + static size_t mod107888587883(size_t hash) { return hash % 107888587883llu; } + static size_t mod135931102921(size_t hash) { return hash % 135931102921llu; } + static size_t mod171262457903(size_t hash) { return hash % 171262457903llu; } + static size_t mod215777175787(size_t hash) { return hash % 215777175787llu; } + static size_t mod271862205833(size_t hash) { return hash % 271862205833llu; } + static size_t mod342524915839(size_t hash) { return hash % 342524915839llu; } + static size_t mod431554351609(size_t hash) { return hash % 431554351609llu; } + static size_t mod543724411781(size_t hash) { return hash % 543724411781llu; } + static size_t mod685049831731(size_t hash) { return hash % 685049831731llu; } + static size_t mod863108703229(size_t hash) { return hash % 863108703229llu; } + static size_t mod1087448823553(size_t hash) { return hash % 1087448823553llu; } + static size_t mod1370099663459(size_t hash) { return hash % 1370099663459llu; } + static size_t mod1726217406467(size_t hash) { return hash % 1726217406467llu; } + static size_t mod2174897647073(size_t hash) { return hash % 2174897647073llu; } + static size_t mod2740199326961(size_t hash) { return hash % 2740199326961llu; } + static size_t mod3452434812973(size_t hash) { return hash % 3452434812973llu; } + static size_t mod4349795294267(size_t hash) { return hash % 4349795294267llu; } + static size_t mod5480398654009(size_t hash) { return hash % 5480398654009llu; } + static size_t mod6904869625999(size_t hash) { return hash % 6904869625999llu; } + static size_t mod8699590588571(size_t hash) { return hash % 8699590588571llu; } + static size_t mod10960797308051(size_t hash) { return hash % 10960797308051llu; } + static size_t mod13809739252051(size_t hash) { return hash % 13809739252051llu; } + static size_t mod17399181177241(size_t hash) { return hash % 17399181177241llu; } + static size_t mod21921594616111(size_t hash) { return hash % 21921594616111llu; } + static size_t mod27619478504183(size_t hash) { return hash % 27619478504183llu; } + static size_t mod34798362354533(size_t hash) { return hash % 34798362354533llu; } + static size_t mod43843189232363(size_t hash) { return hash % 43843189232363llu; } + static size_t mod55238957008387(size_t hash) { return hash % 55238957008387llu; } + static size_t mod69596724709081(size_t hash) { return hash % 69596724709081llu; } + static size_t mod87686378464759(size_t hash) { return hash % 87686378464759llu; } + static size_t mod110477914016779(size_t hash) { return hash % 110477914016779llu; } + static size_t mod139193449418173(size_t hash) { return hash % 139193449418173llu; } + static size_t mod175372756929481(size_t hash) { return hash % 175372756929481llu; } + static size_t mod220955828033581(size_t hash) { return hash % 220955828033581llu; } + static size_t mod278386898836457(size_t hash) { return hash % 278386898836457llu; } + static size_t mod350745513859007(size_t hash) { return hash % 350745513859007llu; } + static size_t mod441911656067171(size_t hash) { return hash % 441911656067171llu; } + static size_t mod556773797672909(size_t hash) { return hash % 556773797672909llu; } + static size_t mod701491027718027(size_t hash) { return hash % 701491027718027llu; } + static size_t mod883823312134381(size_t hash) { return hash % 883823312134381llu; } + static size_t mod1113547595345903(size_t hash) { return hash % 1113547595345903llu; } + static size_t mod1402982055436147(size_t hash) { return hash % 1402982055436147llu; } + static size_t mod1767646624268779(size_t hash) { return hash % 1767646624268779llu; } + static size_t mod2227095190691797(size_t hash) { return hash % 2227095190691797llu; } + static size_t mod2805964110872297(size_t hash) { return hash % 2805964110872297llu; } + static size_t mod3535293248537579(size_t hash) { return hash % 3535293248537579llu; } + static size_t mod4454190381383713(size_t hash) { return hash % 4454190381383713llu; } + static size_t mod5611928221744609(size_t hash) { return hash % 5611928221744609llu; } + static size_t mod7070586497075177(size_t hash) { return hash % 7070586497075177llu; } + static size_t mod8908380762767489(size_t hash) { return hash % 8908380762767489llu; } + static size_t mod11223856443489329(size_t hash) { return hash % 11223856443489329llu; } + static size_t mod14141172994150357(size_t hash) { return hash % 14141172994150357llu; } + static size_t mod17816761525534927(size_t hash) { return hash % 17816761525534927llu; } + static size_t mod22447712886978529(size_t hash) { return hash % 22447712886978529llu; } + static size_t mod28282345988300791(size_t hash) { return hash % 28282345988300791llu; } + static size_t mod35633523051069991(size_t hash) { return hash % 35633523051069991llu; } + static size_t mod44895425773957261(size_t hash) { return hash % 44895425773957261llu; } + static size_t mod56564691976601587(size_t hash) { return hash % 56564691976601587llu; } + static size_t mod71267046102139967(size_t hash) { return hash % 71267046102139967llu; } + static size_t mod89790851547914507(size_t hash) { return hash % 89790851547914507llu; } + static size_t mod113129383953203213(size_t hash) { return hash % 113129383953203213llu; } + static size_t mod142534092204280003(size_t hash) { return hash % 142534092204280003llu; } + static size_t mod179581703095829107(size_t hash) { return hash % 179581703095829107llu; } + static size_t mod226258767906406483(size_t hash) { return hash % 226258767906406483llu; } + static size_t mod285068184408560057(size_t hash) { return hash % 285068184408560057llu; } + static size_t mod359163406191658253(size_t hash) { return hash % 359163406191658253llu; } + static size_t mod452517535812813007(size_t hash) { return hash % 452517535812813007llu; } + static size_t mod570136368817120201(size_t hash) { return hash % 570136368817120201llu; } + static size_t mod718326812383316683(size_t hash) { return hash % 718326812383316683llu; } + static size_t mod905035071625626043(size_t hash) { return hash % 905035071625626043llu; } + static size_t mod1140272737634240411(size_t hash) { return hash % 1140272737634240411llu; } + static size_t mod1436653624766633509(size_t hash) { return hash % 1436653624766633509llu; } + static size_t mod1810070143251252131(size_t hash) { return hash % 1810070143251252131llu; } + static size_t mod2280545475268481167(size_t hash) { return hash % 2280545475268481167llu; } + static size_t mod2873307249533267101(size_t hash) { return hash % 2873307249533267101llu; } + static size_t mod3620140286502504283(size_t hash) { return hash % 3620140286502504283llu; } + static size_t mod4561090950536962147(size_t hash) { return hash % 4561090950536962147llu; } + static size_t mod5746614499066534157(size_t hash) { return hash % 5746614499066534157llu; } + static size_t mod7240280573005008577(size_t hash) { return hash % 7240280573005008577llu; } + static size_t mod9122181901073924329(size_t hash) { return hash % 9122181901073924329llu; } + static size_t mod11493228998133068689(size_t hash) { return hash % 11493228998133068689llu; } + static size_t mod14480561146010017169(size_t hash) { return hash % 14480561146010017169llu; } + static size_t mod18446744073709551557(size_t hash) { return hash % 18446744073709551557llu; } + + using mod_function = size_t (*)(size_t); + + mod_function next_size_over(size_t & size) const + { + // prime numbers generated by the following method: + // 1. start with a prime p = 2 + // 2. go to wolfram alpha and get p = NextPrime(2 * p) + // 3. repeat 2. until you overflow 64 bits + // you now have large gaps which you would hit if somebody called reserve() with an unlucky number. + // 4. to fill the gaps for every prime p go to wolfram alpha and get ClosestPrime(p * 2^(1/3)) and ClosestPrime(p * 2^(2/3)) and put those in the gaps + // 5. get PrevPrime(2^64) and put it at the end + static constexpr const size_t prime_list[] = + { + 2llu, 3llu, 5llu, 7llu, 11llu, 13llu, 17llu, 23llu, 29llu, 37llu, 47llu, + 59llu, 73llu, 97llu, 127llu, 151llu, 197llu, 251llu, 313llu, 397llu, + 499llu, 631llu, 797llu, 1009llu, 1259llu, 1597llu, 2011llu, 2539llu, + 3203llu, 4027llu, 5087llu, 6421llu, 8089llu, 10193llu, 12853llu, 16193llu, + 20399llu, 25717llu, 32401llu, 40823llu, 51437llu, 64811llu, 81649llu, + 102877llu, 129607llu, 163307llu, 205759llu, 259229llu, 326617llu, + 411527llu, 518509llu, 653267llu, 823117llu, 1037059llu, 1306601llu, + 1646237llu, 2074129llu, 2613229llu, 3292489llu, 4148279llu, 5226491llu, + 6584983llu, 8296553llu, 10453007llu, 13169977llu, 16593127llu, 20906033llu, + 26339969llu, 33186281llu, 41812097llu, 52679969llu, 66372617llu, + 83624237llu, 105359939llu, 132745199llu, 167248483llu, 210719881llu, + 265490441llu, 334496971llu, 421439783llu, 530980861llu, 668993977llu, + 842879579llu, 1061961721llu, 1337987929llu, 1685759167llu, 2123923447llu, + 2675975881llu, 3371518343llu, 4247846927llu, 5351951779llu, 6743036717llu, + 8495693897llu, 10703903591llu, 13486073473llu, 16991387857llu, + 21407807219llu, 26972146961llu, 33982775741llu, 42815614441llu, + 53944293929llu, 67965551447llu, 85631228929llu, 107888587883llu, + 135931102921llu, 171262457903llu, 215777175787llu, 271862205833llu, + 342524915839llu, 431554351609llu, 543724411781llu, 685049831731llu, + 863108703229llu, 1087448823553llu, 1370099663459llu, 1726217406467llu, + 2174897647073llu, 2740199326961llu, 3452434812973llu, 4349795294267llu, + 5480398654009llu, 6904869625999llu, 8699590588571llu, 10960797308051llu, + 13809739252051llu, 17399181177241llu, 21921594616111llu, 27619478504183llu, + 34798362354533llu, 43843189232363llu, 55238957008387llu, 69596724709081llu, + 87686378464759llu, 110477914016779llu, 139193449418173llu, + 175372756929481llu, 220955828033581llu, 278386898836457llu, + 350745513859007llu, 441911656067171llu, 556773797672909llu, + 701491027718027llu, 883823312134381llu, 1113547595345903llu, + 1402982055436147llu, 1767646624268779llu, 2227095190691797llu, + 2805964110872297llu, 3535293248537579llu, 4454190381383713llu, + 5611928221744609llu, 7070586497075177llu, 8908380762767489llu, + 11223856443489329llu, 14141172994150357llu, 17816761525534927llu, + 22447712886978529llu, 28282345988300791llu, 35633523051069991llu, + 44895425773957261llu, 56564691976601587llu, 71267046102139967llu, + 89790851547914507llu, 113129383953203213llu, 142534092204280003llu, + 179581703095829107llu, 226258767906406483llu, 285068184408560057llu, + 359163406191658253llu, 452517535812813007llu, 570136368817120201llu, + 718326812383316683llu, 905035071625626043llu, 1140272737634240411llu, + 1436653624766633509llu, 1810070143251252131llu, 2280545475268481167llu, + 2873307249533267101llu, 3620140286502504283llu, 4561090950536962147llu, + 5746614499066534157llu, 7240280573005008577llu, 9122181901073924329llu, + 11493228998133068689llu, 14480561146010017169llu, 18446744073709551557llu + }; + static constexpr size_t (* const mod_functions[])(size_t) = + { + &mod0, &mod2, &mod3, &mod5, &mod7, &mod11, &mod13, &mod17, &mod23, &mod29, &mod37, + &mod47, &mod59, &mod73, &mod97, &mod127, &mod151, &mod197, &mod251, &mod313, &mod397, + &mod499, &mod631, &mod797, &mod1009, &mod1259, &mod1597, &mod2011, &mod2539, &mod3203, + &mod4027, &mod5087, &mod6421, &mod8089, &mod10193, &mod12853, &mod16193, &mod20399, + &mod25717, &mod32401, &mod40823, &mod51437, &mod64811, &mod81649, &mod102877, + &mod129607, &mod163307, &mod205759, &mod259229, &mod326617, &mod411527, &mod518509, + &mod653267, &mod823117, &mod1037059, &mod1306601, &mod1646237, &mod2074129, + &mod2613229, &mod3292489, &mod4148279, &mod5226491, &mod6584983, &mod8296553, + &mod10453007, &mod13169977, &mod16593127, &mod20906033, &mod26339969, &mod33186281, + &mod41812097, &mod52679969, &mod66372617, &mod83624237, &mod105359939, &mod132745199, + &mod167248483, &mod210719881, &mod265490441, &mod334496971, &mod421439783, + &mod530980861, &mod668993977, &mod842879579, &mod1061961721, &mod1337987929, + &mod1685759167, &mod2123923447, &mod2675975881, &mod3371518343, &mod4247846927, + &mod5351951779, &mod6743036717, &mod8495693897, &mod10703903591, &mod13486073473, + &mod16991387857, &mod21407807219, &mod26972146961, &mod33982775741, &mod42815614441, + &mod53944293929, &mod67965551447, &mod85631228929, &mod107888587883, &mod135931102921, + &mod171262457903, &mod215777175787, &mod271862205833, &mod342524915839, + &mod431554351609, &mod543724411781, &mod685049831731, &mod863108703229, + &mod1087448823553, &mod1370099663459, &mod1726217406467, &mod2174897647073, + &mod2740199326961, &mod3452434812973, &mod4349795294267, &mod5480398654009, + &mod6904869625999, &mod8699590588571, &mod10960797308051, &mod13809739252051, + &mod17399181177241, &mod21921594616111, &mod27619478504183, &mod34798362354533, + &mod43843189232363, &mod55238957008387, &mod69596724709081, &mod87686378464759, + &mod110477914016779, &mod139193449418173, &mod175372756929481, &mod220955828033581, + &mod278386898836457, &mod350745513859007, &mod441911656067171, &mod556773797672909, + &mod701491027718027, &mod883823312134381, &mod1113547595345903, &mod1402982055436147, + &mod1767646624268779, &mod2227095190691797, &mod2805964110872297, &mod3535293248537579, + &mod4454190381383713, &mod5611928221744609, &mod7070586497075177, &mod8908380762767489, + &mod11223856443489329, &mod14141172994150357, &mod17816761525534927, + &mod22447712886978529, &mod28282345988300791, &mod35633523051069991, + &mod44895425773957261, &mod56564691976601587, &mod71267046102139967, + &mod89790851547914507, &mod113129383953203213, &mod142534092204280003, + &mod179581703095829107, &mod226258767906406483, &mod285068184408560057, + &mod359163406191658253, &mod452517535812813007, &mod570136368817120201, + &mod718326812383316683, &mod905035071625626043, &mod1140272737634240411, + &mod1436653624766633509, &mod1810070143251252131, &mod2280545475268481167, + &mod2873307249533267101, &mod3620140286502504283, &mod4561090950536962147, + &mod5746614499066534157, &mod7240280573005008577, &mod9122181901073924329, + &mod11493228998133068689, &mod14480561146010017169, &mod18446744073709551557 + }; + const size_t * found = std::lower_bound(std::begin(prime_list), std::end(prime_list) - 1, size); + size = *found; + return mod_functions[1 + found - prime_list]; + } + void commit(mod_function new_mod_function) + { + current_mod_function = new_mod_function; + } + void reset() + { + current_mod_function = &mod0; + } + + size_t index_for_hash(size_t hash, size_t /*num_slots_minus_one*/) const + { + return current_mod_function(hash); + } + size_t keep_in_range(size_t index, size_t num_slots_minus_one) const + { + return index > num_slots_minus_one ? current_mod_function(index) : index; + } + +private: + mod_function current_mod_function = &mod0; +}; + +struct power_of_two_hash_policy +{ + size_t index_for_hash(size_t hash, size_t num_slots_minus_one) const + { + return hash & num_slots_minus_one; + } + size_t keep_in_range(size_t index, size_t num_slots_minus_one) const + { + return index_for_hash(index, num_slots_minus_one); + } + int8_t next_size_over(size_t & size) const + { + size = detailv3::next_power_of_two(size); + return 0; + } + void commit(int8_t) + { + } + void reset() + { + } + +}; + +struct fibonacci_hash_policy +{ + size_t index_for_hash(size_t hash, size_t /*num_slots_minus_one*/) const + { + return (11400714819323198485ull * hash) >> shift; + } + size_t keep_in_range(size_t index, size_t num_slots_minus_one) const + { + return index & num_slots_minus_one; + } + + int8_t next_size_over(size_t & size) const + { + size = std::max(size_t(2), detailv3::next_power_of_two(size)); + return 64 - detailv3::log2(size); + } + void commit(int8_t shift) + { + this->shift = shift; + } + void reset() + { + shift = 63; + } + +private: + int8_t shift = 63; +}; + +template, typename E = std::equal_to, typename A = std::allocator > > +class flat_hash_map + : public detailv3::sherwood_v3_table + < + std::pair, + K, + H, + detailv3::KeyOrValueHasher, H>, + E, + detailv3::KeyOrValueEquality, E>, + A, + typename std::allocator_traits::template rebind_alloc>> + > +{ + using Table = detailv3::sherwood_v3_table + < + std::pair, + K, + H, + detailv3::KeyOrValueHasher, H>, + E, + detailv3::KeyOrValueEquality, E>, + A, + typename std::allocator_traits::template rebind_alloc>> + >; +public: + + using key_type = K; + using mapped_type = V; + + using Table::Table; + flat_hash_map() + { + } + + inline V & operator[](const K & key) + { + return emplace(key, convertible_to_value()).first->second; + } + inline V & operator[](K && key) + { + return emplace(std::move(key), convertible_to_value()).first->second; + } + V & at(const K & key) + { + auto found = this->find(key); + if (found == this->end()) + throw std::out_of_range("Argument passed to at() was not in the map."); + return found->second; + } + const V & at(const K & key) const + { + auto found = this->find(key); + if (found == this->end()) + throw std::out_of_range("Argument passed to at() was not in the map."); + return found->second; + } + + using Table::emplace; + std::pair emplace() + { + return emplace(key_type(), convertible_to_value()); + } + template + std::pair insert_or_assign(const key_type & key, M && m) + { + auto emplace_result = emplace(key, std::forward(m)); + if (!emplace_result.second) + emplace_result.first->second = std::forward(m); + return emplace_result; + } + template + std::pair insert_or_assign(key_type && key, M && m) + { + auto emplace_result = emplace(std::move(key), std::forward(m)); + if (!emplace_result.second) + emplace_result.first->second = std::forward(m); + return emplace_result; + } + template + typename Table::iterator insert_or_assign(typename Table::const_iterator, const key_type & key, M && m) + { + return insert_or_assign(key, std::forward(m)).first; + } + template + typename Table::iterator insert_or_assign(typename Table::const_iterator, key_type && key, M && m) + { + return insert_or_assign(std::move(key), std::forward(m)).first; + } + + friend bool operator==(const flat_hash_map & lhs, const flat_hash_map & rhs) + { + if (lhs.size() != rhs.size()) + return false; + for (const typename Table::value_type & value : lhs) + { + auto found = rhs.find(value.first); + if (found == rhs.end()) + return false; + else if (value.second != found->second) + return false; + } + return true; + } + friend bool operator!=(const flat_hash_map & lhs, const flat_hash_map & rhs) + { + return !(lhs == rhs); + } + +private: + struct convertible_to_value + { + operator V() const + { + return V(); + } + }; +}; + +template, typename E = std::equal_to, typename A = std::allocator > +class flat_hash_set + : public detailv3::sherwood_v3_table + < + T, + T, + H, + detailv3::functor_storage, + E, + detailv3::functor_storage, + A, + typename std::allocator_traits::template rebind_alloc> + > +{ + using Table = detailv3::sherwood_v3_table + < + T, + T, + H, + detailv3::functor_storage, + E, + detailv3::functor_storage, + A, + typename std::allocator_traits::template rebind_alloc> + >; +public: + + using key_type = T; + + using Table::Table; + flat_hash_set() + { + } + + template + std::pair emplace(Args &&... args) + { + return Table::emplace(T(std::forward(args)...)); + } + std::pair emplace(const key_type & arg) + { + return Table::emplace(arg); + } + std::pair emplace(key_type & arg) + { + return Table::emplace(arg); + } + std::pair emplace(const key_type && arg) + { + return Table::emplace(std::move(arg)); + } + std::pair emplace(key_type && arg) + { + return Table::emplace(std::move(arg)); + } + + friend bool operator==(const flat_hash_set & lhs, const flat_hash_set & rhs) + { + if (lhs.size() != rhs.size()) + return false; + for (const T & value : lhs) + { + if (rhs.find(value) == rhs.end()) + return false; + } + return true; + } + friend bool operator!=(const flat_hash_set & lhs, const flat_hash_set & rhs) + { + return !(lhs == rhs); + } +}; + + +template +struct power_of_two_std_hash : std::hash +{ + typedef ska::power_of_two_hash_policy hash_policy; +}; + +} // end namespace ska diff --git a/luprex/core/cpp/planemap.cpp b/luprex/core/cpp/planemap.cpp index 24e74160..61ae0478 100644 --- a/luprex/core/cpp/planemap.cpp +++ b/luprex/core/cpp/planemap.cpp @@ -1,4 +1,106 @@ + +// PlaneTree is an octree-like data structure. +// +// THE COORDINATE SPACE +// +// The tree stores objects which have (x,y,z) coordinates where each of x,y,z is +// an unsigned 16-bit integer. The API uses floating-point coordinates, but +// these are converted to uint16_t for use in the tree. +// +// In an octree, each node has a 2x2x2 array of children (total: 8 children). In +// this tree, however, each node has a 4x4x4 array of children (total: 64 +// children). +// +// The depth of the tree is fixed. It always has one leaf level (level 0), plus +// 8 internal levels (levels 1-8). The root of the tree is level 8. Tangibles +// are always are always stored in the leaf-level. Since there are 8 +// subdivisions, at 4x4x4 per subdivision, that divides the space into 65536 x +// 65536 x 65536. Hence the 16-bit integer coordinates. +// +// Here are the sizes of the levels: +// +// * Level 8 (internal) is 1 cubed. +// * Level 7 (internal) is 4 cubed. +// * Level 6 (internal) is 16 cubed. +// * Level 5 (internal) is 64 cubed. +// * Level 4 (internal) is 256 cubed. +// * Level 3 (internal) is 1024 cubed. +// * Level 2 (internal) is 4096 cubed. +// * Level 1 (internal) is 16385 cubed. +// * Level 0 (leaf) is 65536 cubed. +// +// NODE IDS AND THE NODE TABLES +// +// Every tree node has a unique "NodeID", which consists of it's level and the +// lowest (x,y,z) coordinate in its region. Every tree node is stored in a hash +// table that maps NodeID to the data for that tree node. +// +// Tree nodes don't contain any child pointers or parent pointers. Instead, you +// can calculate the NodeIDs of the parent and children from the NodeID of a +// node. So, you can just look up parents and children in the hash table. Even +// though PlaneTree really is a tree, it doesn't use pointers at all. +// +// There are two separate hash tables - one for storing internal nodes, and one +// for storing leaf nodes. The only data stored in an internal node is a +// bitvector indicating which of its 64 children are nonempty. The only data +// stored in a leaf node is a list of PlaneItems. The list of PlaneItems is +// stored as an intrusive doubly-linked circular list. +// +// THE PLANETREE BOUNDING BOX, OUTLIERS, AND ADAPTIVE RESIZING +// +// The planetree as a whole has a bounding box. For now, the bounding box is +// fixed at (-65536, -65536, -65536) to (65536, 65536, 65536). That makes the +// size of the leaf cells two meters. However, it is my plan to eventually have +// the bounding box selected adaptively. +// +// "Outliers" are objects that are outside the PlaneTree's bounding box. When an +// object is an outlier, its (X,Y,Z) coordinates are clamped to the tree's +// bounding box for purposes of storing it in the tree. This puts all the +// outliers into the cells on the edge of the tree. When we need to scan a +// region that includes areas outside the tree's bounding box, we scan the edge +// cells. +// +// The tree keeps a count of the number of outliers. The intended use for these +// outlier counts is to implement adaptive logic that says "are there too many +// outliers? If so, expand the tree's bounding box." But we haven't written the +// adaptive algorithm yet, so the outlier counts don't serve any purpose yet. +// +// We probably *don't* want to capture 100% of the outliers. It seems likely +// that the programmer will deliberately put a few objects way off in the +// distance. For example, you might imagine somebody creating a "LoginManager" +// object and putting it way off at (1000000, 0, 0) in order to get it out of +// the way. If we were to expand the bounding box to include such objects, we +// would make the tree's bounding box unreasonably large. I have an idea for a +// heuristic: expand the bounding box until it covers 90% of the tangibles, then +// expand it by 25% more, then stop. I have another idea for a different +// heuristic: keep expanding the bounding box as long as making a small +// increment will capture significantly more tangibles, then stop. I don't know +// if either of those heuristics will work well. +// +// Any adaptive algorithm we create must take another factor into account: we +// don't want the cell size to be too small. Overly small cell sizes create lots +// of extra work when an object moves around. So sometimes, it's advantageous +// to deliberately expand the bounding box way beyond what is actually needed to +// capture the outliers, just to make the cell size large enough. Doing this +// isn't wasteful: octrees are very good at handling big empty spaces inside the +// bounding box. As long as the cell size is large enough, but not too large, +// and there aren't too many outliers, everything will work well. Unfortunately, +// I haven't devised a good heuristic to decide when the cell size is "right." +// +// Another thought I have, periodically, is that writing a lot of logic just to +// choose a cell size seems like a lot of unnecessary work: we could just +// configure the cell size for the game in the script. +// +// BYPASSING THE TREE +// +// In many cases, it's possible to jump directly to a leaf node and start +// processing. For example, let's say you want to move a tangible. You know +// its current position, therefore, you know exactly the NodeID of the leaf node +// where it is stored. There is no need to walk the tree to get there: you can +// just access it directly using the hash table. +// + #include "luastack.hpp" #include "util.hpp" #include "planemap.hpp" @@ -6,313 +108,725 @@ #include #include +using NodeID = uint64_t; +using ChildBits = uint64_t; +using IdVector = util::IdVector; -// Cell X, Y coordinates are packed such that they have 24 bits for X and Y. -// A cell is 10 Meters square. -// Cell ID zero is used to represent an invalid position. -// -#define CELL_LIMIT 0x7FFFFF -#define CELL_SCALE 10.0 +// These need to be static floats to encourage gcc to generate +// efficient code in NodeInfo. +static float k_lo = 0.0f; +static float k_hi = 65535.0f; -// Round a float and return as integer. Clamp result to the specified range. -static int round_and_clamp(float x, int lo, int hi) { - x = round(x); - if (x < lo) return lo; - if (x > hi) return hi; - return int(x); +static constexpr ChildBits child_bit(int i) { + return (uint64_t(1) << i); } -// A cell range is inclusive. -struct CellRange { - int xlo; - int ylo; - int xhi; - int yhi; +static constexpr uint8_t node_get_level(NodeID node) { + return node >> 48; +} - bool equal(int xl, int yl, int xh, int yh) { - return ((xlo==xl)&&(ylo==yl)&&(xh==xhi)&&(yh==yhi)); +static constexpr uint16_t node_get_x(NodeID node) { + return uint16_t(node >> 32); +} + +static constexpr uint16_t node_get_y(NodeID node) { + return uint16_t(node >> 16); +} + +static constexpr uint16_t node_get_z(NodeID node) { + return uint16_t(node >> 0); +} + +static constexpr NodeID node_lxyz(uint8_t level, uint16_t x, uint16_t y, uint16_t z) { + return (NodeID(level) << 48) | (NodeID(x) << 32) | (NodeID(y) << 16) | (NodeID(z) << 0); +} + +static constexpr NodeID node_parent(NodeID node) { + uint8_t level = node_get_level(node); + return ((node & node_lxyz(0, 0xFFFC, 0xFFFC, 0xFFFC)) >> 2) | node_lxyz(level + 1, 0, 0, 0); +} + +static constexpr uint8_t node_childindex(NodeID node) { + uint64_t masked = node & node_lxyz(0, 0x0003, 0x0003, 0x0003); + return (masked >> 0) | (masked >> 14) | (masked >> 28); +} + +static constexpr ChildBits node_childbit(NodeID node) { + return child_bit(node_childindex(node)); +} + +static constexpr NodeID node_nthchild(NodeID node, int i) { + int level = node_get_level(node); + uint16_t x = (i >> 4)&3; + uint16_t y = (i >> 2)&3; + uint16_t z = (i >> 0)&3; + return ((node & node_lxyz(0, 0xFFFF, 0xFFFF, 0xFFFF)) << 2) | node_lxyz(level - 1, x, y, z); +} + +static void print_node_id(NodeID node, std::ostream *os) { + int level = node_get_level(node); + + if (level >= 8) { + (*os) << "L" << level << ":root"; + return; + } + + uint16_t x = node_get_x(node); + uint16_t y = node_get_y(node); + uint16_t z = node_get_z(node); + auto fmt = util::hex.width(4 - (level >> 1)).fill('0'); + (*os) << "L" << level << ":" << fmt.val(x) << "," << fmt.val(y) << "," << fmt.val(z); +} + +enum BBoxCheck { INSIDE_BBOX, JUST_OUTSIDE_BBOX, WAY_OUTSIDE_BBOX }; + +struct NodeInfo { + NodeID node; + BBoxCheck bbcheck; + NodeInfo(float scale, float x, float y, float z) { + float sx = (x * scale); + float sy = (y * scale); + float sz = (z * scale); + float dist = std::max({std::abs(sx), std::abs(sy), std::abs(sz)}); + if (dist >= 32768.0f) { + bbcheck = (dist > (32768.0f + 8192.0f)) ? WAY_OUTSIDE_BBOX : JUST_OUTSIDE_BBOX; + float clampx = std::min(k_hi, std::max(k_lo, sx + 32768.0f)); + float clampy = std::min(k_hi, std::max(k_lo, sy + 32768.0f)); + float clampz = std::min(k_hi, std::max(k_lo, sz + 32768.0f)); + node = node_lxyz(0, clampx, clampy, clampz); + } else { + node = node_lxyz(0, sx + 32768.0f, sy + 32768.0f, sz + 32768.0f); + bbcheck = INSIDE_BBOX; + } } }; -// Get the range of cells that includes everything in the rectangle. -// -// Gracefully handles the case that some or all of the rectangle is -// beyond the maximum cell range. In that case, it clamps to the edge -// of the cell range. -// -static CellRange rect_cell_range(float x1, float y1, float x2, float y2) { - CellRange result; - result.xlo = round_and_clamp(x1 / CELL_SCALE, -CELL_LIMIT, CELL_LIMIT); - result.ylo = round_and_clamp(y1 / CELL_SCALE, -CELL_LIMIT, CELL_LIMIT); - result.xhi = round_and_clamp(x2 / CELL_SCALE, -CELL_LIMIT, CELL_LIMIT); - result.yhi = round_and_clamp(y2 / CELL_SCALE, -CELL_LIMIT, CELL_LIMIT); - return result; -} +// Class PlaneTree. Everything here is 'public', but this class +// is only visible inside this one C++ file. +class PlaneTree : public eng::opnew { +public: + void set_radius(float r); + + using NodeID = uint64_t; + using ChildBits = uint64_t; + using IdVector = util::IdVector; -static int64_t cell_id(int64_t cellx, int64_t celly) { - int64_t icellx = cellx & 0xFFFFFF; - int64_t icelly = celly & 0xFFFFFF; - return 0x0001000000000000 | (icellx << 24) | (icelly << 0); -} + // The PlaneMap that this tree is a part of. + PlaneMap *planemap_; -// Get the cell ID of the specified point -static int64_t point_cell_id(float x, float y) { - float cellx = round_and_clamp(x / CELL_SCALE, -CELL_LIMIT, CELL_LIMIT); - float celly = round_and_clamp(y / CELL_SCALE, -CELL_LIMIT, CELL_LIMIT); - return cell_id(int64_t(cellx), int64_t(celly)); -} + // The name of this plane. + eng::string plane_; -void PlaneMap::remove(const eng::string &plane, int64_t cellid, PlaneItem *client) { - auto piter = planes_.find(plane); - if (piter == planes_.end()) { - return; + // Internal nodes in the tree just have bits indicating + // which children exist. + eng::bytell_hash_map internal_nodes_; + + // Leaf nodes in the tree contain a doubly-linked + // intrusive ring. + eng::bytell_hash_map leaf_nodes_; + + // The radius of the bounding box. + double radius_; + + // A conversion factor to convert float coordinates to + // integral coordinates. Equal to 32k / radius. + float scale_; + + // total number of items in the planetree. + int total_count_; + + // total number of outliers in the planetree. Outliers are + // classified as just outside or way outside the bbox. + int just_outside_bbox_; + int way_outside_bbox_; + +public: + // Untrack all planeitems. This is for unit testing and for destructors. We + // don't use PlaneItem::untrack, because that would create problems with + // removing items from a list while iterating over that list. + void untrack_all() { + for (auto &l : leaf_nodes_) { + PlaneItem *first = l.second; + PlaneItem *pi = first; + assert(pi != nullptr); + while (true) { + PlaneItem *next = pi->next_; + pi->tree_= nullptr; + pi = next; + if (pi == first) break; + } + } + leaf_nodes_.clear(); + internal_nodes_.clear(); } - Plane &p = piter->second; - auto liter = p.find(cellid); - if (liter == p.end()) { - return; - } - EltVec &l = liter->second; - l.erase(std::remove(l.begin(), l.end(), client), l.end()); - if (l.empty()) { - p.erase(liter); - } - if (p.empty()) { - planes_.erase(piter); - } -} -void PlaneMap::insert(const eng::string &plane, int64_t cellid, PlaneItem *client) { - Plane &p = planes_[plane]; - EltVec &l = p[cellid]; - l.push_back(client); -} + // This just sets the radius. + // It verifies that the tree is empty first. + void set_radius_of_empty_tree(float r) { + assert(total_count_ == 0); + radius_ = r; + scale_ = 32768.0 / r; + } -void PlaneItem::set_pos(const eng::string &plane, float x, float y, float z) { - int64_t old_cell = point_cell_id(x_, y_); - int64_t new_cell = point_cell_id(x, y); + // Get a PlaneTree by plane name. + static PlaneTree *get(PlaneMap *pmap, const eng::string &plane) { + std::unique_ptr &result = pmap->planes_[plane]; + if (result == nullptr) { + result.reset(new PlaneTree(pmap, plane)); + } + return result.get(); + } - // Update the grid. - if (pmap_ != 0) { - if ((plane_ != plane) || (old_cell != new_cell)) { - pmap_->remove(plane_, old_cell, this); - pmap_->insert(plane, new_cell, this); + // Remove an item from the specified leaf node. + // Returns true if we removed the last item from the leaf. + bool remove_planeitem_from_leaf(NodeID node, PlaneItem *item) { + if (item->next_ == item) { + leaf_nodes_.erase(node); + // Note: these next two assignments are only needed for sanity checking. + item->next_ = nullptr; + item->prev_ = nullptr; + return true; + } else { + item->prev_->next_ = item->next_; + item->next_->prev_ = item->prev_; + // Note: these next two assignments are only needed for sanity checking. + item->next_ = nullptr; + item->prev_ = nullptr; + return false; } } - // Update the client position. - plane_ = plane; - x_ = x; - y_ = y; - z_ = z; -} - -void PlaneItem::untrack() { - if (pmap_ != 0) { - pmap_->remove(plane_, point_cell_id(x_, y_), this); - pmap_ = 0; + // Insert an item into the specified leaf node. + // Returns true if we inserted the first item into the leaf. + bool insert_planeitem_into_leaf(NodeID node, PlaneItem *item) { + PlaneItem *&newcell = leaf_nodes_[node]; + if (newcell == nullptr) { + newcell = item; + item->next_ = item; + item->prev_ = item; + return true; + } else { + PlaneItem *next = newcell; + PlaneItem *prev = newcell->prev_; + item->next_ = next; + item->prev_ = prev; + prev->next_ = item; + next->prev_ = item; + return false; + } } -} + + // Update the parent to reflect the fact that the child was added. + // This will propagage all the way up the tree. + void insert_child_into_childbits(NodeID child) { + uint8_t childlevel = node_get_level(child); + uint8_t parentlevel = childlevel + 1; + NodeID parent = node_parent(child); + ChildBits &inode = internal_nodes_[parent]; + bool waszero = (inode == 0); + inode |= node_childbit(child); + if (waszero) { + if (parentlevel < 8) insert_child_into_childbits(parent); + } + } + + // Update the parent to reflect the fact that the child was removed. + // This will propagage all the way up the tree. + void remove_child_from_childbits(NodeID child) { + uint8_t childlevel = node_get_level(child); + uint8_t parentlevel = childlevel + 1; + NodeID parent = node_parent(child); + auto iter = internal_nodes_.find(parent); + iter->second &= (~node_childbit(child)); + if (iter->second == 0) { + internal_nodes_.erase(parent); + if (parentlevel < 8) remove_child_from_childbits(parent); + } + } + + // Update the counters to reflect the removal of one item from the tree. + void decrement_planeitem_counters(BBoxCheck bbcheck) { + total_count_ -= 1; + if (bbcheck == JUST_OUTSIDE_BBOX) just_outside_bbox_ -= 1; + if (bbcheck == WAY_OUTSIDE_BBOX) way_outside_bbox_ -= 1; + } + + // Update the counters to reflect the insertion of one item into the tree. + void increment_planeitem_counters(BBoxCheck bbcheck) { + total_count_ += 1; + if (bbcheck == JUST_OUTSIDE_BBOX) just_outside_bbox_ += 1; + if (bbcheck == WAY_OUTSIDE_BBOX) way_outside_bbox_ += 1; + } + + // Remove a planeitem from whatever tree it is in, preserving + // all invariants. The planeitem ends up being an untracked PlaneItem. + static void remove_planeitem(PlaneItem *item) { + PlaneTree *tree = item->tree_; + assert(tree != nullptr); + NodeInfo info(tree->scale_, item->x_, item->y_, item->z_); + tree->decrement_planeitem_counters(info.bbcheck); + if (tree->remove_planeitem_from_leaf(info.node, item)) { + tree->remove_child_from_childbits(info.node); + } + item->tree_ = nullptr; + } + + // Insert a planeitem into whatever tree is specified, preserving + // all invariants. The planeitem must be an untracked PlaneItem. + void insert_planeitem(PlaneItem *item) { + PlaneTree *tree = this; + assert(item->tree_ == nullptr); + NodeInfo info(tree->scale_, item->x_, item->y_, item->z_); + tree->increment_planeitem_counters(info.bbcheck); + if (tree->insert_planeitem_into_leaf(info.node, item)) { + tree->insert_child_into_childbits(info.node); + } + item->tree_ = tree; + item->plane_ = tree->plane_; + } + + // Scan a planetree. + void scan(const PlaneScan &scan, IdVector *result) { + // Convert the bounding box to integral coordinates. + NodeInfo bblo(scale_, scan.lo_.x, scan.lo_.y, scan.lo_.z); + NodeInfo bbhi(scale_, scan.hi_.x, scan.hi_.y, scan.hi_.z); + + + // NOT IMPLEMENTED YET + } + + void print_planeitem_ids(PlaneItem *first, std::ostream *os) { + util::IdVector ids; + if (first == nullptr) { + (*os) << "invalid null list"; + return; + } + PlaneItem *pi = first; + while (true) { + PlaneItem *next = pi->next_; + ids.push_back(pi->id()); + if (next == first) break; + pi = next; + } + std::sort(ids.begin(), ids.end()); + if (ids.size() > 0) { + (*os) << ids[0]; + } + for (int i = 1; i < int(ids.size()); i++) { + (*os) << "," << ids[i]; + } + } + + void print_tree_r(NodeID node, std::ostream *os) { + int level = node_get_level(node); + int indent = 8 - level; + if (level == 0) { + (*os) << "| "; + print_node_id(node, os); + (*os) << " "; + auto iter = leaf_nodes_.find(node); + if (iter == leaf_nodes_.end()) { + (*os) << "no such leaf"; + } else { + print_planeitem_ids(iter->second, os); + } + } else { + auto iter = internal_nodes_.find(node); + ChildBits cb = 0; + if (iter != internal_nodes_.end()) { + cb = iter->second; + } + if ((level & 1) == 0) { + (*os) << "|"; + for (int i = 0; i < indent; i++) (*os) << " "; + print_node_id(node, os); + if ((cb == 0) && (level != 8)) { + (*os) << " (invalid empty node)"; + } + } + for (int i = 0; i < 64; i++) { + if (cb & child_bit(i)) { + NodeID child = node_nthchild(node, i); + assert(node_childindex(child) == i); + print_tree_r(child, os); + } + } + } + } + + eng::string tree_debug_string() { + eng::ostringstream oss; + print_tree_r(node_lxyz(8,0,0,0), &oss); + return oss.str(); + } + + eng::string outliers_debug_string() { + eng::ostringstream oss; + oss << "total:" << total_count_ << " justout:" << just_outside_bbox_ << " wayout:" << way_outside_bbox_; + return oss.str(); + } + + // Construct a PlaneTree. + PlaneTree(PlaneMap *pmap, const eng::string &plane) { + planemap_ = pmap; + plane_ = plane; + total_count_ = 0; + just_outside_bbox_ = 0; + way_outside_bbox_ = 0; + set_radius_of_empty_tree(pmap->default_radius_); + } + + // Destructor: the PlaneTree doesn't own the PlaneItems, so it doesn't + // delete them, but it needs to untrack all the PlaneItems. + ~PlaneTree() { + untrack_all(); + } +}; void PlaneItem::track(PlaneMap *pmap) { - if (pmap_ != pmap) { - untrack(); - pmap->insert(plane_, point_cell_id(x_, y_), this); - pmap_ = pmap; + // If we're already in a PlaneMap, and it's not the + // PlaneMap we want to be in, remove from the old PlaneMap. + if ((tree_ != nullptr) && (tree_->planemap_ != pmap)) { + PlaneTree::remove_planeitem(this); + } + + // If we're supposed to be in a PlaneMap, and we're not + // already in the PlaneMap, insert it. + if ((tree_ == nullptr) && (pmap != nullptr)) { + PlaneTree::get(pmap, plane_)->insert_planeitem(this); } } -PlaneItem::PlaneItem() : pmap_(NULL), x_(0.0), y_(0.0), z_(0.0) { +void PlaneItem::set_pos(const eng::string &plane, float x, float y, float z) { + // If we're not in a PlaneMap, nothing to do but set the variables. + if (tree_ == nullptr) { + plane_ = plane; + x_ = x; + y_ = y; + z_ = z; + return; + } + + // When moving within a plane (not warping), use set_xyz, which is faster. + if (plane_ == plane) { + set_xyz(x, y, z); + return; + } + + // We're warping from one plane to another. That means we're removing + // ourself from one planetree and inserting ourself into a different one. + PlaneTree *newtree = PlaneTree::get(tree_->planemap_, plane); + PlaneTree::remove_planeitem(this); + x_ = x; + y_ = y; + z_ = z; + newtree->insert_planeitem(this); } -PlaneMap::PlaneMap() { +void PlaneItem::set_xyz(float x, float y, float z) { + // If we're not in a PlaneMap, nothing to do but set the variables. + if (tree_ == nullptr) { + x_ = x; + y_ = y; + z_ = z; + return; + } + + // We could implement this function using 'PlaneTree::remove_planeitem' + // and 'PlaneTree::insert_planeitem', which would be less code, but it + // would also be slower. + NodeInfo old_cell(tree_->scale_, x_, y_, z_); + NodeInfo new_cell(tree_->scale_, x, y, z); + + // Update the variables. + x_ = x; + y_ = y; + z_ = z; + + // Update the outliers counters (unlikely). + if (old_cell.bbcheck != new_cell.bbcheck) { + tree_->decrement_planeitem_counters(old_cell.bbcheck); + tree_->increment_planeitem_counters(new_cell.bbcheck); + } + + // If we have changed cells, update the tree. + // We have to remove the child from the old leaf before inserting + // it into the new leaf, because the 'next' and 'prev' pointers are + // intrusive and we need them to be unused to do the insert. + // However, inserting the child into the childbits first is faster + // and poses no problems. + if (new_cell.node != old_cell.node) { + bool leaf_removed = tree_->remove_planeitem_from_leaf(old_cell.node, this); + bool leaf_created = tree_->insert_planeitem_into_leaf(new_cell.node, this); + if (leaf_created) tree_->insert_child_into_childbits(new_cell.node); + if (leaf_removed) tree_->remove_child_from_childbits(old_cell.node); + } +} + +PlaneItem::PlaneItem() { + id_ = 0; + tree_ = nullptr; + next_ = nullptr; + prev_ = nullptr; + x_ = y_ = z_ = 0.0; } PlaneItem::~PlaneItem() { untrack(); } -PlaneMap::~PlaneMap() { - for (const auto &p : planes_) { - for (const auto &l : p.second) { - for (PlaneItem *i : l.second) { - i->pmap_ = NULL; - } +PlaneMap::PlaneMap() : default_radius_(32768.0) {} +PlaneMap::~PlaneMap() {} + + +IdVector PlaneMap::scan(const PlaneScan &scan) const { + IdVector result; + int startpos = 0; + if (scan.special_ != 0) { + if (!scan.omit_special_) { + result.push_back(scan.special_); + startpos = 1; } } -} -PlaneMap::EltVec PlaneMap::get_cell(const eng::string &plane, int64_t cellid) const { - PlaneMap::EltVec result; - auto piter = planes_.find(plane); - if (piter != planes_.end()) { - const Plane &p = piter->second; - auto liter = p.find(cellid); - if (liter != p.end()) { - result = liter->second; - } - } - return result; -} - -int PlaneMap::total_cells() const { - int total = 0; - for (const auto &p : planes_) { - total += p.second.size(); - } - return total; -} - -PlaneMap::IdVector PlaneMap::scan_radius_unsorted(const eng::string &plane, float x, float y, float radius, bool exclude_nowhere, int64_t special, bool omit) const { - PlaneMap::IdVector result; - if ((special != 0)&&(!omit)) { - result.push_back(special); - } - if (exclude_nowhere && (plane == "nowhere")) { + if (scan.omit_nowhere_ && (scan.plane_ == "nowhere")) { return result; } - auto piter = planes_.find(plane); + + auto piter = planes_.find(scan.plane_); if (piter != planes_.end()) { - const Plane &p = piter->second; - CellRange range = rect_cell_range(x - radius, y - radius, x + radius, y + radius); - float radsq = radius*radius; - for (int cy = range.ylo; cy <= range.yhi; cy++) { - for (int cx = range.xlo; cx <= range.xhi; cx++) { - auto liter = p.find(cell_id(cx, cy)); - if (liter != p.end()) { - for (PlaneItem *client : liter->second) { - if (util::distance_squared(client->x(), client->y(), x, y) <= radsq) { - if (client->id() != special) { - result.push_back(client->id()); - } - } - } - } - } - } + const std::unique_ptr &tree = piter->second; + tree->scan(scan, &result); + } + + if (scan.sorted_) { + std::sort(result.begin() + startpos, result.end()); } return result; } -PlaneMap::IdVector PlaneMap::scan_radius(const eng::string &plane, float x, float y, float radius, bool exclude_nowhere, int64_t special, bool omit) const { - PlaneMap::IdVector result = scan_radius_unsorted(plane, x, y, radius, exclude_nowhere, special, omit); - if ((special != 0)&&(!omit)) { - std::sort(result.begin() + 1, result.end()); +eng::string PlaneMap::tree_debug_string(const eng::string &plane) const { + auto iter = planes_.find(plane); + if (iter == planes_.end()) { + return "no such plane"; } else { - std::sort(result.begin(), result.end()); + return iter->second->tree_debug_string(); } - return result; } +eng::string PlaneMap::outliers_debug_string(const eng::string &plane) const { + auto iter = planes_.find(plane); + if (iter == planes_.end()) { + return "no such plane"; + } else { + return iter->second->outliers_debug_string(); + } +} + +void PlaneMap::untrack_all() { + for (const auto &pair : planes_) { + pair.second->untrack_all(); + } +} + +static eng::string tdb(const PlaneMap &pm) { + return pm.tree_debug_string("p"); +} + +static eng::string odb(const PlaneMap &pm) { + return pm.outliers_debug_string("p"); +} + +// The default radius is set such that float coordinates map directly to +// integer coordinates, with an offset of 0x8000. This makes unit testing +// a lot easier. +// LuaDefine(unittests_planemap, "", "some unit tests") { - float SC = CELL_SCALE; - float E = CELL_SCALE * 0.4; - int LO = -CELL_LIMIT; - int HI = CELL_LIMIT; PlaneMap pm; - PlaneItem pia, pib; - PlaneMap::EltVec elts; - PlaneMap::IdVector ids; + PlaneItem pi123, pi456; + pi123.set_id(123); + pi456.set_id(456); - // Simple test. - LuaAssert(L, rect_cell_range(-7*SC, -15*SC, 87*SC, 21*SC).equal(-7, -15, 87, 21)); - - // Adding an epsilon doesn't change result, if epsilon is less than half of cell scale. - LuaAssert(L, rect_cell_range(-7*SC+E, -15*SC+E, 87*SC-E, 21*SC-E).equal(-7, -15, 87, 21)); + // Test that PlaneItems can be manipulated when they're not + // yet tracking a PlaneMap. + pi123.set_pos("p", 0x38, 0x16, 0x87); + LuaAssert(L, pi123.plane() == "p"); + LuaAssert(L, pi123.x() == 0x38); + LuaAssert(L, pi123.y() == 0x16); + LuaAssert(L, pi123.z() == 0x87); - // Rectangle that crosses the high end of the range. - LuaAssert(L, rect_cell_range((HI-7)*SC, (HI-5)*SC, (HI+3)*SC, (HI+6)*SC).equal(HI-7, HI-5, HI, HI)); - - // Rectangle that exceeds the high end of the range. - LuaAssert(L, rect_cell_range((HI+7)*SC, (HI+5)*SC, (HI+15)*SC, (HI+12)*SC).equal(HI, HI, HI, HI)); + // TESTS OF TREE MANIPULATION FOLLOW. - // Rectangle that crosses the low end of the range. - LuaAssert(L, rect_cell_range((LO-7)*SC, (LO-5)*SC, (LO+3)*SC, (LO+4)*SC).equal(LO, LO, LO+3, LO+4)); + // Test track. + pi123.set_pos("p", 0x38, 0x16, 0x87); + pi123.track(&pm); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,8,8" + "| L4:80,80,80" + "| L2:803,801,808" + "| L0:8038,8016,8087 123"); + + // Test untrack. + pi123.untrack(); + LuaAssertStrEq(L, tdb(pm), + "|L8:root"); - // Rectangle that exceeds the low end of the range. - LuaAssert(L, rect_cell_range((LO-15)*SC, (LO-17)*SC, (LO-7)*SC, (LO-5)*SC).equal(LO, LO, LO, LO)); - - // Simple test. - LuaAssert(L, point_cell_id(-7*SC, 15*SC) == cell_id(-7, 15)); - - // Adding epsilon doesn't change the result if less than half cell scale. - LuaAssert(L, point_cell_id(-7*SC+E, 15*SC+E) == cell_id(-7, 15)); - - // Right at the top edge of the range. - LuaAssert(L, point_cell_id(HI*SC, HI*SC) == cell_id(HI, HI)); - - // Right at the bottom edge of the range. - LuaAssert(L, point_cell_id(LO*SC, LO*SC) == cell_id(LO, LO)); - - // Beyond various edges. - LuaAssert(L, point_cell_id((LO-1)*SC, 0) == point_cell_id(LO*SC, 0)); - LuaAssert(L, point_cell_id((HI+1)*SC, 0) == point_cell_id(HI*SC, 0)); - LuaAssert(L, point_cell_id(0, (LO-1)*SC) == point_cell_id(0, LO*SC)); - LuaAssert(L, point_cell_id(0, (HI+1)*SC) == point_cell_id(0, HI*SC)); - - // Test using the insert function. - pm.clear(); - LuaAssert(L, pm.total_cells() == 0); - pm.insert("foo", 12345, &pia); - LuaAssert(L, pm.total_cells() == 1); - pm.insert("foo", 12345, &pib); - LuaAssert(L, pm.total_cells() == 1); - elts = pm.get_cell("foo", 12345); - LuaAssert(L, elts.size() == 2); - LuaAssert(L, elts[0] == &pia); - LuaAssert(L, elts[1] == &pib); - - // Test the remove function. - pm.remove("foo", 12345, &pia); - LuaAssert(L, pm.total_cells() == 1); - elts = pm.get_cell("foo", 12345); - LuaAssert(L, elts.size() == 1); - LuaAssert(L, elts[0] == &pib); - pm.remove("foo", 12345, &pib); - LuaAssert(L, pm.total_cells() == 0); + // Track two items at a time, not in the same cell. + pi456.set_pos("p", 0x12, 0x17, 0xAC); + pi123.track(&pm); + pi456.track(&pm); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,8,8" + "| L4:80,80,80" + "| L2:801,801,80a" + "| L0:8012,8017,80ac 456" + "| L2:803,801,808" + "| L0:8038,8016,8087 123"); - // Try moving a plane item around without it being tracked to a grid. - pia.set_pos("foo", 3, 4, 5); - LuaAssert(L, pia.plane() == "foo"); - LuaAssert(L, pia.x() == 3.0); - LuaAssert(L, pia.y() == 4.0); - LuaAssert(L, pia.z() == 5.0); + // Move one of the items into the same cell as the other. + pi456.set_xyz(0x38, 0x16, 0x87); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,8,8" + "| L4:80,80,80" + "| L2:803,801,808" + "| L0:8038,8016,8087 123,456"); - // Attach pia to the grid. This should record it. - pm.clear(); - pia.track(&pm); - elts = pm.get_cell("foo", point_cell_id(3.0, 4.0)); - LuaAssert(L, elts.size() == 1); - LuaAssert(L, elts[0] == &pia); - - // Unattach pia from the grid. This should unrecord it. - pia.untrack(); - LuaAssert(L, pm.total_cells() == 0); + // Move item 456 back out of the cell. + pi456.set_xyz(0x27, 0x11, 0x31); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,8,8" + "| L4:80,80,80" + "| L2:802,801,803" + "| L0:8027,8011,8031 456" + "| L2:803,801,808" + "| L0:8038,8016,8087 123"); - // Reattach pia to the grid, then move it. - pia.track(&pm); - LuaAssert(L, pm.total_cells() == 1); - pia.set_pos("bar", 1000.0, 1000.0, 0.0); - LuaAssert(L, pm.total_cells() == 1); - elts = pm.get_cell("bar", point_cell_id(1000.0, 1000.0)); - LuaAssert(L, elts.size() == 1); - LuaAssert(L, elts[0] == &pia); + // Move item 123 to follow 456. + pi123.set_xyz(0x27, 0x11, 0x31); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,8,8" + "| L4:80,80,80" + "| L2:802,801,803" + "| L0:8027,8011,8031 123,456"); + + // TESTS OF OUTLIER CLAMPING FOLLOW. + + // Move item 456 close to, but not quite on the positive edge. + pi123.untrack(); + pi456.set_xyz(0x23, 0x7FFE, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:0 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,f,8" + "| L4:80,ff,80" + "| L2:802,fff,802" + "| L0:8023,fffe,8027 456"); + + // Move item 456 so that it's on the positive edge, but not an outlier. + pi456.set_xyz(0x23, 0x7FFF, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:0 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,f,8" + "| L4:80,ff,80" + "| L2:802,fff,802" + "| L0:8023,ffff,8027 456"); + + // Move item 456 so that it's even closer to the positive edge, but not an outlier. + pi456.set_xyz(0x23, 0x7FFF + 0.99, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:0 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,f,8" + "| L4:80,ff,80" + "| L2:802,fff,802" + "| L0:8023,ffff,8027 456"); + + // Move item 456 so that it's just barely a positive outlier. + pi456.set_xyz(0x23, 0x8000, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:1 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,f,8" + "| L4:80,ff,80" + "| L2:802,fff,802" + "| L0:8023,ffff,8027 456"); + + // Move item 456 so that it's considerably past the positive edge. + pi456.set_xyz(0x23, 0x8048, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:1 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,f,8" + "| L4:80,ff,80" + "| L2:802,fff,802" + "| L0:8023,ffff,8027 456"); + + // Move item 456 so that it's way past the positive edge. + pi456.set_xyz(0x23, 0x83748, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:0 wayout:1"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,f,8" + "| L4:80,ff,80" + "| L2:802,fff,802" + "| L0:8023,ffff,8027 456"); + + // Move item 456 close to, but not quite on the negative edge. + pi456.set_xyz(0x23, -0x7fff, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:0 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,0,8" + "| L4:80,00,80" + "| L2:802,000,802" + "| L0:8023,0001,8027 456"); + + // Move item 456 so that it's on the negative edge, but not an outlier. + pi456.set_xyz(0x23, -0x7fff - 0.5, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:0 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,0,8" + "| L4:80,00,80" + "| L2:802,000,802" + "| L0:8023,0000,8027 456"); + + // Move item 456 so that it's just barely a negative outlier. + pi456.set_xyz(0x23, -0x8000, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:1 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,0,8" + "| L4:80,00,80" + "| L2:802,000,802" + "| L0:8023,0000,8027 456"); + + // Move item 456 so that it's significantly past the negative edge. + pi456.set_xyz(0x23, -0x8048, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:1 wayout:0"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,0,8" + "| L4:80,00,80" + "| L2:802,000,802" + "| L0:8023,0000,8027 456"); + + // Move item 456 so that it's way past the negative edge. + pi456.set_xyz(0x23, -0x83048, 0x27); + LuaAssertStrEq(L, odb(pm), "total:1 justout:0 wayout:1"); + LuaAssertStrEq(L, tdb(pm), + "|L8:root" + "| L6:8,0,8" + "| L4:80,00,80" + "| L2:802,000,802" + "| L0:8023,0000,8027 456"); - // Insert the four elements, then test the scan function. - pib.track(&pm); - pia.set_id(123); - pib.set_id(456); - pib.set_pos("bar", 1100.0, 1000.0, 0.0); - ids = pm.scan_radius("bar", 1000.0, 1000.0, 1.0, false, 0, false); - LuaAssert(L, ids.size() == 1); - LuaAssert(L, ids[0] == 123); - ids = pm.scan_radius("bar", 1000.0, 1000.0, 99.9, false, 0, false); - LuaAssert(L, ids.size() == 1); - LuaAssert(L, ids[0] == 123); - ids = pm.scan_radius("bar", 1000.0, 1000.0, 100.0, false, 0, false); - LuaAssert(L, ids.size() == 2); - LuaAssert(L, ids[0] == 123); - LuaAssert(L, ids[1] == 456); return 0; } diff --git a/luprex/core/cpp/planemap.hpp b/luprex/core/cpp/planemap.hpp index bc7a71d6..57a36057 100644 --- a/luprex/core/cpp/planemap.hpp +++ b/luprex/core/cpp/planemap.hpp @@ -76,21 +76,94 @@ #include "wrap-vector.hpp" #include "wrap-map.hpp" #include "wrap-string.hpp" - +#include "wrap-bytell-hash-map.hpp" #include "util.hpp" +#include "luastack.hpp" #include +#include +#include class PlaneMap; +class PlaneTree; -class PlaneItem : public eng::nevernew { +class PlaneScan : public eng::nevernew { +public: friend class PlaneMap; + friend class PlaneTree; + enum Shape { BOX, CYLINDER, SPHEROID }; +private: + // The plane to scan. + eng::string plane_; + + // The bounding box of the scan. + util::XYZ lo_, hi_, center_; + + // If you scan a cylinder or spheroid, it actually + // scans the bounding box first, then clips out + // the parts that aren't correct. + Shape shape_; + + // When true, the items are sorted by ID. + // WARNING: setting this to false can create + // nondeterminism. Scans by lua should always be sorted. + bool sorted_; + + // The special ID, if nonzero, is either PREPENDED to the + // results, or OMITTED from the results, depending on omit_special. + int64_t special_; + bool omit_special_; + + // If this is true, items on the nowhere plane are not scanned. + bool omit_nowhere_; private: - PlaneMap *pmap_; + // Derived variables. These are populated by PlaneTree::scan. + uint64_t bblo_; + uint64_t bbhi_; + +public: + PlaneScan() : plane_(""), shape_(BOX), sorted_(true), special_(0), omit_special_(0), omit_nowhere_(false) {} + + // Convert a lua table into a scan configuration. + void configure(LuaStack &LS, LuaSlot slot); + + // Set the bounding box given two corners. + void set_bbox_given_two_corners(const util::XYZ &a, const util::XYZ &b) { + lo_.x = std::min(a.x, b.x); + lo_.y = std::min(a.y, b.y); + lo_.z = std::min(a.z, b.z); + hi_.x = std::max(a.x, b.x); + hi_.y = std::max(a.y, b.y); + hi_.z = std::max(a.z, b.z); + center_ = (lo_ + hi_) * 0.5; + } + + // Set the bounding box given a center and a radius. + void set_bbox_given_center_radius(const util::XYZ ¢er, float r) { + util::XYZ offset(r, r, r); + lo_ = center - offset; + hi_ = center + offset; + center_ = center; + } + + void set_plane(std::string_view p) { plane_ = p; } + void set_shape(Shape s) { shape_ = s; } + void set_sorted(bool s) { sorted_ = s; } + void set_special(int64_t id, bool omit) { special_ = id; omit_special_ = omit; } + void set_omit_nowhere(bool b) { omit_nowhere_ = b; } +}; + +class PlaneItem : public eng::nevernew { + friend class PlaneTree; + friend class PlaneMap; +private: + PlaneTree *tree_; + PlaneItem *prev_; + PlaneItem *next_; + int64_t id_; eng::string plane_; float x_, y_, z_; - int64_t id_; public: PlaneItem(); @@ -105,43 +178,49 @@ public: const float y() const { return y_; } const float z() const { return z_; } - void untrack(); void track(PlaneMap *pmap); + void untrack() { track(nullptr); } void set_pos(const eng::string &plane, float x, float y, float z); - void set_xyz(float x, float y, float z) { set_pos(plane_, x, y, z); } + void set_xyz(float x, float y, float z); }; class PlaneMap : public eng::nevernew { friend class PlaneItem; -private: - using EltVec = eng::vector; - using Plane = eng::map; - eng::map planes_; - void remove(const eng::string &plane, int64_t cell, PlaneItem *client); - void insert(const eng::string &plane, int64_t cell, PlaneItem *client); - + friend class PlaneTree; public: using IdVector = util::IdVector; + +private: + float default_radius_; + eng::map> planes_; + +public: + // No special code is needed for construction or destruction. PlaneMap(); ~PlaneMap(); - // Caution: scan_radius is not deterministically ordered unless sort=true. - // - // exclude_nowhere - if true, and plane="nowhere", nothing is scanned. - // special - an ID that is considered special. If zero, there is no special ID. - // omit - if true, remove the special ID from the list. - // if false, prepend the special ID to the head of the list. - // - IdVector scan_radius(const eng::string &plane, float x, float y, float radius, bool exclude_nowhere, int64_t special, bool omit) const; - IdVector scan_radius_unsorted(const eng::string &plane, float x, float y, float radius, bool exclude_nowhere, int64_t special, bool omit) const; + // The 'insert' and 'remove' operators are inside class + // PlaneItem. See PlaneItem::track and PlaneItem::untrack. + // Scan the PlaneMap for items, return their IDs. + IdVector scan(const PlaneScan &s) const; + + // Set the default radius for all planes. + // Maybe we'll make it adaptive some day. + void set_default_radius(float r) { default_radius_ = r; } + + // Return a debug string for the specified plane. + // This is for unit testing. + eng::string tree_debug_string(const eng::string &plane) const; + eng::string outliers_debug_string(const eng::string &plane) const; + + // Untrack all planeitems. This is for unit testing. + void untrack_all(); + private: // unit testing stuff. friend int lfn_unittests_planemap(lua_State *L); - EltVec get_cell(const eng::string &plane, int64_t cell) const; - int total_cells() const; - void clear() { planes_.clear(); } }; diff --git a/luprex/core/cpp/util.hpp b/luprex/core/cpp/util.hpp index 3bde6373..d56ef131 100644 --- a/luprex/core/cpp/util.hpp +++ b/luprex/core/cpp/util.hpp @@ -262,6 +262,16 @@ eng::string hash_to_hex(const HashValue &hash); // This is a good hash, but not cryptographically good. uint64_t hash_ints(uint64_t n1, uint64_t n2, uint64_t n3, uint64_t n4); +// Hash a single 64-bit integer. +// This is a good hash, but not cryptographically good. +// Published by David Stafford in his article 'Better Bit Mixing'. +inline uint64_t hash_int(uint64_t x) { + x = (x ^ (x >> 30)) * UINT64_C(0xbf58476d1ce4e5b9); + x = (x ^ (x >> 27)) * UINT64_C(0x94d049bb133111eb); + x = x ^ (x >> 31); + return x; +} + // Convert a 64-bit hash value into a floating point number between 0 and 1. double hash_to_double(uint64_t hash); @@ -319,6 +329,9 @@ struct XYZ { XYZ(float ix, float iy, float iz) { x=ix; y=iy; z=iz; } bool operator ==(const XYZ &o) const { return x==o.x && y == o.y && z==o.z; } bool operator !=(const XYZ &o) const { return x!=o.x || y != o.y || z!=o.z; } + XYZ operator -(const XYZ &o) const { return XYZ(x-o.x, y-o.y, z-o.z); } + XYZ operator +(const XYZ &o) const { return XYZ(x+o.x, y+o.y, z+o.z); } + XYZ operator *(float scale) const { return XYZ(x*scale, y*scale, z*scale); } eng::string debug_string() const; }; diff --git a/luprex/core/cpp/world-accessor.cpp b/luprex/core/cpp/world-accessor.cpp index feb989a6..44020e2e 100644 --- a/luprex/core/cpp/world-accessor.cpp +++ b/luprex/core/cpp/world-accessor.cpp @@ -265,11 +265,17 @@ LuaDefine(tangible_near, "tan,radius,omit_nowhere,omit_self", LuaStack LS(L, ltan, lradius, lomit_nowhere, lomit_self, list); World *w = World::fetch_global_pointer(L); Tangible *tan = w->tangible_get(LS, ltan); - double radius = LS.cknumber(lradius); - bool omit_nowhere = LS.ckboolean(lomit_nowhere); - bool omit_self = LS.ckboolean(lomit_self); const AnimStep &aqback = tan->anim_queue_.back(); - util::IdVector idv = w->plane_map_.scan_radius(aqback.plane(), aqback.xyz().x, aqback.xyz().y, radius, omit_nowhere, tan->id(), omit_self); + + PlaneScan scan; + scan.set_plane(aqback.plane()); + scan.set_bbox_given_center_radius(aqback.xyz(), LS.cknumber(lradius)); + scan.set_shape(PlaneScan::SPHEROID); + scan.set_sorted(true); + scan.set_special(tan->id(), LS.ckboolean(lomit_self)); + scan.set_omit_nowhere(LS.ckboolean(lomit_nowhere)); + + util::IdVector idv = w->plane_map_.scan(scan); tangible_getall(LS, list, idv); return LS.result(); } @@ -282,12 +288,15 @@ LuaDefine(tangible_scan, "plane,x,y,radius,omit_nowhere", LuaRet list; LuaStack LS(L, lplane, lx, ly, lradius, lomit_nowhere, list); World *w = World::fetch_global_pointer(L); - eng::string plane = LS.ckstring(lplane); - double x = LS.cknumber(lx); - double y = LS.cknumber(ly); - double radius = LS.cknumber(lradius); - bool omit_nowhere = LS.ckboolean(lomit_nowhere); - util::IdVector idv = w->plane_map_.scan_radius(plane, x, y, radius, omit_nowhere, 0, false); + + PlaneScan scan; + scan.set_plane(LS.ckstring(lplane)); + scan.set_bbox_given_center_radius(util::XYZ(LS.cknumber(lx), LS.cknumber(ly), 0), LS.cknumber(lradius)); + scan.set_shape(PlaneScan::SPHEROID); + scan.set_sorted(true); + scan.set_omit_nowhere(LS.ckboolean(lomit_nowhere)); + + util::IdVector idv = w->plane_map_.scan(scan); tangible_getall(LS, list, idv); return LS.result(); } diff --git a/luprex/core/cpp/world-core.cpp b/luprex/core/cpp/world-core.cpp index 3b11b026..fd0cb8fd 100644 --- a/luprex/core/cpp/world-core.cpp +++ b/luprex/core/cpp/world-core.cpp @@ -220,26 +220,23 @@ void World::tangible_delete(int64_t id) { LS.result(); } -util::IdVector World::get_near_unsorted(int64_t player_id, float radius, bool exclude_nowhere, bool omit_player) const { +util::IdVector World::get_near(int64_t player_id, float radius, bool exclude_nowhere, bool omit_player, bool sorted) const { const Tangible *player = tangible_get(player_id); if (player == nullptr) { return IdVector(); } - // Find out where's the center of the world. + // Find out where the player is. const AnimStep &aqback = player->anim_queue_.back(); - return plane_map_.scan_radius_unsorted(aqback.plane(), aqback.xyz().x, aqback.xyz().y, radius, exclude_nowhere, player_id, omit_player); -} -util::IdVector World::get_near(int64_t player_id, float radius, bool exclude_nowhere, bool omit_player) const { - const Tangible *player = tangible_get(player_id); - if (player == nullptr) { - return IdVector(); - } - - // Find out where's the center of the world. - const AnimStep &aqback = player->anim_queue_.back(); - return plane_map_.scan_radius(aqback.plane(), aqback.xyz().x, aqback.xyz().y, radius, exclude_nowhere, player_id, omit_player); + PlaneScan scan; + scan.set_plane(aqback.plane()); + scan.set_bbox_given_center_radius(aqback.xyz(), radius); + scan.set_shape(PlaneScan::SPHEROID); + scan.set_sorted(sorted); + scan.set_omit_nowhere(exclude_nowhere); + scan.set_special(player_id, omit_player); + return plane_map_.scan(scan); } World::Redirects World::fetch_redirects() { diff --git a/luprex/core/cpp/world-diffxmit.cpp b/luprex/core/cpp/world-diffxmit.cpp index fdefe54a..abb60d52 100644 --- a/luprex/core/cpp/world-diffxmit.cpp +++ b/luprex/core/cpp/world-diffxmit.cpp @@ -3,8 +3,8 @@ util::IdVector World::get_visible_union(int64_t actor_id, World *master) { return util::sort_union_id_vectors( - master->get_near_unsorted(actor_id, RadiusVisibility, true, false), - get_near_unsorted(actor_id, RadiusVisibility, true, false)); + master->get_near(actor_id, RadiusVisibility, true, false, false), + get_near(actor_id, RadiusVisibility, true, false, false)); } int64_t World::patch_actor(StreamBuffer *sb, DebugCollector *dbc) { @@ -169,7 +169,7 @@ void World::patch_luatabs(StreamBuffer *sb, DebugCollector *dbc) { int64_t actor_id = sb->read_int64(); util::HashValue closehash = sb->read_hashvalue(); int ncreate = sb->read_int32(); - util::IdVector closetans = get_near(actor_id, RadiusClose, true, false); + util::IdVector closetans = get_near(actor_id, RadiusClose, true, false, true); assert(closehash == util::hash_id_vector(closetans)); number_lua_tables(closetans); create_new_tables(ncreate); @@ -183,8 +183,8 @@ void World::diff_luatabs(int64_t actor_id, World *master, StreamBuffer *xsb) { StreamBuffer tsb; // Calculate the set of close tangibles. - util::IdVector closetans = master->get_near(actor_id, RadiusClose, true, false); - assert(get_near(actor_id, RadiusClose, true, false) == closetans); + util::IdVector closetans = master->get_near(actor_id, RadiusClose, true, false, true); + assert(get_near(actor_id, RadiusClose, true, false, true) == closetans); util::HashValue closehash = util::hash_id_vector(closetans); // Number and pair tables in the synchronous and master model. @@ -250,7 +250,7 @@ void World::diff_tanclass(int64_t actor_id, World *master, StreamBuffer *xsb) { // Calculate the set of close tangibles. // TODO: we've already calculated this in an earlier function. This is wasteful. - util::IdVector closetans = master->get_near(actor_id, RadiusClose, true, false); + util::IdVector closetans = master->get_near(actor_id, RadiusClose, true, false, true); tsb.write_int32(0); int write_count_after = tsb.total_writes(); diff --git a/luprex/core/cpp/world-testing.cpp b/luprex/core/cpp/world-testing.cpp index 7e99c2c3..0d777d08 100644 --- a/luprex/core/cpp/world-testing.cpp +++ b/luprex/core/cpp/world-testing.cpp @@ -39,7 +39,7 @@ eng::string World::tangible_ids_debug_string() const { eng::string World::tangibles_near_debug_string(int64_t actor, int64_t distance) { eng::ostringstream result; - for (int64_t id : get_near(actor, distance, true, false)) { + for (int64_t id : get_near(actor, distance, true, false, true)) { const Tangible *tan = tangible_get(id); const AnimStep &aqback = tan->anim_queue_.back(); result << id << ": " << aqback.graphic() << " " << aqback.plane() << " " << aqback.xyz().debug_string() << std::endl; diff --git a/luprex/core/cpp/world.hpp b/luprex/core/cpp/world.hpp index f4fc4a7f..d4e70bd6 100644 --- a/luprex/core/cpp/world.hpp +++ b/luprex/core/cpp/world.hpp @@ -122,10 +122,10 @@ public: // // Get a list of the tangibles that are near the player. If 'exclude_nowhere' is // true, exclude any tangibles on the nowhere plane (but still include the player himself). - // The unsorted version returns the tangibles in an unpredictable order. + // The unsorted version returns the tangibles in an unpredictable order. If sorted + // is false, return them in an unpredictable order. // - IdVector get_near(int64_t player_id, float radius, bool exclude_nowhere, bool omit_player) const; - IdVector get_near_unsorted(int64_t player_id, float radius, bool exclude_nowhere, bool omit_player) const; + IdVector get_near(int64_t player_id, float radius, bool exclude_nowhere, bool omit_player, bool sorted) const; // Make a tangible. // diff --git a/luprex/core/wrap/wrap-bytell-hash-map.hpp b/luprex/core/wrap/wrap-bytell-hash-map.hpp new file mode 100644 index 00000000..23bf3ed4 --- /dev/null +++ b/luprex/core/wrap/wrap-bytell-hash-map.hpp @@ -0,0 +1,14 @@ +#ifndef WRAP_BYTELL_HASH_MAP_HPP +#define WRAP_BYTELL_HASH_MAP_HPP + +#include "eng-malloc.hpp" +#include "bytell-hash-map.hpp" + +namespace eng { +template, class E=std::equal_to> +class bytell_hash_map : public ska::bytell_hash_map>>, public eng::opnew { + using ska::bytell_hash_map>>::bytell_hash_map; +}; +} // namespace eng + +#endif // WRAP_BYTELL_HASH_MAP_HPP