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

#include "termdistancefeature.h"
#include "valuefeature.h"
#include "utils.h"
#include <vespa/searchlib/fef/fieldinfo.h>
#include <vespa/searchlib/fef/properties.h>
#include <vespa/vespalib/util/stash.h>

using namespace search::fef;

namespace search::features {


TermDistanceExecutor::TermDistanceExecutor(const IQueryEnvironment & env,
                                           const TermDistanceParams & params) :
    FeatureExecutor(),
    _termA(env.getTerm(params.termX)),
    _termB(env.getTerm(params.termY)),
    _md(nullptr)
{
    _termA.fieldHandle(util::getTermFieldData(env, params.termX, params.fieldId));
    _termB.fieldHandle(util::getTermFieldData(env, params.termY, params.fieldId));
}

bool TermDistanceExecutor::valid() const
{
    return ((_termA.termData() != 0) && (_termB.termData() != 0) &&
            (_termA.fieldHandle() != IllegalHandle) && (_termB.fieldHandle() != IllegalHandle));
}

void
TermDistanceExecutor::execute(uint32_t docId)
{
    TermDistanceCalculator::Result result;
    TermDistanceCalculator::run(_termA, _termB, *_md, docId, result);
    outputs().set_number(0, result.forwardDist);
    outputs().set_number(1, result.forwardTermPos);
    outputs().set_number(2, result.reverseDist);
    outputs().set_number(3, result.reverseTermPos);
}

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

TermDistanceBlueprint::TermDistanceBlueprint() :
    Blueprint("termDistance"),
    _params()
{
}

void
TermDistanceBlueprint::visitDumpFeatures(const IIndexEnvironment &,
                                         IDumpFeatureVisitor &) const
{
}

Blueprint::UP
TermDistanceBlueprint::createInstance() const
{
    return std::make_unique<TermDistanceBlueprint>();
}

bool
TermDistanceBlueprint::setup(const IIndexEnvironment &,
                             const ParameterList & params)
{
    _params.fieldId = params[0].asField()->id();
    _params.termX = params[1].asInteger();
    _params.termY = params[2].asInteger();

    describeOutput("forward",             "the min distance between term X and term Y in the field");
    describeOutput("forwardTermPosition", "the position of term X for the forward distance");
    describeOutput("reverse",             "the min distance between term Y and term X in the field");
    describeOutput("reverseTermPosition", "the position of term Y for the reverse distance");

    return true;
}

FeatureExecutor &
TermDistanceBlueprint::createExecutor(const IQueryEnvironment &env, vespalib::Stash &stash) const
{
    TermDistanceExecutor &tde(stash.create<TermDistanceExecutor>(env, _params));
    if (tde.valid()) {
        return tde;
    } else {
        TermDistanceCalculator::Result r;
        std::vector<feature_t> values(4);
        values[0] = r.forwardDist;
        values[1] = r.forwardTermPos;
        values[2] = r.reverseDist;
        values[3] = r.reverseTermPos;
        return stash.create<ValueExecutor>(values);
    }
}

}