1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
/**
* 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 <immer/vector.hpp>
#include <immer/vector_transient.hpp>
#include "mongo/util/immutable/details/memory_policy.h"
namespace mongo::immutable {
/**
* Immutable vector.
*
* Interfaces that "modify" the vector are 'const' and return a new version of the vector with
* the modifications applied and leave the original version untouched.
*
* It is optimized for efficient copies and low memory usage when multiple versions of the vector
* exist simultaneously at the expense of regular lookups not being as efficient as the regular
* std::vector implementation. 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 vector are released.
*
* Multiple modifications can be done efficiently using the 'transient()' interface.
*
* Documentation: 'immer/vector.h' and https://sinusoid.es/immer/
*/
template <class T>
using vector = immer::vector<T, detail::MemoryPolicy>;
} // namespace mongo::immutable
|
