diff options
Diffstat (limited to 'src/mongo/util/immutable/set.h')
| -rw-r--r-- | src/mongo/util/immutable/set.h | 199 |
1 files changed, 0 insertions, 199 deletions
diff --git a/src/mongo/util/immutable/set.h b/src/mongo/util/immutable/set.h deleted file mode 100644 index 24e5183c34f..00000000000 --- a/src/mongo/util/immutable/set.h +++ /dev/null @@ -1,199 +0,0 @@ -/** - * Copyright (C) 2023-present MongoDB, Inc. - * - * This program is free software: you can redistribute it and/or modify - * it under the terms of the Server Side Public License, version 1, - * as published by MongoDB, Inc. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * Server Side Public License for more details. - * - * You should have received a copy of the Server Side Public License - * along with this program. If not, see - * <http://www.mongodb.com/licensing/server-side-public-license>. - * - * As a special exception, the copyright holders give permission to link the - * code of portions of this program with the OpenSSL library under certain - * conditions as described in each individual source file and distribute - * linked combinations including the program with the OpenSSL library. You - * must comply with the Server Side Public License in all respects for - * all of the code used other than as permitted herein. If you modify file(s) - * with this exception, you may extend this exception to your version of the - * file(s), but you are not obligated to do so. If you do not wish to do so, - * delete this exception statement from your version. If you delete this - * exception statement from all source files in the program, then also delete - * it in the license file. - */ - -#pragma once - -#include <algorithm> - -#include <immer/flex_vector.hpp> - -#include "mongo/util/immutable/details/memory_policy.h" -#include "mongo/util/immutable/details/set.h" - -namespace mongo::immutable { - -/** - * Immutable ordered set. - * - * Interfaces that "modify" the set are 'const' and return a new version of the set with the - * modifications applied and leaves the original version untouched. - * - * It is optimized for efficient copies and low memory usage when multiple versions of the set exist - * simultaneously at the expense of regular lookups not being as efficient as the regular std - * ordered containers. Suitable for use in code that uses the copy-on-write pattern. - * - * Thread-safety: All methods are const, it is safe to perform modifications that result in new - * versions from multiple threads concurrently. - * - * Memory management: Internal memory management is done using reference counting, memory is free'd - * as references to different versions of the set are released. - * - * Built on top of 'immer::flex_vector'. - * Documentation: 'immer/flex_vector.h' and https://sinusoid.es/immer/ - */ -template <typename Key, typename Compare = std::less<Key>> -class set { -public: - using key_type = Key; - using storage_type = immer::flex_vector<key_type, detail::MemoryPolicy>; - using iterator = typename storage_type::iterator; - using size_type = typename storage_type::size_type; - using diference_type = std::ptrdiff_t; - using reference = const key_type&; - using const_reference = const key_type&; - using memory_policy_type = detail::MemoryPolicy; - using comp = Compare; - - set() = default; - - bool operator==(const set& other) const { - return _storage == other._storage; - } - - bool operator!=(const set& other) const { - return !(*this == other); - } - - [[nodiscard]] iterator begin() const { - return _storage.begin(); - } - - [[nodiscard]] iterator end() const { - return _storage.end(); - } - - size_t size() const { - return _storage.size(); - } - - /** - * Insert a new 'key' to the set. - * - * Returns the modified set, or the original if 'key' was already contained. - */ - template <typename K> - [[nodiscard]] set insert(K&& key) const& { - return set{details::set::insert<set>(_storage, std::forward<K>(key))}; - } - template <typename K> - [[nodiscard]] set insert(K&& key) && { - return set{details::set::insert<set>(std::move(_storage), std::forward<K>(key))}; - } - - /** - * Insert a new 'key' to the set. Uses 'it' as a hint. - * - * Returns the modified set, or the original if 'key' was already contained. - */ - template <typename K> - [[nodiscard]] set insert(iterator it, K&& key) const& { - return set{details::set::insert<set>(_storage, it, std::forward<K>(key))}; - } - template <typename K> - [[nodiscard]] set insert(iterator it, K&& key) && { - return set{details::set::insert<set>(std::move(_storage), it, std::forward<K>(key))}; - } - - /** - * Removes 'key' from the set. - * - * Returns the modified set, or the original if 'key' does not exist. - */ - template <typename K> - [[nodiscard]] set erase(K&& key) const& { - return set{details::set::erase<set>(_storage, std::forward<K>(key))}; - } - template <typename K> - [[nodiscard]] set erase(K&& key) && { - return set{details::set::erase<set>(std::move(_storage), std::forward<K>(key))}; - } - - /** - * Removes key associated with 'key' from the set. Uses 'it' as a hint. - * - * Returns the modified set, or the original if 'key' does not exist. - */ - template <typename K> - [[nodiscard]] set erase(iterator it, K&& key) const& { - return set{details::set::erase<set>(_storage, it, std::forward<K>(key))}; - } - template <typename K> - [[nodiscard]] set erase(iterator it, K&& key) && { - return set{details::set::erase<set>(std::move(_storage), it, std::forward<K>(key))}; - } - - /** - * Returns an iterator to the element for 'key' if it exists, 'end()' otherwise. - * - * Supports heterogeneous lookup. - */ - template <class SearchKey> - [[nodiscard]] iterator find(const SearchKey& key) const { - return details::set::find<set>(_storage, key); - } - - /** - * Returns true if set contains 'key'. - * - * Supports heterogeneous lookup. - */ - template <class SearchKey> - bool contains(const SearchKey& key) const { - return find(key) != end(); - } - - /** - * Returns the first the element greater than or equal to 'key' if one exists, 'end()' - * otherwise. - * - * Supports heterogeneous lookup. - */ - template <class SearchKey> - [[nodiscard]] iterator lower_bound(const SearchKey& key) const { - return details::set::lower_bound<set>(_storage, key); - } - - /** - * Returns the first the element strictly greater than 'key' if one exists, 'end()' otherwise. - * - * Supports heterogeneous lookup. - */ - template <class SearchKey> - [[nodiscard]] iterator upper_bound(const SearchKey& key) const { - return std::upper_bound(_storage.begin(), _storage.end(), key, comp{}); - } - -private: - template <typename S> - explicit set(S&& s) : _storage{std::forward<S>(s)} {} - - storage_type _storage; -}; - -} // namespace mongo::immutable |