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

#pragma once

#include <vespa/searchlib/fef/blueprint.h>
#include <vespa/searchlib/fef/table.h>
#include "termdistancecalculator.h"

namespace search::features {

/**
 * This struct contains parameters used by the executor.
 **/
struct TermDistanceParams {
    uint32_t fieldId;
    uint32_t termX;
    uint32_t termY;
    TermDistanceParams() : fieldId(0), termX(0), termY(0) {}
};

/**
 * Implements the executor for calculating min term distance (forward and reverse).
 **/
class TermDistanceExecutor : public fef::FeatureExecutor
{
private:
    QueryTerm        _termA;
    QueryTerm        _termB;
    const fef::MatchData *_md;

    virtual void handle_bind_match_data(const fef::MatchData &md) override;

public:
    TermDistanceExecutor(const fef::IQueryEnvironment & env,
                         const TermDistanceParams & params);
    void execute(uint32_t docId) override;
    bool valid() const;
};


/**
 * Implements the blueprint for the term distance executor.
 **/
class TermDistanceBlueprint : public fef::Blueprint {
private:
    TermDistanceParams _params;

public:
    TermDistanceBlueprint();
    void visitDumpFeatures(const fef::IIndexEnvironment & env, fef::IDumpFeatureVisitor & visitor) const override;
    fef::Blueprint::UP createInstance() const override;
    fef::ParameterDescriptions getDescriptions() const override {
        return fef::ParameterDescriptions().desc().indexField(fef::ParameterCollection::ANY).number().number();
    }
    bool setup(const fef::IIndexEnvironment & env, const fef::ParameterList & params) override;
    fef::FeatureExecutor &createExecutor(const fef::IQueryEnvironment &env, vespalib::Stash &stash) const override;
};

}