summaryrefslogtreecommitdiff
path: root/src/mongo/util/pair_map.h
blob: 6271fb9ae6d97839949a996ac0d56554f0756b5e (plain)
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/**
 *    Copyright (C) 2022-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 <absl/container/flat_hash_map.h>
#include <absl/container/flat_hash_set.h>

#include "mongo/base/string_data.h"
#include "mongo/util/assert_util.h"

namespace mongo {

template <typename T>
class PairMapTraits {
public:
    using OwnedType = T;
    using ViewType = T;
    using HashableType = T;

    static const T& toOwned(const T& t) {
        return t;
    }
    static const T& toView(const T& t) {
        return t;
    }
    static const T& toHashable(const T& t) {
        return t;
    }
};

template <>
class PairMapTraits<StringData> {
public:
    using OwnedType = std::string;
    using ViewType = StringData;
    using HashableType = absl::string_view;

    static std::string toOwned(const StringData& t) {
        return t.toString();
    }
    static const StringData& toView(const StringData& t) {
        return t;
    }
    static absl::string_view toHashable(const StringData& t) {
        // Use the default absl string hasher.
        return absl::string_view(t.rawData(), t.size());
    }
};

template <>
class PairMapTraits<std::string> {
public:
    using OwnedType = std::string;
    using ViewType = StringData;
    using HashableType = absl::string_view;

    static const std::string& toOwned(const std::string& t) {
        return t;
    }
    static StringData toView(const std::string& t) {
        return StringData(t);
    }
    static absl::string_view toHashable(const std::string& t) {
        // Use the default absl string hasher.
        return absl::string_view(t.data(), t.size());
    }
};

/**
 * Type that bundles a hashed key with the actual pair value so that hashing can be performed
 * outside of insert() call. This is needed to facilitate heterogeneous lookup.
 */
template <typename T1, typename T2>
class PairMapHashedKey {
public:
    using OwnedType1 = typename PairMapTraits<T1>::OwnedType;
    using OwnedType2 = typename PairMapTraits<T2>::OwnedType;
    using OwnedPairType = std::pair<OwnedType1, OwnedType2>;
    using ViewType1 = typename PairMapTraits<T1>::ViewType;
    using ViewType2 = typename PairMapTraits<T2>::ViewType;
    using ViewPairType = std::pair<ViewType1, ViewType2>;

    explicit PairMapHashedKey(ViewPairType key, std::size_t hash)
        : _key(std::move(key)), _hash(hash) {}

    explicit operator OwnedPairType() const {
        return {PairMapTraits<ViewType1>::toOwned(_key.first),
                PairMapTraits<ViewType2>::toOwned(_key.second)};
    }

    const ViewPairType& key() const {
        return _key;
    }

    std::size_t hash() const {
        return _hash;
    }

private:
    ViewPairType _key;
    std::size_t _hash;
};

/**
 * Hasher to support heterogeneous lookup.
 */
template <typename T1, typename T2>
class PairMapHasher {
public:
    using OwnedType1 = typename PairMapTraits<T1>::OwnedType;
    using OwnedType2 = typename PairMapTraits<T2>::OwnedType;
    using OwnedPairType = std::pair<OwnedType1, OwnedType2>;
    using ViewType1 = typename PairMapTraits<T1>::ViewType;
    using ViewType2 = typename PairMapTraits<T2>::ViewType;
    using ViewPairType = std::pair<ViewType1, ViewType2>;
    using HashableType1 = typename PairMapTraits<T1>::HashableType;
    using HashableType2 = typename PairMapTraits<T2>::HashableType;
    using HashablePairType = std::pair<HashableType1, HashableType2>;

    // This using directive activates heterogeneous lookup in the hash table.
    using is_transparent = void;

    std::size_t operator()(const ViewPairType& sd) const {
        return absl::Hash<HashablePairType>{}(
            std::make_pair(PairMapTraits<ViewType1>::toHashable(sd.first),
                           PairMapTraits<ViewType2>::toHashable(sd.second)));
    }

    std::size_t operator()(const OwnedPairType& s) const {
        return operator()(std::make_pair(PairMapTraits<OwnedType1>::toView(s.first),
                                         PairMapTraits<OwnedType2>::toView(s.second)));
    }

    std::size_t operator()(const PairMapHashedKey<T1, T2>& key) const {
        return key.hash();
    }

    PairMapHashedKey<T1, T2> hashed_key(const ViewPairType& sd) const {
        return PairMapHashedKey<T1, T2>(sd, operator()(sd));
    }
};

template <typename T1, typename T2>
class PairMapEq {
public:
    using ViewType1 = typename PairMapTraits<T1>::ViewType;
    using ViewType2 = typename PairMapTraits<T2>::ViewType;
    using ViewPairType = std::pair<ViewType1, ViewType2>;

    // This using directive activates heterogeneous lookup in the hash table.
    using is_transparent = void;

    bool operator()(const ViewPairType& lhs, const ViewPairType& rhs) const {
        return lhs == rhs;
    }

    bool operator()(const PairMapHashedKey<T1, T2>& lhs, const ViewPairType& rhs) const {
        return lhs.key() == rhs;
    }

    bool operator()(const ViewPairType& lhs, const PairMapHashedKey<T1, T2>& rhs) const {
        return lhs == rhs.key();
    }

    bool operator()(const PairMapHashedKey<T1, T2>& lhs,
                    const PairMapHashedKey<T1, T2>& rhs) const {
        return lhs.key() == rhs.key();
    }
};

template <typename K1, typename K2, typename V>
using PairMap = absl::flat_hash_map<std::pair<K1, K2>, V, PairMapHasher<K1, K2>, PairMapEq<K1, K2>>;

template <typename K1, typename K2>
using PairSet = absl::flat_hash_set<std::pair<K1, K2>, PairMapHasher<K1, K2>, PairMapEq<K1, K2>>;

}  // namespace mongo