aboutsummaryrefslogtreecommitdiffstats
path: root/eval/src/vespa/eval/eval/test/eval_spec.h
blob: a26fd6268103a18f6690e65f240044d0900fdc8d (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
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include <vespa/vespalib/stllike/string.h>
#include <initializer_list>
#include <cassert>
#include <vector>

namespace vespalib::eval::test {

/**
 * A collection of expressions with parameter bindings and their
 * expected evaluation results. This is intended as the basis for
 * conformance testing of evaluation engines.
 **/
class EvalSpec
{
private:
    typedef double (*fun_1_ref)(double);
    typedef double (*fun_2_ref)(double, double);

    struct Expression {
        struct Case {
            std::vector<double> param_values;
            double expected_result;
            Case(std::initializer_list<double> param_values_in, double expected_result_in)
                : param_values(param_values_in), expected_result(expected_result_in) {}
        };
        std::vector<vespalib::string> param_names;
        vespalib::string expression;
        std::vector<Case> cases;
        Expression(std::initializer_list<vespalib::string> param_names_in, vespalib::string expression_in)
            : param_names(param_names_in), expression(expression_in) {}
        ~Expression();

        Expression &add_case(std::initializer_list<double> param_values, double expected_result);
        Expression &add_cases(std::initializer_list<double> a_values, fun_1_ref fun);
        Expression &add_cases(std::initializer_list<double> a_values, std::initializer_list<double> b_values, fun_2_ref fun);
    };
    std::vector<Expression> expressions;

    Expression &add_expression(std::initializer_list<vespalib::string> param_names, vespalib::string expression) {
        expressions.emplace_back(param_names, expression);
        return expressions.back();
    }

    struct ParamSpec {
        vespalib::string name;
        double min;
        double max;
        std::vector<double> expand(size_t inner_samples) const {
            std::vector<double> ret;
            ret.push_back(min);
            if (max == min) {
                return ret;
            }
            ret.push_back(max);
            if ((min < 0.0) && (max > 0.0)) {
                ret.push_back(0.0);
            }
            double delta = (max - min) / (inner_samples + 1);
            for(size_t i = 0; i < inner_samples; ++i) {
                double x = min + (delta * (i + 1));
                if (x != 0.0) {
                    ret.push_back(x);
                }
            }
            return ret;
        }
    };

    void add_rule(const ParamSpec &a_spec, const vespalib::string &expression, fun_1_ref ref);

    void add_rule(const ParamSpec &a_spec, const ParamSpec &b_spec, const vespalib::string &expression, fun_2_ref ref);

public:
    struct EvalTest {
        static vespalib::string as_string(const std::vector<vespalib::string> &param_names,
                                          const std::vector<double> &param_values,
                                          const vespalib::string &expression);
        bool is_same(double expected, double actual);
        virtual void next_expression(const std::vector<vespalib::string> &param_names,
                                     const vespalib::string &expression) = 0;
        virtual void handle_case(const std::vector<vespalib::string> &param_names,
                                 const std::vector<double> &param_values,
                                 const vespalib::string &expression,
                                 double expected_result) = 0;
        virtual ~EvalTest() {}
    };
    //-------------------------------------------------------------------------
    void add_terminal_cases();         // a, 1.0
    void add_arithmetic_cases();       // a + b, a ^ b
    void add_function_call_cases();    // cos(a), max(a, b)
    void add_tensor_operation_cases(); // map(a,f(x)(sin(x)))
    void add_comparison_cases();       // a < b, c != d
    void add_set_membership_cases();   // a in [x, y, z]
    void add_boolean_cases();          // 1.0 && 0.0
    void add_if_cases();               // if (a < b, a, b)
    void add_complex_cases();          // ...
    //-------------------------------------------------------------------------
    void add_all_cases() {
        add_terminal_cases();
        add_arithmetic_cases();
        add_function_call_cases();
        add_tensor_operation_cases();
        add_comparison_cases();
        add_set_membership_cases();
        add_boolean_cases();
        add_if_cases();
        add_complex_cases();
    }
    //-------------------------------------------------------------------------
    void each_case(EvalTest &test) const {
        for (const Expression &expr: expressions) {
            test.next_expression(expr.param_names, expr.expression);
            for (const Expression::Case &expr_case: expr.cases) {
                test.handle_case(expr.param_names, expr_case.param_values, expr.expression,
                                 expr_case.expected_result);
            }
        }
    }
};

} // namespace