From e9959aa969fae43bf5a5954ea6938081ed337ac3 Mon Sep 17 00:00:00 2001 From: Olivier Binette Date: Tue, 5 Apr 2022 17:11:04 -0400 Subject: [PATCH] update readme --- README.md | 10 +++++----- docs/README.html | 10 +++++----- docs/_sources/README.rst.txt | 10 +++++----- docs/index.html | 10 +++++----- docs/searchindex.js | 2 +- documentation/README.rst | 10 +++++----- 6 files changed, 26 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index db92bd4..ecc7978 100644 --- a/README.md +++ b/README.md @@ -17,10 +17,10 @@ The [complete API documentation](https://olivierbinette.github.io/StringCompare/ ## Installation -Install the development version from github using the following commands: +Install the released version from github using the following commands: ```bash - pip install git+https://github.com/OlivierBinette/StringCompare.git + pip install git+https://github.com/OlivierBinette/StringCompare.git@release ``` ## Project Roadmap @@ -115,9 +115,9 @@ print(tabulate(table, headers=["Package", "avg runtime (ns)"])) Package avg runtime (ns) ------------- ------------------ - StringCompare 703.727 - jellyfish 978.144 - textdistance 4139.59 + StringCompare 697.834 + jellyfish 974.363 + textdistance 3982.73 ### Performance notes diff --git a/docs/README.html b/docs/README.html index 36b21dc..532c234 100644 --- a/docs/README.html +++ b/docs/README.html @@ -94,8 +94,8 @@

⚡ StringCompare: Efficient String Comparison FunctionsThe complete API documentation is available on the project website olivierbinette.github.io/StringCompare.

Installation

-

Install the development version from github using the following commands:

-
pip install git+https://github.com/OlivierBinette/StringCompare.git
+
Install the released version from github using the following commands:

+
pip install git+https://github.com/OlivierBinette/StringCompare.git@release
@@ -190,9 +190,9 @@

Benchmark
Package          avg runtime (ns)
 -------------  ------------------
-StringCompare             703.727
-jellyfish                 978.144
-textdistance             4139.59
+StringCompare             697.834
+jellyfish                 974.363
+textdistance             3982.73
diff --git a/docs/_sources/README.rst.txt b/docs/_sources/README.rst.txt index 7a6e42a..5d94624 100644 --- a/docs/_sources/README.rst.txt +++ b/docs/_sources/README.rst.txt @@ -45,11 +45,11 @@ The `complete API documentation ⚡ StringCompare: Efficient String Comparison FunctionsThe complete API documentation is available on the project website olivierbinette.github.io/StringCompare.

Installation

-

Install the development version from github using the following commands:

-
pip install git+https://github.com/OlivierBinette/StringCompare.git
+
Install the released version from github using the following commands:

+
pip install git+https://github.com/OlivierBinette/StringCompare.git@release
@@ -177,9 +177,9 @@

Benchmark
Package          avg runtime (ns)
 -------------  ------------------
-StringCompare             703.727
-jellyfish                 978.144
-textdistance             4139.59
+StringCompare             697.834
+jellyfish                 974.363
+textdistance             3982.73
diff --git a/docs/searchindex.js b/docs/searchindex.js index 26c8707..be2ca04 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["AUTHORS","README","changelog","contributing","index","installation","source/index","source/modules","source/setup","source/stringcompare","source/stringcompare.distance","source/stringcompare.preprocessing","source/stringcompare.tokenizer","source/tests","usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["AUTHORS.rst","README.rst","changelog.rst","contributing.rst","index.rst","installation.rst","source/index.rst","source/modules.rst","source/setup.rst","source/stringcompare.rst","source/stringcompare.distance.rst","source/stringcompare.preprocessing.rst","source/stringcompare.tokenizer.rst","source/tests.rst","usage.rst"],objects:{"":[[8,0,0,"-","setup"],[9,0,0,"-","stringcompare"],[13,0,0,"-","tests"]],"stringcompare.CharacterDifference":[[9,2,1,"","compare"]],"stringcompare.Comparator":[[9,2,1,"","compare"],[9,2,1,"","elementwise"],[9,2,1,"","pairwise"]],"stringcompare.DamerauLevenshtein":[[9,2,1,"","compare"]],"stringcompare.DeepparseAddressTagger":[[9,3,1,"","LABELS"],[9,2,1,"","batch_tag"],[9,2,1,"","tag"]],"stringcompare.DelimTokenizer":[[9,2,1,"","tokenize"]],"stringcompare.Hamming":[[9,2,1,"","compare"]],"stringcompare.Jaro":[[9,2,1,"","compare"]],"stringcompare.JaroWinkler":[[9,2,1,"","compare"]],"stringcompare.LCSDistance":[[9,2,1,"","compare"]],"stringcompare.Levenshtein":[[9,2,1,"","compare"]],"stringcompare.NGramTokenizer":[[9,2,1,"","tokenize"]],"stringcompare.StringComparator":[[9,2,1,"","compare"],[9,2,1,"","elementwise"],[9,2,1,"","pairwise"]],"stringcompare.Tagger":[[9,4,1,"","LABELS"],[9,2,1,"","batch_tag"],[9,2,1,"","tag"]],"stringcompare.Tokenizer":[[9,2,1,"","batch_tokenize"],[9,2,1,"","tokenize"]],"stringcompare.distance":[[10,1,1,"","CharacterDifference"],[10,1,1,"","Comparator"],[10,1,1,"","DamerauLevenshtein"],[10,1,1,"","Hamming"],[10,1,1,"","Jaro"],[10,1,1,"","JaroWinkler"],[10,1,1,"","LCSDistance"],[10,1,1,"","Levenshtein"],[10,1,1,"","StringComparator"],[10,0,0,"-","characterdifference"],[10,0,0,"-","comparator"],[10,0,0,"-","dameraulevenshtein"],[10,0,0,"-","jaro"],[10,0,0,"-","jarowinkler"],[10,0,0,"-","lcs"],[10,0,0,"-","levenshtein"],[10,0,0,"-","monge_elkan"]],"stringcompare.distance.CharacterDifference":[[10,2,1,"","compare"]],"stringcompare.distance.Comparator":[[10,2,1,"","compare"],[10,2,1,"","elementwise"],[10,2,1,"","pairwise"]],"stringcompare.distance.DamerauLevenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.Hamming":[[10,2,1,"","compare"]],"stringcompare.distance.Jaro":[[10,2,1,"","compare"]],"stringcompare.distance.JaroWinkler":[[10,2,1,"","compare"]],"stringcompare.distance.LCSDistance":[[10,2,1,"","compare"]],"stringcompare.distance.Levenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.StringComparator":[[10,2,1,"","compare"],[10,2,1,"","elementwise"],[10,2,1,"","pairwise"]],"stringcompare.distance.characterdifference":[[10,1,1,"","CharacterDifference"]],"stringcompare.distance.characterdifference.CharacterDifference":[[10,2,1,"","compare"]],"stringcompare.distance.comparator":[[10,1,1,"","Comparator"],[10,1,1,"","NumericComparator"],[10,1,1,"","StringComparator"]],"stringcompare.distance.comparator.Comparator":[[10,2,1,"","compare"],[10,2,1,"","elementwise"],[10,2,1,"","pairwise"]],"stringcompare.distance.dameraulevenshtein":[[10,1,1,"","DamerauLevenshtein"],[10,5,1,"","dameraulevenshtein"]],"stringcompare.distance.dameraulevenshtein.DamerauLevenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.jaro":[[10,1,1,"","Jaro"],[10,5,1,"","jaro"]],"stringcompare.distance.jaro.Jaro":[[10,2,1,"","compare"]],"stringcompare.distance.jarowinkler":[[10,1,1,"","JaroWinkler"],[10,5,1,"","jarowinkler"]],"stringcompare.distance.jarowinkler.JaroWinkler":[[10,2,1,"","compare"]],"stringcompare.distance.lcs":[[10,1,1,"","LCSDistance"],[10,5,1,"","lcs"]],"stringcompare.distance.lcs.LCSDistance":[[10,2,1,"","compare"]],"stringcompare.distance.levenshtein":[[10,1,1,"","Levenshtein"],[10,5,1,"","levenshtein"]],"stringcompare.distance.levenshtein.Levenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.monge_elkan":[[10,1,1,"","MongeElkan"]],"stringcompare.distance.monge_elkan.MongeElkan":[[10,2,1,"","compare"],[10,2,1,"","monge_elkan"]],"stringcompare.preprocessing":[[11,1,1,"","DeepparseAddressTagger"],[11,1,1,"","DelimTokenizer"],[11,1,1,"","NGramTokenizer"],[11,1,1,"","Tagger"],[11,1,1,"","Tokenizer"],[11,1,1,"","WhitespaceTokenizer"],[11,0,0,"-","tagger"],[11,0,0,"-","tokenizer"]],"stringcompare.preprocessing.DeepparseAddressTagger":[[11,3,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.DelimTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.NGramTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.Tagger":[[11,4,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.Tokenizer":[[11,2,1,"","batch_tokenize"],[11,2,1,"","tokenize"]],"stringcompare.preprocessing.tagger":[[11,1,1,"","DeepparseAddressTagger"],[11,1,1,"","Tagger"]],"stringcompare.preprocessing.tagger.DeepparseAddressTagger":[[11,3,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.tagger.Tagger":[[11,4,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.tokenizer":[[11,1,1,"","DelimTokenizer"],[11,1,1,"","NGramTokenizer"],[11,1,1,"","Tokenizer"],[11,1,1,"","WhitespaceTokenizer"]],"stringcompare.preprocessing.tokenizer.DelimTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.tokenizer.NGramTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.tokenizer.Tokenizer":[[11,2,1,"","batch_tokenize"],[11,2,1,"","tokenize"]],"tests.test_characterdifference":[[13,5,1,"","random_string"],[13,5,1,"","test_CharacterDifference_FF"],[13,5,1,"","test_CharacterDifference_FT"],[13,5,1,"","test_CharacterDifference_TF"],[13,5,1,"","test_CharacterDifference_TT"],[13,5,1,"","test_CharacterDifference_dmat_size"],[13,5,1,"","test_PyCharacterDifference_FF"],[13,5,1,"","test_PyCharacterDifference_FT"],[13,5,1,"","test_PyCharacterDifference_TF"],[13,5,1,"","test_PyCharacterDifference_TT"],[13,5,1,"","test_PyCharacterDifference_dmat_size"],[13,5,1,"","test_pycpp"]],"tests.test_damerau_levenshtein":[[13,5,1,"","random_string"],[13,5,1,"","test_DamerauLevenshtein_FF"],[13,5,1,"","test_DamerauLevenshtein_FT"],[13,5,1,"","test_DamerauLevenshtein_TF"],[13,5,1,"","test_DamerauLevenshtein_TT"],[13,5,1,"","test_DamerauLevenshtein_dmat_size"],[13,5,1,"","test_PyDamerauLevenshtein_FF"],[13,5,1,"","test_PyDamerauLevenshtein_FT"],[13,5,1,"","test_PyDamerauLevenshtein_TF"],[13,5,1,"","test_PyDamerauLevenshtein_TT"],[13,5,1,"","test_PyDamerauLevenshtein_dmat_size"],[13,5,1,"","test_pycpp"]],"tests.test_jaro":[[13,5,1,"","test_jaro"],[13,5,1,"","test_pyjaro"]],"tests.test_jaro_winkler":[[13,5,1,"","test_jarowinkler"],[13,5,1,"","test_pyjarowinkler"]],"tests.test_lcs":[[13,5,1,"","random_string"],[13,5,1,"","test_LCSDistance_FF"],[13,5,1,"","test_LCSDistance_FT"],[13,5,1,"","test_LCSDistance_TF"],[13,5,1,"","test_LCSDistance_TT"],[13,5,1,"","test_LCSDistance_dmat_size"],[13,5,1,"","test_PyLCSDistance_FF"],[13,5,1,"","test_PyLCSDistance_FT"],[13,5,1,"","test_PyLCSDistance_TF"],[13,5,1,"","test_PyLCSDistance_TT"],[13,5,1,"","test_PyLCSDistance_dmat_size"],[13,5,1,"","test_pycpp"]],"tests.test_levenshtein":[[13,5,1,"","random_string"],[13,5,1,"","test_Levenshtein_FF"],[13,5,1,"","test_Levenshtein_FT"],[13,5,1,"","test_Levenshtein_TF"],[13,5,1,"","test_Levenshtein_TT"],[13,5,1,"","test_Levenshtein_dmat_size"],[13,5,1,"","test_PyLevenshtein_FF"],[13,5,1,"","test_PyLevenshtein_FT"],[13,5,1,"","test_PyLevenshtein_TF"],[13,5,1,"","test_PyLevenshtein_TT"],[13,5,1,"","test_PyLevenshtein_dmat_size"],[13,5,1,"","test_pycpp"]],stringcompare:[[9,1,1,"","CharacterDifference"],[9,1,1,"","Comparator"],[9,1,1,"","DamerauLevenshtein"],[9,1,1,"","DeepparseAddressTagger"],[9,1,1,"","DelimTokenizer"],[9,1,1,"","Hamming"],[9,1,1,"","Jaro"],[9,1,1,"","JaroWinkler"],[9,1,1,"","LCSDistance"],[9,1,1,"","Levenshtein"],[9,1,1,"","NGramTokenizer"],[9,1,1,"","StringComparator"],[9,1,1,"","Tagger"],[9,1,1,"","Tokenizer"],[9,1,1,"","WhitespaceTokenizer"],[10,0,0,"-","distance"],[11,0,0,"-","preprocessing"]],tests:[[13,0,0,"-","test_characterdifference"],[13,0,0,"-","test_damerau_levenshtein"],[13,0,0,"-","test_jaro"],[13,0,0,"-","test_jaro_winkler"],[13,0,0,"-","test_lcs"],[13,0,0,"-","test_levenshtein"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","property","Python property"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:property","5":"py:function"},terms:{"0":[1,4,9,10],"1":[1,4,9,10],"10":[1,4],"100":[9,10],"1000":[1,4],"1000000":[1,4],"11":[1,4],"14285714":[1,4],"14285714285714285":[1,4],"144":[1,4],"2":[1,4,9,10],"21":[1,4],"25":[9,10],"26666667":[1,4],"28571429":[1,4],"2x2":[9,10],"3":[1,4],"4":[1,4],"4139":[1,4],"5":[9,10],"59":[1,4],"6":[9,10],"7":[1,4],"703":[1,4],"727":[1,4],"9":[1,4],"978":[1,4],"abstract":[9,10,11],"class":[9,10,11],"default":[9,10],"export":[1,4],"float":[9,10],"function":[9,10,11],"import":[1,4,9,10,14],"long":[1,4,9,10],"new":4,"public":5,"return":[9,10],"static":[9,11],"true":[1,4,9,10],A:[9,11],For:[1,4],If:[1,3,4,5,9,11],It:[1,4,9,11],Or:5,The:[1,3,4,5,9,10,11],To:[3,5,9,11,14],__call__:[1,4],_distanc:[9,10],ab:[9,10],abc:[9,10,11],about:[1,3,4],accordingli:[9,10],activ:3,after:[1,4],algorithm:[1,4],all:3,allow:[1,4],also:[1,4],alwai:[3,5],an:[1,3,4,9,10,11],ani:3,anyth:3,api:[1,4],appreci:3,approxim:[1,4],apt:[1,4],ar:[1,3,4,9,11],arg0:[9,10],arg1:[9,10,11],arg2:[9,11],arg:10,argument:[9,11],arrai:[1,4,9,10],articl:3,assum:3,avail:[1,4],avg:[1,4],b:[3,9,10],ba:[9,10],base:[1,4,9,10,11],bash:[1,4],batch_tag:[9,11],batch_token:[9,11],been:3,befor:[1,3,4],below:[1,4],benet:[1,4],best:3,between:[1,4,9,10],binett:[0,1,4],bit:3,blog:3,branch:3,buffer:[9,10],bugfix:3,build:3,builtin:[9,11],c:[1,4,9,10,11],call:[9,10,11],can:[1,3,4,5,9,11],canada:[1,4],care:[1,4],cc:[1,4],cd:3,chang:[3,9,10],changelog:[2,3],charact:[9,10],characterdiffer:9,check:[3,9,10],check_bound:[9,10],checkout:3,cl:[9,11],classmethod:[9,11],clone:[3,5],closer:[9,10],cmp:[1,4],column:[9,10],com:[0,1,3,4,5],come:[1,4],command:[1,4,5],commit:3,common:[9,10],compar:[1,4,9],comparison:[9,10],compat:[1,4],complet:[1,4],comput:[1,4],conda:3,configur:[1,4],constructor:[9,10],contain:[1,4,9,10],contributor:4,conveni:3,convert:[9,11],copi:[3,5],correspond:[9,10],could:[1,3,4],council:[1,4],cpython:[1,4],creat:3,credit:[3,4],curl:5,current:[1,4,9,10],cxx:[1,4],damerau:[1,4,9,10],damerau_levenshtein:[1,4],damerau_levenshtein_dist:[1,4],dameraulevenshtein:[1,4,9],deal:[1,4],declar:[9,11],deepparse_handl:[9,11],deepparseaddresstagg:[9,11],def:[9,11],defin:[9,10],delet:[9,10],delim:[9,11],delimtoken:[9,11],deriv:[9,11],descript:3,detail:[1,3,4],dev:3,develop:[1,3,4],dict:[9,11],differ:[1,4,9,10,11],dimens:10,directli:[1,4],distanc:[1,4,9],dmat:10,dmat_siz:[9,10],doc:3,docker:[1,4],docstr:3,document:1,don:5,done:3,download:5,driven:3,e:[1,4,9,10,11],each:[9,10],earli:[1,4],easier:3,easili:[1,4],edit:[1,4,9,10],effici:[9,10],either:[5,9,11],element:[9,10],elementwis:[1,4,9,10],elkan:[1,4],embed:[1,4],engin:[1,4],enhanc:3,env:3,environ:[1,3,4],equal:[1,4],equival:[1,4],etc:[9,10],even:3,everi:3,exampl:[9,10],exce:[9,10],excel:[1,4],except:[1,4,9,11],explain:3,expos:[1,4],extens:[1,4],f:[3,9,11],fals:[1,4,9,10],faster:[1,4],featur:[1,4],file:3,first:[0,9,11],flake8:3,float64:[9,10],focu:[1,4],follow:[1,3,4,9,10],fork:3,framework:[1,4],from:[1,4,9,10],fun:[1,4],g:[1,4,9,10,11],gcc:[1,4],gener:[3,10],generaldeliveri:[9,11],get:4,git:[1,3,4,5],github:[1,3,4,5],given:3,gmail:0,goal:[1,4],grant:[1,4],greatli:3,guid:5,guidelin:4,ha:[1,3,4],ham:[9,10],have:[3,5],header:[1,4],help:3,here:[1,3,4],higher:[9,10],how:3,howev:[1,4],http:[1,3,4,5],hybrid:[1,4],i:[1,4],idf:[1,4],idiom:[9,11],ignor:[9,11],imag:[1,4],implement:[1,4,9,10],impli:[9,11],implicit:[9,11],includ:[2,3],index:[4,6],indic:10,individu:[1,4],inform:[1,4],insert:[9,10],inspir:[1,4],instal:3,instanc:[9,11],instanci:[1,4],instead:[9,10],interact:[1,4],interfac:[1,4,9,11],intern:[9,10],io:[1,4],issu:[1,3,4],item:[1,4],its:[1,4,9,11],jaro:[1,4,9],jarowinkl:[1,4,9],java:[9,11],jellyfish:[1,4],just:[3,9,11],keep:3,kei:[1,4],kwd:10,l1:10,l2:10,label:[9,11],lambda:[1,4],launch:[1,4],lc:9,lcsdistanc:[1,4,9,10],lead:4,learn:[1,4],len:10,length:[9,10],lev:[1,4,9,10],level:10,levenshtein:[1,4,9],librari:[1,4],like:[1,4,9,11],linux:[1,4],list:[1,3,4,9,10,11],littl:[1,3,4],local:3,longest:[9,10],look:3,lsh:[1,4],m:3,macro:3,made:[1,4],mai:[9,10],maintain:[1,4],make:3,makefil:3,mani:3,master:5,match:[1,4],matrix:10,maxim:[9,10],maximum:[9,10],md:3,meet:3,memori:[1,4],method:[1,4,5,9,11],metric:[1,4],might:[1,3,4],minimum:[9,10],mkvirtualenv:3,modul:[4,6,7,9],mong:[1,4],mongeelkan:10,more:[1,3,4,9,10],most:[1,4,5],much:[1,4],municip:[9,11],my:[1,4],n:[9,11,13],name:[1,3,4],narrow:3,natur:[1,4],ndarrai:[9,10],necessarili:10,ngramtoken:[9,11],none:0,normal:[1,4,9,10],now:3,ns:[1,4],nserc:[1,4],number:[1,4,9,10],numer:[9,10],numericcompar:[9,10],numpi:[1,4,9,10],obj:[9,11],object:[1,4,9,10,11],offici:3,oilvier:[1,4,9,10],ojl:5,oliv:[1,4],olivi:[0,1,4,9,10],olivia:[1,4],olivierbinett:[1,3,4,5],onc:5,one:[9,10],open:3,oper:3,optim:[1,4],orient:[9,11],origin:3,other:[1,3,4,9,10],overhead:[1,4],p:10,packag:[1,3,4,6,7],page:[1,4,6,9,10],pairwis:[1,4,9,10],paramet:[9,10],part:3,pass:[3,9,11],pip:[1,3,4,5],place:[1,4],pleas:[1,3,4],possibl:[1,3,4],post:3,postalcod:[9,11],prefer:5,preprocess:[6,7,9,10],print:[1,4],process:5,project:[3,14],properti:[9,11],propos:3,provid:[1,3,4,9,10],provinc:[9,11],pull:4,push:3,py:[3,5],py_stringmatch:[1,4],pybind11:[1,4,5,9,10],pybind11_builtin:[9,10],pybind11_object:[9,10],pycach:3,pytest:3,python:[1,3,4,5],r:[1,4],random_str:13,re:[1,3,4],readi:3,readm:3,receiv:[9,11],recent:5,recommend:[1,4],releas:4,rememb:3,repo:[3,5],report:[1,4],repositori:5,reproduc:3,request:4,requir:[9,10],research:[1,4],resiz:[9,10],result:[9,10],row:[9,10],rst:[2,3],rule:3,run:[1,4,5],runtim:[1,4],s:[3,10],safeti:[9,10],same:[1,4,9,10],scienc:[1,4],scope:3,score:[9,10],search:[4,6],see:[1,4,9,10,11],self:[9,10],semant:3,send:3,sentenc:[9,11],session:[1,4],set:[3,9,10],setup:[3,5],setuptool:5,should:[3,9,10],similar:[1,4,9,10],singl:[9,10],size:[9,10],small:[1,4],some:[1,4],sourc:[9,10,11,13],speed:[1,4],sponsor:[1,4],stage:[1,4],start:4,staticmethod:[9,11],statu:[1,4],step:3,str:[9,10],streetnam:[9,11],streetnumb:[9,11],string:[9,10,11],stringcompar:[5,14],stringdist:[1,4],structur:[9,10],submodul:[6,7,9],subpackag:[4,6,7],subsequ:[9,10],substitut:[9,10],sudo:[1,4],support:[1,4],symmetr:10,system:3,t:[5,10],tabl:1,tabul:[1,4],tag:[3,9,11],tagger:[6,7,9],take:[1,4],tarbal:5,termin:5,test:3,test_characterdifference_dmat_s:13,test_characterdifference_ff:13,test_characterdifference_ft:13,test_characterdifference_tf:13,test_characterdifference_tt:13,test_dameraulevenshtein_dmat_s:13,test_dameraulevenshtein_ff:13,test_dameraulevenshtein_ft:13,test_dameraulevenshtein_tf:13,test_dameraulevenshtein_tt:13,test_jarowinkl:13,test_lcsdistance_dmat_s:13,test_lcsdistance_ff:13,test_lcsdistance_ft:13,test_lcsdistance_tf:13,test_lcsdistance_tt:13,test_levenshtein_dmat_s:13,test_levenshtein_ff:13,test_levenshtein_ft:13,test_levenshtein_tf:13,test_levenshtein_tt:13,test_pycharacterdifference_dmat_s:13,test_pycharacterdifference_ff:13,test_pycharacterdifference_ft:13,test_pycharacterdifference_tf:13,test_pycharacterdifference_tt:13,test_pycpp:13,test_pydameraulevenshtein_dmat_s:13,test_pydameraulevenshtein_ff:13,test_pydameraulevenshtein_ft:13,test_pydameraulevenshtein_tf:13,test_pydameraulevenshtein_tt:13,test_pyjaro:13,test_pyjarowinkl:13,test_pylcsdistance_dmat_s:13,test_pylcsdistance_ff:13,test_pylcsdistance_ft:13,test_pylcsdistance_tf:13,test_pylcsdistance_tt:13,test_pylevenshtein_dmat_s:13,test_pylevenshtein_ff:13,test_pylevenshtein_ft:13,test_pylevenshtein_tf:13,test_pylevenshtein_tt:13,textdist:[1,4],tf:[1,4],than:[1,4,9,10,11],thank:[1,4],thei:3,them:3,thi:[1,3,4,5,9,10,11],those:[9,11],through:[1,3,4,5],timeit:[1,4],tip:4,token:[1,4,6,7,9,10],tox:3,transposit:[9,10],tree:[1,4],troubleshoot:3,two:[9,10],type:4,ubuntu:[1,4],under:3,unit:[9,11],unreleas:3,unsuccess:[1,4],up:3,updat:3,us:[1,3,4,9,11,14],valu:[9,10],version:[1,4],virtualenv:3,virtualenvwrapp:3,vocabulari:[1,4],volunt:3,wai:3,want:[1,3,4,9,11],we:[1,4],web:3,websit:[1,3,4],weight:[9,10],welcom:[1,3,4],wheel:5,when:[1,3,4],where:[9,10],whether:[3,9,10],which:[1,4,9,10],whitespacetoken:[9,10,11],whoever:3,why:0,wikipedia:[9,10],winkler:[1,4,9,10],within:[1,4],word:[9,10],work:3,worri:[1,4],would:[1,3,4],wrapper:[1,4],xlen:10,yet:0,yml:3,you:[1,3,4,5,9,11],your:[1,3,4,5],your_name_her:3,zero:[9,10]},titles:["Credits","\u26a1 StringCompare: Efficient String Comparison Functions","<no title>","Contributing","\u26a1 StringCompare: Efficient String Comparison Functions","Installation","Welcome to stringcompare\u2019s documentation!","stringcompare","setup module","stringcompare package","stringcompare.distance package","stringcompare.preprocessing package","stringcompare.tokenizer package","tests package","Usage"],titleterms:{"function":[1,4],"new":3,acknowledg:[1,4],benchmark:[1,4],bug:[1,3,4],characterdiffer:10,compar:10,comparison:[1,4],content:[4,6,12,13],contribut:[1,3,4],contributor:0,credit:0,dameraulevenshtein:10,develop:[0,5],distanc:10,document:[3,4,6],effici:[1,4],exampl:[1,4],featur:3,feedback:3,fix:3,from:5,get:3,guidelin:3,implement:3,indic:[4,6],instal:[1,4,5],jaro:10,jarowinkl:10,known:[1,4],lc:10,lead:0,levenshtein:10,link:4,modul:[8,10,11,12,13],monge_elkan:10,note:[1,4],packag:[9,10,11,12,13],perform:[1,4],preprocess:11,project:[1,4],pull:3,releas:3,report:3,request:3,roadmap:[1,4],s:6,setup:8,sourc:5,start:3,string:[1,4],stringcompar:[1,4,6,7,9,10,11,12],submit:3,submodul:[10,11,12,13],subpackag:9,tabl:[4,6],tagger:11,test:13,test_characterdiffer:13,test_damerau_levenshtein:13,test_jaro:13,test_jaro_winkl:13,test_lc:13,test_levenshtein:13,tip:3,token:[11,12],type:3,usag:14,version:[3,5],welcom:6,write:3}}) \ No newline at end of file +Search.setIndex({docnames:["AUTHORS","README","changelog","contributing","index","installation","source/index","source/modules","source/setup","source/stringcompare","source/stringcompare.distance","source/stringcompare.preprocessing","source/stringcompare.tokenizer","source/tests","usage"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":4,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":3,"sphinx.domains.rst":2,"sphinx.domains.std":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["AUTHORS.rst","README.rst","changelog.rst","contributing.rst","index.rst","installation.rst","source/index.rst","source/modules.rst","source/setup.rst","source/stringcompare.rst","source/stringcompare.distance.rst","source/stringcompare.preprocessing.rst","source/stringcompare.tokenizer.rst","source/tests.rst","usage.rst"],objects:{"":[[8,0,0,"-","setup"],[9,0,0,"-","stringcompare"],[13,0,0,"-","tests"]],"stringcompare.CharacterDifference":[[9,2,1,"","compare"]],"stringcompare.Comparator":[[9,2,1,"","compare"],[9,2,1,"","elementwise"],[9,2,1,"","pairwise"]],"stringcompare.DamerauLevenshtein":[[9,2,1,"","compare"]],"stringcompare.DeepparseAddressTagger":[[9,3,1,"","LABELS"],[9,2,1,"","batch_tag"],[9,2,1,"","tag"]],"stringcompare.DelimTokenizer":[[9,2,1,"","tokenize"]],"stringcompare.Hamming":[[9,2,1,"","compare"]],"stringcompare.Jaro":[[9,2,1,"","compare"]],"stringcompare.JaroWinkler":[[9,2,1,"","compare"]],"stringcompare.LCSDistance":[[9,2,1,"","compare"]],"stringcompare.Levenshtein":[[9,2,1,"","compare"]],"stringcompare.NGramTokenizer":[[9,2,1,"","tokenize"]],"stringcompare.StringComparator":[[9,2,1,"","compare"],[9,2,1,"","elementwise"],[9,2,1,"","pairwise"]],"stringcompare.Tagger":[[9,4,1,"","LABELS"],[9,2,1,"","batch_tag"],[9,2,1,"","tag"]],"stringcompare.Tokenizer":[[9,2,1,"","batch_tokenize"],[9,2,1,"","tokenize"]],"stringcompare.distance":[[10,1,1,"","CharacterDifference"],[10,1,1,"","Comparator"],[10,1,1,"","DamerauLevenshtein"],[10,1,1,"","Hamming"],[10,1,1,"","Jaro"],[10,1,1,"","JaroWinkler"],[10,1,1,"","LCSDistance"],[10,1,1,"","Levenshtein"],[10,1,1,"","StringComparator"],[10,0,0,"-","characterdifference"],[10,0,0,"-","comparator"],[10,0,0,"-","dameraulevenshtein"],[10,0,0,"-","jaro"],[10,0,0,"-","jarowinkler"],[10,0,0,"-","lcs"],[10,0,0,"-","levenshtein"],[10,0,0,"-","monge_elkan"]],"stringcompare.distance.CharacterDifference":[[10,2,1,"","compare"]],"stringcompare.distance.Comparator":[[10,2,1,"","compare"],[10,2,1,"","elementwise"],[10,2,1,"","pairwise"]],"stringcompare.distance.DamerauLevenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.Hamming":[[10,2,1,"","compare"]],"stringcompare.distance.Jaro":[[10,2,1,"","compare"]],"stringcompare.distance.JaroWinkler":[[10,2,1,"","compare"]],"stringcompare.distance.LCSDistance":[[10,2,1,"","compare"]],"stringcompare.distance.Levenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.StringComparator":[[10,2,1,"","compare"],[10,2,1,"","elementwise"],[10,2,1,"","pairwise"]],"stringcompare.distance.characterdifference":[[10,1,1,"","CharacterDifference"]],"stringcompare.distance.characterdifference.CharacterDifference":[[10,2,1,"","compare"]],"stringcompare.distance.comparator":[[10,1,1,"","Comparator"],[10,1,1,"","NumericComparator"],[10,1,1,"","StringComparator"]],"stringcompare.distance.comparator.Comparator":[[10,2,1,"","compare"],[10,2,1,"","elementwise"],[10,2,1,"","pairwise"]],"stringcompare.distance.dameraulevenshtein":[[10,1,1,"","DamerauLevenshtein"],[10,5,1,"","dameraulevenshtein"]],"stringcompare.distance.dameraulevenshtein.DamerauLevenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.jaro":[[10,1,1,"","Jaro"],[10,5,1,"","jaro"]],"stringcompare.distance.jaro.Jaro":[[10,2,1,"","compare"]],"stringcompare.distance.jarowinkler":[[10,1,1,"","JaroWinkler"],[10,5,1,"","jarowinkler"]],"stringcompare.distance.jarowinkler.JaroWinkler":[[10,2,1,"","compare"]],"stringcompare.distance.lcs":[[10,1,1,"","LCSDistance"],[10,5,1,"","lcs"]],"stringcompare.distance.lcs.LCSDistance":[[10,2,1,"","compare"]],"stringcompare.distance.levenshtein":[[10,1,1,"","Levenshtein"],[10,5,1,"","levenshtein"]],"stringcompare.distance.levenshtein.Levenshtein":[[10,2,1,"","compare"]],"stringcompare.distance.monge_elkan":[[10,1,1,"","MongeElkan"]],"stringcompare.distance.monge_elkan.MongeElkan":[[10,2,1,"","compare"],[10,2,1,"","monge_elkan"]],"stringcompare.preprocessing":[[11,1,1,"","DeepparseAddressTagger"],[11,1,1,"","DelimTokenizer"],[11,1,1,"","NGramTokenizer"],[11,1,1,"","Tagger"],[11,1,1,"","Tokenizer"],[11,1,1,"","WhitespaceTokenizer"],[11,0,0,"-","tagger"],[11,0,0,"-","tokenizer"]],"stringcompare.preprocessing.DeepparseAddressTagger":[[11,3,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.DelimTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.NGramTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.Tagger":[[11,4,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.Tokenizer":[[11,2,1,"","batch_tokenize"],[11,2,1,"","tokenize"]],"stringcompare.preprocessing.tagger":[[11,1,1,"","DeepparseAddressTagger"],[11,1,1,"","Tagger"]],"stringcompare.preprocessing.tagger.DeepparseAddressTagger":[[11,3,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.tagger.Tagger":[[11,4,1,"","LABELS"],[11,2,1,"","batch_tag"],[11,2,1,"","tag"]],"stringcompare.preprocessing.tokenizer":[[11,1,1,"","DelimTokenizer"],[11,1,1,"","NGramTokenizer"],[11,1,1,"","Tokenizer"],[11,1,1,"","WhitespaceTokenizer"]],"stringcompare.preprocessing.tokenizer.DelimTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.tokenizer.NGramTokenizer":[[11,2,1,"","tokenize"]],"stringcompare.preprocessing.tokenizer.Tokenizer":[[11,2,1,"","batch_tokenize"],[11,2,1,"","tokenize"]],"tests.test_characterdifference":[[13,5,1,"","random_string"],[13,5,1,"","test_CharacterDifference_FF"],[13,5,1,"","test_CharacterDifference_FT"],[13,5,1,"","test_CharacterDifference_TF"],[13,5,1,"","test_CharacterDifference_TT"],[13,5,1,"","test_CharacterDifference_dmat_size"],[13,5,1,"","test_PyCharacterDifference_FF"],[13,5,1,"","test_PyCharacterDifference_FT"],[13,5,1,"","test_PyCharacterDifference_TF"],[13,5,1,"","test_PyCharacterDifference_TT"],[13,5,1,"","test_PyCharacterDifference_dmat_size"],[13,5,1,"","test_pycpp"]],"tests.test_damerau_levenshtein":[[13,5,1,"","random_string"],[13,5,1,"","test_DamerauLevenshtein_FF"],[13,5,1,"","test_DamerauLevenshtein_FT"],[13,5,1,"","test_DamerauLevenshtein_TF"],[13,5,1,"","test_DamerauLevenshtein_TT"],[13,5,1,"","test_DamerauLevenshtein_dmat_size"],[13,5,1,"","test_PyDamerauLevenshtein_FF"],[13,5,1,"","test_PyDamerauLevenshtein_FT"],[13,5,1,"","test_PyDamerauLevenshtein_TF"],[13,5,1,"","test_PyDamerauLevenshtein_TT"],[13,5,1,"","test_PyDamerauLevenshtein_dmat_size"],[13,5,1,"","test_pycpp"]],"tests.test_jaro":[[13,5,1,"","test_jaro"],[13,5,1,"","test_pyjaro"]],"tests.test_jaro_winkler":[[13,5,1,"","test_jarowinkler"],[13,5,1,"","test_pyjarowinkler"]],"tests.test_lcs":[[13,5,1,"","random_string"],[13,5,1,"","test_LCSDistance_FF"],[13,5,1,"","test_LCSDistance_FT"],[13,5,1,"","test_LCSDistance_TF"],[13,5,1,"","test_LCSDistance_TT"],[13,5,1,"","test_LCSDistance_dmat_size"],[13,5,1,"","test_PyLCSDistance_FF"],[13,5,1,"","test_PyLCSDistance_FT"],[13,5,1,"","test_PyLCSDistance_TF"],[13,5,1,"","test_PyLCSDistance_TT"],[13,5,1,"","test_PyLCSDistance_dmat_size"],[13,5,1,"","test_pycpp"]],"tests.test_levenshtein":[[13,5,1,"","random_string"],[13,5,1,"","test_Levenshtein_FF"],[13,5,1,"","test_Levenshtein_FT"],[13,5,1,"","test_Levenshtein_TF"],[13,5,1,"","test_Levenshtein_TT"],[13,5,1,"","test_Levenshtein_dmat_size"],[13,5,1,"","test_PyLevenshtein_FF"],[13,5,1,"","test_PyLevenshtein_FT"],[13,5,1,"","test_PyLevenshtein_TF"],[13,5,1,"","test_PyLevenshtein_TT"],[13,5,1,"","test_PyLevenshtein_dmat_size"],[13,5,1,"","test_pycpp"]],stringcompare:[[9,1,1,"","CharacterDifference"],[9,1,1,"","Comparator"],[9,1,1,"","DamerauLevenshtein"],[9,1,1,"","DeepparseAddressTagger"],[9,1,1,"","DelimTokenizer"],[9,1,1,"","Hamming"],[9,1,1,"","Jaro"],[9,1,1,"","JaroWinkler"],[9,1,1,"","LCSDistance"],[9,1,1,"","Levenshtein"],[9,1,1,"","NGramTokenizer"],[9,1,1,"","StringComparator"],[9,1,1,"","Tagger"],[9,1,1,"","Tokenizer"],[9,1,1,"","WhitespaceTokenizer"],[10,0,0,"-","distance"],[11,0,0,"-","preprocessing"]],tests:[[13,0,0,"-","test_characterdifference"],[13,0,0,"-","test_damerau_levenshtein"],[13,0,0,"-","test_jaro"],[13,0,0,"-","test_jaro_winkler"],[13,0,0,"-","test_lcs"],[13,0,0,"-","test_levenshtein"]]},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","property","Python property"],"5":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:property","5":"py:function"},terms:{"0":[1,4,9,10],"1":[1,4,9,10],"10":[1,4],"100":[9,10],"1000":[1,4],"1000000":[1,4],"11":[1,4],"14285714":[1,4],"14285714285714285":[1,4],"2":[1,4,9,10],"21":[1,4],"25":[9,10],"26666667":[1,4],"28571429":[1,4],"2x2":[9,10],"3":[1,4],"363":[1,4],"3982":[1,4],"4":[1,4],"5":[9,10],"6":[9,10],"697":[1,4],"7":[1,4],"73":[1,4],"834":[1,4],"9":[1,4],"974":[1,4],"abstract":[9,10,11],"class":[9,10,11],"default":[9,10],"export":[1,4],"float":[9,10],"function":[9,10,11],"import":[1,4,9,10,14],"long":[1,4,9,10],"new":4,"public":5,"return":[9,10],"static":[9,11],"true":[1,4,9,10],A:[9,11],For:[1,4],If:[1,3,4,5,9,11],It:[1,4,9,11],Or:5,The:[1,3,4,5,9,10,11],To:[3,5,9,11,14],__call__:[1,4],_distanc:[9,10],ab:[9,10],abc:[9,10,11],about:[1,3,4],accordingli:[9,10],activ:3,after:[1,4],algorithm:[1,4],all:3,allow:[1,4],also:[1,4],alwai:[3,5],an:[1,3,4,9,10,11],ani:3,anyth:3,api:[1,4],appreci:3,approxim:[1,4],apt:[1,4],ar:[1,3,4,9,11],arg0:[9,10],arg1:[9,10,11],arg2:[9,11],arg:10,argument:[9,11],arrai:[1,4,9,10],articl:3,assum:3,avail:[1,4],avg:[1,4],b:[3,9,10],ba:[9,10],base:[1,4,9,10,11],bash:[1,4],batch_tag:[9,11],batch_token:[9,11],been:3,befor:[1,3,4],below:[1,4],benet:[1,4],best:3,between:[1,4,9,10],binett:[0,1,4],bit:3,blog:3,branch:3,buffer:[9,10],bugfix:3,build:3,builtin:[9,11],c:[1,4,9,10,11],call:[9,10,11],can:[1,3,4,5,9,11],canada:[1,4],care:[1,4],cc:[1,4],cd:3,chang:[3,9,10],changelog:[2,3],charact:[9,10],characterdiffer:9,check:[3,9,10],check_bound:[9,10],checkout:3,cl:[9,11],classmethod:[9,11],clone:[3,5],closer:[9,10],cmp:[1,4],column:[9,10],com:[0,1,3,4,5],come:[1,4],command:[1,4,5],commit:3,common:[9,10],compar:[1,4,9],comparison:[9,10],compat:[1,4],complet:[1,4],comput:[1,4],conda:3,configur:[1,4],constructor:[9,10],contain:[1,4,9,10],contributor:4,conveni:3,convert:[9,11],copi:[3,5],correspond:[9,10],could:[1,3,4],council:[1,4],cpython:[1,4],creat:3,credit:[3,4],curl:5,current:[1,4,9,10],cxx:[1,4],damerau:[1,4,9,10],damerau_levenshtein:[1,4],damerau_levenshtein_dist:[1,4],dameraulevenshtein:[1,4,9],deal:[1,4],declar:[9,11],deepparse_handl:[9,11],deepparseaddresstagg:[9,11],def:[9,11],defin:[9,10],delet:[9,10],delim:[9,11],delimtoken:[9,11],deriv:[9,11],descript:3,detail:[1,3,4],dev:3,develop:[1,3,4],dict:[9,11],differ:[1,4,9,10,11],dimens:10,directli:[1,4],distanc:[1,4,9],dmat:10,dmat_siz:[9,10],doc:3,docker:[1,4],docstr:3,document:1,don:5,done:3,download:5,driven:3,e:[1,4,9,10,11],each:[9,10],earli:[1,4],easier:3,easili:[1,4],edit:[1,4,9,10],effici:[9,10],either:[5,9,11],element:[9,10],elementwis:[1,4,9,10],elkan:[1,4],embed:[1,4],engin:[1,4],enhanc:3,env:3,environ:[1,3,4],equal:[1,4],equival:[1,4],etc:[9,10],even:3,everi:3,exampl:[9,10],exce:[9,10],excel:[1,4],except:[1,4,9,11],explain:3,expos:[1,4],extens:[1,4],f:[3,9,11],fals:[1,4,9,10],faster:[1,4],featur:[1,4],file:3,first:[0,9,11],flake8:3,float64:[9,10],focu:[1,4],follow:[1,3,4,9,10],fork:3,framework:[1,4],from:[1,4,9,10],fun:[1,4],g:[1,4,9,10,11],gcc:[1,4],gener:[3,10],generaldeliveri:[9,11],get:4,git:[1,3,4,5],github:[1,3,4,5],given:3,gmail:0,goal:[1,4],grant:[1,4],greatli:3,guid:5,guidelin:4,ha:[1,3,4],ham:[9,10],have:[3,5],header:[1,4],help:3,here:[1,3,4],higher:[9,10],how:3,howev:[1,4],http:[1,3,4,5],hybrid:[1,4],i:[1,4],idf:[1,4],idiom:[9,11],ignor:[9,11],imag:[1,4],implement:[1,4,9,10],impli:[9,11],implicit:[9,11],includ:[2,3],index:[4,6],indic:10,individu:[1,4],inform:[1,4],insert:[9,10],inspir:[1,4],instal:3,instanc:[9,11],instanci:[1,4],instead:[9,10],interact:[1,4],interfac:[1,4,9,11],intern:[9,10],io:[1,4],issu:[1,3,4],item:[1,4],its:[1,4,9,11],jaro:[1,4,9],jarowinkl:[1,4,9],java:[9,11],jellyfish:[1,4],just:[3,9,11],keep:3,kei:[1,4],kwd:10,l1:10,l2:10,label:[9,11],lambda:[1,4],launch:[1,4],lc:9,lcsdistanc:[1,4,9,10],lead:4,learn:[1,4],len:10,length:[9,10],lev:[1,4,9,10],level:10,levenshtein:[1,4,9],librari:[1,4],like:[1,4,9,11],linux:[1,4],list:[1,3,4,9,10,11],littl:[1,3,4],local:3,longest:[9,10],look:3,lsh:[1,4],m:3,macro:3,made:[1,4],mai:[9,10],maintain:[1,4],make:3,makefil:3,mani:3,master:5,match:[1,4],matrix:10,maxim:[9,10],maximum:[9,10],md:3,meet:3,memori:[1,4],method:[1,4,5,9,11],metric:[1,4],might:[1,3,4],minimum:[9,10],mkvirtualenv:3,modul:[4,6,7,9],mong:[1,4],mongeelkan:10,more:[1,3,4,9,10],most:[1,4,5],much:[1,4],municip:[9,11],my:[1,4],n:[9,11,13],name:[1,3,4],narrow:3,natur:[1,4],ndarrai:[9,10],necessarili:10,ngramtoken:[9,11],none:0,normal:[1,4,9,10],now:3,ns:[1,4],nserc:[1,4],number:[1,4,9,10],numer:[9,10],numericcompar:[9,10],numpi:[1,4,9,10],obj:[9,11],object:[1,4,9,10,11],offici:3,oilvier:[1,4,9,10],ojl:5,oliv:[1,4],olivi:[0,1,4,9,10],olivia:[1,4],olivierbinett:[1,3,4,5],onc:5,one:[9,10],open:3,oper:3,optim:[1,4],orient:[9,11],origin:3,other:[1,3,4,9,10],overhead:[1,4],p:10,packag:[1,3,4,6,7],page:[1,4,6,9,10],pairwis:[1,4,9,10],paramet:[9,10],part:3,pass:[3,9,11],pip:[1,3,4,5],place:[1,4],pleas:[1,3,4],possibl:[1,3,4],post:3,postalcod:[9,11],prefer:5,preprocess:[6,7,9,10],print:[1,4],process:5,project:[3,14],properti:[9,11],propos:3,provid:[1,3,4,9,10],provinc:[9,11],pull:4,push:3,py:[3,5],py_stringmatch:[1,4],pybind11:[1,4,5,9,10],pybind11_builtin:[9,10],pybind11_object:[9,10],pycach:3,pytest:3,python:[1,3,4,5],r:[1,4],random_str:13,re:[1,3,4],readi:3,readm:3,receiv:[9,11],recent:5,recommend:[1,4],releas:[1,4],rememb:3,repo:[3,5],report:[1,4],repositori:5,reproduc:3,request:4,requir:[9,10],research:[1,4],resiz:[9,10],result:[9,10],row:[9,10],rst:[2,3],rule:3,run:[1,4,5],runtim:[1,4],s:[3,10],safeti:[9,10],same:[1,4,9,10],scienc:[1,4],scope:3,score:[9,10],search:[4,6],see:[1,4,9,10,11],self:[9,10],semant:3,send:3,sentenc:[9,11],session:[1,4],set:[3,9,10],setup:[3,5],setuptool:5,should:[3,9,10],similar:[1,4,9,10],singl:[9,10],size:[9,10],small:[1,4],some:[1,4],sourc:[9,10,11,13],speed:[1,4],sponsor:[1,4],stage:[1,4],start:4,staticmethod:[9,11],statu:[1,4],step:3,str:[9,10],streetnam:[9,11],streetnumb:[9,11],string:[9,10,11],stringcompar:[5,14],stringdist:[1,4],structur:[9,10],submodul:[6,7,9],subpackag:[4,6,7],subsequ:[9,10],substitut:[9,10],sudo:[1,4],support:[1,4],symmetr:10,system:3,t:[5,10],tabl:1,tabul:[1,4],tag:[3,9,11],tagger:[6,7,9],take:[1,4],tarbal:5,termin:5,test:3,test_characterdifference_dmat_s:13,test_characterdifference_ff:13,test_characterdifference_ft:13,test_characterdifference_tf:13,test_characterdifference_tt:13,test_dameraulevenshtein_dmat_s:13,test_dameraulevenshtein_ff:13,test_dameraulevenshtein_ft:13,test_dameraulevenshtein_tf:13,test_dameraulevenshtein_tt:13,test_jarowinkl:13,test_lcsdistance_dmat_s:13,test_lcsdistance_ff:13,test_lcsdistance_ft:13,test_lcsdistance_tf:13,test_lcsdistance_tt:13,test_levenshtein_dmat_s:13,test_levenshtein_ff:13,test_levenshtein_ft:13,test_levenshtein_tf:13,test_levenshtein_tt:13,test_pycharacterdifference_dmat_s:13,test_pycharacterdifference_ff:13,test_pycharacterdifference_ft:13,test_pycharacterdifference_tf:13,test_pycharacterdifference_tt:13,test_pycpp:13,test_pydameraulevenshtein_dmat_s:13,test_pydameraulevenshtein_ff:13,test_pydameraulevenshtein_ft:13,test_pydameraulevenshtein_tf:13,test_pydameraulevenshtein_tt:13,test_pyjaro:13,test_pyjarowinkl:13,test_pylcsdistance_dmat_s:13,test_pylcsdistance_ff:13,test_pylcsdistance_ft:13,test_pylcsdistance_tf:13,test_pylcsdistance_tt:13,test_pylevenshtein_dmat_s:13,test_pylevenshtein_ff:13,test_pylevenshtein_ft:13,test_pylevenshtein_tf:13,test_pylevenshtein_tt:13,textdist:[1,4],tf:[1,4],than:[1,4,9,10,11],thank:[1,4],thei:3,them:3,thi:[1,3,4,5,9,10,11],those:[9,11],through:[1,3,4,5],timeit:[1,4],tip:4,token:[1,4,6,7,9,10],tox:3,transposit:[9,10],tree:[1,4],troubleshoot:3,two:[9,10],type:4,ubuntu:[1,4],under:3,unit:[9,11],unreleas:3,unsuccess:[1,4],up:3,updat:3,us:[1,3,4,9,11,14],valu:[9,10],version:[1,4],virtualenv:3,virtualenvwrapp:3,vocabulari:[1,4],volunt:3,wai:3,want:[1,3,4,9,11],we:[1,4],web:3,websit:[1,3,4],weight:[9,10],welcom:[1,3,4],wheel:5,when:[1,3,4],where:[9,10],whether:[3,9,10],which:[1,4,9,10],whitespacetoken:[9,10,11],whoever:3,why:0,wikipedia:[9,10],winkler:[1,4,9,10],within:[1,4],word:[9,10],work:3,worri:[1,4],would:[1,3,4],wrapper:[1,4],xlen:10,yet:0,yml:3,you:[1,3,4,5,9,11],your:[1,3,4,5],your_name_her:3,zero:[9,10]},titles:["Credits","\u26a1 StringCompare: Efficient String Comparison Functions","<no title>","Contributing","\u26a1 StringCompare: Efficient String Comparison Functions","Installation","Welcome to stringcompare\u2019s documentation!","stringcompare","setup module","stringcompare package","stringcompare.distance package","stringcompare.preprocessing package","stringcompare.tokenizer package","tests package","Usage"],titleterms:{"function":[1,4],"new":3,acknowledg:[1,4],benchmark:[1,4],bug:[1,3,4],characterdiffer:10,compar:10,comparison:[1,4],content:[4,6,12,13],contribut:[1,3,4],contributor:0,credit:0,dameraulevenshtein:10,develop:[0,5],distanc:10,document:[3,4,6],effici:[1,4],exampl:[1,4],featur:3,feedback:3,fix:3,from:5,get:3,guidelin:3,implement:3,indic:[4,6],instal:[1,4,5],jaro:10,jarowinkl:10,known:[1,4],lc:10,lead:0,levenshtein:10,link:4,modul:[8,10,11,12,13],monge_elkan:10,note:[1,4],packag:[9,10,11,12,13],perform:[1,4],preprocess:11,project:[1,4],pull:3,releas:3,report:3,request:3,roadmap:[1,4],s:6,setup:8,sourc:5,start:3,string:[1,4],stringcompar:[1,4,6,7,9,10,11,12],submit:3,submodul:[10,11,12,13],subpackag:9,tabl:[4,6],tagger:11,test:13,test_characterdiffer:13,test_damerau_levenshtein:13,test_jaro:13,test_jaro_winkl:13,test_lc:13,test_levenshtein:13,tip:3,token:[11,12],type:3,usag:14,version:[3,5],welcom:6,write:3}}) \ No newline at end of file diff --git a/documentation/README.rst b/documentation/README.rst index 7a6e42a..5d94624 100644 --- a/documentation/README.rst +++ b/documentation/README.rst @@ -45,11 +45,11 @@ The `complete API documentation