aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/common/bitvectoriterator.cpp
blob: e510102ba72569e1d40c239f36fb650dba486d5b (plain) (blame)
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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "bitvectoriterator.h"
#include <vespa/searchlib/queryeval/emptysearch.h>
#include <vespa/searchlib/fef/termfieldmatchdataarray.h>
#include <vespa/vespalib/objects/visit.h>
#include <cassert>

namespace search {

using fef::TermFieldMatchDataArray;
using fef::TermFieldMatchData;
using vespalib::Trinary;

BitVectorIterator::BitVectorIterator(const BitVector & bv, uint32_t docIdLimit, TermFieldMatchData & matchData) :
    _docIdLimit(std::min(docIdLimit, bv.size())),
    _bv(bv),
    _tfmd(matchData)
{
    assert(docIdLimit <= bv.size());
    _tfmd.reset(0);
}

void
BitVectorIterator::initRange(uint32_t begin, uint32_t end)
{
    SearchIterator::initRange(begin, end);
    if (begin >= _docIdLimit) {
        setAtEnd();
    }
}

void
BitVectorIterator::visitMembers(vespalib::ObjectVisitor &visitor) const
{
    SearchIterator::visitMembers(visitor);
    visit(visitor, "docIdLimit", _docIdLimit);
    visit(visitor, "termfieldmatchdata.fieldId", _tfmd.getFieldId());
    visit(visitor, "termfieldmatchdata.docid", _tfmd.getDocId());
}

template<bool inverse>
class BitVectorIteratorT : public BitVectorIterator {
public:
    BitVectorIteratorT(const BitVector &other, uint32_t docIdLimit, fef::TermFieldMatchData &matchData);

    void doSeek(uint32_t docId) override;
    BitVector::UP get_hits(uint32_t begin_id) override;
    void or_hits_into(BitVector &result, uint32_t begin_id) override;
    void and_hits_into(BitVector &result, uint32_t begin_id) override;
    bool isInverted() const override { return inverse; }
private:
    bool isSet(uint32_t docId) const noexcept { return inverse == ! _bv.testBit(docId); }
};

template<bool inverse>
BitVectorIteratorT<inverse>::BitVectorIteratorT(const BitVector & bv, uint32_t docIdLimit, TermFieldMatchData & matchData) :
    BitVectorIterator(bv, docIdLimit, matchData)
{
}

template<bool inverse>
void
BitVectorIteratorT<inverse>::doSeek(uint32_t docId)
{
    if (__builtin_expect(docId >= _docIdLimit, false)) {
        setAtEnd();
    } else if (isSet(docId)) {
        setDocId(docId);
    }
}

template<bool inverse>
class BitVectorIteratorStrictT : public BitVectorIteratorT<inverse>
{
public:
    BitVectorIteratorStrictT(const BitVector & bv, uint32_t docIdLimit, TermFieldMatchData & matchData);
private:
    void initRange(uint32_t begin, uint32_t end) override;
    void doSeek(uint32_t docId) override;
    Trinary is_strict() const override { return Trinary::True; }
    uint32_t getNextBit(uint32_t docId) const noexcept {
        return inverse ? this->_bv.getNextFalseBit(docId) : this->_bv.getNextTrueBit(docId);
    }
    uint32_t getFirstBit(uint32_t docId) const noexcept {
        return inverse ? this->_bv.getFirstFalseBit(docId) : this->_bv.getFirstTrueBit(docId);
    }
};

template<bool inverse>
BitVectorIteratorStrictT<inverse>::BitVectorIteratorStrictT(const BitVector & bv, uint32_t docIdLimit, TermFieldMatchData & matchData) :
    BitVectorIteratorT<inverse>(bv, docIdLimit, matchData)
{
}

template<bool inverse>
void
BitVectorIteratorStrictT<inverse>::doSeek(uint32_t docId)
{
    if (__builtin_expect(docId >= this->_docIdLimit, false)) {
        this->setAtEnd();
        return;
    }
    
    docId = getNextBit(docId);
    if (__builtin_expect(docId >= this->_docIdLimit, false)) {
        this->setAtEnd();
    } else {
        this->setDocId(docId);
    }
}

template<bool inverse>
void
BitVectorIteratorStrictT<inverse>::initRange(uint32_t begin, uint32_t end)
{
    BitVectorIterator::initRange(begin, end);
    if (!this->isAtEnd()) {
        uint32_t docId = getFirstBit(begin);
        if (docId >= this->_docIdLimit) {
            this->setAtEnd();
        } else {
            this->setDocId(docId);
        }
    }
}

queryeval::SearchIterator::UP
BitVectorIterator::create(const BitVector *const bv, TermFieldMatchData &matchData, bool strict, bool inverted)
{
    return create(bv, bv->size(), matchData, strict, inverted);
}

queryeval::SearchIterator::UP
BitVectorIterator::create(const BitVector *const bv, uint32_t docIdLimit,
                          TermFieldMatchData &matchData, bool strict, bool inverted)
{
    if (bv == nullptr) {
        return std::make_unique<queryeval::EmptySearch>();
    } else if (strict) {
        if (inverted) {
            return std::make_unique<BitVectorIteratorStrictT<true>>(*bv, docIdLimit, matchData);
        } else {
            return std::make_unique<BitVectorIteratorStrictT<false>>(*bv, docIdLimit, matchData);
        }
    } else {
        if (inverted) {
            return std::make_unique<BitVectorIteratorT<true>>(*bv, docIdLimit, matchData);
        } else {
            return std::make_unique<BitVectorIteratorT<false>>(*bv, docIdLimit, matchData);
        }
    }
}

template<bool inverse>
BitVector::UP
BitVectorIteratorT<inverse>::get_hits(uint32_t begin_id) {
    BitVector::UP result = BitVector::create(_bv, begin_id, getEndId());
    if (inverse) {
        result->notSelf();
    }
    if (begin_id < getDocId()) {
        result->clearInterval(begin_id, getDocId());
    }
    return result;
}

template<bool inverse>
void
BitVectorIteratorT<inverse>::or_hits_into(BitVector &result, uint32_t) {
    if (inverse) {
        result.notSelf();
        result.andWith(_bv);
        result.notSelf();
    } else {
        result.orWith(_bv);
    }
}

template<bool inverse>
void
BitVectorIteratorT<inverse>::and_hits_into(BitVector &result, uint32_t) {
    if (inverse) {
        result.andNotWith(_bv);
    } else {
        result.andWith(_bv);
    }
}

} // namespace search