View Javadoc
1   /*
2    * Licensed to the Apache Software Foundation (ASF) under one or more
3    * contributor license agreements.  See the NOTICE file distributed with
4    * this work for additional information regarding copyright ownership.
5    * The ASF licenses this file to You under the Apache License, Version 2.0
6    * (the "License"); you may not use this file except in compliance with
7    * the License.  You may obtain a copy of the License at
8    *
9    *      https://www.apache.org/licenses/LICENSE-2.0
10   *
11   * Unless required by applicable law or agreed to in writing, software
12   * distributed under the License is distributed on an "AS IS" BASIS,
13   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14   * See the License for the specific language governing permissions and
15   * limitations under the License.
16   */
17  package org.apache.commons.text.similarity;
18  
19  import static org.junit.jupiter.api.Assertions.assertEquals;
20  import static org.junit.jupiter.api.Assertions.assertThrows;
21  
22  import org.junit.jupiter.api.Test;
23  
24  /**
25   * Tests {@link EditDistanceFrom}.
26   */
27  class StringMetricFromTest {
28  
29      @Test
30      void testEquivalence() {
31          final EditDistance<Integer> metric = LevenshteinDistance.getDefaultInstance();
32          final String left = "Apache";
33          final String right = "a patchy";
34          final Integer distance = 4;
35          final EditDistanceFrom<Integer> metricFrom = new EditDistanceFrom<>(metric, left);
36  
37          assertEquals(distance, metricFrom.apply(right));
38          assertEquals(metric.apply(left, right), metricFrom.apply(right));
39      }
40  
41      @Test
42      void testJavadocExample() {
43          final EditDistance<Integer> metric = LevenshteinDistance.getDefaultInstance();
44          final String target = "Apache";
45          final EditDistanceFrom<Integer> metricFrom = new EditDistanceFrom<>(metric, target);
46          String mostSimilar = null;
47          Integer shortestDistance = null;
48  
49          for (final String test : new String[] { "Appaloosa", "a patchy", "apple" }) {
50              final Integer distance = metricFrom.apply(test);
51              if (shortestDistance == null || distance < shortestDistance) {
52                  shortestDistance = distance;
53                  mostSimilar = test;
54              }
55          }
56          assertEquals("a patchy", mostSimilar);
57          assertEquals(4, shortestDistance);
58      }
59  
60      @Test
61      void testMissingMetric() {
62          assertThrows(IllegalArgumentException.class, () -> new EditDistanceFrom<Number>(null, "no go"));
63      }
64  
65  }