File: tests-JaroWinkler.cpp

package info (click to toggle)
rapidfuzz-cpp 3.3.2-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 2,480 kB
  • sloc: cpp: 30,893; python: 63; makefile: 26; sh: 8
file content (217 lines) | stat: -rw-r--r-- 10,769 bytes parent folder | download
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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
#if CATCH2_VERSION == 2
#    include <catch2/catch.hpp>
#else
#    include <catch2/catch_test_macros.hpp>
#    include <catch2/matchers/catch_matchers_floating_point.hpp>
#endif

#include "../../rapidfuzz_reference/JaroWinkler.hpp"
#include <rapidfuzz/distance/JaroWinkler.hpp>

#include "../common.hpp"

using Catch::Matchers::WithinAbs;

template <typename Sentence1, typename Sentence2>
double jaro_winkler_similarity(const Sentence1& s1, const Sentence2& s2, double prefix_weight = 0.1,
                               double score_cutoff = 0.0)
{
    double res1 = rapidfuzz::jaro_winkler_similarity(s1, s2, prefix_weight, score_cutoff);
    double res2 = rapidfuzz::jaro_winkler_similarity(s1.begin(), s1.end(), s2.begin(), s2.end(),
                                                     prefix_weight, score_cutoff);
    double res3 = rapidfuzz::jaro_winkler_normalized_similarity(s1, s2, prefix_weight, score_cutoff);
    double res4 = rapidfuzz::jaro_winkler_normalized_similarity(s1.begin(), s1.end(), s2.begin(), s2.end(),
                                                                prefix_weight, score_cutoff);
    rapidfuzz::CachedJaroWinkler<rapidfuzz::char_type<Sentence1>> scorer(s1, prefix_weight);
    double res5 = scorer.similarity(s2, score_cutoff);
    double res6 = scorer.similarity(s2.begin(), s2.end(), score_cutoff);
    double res7 = scorer.normalized_similarity(s2, score_cutoff);
    double res8 = scorer.normalized_similarity(s2.begin(), s2.end(), score_cutoff);

#ifdef RAPIDFUZZ_SIMD
    std::vector<double> results(256 / 8);
    if (s1.size() <= 8) {
        rapidfuzz::experimental::MultiJaroWinkler<8> simd_scorer(32, prefix_weight);
        for (unsigned int i = 0; i < 32; ++i)
            simd_scorer.insert(s1);
        simd_scorer.similarity(&results[0], results.size(), s2, score_cutoff);
        for (unsigned int i = 0; i < 32; ++i)
            REQUIRE_THAT(res1, WithinAbs(results[i], 0.000001));
    }
    if (s1.size() <= 16) {
        rapidfuzz::experimental::MultiJaroWinkler<16> simd_scorer(1, prefix_weight);
        simd_scorer.insert(s1);
        simd_scorer.similarity(&results[0], results.size(), s2, score_cutoff);
        REQUIRE_THAT(res1, WithinAbs(results[0], 0.000001));
    }
    if (s1.size() <= 32) {
        rapidfuzz::experimental::MultiJaroWinkler<32> simd_scorer(1, prefix_weight);
        simd_scorer.insert(s1);
        simd_scorer.similarity(&results[0], results.size(), s2, score_cutoff);
        REQUIRE_THAT(res1, WithinAbs(results[0], 0.000001));
    }
    if (s1.size() <= 64) {
        rapidfuzz::experimental::MultiJaroWinkler<64> simd_scorer(1, prefix_weight);
        simd_scorer.insert(s1);
        simd_scorer.similarity(&results[0], results.size(), s2, score_cutoff);
        REQUIRE_THAT(res1, WithinAbs(results[0], 0.000001));
    }
#endif

    REQUIRE_THAT(res1, WithinAbs(res2, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res3, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res4, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res5, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res6, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res7, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res8, 0.000001));
    return res1;
}

template <typename Sentence1, typename Sentence2>
double jaro_winkler_distance(const Sentence1& s1, const Sentence2& s2, double prefix_weight = 0.1,
                             double score_cutoff = 1.0)
{
    double res1 = rapidfuzz::jaro_winkler_distance(s1, s2, prefix_weight, score_cutoff);
    double res2 = rapidfuzz::jaro_winkler_distance(s1.begin(), s1.end(), s2.begin(), s2.end(), prefix_weight,
                                                   score_cutoff);
    double res3 = rapidfuzz::jaro_winkler_normalized_distance(s1, s2, prefix_weight, score_cutoff);
    double res4 = rapidfuzz::jaro_winkler_normalized_distance(s1.begin(), s1.end(), s2.begin(), s2.end(),
                                                              prefix_weight, score_cutoff);
    rapidfuzz::CachedJaroWinkler<rapidfuzz::char_type<Sentence1>> scorer(s1, prefix_weight);
    double res5 = scorer.distance(s2, score_cutoff);
    double res6 = scorer.distance(s2.begin(), s2.end(), score_cutoff);
    double res7 = scorer.normalized_distance(s2, score_cutoff);
    double res8 = scorer.normalized_distance(s2.begin(), s2.end(), score_cutoff);

#ifdef RAPIDFUZZ_SIMD
    std::vector<double> results(256 / 8);
    if (s1.size() <= 8) {
        rapidfuzz::experimental::MultiJaroWinkler<8> simd_scorer(1, prefix_weight);
        simd_scorer.insert(s1);
        simd_scorer.distance(&results[0], results.size(), s2, score_cutoff);
        REQUIRE_THAT(res1, WithinAbs(results[0], 0.000001));
    }
    if (s1.size() <= 16) {
        rapidfuzz::experimental::MultiJaroWinkler<16> simd_scorer(1, prefix_weight);
        simd_scorer.insert(s1);
        simd_scorer.distance(&results[0], results.size(), s2, score_cutoff);
        REQUIRE_THAT(res1, WithinAbs(results[0], 0.000001));
    }
    if (s1.size() <= 32) {
        rapidfuzz::experimental::MultiJaroWinkler<32> simd_scorer(1, prefix_weight);
        simd_scorer.insert(s1);
        simd_scorer.distance(&results[0], results.size(), s2, score_cutoff);
        REQUIRE_THAT(res1, WithinAbs(results[0], 0.000001));
    }
    if (s1.size() <= 64) {
        rapidfuzz::experimental::MultiJaroWinkler<64> simd_scorer(1, prefix_weight);
        simd_scorer.insert(s1);
        simd_scorer.distance(&results[0], results.size(), s2, score_cutoff);
        REQUIRE_THAT(res1, WithinAbs(results[0], 0.000001));
    }
#endif

    REQUIRE_THAT(res1, WithinAbs(res2, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res3, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res4, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res5, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res6, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res7, 0.000001));
    REQUIRE_THAT(res1, WithinAbs(res8, 0.000001));
    return res1;
}

template <typename Sentence1, typename Sentence2>
double jaro_winkler_sim_test(const Sentence1& s1, const Sentence2& s2, double score_cutoff = 0.0)
{
    INFO("name1: " << s1 << ", name2: " << s2 << ", score_cutoff: " << score_cutoff);
    double Sim_original = rapidfuzz_reference::jaro_winkler_similarity(s1, s2, 0.1, score_cutoff);
    double Sim_bitparallel = jaro_winkler_similarity(s1, s2, 0.1, score_cutoff);
    double Dist_bitparallel = jaro_winkler_distance(s1, s2, 0.1, 1.0 - score_cutoff);
    double Sim_bitparallel2 = jaro_winkler_similarity(s2, s1, 0.1, score_cutoff);
    double Dist_bitparallel2 = jaro_winkler_distance(s2, s1, 0.1, 1.0 - score_cutoff);

    REQUIRE_THAT(Sim_original, WithinAbs(Sim_bitparallel, 0.000001));
    REQUIRE_THAT((1.0 - Sim_original), WithinAbs(Dist_bitparallel, 0.000001));
    REQUIRE_THAT(Sim_original, WithinAbs(Sim_bitparallel2, 0.000001));
    REQUIRE_THAT((1.0 - Sim_original), WithinAbs(Dist_bitparallel2, 0.000001));
    return Sim_original;
}

TEST_CASE("JaroWinklerTest")
{
    std::array<std::string, 22> names = {"james",
                                         "robert",
                                         "john",
                                         "michael",
                                         "william",
                                         "david",
                                         "joseph",
                                         "thomas",
                                         "charles",
                                         "mary",
                                         "patricia",
                                         "jennifer",
                                         "linda",
                                         "elizabeth",
                                         "barbara",
                                         "susan",
                                         "jessica",
                                         "sarah",
                                         "karen",
                                         ""
                                         "aaaaaaaa",
                                         "aabaaab"};

    SECTION("testFullResultWithScoreCutoff")
    {
        auto score_cutoffs = {0.1, 0.2, 0.3, 0.4, 0.5, 0.6, 0.7, 0.8, 0.9, 1.0, 1.1};

        for (double score_cutoff : score_cutoffs)
            for (const auto& name1 : names)
                for (const auto& name2 : names)
                    jaro_winkler_sim_test(name1, name2, score_cutoff);
    }

    SECTION("testEdgeCaseLengths")
    {
        REQUIRE_THAT(jaro_winkler_sim_test(std::string(""), std::string("")), WithinAbs(1, 0.000001));
        REQUIRE_THAT(jaro_winkler_sim_test(std::string("0"), std::string("0")), WithinAbs(1, 0.000001));
        REQUIRE_THAT(jaro_winkler_sim_test(std::string("00"), std::string("00")), WithinAbs(1, 0.000001));
        REQUIRE_THAT(jaro_winkler_sim_test(std::string("0"), std::string("00")), WithinAbs(0.85, 0.000001));

        REQUIRE_THAT(
            jaro_winkler_sim_test(str_multiply(std::string("0"), 65), str_multiply(std::string("0"), 65)),
            WithinAbs(1, 0.000001));
        REQUIRE_THAT(
            jaro_winkler_sim_test(str_multiply(std::string("0"), 64), str_multiply(std::string("0"), 65)),
            WithinAbs(0.996923, 0.000001));
        REQUIRE_THAT(
            jaro_winkler_sim_test(str_multiply(std::string("0"), 63), str_multiply(std::string("0"), 65)),
            WithinAbs(0.993846, 0.000001));

        REQUIRE_THAT(jaro_winkler_sim_test(std::string("000000001"), std::string("0000010")),
                     WithinAbs(0.926984127, 0.000001));

        REQUIRE_THAT(jaro_winkler_sim_test(std::string("01"), std::string("1111100000")),
                     WithinAbs(0.53333333, 0.000001));

        REQUIRE_THAT(jaro_winkler_sim_test(
                         std::string("10000000000000000000000000000000000000000000000000000000000000020"),
                         std::string("00000000000000000000000000000000000000000000000000000000000000000")),
                     WithinAbs(0.979487, 0.000001));
        REQUIRE_THAT(
            jaro_winkler_sim_test(
                std::string("00000000000000100000000000000000000000010000000000000000000000000"),
                std::string(
                    "0000000000000000000000000000000000000000000000000000000000000000000000000000001")),
            WithinAbs(0.95334, 0.000001));
        REQUIRE_THAT(
            jaro_winkler_sim_test(
                std::string("00000000000000000000000000000000000000000000000000000000000000000"),
                std::string("0100000000000000000000000000000000000000000000000000000000000000000000000000"
                            "0000000000000000000000000000000000000000000000000000")),
            WithinAbs(0.852344, 0.000001));
    }
}