Package triebeard. August 29, 2016

Transcription

1 Type Package Title 'Radix' Trees in 'Rcpp' Version Package beard August 29, 2016 Author Oliver Keyes [aut, cre], Drew Schmidt [aut], Yuuki Takano [cph] Maintainer Oliver Keyes 'Radix trees', or 's', are keyvalue data structures optimised for efficient lookups, similar in purpose to hash tables. 'beard' provides an implementation of 'radix trees' for use in R programming and in developing packages with 'Rcpp'. License MIT + file LICENSE LazyData TRUE LinkingTo Rcpp Imports Rcpp RoxygenNote Suggests knitr, rmarkdown, testthat VignetteBuilder knitr URL BugReports Date NeedsCompilation yes Repository CRAN Date/Publication :57:37 R topics documented: alter getters greedy_match

2 2 alter longest_match prefix_match beard Index 7 alter Add or remove ens _add and _remove allow you to add or remove ens from s, respectively. _add(, keys, values) _remove(, keys) keys values a object created with a character vector containing the keys of the ens to add (or remove). Ens with NA keys will not be added. an atomic vector, matching the type of the, containing the values of the ens to add. Ens with NA values will not be added. nothing; the is modified in-place for creating s in the first place. <- ("foo", "bar") length() _add(, "baz", "qux") length() _remove(, "baz") length()

3 getters 3 getters Trie Getters "Getters" for the data stored in a object. get_keys gets the keys, get_values gets the values. get_keys() get_values() A object, created with. An atomic vector of keys or values stored in the. greedy_match Greedily match against a tree greedy_match accepts a and a character vector and returns the values associated with any key that is "greedily" (read: fuzzily) matched against one of the character vector ens. greedy_match(, to_match) to_match a object, created with a character vector containing the strings to check against the s keys. a list, the length of to_match, with each entry containing any values where the to_match element greedily matches the associated key. In the case that nothing was found, the entry will contain NA.

4 4 longest_match longest_match and prefix_match for longest and prefix matching, respectively. <- (keys = c("afford", "affair", "available", "binary", "bind", "blind"), values = c("afford", "affair", "available", "binary", "bind", "blind")) greedy_match(, c("avoid", "bring", "attack")) longest_match Find the longest match in a longest_match accepts a and a character vector and returns the value associated with whichever key had the longest match to each entry in the character vector. A of "binary" and "bind", for example, with an entry-to-compare of "binder", will match to "bind". longest_match(, to_match) to_match a object, created with a character vector containing the strings to match against the s keys. prefix_match and greedy_match for prefix and greedy matching, respectively. <- (keys = c("afford", "affair", "available", "binary", "bind", "blind"), values = c("afford", "affair", "available", "binary", "bind", "blind")) longest_match(, "binder")

5 prefix_match 5 prefix_match Find the prefix matches in a prefix_match accepts a and a character vector and returns the values associated with any key that has a particular character vector entry as a prefix (see the examples). prefix_match(, to_match) to_match a object, created with a character vector containing the strings to check against the s keys. a list, the length of to_match, with each entry containing any values where the to_match element was a prefix of the associated key. In the case that nothing was found, the entry will contain NA. longest_match and greedy_match for longest and greedy matching, respectively. <- (keys = c("afford", "affair", "available", "binary", "bind", "blind"), values = c("afford", "affair", "available", "binary", "bind", "blind")) prefix_match(, "aff") Create a Trie create_ creates a (a key-value store optimised for matching) out of a provided character vector of keys, and a numeric, character, logical or integer vector of values (both the same length). (keys, values)

6 6 beard keys values a character vector containing the keys for the. an atomic vector of any type, containing the values to pair with keys. Must be the same length as keys. a object. _add and _remove for adding to and removing from s after their creation, and longest_match and other match functions for matching values against the keys of a created. # An integer int_ <- (keys = "foo", values = 1) # A string str_ <- (keys = "foo", values = "bar") beard Radix trees in Rcpp This package provides access to Radix tree (or "") structures in Rcpp. At a later date it will hopefully provide them in R, too.

7 Index alter, 2 get_keys (getters), 3 get_values (getters), 3 getters, 3 greedy_match, 3, 4, 5 longest_match, 4, 4, 5, 6 prefix_match, 4, 5, 2 5, 5 _add, 6 _add (alter), 2 _remove, 6 _remove (alter), 2 beard, 6 beard-package (beard), 6 7