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.BeforeAll;
23  import org.junit.jupiter.api.Test;
24  import org.junit.jupiter.params.ParameterizedTest;
25  import org.junit.jupiter.params.provider.MethodSource;
26  
27  /**
28   * Tests {@link JaroWinklerDistance}.
29   */
30  class JaroWinklerDistanceTest {
31  
32      private static JaroWinklerDistance distance;
33  
34      @BeforeAll
35      public static void setUp() {
36          distance = new JaroWinklerDistance();
37      }
38  
39      @ParameterizedTest
40      @MethodSource("org.apache.commons.text.similarity.SimilarityInputTest#similarityInputsEquals()")
41      void testGetJaroWinklerDistance(final Class<?> cls) {
42          assertEquals(0.07501d, distance.apply(SimilarityInputTest.build(cls, "frog"), SimilarityInputTest.build(cls, "fog")), 0.00001d);
43          assertEquals(1.0d, distance.apply(SimilarityInputTest.build(cls, "fly"), SimilarityInputTest.build(cls, "ant")), 0.00000000000000000001d);
44          assertEquals(0.55834d, distance.apply(SimilarityInputTest.build(cls, "elephant"), SimilarityInputTest.build(cls, "hippo")), 0.00001d);
45          assertEquals(0.09334d, distance.apply(SimilarityInputTest.build(cls, "ABC Corporation"), SimilarityInputTest.build(cls, "ABC Corp")), 0.00001d);
46          assertEquals(0.04749d,
47                  distance.apply(SimilarityInputTest.build(cls, "D N H Enterprises Inc"), SimilarityInputTest.build(cls, "D & H Enterprises, Inc.")), 0.00001d);
48          assertEquals(0.058d,
49                  distance.apply(SimilarityInputTest.build(cls, "My Gym Children's Fitness Center"), SimilarityInputTest.build(cls, "My Gym. Childrens Fitness")),
50                  0.00001d);
51          assertEquals(0.101982d, distance.apply(SimilarityInputTest.build(cls, "PENNSYLVANIA"), SimilarityInputTest.build(cls, "PENNCISYLVNIA")), 0.00001d);
52          assertEquals(0.028572d, distance.apply(SimilarityInputTest.build(cls, "/opt/software1"), SimilarityInputTest.build(cls, "/opt/software2")), 0.00001d);
53          assertEquals(0.058334d, distance.apply(SimilarityInputTest.build(cls, "aaabcd"), SimilarityInputTest.build(cls, "aaacdb")), 0.00001d);
54          assertEquals(0.088889d, distance.apply(SimilarityInputTest.build(cls, "John Horn"), SimilarityInputTest.build(cls, "John Hopkins")), 0.00001d);
55          assertEquals(0d, distance.apply(SimilarityInputTest.build(cls, ""), SimilarityInputTest.build(cls, "")), 0.00001d);
56          assertEquals(0d, distance.apply(SimilarityInputTest.build(cls, "foo"), SimilarityInputTest.build(cls, "foo")), 0.00001d);
57          assertEquals(1 - 0.94166d, distance.apply(SimilarityInputTest.build(cls, "foo"), SimilarityInputTest.build(cls, "foo ")), 0.00001d);
58          assertEquals(1 - 0.90666d, distance.apply(SimilarityInputTest.build(cls, "foo"), SimilarityInputTest.build(cls, "foo  ")), 0.00001d);
59          assertEquals(1 - 0.86666d, distance.apply(SimilarityInputTest.build(cls, "foo"), SimilarityInputTest.build(cls, " foo ")), 0.00001d);
60          assertEquals(1 - 0.51111d, distance.apply(SimilarityInputTest.build(cls, "foo"), SimilarityInputTest.build(cls, "  foo")), 0.00001d);
61      }
62  
63      @Test
64      void testGetJaroWinklerDistance_NullNull() {
65          assertThrows(IllegalArgumentException.class, () -> distance.apply((String) null, null));
66      }
67  
68      @Test
69      void testGetJaroWinklerDistance_NullString() {
70          assertThrows(IllegalArgumentException.class, () -> distance.apply(null, "clear"));
71      }
72  
73      @Test
74      void testGetJaroWinklerDistance_StringNull() {
75          assertThrows(IllegalArgumentException.class, () -> distance.apply(" ", null));
76      }
77  
78      @Test
79      void testGetJaroWinklerDistance_StringString() {
80          assertEquals(0.07501d, distance.apply("frog", "fog"), 0.00001d);
81          assertEquals(1.0d, distance.apply("fly", "ant"), 0.00000000000000000001d);
82          assertEquals(0.55834d, distance.apply("elephant", "hippo"), 0.00001d);
83          assertEquals(0.09334d, distance.apply("ABC Corporation", "ABC Corp"), 0.00001d);
84          assertEquals(0.04749d, distance.apply("D N H Enterprises Inc", "D & H Enterprises, Inc."), 0.00001d);
85          assertEquals(0.058d, distance.apply("My Gym Children's Fitness Center", "My Gym. Childrens Fitness"), 0.00001d);
86          assertEquals(0.101982d, distance.apply("PENNSYLVANIA", "PENNCISYLVNIA"), 0.00001d);
87          assertEquals(0.028572d, distance.apply("/opt/software1", "/opt/software2"), 0.00001d);
88          assertEquals(0.058334d, distance.apply("aaabcd", "aaacdb"), 0.00001d);
89          assertEquals(0.088889d, distance.apply("John Horn", "John Hopkins"), 0.00001d);
90          assertEquals(0d, distance.apply("", ""), 0.00001d);
91          assertEquals(0d, distance.apply("foo", "foo"), 0.00001d);
92          assertEquals(1 - 0.94166d, distance.apply("foo", "foo "), 0.00001d);
93          assertEquals(1 - 0.90666d, distance.apply("foo", "foo  "), 0.00001d);
94          assertEquals(1 - 0.86666d, distance.apply("foo", " foo "), 0.00001d);
95          assertEquals(1 - 0.51111d, distance.apply("foo", "  foo"), 0.00001d);
96      }
97  
98  }