@@ -151,7 +151,7 @@ <h1>Levenshtein module<a class="headerlink" href="#levenshtein-module" title="Li
151
151
< h2 > distance< a class ="headerlink " href ="#distance " title ="Link to this heading "> </ a > </ h2 >
152
152
< dl class ="py function ">
153
153
< dt class ="sig sig-object py " id ="Levenshtein.distance ">
154
- < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> distance</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="o "> < span class ="pre "> *</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> weights</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> (1,</ span > < span class ="pre "> 1,</ span > < span class ="pre "> 1)</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_hint</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < a class ="headerlink " href ="#Levenshtein.distance " title ="Link to this definition "> </ a > </ dt >
154
+ < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> distance</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="keyword-only-separator o "> < abbr title ="Keyword-only parameters separator (PEP 3102) "> < span class ="pre "> *</ span > </ abbr > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> weights</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> (1,</ span > < span class ="pre "> 1,</ span > < span class ="pre "> 1)</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_hint</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < a class ="headerlink " href ="#Levenshtein.distance " title ="Link to this definition "> </ a > </ dt >
155
155
< dd > < p > Calculates the minimum number of insertions, deletions, and substitutions
156
156
required to change one sequence into the other according to Levenshtein with custom
157
157
costs for insertion, deletion and substitution</ p >
@@ -209,7 +209,7 @@ <h2>distance<a class="headerlink" href="#distance" title="Link to this heading">
209
209
< h2 > ratio< a class ="headerlink " href ="#ratio " title ="Link to this heading "> </ a > </ h2 >
210
210
< dl class ="py function ">
211
211
< dt class ="sig sig-object py " id ="Levenshtein.ratio ">
212
- < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> ratio</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="o "> < span class ="pre "> *</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < a class ="headerlink " href ="#Levenshtein.ratio " title ="Link to this definition "> </ a > </ dt >
212
+ < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> ratio</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="keyword-only-separator o "> < abbr title ="Keyword-only parameters separator (PEP 3102) "> < span class ="pre "> *</ span > </ abbr > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < a class ="headerlink " href ="#Levenshtein.ratio " title ="Link to this definition "> </ a > </ dt >
213
213
< dd > < p > Calculates a normalized indel similarity in the range [0, 1].
214
214
The indel distance calculates the minimum number of insertions and deletions
215
215
required to change one sequence into the other.</ p >
@@ -258,7 +258,7 @@ <h2>ratio<a class="headerlink" href="#ratio" title="Link to this heading"></a
258
258
< h2 > hamming< a class ="headerlink " href ="#hamming " title ="Link to this heading "> </ a > </ h2 >
259
259
< dl class ="py function ">
260
260
< dt class ="sig sig-object py " id ="Levenshtein.hamming ">
261
- < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> hamming</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="o "> < span class ="pre "> *</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> pad</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> True</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < a class ="headerlink " href ="#Levenshtein.hamming " title ="Link to this definition "> </ a > </ dt >
261
+ < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> hamming</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="keyword-only-separator o "> < abbr title ="Keyword-only parameters separator (PEP 3102) "> < span class ="pre "> *</ span > </ abbr > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> pad</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> True</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < a class ="headerlink " href ="#Levenshtein.hamming " title ="Link to this definition "> </ a > </ dt >
262
262
< dd > < p > Calculates the Hamming distance between two strings.
263
263
The hamming distance is defined as the number of positions
264
264
where the two strings differ. It describes the minimum
@@ -296,7 +296,7 @@ <h2>hamming<a class="headerlink" href="#hamming" title="Link to this heading">
296
296
< h2 > jaro< a class ="headerlink " href ="#jaro " title ="Link to this heading "> </ a > </ h2 >
297
297
< dl class ="py function ">
298
298
< dt class ="sig sig-object py " id ="Levenshtein.jaro ">
299
- < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> jaro</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="o "> < span class ="pre "> *</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < span class ="pre "> float</ span > </ span > </ span > < a class ="headerlink " href ="#Levenshtein.jaro " title ="Link to this definition "> </ a > </ dt >
299
+ < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> jaro</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="keyword-only-separator o "> < abbr title ="Keyword-only parameters separator (PEP 3102) "> < span class ="pre "> *</ span > </ abbr > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < span class ="pre "> float</ span > </ span > </ span > < a class ="headerlink " href ="#Levenshtein.jaro " title ="Link to this definition "> </ a > </ dt >
300
300
< dd > < p > Calculates the jaro similarity</ p >
301
301
< dl class ="field-list simple ">
302
302
< dt class ="field-odd "> Parameters< span class ="colon "> :</ span > </ dt >
@@ -324,7 +324,7 @@ <h2>jaro<a class="headerlink" href="#jaro" title="Link to this heading"></a><
324
324
< h2 > jaro_winkler< a class ="headerlink " href ="#jaro-winkler " title ="Link to this heading "> </ a > </ h2 >
325
325
< dl class ="py function ">
326
326
< dt class ="sig sig-object py " id ="Levenshtein.jaro_winkler ">
327
- < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> jaro_winkler</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="o "> < span class ="pre "> *</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> prefix_weight</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> 0.1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < span class ="pre "> float</ span > </ span > </ span > < a class ="headerlink " href ="#Levenshtein.jaro_winkler " title ="Link to this definition "> </ a > </ dt >
327
+ < span class ="sig-prename descclassname "> < span class ="pre "> Levenshtein.</ span > </ span > < span class ="sig-name descname "> < span class ="pre "> jaro_winkler</ span > </ span > < span class ="sig-paren "> (</ span > < em class ="sig-param "> < span class ="n "> < span class ="pre "> s1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> s2</ span > </ span > </ em > , < em class ="sig-param "> < span class ="keyword-only-separator o "> < abbr title ="Keyword-only parameters separator (PEP 3102) "> < span class ="pre "> *</ span > </ abbr > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> prefix_weight</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> 0.1</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> processor</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > , < em class ="sig-param "> < span class ="n "> < span class ="pre "> score_cutoff</ span > </ span > < span class ="o "> < span class ="pre "> =</ span > </ span > < span class ="default_value "> < span class ="pre "> None</ span > </ span > </ em > < span class ="sig-paren "> )</ span > < span class ="sig-return "> < span class ="sig-return-icon "> →</ span > < span class ="sig-return-typehint "> < span class ="pre "> float</ span > </ span > </ span > < a class ="headerlink " href ="#Levenshtein.jaro_winkler " title ="Link to this definition "> </ a > </ dt >
328
328
< dd > < p > Calculates the jaro winkler similarity</ p >
329
329
< dl class ="field-list simple ">
330
330
< dt class ="field-odd "> Parameters< span class ="colon "> :</ span > </ dt >
0 commit comments