aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/attribute/attribute_weighted_set_blueprint.cpp
blob: ce9163bbddbea83088844c877273db225ea85f76 (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
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "attribute_weighted_set_blueprint.h"
#include "multi_term_hash_filter.hpp"
#include <vespa/searchcommon/attribute/i_search_context.h>
#include <vespa/searchlib/common/bitvector.h>
#include <vespa/searchlib/fef/matchdatalayout.h>
#include <vespa/searchlib/query/query_term_ucs4.h>
#include <vespa/searchlib/queryeval/filter_wrapper.h>
#include <vespa/searchlib/queryeval/orsearch.h>
#include <vespa/searchlib/queryeval/flow.h>
#include <vespa/searchlib/queryeval/flow_tuning.h>
#include <vespa/searchlib/queryeval/weighted_set_term_search.h>
#include <vespa/vespalib/objects/visit.h>
#include <vespa/vespalib/stllike/hash_map.hpp>
#include <vespa/vespalib/util/stringfmt.h>


namespace search {

namespace {

using attribute::ISearchContext;
using attribute::IAttributeVector;
using queryeval::OrFlow;

class AttrWrapper
{
private:
    const attribute::IAttributeVector &_attr;

protected:
    const attribute::IAttributeVector &attribute() const { return _attr; }

public:
    explicit AttrWrapper(const attribute::IAttributeVector & attr)
        : _attr(attr) {}
};

class StringEnumWrapper : public AttrWrapper
{
public:
    using TokenT = uint32_t;
    static constexpr bool unpack_weights = true;
    explicit StringEnumWrapper(const IAttributeVector & attr)
        : AttrWrapper(attr) {}
    auto mapToken(const ISearchContext &context) const {
        return attribute().findFoldedEnums(context.queryTerm()->getTerm());
    }
    TokenT getToken(uint32_t docId) const {
        return attribute().getEnum(docId);
    }
};

class IntegerWrapper : public AttrWrapper
{
public:
    using TokenT = uint64_t;
    static constexpr bool unpack_weights = true;
    explicit IntegerWrapper(const IAttributeVector & attr) : AttrWrapper(attr) {}
    std::vector<int64_t> mapToken(const ISearchContext &context) const {
        std::vector<int64_t> result;
        Int64Range range(context.getAsIntegerTerm());
        if (range.isPoint()) {
            result.push_back(range.lower());
        }
        return result;
    }
    TokenT getToken(uint32_t docId) const {
        return attribute().getInt(docId);
    }
};

template <typename WrapperType>
std::unique_ptr<queryeval::SearchIterator>
make_multi_term_filter(fef::TermFieldMatchData& tfmd,
                       const IAttributeVector& attr,
                       const std::vector<int32_t>& weights,
                       const std::vector<ISearchContext*>& contexts)
{
    using FilterType = attribute::MultiTermHashFilter<WrapperType>;
    typename FilterType::TokenMap tokens;
    WrapperType wrapper(attr);
    for (size_t i = 0; i < contexts.size(); ++i) {
        for (auto token : wrapper.mapToken(*contexts[i])) {
            tokens[token] = weights[i];
        }
    }
    return std::make_unique<FilterType>(tfmd, wrapper, std::move(tokens));
}

}

AttributeWeightedSetBlueprint::AttributeWeightedSetBlueprint(const queryeval::FieldSpec &field, const IAttributeVector & attr)
    : queryeval::ComplexLeafBlueprint(field),
      _numDocs(attr.getNumDocs()),
      _estHits(0),
      _weights(),
      _attr(attr),
      _contexts(),
      _estimates()
{
    set_allow_termwise_eval(true);
}

AttributeWeightedSetBlueprint::~AttributeWeightedSetBlueprint()
{
    while (!_contexts.empty()) {
        delete _contexts.back();
        _contexts.pop_back();
    }
}

void
AttributeWeightedSetBlueprint::addToken(std::unique_ptr<ISearchContext> context, int32_t weight)
{
    _estimates.push_back(context->calc_hit_estimate());
    _estHits = std::min(_estHits + _estimates.back().est_hits(), _numDocs);
    setEstimate(HitEstimate(_estHits, (_estHits == 0)));
    _weights.push_back(weight);
    _contexts.push_back(context.release());
}

void
AttributeWeightedSetBlueprint::sort(queryeval::InFlow in_flow)
{
    strict(in_flow.strict());
}

queryeval::FlowStats
AttributeWeightedSetBlueprint::calculate_flow_stats(uint32_t docid_limit) const
{
    struct MyAdapter {
        uint32_t docid_limit;
        MyAdapter(uint32_t docid_limit_in) noexcept : docid_limit(docid_limit_in) {}
        double estimate(const AttrHitEstimate &est) const noexcept {
            return est.is_unknown() ? 0.5 : abs_to_rel_est(est.est_hits(), docid_limit);
        }
        double cost(const AttrHitEstimate &) const noexcept { return 1.0; }
        double strict_cost(const AttrHitEstimate &est) const noexcept {
            return est.is_unknown() ? 1.0 : abs_to_rel_est(est.est_hits(), docid_limit);
        }
    };
    double est = OrFlow::estimate_of(MyAdapter(docid_limit), _estimates);
    return {est, OrFlow::cost_of(MyAdapter(docid_limit), _estimates, false),
            OrFlow::cost_of(MyAdapter(docid_limit), _estimates, true) + queryeval::flow::heap_cost(est, _estimates.size())};
}

queryeval::SearchIterator::UP
AttributeWeightedSetBlueprint::createLeafSearch(const fef::TermFieldMatchDataArray &tfmda) const
{
    assert(tfmda.size() == 1);
    assert(getState().numFields() == 1);
    fef::TermFieldMatchData &tfmd = *tfmda[0];
    bool field_is_filter = getState().fields()[0].isFilter();
    if ((tfmd.isNotNeeded() || field_is_filter) && (_contexts.size() == 1)) {
        return _contexts[0]->createIterator(&tfmd, strict());
    }
    if (strict()) { // use generic weighted set search
        fef::MatchDataLayout layout;
        auto handle = layout.allocTermField(tfmd.getFieldId());
        auto match_data = layout.createMatchData();
        auto child_tfmd = match_data->resolveTermField(handle);
        std::vector<queryeval::SearchIterator*> children(_contexts.size());
        for (size_t i = 0; i < _contexts.size(); ++i) {
            // TODO: pass ownership with unique_ptr
            children[i] = _contexts[i]->createIterator(child_tfmd, true).release();
        }
        return queryeval::WeightedSetTermSearch::create(children, tfmd, field_is_filter, _weights, std::move(match_data));
    } else { // use attribute filter optimization
        bool isString = (_attr.isStringType() && _attr.hasEnum());
        assert(!_attr.hasMultiValue());
        if (isString) {
            return make_multi_term_filter<StringEnumWrapper>(tfmd, _attr, _weights, _contexts);
        } else {
            assert(_attr.isIntegerType());
            return make_multi_term_filter<IntegerWrapper>(tfmd, _attr, _weights, _contexts);
        }
    }
}

queryeval::SearchIterator::UP
AttributeWeightedSetBlueprint::createFilterSearch(FilterConstraint) const
{
    std::vector<std::unique_ptr<queryeval::SearchIterator>> children;
    children.reserve(_contexts.size());
    for (auto& context : _contexts) {
        auto wrapper = std::make_unique<queryeval::FilterWrapper>(1);
        wrapper->wrap(context->createIterator(wrapper->tfmda()[0], strict()));
        children.emplace_back(std::move(wrapper));
    }
    return queryeval::OrSearch::create(std::move(children), strict(), queryeval::UnpackInfo());
}

void
AttributeWeightedSetBlueprint::fetchPostings(const queryeval::ExecuteInfo &execInfo)
{
    if (strict()) {
        for (auto * context : _contexts) {
            context->fetchPostings(execInfo, strict());
        }
    }
}

void
AttributeWeightedSetBlueprint::visitMembers(vespalib::ObjectVisitor &visitor) const
{
    ComplexLeafBlueprint::visitMembers(visitor);
    visitor.visitString("attribute", _attr.getName());
    visitor.openStruct("terms", "TermList");
    for (size_t i = 0; i < _contexts.size(); ++i) {
        const ISearchContext * context = _contexts[i];
        visitor.openStruct(vespalib::make_string("[%zu]", i), "Term");
        visitor.visitBool("valid", context->valid());
        if (context-> valid()) {
            bool isString = (_attr.isStringType() && _attr.hasEnum());
            if (isString) {
                visitor.visitString("term", context->queryTerm()->getTerm());
            } else {
                visitor.visitInt("term", context->getAsIntegerTerm().lower());
            }
            visitor.visitInt("weight", _weights[i]);
        }
        visitor.closeStruct();
    }
    visitor.closeStruct();
}

} // namespace search