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
|
/**
* Copyright (C) 2016 MongoDB Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License, version 3,
* as published by the Free Software Foundation.
*
* 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
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
* 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 GNU Affero General 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 "mongo/bson/bson_comparator_interface_base.h"
#include "mongo/bson/bsonobj.h"
namespace mongo {
/**
* A BSONObj::ComparatorInterface is an abstract class for comparing BSONObj objects. Usage for
* comparing two BSON objects, 'lhs' and 'rhs', where 'comparator' is an instance of a class
* implementing this interface, is as shown below:
*
* bool lessThan = comparator.evaluate(lhs < rhs);
* bool lessThanOrEqual = comparator.evaluate(lhs <= rhs);
* bool equal = comparator.evaluate(lhs == rhs);
* bool greaterThanOrEqual = comparator.evaluate(lhs >= rhs);
* bool greaterThan = comparator.evaluate(lhs > rhs);
* bool notEqual = comparator.evaluate(lhs != rhs);
*
* Can also be used to obtain function objects compatible for use with standard library algorithms
* such as std::sort, and to construct STL sets and maps which respect this comparator.
*
* All methods are thread-safe.
*/
class BSONObj::ComparatorInterface : public BSONComparatorInterfaceBase<BSONObj> {
public:
/**
* Constructs a BSONObjSet whose equivalence classes are given by this comparator. This
* comparator must outlive the returned set.
*/
Set makeBSONObjSet(std::initializer_list<BSONObj> init = {}) const {
return makeSet(init);
}
/**
* Constructs a BSONObjUnorderedSet whose equivalence classes are given by this
* comparator. This comparator must outlive the returned set.
*/
UnorderedSet makeBSONObjUnorderedSet(std::initializer_list<BSONObj> init = {}) const {
return makeUnorderedSet(init);
}
/**
* Constructs an ordered map from BSONObj to type ValueType whose ordering is given by this
* comparator. This comparator must outlive the returned map.
*/
template <typename ValueType>
Map<ValueType> makeBSONObjIndexedMap(
std::initializer_list<std::pair<const BSONObj, ValueType>> init = {}) const {
return makeMap(init);
}
/**
* Constructs an unordered map from BSONObj to type ValueType whose ordering is given by this
* comparator. This comparator must outlive the returned map.
*/
template <typename ValueType>
UnorderedMap<ValueType> makeBSONObjIndexedUnorderedMap(
std::initializer_list<std::pair<const BSONObj, ValueType>> init = {}) const {
return makeUnorderedMap(init);
}
};
using BSONObjSet = BSONComparatorInterfaceBase<BSONObj>::Set;
using BSONObjUnorderedSet = BSONComparatorInterfaceBase<BSONObj>::UnorderedSet;
template <typename ValueType>
using BSONObjIndexedMap = BSONComparatorInterfaceBase<BSONObj>::Map<ValueType>;
template <typename ValueType>
using BSONObjIndexedUnorderedMap = BSONComparatorInterfaceBase<BSONObj>::UnorderedMap<ValueType>;
} // namespace mongo
|
