var searchIndex = {};
searchIndex["hyphenation"] = {"doc":"","items":[[0,"exception","hyphenation","Data structures and methods for parsing and applying exceptions, which\nassign predetermined scores to specific words.",null,null],[3,"Exceptions","hyphenation::exception","A specialized hash map of pattern-score pairs.",null,null],[12,"0","","",0,null],[11,"fmt","","",0,null],[11,"clone","","",0,null],[11,"empty","","Creates an empty `Exceptions` map.",0,{"inputs":[],"output":{"name":"exceptions"}}],[11,"insert","","Inserts a Knuth-Liang exception pair into the map.",0,null],[11,"score","","Retrieves the score for each hyphenation point of `word`.",0,null],[0,"hyphenator","hyphenation","Hyphenating iterators.",null,null],[3,"Standard","hyphenation::hyphenator","The `Standard` hyphenator iterates over a string, returning slices\ndelimited by string boundaries and valid hyphenation points.",null,null],[8,"Hyphenation","","",null,null],[10,"opportunities","","Returns the indices of valid hyphenation points within the text.",1,null],[10,"hyphenate","","Returns an iterator over segments of the text separated by valid\nhyphenation points.",1,null],[11,"fmt","","",2,null],[11,"clone","","",2,null],[11,"punctuate","","Inserts a soft hyphen at hyphenation points.",2,null],[11,"punctuate_with","","Inserts a given string at hyphenation points.",2,null],[11,"next","","",2,null],[0,"language","hyphenation","Languages we can hyphenate and their default parameters, as provided by\nthe TeX `hyph-utf8` package.",null,null],[3,"Corpus","hyphenation::language","A `Corpus` carries hyphenation data and parameters.",null,null],[12,"language","","",3,null],[12,"patterns","","",3,null],[12,"exceptions","","",3,null],[12,"left_min","","",3,null],[12,"right_min","","",3,null],[4,"Language","","The set of available languages.",null,null],[13,"Afrikaans","","",4,null],[13,"Armenian","","",4,null],[13,"Assamese","","",4,null],[13,"Basque","","",4,null],[13,"Bengali","","",4,null],[13,"Bulgarian","","",4,null],[13,"Catalan","","",4,null],[13,"Chinese","","",4,null],[13,"Coptic","","",4,null],[13,"Croatian","","",4,null],[13,"Czech","","",4,null],[13,"Danish","","",4,null],[13,"Dutch","","",4,null],[13,"English_GB","","",4,null],[13,"English_US","","",4,null],[13,"Esperanto","","",4,null],[13,"Estonian","","",4,null],[13,"Ethiopic","","",4,null],[13,"Finnish","","",4,null],[13,"French","","",4,null],[13,"Friulan","","",4,null],[13,"Galician","","",4,null],[13,"Georgian","","",4,null],[13,"German_1901","","",4,null],[13,"German_1996","","",4,null],[13,"German_Swiss","","",4,null],[13,"Greek_Ancient","","",4,null],[13,"Greek_Mono","","",4,null],[13,"Greek_Poly","","",4,null],[13,"Gujarati","","",4,null],[13,"Hindi","","",4,null],[13,"Hungarian","","",4,null],[13,"Icelandic","","",4,null],[13,"Indonesian","","",4,null],[13,"Interlingua","","",4,null],[13,"Irish","","",4,null],[13,"Italian","","",4,null],[13,"Kannada","","",4,null],[13,"Kurmanji","","",4,null],[13,"Latin_Classic","","",4,null],[13,"Latin","","",4,null],[13,"Latvian","","",4,null],[13,"Lithuanian","","",4,null],[13,"Malayalam","","",4,null],[13,"Marathi","","",4,null],[13,"Mongolian","","",4,null],[13,"Norwegian_Bokmal","","",4,null],[13,"Norwegian_Nynorsk","","",4,null],[13,"Occitan","","",4,null],[13,"Oriya","","",4,null],[13,"Panjabi","","",4,null],[13,"Piedmontese","","",4,null],[13,"Polish","","",4,null],[13,"Portuguese","","",4,null],[13,"Romanian","","",4,null],[13,"Romansh","","",4,null],[13,"Russian","","",4,null],[13,"Sanskrit","","",4,null],[13,"Serbian_Cyrillic","","",4,null],[13,"Serbocroatian_Cyrillic","","",4,null],[13,"Serbocroatian_Latin","","",4,null],[13,"Slovak","","",4,null],[13,"Slovenian","","",4,null],[13,"Spanish","","",4,null],[13,"Swedish","","",4,null],[13,"Tamil","","",4,null],[13,"Telugu","","",4,null],[13,"Thai","","",4,null],[13,"Turkish","","",4,null],[13,"Turkmen","","",4,null],[13,"Ukrainian","","",4,null],[13,"Uppersorbian","","",4,null],[13,"Welsh","","",4,null],[5,"tag","","The TeX tag for a given language.",null,{"inputs":[{"name":"language"}],"output":{"name":"str"}}],[5,"mins","","The default number of characters from the start and end of a word\nwhich shall not be hyphenated.",null,null],[11,"fmt","","",3,null],[11,"clone","","",3,null],[11,"cmp","","",4,null],[11,"partial_cmp","","",4,null],[11,"eq","","",4,null],[11,"fmt","","",4,null],[11,"clone","","",4,null],[0,"load","hyphenation","IO operations for pattern and exception data provided by `hyph-UTF8`\nand stored in the `patterns` folder.",null,null],[4,"Error","hyphenation::load","Failure modes of pattern loading.",null,null],[13,"IO","","",5,null],[13,"Deserialization","","",5,null],[5,"set_pattern_folder","","",null,{"inputs":[{"name":"path"}],"output":null}],[5,"data_file","","",null,{"inputs":[{"name":"language"},{"name":"str"}],"output":{"name":"result"}}],[5,"patterns","","",null,{"inputs":[{"name":"language"}],"output":{"name":"result"}}],[5,"exceptions","","",null,{"inputs":[{"name":"language"}],"output":{"name":"result"}}],[5,"language","","Constructs the default `Corpus` for a given language.",null,{"inputs":[{"name":"language"}],"output":{"name":"result"}}],[11,"fmt","","",5,null],[11,"fmt","","",5,null],[11,"description","","",5,null],[11,"from","","",5,{"inputs":[{"name":"error"}],"output":{"name":"error"}}],[11,"from","","",5,{"inputs":[{"name":"error"}],"output":{"name":"error"}}],[0,"pattern","hyphenation","Data structures and methods for parsing and applying Knuth-Liang\nhyphenation patterns.",null,null],[3,"Patterns","hyphenation::pattern","A basic trie, used to associate patterns to their hyphenation scores.",null,null],[12,"tally","","",6,null],[12,"descendants","","",6,null],[11,"fmt","","",6,null],[11,"clone","","",6,null],[11,"empty","","Creates an empty `Patterns` trie.",6,{"inputs":[],"output":{"name":"patterns"}}],[11,"insert","","Inserts a Knuth-Liang hyphenation pair into the trie.",6,null],[11,"score","","Assigns a score to each potential hyphenation point.",6,null]],"paths":[[3,"Exceptions"],[8,"Hyphenation"],[3,"Standard"],[3,"Corpus"],[4,"Language"],[4,"Error"],[3,"Patterns"]]};
initSearch(searchIndex);