aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/tests/tensor/distance_calculator/distance_calculator_test.cpp
blob: b7702398857ce1ec893287eb88f84bbae015e6ef (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#include <vespa/eval/eval/simple_value.h>
#include <vespa/eval/eval/tensor_spec.h>
#include <vespa/eval/eval/value_type.h>
#include <vespa/searchcommon/attribute/config.h>
#include <vespa/searchlib/attribute/attributevector.h>
#include <vespa/searchlib/tensor/distance_calculator.h>
#include <vespa/searchlib/test/attribute_builder.h>
#include <vespa/vespalib/gtest/gtest.h>
#include <vespa/vespalib/util/exceptions.h>
#include <iostream>

using namespace search::attribute::test;
using namespace search::attribute;
using namespace search::tensor;
using namespace vespalib::eval;

using search::AttributeVector;

using OptSubspace = std::optional<uint32_t>;

std::unique_ptr<Value> make_tensor(const vespalib::string& expr) {
    return SimpleValue::from_spec(TensorSpec::from_expr(expr));
}

class DistanceCalculatorTest : public testing::Test {
public:
    std::shared_ptr<AttributeVector> attr;

    DistanceCalculatorTest()
        : attr()
    {
    }

    void build_attribute(const vespalib::string& tensor_type,
                         const std::vector<vespalib::string>& tensor_values) {
        Config cfg(BasicType::TENSOR);
        cfg.setTensorType(ValueType::from_spec(tensor_type));
        cfg.set_distance_metric(DistanceMetric::Euclidean);
        attr = AttributeBuilder("doc_tensor", cfg).fill_tensor(tensor_values).get();
        ASSERT_TRUE(attr.get() != nullptr);
    }
    double calc_distance(uint32_t docid, const vespalib::string& query_tensor) {
        auto qt = make_tensor(query_tensor);
        auto calc = DistanceCalculator::make_with_validation(*attr, *qt);
        return calc->calc_with_limit(docid, std::numeric_limits<double>::max());
    }
    double calc_rawscore(uint32_t docid, const vespalib::string& query_tensor) {
        auto qt = make_tensor(query_tensor);
        auto calc = DistanceCalculator::make_with_validation(*attr, *qt);
        return calc->calc_raw_score(docid);
    }
    OptSubspace calc_closest_subspace(uint32_t docid, const vespalib::string& query_tensor) {
        auto qt = make_tensor(query_tensor);
        auto calc = DistanceCalculator::make_with_validation(*attr, *qt);
        return calc->calc_closest_subspace(attr->asTensorAttribute()->get_vectors(docid));
    }
    void make_calc_throws(const vespalib::string& query_tensor) {
        auto qt = make_tensor(query_tensor);
        DistanceCalculator::make_with_validation(*attr, *qt);
    }
};

constexpr double max_distance = std::numeric_limits<double>::max();

TEST_F(DistanceCalculatorTest, calculation_over_dense_tensor_attribute)
{
    build_attribute("tensor(y[2])", {"[3,10]", ""});
    vespalib::string qt = "tensor(y[2]):[7,10]";
    EXPECT_DOUBLE_EQ(16, calc_distance(1, qt));
    EXPECT_DOUBLE_EQ(max_distance, calc_distance(2, qt));
    EXPECT_EQ(OptSubspace(0), calc_closest_subspace(1, qt));

    EXPECT_DOUBLE_EQ(1.0/(1.0 + 4.0), calc_rawscore(1, qt));
    EXPECT_DOUBLE_EQ(0.0, calc_rawscore(2, qt));
    EXPECT_EQ(OptSubspace(), calc_closest_subspace(2, qt));
}

TEST_F(DistanceCalculatorTest, calculation_over_mixed_tensor_attribute)
{
    build_attribute("tensor(x{},y[2])",
                    {"{{x:\"a\",y:0}:3,{x:\"a\",y:1}:10,{x:\"b\",y:0}:5,{x:\"b\",y:1}:10}",
                     "{}", ""});
    vespalib::string qt_1 = "tensor(y[2]):[9,10]";
    vespalib::string qt_2 = "tensor(y[2]):[1,10]";
    EXPECT_DOUBLE_EQ(16, calc_distance(1, qt_1));
    EXPECT_DOUBLE_EQ(4, calc_distance(1, qt_2));
    EXPECT_EQ(OptSubspace(1), calc_closest_subspace(1, qt_1));
    EXPECT_EQ(OptSubspace(0), calc_closest_subspace(1, qt_2));
    EXPECT_DOUBLE_EQ(max_distance, calc_distance(2, qt_1));
    EXPECT_DOUBLE_EQ(max_distance, calc_distance(3, qt_1));
    EXPECT_EQ(OptSubspace(), calc_closest_subspace(2, qt_1));
    EXPECT_EQ(OptSubspace(), calc_closest_subspace(3, qt_1));

    EXPECT_DOUBLE_EQ(1.0/(1.0 + 4.0), calc_rawscore(1, qt_1));
    EXPECT_DOUBLE_EQ(1.0/(1.0 + 2.0), calc_rawscore(1, qt_2));
    EXPECT_DOUBLE_EQ(0.0, calc_rawscore(2, qt_1));
    EXPECT_DOUBLE_EQ(0.0, calc_rawscore(3, qt_1));
}

TEST_F(DistanceCalculatorTest, make_calculator_for_unsupported_types_throws)
{
    build_attribute("tensor(x{},y{})", {});
    EXPECT_THROW(make_calc_throws("tensor(y[2]):[9,10]"), vespalib::IllegalArgumentException);

    build_attribute("tensor(x{},y{},z[2])", {});
    EXPECT_THROW(make_calc_throws("tensor(z[2]):[9,10]"), vespalib::IllegalArgumentException);

    build_attribute("tensor(x{},y[2])", {});
    EXPECT_THROW(make_calc_throws("tensor(y{}):{{y:\"a\"}:9,{y:\"b\"}:10}"), vespalib::IllegalArgumentException);
    EXPECT_THROW(make_calc_throws("tensor(y[3]):[9,10]"), vespalib::IllegalArgumentException);
}

GTEST_MAIN_RUN_ALL_TESTS()