summaryrefslogtreecommitdiff
path: root/core/src/main/java/org/elasticsearch/index/similarity/LMJelinekMercerSimilarityProvider.java
blob: 3d5a40fc153db5729a98e61665477f578977df30 (plain)
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
/*
 * Licensed to Elasticsearch under one or more contributor
 * license agreements. See the NOTICE file distributed with
 * this work for additional information regarding copyright
 * ownership. Elasticsearch licenses this file to you under
 * the Apache License, Version 2.0 (the "License"); you may
 * not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.elasticsearch.index.similarity;

import org.apache.lucene.search.similarities.LMJelinekMercerSimilarity;
import org.apache.lucene.search.similarities.Similarity;
import org.elasticsearch.common.inject.Inject;
import org.elasticsearch.common.inject.assistedinject.Assisted;
import org.elasticsearch.common.settings.Settings;

/**
 * {@link SimilarityProvider} for {@link LMJelinekMercerSimilarity}.
 * <p>
 * Configuration options available:
 * <ul>
 *     <li>lambda</li>
 * </ul>
 * @see LMJelinekMercerSimilarity For more information about configuration
 */
public class LMJelinekMercerSimilarityProvider extends AbstractSimilarityProvider {

    private final LMJelinekMercerSimilarity similarity;

    public LMJelinekMercerSimilarityProvider(String name, Settings settings) {
        super(name);
        float lambda = settings.getAsFloat("lambda", 0.1f);
        this.similarity = new LMJelinekMercerSimilarity(lambda);
    }

    /**
     * {@inheritDoc}
     */
    @Override
    public Similarity get() {
        return similarity;
    }
}