summaryrefslogtreecommitdiffstats
path: root/searchlib/src/vespa/searchlib/tensor/bound_distance_function.h
blob: 318271835ad3e64cbbf840dc05246b4313bd1c19 (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include "distance_function.h"
#include <vespa/eval/eval/typed_cells.h>
#include <memory>

namespace search::tensor {

/**
 * Interface used to calculate the distance from a prebound n-dimensional vector.
 *
 * Use from a single thread only - not required to be thread safe.
 * The actual implementation may keep state about the prebound vector and
 * mutable temporary storage.
 */
class BoundDistanceFunction : public DistanceConverter {
public:
    using UP = std::unique_ptr<BoundDistanceFunction>;
    using TypedCells = vespalib::eval::TypedCells;
    using Int8Float = vespalib::eval::Int8Float;

    BoundDistanceFunction() noexcept = default;

    ~BoundDistanceFunction() override = default;

    // calculate internal distance (comparable)
    virtual double calc(TypedCells rhs) const noexcept = 0;

    // calculate internal distance, early return allowed if > limit
    virtual double calc_with_limit(TypedCells rhs, double limit) const noexcept = 0;
protected:
    static const double *cast(const double * p) { return p; }
    static const float *cast(const float * p) { return p; }
    static const int8_t *cast(const Int8Float * p) { return reinterpret_cast<const int8_t *>(p); }
};

}