aboutsummaryrefslogtreecommitdiffstats
path: root/container-search/src/main/java/com/yahoo/search/query/ranking/Matching.java
blob: fb3f2acfadd5021ce60f60186c09922abd2bc27f (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
// Copyright 2017 Yahoo Holdings. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.search.query.ranking;

import com.yahoo.search.query.Ranking;
import com.yahoo.search.query.profile.types.FieldDescription;
import com.yahoo.search.query.profile.types.QueryProfileType;

import java.util.Objects;

/**
 * Holds the settings for the matching feature.
 *
 * @author baldersheim
 */
public class Matching implements Cloneable {

    /** The type representing the property arguments consumed by this */
    private static final QueryProfileType argumentType;

    public static final String TERMWISELIMIT = "termwiselimit";
    public static final String NUMTHREADSPERSEARCH = "numthreadspersearch";
    public static final String NUMSEARCHPARTITIIONS = "numsearchpartitions";
    public static final String MINHITSPERTHREAD = "minhitsperthread";


    static {
        argumentType =new QueryProfileType(Ranking.MATCHING);
        argumentType.setStrict(true);
        argumentType.setBuiltin(true);
        argumentType.addField(new FieldDescription(TERMWISELIMIT, "double"));
        argumentType.addField(new FieldDescription(NUMTHREADSPERSEARCH, "integer"));
        argumentType.addField(new FieldDescription(NUMSEARCHPARTITIIONS, "integer"));
        argumentType.addField(new FieldDescription(MINHITSPERTHREAD, "integer"));
        argumentType.freeze();
    }

    public static QueryProfileType getArgumentType() { return argumentType; }

    public Double termwiseLimit = null;
    private Integer numThreadsPerSearch = null;
    private Integer numSearchPartitions = null;
    private Integer minHitsPerThread = null;

    public Integer getNumSearchPartitions() {
        return numSearchPartitions;
    }

    public void setNumSearchPartitions(int numSearchPartitions) {
        this.numSearchPartitions = numSearchPartitions;
    }

    public Integer getMinHitsPerThread() {
        return minHitsPerThread;
    }

    public void setMinHitsPerThread(int minHitsPerThread) {
        this.minHitsPerThread = minHitsPerThread;
    }

    public void setTermwiselimit(double value) {
        if ((value < 0.0) || (value > 1.0)) {
            throw new IllegalArgumentException("termwiselimit must be in the range [0.0, 1.0]. It is " + value);
        }
        termwiseLimit = value;
    }

    public Double getTermwiseLimit() { return termwiseLimit; }

    public void setNumThreadsPerSearch(int value) {
        numThreadsPerSearch = value;
    }
    public Integer getNumThreadsPerSearch() { return numThreadsPerSearch; }


    /** Internal operation - DO NOT USE */
    public void prepare(RankProperties rankProperties) {

        if (termwiseLimit != null) {
            rankProperties.put("vespa.matching.termwise_limit", String.valueOf(termwiseLimit));
        }
        if (numThreadsPerSearch != null) {
            rankProperties.put("vespa.matching.numthreadspersearch", String.valueOf(numThreadsPerSearch));
        }
        if (numSearchPartitions != null) {
            rankProperties.put("vespa.matching.numsearchpartitions", String.valueOf(numSearchPartitions));
        }
        if (minHitsPerThread != null) {
            rankProperties.put("vespa.matching.minhitsperthread", String.valueOf(minHitsPerThread));
        }
    }

    @Override
    public Matching clone() {
        try {
            return (Matching) super.clone();
        }
        catch (CloneNotSupportedException e) {
            throw new RuntimeException("Won't happen", e);
        }
    }

    @Override
    public int hashCode() {
        int hash = 0;
        if (termwiseLimit != null) hash += 11 * termwiseLimit.hashCode();
        if (numThreadsPerSearch != null) hash += 13 * numThreadsPerSearch.hashCode();
        if (numSearchPartitions != null) hash += 17 * numSearchPartitions.hashCode();
        if (minHitsPerThread != null) hash += 19 * minHitsPerThread.hashCode();
        return hash;
    }

    @Override
    public boolean equals(Object o) {
        if (o == this) return true;
        if ( ! (o instanceof Matching)) return false;

        Matching other = (Matching) o;
        if ( ! Objects.equals(this.termwiseLimit, other.termwiseLimit)) return false;
        if ( ! Objects.equals(this.numThreadsPerSearch, other.numThreadsPerSearch)) return false;
        if ( ! Objects.equals(this.numSearchPartitions, other.numSearchPartitions)) return false;
        if ( ! Objects.equals(this.minHitsPerThread, other.minHitsPerThread)) return false;
        return true;
    }

}