summaryrefslogtreecommitdiffstats
path: root/searchlib/src/main/java/com/yahoo/searchlib/rankingexpression/evaluation/TensorValue.java
blob: b37bbb543eb0f40f4e182b44e49685b889833ed7 (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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.searchlib.rankingexpression.evaluation;

import com.yahoo.api.annotations.Beta;
import com.yahoo.searchlib.rankingexpression.rule.Function;
import com.yahoo.searchlib.rankingexpression.rule.TruthOperator;
import com.yahoo.tensor.Tensor;
import com.yahoo.tensor.TensorAddress;
import com.yahoo.tensor.TensorType;

/**
 * A Value containing a tensor.
 * See {@link com.yahoo.tensor.Tensor} for definition of a tensor
 * and the operations supported.
 *
 * @author bratseth
 */
@Beta
public class TensorValue extends Value {

    /** The tensor value of this */
    private final Tensor value;

    public TensorValue(Tensor value) {
        this.value = value;
    }

    @Override
    public TensorType type() { return value.type(); }

    @Override
    public double asDouble() {
        if (hasDouble())
            return value.get(TensorAddress.of());
        throw new UnsupportedOperationException("Requires a double value, but " + this.value + " cannot be " +
                                                "used as a double");
    }

    @Override
    public boolean hasDouble() { return value.type().dimensions().isEmpty() && ! value.isEmpty(); }

    @Override
    public boolean asBoolean() {
        if (hasDouble())
            return asDouble() != 0.0;
        throw new UnsupportedOperationException("Tensor does not have a value that can be converted to a boolean");
    }

    @Override
    public Value negate() {
        return new TensorValue(value.map((value) -> -value));
    }

    @Override
    public Value add(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.add(((TensorValue)argument).value));
        else
            return new TensorValue(value.map((value) -> value + argument.asDouble()));
    }

    @Override
    public Value subtract(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.subtract(((TensorValue) argument).value));
        else
            return new TensorValue(value.map((value) -> value - argument.asDouble()));
    }

    @Override
    public Value multiply(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.multiply(((TensorValue) argument).value));
        else
            return new TensorValue(value.map((value) -> value * argument.asDouble()));
    }

    @Override
    public Value divide(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.divide(((TensorValue) argument).value));
        else
            return new TensorValue(value.map((value) -> value / argument.asDouble()));
    }

    @Override
    public Value modulo(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.fmod(((TensorValue) argument).value));
        else
            return new TensorValue(value.map((value) -> value % argument.asDouble()));
    }

    @Override
    public Value and(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.join(((TensorValue)argument).value, (a, b) -> ((a!=0.0) && (b!=0.0)) ? 1.0 : 0.0 ));
        else
            return new TensorValue(value.map((value) -> ((value!=0.0) && argument.asBoolean()) ? 1 : 0));
    }

    @Override
    public Value or(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.join(((TensorValue)argument).value, (a, b) -> ((a!=0.0) || (b!=0.0)) ? 1.0 : 0.0 ));
        else
            return new TensorValue(value.map((value) -> ((value!=0.0) || argument.asBoolean()) ? 1 : 0));
    }

    @Override
    public Value not() {
        return new TensorValue(value.map((value) -> (value==0.0) ? 1.0 : 0.0));
    }

    @Override
    public Value power(Value argument) {
        if (argument instanceof TensorValue)
            return new TensorValue(value.pow(((TensorValue)argument).value));
        else
            return new TensorValue(value.map((value) -> Math.pow(value, argument.asDouble())));
    }

    public Tensor asTensor() { return value; }

    @Override
    public Value compare(TruthOperator operator, Value argument) {
        return new TensorValue(compareTensor(operator, argument.asTensor()));
    }

    private Tensor compareTensor(TruthOperator operator, Tensor argument) {
        switch (operator) {
            case LARGER: return value.larger(argument);
            case LARGEREQUAL: return value.largerOrEqual(argument);
            case SMALLER: return value.smaller(argument);
            case SMALLEREQUAL: return value.smallerOrEqual(argument);
            case EQUAL: return value.equal(argument);
            case NOTEQUAL: return value.notEqual(argument);
            case APPROX_EQUAL: return value.approxEqual(argument);
            default: throw new UnsupportedOperationException("Tensors cannot be compared with " + operator);
        }
    }

    @Override
    public Value function(Function function, Value arg) {
        if (arg instanceof TensorValue)
            return new TensorValue(functionOnTensor(function, arg.asTensor()));
        else
            return new TensorValue(value.map((value) -> function.evaluate(value, arg.asDouble())));
    }

    private Tensor functionOnTensor(Function function, Tensor argument) {
        switch (function) {
            case min: return value.min(argument);
            case max: return value.max(argument);
            case atan2: return value.atan2(argument);
            case pow: return value.pow(argument);
            case fmod: return value.fmod(argument);
            case ldexp: return value.ldexp(argument);
            case bit: return value.bit(argument);
            case hamming: return value.hamming(argument);
            default: throw new UnsupportedOperationException("Cannot combine two tensors using " + function);
        }
    }

    @Override
    public Value asMutable() {
        throw new UnsupportedOperationException();
    }

    @Override
    public String toString() {
        return value.toString();
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        TensorValue other = (TensorValue) o;
        return value.equals(other.value);
    }

    @Override
    public int hashCode() {
        return value.hashCode();
    }

}