// Copyright 2018 The Abseil Authors. // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // https://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. #ifndef ABSL_CONTAINER_INTERNAL_BTREE_CONTAINER_H_ #define ABSL_CONTAINER_INTERNAL_BTREE_CONTAINER_H_ #include #include #include #include #include "absl/base/attributes.h" #include "absl/base/internal/throw_delegate.h" #include "absl/container/internal/btree.h" // IWYU pragma: export #include "absl/container/internal/common.h" #include "absl/memory/memory.h" #include "absl/meta/type_traits.h" namespace absl { ABSL_NAMESPACE_BEGIN namespace container_internal { // A common base class for btree_set, btree_map, btree_multiset, and // btree_multimap. template class btree_container { using params_type = typename Tree::params_type; protected: // Alias used for heterogeneous lookup functions. // `key_arg` evaluates to `K` when the functors are transparent and to // `key_type` otherwise. It permits template argument deduction on `K` for the // transparent case. template using key_arg = typename KeyArg::value>:: template type; public: using key_type = typename Tree::key_type; using value_type = typename Tree::value_type; using size_type = typename Tree::size_type; using difference_type = typename Tree::difference_type; using key_compare = typename Tree::original_key_compare; using value_compare = typename Tree::value_compare; using allocator_type = typename Tree::allocator_type; using reference = typename Tree::reference; using const_reference = typename Tree::const_reference; using pointer = typename Tree::pointer; using const_pointer = typename Tree::const_pointer; using iterator = typename Tree::iterator; using const_iterator = typename Tree::const_iterator; using reverse_iterator = typename Tree::reverse_iterator; using const_reverse_iterator = typename Tree::const_reverse_iterator; using node_type = typename Tree::node_handle_type; // Constructors/assignments. btree_container() : tree_(key_compare(), allocator_type()) {} explicit btree_container(const key_compare &comp, const allocator_type &alloc = allocator_type()) : tree_(comp, alloc) {} explicit btree_container(const allocator_type &alloc) : tree_(key_compare(), alloc) {} btree_container(const btree_container &other) : btree_container(other, absl::allocator_traits:: select_on_container_copy_construction( other.get_allocator())) {} btree_container(const btree_container &other, const allocator_type &alloc) : tree_(other.tree_, alloc) {} btree_container(btree_container &&other) noexcept( std::is_nothrow_move_constructible::value) = default; btree_container(btree_container &&other, const allocator_type &alloc) : tree_(std::move(other.tree_), alloc) {} btree_container &operator=(const btree_container &other) = default; btree_container &operator=(btree_container &&other) noexcept( std::is_nothrow_move_assignable::value) = default; // Iterator routines. iterator begin() { return tree_.begin(); } const_iterator begin() const { return tree_.begin(); } const_iterator cbegin() const { return tree_.begin(); } iterator end() { return tree_.end(); } const_iterator end() const { return tree_.end(); } const_iterator cend() const { return tree_.end(); } reverse_iterator rbegin() { return tree_.rbegin(); } const_reverse_iterator rbegin() const { return tree_.rbegin(); } const_reverse_iterator crbegin() const { return tree_.rbegin(); } reverse_iterator rend() { return tree_.rend(); } const_reverse_iterator rend() const { return tree_.rend(); } const_reverse_iterator crend() const { return tree_.rend(); } // Lookup routines. template size_type count(const key_arg &key) const { auto equal_range = this->equal_range(key); return std::distance(equal_range.first, equal_range.second); } template iterator find(const key_arg &key) { return tree_.find(key); } template const_iterator find(const key_arg &key) const { return tree_.find(key); } template bool contains(const key_arg &key) const { return find(key) != end(); } template iterator lower_bound(const key_arg &key) { return tree_.lower_bound(key); } template const_iterator lower_bound(const key_arg &key) const { return tree_.lower_bound(key); } template iterator upper_bound(const key_arg &key) { return tree_.upper_bound(key); } template const_iterator upper_bound(const key_arg &key) const { return tree_.upper_bound(key); } template std::pair equal_range(const key_arg &key) { return tree_.equal_range(key); } template std::pair equal_range( const key_arg &key) const { return tree_.equal_range(key); } // Deletion routines. Note that there is also a deletion routine that is // specific to btree_set_container/btree_multiset_container. // Erase the specified iterator from the btree. The iterator must be valid // (i.e. not equal to end()). Return an iterator pointing to the node after // the one that was erased (or end() if none exists). iterator erase(const_iterator iter) { return tree_.erase(iterator(iter)); } iterator erase(iterator iter) { return tree_.erase(iter); } iterator erase(const_iterator first, const_iterator last) { return tree_.erase_range(iterator(first), iterator(last)).second; } template size_type erase(const key_arg &key) { auto equal_range = this->equal_range(key); return tree_.erase_range(equal_range.first, equal_range.second).first; } // Extract routines. node_type extract(iterator position) { // Use Move instead of Transfer, because the rebalancing code expects to // have a valid object to scribble metadata bits on top of. auto node = CommonAccess::Move(get_allocator(), position.slot()); erase(position); return node; } node_type extract(const_iterator position) { return extract(iterator(position)); } // Utility routines. ABSL_ATTRIBUTE_REINITIALIZES void clear() { tree_.clear(); } void swap(btree_container &other) { tree_.swap(other.tree_); } void verify() const { tree_.verify(); } // Size routines. size_type size() const { return tree_.size(); } size_type max_size() const { return tree_.max_size(); } bool empty() const { return tree_.empty(); } friend bool operator==(const btree_container &x, const btree_container &y) { if (x.size() != y.size()) return false; return std::equal(x.begin(), x.end(), y.begin()); } friend bool operator!=(const btree_container &x, const btree_container &y) { return !(x == y); } friend bool operator<(const btree_container &x, const btree_container &y) { return std::lexicographical_compare(x.begin(), x.end(), y.begin(), y.end()); } friend bool operator>(const btree_container &x, const btree_container &y) { return y < x; } friend bool operator<=(const btree_container &x, const btree_container &y) { return !(y < x); } friend bool operator>=(const btree_container &x, const btree_container &y) { return !(x < y); } // The allocator used by the btree. allocator_type get_allocator() const { return tree_.get_allocator(); } // The key comparator used by the btree. key_compare key_comp() const { return key_compare(tree_.key_comp()); } value_compare value_comp() const { return tree_.value_comp(); } // Support absl::Hash. template friend State AbslHashValue(State h, const btree_container &b) { for (const auto &v : b) { h = State::combine(std::move(h), v); } return State::combine(std::move(h), b.size()); } protected: friend struct btree_access; Tree tree_; }; // A common base class for btree_set and btree_map. template class btree_set_container : public btree_container { using super_type = btree_container; using params_type = typename Tree::params_type; using init_type = typename params_type::init_type; using is_key_compare_to = typename params_type::is_key_compare_to; friend class BtreeNodePeer; protected: template using key_arg = typename super_type::template key_arg; public: using key_type = typename Tree::key_type; using value_type = typename Tree::value_type; using size_type = typename Tree::size_type; using key_compare = typename Tree::original_key_compare; using allocator_type = typename Tree::allocator_type; using iterator = typename Tree::iterator; using const_iterator = typename Tree::const_iterator; using node_type = typename super_type::node_type; using insert_return_type = InsertReturnType; // Inherit constructors. using super_type::super_type; btree_set_container() {} // Range constructors. template btree_set_container(InputIterator b, InputIterator e, const key_compare &comp = key_compare(), const allocator_type &alloc = allocator_type()) : super_type(comp, alloc) { insert(b, e); } template btree_set_container(InputIterator b, InputIterator e, const allocator_type &alloc) : btree_set_container(b, e, key_compare(), alloc) {} // Initializer list constructors. btree_set_container(std::initializer_list init, const key_compare &comp = key_compare(), const allocator_type &alloc = allocator_type()) : btree_set_container(init.begin(), init.end(), comp, alloc) {} btree_set_container(std::initializer_list init, const allocator_type &alloc) : btree_set_container(init.begin(), init.end(), alloc) {} // Insertion routines. std::pair insert(const value_type &v) { return this->tree_.insert_unique(params_type::key(v), v); } std::pair insert(value_type &&v) { return this->tree_.insert_unique(params_type::key(v), std::move(v)); } template std::pair emplace(Args &&... args) { init_type v(std::forward(args)...); return this->tree_.insert_unique(params_type::key(v), std::move(v)); } iterator insert(const_iterator hint, const value_type &v) { return this->tree_ .insert_hint_unique(iterator(hint), params_type::key(v), v) .first; } iterator insert(const_iterator hint, value_type &&v) { return this->tree_ .insert_hint_unique(iterator(hint), params_type::key(v), std::move(v)) .first; } template iterator emplace_hint(const_iterator hint, Args &&... args) { init_type v(std::forward(args)...); return this->tree_ .insert_hint_unique(iterator(hint), params_type::key(v), std::move(v)) .first; } template void insert(InputIterator b, InputIterator e) { this->tree_.insert_iterator_unique(b, e, 0); } void insert(std::initializer_list init) { this->tree_.insert_iterator_unique(init.begin(), init.end(), 0); } insert_return_type insert(node_type &&node) { if (!node) return {this->end(), false, node_type()}; std::pair res = this->tree_.insert_unique(params_type::key(CommonAccess::GetSlot(node)), CommonAccess::GetSlot(node)); if (res.second) { CommonAccess::Destroy(&node); return {res.first, true, node_type()}; } else { return {res.first, false, std::move(node)}; } } iterator insert(const_iterator hint, node_type &&node) { if (!node) return this->end(); std::pair res = this->tree_.insert_hint_unique( iterator(hint), params_type::key(CommonAccess::GetSlot(node)), CommonAccess::GetSlot(node)); if (res.second) CommonAccess::Destroy(&node); return res.first; } // Node extraction routines. template node_type extract(const key_arg &key) { const std::pair lower_and_equal = this->tree_.lower_bound_equal(key); return lower_and_equal.second ? extract(lower_and_equal.first) : node_type(); } using super_type::extract; // Merge routines. // Moves elements from `src` into `this`. If the element already exists in // `this`, it is left unmodified in `src`. template < typename T, typename absl::enable_if_t< absl::conjunction< std::is_same, std::is_same, std::is_same>::value, int> = 0> void merge(btree_container &src) { // NOLINT for (auto src_it = src.begin(); src_it != src.end();) { if (insert(std::move(params_type::element(src_it.slot()))).second) { src_it = src.erase(src_it); } else { ++src_it; } } } template < typename T, typename absl::enable_if_t< absl::conjunction< std::is_same, std::is_same, std::is_same>::value, int> = 0> void merge(btree_container &&src) { merge(src); } }; // Base class for btree_map. template class btree_map_container : public btree_set_container { using super_type = btree_set_container; using params_type = typename Tree::params_type; friend class BtreeNodePeer; private: template using key_arg = typename super_type::template key_arg; public: using key_type = typename Tree::key_type; using mapped_type = typename params_type::mapped_type; using value_type = typename Tree::value_type; using key_compare = typename Tree::original_key_compare; using allocator_type = typename Tree::allocator_type; using iterator = typename Tree::iterator; using const_iterator = typename Tree::const_iterator; // Inherit constructors. using super_type::super_type; btree_map_container() {} // Insertion routines. // Note: the nullptr template arguments and extra `const M&` overloads allow // for supporting bitfield arguments. template std::pair insert_or_assign(const key_arg &k, const M &obj) { return insert_or_assign_impl(k, obj); } template std::pair insert_or_assign(key_arg &&k, const M &obj) { return insert_or_assign_impl(std::forward(k), obj); } template std::pair insert_or_assign(const key_arg &k, M &&obj) { return insert_or_assign_impl(k, std::forward(obj)); } template std::pair insert_or_assign(key_arg &&k, M &&obj) { return insert_or_assign_impl(std::forward(k), std::forward(obj)); } template iterator insert_or_assign(const_iterator hint, const key_arg &k, const M &obj) { return insert_or_assign_hint_impl(hint, k, obj); } template iterator insert_or_assign(const_iterator hint, key_arg &&k, const M &obj) { return insert_or_assign_hint_impl(hint, std::forward(k), obj); } template iterator insert_or_assign(const_iterator hint, const key_arg &k, M &&obj) { return insert_or_assign_hint_impl(hint, k, std::forward(obj)); } template iterator insert_or_assign(const_iterator hint, key_arg &&k, M &&obj) { return insert_or_assign_hint_impl(hint, std::forward(k), std::forward(obj)); } template ::value, int> = 0> std::pair try_emplace(const key_arg &k, Args &&... args) { return try_emplace_impl(k, std::forward(args)...); } template ::value, int> = 0> std::pair try_emplace(key_arg &&k, Args &&... args) { return try_emplace_impl(std::forward(k), std::forward(args)...); } template iterator try_emplace(const_iterator hint, const key_arg &k, Args &&... args) { return try_emplace_hint_impl(hint, k, std::forward(args)...); } template iterator try_emplace(const_iterator hint, key_arg &&k, Args &&... args) { return try_emplace_hint_impl(hint, std::forward(k), std::forward(args)...); } template mapped_type &operator[](const key_arg &k) { return try_emplace(k).first->second; } template mapped_type &operator[](key_arg &&k) { return try_emplace(std::forward(k)).first->second; } template mapped_type &at(const key_arg &key) { auto it = this->find(key); if (it == this->end()) base_internal::ThrowStdOutOfRange("absl::btree_map::at"); return it->second; } template const mapped_type &at(const key_arg &key) const { auto it = this->find(key); if (it == this->end()) base_internal::ThrowStdOutOfRange("absl::btree_map::at"); return it->second; } private: // Note: when we call `std::forward(obj)` twice, it's safe because // insert_unique/insert_hint_unique are guaranteed to not consume `obj` when // `ret.second` is false. template std::pair insert_or_assign_impl(K &&k, M &&obj) { const std::pair ret = this->tree_.insert_unique(k, std::forward(k), std::forward(obj)); if (!ret.second) ret.first->second = std::forward(obj); return ret; } template iterator insert_or_assign_hint_impl(const_iterator hint, K &&k, M &&obj) { const std::pair ret = this->tree_.insert_hint_unique( iterator(hint), k, std::forward(k), std::forward(obj)); if (!ret.second) ret.first->second = std::forward(obj); return ret.first; } template std::pair try_emplace_impl(K &&k, Args &&... args) { return this->tree_.insert_unique( k, std::piecewise_construct, std::forward_as_tuple(std::forward(k)), std::forward_as_tuple(std::forward(args)...)); } template iterator try_emplace_hint_impl(const_iterator hint, K &&k, Args &&... args) { return this->tree_ .insert_hint_unique(iterator(hint), k, std::piecewise_construct, std::forward_as_tuple(std::forward(k)), std::forward_as_tuple(std::forward(args)...)) .first; } }; // A common base class for btree_multiset and btree_multimap. template class btree_multiset_container : public btree_container { using super_type = btree_container; using params_type = typename Tree::params_type; using init_type = typename params_type::init_type; using is_key_compare_to = typename params_type::is_key_compare_to; template using key_arg = typename super_type::template key_arg; public: using key_type = typename Tree::key_type; using value_type = typename Tree::value_type; using size_type = typename Tree::size_type; using key_compare = typename Tree::original_key_compare; using allocator_type = typename Tree::allocator_type; using iterator = typename Tree::iterator; using const_iterator = typename Tree::const_iterator; using node_type = typename super_type::node_type; // Inherit constructors. using super_type::super_type; btree_multiset_container() {} // Range constructors. template btree_multiset_container(InputIterator b, InputIterator e, const key_compare &comp = key_compare(), const allocator_type &alloc = allocator_type()) : super_type(comp, alloc) { insert(b, e); } template btree_multiset_container(InputIterator b, InputIterator e, const allocator_type &alloc) : btree_multiset_container(b, e, key_compare(), alloc) {} // Initializer list constructors. btree_multiset_container(std::initializer_list init, const key_compare &comp = key_compare(), const allocator_type &alloc = allocator_type()) : btree_multiset_container(init.begin(), init.end(), comp, alloc) {} btree_multiset_container(std::initializer_list init, const allocator_type &alloc) : btree_multiset_container(init.begin(), init.end(), alloc) {} // Insertion routines. iterator insert(const value_type &v) { return this->tree_.insert_multi(v); } iterator insert(value_type &&v) { return this->tree_.insert_multi(std::move(v)); } iterator insert(const_iterator hint, const value_type &v) { return this->tree_.insert_hint_multi(iterator(hint), v); } iterator insert(const_iterator hint, value_type &&v) { return this->tree_.insert_hint_multi(iterator(hint), std::move(v)); } template void insert(InputIterator b, InputIterator e) { this->tree_.insert_iterator_multi(b, e); } void insert(std::initializer_list init) { this->tree_.insert_iterator_multi(init.begin(), init.end()); } template iterator emplace(Args &&... args) { return this->tree_.insert_multi(init_type(std::forward(args)...)); } template iterator emplace_hint(const_iterator hint, Args &&... args) { return this->tree_.insert_hint_multi( iterator(hint), init_type(std::forward(args)...)); } iterator insert(node_type &&node) { if (!node) return this->end(); iterator res = this->tree_.insert_multi(params_type::key(CommonAccess::GetSlot(node)), CommonAccess::GetSlot(node)); CommonAccess::Destroy(&node); return res; } iterator insert(const_iterator hint, node_type &&node) { if (!node) return this->end(); iterator res = this->tree_.insert_hint_multi( iterator(hint), std::move(params_type::element(CommonAccess::GetSlot(node)))); CommonAccess::Destroy(&node); return res; } // Node extraction routines. template node_type extract(const key_arg &key) { const std::pair lower_and_equal = this->tree_.lower_bound_equal(key); return lower_and_equal.second ? extract(lower_and_equal.first) : node_type(); } using super_type::extract; // Merge routines. // Moves all elements from `src` into `this`. template < typename T, typename absl::enable_if_t< absl::conjunction< std::is_same, std::is_same, std::is_same>::value, int> = 0> void merge(btree_container &src) { // NOLINT for (auto src_it = src.begin(), end = src.end(); src_it != end; ++src_it) { insert(std::move(params_type::element(src_it.slot()))); } src.clear(); } template < typename T, typename absl::enable_if_t< absl::conjunction< std::is_same, std::is_same, std::is_same>::value, int> = 0> void merge(btree_container &&src) { merge(src); } }; // A base class for btree_multimap. template class btree_multimap_container : public btree_multiset_container { using super_type = btree_multiset_container; using params_type = typename Tree::params_type; public: using mapped_type = typename params_type::mapped_type; // Inherit constructors. using super_type::super_type; btree_multimap_container() {} }; } // namespace container_internal ABSL_NAMESPACE_END } // namespace absl #endif // ABSL_CONTAINER_INTERNAL_BTREE_CONTAINER_H_