aboutsummaryrefslogtreecommitdiffstats
path: root/searchlib/src/test/java/com/yahoo/searchlib/ranking/features/fieldmatch/SemanticDistanceTestCase.java
blob: f3d52acf878d9c8978bee4835cd40a0ed3acc43e (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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.searchlib.ranking.features.fieldmatch;

import org.junit.Before;
import org.junit.Test;

import java.util.Set;
import java.util.HashSet;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertTrue;

/**
 * The "semantic distance" refers to the non-continuous distance from a token
 * to the next token used by the string match metrics algorithm. This class
 * tests invariants which must hold for any such distance metric as well as specifics
 * for the currently used distance metric.
 *
 * @author bratseth
 */
public class SemanticDistanceTestCase {

    FieldMatchMetricsComputer c;

    @Before
    public void setUp() {
        c=new FieldMatchMetricsComputer();
        StringBuilder field = new StringBuilder();
        for (int i = 0; i < 150; i++)
            field.append("t" + i + " ");
        c.compute("query", field.toString()); // Just to set the field value
    }

    /** Must be true using any semantic distance function */
    @Test
    public void testBothWayConversionProducesOriginalValue() {
        assertBothWayConversionProducesOriginalValue(50);
        assertBothWayConversionProducesOriginalValue(10);
        assertBothWayConversionProducesOriginalValue(5);
        assertBothWayConversionProducesOriginalValue(0);
        assertBothWayConversionProducesOriginalValue(140);
        assertBothWayConversionProducesOriginalValue(145);
        assertBothWayConversionProducesOriginalValue(149);
    }

    /** Must be true using any semantic distance function */
    @Test
    public void testFunctionsAreOneToOne() {
        assertFunctionsAreOneToOne(50);
        assertFunctionsAreOneToOne(10);
        assertFunctionsAreOneToOne(5);
        assertFunctionsAreOneToOne(0);
        assertFunctionsAreOneToOne(140);
        assertFunctionsAreOneToOne(145);
        assertFunctionsAreOneToOne(149);
    }

    /** Specific to this particular distance function */
    @Test
    public void testFunction() {
        int zeroJ = 50;
        assertFunction(50,0, zeroJ);
        assertFunction(59,9, zeroJ);
        assertFunction(49,10, zeroJ);
        assertFunction(40,19, zeroJ);
        assertFunction(60,20, zeroJ);
        assertFunction(149,109, zeroJ);
        assertFunction(39,110, zeroJ);
        assertFunction(0,149, zeroJ);

        zeroJ = 0;
        assertFunction(0,0, zeroJ);
        assertFunction(10,10, zeroJ);
        assertFunction(20,20, zeroJ);
        assertFunction(149,149, zeroJ);

        zeroJ = 5;
        assertFunction(5,0, zeroJ);
        assertFunction(10,5, zeroJ);
        assertFunction(14,9, zeroJ);
        assertFunction(4,10, zeroJ);
        assertFunction(0,14, zeroJ);
        assertFunction(15,15, zeroJ);
        assertFunction(25,25, zeroJ);
        assertFunction(149,149, zeroJ);

        zeroJ = 149;
        assertFunction(149,0, zeroJ);
        assertFunction(140,9, zeroJ);
        assertFunction(130,19, zeroJ);
        assertFunction(0,149, zeroJ);

        zeroJ = 145;
        assertFunction(145,0, zeroJ);
        assertFunction(149,4, zeroJ);
        assertFunction(144,5, zeroJ);
        assertFunction(140,9, zeroJ);
        assertFunction(135,14, zeroJ);
        assertFunction(125,24, zeroJ);
        assertFunction(0,149, zeroJ);
    }

    /** Hits both limits at once */
    @Test
    public void testSmallField() {
        c = new FieldMatchMetricsComputer();
        c.compute("query","my field value four"); // Just to set the field value
        assertBothWayConversionProducesOriginalValue(2);
        assertBothWayConversionProducesOriginalValue(0);
        assertBothWayConversionProducesOriginalValue(3);
        assertFunctionsAreOneToOne(2);
        assertFunctionsAreOneToOne(0);
        assertFunctionsAreOneToOne(3);

        int zeroJ=2;
        assertFunction(2,0, zeroJ);
        assertFunction(3,1, zeroJ);
        assertFunction(1,2, zeroJ);
        assertFunction(0,3, zeroJ);
    }

    private void assertBothWayConversionProducesOriginalValue(int zeroJ) {
        // Starting point in the middle
        for (int j = 0; j < c.getField().terms().size(); j++) {
            int semanticDistance=c.fieldIndexToSemanticDistance(j, zeroJ);
            assertTrue("Using zeroJ=" + zeroJ + ": " + semanticDistance +">=0", semanticDistance >= 0);
            int backConvertedJ=c.semanticDistanceToFieldIndex(semanticDistance, zeroJ);
            assertEquals("Using zeroJ=" + zeroJ + ": " + j + "->" + semanticDistance + "->" + backConvertedJ,j, backConvertedJ);
        }
    }

    private void assertFunctionsAreOneToOne(int zeroJ) {
        Set<Integer> distances = new HashSet<>();
        for (int j = 0; j < c.getField().terms().size(); j++) {
            int semanticDistance = c.fieldIndexToSemanticDistance(j,zeroJ);
            assertTrue("Using zeroJ=" + zeroJ + ": " + j + "->" + semanticDistance + " is unique",
                       ! distances.contains(semanticDistance));
            distances.add(semanticDistance);
        }
    }

    private void assertFunction(int j,int semanticDistance, int zeroJ) {
        assertEquals(j + "->" + semanticDistance,semanticDistance, c.fieldIndexToSemanticDistance(j,zeroJ));
    }

}