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
|
/**
* 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 <cstddef>
#include <sys/types.h>
#include "mongo/db/query/optimizer/cascades/interfaces.h"
namespace mongo {
namespace optimizer {
namespace cascades {
// Forward declaration.
class CEInterface;
} // namespace cascades
} // namespace optimizer
namespace ce {
// Enable this flag to log all estimates, and let all tests pass.
//#define CE_TEST_LOG_MODE 1
const double kMaxCEError = 0.01;
/**
* Helpful macros for asserting that the CE of a $match predicate is approximately what we were
* expecting.
*/
#ifndef CE_TEST_LOG_MODE
#define ASSERT_MATCH_CE(ce, predicate, expectedCE) \
ASSERT_APPROX_EQUAL(expectedCE, ce.getCE(predicate), kMaxCEError)
#else
#define ASSERT_MATCH_CE(ce, predicate, expectedCE) \
ce.getCE(predicate); \
ASSERT_APPROX_EQUAL(1.0, 1.0, kMaxCEError)
#endif
#ifndef CE_TEST_LOG_MODE
#define ASSERT_MATCH_CE_CARD(ce, predicate, expectedCE, collCard) \
ce.setCollCard(collCard); \
ASSERT_APPROX_EQUAL(expectedCE, ce.getCE(predicate), kMaxCEError)
#else
#define ASSERT_MATCH_CE_CARD(ce, predicate, expectedCE, collCard) \
ce.setCollCard(collCard); \
ce.getCE(predicate); \
ASSERT_APPROX_EQUAL(1.0, 1.0, kMaxCEError)
#endif
/**
* A test utility class for helping verify the cardinality of CE transports on a given $match
* predicate.
*/
class CETester {
public:
CETester(std::string collName, double numRecords);
/**
* Returns the estimated cardinality of a given 'matchPredicate'.
*/
double getCE(const std::string& matchPredicate, size_t optimizationLevel = 1) const;
void setCollCard(double card) {
_collCard = card;
}
protected:
/**
* Subclasses need to override this method to initialize the transports they are testing.
*/
virtual std::unique_ptr<optimizer::cascades::CEInterface> getCETransport() const = 0;
std::string _collName;
// The number of records in the collection we are testing.
double _collCard;
};
} // namespace ce
} // namespace mongo
|
