summaryrefslogtreecommitdiffstats
path: root/streamingvisitors/src/tests/rank_processor/rank_processor_test.cpp
blob: 2d138d1d336b7b35311de247af4164e3df5760e6 (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <vespa/searchvisitor/rankprocessor.h>
#include <vespa/searchlib/query/streaming/query.h>
#include <vespa/searchlib/query/streaming/nearest_neighbor_query_node.h>
#include <vespa/searchlib/query/tree/querybuilder.h>
#include <vespa/searchlib/query/tree/simplequery.h>
#include <vespa/searchlib/query/tree/stackdumpcreator.h>
#include <vespa/searchvisitor/querytermdata.h>
#include <vespa/vespalib/gtest/gtest.h>

using search::fef::MatchData;
using search::fef::TermFieldHandle;
using search::fef::TermFieldMatchData;
using search::query::Weight;
using search::query::QueryBuilder;
using search::query::SimpleQueryNodeTypes;
using search::query::StackDumpCreator;
using search::streaming::NearestNeighborQueryNode;
using search::streaming::Query;
using search::streaming::QueryTerm;
using streaming::RankProcessor;
using streaming::QueryTermData;
using streaming::QueryTermDataFactory;
using streaming::QueryWrapper;

class RankProcessorTest : public testing::Test
{
protected:
    QueryTermDataFactory _factory;
    std::unique_ptr<Query> _query;
    std::unique_ptr<QueryWrapper> _query_wrapper;

    RankProcessorTest();
    ~RankProcessorTest() override;

    void build_query(QueryBuilder<SimpleQueryNodeTypes> &builder);
    void test_unpack_match_data_for_term_node(bool interleaved_features);
};

RankProcessorTest::RankProcessorTest()
    : testing::Test(),
      _factory(),
      _query(),
      _query_wrapper()
{
}

RankProcessorTest::~RankProcessorTest() = default;

void
RankProcessorTest::build_query(QueryBuilder<SimpleQueryNodeTypes> &builder)
{
    auto build_node = builder.build();
    auto stack_dump = StackDumpCreator::create(*build_node);
    _query = std::make_unique<Query>(_factory, stack_dump);
    _query_wrapper = std::make_unique<QueryWrapper>(*_query);
}

void
RankProcessorTest::test_unpack_match_data_for_term_node(bool interleaved_features)
{
    QueryBuilder<SimpleQueryNodeTypes> builder;
    constexpr int32_t id = 42;
    constexpr int32_t weight = 1;
    builder.addStringTerm("term", "field", id, Weight(weight));
    build_query(builder);
    auto& term_list = _query_wrapper->getTermList();
    EXPECT_EQ(1u, term_list.size());
    auto node = dynamic_cast<QueryTerm*>(term_list.front().getTerm());
    EXPECT_NE(nullptr, node);
    auto& qtd = static_cast<QueryTermData &>(node->getQueryItem());
    auto& td = qtd.getTermData();
    constexpr TermFieldHandle handle = 27;
    constexpr uint32_t field_id = 12;
    constexpr uint32_t mock_num_occs = 2;
    constexpr uint32_t mock_field_length = 101;
    td.addField(field_id).setHandle(handle);
    node->resizeFieldId(field_id);
    auto md = MatchData::makeTestInstance(handle + 1, handle + 1);
    auto tfmd = md->resolveTermField(handle);
    tfmd->setNeedInterleavedFeatures(interleaved_features);
    auto invalid_id = TermFieldMatchData::invalidId();
    EXPECT_EQ(invalid_id, tfmd->getDocId());
    RankProcessor::unpack_match_data(1, *md, *_query_wrapper);
    EXPECT_EQ(invalid_id, tfmd->getDocId());
    node->add(0, field_id, 0, 1);
    auto& field_info = node->getFieldInfo(field_id);
    field_info.setHitCount(mock_num_occs);
    field_info.setFieldLength(mock_field_length);
    RankProcessor::unpack_match_data(2, *md, *_query_wrapper);
    EXPECT_EQ(2, tfmd->getDocId());
    if (interleaved_features) {
        EXPECT_EQ(mock_num_occs, tfmd->getNumOccs());
        EXPECT_EQ(mock_field_length, tfmd->getFieldLength());
    } else {
        EXPECT_EQ(0, tfmd->getNumOccs());
        EXPECT_EQ(0, tfmd->getFieldLength());
    }
    EXPECT_EQ(1, tfmd->size());
    node->reset();
    RankProcessor::unpack_match_data(3, *md, *_query_wrapper);
    EXPECT_EQ(2, tfmd->getDocId());
}


TEST_F(RankProcessorTest, unpack_normal_match_data_for_term_node)
{
    test_unpack_match_data_for_term_node(false);
}

TEST_F(RankProcessorTest, unpack_interleaved_match_data_for_term_node)
{
    test_unpack_match_data_for_term_node(true);
}

class MockRawScoreCalculator : public search::streaming::NearestNeighborQueryNode::RawScoreCalculator {
public:
    double to_raw_score(double distance) override { return distance * 2; }
};

TEST_F(RankProcessorTest, unpack_match_data_for_nearest_neighbor_query_node)
{
    QueryBuilder<SimpleQueryNodeTypes> builder;
    constexpr double distance_threshold = 35.5;
    constexpr int32_t id = 42;
    constexpr int32_t weight = 1;
    constexpr uint32_t target_num_hits = 100;
    constexpr bool allow_approximate = false;
    constexpr uint32_t explore_additional_hits = 800;
    builder.add_nearest_neighbor_term("qtensor", "field", id, Weight(weight), target_num_hits, allow_approximate, explore_additional_hits, distance_threshold);
    build_query(builder);
    auto& term_list = _query_wrapper->getTermList();
    EXPECT_EQ(1u, term_list.size());
    auto node = dynamic_cast<NearestNeighborQueryNode*>(term_list.front().getTerm());
    EXPECT_NE(nullptr, node);
    MockRawScoreCalculator calc;
    node->set_raw_score_calc(&calc);
    auto& qtd = static_cast<QueryTermData &>(node->getQueryItem());
    auto& td = qtd.getTermData();
    constexpr TermFieldHandle handle = 27;
    constexpr uint32_t field_id = 12;
    td.addField(field_id).setHandle(handle);
    auto md = MatchData::makeTestInstance(handle + 1, handle + 1);
    auto tfmd = md->resolveTermField(handle);
    auto invalid_id = TermFieldMatchData::invalidId();
    EXPECT_EQ(invalid_id, tfmd->getDocId());
    RankProcessor::unpack_match_data(1, *md, *_query_wrapper);
    EXPECT_EQ(invalid_id, tfmd->getDocId());
    constexpr double distance = 1.5;
    node->set_distance(distance);
    RankProcessor::unpack_match_data(2, *md, *_query_wrapper);
    EXPECT_EQ(2, tfmd->getDocId());
    EXPECT_EQ(distance * 2, tfmd->getRawScore());
    node->reset();
    RankProcessor::unpack_match_data(3, *md, *_query_wrapper);
    EXPECT_EQ(2, tfmd->getDocId());
}

GTEST_MAIN_RUN_ALL_TESTS()