summaryrefslogtreecommitdiff
path: root/src/mongo/db/exec/2dnear.h
blob: 9ac7eae3a7ae6388a8bf12a2cff351a5cfc6f12f (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
/**
 *    Copyright (C) 2013 10gen 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 <queue>

#include "mongo/db/diskloc.h"
#include "mongo/db/exec/2dcommon.h"
#include "mongo/db/exec/plan_stage.h"
#include "mongo/db/geo/geoquery.h"
#include "mongo/db/jsobj.h"
#include "mongo/db/matcher/expression.h"

namespace mongo {

    struct TwoDNearParams {
        NearQuery nearQuery;
        Collection* collection; // not owned
        BSONObj indexKeyPattern;
        MatchExpression* filter;
        int numWanted;
        bool addPointMeta;
        bool addDistMeta;
    };

    struct Result {
        Result(WorkingSetID wsid, double dist) : id(wsid), distance(dist) { }

        bool operator<(const Result& other) const {
            // We want increasing distance, not decreasing, so we reverse the <.
            return distance > other.distance;
        }

        WorkingSetID id;

        double distance;
    };

    class TwoDNear : public PlanStage {
    public:
        TwoDNear(const TwoDNearParams& params, WorkingSet* ws);
        virtual ~TwoDNear();

        virtual bool isEOF();
        virtual StageState work(WorkingSetID* out);

        virtual void prepareToYield();
        virtual void recoverFromYield();
        virtual void invalidate(const DiskLoc& dl, InvalidationType type);

        virtual PlanStageStats* getStats();

        static const char* kStageType;

    private:
        WorkingSet* _workingSet;

        // Stats
        CommonStats _commonStats;
        TwoDNearStats _specificStats;

        // We compute an annulus of results and cache it here.
        priority_queue<Result> _results;

        // For fast invalidation.  Perhaps not worth it.
        //
        // Multi-location docs mean that this is not one diskloc -> one WSID but one DiskLoc -> many
        // WSIDs.
        multimap<DiskLoc, WorkingSetID> _invalidationMap;

        TwoDNearParams _params;

        bool _initted;
    };

}  // namespace mongo

namespace mongo {
namespace twod_exec {

    class GeoHopper : public GeoBrowse {
    public:
        typedef multiset<GeoPoint> Holder;

        GeoHopper(Collection* collection,
                  TwoDAccessMethod* accessMethod,
                  unsigned max,
                  const Point& n,
                  MatchExpression* filter,
                  double maxDistance = numeric_limits<double>::max(),
                  GeoDistType type = GEO_PLANE);

        virtual KeyResult approxKeyCheck(const Point& p, double& d);

        virtual bool exactDocCheck(const Point& p, double& d);

        // Always in distance units, whether radians or normal
        double farthest() const { return _farthest; }

        virtual int addSpecific(const GeoIndexEntry& node, const Point& keyP, bool onBounds,
                                double keyD, bool potentiallyNewDoc);

        // Removes extra points from end of _points set.
        // Check can be a bit costly if we have lots of exact points near borders,
        // so we'll do this every once and awhile.
        void processExtraPoints();

        unsigned _max;
        Point _near;
        Holder _points;
        double _maxDistance;
        GeoDistType _type;
        double _distError;
        double _farthest;

        // Safe to use currently since we don't yield in $near searches.  If we do start to yield,
        // we may need to replace dirtied disklocs in our holder / ensure our logic is correct.
        std::map<DiskLoc, Holder::iterator> _seenPts;

    private:
        const Collection* _collection;
    };

    class GeoSearch : public GeoHopper {
    public:
        GeoSearch(Collection* collection,
                  TwoDAccessMethod* accessMethod,
                  const Point& startPt,
                  int numWanted = 100,
                  MatchExpression* filter = NULL,
                  double maxDistance = numeric_limits<double>::max(),
                  GeoDistType type = GEO_PLANE);

        void exec();

        void addExactPoints(const GeoPoint& pt, Holder& points, bool force);

        void addExactPoints(const GeoPoint& pt, Holder& points, int& before, int& after,
                            bool force);

        // TODO: Refactor this back into holder class, allow to run periodically when we are seeing
        // a lot of pts
        void expandEndPoints(bool finish = true);

        virtual GeoHash expandStartHash() { return _start; }

        // Whether the current box width is big enough for our search area
        virtual bool fitsInBox(double width) { return width >= _scanDistance; }

        // Whether the current box overlaps our search area
        virtual double intersectsBox(Box& cur) { return cur.legacyIntersectFraction(_want); }

        std::set< std::pair<DiskLoc,int> > _seen;
        GeoHash _start;
        int _numWanted;
        double _scanDistance;
        long long _nscanned;
        int _found;
        GeoDistType _type;
        Box _want;
        TwoDIndexingParams& _params;
    };

}  // namespace twod_exec
}  // namespace mongo