summaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/features/fieldtermmatchfeature.cpp
blob: 980e8ec833b276038e503bd285dcce8e4d1c96ae (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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include "fieldtermmatchfeature.h"
#include "utils.h"
#include <vespa/searchlib/fef/featurenamebuilder.h>
#include <vespa/searchlib/fef/fieldinfo.h>
#include <vespa/searchlib/fef/fieldtype.h>
#include <vespa/searchlib/fef/properties.h>
#include <vespa/searchlib/fef/itermdata.h>
#include <vespa/vespalib/util/stringfmt.h>
#include <vespa/vespalib/util/stash.h>


namespace search::features {

FieldTermMatchExecutor::FieldTermMatchExecutor(const search::fef::IQueryEnvironment &env,
                                               uint32_t fieldId, uint32_t termId) :
    search::fef::FeatureExecutor(),
    _fieldHandle(util::getTermFieldHandle(env, termId, fieldId)),
    _md(nullptr)
{
}

void
FieldTermMatchExecutor::execute(uint32_t docId)
{
    if (_fieldHandle == search::fef::IllegalHandle) {
        outputs().set_number(0, 1000000); // firstPosition
        outputs().set_number(1, 1000000); // lastPosition
        outputs().set_number(2, 0.0f); // occurrences
        outputs().set_number(3, 0.0f); // sum weight
        outputs().set_number(4, 0.0f); // avg exactness
        return;
    }

    const search::fef::TermFieldMatchData &tfmd = *_md->resolveTermField(_fieldHandle);
    uint32_t firstPosition = 1000000;
    uint32_t lastPosition = 1000000;
    uint32_t occurrences = 0;
    double sumExactness = 0;
    int64_t weight = 0;
    if (tfmd.getDocId() == docId) {
        search::fef::FieldPositionsIterator it = tfmd.getIterator();
        if (it.valid()) {
            lastPosition = 0;
            while (it.valid()) {
                firstPosition = std::min(firstPosition, it.getPosition());
                lastPosition = std::max(lastPosition, it.getPosition());
                ++occurrences;
                weight += it.getElementWeight();
                sumExactness += it.getMatchExactness();
                it.next();
            }
        } else {
            lastPosition = 1000000;
            occurrences = 1;
        }
    }
    outputs().set_number(0, firstPosition);
    outputs().set_number(1, lastPosition);
    outputs().set_number(2, occurrences);
    outputs().set_number(3, weight);
    outputs().set_number(4, (occurrences > 0) ? (sumExactness / occurrences) : 0);
}

void
FieldTermMatchExecutor::handle_bind_match_data(const fef::MatchData &md)
{
    _md = &md;
}


FieldTermMatchBlueprint::FieldTermMatchBlueprint() :
    search::fef::Blueprint("fieldTermMatch"),
    _fieldId(0),
    _termId(0)
{
    // empty
}

void
FieldTermMatchBlueprint::visitDumpFeatures(const search::fef::IIndexEnvironment &env,
                                           search::fef::IDumpFeatureVisitor &visitor) const
{
    const search::fef::Properties &props = env.getProperties();
    const vespalib::string &baseName = getBaseName();
    int baseNumTerms = atoi(props.lookup(baseName, "numTerms").get("5").c_str());

    for (uint32_t i = 0; i < env.getNumFields(); ++i) {
        const search::fef::FieldInfo& field = *env.getField(i);
        if (field.type() == search::fef::FieldType::INDEX) {
            const vespalib::string &fieldName = field.name();
            const search::fef::Property &prop = props.lookup(baseName, "numTerms", fieldName);
            int numTerms = prop.found() ? atoi(prop.get().c_str()) : baseNumTerms;
            for (int term = 0; term < numTerms; ++term) {
                search::fef::FeatureNameBuilder fnb;
                fnb.baseName(baseName)
                    .parameter(fieldName)
                    .parameter(vespalib::make_string("%d", term));
                visitor.visitDumpFeature(fnb.output("firstPosition").buildName());
                visitor.visitDumpFeature(fnb.output("occurrences").buildName());
                visitor.visitDumpFeature(fnb.output("weight").buildName());
            }
         }
    }
}

bool
FieldTermMatchBlueprint::setup(const search::fef::IIndexEnvironment &env,
                               const search::fef::ParameterList &params)
{
    _fieldId = params[0].asField()->id();
    _termId = params[1].asInteger();
    describeOutput("firstPosition", "The first occurrence of this term.");
    describeOutput("lastPosition",  "The last occurrence of this term.");
    describeOutput("occurrences",  "The number of occurrence of this term.");
    describeOutput("weight", "The sum occurence weights of this term.");
    describeOutput("exactness", "The average exactness this term.");
    env.hintFieldAccess(_fieldId);
    return true;
}

search::fef::Blueprint::UP
FieldTermMatchBlueprint::createInstance() const
{
    return std::make_unique<FieldTermMatchBlueprint>();
}

search::fef::FeatureExecutor &
FieldTermMatchBlueprint::createExecutor(const search::fef::IQueryEnvironment &env, vespalib::Stash &stash) const
{
    return stash.create<FieldTermMatchExecutor>(env, _fieldId, _termId);
}

}