├── LICENSE
├── README.markdown
├── doc
    ├── btrie.html
    ├── edoc-info
    ├── erlang.png
    ├── index.html
    ├── modules-frame.html
    ├── overview-summary.html
    ├── stylesheet.css
    └── trie.html
├── generate_docs.sh
├── mix.exs
├── rebar.config
├── src
    ├── btrie.erl
    ├── trie.app.src
    ├── trie.erl
    ├── trie.hrl
    └── trie_test.hrl
└── test
    ├── proper_srv.erl
    └── trie_proper.erl


/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2010-2025 Michael Truog <mjtruog at protonmail dot com>
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a
 6 | copy of this software and associated documentation files (the "Software"),
 7 | to deal in the Software without restriction, including without limitation
 8 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
 9 | and/or sell copies of the Software, and to permit persons to whom the
10 | Software is furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in
13 | all copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21 | DEALINGS IN THE SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/README.markdown:
--------------------------------------------------------------------------------
 1 | Erlang Trie Implementation
 2 | ==========================
 3 | 
 4 | The data structure is only for storing keys as strings (lists of integers), but is able to get performance close to the process dictionary when doing key lookups (based on [results here](http://okeuday.livejournal.com/20025.html) with [the benchmark here](http://github.com/okeuday/erlbench)).  So, this data structure is (currently) the quickest for lookups on key-value pairs where all keys are strings, if you ignore the process dictionary (which many argue should never be used).
 5 | 
 6 | The implementation stores leaf nodes as the string suffix because it is a [PATRICIA trie](https://xlinux.nist.gov/dads/HTML/patriciatree.html) (PATRICIA - Practical Algorithm to Retrieve Information Coded in Alphanumeric, D.R.Morrison (1968)).  Storing leaf nodes this way helps avoid single child leafs (compressing the tree a little bit).
 7 | 
 8 | The full OTP dict API is supported in addition to other functions.  Functions like foldl, iter, itera, and foreach traverse in alphabetical order.  Functions like map and foldr traverse in reverse alphabetical order.  There are also functions like `find_prefix`, `is_prefix`, and `is_prefixed` that check if a prefix exists within the trie.  The functions with a `"_similar"` suffix like `find_similar`, `foldl_similar`, and `foldr_similar` all operate with trie elements that share a common prefix with the supplied string.
 9 | 
10 | The trie data structure supports string patterns.  The functions `find_match/2`, `fold_match/4`, and `pattern_parse/2` utilize patterns that contain a`"*"`wildcard character(s) (equivalent to ".+" regex while`"**"`is forbidden).  The function `find_match/2` operates on a trie filled with patterns when supplied a string non-pattern, while the function `fold_match/4` operates on a trie without patterns when supplied a string pattern.  The functions `find_match2/2` and `pattern2_parse/2` add `"?"` as an additional wildcard character (with `"**"`, `"??"`, `"*?"` and `"?*"` forbidden) that consumes greedily to the next character (`"?"` must not be the last character in the pattern).
11 | 
12 | The btrie data structure was added because many people wanted a quick associative data structure for binary keys.  However, other alternatives provide better efficiency, so the btrie is best used for functions that can not be found elsewhere (or perhaps extra-long keys)... more testing would be needed to determine the best use-cases of the btrie.
13 | 
14 | Tests
15 | -----
16 | 
17 |     rebar compile
18 |     ERL_LIBS="/path/to/proper" rebar eunit
19 | 
20 | Author
21 | ------
22 | 
23 | Michael Truog (mjtruog at protonmail dot com)
24 | 
25 | License
26 | -------
27 | 
28 | MIT License
29 | 


--------------------------------------------------------------------------------
/doc/btrie.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2 | <html>
  3 | <head>
  4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5 | <title>Module btrie</title>
  6 | <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
  7 | </head>
  8 | <body bgcolor="white">
  9 | <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
 10 | <hr>
 11 | 
 12 | <h1>Module btrie</h1>
 13 | <ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
 14 |    <h3><a name="A_trie_data_structure_implementation.">A trie data structure implementation.</a></h3><p>   
 15 | The trie (i.e., from "retrieval") data structure was invented by   
 16 | Edward Fredkin (it is a form of radix sort).  The implementation stores   
 17 | string suffixes as a list because it is a PATRICIA trie   
 18 | (PATRICIA - Practical Algorithm to Retrieve Information    
 19 | Coded in Alphanumeric, D.R.Morrison (1968)).</p>
 20 |   
 21 |    This Erlang trie implementation uses binary keys.
 22 | <p>Copyright © 2010-2020 Michael Truog</p>
 23 | 
 24 | <p><b>Version:</b> 2.0.1 Oct 26 2023 11:28:28
 25 |   ------------------------------------------------------------------------</p>
 26 | <p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
 27 | 
 28 | <h2><a name="description">Description</a></h2>
 29 |    <h3><a name="A_trie_data_structure_implementation.">A trie data structure implementation.</a></h3><p>   
 30 | The trie (i.e., from "retrieval") data structure was invented by   
 31 | Edward Fredkin (it is a form of radix sort).  The implementation stores   
 32 | string suffixes as a list because it is a PATRICIA trie   
 33 | (PATRICIA - Practical Algorithm to Retrieve Information    
 34 | Coded in Alphanumeric, D.R.Morrison (1968)).</p>
 35 |   
 36 |    This Erlang trie implementation uses binary keys.  Using binary keys
 37 |    means that other data structures are quicker alternatives, so this
 38 |    module is probably not a good choice, unless it is used for functions
 39 |    not available elsewhere.
 40 | <h2><a name="types">Data Types</a></h2>
 41 | 
 42 | <h3 class="typedecl"><a name="type-empty_trie">empty_trie()</a></h3>
 43 | <p><tt>empty_trie() = &lt;&lt;&gt;&gt;</tt></p>
 44 | 
 45 | 
 46 | <h3 class="typedecl"><a name="type-nonempty_trie">nonempty_trie()</a></h3>
 47 | <p><tt>nonempty_trie() = {integer(), integer(), tuple()}</tt></p>
 48 | 
 49 | 
 50 | <h3 class="typedecl"><a name="type-trie">trie()</a></h3>
 51 | <p><tt>trie() = <a href="#type-nonempty_trie">nonempty_trie()</a> | <a href="#type-empty_trie">empty_trie()</a></tt></p>
 52 | 
 53 | 
 54 | <h2><a name="index">Function Index</a></h2>
 55 | <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#append-3">append/3</a></td><td>
 56 |   <h4><a name="Append_a_value_as_a_list_element_in_a_trie_instance.">Append a value as a list element in a trie instance.</a></h4>.</td></tr>
 57 | <tr><td valign="top"><a href="#append_list-3">append_list/3</a></td><td>
 58 |   <h4><a name="Append_a_list_of_values_as_a_list_element_in_a_trie_instance.">Append a list of values as a list element in a trie instance.</a></h4>.</td></tr>
 59 | <tr><td valign="top"><a href="#erase-2">erase/2</a></td><td>
 60 |   <h4><a name="Erase_a_value_in_a_trie.">Erase a value in a trie.</a></h4>.</td></tr>
 61 | <tr><td valign="top"><a href="#erase_similar-2">erase_similar/2</a></td><td>
 62 |   <h4><a name="Erase_all_entries_within_a_trie_that_share_a_common_prefix.">Erase all entries within a trie that share a common prefix.</a></h4>.</td></tr>
 63 | <tr><td valign="top"><a href="#fetch-2">fetch/2</a></td><td>
 64 |   <h4><a name="Fetch_a_value_from_a_trie.">Fetch a value from a trie.</a></h4>.</td></tr>
 65 | <tr><td valign="top"><a href="#fetch_keys-1">fetch_keys/1</a></td><td>
 66 |   <h4><a name="Fetch_all_the_keys_in_a_trie.">Fetch all the keys in a trie.</a></h4>.</td></tr>
 67 | <tr><td valign="top"><a href="#fetch_keys_similar-2">fetch_keys_similar/2</a></td><td>
 68 |   <h4><a name="Fetch_the_keys_within_a_trie_that_share_a_common_prefix.">Fetch the keys within a trie that share a common prefix.</a></h4>.</td></tr>
 69 | <tr><td valign="top"><a href="#filter-2">filter/2</a></td><td>
 70 |   <h4><a name="Filter_a_trie_with_a_predicate_function.">Filter a trie with a predicate function.</a></h4>.</td></tr>
 71 | <tr><td valign="top"><a href="#find-2">find/2</a></td><td>
 72 |   <h4><a name="Find_a_value_in_a_trie.">Find a value in a trie.</a></h4>.</td></tr>
 73 | <tr><td valign="top"><a href="#find_prefix-2">find_prefix/2</a></td><td>
 74 |   <h4><a name="Find_a_value_in_a_trie_by_prefix.">Find a value in a trie by prefix.</a></h4>
 75 |   The atom 'prefix' is returned if the string supplied is a prefix
 76 |   for a key that has previously been stored within the trie, but no
 77 |   value was found, since there was no exact match for the string supplied.</td></tr>
 78 | <tr><td valign="top"><a href="#find_prefix_longest-2">find_prefix_longest/2</a></td><td>
 79 |   <h4><a name="Find_the_longest_key_in_a_trie_that_is_a_prefix_to_the_passed_string.">Find the longest key in a trie that is a prefix to the passed string.</a></h4>.</td></tr>
 80 | <tr><td valign="top"><a href="#find_prefixes-2">find_prefixes/2</a></td><td>
 81 |   <h4><a name="Find_all_the_keys_in_a_trie_that_are_prefixes_to_the_passed_string.">Find all the keys in a trie that are prefixes to the passed string.</a></h4>
 82 |   The entries are returned in alphabetical order.</td></tr>
 83 | <tr><td valign="top"><a href="#fold-3">fold/3</a></td><td>
 84 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
 85 |   Traverses in alphabetical order.</td></tr>
 86 | <tr><td valign="top"><a href="#fold_similar-4">fold_similar/4</a></td><td>
 87 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
 88 |   Traverses in alphabetical order.</td></tr>
 89 | <tr><td valign="top"><a href="#foldl-3">foldl/3</a></td><td>
 90 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
 91 |   Traverses in alphabetical order.</td></tr>
 92 | <tr><td valign="top"><a href="#foldl_similar-4">foldl_similar/4</a></td><td>
 93 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
 94 |   Traverses in alphabetical order.</td></tr>
 95 | <tr><td valign="top"><a href="#foldr-3">foldr/3</a></td><td>
 96 |   <h4><a name="Fold_a_function_over_the_trie_in_reverse.">Fold a function over the trie in reverse.</a></h4>
 97 |   Traverses in reverse alphabetical order.</td></tr>
 98 | <tr><td valign="top"><a href="#foldr_similar-4">foldr_similar/4</a></td><td>
 99 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix_in_reverse.">Fold a function over the keys within a trie that share a common prefix in reverse.</a></h4>
100 |   Traverses in reverse alphabetical order.</td></tr>
101 | <tr><td valign="top"><a href="#foreach-2">foreach/2</a></td><td>
102 |   <h4><a name="Call_a_function_for_each_element.">Call a function for each element.</a></h4>
103 |   Traverses in alphabetical order.</td></tr>
104 | <tr><td valign="top"><a href="#from_list-1">from_list/1</a></td><td>
105 |   <h4><a name="Create_a_trie_from_a_list.">Create a trie from a list.</a></h4>.</td></tr>
106 | <tr><td valign="top"><a href="#is_key-2">is_key/2</a></td><td>
107 |   <h4><a name="Determine_if_a_key_exists_in_a_trie.">Determine if a key exists in a trie.</a></h4>.</td></tr>
108 | <tr><td valign="top"><a href="#map-2">map/2</a></td><td>
109 |   <h4><a name="Map_a_function_over_a_trie.">Map a function over a trie.</a></h4>
110 |   Traverses in reverse alphabetical order.</td></tr>
111 | <tr><td valign="top"><a href="#merge-3">merge/3</a></td><td>
112 |   <h4><a name="Merge_two_trie_instance.">Merge two trie instance.</a></h4>
113 |   Update the second trie parameter with all of the elements
114 |   found within the first trie parameter.</td></tr>
115 | <tr><td valign="top"><a href="#new-0">new/0</a></td><td>
116 |   <h4><a name="Create_a_new_trie_instance.">Create a new trie instance.</a></h4>.</td></tr>
117 | <tr><td valign="top"><a href="#new-1">new/1</a></td><td>
118 |   <h4><a name="Create_a_new_trie_instance_from_a_list.">Create a new trie instance from a list.</a></h4>
119 |   The list may contain either: strings, 2 element tuples with a string as the
120 |   first tuple element, or tuples with more than 2 elements (including records)
121 |   with a string as the first element (second element if it is a record).</td></tr>
122 | <tr><td valign="top"><a href="#prefix-3">prefix/3</a></td><td>
123 |   <h4><a name="Insert_a_value_as_the_first_list_element_in_a_trie_instance.">Insert a value as the first list element in a trie instance.</a></h4>
124 |   The reverse of append/3.</td></tr>
125 | <tr><td valign="top"><a href="#size-1">size/1</a></td><td>
126 |   <h4><a name="Size_of_a_trie_instance.">Size of a trie instance.</a></h4>.</td></tr>
127 | <tr><td valign="top"><a href="#store-2">store/2</a></td><td>
128 |   <h4><a name="Store_only_a_key_in_a_trie_instance.">Store only a key in a trie instance.</a></h4>.</td></tr>
129 | <tr><td valign="top"><a href="#store-3">store/3</a></td><td>
130 |   <h4><a name="Store_a_key/value_pair_in_a_trie_instance.">Store a key/value pair in a trie instance.</a></h4>.</td></tr>
131 | <tr><td valign="top"><a href="#take-2">take/2</a></td><td>
132 |   <h4><a name="Take_a_value_from_the_trie.">Take a value from the trie.</a></h4>.</td></tr>
133 | <tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td>
134 |   <h4><a name="Convert_all_entries_in_a_trie_to_a_list.">Convert all entries in a trie to a list.</a></h4>
135 |   The list is in alphabetical order.</td></tr>
136 | <tr><td valign="top"><a href="#to_list_similar-2">to_list_similar/2</a></td><td>
137 |   <h4><a name="Return_a_list_of_all_entries_within_a_trie_that_share_a_common_prefix.">Return a list of all entries within a trie that share a common prefix.</a></h4>.</td></tr>
138 | <tr><td valign="top"><a href="#update-3">update/3</a></td><td>
139 |   <h4><a name="Update_a_value_in_a_trie.">Update a value in a trie.</a></h4>.</td></tr>
140 | <tr><td valign="top"><a href="#update-4">update/4</a></td><td>
141 |   <h4><a name="Update_or_add_a_value_in_a_trie.">Update or add a value in a trie.</a></h4>.</td></tr>
142 | <tr><td valign="top"><a href="#update_counter-3">update_counter/3</a></td><td>
143 |   <h4><a name="Update_a_counter_in_a_trie.">Update a counter in a trie.</a></h4>.</td></tr>
144 | </table>
145 | 
146 | <h2><a name="functions">Function Details</a></h2>
147 | 
148 | <h3 class="function"><a name="append-3">append/3</a></h3>
149 | <div class="spec">
150 | <p><tt>append(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, Value::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
151 | <p> </p>
152 | </div><p>
153 |   <h4><a name="Append_a_value_as_a_list_element_in_a_trie_instance.">Append a value as a list element in a trie instance.</a></h4>
154 | </p>
155 | 
156 | <h3 class="function"><a name="append_list-3">append_list/3</a></h3>
157 | <div class="spec">
158 | <p><tt>append_list(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, ValueList::list(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
159 | <p> </p>
160 | </div><p>
161 |   <h4><a name="Append_a_list_of_values_as_a_list_element_in_a_trie_instance.">Append a list of values as a list element in a trie instance.</a></h4>
162 | </p>
163 | 
164 | <h3 class="function"><a name="erase-2">erase/2</a></h3>
165 | <div class="spec">
166 | <p><tt>erase(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
167 | <p> </p>
168 | </div><p>
169 |   <h4><a name="Erase_a_value_in_a_trie.">Erase a value in a trie.</a></h4>
170 | </p>
171 | 
172 | <h3 class="function"><a name="erase_similar-2">erase_similar/2</a></h3>
173 | <div class="spec">
174 | <p><tt>erase_similar(Similar::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; [&lt;&lt;_:8, _:_*8&gt;&gt;]</tt><br></p>
175 | <p> </p>
176 | </div><p>
177 |   <h4><a name="Erase_all_entries_within_a_trie_that_share_a_common_prefix.">Erase all entries within a trie that share a common prefix.</a></h4>
178 | </p>
179 | 
180 | <h3 class="function"><a name="fetch-2">fetch/2</a></h3>
181 | <div class="spec">
182 | <p><tt>fetch(X1::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-nonempty_trie">nonempty_trie()</a>) -&gt; any()</tt><br></p>
183 | <p> </p>
184 | </div><p>
185 |   <h4><a name="Fetch_a_value_from_a_trie.">Fetch a value from a trie.</a></h4>
186 | </p>
187 | 
188 | <h3 class="function"><a name="fetch_keys-1">fetch_keys/1</a></h3>
189 | <div class="spec">
190 | <p><tt>fetch_keys(Node::<a href="#type-trie">trie()</a>) -&gt; [&lt;&lt;_:8, _:_*8&gt;&gt;]</tt><br></p>
191 | <p> </p>
192 | </div><p>
193 |   <h4><a name="Fetch_all_the_keys_in_a_trie.">Fetch all the keys in a trie.</a></h4>
194 | </p>
195 | 
196 | <h3 class="function"><a name="fetch_keys_similar-2">fetch_keys_similar/2</a></h3>
197 | <div class="spec">
198 | <p><tt>fetch_keys_similar(Similar::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; [&lt;&lt;_:8, _:_*8&gt;&gt;]</tt><br></p>
199 | <p> </p>
200 | </div><p>
201 |   <h4><a name="Fetch_the_keys_within_a_trie_that_share_a_common_prefix.">Fetch the keys within a trie that share a common prefix.</a></h4>
202 | </p>
203 | 
204 | <h3 class="function"><a name="filter-2">filter/2</a></h3>
205 | <div class="spec">
206 | <p><tt>filter(F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any()) -&gt; boolean()), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
207 | <p> </p>
208 | </div><p>
209 |   <h4><a name="Filter_a_trie_with_a_predicate_function.">Filter a trie with a predicate function.</a></h4>
210 | </p>
211 | 
212 | <h3 class="function"><a name="find-2">find/2</a></h3>
213 | <div class="spec">
214 | <p><tt>find(X1::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; {ok, any()} | error</tt><br></p>
215 | <p> </p>
216 | </div><p>
217 |   <h4><a name="Find_a_value_in_a_trie.">Find a value in a trie.</a></h4>
218 | </p>
219 | 
220 | <h3 class="function"><a name="find_prefix-2">find_prefix/2</a></h3>
221 | <div class="spec">
222 | <p><tt>find_prefix(X1::&lt;&lt;_:8, _:_*8&gt;&gt;, X2::<a href="#type-trie">trie()</a>) -&gt; {ok, any()} | prefix | error</tt><br></p>
223 | <p> </p>
224 | </div><p>
225 |   <h4><a name="Find_a_value_in_a_trie_by_prefix.">Find a value in a trie by prefix.</a></h4>
226 |   The atom 'prefix' is returned if the string supplied is a prefix
227 |   for a key that has previously been stored within the trie, but no
228 |   value was found, since there was no exact match for the string supplied.</p>
229 | 
230 | <h3 class="function"><a name="find_prefix_longest-2">find_prefix_longest/2</a></h3>
231 | <div class="spec">
232 | <p><tt>find_prefix_longest(Match::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; {ok, &lt;&lt;_:8, _:_*8&gt;&gt;, any()} | error</tt><br></p>
233 | <p> </p>
234 | </div><p>
235 |   <h4><a name="Find_the_longest_key_in_a_trie_that_is_a_prefix_to_the_passed_string.">Find the longest key in a trie that is a prefix to the passed string.</a></h4>
236 | </p>
237 | 
238 | <h3 class="function"><a name="find_prefixes-2">find_prefixes/2</a></h3>
239 | <div class="spec">
240 | <p><tt>find_prefixes(Match::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; [{&lt;&lt;_:8, _:_*8&gt;&gt;, any()}]</tt><br></p>
241 | <p> </p>
242 | </div><p>
243 |   <h4><a name="Find_all_the_keys_in_a_trie_that_are_prefixes_to_the_passed_string.">Find all the keys in a trie that are prefixes to the passed string.</a></h4>
244 |   The entries are returned in alphabetical order.</p>
245 | 
246 | <h3 class="function"><a name="fold-3">fold/3</a></h3>
247 | <div class="spec">
248 | <p><tt>fold(F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
249 | <p> </p>
250 | </div><p>
251 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
252 |   Traverses in alphabetical order.</p>
253 | 
254 | <h3 class="function"><a name="fold_similar-4">fold_similar/4</a></h3>
255 | <div class="spec">
256 | <p><tt>fold_similar(Similar::&lt;&lt;_:8, _:_*8&gt;&gt;, F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
257 | <p> </p>
258 | </div><p>
259 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
260 |   Traverses in alphabetical order.</p>
261 | 
262 | <h3 class="function"><a name="foldl-3">foldl/3</a></h3>
263 | <div class="spec">
264 | <p><tt>foldl(F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
265 | <p> </p>
266 | </div><p>
267 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
268 |   Traverses in alphabetical order.</p>
269 | 
270 | <h3 class="function"><a name="foldl_similar-4">foldl_similar/4</a></h3>
271 | <div class="spec">
272 | <p><tt>foldl_similar(Similar::&lt;&lt;_:8, _:_*8&gt;&gt;, F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
273 | <p> </p>
274 | </div><p>
275 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
276 |   Traverses in alphabetical order.</p>
277 | 
278 | <h3 class="function"><a name="foldr-3">foldr/3</a></h3>
279 | <div class="spec">
280 | <p><tt>foldr(F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
281 | <p> </p>
282 | </div><p>
283 |   <h4><a name="Fold_a_function_over_the_trie_in_reverse.">Fold a function over the trie in reverse.</a></h4>
284 |   Traverses in reverse alphabetical order.</p>
285 | 
286 | <h3 class="function"><a name="foldr_similar-4">foldr_similar/4</a></h3>
287 | <div class="spec">
288 | <p><tt>foldr_similar(Similar::&lt;&lt;_:8, _:_*8&gt;&gt;, F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
289 | <p> </p>
290 | </div><p>
291 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix_in_reverse.">Fold a function over the keys within a trie that share a common prefix in reverse.</a></h4>
292 |   Traverses in reverse alphabetical order.</p>
293 | 
294 | <h3 class="function"><a name="foreach-2">foreach/2</a></h3>
295 | <div class="spec">
296 | <p><tt>foreach(F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any()) -&gt; any()), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
297 | <p> </p>
298 | </div><p>
299 |   <h4><a name="Call_a_function_for_each_element.">Call a function for each element.</a></h4>
300 |   Traverses in alphabetical order.</p>
301 | 
302 | <h3 class="function"><a name="from_list-1">from_list/1</a></h3>
303 | <div class="spec">
304 | <p><tt>from_list(L::[&lt;&lt;_:8, _:_*8&gt;&gt; | tuple()]) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
305 | <p> </p>
306 | </div><p>
307 |   <h4><a name="Create_a_trie_from_a_list.">Create a trie from a list.</a></h4>
308 | </p>
309 | 
310 | <h3 class="function"><a name="is_key-2">is_key/2</a></h3>
311 | <div class="spec">
312 | <p><tt>is_key(X1::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; boolean()</tt><br></p>
313 | <p> </p>
314 | </div><p>
315 |   <h4><a name="Determine_if_a_key_exists_in_a_trie.">Determine if a key exists in a trie.</a></h4>
316 | </p>
317 | 
318 | <h3 class="function"><a name="map-2">map/2</a></h3>
319 | <div class="spec">
320 | <p><tt>map(F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any()) -&gt; any()), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
321 | <p> </p>
322 | </div><p>
323 |   <h4><a name="Map_a_function_over_a_trie.">Map a function over a trie.</a></h4>
324 |   Traverses in reverse alphabetical order.</p>
325 | 
326 | <h3 class="function"><a name="merge-3">merge/3</a></h3>
327 | <div class="spec">
328 | <p><tt>merge(F::fun((&lt;&lt;_:8, _:_*8&gt;&gt;, any(), any()) -&gt; any()), Node1::<a href="#type-trie">trie()</a>, Node2::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
329 | <p> </p>
330 | </div><p>
331 |   <h4><a name="Merge_two_trie_instance.">Merge two trie instance.</a></h4>
332 |   Update the second trie parameter with all of the elements
333 |   found within the first trie parameter.</p>
334 | 
335 | <h3 class="function"><a name="new-0">new/0</a></h3>
336 | <div class="spec">
337 | <p><tt>new() -&gt; <a href="#type-empty_trie">empty_trie()</a></tt><br></p>
338 | <p> </p>
339 | </div><p>
340 |   <h4><a name="Create_a_new_trie_instance.">Create a new trie instance.</a></h4>
341 | </p>
342 | 
343 | <h3 class="function"><a name="new-1">new/1</a></h3>
344 | <div class="spec">
345 | <p><tt>new(L::[&lt;&lt;_:8, _:_*8&gt;&gt; | tuple()]) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
346 | <p> </p>
347 | </div><p>
348 |   <h4><a name="Create_a_new_trie_instance_from_a_list.">Create a new trie instance from a list.</a></h4>
349 |   The list may contain either: strings, 2 element tuples with a string as the
350 |   first tuple element, or tuples with more than 2 elements (including records)
351 |   with a string as the first element (second element if it is a record).
352 |   If a list of records (or tuples larger than 2 elements) is provided,
353 |   the whole record/tuple is stored as the value.</p>
354 | 
355 | <h3 class="function"><a name="prefix-3">prefix/3</a></h3>
356 | <div class="spec">
357 | <p><tt>prefix(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, Value::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
358 | <p> </p>
359 | </div><p>
360 |   <h4><a name="Insert_a_value_as_the_first_list_element_in_a_trie_instance.">Insert a value as the first list element in a trie instance.</a></h4>
361 |   The reverse of append/3.</p>
362 | 
363 | <h3 class="function"><a name="size-1">size/1</a></h3>
364 | <div class="spec">
365 | <p><tt>size(Node::<a href="#type-trie">trie()</a>) -&gt; non_neg_integer()</tt><br></p>
366 | <p> </p>
367 | </div><p>
368 |   <h4><a name="Size_of_a_trie_instance.">Size of a trie instance.</a></h4>
369 | </p>
370 | 
371 | <h3 class="function"><a name="store-2">store/2</a></h3>
372 | <div class="spec">
373 | <p><tt>store(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
374 | <p> </p>
375 | </div><p>
376 |   <h4><a name="Store_only_a_key_in_a_trie_instance.">Store only a key in a trie instance.</a></h4>
377 | </p>
378 | 
379 | <h3 class="function"><a name="store-3">store/3</a></h3>
380 | <div class="spec">
381 | <p><tt>store(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, NewValue::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
382 | <p> </p>
383 | </div><p>
384 |   <h4><a name="Store_a_key/value_pair_in_a_trie_instance.">Store a key/value pair in a trie instance.</a></h4>
385 | </p>
386 | 
387 | <h3 class="function"><a name="take-2">take/2</a></h3>
388 | <div class="spec">
389 | <p><tt>take(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; {any(), <a href="#type-trie">trie()</a>} | error</tt><br></p>
390 | <p> </p>
391 | </div><p>
392 |   <h4><a name="Take_a_value_from_the_trie.">Take a value from the trie.</a></h4>
393 | </p>
394 | 
395 | <h3 class="function"><a name="to_list-1">to_list/1</a></h3>
396 | <div class="spec">
397 | <p><tt>to_list(Node::<a href="#type-trie">trie()</a>) -&gt; [{&lt;&lt;_:8, _:_*8&gt;&gt;, any()}]</tt><br></p>
398 | <p> </p>
399 | </div><p>
400 |   <h4><a name="Convert_all_entries_in_a_trie_to_a_list.">Convert all entries in a trie to a list.</a></h4>
401 |   The list is in alphabetical order.</p>
402 | 
403 | <h3 class="function"><a name="to_list_similar-2">to_list_similar/2</a></h3>
404 | <div class="spec">
405 | <p><tt>to_list_similar(Similar::&lt;&lt;_:8, _:_*8&gt;&gt;, Node::<a href="#type-trie">trie()</a>) -&gt; [{&lt;&lt;_:8, _:_*8&gt;&gt;, any()}]</tt><br></p>
406 | <p> </p>
407 | </div><p>
408 |   <h4><a name="Return_a_list_of_all_entries_within_a_trie_that_share_a_common_prefix.">Return a list of all entries within a trie that share a common prefix.</a></h4>
409 | </p>
410 | 
411 | <h3 class="function"><a name="update-3">update/3</a></h3>
412 | <div class="spec">
413 | <p><tt>update(X1::&lt;&lt;_:8, _:_*8&gt;&gt;, F::fun((any()) -&gt; any()), Node::<a href="#type-nonempty_trie">nonempty_trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
414 | <p> </p>
415 | </div><p>
416 |   <h4><a name="Update_a_value_in_a_trie.">Update a value in a trie.</a></h4>
417 | </p>
418 | 
419 | <h3 class="function"><a name="update-4">update/4</a></h3>
420 | <div class="spec">
421 | <p><tt>update(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, F::fun((any()) -&gt; any()), Initial::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
422 | <p> </p>
423 | </div><p>
424 |   <h4><a name="Update_or_add_a_value_in_a_trie.">Update or add a value in a trie.</a></h4>
425 | </p>
426 | 
427 | <h3 class="function"><a name="update_counter-3">update_counter/3</a></h3>
428 | <div class="spec">
429 | <p><tt>update_counter(Key::&lt;&lt;_:8, _:_*8&gt;&gt;, Increment::number(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
430 | <p> </p>
431 | </div><p>
432 |   <h4><a name="Update_a_counter_in_a_trie.">Update a counter in a trie.</a></h4>
433 | </p>
434 | <hr>
435 | 
436 | <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
437 | <p><i>Generated by EDoc</i></p>
438 | </body>
439 | </html>
440 | 


--------------------------------------------------------------------------------
/doc/edoc-info:
--------------------------------------------------------------------------------
1 | %% encoding: UTF-8
2 | {application,trie}.
3 | {modules,[btrie,trie]}.
4 | 


--------------------------------------------------------------------------------
/doc/erlang.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/okeuday/trie/0cf9c913b5e0f39a46c763a2168077d2c4dfd0e9/doc/erlang.png


--------------------------------------------------------------------------------
/doc/index.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 2 | <html>
 3 | <head>
 4 | <title>The trie application</title>
 5 | </head>
 6 | <frameset cols="20%,80%">
 7 | <frame src="modules-frame.html" name="modulesFrame" title="">
 8 | 
 9 | <frame src="overview-summary.html" name="overviewFrame" title="">
10 | <noframes>
11 | <h2>This page uses frames</h2>
12 | <p>Your browser does not accept frames.
13 | <br>You should go to the <a href="overview-summary.html">non-frame version</a> instead.
14 | </p>
15 | </noframes>
16 | </frameset>
17 | </html>


--------------------------------------------------------------------------------
/doc/modules-frame.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 2 | <html>
 3 | <head>
 4 | <title>The trie application</title>
 5 | <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
 6 | </head>
 7 | <body bgcolor="white">
 8 | <h2 class="indextitle">Modules</h2>
 9 | <table width="100%" border="0" summary="list of modules">
10 | <tr><td><a href="btrie.html" target="overviewFrame" class="module">btrie</a></td></tr>
11 | <tr><td><a href="trie.html" target="overviewFrame" class="module">trie</a></td></tr></table>
12 | </body>
13 | </html>


--------------------------------------------------------------------------------
/doc/overview-summary.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
 2 | <html>
 3 | <head>
 4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
 5 | <title>The trie application</title>
 6 | <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
 7 | </head>
 8 | <body bgcolor="white">
 9 | <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
10 | <h1>The trie application</h1>
11 | 
12 | <hr>
13 | <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
14 | <p><i>Generated by EDoc</i></p>
15 | </body>
16 | </html>
17 | 


--------------------------------------------------------------------------------
/doc/stylesheet.css:
--------------------------------------------------------------------------------
 1 | /* standard EDoc style sheet */
 2 | body {
 3 | 	font-family: Verdana, Arial, Helvetica, sans-serif;
 4 |       	margin-left: .25in;
 5 |        	margin-right: .2in;
 6 |        	margin-top: 0.2in;
 7 |        	margin-bottom: 0.2in;
 8 |        	color: #000000;
 9 |        	background-color: #ffffff;
10 | }
11 | h1,h2 {
12 |  	margin-left: -0.2in;
13 | }
14 | div.navbar {
15 | 	background-color: #add8e6;
16 | 	padding: 0.2em;
17 | }
18 | h2.indextitle {
19 | 	padding: 0.4em;
20 | 	background-color: #add8e6;
21 | }
22 | h3.function,h3.typedecl {
23 | 	background-color: #add8e6;
24 |  	padding-left: 1em;
25 | }
26 | div.spec {
27 |  	margin-left: 2em;
28 | 	background-color: #eeeeee;
29 | }
30 | a.module {
31 | 	text-decoration:none
32 | }
33 | a.module:hover {
34 | 	background-color: #eeeeee;
35 | }
36 | ul.definitions {
37 | 	list-style-type: none;
38 | }
39 | ul.index {
40 | 	list-style-type: none;
41 | 	background-color: #eeeeee;
42 | }
43 | 
44 | /*
45 |  * Minor style tweaks
46 |  */
47 | ul {
48 | 	list-style-type: square;
49 | }
50 | table {
51 | 	border-collapse: collapse;
52 | }
53 | td {
54 | 	padding: 3
55 | }
56 | 


--------------------------------------------------------------------------------
/doc/trie.html:
--------------------------------------------------------------------------------
  1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
  2 | <html>
  3 | <head>
  4 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
  5 | <title>Module trie</title>
  6 | <link rel="stylesheet" type="text/css" href="stylesheet.css" title="EDoc">
  7 | </head>
  8 | <body bgcolor="white">
  9 | <div class="navbar"><a name="#navbar_top"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
 10 | <hr>
 11 | 
 12 | <h1>Module trie</h1>
 13 | <ul class="index"><li><a href="#description">Description</a></li><li><a href="#types">Data Types</a></li><li><a href="#index">Function Index</a></li><li><a href="#functions">Function Details</a></li></ul>
 14 |    <h3><a name="A_trie_data_structure_implementation.">A trie data structure implementation.</a></h3><p>   
 15 | The trie (i.e., from "retrieval") data structure was invented by   
 16 | Edward Fredkin (it is a form of radix sort).  The implementation stores   
 17 | string suffixes as a list because it is a PATRICIA trie   
 18 | (PATRICIA - Practical Algorithm to Retrieve Information    
 19 | Coded in Alphanumeric, D.R.Morrison (1968)).</p>
 20 |   
 21 |    This Erlang trie implementation uses string (list of integers) keys and
 22 |    is able to get performance close to the process dictionary when doing key
 23 |    lookups (find or fetch, see <a href="http://okeuday.livejournal.com/16941.html" target="_top"><tt>http://okeuday.livejournal.com/16941.html</tt></a>).
 24 | <p>Copyright © 2010-2022 Michael Truog</p>
 25 | 
 26 | <p><b>Version:</b> 2.0.5 Oct 26 2023 11:28:28
 27 |   ------------------------------------------------------------------------</p>
 28 | <p><b>Authors:</b> Michael Truog (<a href="mailto:mjtruog at protonmail dot com"><tt>mjtruog at protonmail dot com</tt></a>).</p>
 29 | 
 30 | <h2><a name="description">Description</a></h2>
 31 |    <h3><a name="A_trie_data_structure_implementation.">A trie data structure implementation.</a></h3><p>   
 32 | The trie (i.e., from "retrieval") data structure was invented by   
 33 | Edward Fredkin (it is a form of radix sort).  The implementation stores   
 34 | string suffixes as a list because it is a PATRICIA trie   
 35 | (PATRICIA - Practical Algorithm to Retrieve Information    
 36 | Coded in Alphanumeric, D.R.Morrison (1968)).</p>
 37 |   
 38 |    This Erlang trie implementation uses string (list of integers) keys and
 39 |    is able to get performance close to the process dictionary when doing key
 40 |    lookups (find or fetch, see <a href="http://okeuday.livejournal.com/16941.html" target="_top"><tt>http://okeuday.livejournal.com/16941.html</tt></a>).
 41 |    Utilizing this trie, it is possible to avoid generating dynamic atoms
 42 |    in various contexts.  Also, an added benefit to using this trie is that
 43 |    the traversals preserve alphabetical ordering.
 44 | <h2><a name="types">Data Types</a></h2>
 45 | 
 46 | <h3 class="typedecl"><a name="type-empty_trie">empty_trie()</a></h3>
 47 | <p><tt>empty_trie() = []</tt></p>
 48 | 
 49 | 
 50 | <h3 class="typedecl"><a name="type-nonempty_trie">nonempty_trie()</a></h3>
 51 | <p><tt>nonempty_trie() = {integer(), integer(), tuple()}</tt></p>
 52 | 
 53 | 
 54 | <h3 class="typedecl"><a name="type-trie">trie()</a></h3>
 55 | <p><tt>trie() = <a href="#type-nonempty_trie">nonempty_trie()</a> | <a href="#type-empty_trie">empty_trie()</a></tt></p>
 56 | 
 57 | 
 58 | <h2><a name="index">Function Index</a></h2>
 59 | <table width="100%" border="1" cellspacing="0" cellpadding="2" summary="function index"><tr><td valign="top"><a href="#append-3">append/3</a></td><td>
 60 |   <h4><a name="Append_a_value_as_a_list_element_in_a_trie_instance.">Append a value as a list element in a trie instance.</a></h4>.</td></tr>
 61 | <tr><td valign="top"><a href="#append_list-3">append_list/3</a></td><td>
 62 |   <h4><a name="Append_a_list_of_values_as_a_list_element_in_a_trie_instance.">Append a list of values as a list element in a trie instance.</a></h4>.</td></tr>
 63 | <tr><td valign="top"><a href="#erase-2">erase/2</a></td><td>
 64 |   <h4><a name="Erase_a_value_in_a_trie.">Erase a value in a trie.</a></h4>.</td></tr>
 65 | <tr><td valign="top"><a href="#erase_similar-2">erase_similar/2</a></td><td>
 66 |   <h4><a name="Erase_all_entries_within_a_trie_that_share_a_common_prefix.">Erase all entries within a trie that share a common prefix.</a></h4>.</td></tr>
 67 | <tr><td valign="top"><a href="#fetch-2">fetch/2</a></td><td>
 68 |   <h4><a name="Fetch_a_value_from_a_trie.">Fetch a value from a trie.</a></h4>.</td></tr>
 69 | <tr><td valign="top"><a href="#fetch_keys-1">fetch_keys/1</a></td><td>
 70 |   <h4><a name="Fetch_all_the_keys_in_a_trie.">Fetch all the keys in a trie.</a></h4>.</td></tr>
 71 | <tr><td valign="top"><a href="#fetch_keys_similar-2">fetch_keys_similar/2</a></td><td>
 72 |   <h4><a name="Fetch_the_keys_within_a_trie_that_share_a_common_prefix.">Fetch the keys within a trie that share a common prefix.</a></h4>.</td></tr>
 73 | <tr><td valign="top"><a href="#filter-2">filter/2</a></td><td>
 74 |   <h4><a name="Filter_a_trie_with_a_predicate_function.">Filter a trie with a predicate function.</a></h4>.</td></tr>
 75 | <tr><td valign="top"><a href="#find-2">find/2</a></td><td>
 76 |   <h4><a name="Find_a_value_in_a_trie.">Find a value in a trie.</a></h4>.</td></tr>
 77 | <tr><td valign="top"><a href="#find_match-2">find_match/2</a></td><td>
 78 |   <h4><a name="Find_a_match_with_patterns_held_within_a_trie.">Find a match with patterns held within a trie.</a></h4>
 79 |   All patterns held within the trie use a wildcard character "*" to represent
 80 |   a regex of ".+".</td></tr>
 81 | <tr><td valign="top"><a href="#find_match2-2">find_match2/2</a></td><td>
 82 |   <h4><a name="Find_a_match_with_patterns_(using_2_wildcard_characters)_held_within_a_trie.">Find a match with patterns (using 2 wildcard characters) held within a trie.</a></h4>
 83 |   All patterns held within the trie use the wildcard character "*" or "?"
 84 |   to represent a regex of ".+".</td></tr>
 85 | <tr><td valign="top"><a href="#find_prefix-2">find_prefix/2</a></td><td>
 86 |   <h4><a name="Find_a_value_in_a_trie_by_prefix.">Find a value in a trie by prefix.</a></h4>
 87 |   The atom 'prefix' is returned if the string supplied is a prefix
 88 |   for a key that has previously been stored within the trie, but no
 89 |   value was found, since there was no exact match for the string supplied.</td></tr>
 90 | <tr><td valign="top"><a href="#find_prefix_longest-2">find_prefix_longest/2</a></td><td>
 91 |   <h4><a name="Find_the_longest_key_in_a_trie_that_is_a_prefix_to_the_passed_string.">Find the longest key in a trie that is a prefix to the passed string.</a></h4>.</td></tr>
 92 | <tr><td valign="top"><a href="#find_prefixes-2">find_prefixes/2</a></td><td>
 93 |   <h4><a name="Find_all_the_keys_in_a_trie_that_are_prefixes_to_the_passed_string.">Find all the keys in a trie that are prefixes to the passed string.</a></h4>
 94 |   The entries are returned in alphabetical order.</td></tr>
 95 | <tr><td valign="top"><a href="#find_similar-2">find_similar/2</a></td><td>
 96 |   <h4><a name="Find_the_first_key/value_pair_in_a_trie_where_the_key_shares_a_common_prefix.">Find the first key/value pair in a trie where the key shares a common prefix.</a></h4>
 97 |   The first match is found based on alphabetical order.</td></tr>
 98 | <tr><td valign="top"><a href="#fold-3">fold/3</a></td><td>
 99 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
100 |   Traverses in alphabetical order.</td></tr>
101 | <tr><td valign="top"><a href="#fold_match-4">fold_match/4</a></td><td>
102 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_matches_a_pattern.">Fold a function over the keys within a trie that matches a pattern.</a></h4>
103 |   Traverses in alphabetical order.</td></tr>
104 | <tr><td valign="top"><a href="#fold_similar-4">fold_similar/4</a></td><td>
105 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
106 |   Traverses in alphabetical order.</td></tr>
107 | <tr><td valign="top"><a href="#foldl-3">foldl/3</a></td><td>
108 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
109 |   Traverses in alphabetical order.</td></tr>
110 | <tr><td valign="top"><a href="#foldl_similar-4">foldl_similar/4</a></td><td>
111 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
112 |   Traverses in alphabetical order.</td></tr>
113 | <tr><td valign="top"><a href="#foldr-3">foldr/3</a></td><td>
114 |   <h4><a name="Fold_a_function_over_the_trie_in_reverse.">Fold a function over the trie in reverse.</a></h4>
115 |   Traverses in reverse alphabetical order.</td></tr>
116 | <tr><td valign="top"><a href="#foldr_similar-4">foldr_similar/4</a></td><td>
117 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix_in_reverse.">Fold a function over the keys within a trie that share a common prefix in reverse.</a></h4>
118 |   Traverses in reverse alphabetical order.</td></tr>
119 | <tr><td valign="top"><a href="#foreach-2">foreach/2</a></td><td>
120 |   <h4><a name="Call_a_function_for_each_element.">Call a function for each element.</a></h4>
121 |   Traverses in alphabetical order.</td></tr>
122 | <tr><td valign="top"><a href="#from_list-1">from_list/1</a></td><td>
123 |   <h4><a name="Create_a_trie_from_a_list.">Create a trie from a list.</a></h4>.</td></tr>
124 | <tr><td valign="top"><a href="#is_bytestring-1">is_bytestring/1</a></td><td>
125 |   <h4><a name="Test_if_the_parameter_is_a_byte_string.">Test if the parameter is a byte string.</a></h4>.</td></tr>
126 | <tr><td valign="top"><a href="#is_bytestring_nonempty-1">is_bytestring_nonempty/1</a></td><td>
127 |   <h4><a name="Test_if_the_parameter_is_a_nonempty_byte_string.">Test if the parameter is a nonempty byte string.</a></h4>.</td></tr>
128 | <tr><td valign="top"><a href="#is_key-2">is_key/2</a></td><td>
129 |   <h4><a name="Determine_if_a_key_exists_in_a_trie.">Determine if a key exists in a trie.</a></h4>.</td></tr>
130 | <tr><td valign="top"><a href="#is_pattern-1">is_pattern/1</a></td><td>
131 |   <h4><a name="Test_to_determine_if_a_string_is_a_pattern.">Test to determine if a string is a pattern.</a></h4>
132 |   "*" is the wildcard character (equivalent to the ".+" regex).</td></tr>
133 | <tr><td valign="top"><a href="#is_pattern2-1">is_pattern2/1</a></td><td>
134 |   <h4><a name="Test_to_determine_if_a_string_is_a_pattern_(using_2_wildcard_characters).">Test to determine if a string is a pattern (using 2 wildcard characters).</a></h4>
135 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).</td></tr>
136 | <tr><td valign="top"><a href="#is_pattern2_bytes-1">is_pattern2_bytes/1</a></td><td>
137 |   <h4><a name="Test_to_determine_if_a_byte_string_is_a_pattern_(using_2_wildcard_characters).">Test to determine if a byte string is a pattern (using 2 wildcard characters).</a></h4>
138 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).</td></tr>
139 | <tr><td valign="top"><a href="#is_pattern_bytes-1">is_pattern_bytes/1</a></td><td>
140 |   <h4><a name="Test_to_determine_if_a_byte_string_is_a_pattern.">Test to determine if a byte string is a pattern.</a></h4>
141 |   "*" is the wildcard character (equivalent to the ".+" regex).</td></tr>
142 | <tr><td valign="top"><a href="#is_prefix-2">is_prefix/2</a></td><td>
143 |   <h4><a name="Determine_if_the_prefix_provided_has_existed_within_a_trie.">Determine if the prefix provided has existed within a trie.</a></h4>
144 |   The function returns true if the string supplied is a prefix
145 |   for a key that has previously been stored within the trie.</td></tr>
146 | <tr><td valign="top"><a href="#is_prefixed-2">is_prefixed/2</a></td><td>
147 |   <h4><a name="Determine_if_the_provided_string_has_a_prefix_within_a_trie.">Determine if the provided string has a prefix within a trie.</a></h4>.</td></tr>
148 | <tr><td valign="top"><a href="#is_prefixed-3">is_prefixed/3</a></td><td>
149 |   <h4><a name="Determine_if_the_provided_string_has_an_acceptable_prefix_within_a_trie.">Determine if the provided string has an acceptable prefix within a trie.</a></h4>
150 |   The prefix within the trie must match at least 1 character that is not
151 |   within the excluded list of characters.</td></tr>
152 | <tr><td valign="top"><a href="#iter-2">iter/2</a></td><td>
153 |   <h4><a name="Iterate_over_a_trie.">Iterate over a trie.</a></h4>
154 |   Traverses in alphabetical order.</td></tr>
155 | <tr><td valign="top"><a href="#itera-3">itera/3</a></td><td>
156 |   <h4><a name="Iterate_over_a_trie_with_an_accumulator.">Iterate over a trie with an accumulator.</a></h4>
157 |   Traverses in alphabetical order.</td></tr>
158 | <tr><td valign="top"><a href="#map-2">map/2</a></td><td>
159 |   <h4><a name="Map_a_function_over_a_trie.">Map a function over a trie.</a></h4>
160 |   Traverses in reverse alphabetical order.</td></tr>
161 | <tr><td valign="top"><a href="#merge-3">merge/3</a></td><td>
162 |   <h4><a name="Merge_two_trie_instance.">Merge two trie instance.</a></h4>
163 |   Update the second trie parameter with all of the elements
164 |   found within the first trie parameter.</td></tr>
165 | <tr><td valign="top"><a href="#new-0">new/0</a></td><td>
166 |   <h4><a name="Create_a_new_trie_instance.">Create a new trie instance.</a></h4>.</td></tr>
167 | <tr><td valign="top"><a href="#new-1">new/1</a></td><td>
168 |   <h4><a name="Create_a_new_trie_instance_from_a_list.">Create a new trie instance from a list.</a></h4>
169 |   The list may contain either: strings, 2 element tuples with a string as the
170 |   first tuple element, or tuples with more than 2 elements (including records)
171 |   with a string as the first element (second element if it is a record).</td></tr>
172 | <tr><td valign="top"><a href="#pattern2_fill-2">pattern2_fill/2</a></td><td>
173 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
174 |   The "*" and "?" wildcard characters may be used consecutively by this
175 |   function to have parameters concatenated (both are processed the same
176 |   way by this function).</td></tr>
177 | <tr><td valign="top"><a href="#pattern2_fill-4">pattern2_fill/4</a></td><td>
178 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
179 |   The "*" and "?" wildcard characters may be used consecutively by this
180 |   function to have parameters concatenated (both are processed the same
181 |   way by this function).</td></tr>
182 | <tr><td valign="top"><a href="#pattern2_parse-2">pattern2_parse/2</a></td><td>
183 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_(using_2_wildcard_characters).">Parse a string based on the supplied wildcard pattern (using 2 wildcard characters).</a></h4>
184 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).</td></tr>
185 | <tr><td valign="top"><a href="#pattern2_parse-3">pattern2_parse/3</a></td><td>
186 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_(using_2_wildcard_characters).">Parse a string based on the supplied wildcard pattern (using 2 wildcard characters).</a></h4>
187 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).</td></tr>
188 | <tr><td valign="top"><a href="#pattern2_suffix-2">pattern2_suffix/2</a></td><td>
189 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_(using_2_wildcard_characters)_to_return_only_the_suffix_after_the_pattern.">Parse a string based on the supplied wildcard pattern (using 2 wildcard characters) to return only the suffix after the pattern.</a></h4>
190 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).</td></tr>
191 | <tr><td valign="top"><a href="#pattern_fill-2">pattern_fill/2</a></td><td>
192 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
193 |   The "*" wildcard character may be used consecutively by this function
194 |   to have parameters concatenated.</td></tr>
195 | <tr><td valign="top"><a href="#pattern_fill-4">pattern_fill/4</a></td><td>
196 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
197 |   The "*" wildcard character may be used consecutively by this function
198 |   to have parameters concatenated.</td></tr>
199 | <tr><td valign="top"><a href="#pattern_parse-2">pattern_parse/2</a></td><td>
200 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern.">Parse a string based on the supplied wildcard pattern.</a></h4>
201 |   "*" is the wildcard character (equivalent to the ".+" regex).</td></tr>
202 | <tr><td valign="top"><a href="#pattern_parse-3">pattern_parse/3</a></td><td>
203 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern.">Parse a string based on the supplied wildcard pattern.</a></h4>
204 |   "*" is the wildcard character (equivalent to the ".+" regex).</td></tr>
205 | <tr><td valign="top"><a href="#pattern_suffix-2">pattern_suffix/2</a></td><td>
206 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_to_return_only_the_suffix_after_the_pattern.">Parse a string based on the supplied wildcard pattern to return only the suffix after the pattern.</a></h4>
207 |   "*" is the wildcard character (equivalent to the ".+" regex).</td></tr>
208 | <tr><td valign="top"><a href="#prefix-3">prefix/3</a></td><td>
209 |   <h4><a name="Insert_a_value_as_the_first_list_element_in_a_trie_instance.">Insert a value as the first list element in a trie instance.</a></h4>
210 |   The reverse of append/3.</td></tr>
211 | <tr><td valign="top"><a href="#size-1">size/1</a></td><td>
212 |   <h4><a name="Size_of_a_trie_instance.">Size of a trie instance.</a></h4>.</td></tr>
213 | <tr><td valign="top"><a href="#store-2">store/2</a></td><td>
214 |   <h4><a name="Store_only_a_key_in_a_trie_instance.">Store only a key in a trie instance.</a></h4>.</td></tr>
215 | <tr><td valign="top"><a href="#store-3">store/3</a></td><td>
216 |   <h4><a name="Store_a_key/value_pair_in_a_trie_instance.">Store a key/value pair in a trie instance.</a></h4>.</td></tr>
217 | <tr><td valign="top"><a href="#take-2">take/2</a></td><td>
218 |   <h4><a name="Take_a_value_from_the_trie.">Take a value from the trie.</a></h4>.</td></tr>
219 | <tr><td valign="top"><a href="#to_list-1">to_list/1</a></td><td>
220 |   <h4><a name="Convert_all_entries_in_a_trie_to_a_list.">Convert all entries in a trie to a list.</a></h4>
221 |   The list is in alphabetical order.</td></tr>
222 | <tr><td valign="top"><a href="#to_list_similar-2">to_list_similar/2</a></td><td>
223 |   <h4><a name="Return_a_list_of_all_entries_within_a_trie_that_share_a_common_prefix.">Return a list of all entries within a trie that share a common prefix.</a></h4>.</td></tr>
224 | <tr><td valign="top"><a href="#update-3">update/3</a></td><td>
225 |   <h4><a name="Update_a_value_in_a_trie.">Update a value in a trie.</a></h4>.</td></tr>
226 | <tr><td valign="top"><a href="#update-4">update/4</a></td><td>
227 |   <h4><a name="Update_or_add_a_value_in_a_trie.">Update or add a value in a trie.</a></h4>.</td></tr>
228 | <tr><td valign="top"><a href="#update_counter-3">update_counter/3</a></td><td>
229 |   <h4><a name="Update_a_counter_in_a_trie.">Update a counter in a trie.</a></h4>.</td></tr>
230 | </table>
231 | 
232 | <h2><a name="functions">Function Details</a></h2>
233 | 
234 | <h3 class="function"><a name="append-3">append/3</a></h3>
235 | <div class="spec">
236 | <p><tt>append(Key::nonempty_string(), Value::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
237 | <p> </p>
238 | </div><p>
239 |   <h4><a name="Append_a_value_as_a_list_element_in_a_trie_instance.">Append a value as a list element in a trie instance.</a></h4>
240 | </p>
241 | 
242 | <h3 class="function"><a name="append_list-3">append_list/3</a></h3>
243 | <div class="spec">
244 | <p><tt>append_list(Key::nonempty_string(), ValueList::list(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
245 | <p> </p>
246 | </div><p>
247 |   <h4><a name="Append_a_list_of_values_as_a_list_element_in_a_trie_instance.">Append a list of values as a list element in a trie instance.</a></h4>
248 | </p>
249 | 
250 | <h3 class="function"><a name="erase-2">erase/2</a></h3>
251 | <div class="spec">
252 | <p><tt>erase(Key::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
253 | <p> </p>
254 | </div><p>
255 |   <h4><a name="Erase_a_value_in_a_trie.">Erase a value in a trie.</a></h4>
256 | </p>
257 | 
258 | <h3 class="function"><a name="erase_similar-2">erase_similar/2</a></h3>
259 | <div class="spec">
260 | <p><tt>erase_similar(Similar::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; [nonempty_string()]</tt><br></p>
261 | <p> </p>
262 | </div><p>
263 |   <h4><a name="Erase_all_entries_within_a_trie_that_share_a_common_prefix.">Erase all entries within a trie that share a common prefix.</a></h4>
264 | </p>
265 | 
266 | <h3 class="function"><a name="fetch-2">fetch/2</a></h3>
267 | <div class="spec">
268 | <p><tt>fetch(T::nonempty_string(), Node::<a href="#type-nonempty_trie">nonempty_trie()</a>) -&gt; any()</tt><br></p>
269 | <p> </p>
270 | </div><p>
271 |   <h4><a name="Fetch_a_value_from_a_trie.">Fetch a value from a trie.</a></h4>
272 | </p>
273 | 
274 | <h3 class="function"><a name="fetch_keys-1">fetch_keys/1</a></h3>
275 | <div class="spec">
276 | <p><tt>fetch_keys(Node::<a href="#type-trie">trie()</a>) -&gt; [nonempty_string()]</tt><br></p>
277 | <p> </p>
278 | </div><p>
279 |   <h4><a name="Fetch_all_the_keys_in_a_trie.">Fetch all the keys in a trie.</a></h4>
280 | </p>
281 | 
282 | <h3 class="function"><a name="fetch_keys_similar-2">fetch_keys_similar/2</a></h3>
283 | <div class="spec">
284 | <p><tt>fetch_keys_similar(Similar::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; [nonempty_string()]</tt><br></p>
285 | <p> </p>
286 | </div><p>
287 |   <h4><a name="Fetch_the_keys_within_a_trie_that_share_a_common_prefix.">Fetch the keys within a trie that share a common prefix.</a></h4>
288 | </p>
289 | 
290 | <h3 class="function"><a name="filter-2">filter/2</a></h3>
291 | <div class="spec">
292 | <p><tt>filter(F::fun((nonempty_string(), any()) -&gt; boolean()), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
293 | <p> </p>
294 | </div><p>
295 |   <h4><a name="Filter_a_trie_with_a_predicate_function.">Filter a trie with a predicate function.</a></h4>
296 | </p>
297 | 
298 | <h3 class="function"><a name="find-2">find/2</a></h3>
299 | <div class="spec">
300 | <p><tt>find(T::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; {ok, any()} | error</tt><br></p>
301 | <p> </p>
302 | </div><p>
303 |   <h4><a name="Find_a_value_in_a_trie.">Find a value in a trie.</a></h4>
304 | </p>
305 | 
306 | <h3 class="function"><a name="find_match-2">find_match/2</a></h3>
307 | <div class="spec">
308 | <p><tt>find_match(Match::string(), Node::<a href="#type-trie">trie()</a>) -&gt; {ok, any(), any()} | error</tt><br></p>
309 | <p> </p>
310 | </div><p>
311 |   <h4><a name="Find_a_match_with_patterns_held_within_a_trie.">Find a match with patterns held within a trie.</a></h4>
312 |   All patterns held within the trie use a wildcard character "*" to represent
313 |   a regex of ".+".  "**" within the trie will result in undefined behavior
314 |   (the pattern is malformed).  The function will search for the most specific
315 |   match possible, given the input string and the trie contents.  The input
316 |   string must not contain wildcard characters, otherwise a badarg exit
317 |   exception will occur.  If you instead want to supply a pattern string to
318 |   match the contents of the trie, see fold_match/4.</p>
319 | 
320 | <h3 class="function"><a name="find_match2-2">find_match2/2</a></h3>
321 | <div class="spec">
322 | <p><tt>find_match2(Match::string(), Node::<a href="#type-trie">trie()</a>) -&gt; {ok, any(), any()} | error</tt><br></p>
323 | <p> </p>
324 | </div><p>
325 |   <h4><a name="Find_a_match_with_patterns_(using_2_wildcard_characters)_held_within_a_trie.">Find a match with patterns (using 2 wildcard characters) held within a trie.</a></h4>
326 |   All patterns held within the trie use the wildcard character "*" or "?"
327 |   to represent a regex of ".+".  "**", "??", "*?", or "?*" within the
328 |   trie will result in undefined behavior (the pattern is malformed).
329 |   The function will search for the most specific match possible, given the
330 |   input string and the trie contents.  The input string must not contain
331 |   wildcard characters, otherwise a badarg exit exception will occur.
332 |   The "?" wildcard character consumes the shortest match to the next
333 |   character and must not be the the last character in the string
334 |   (the pattern would be malformed).</p>
335 | 
336 | <h3 class="function"><a name="find_prefix-2">find_prefix/2</a></h3>
337 | <div class="spec">
338 | <p><tt>find_prefix(T::nonempty_string(), X2::<a href="#type-trie">trie()</a>) -&gt; {ok, any()} | prefix | error</tt><br></p>
339 | <p> </p>
340 | </div><p>
341 |   <h4><a name="Find_a_value_in_a_trie_by_prefix.">Find a value in a trie by prefix.</a></h4>
342 |   The atom 'prefix' is returned if the string supplied is a prefix
343 |   for a key that has previously been stored within the trie, but no
344 |   value was found, since there was no exact match for the string supplied.</p>
345 | 
346 | <h3 class="function"><a name="find_prefix_longest-2">find_prefix_longest/2</a></h3>
347 | <div class="spec">
348 | <p><tt>find_prefix_longest(Match::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; {ok, nonempty_string(), any()} | error</tt><br></p>
349 | <p> </p>
350 | </div><p>
351 |   <h4><a name="Find_the_longest_key_in_a_trie_that_is_a_prefix_to_the_passed_string.">Find the longest key in a trie that is a prefix to the passed string.</a></h4>
352 | </p>
353 | 
354 | <h3 class="function"><a name="find_prefixes-2">find_prefixes/2</a></h3>
355 | <div class="spec">
356 | <p><tt>find_prefixes(Match::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; [{nonempty_string(), any()}]</tt><br></p>
357 | <p> </p>
358 | </div><p>
359 |   <h4><a name="Find_all_the_keys_in_a_trie_that_are_prefixes_to_the_passed_string.">Find all the keys in a trie that are prefixes to the passed string.</a></h4>
360 |   The entries are returned in alphabetical order.</p>
361 | 
362 | <h3 class="function"><a name="find_similar-2">find_similar/2</a></h3>
363 | <div class="spec">
364 | <p><tt>find_similar(Similar::string(), Node::<a href="#type-trie">trie()</a>) -&gt; {ok, string(), any()} | error</tt><br></p>
365 | <p> </p>
366 | </div><p>
367 |   <h4><a name="Find_the_first_key/value_pair_in_a_trie_where_the_key_shares_a_common_prefix.">Find the first key/value pair in a trie where the key shares a common prefix.</a></h4>
368 |   The first match is found based on alphabetical order.</p>
369 | 
370 | <h3 class="function"><a name="fold-3">fold/3</a></h3>
371 | <div class="spec">
372 | <p><tt>fold(F::fun((nonempty_string(), any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
373 | <p> </p>
374 | </div><p>
375 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
376 |   Traverses in alphabetical order.</p>
377 | 
378 | <h3 class="function"><a name="fold_match-4">fold_match/4</a></h3>
379 | <div class="spec">
380 | <p><tt>fold_match(Match::string(), F::fun((string(), any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
381 | <p> </p>
382 | </div><p>
383 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_matches_a_pattern.">Fold a function over the keys within a trie that matches a pattern.</a></h4>
384 |   Traverses in alphabetical order.  Uses "*" as a wildcard character
385 |   within the pattern (it acts like a ".+" regex, and "**" is forbidden).
386 |   The trie keys must not contain wildcard characters, otherwise a badarg
387 |   exit exception will occur. If you want to match a specific string
388 |   without wildcards on trie values that contain wildcard characters,
389 |   see find_match/2.</p>
390 | 
391 | <h3 class="function"><a name="fold_similar-4">fold_similar/4</a></h3>
392 | <div class="spec">
393 | <p><tt>fold_similar(Similar::nonempty_string(), F::fun((nonempty_string(), any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
394 | <p> </p>
395 | </div><p>
396 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
397 |   Traverses in alphabetical order.</p>
398 | 
399 | <h3 class="function"><a name="foldl-3">foldl/3</a></h3>
400 | <div class="spec">
401 | <p><tt>foldl(F::fun((nonempty_string(), any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
402 | <p> </p>
403 | </div><p>
404 |   <h4><a name="Fold_a_function_over_the_trie.">Fold a function over the trie.</a></h4>
405 |   Traverses in alphabetical order.</p>
406 | 
407 | <h3 class="function"><a name="foldl_similar-4">foldl_similar/4</a></h3>
408 | <div class="spec">
409 | <p><tt>foldl_similar(Similar::nonempty_string(), F::fun((nonempty_string(), any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
410 | <p> </p>
411 | </div><p>
412 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix.">Fold a function over the keys within a trie that share a common prefix.</a></h4>
413 |   Traverses in alphabetical order.</p>
414 | 
415 | <h3 class="function"><a name="foldr-3">foldr/3</a></h3>
416 | <div class="spec">
417 | <p><tt>foldr(F::fun((nonempty_string(), any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
418 | <p> </p>
419 | </div><p>
420 |   <h4><a name="Fold_a_function_over_the_trie_in_reverse.">Fold a function over the trie in reverse.</a></h4>
421 |   Traverses in reverse alphabetical order.</p>
422 | 
423 | <h3 class="function"><a name="foldr_similar-4">foldr_similar/4</a></h3>
424 | <div class="spec">
425 | <p><tt>foldr_similar(Similar::nonempty_string(), F::fun((nonempty_string(), any(), any()) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
426 | <p> </p>
427 | </div><p>
428 |   <h4><a name="Fold_a_function_over_the_keys_within_a_trie_that_share_a_common_prefix_in_reverse.">Fold a function over the keys within a trie that share a common prefix in reverse.</a></h4>
429 |   Traverses in reverse alphabetical order.</p>
430 | 
431 | <h3 class="function"><a name="foreach-2">foreach/2</a></h3>
432 | <div class="spec">
433 | <p><tt>foreach(F::fun((nonempty_string(), any()) -&gt; any()), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
434 | <p> </p>
435 | </div><p>
436 |   <h4><a name="Call_a_function_for_each_element.">Call a function for each element.</a></h4>
437 |   Traverses in alphabetical order.</p>
438 | 
439 | <h3 class="function"><a name="from_list-1">from_list/1</a></h3>
440 | <div class="spec">
441 | <p><tt>from_list(L::[nonempty_string() | tuple()]) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
442 | <p> </p>
443 | </div><p>
444 |   <h4><a name="Create_a_trie_from_a_list.">Create a trie from a list.</a></h4>
445 | </p>
446 | 
447 | <h3 class="function"><a name="is_bytestring-1">is_bytestring/1</a></h3>
448 | <div class="spec">
449 | <p><tt>is_bytestring(L::[byte()]) -&gt; true | false</tt><br></p>
450 | <p> </p>
451 | </div><p>
452 |   <h4><a name="Test_if_the_parameter_is_a_byte_string.">Test if the parameter is a byte string.</a></h4>
453 | </p>
454 | 
455 | <h3 class="function"><a name="is_bytestring_nonempty-1">is_bytestring_nonempty/1</a></h3>
456 | <div class="spec">
457 | <p><tt>is_bytestring_nonempty(L::[byte(), ...]) -&gt; true | false</tt><br></p>
458 | <p> </p>
459 | </div><p>
460 |   <h4><a name="Test_if_the_parameter_is_a_nonempty_byte_string.">Test if the parameter is a nonempty byte string.</a></h4>
461 | </p>
462 | 
463 | <h3 class="function"><a name="is_key-2">is_key/2</a></h3>
464 | <div class="spec">
465 | <p><tt>is_key(T::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; boolean()</tt><br></p>
466 | <p> </p>
467 | </div><p>
468 |   <h4><a name="Determine_if_a_key_exists_in_a_trie.">Determine if a key exists in a trie.</a></h4>
469 | </p>
470 | 
471 | <h3 class="function"><a name="is_pattern-1">is_pattern/1</a></h3>
472 | <div class="spec">
473 | <p><tt>is_pattern(Pattern::string()) -&gt; true | false</tt><br></p>
474 | <p> </p>
475 | </div><p>
476 |   <h4><a name="Test_to_determine_if_a_string_is_a_pattern.">Test to determine if a string is a pattern.</a></h4>
477 |   "*" is the wildcard character (equivalent to the ".+" regex).
478 |   "**" is forbidden.</p>
479 | 
480 | <h3 class="function"><a name="is_pattern2-1">is_pattern2/1</a></h3>
481 | <div class="spec">
482 | <p><tt>is_pattern2(Pattern::string()) -&gt; true | false</tt><br></p>
483 | <p> </p>
484 | </div><p>
485 |   <h4><a name="Test_to_determine_if_a_string_is_a_pattern_(using_2_wildcard_characters).">Test to determine if a string is a pattern (using 2 wildcard characters).</a></h4>
486 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).
487 |   "**", "??", "*?" and "?*" are forbidden.  "?" must not be the last
488 |   character in the pattern.</p>
489 | 
490 | <h3 class="function"><a name="is_pattern2_bytes-1">is_pattern2_bytes/1</a></h3>
491 | <div class="spec">
492 | <p><tt>is_pattern2_bytes(Pattern::[byte()]) -&gt; true | false</tt><br></p>
493 | <p> </p>
494 | </div><p>
495 |   <h4><a name="Test_to_determine_if_a_byte_string_is_a_pattern_(using_2_wildcard_characters).">Test to determine if a byte string is a pattern (using 2 wildcard characters).</a></h4>
496 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).
497 |   "**", "??", "*?" and "?*" are forbidden.  "?" must not be the last
498 |   character in the pattern.</p>
499 | 
500 | <h3 class="function"><a name="is_pattern_bytes-1">is_pattern_bytes/1</a></h3>
501 | <div class="spec">
502 | <p><tt>is_pattern_bytes(Pattern::[byte()]) -&gt; true | false</tt><br></p>
503 | <p> </p>
504 | </div><p>
505 |   <h4><a name="Test_to_determine_if_a_byte_string_is_a_pattern.">Test to determine if a byte string is a pattern.</a></h4>
506 |   "*" is the wildcard character (equivalent to the ".+" regex).
507 |   "**" is forbidden.</p>
508 | 
509 | <h3 class="function"><a name="is_prefix-2">is_prefix/2</a></h3>
510 | <div class="spec">
511 | <p><tt>is_prefix(T::string(), X2::<a href="#type-trie">trie()</a>) -&gt; true | false</tt><br></p>
512 | <p> </p>
513 | </div><p>
514 |   <h4><a name="Determine_if_the_prefix_provided_has_existed_within_a_trie.">Determine if the prefix provided has existed within a trie.</a></h4>
515 |   The function returns true if the string supplied is a prefix
516 |   for a key that has previously been stored within the trie.
517 |   If no values with the prefix matching key(s) were removed from the trie,
518 |   then the prefix currently exists within the trie.</p>
519 | 
520 | <h3 class="function"><a name="is_prefixed-2">is_prefixed/2</a></h3>
521 | <div class="spec">
522 | <p><tt>is_prefixed(T::string(), X2::<a href="#type-trie">trie()</a>) -&gt; true | false</tt><br></p>
523 | <p> </p>
524 | </div><p>
525 |   <h4><a name="Determine_if_the_provided_string_has_a_prefix_within_a_trie.">Determine if the provided string has a prefix within a trie.</a></h4>
526 | </p>
527 | 
528 | <h3 class="function"><a name="is_prefixed-3">is_prefixed/3</a></h3>
529 | <div class="spec">
530 | <p><tt>is_prefixed(Key::string(), Exclude::string(), Node::<a href="#type-trie">trie()</a>) -&gt; true | false</tt><br></p>
531 | <p> </p>
532 | </div><p>
533 |   <h4><a name="Determine_if_the_provided_string_has_an_acceptable_prefix_within_a_trie.">Determine if the provided string has an acceptable prefix within a trie.</a></h4>
534 |   The prefix within the trie must match at least 1 character that is not
535 |   within the excluded list of characters.</p>
536 | 
537 | <h3 class="function"><a name="iter-2">iter/2</a></h3>
538 | <div class="spec">
539 | <p><tt>iter(F::fun((string(), any(), fun(() -&gt; any())) -&gt; any()), Node::<a href="#type-trie">trie()</a>) -&gt; ok</tt><br></p>
540 | <p> </p>
541 | </div><p>
542 |   <h4><a name="Iterate_over_a_trie.">Iterate over a trie.</a></h4>
543 |   Traverses in alphabetical order.</p>
544 | 
545 | <h3 class="function"><a name="itera-3">itera/3</a></h3>
546 | <div class="spec">
547 | <p><tt>itera(F::fun((string(), any(), any(), fun((any()) -&gt; any())) -&gt; any()), A::any(), Node::<a href="#type-trie">trie()</a>) -&gt; any()</tt><br></p>
548 | <p> </p>
549 | </div><p>
550 |   <h4><a name="Iterate_over_a_trie_with_an_accumulator.">Iterate over a trie with an accumulator.</a></h4>
551 |   Traverses in alphabetical order.</p>
552 | 
553 | <h3 class="function"><a name="map-2">map/2</a></h3>
554 | <div class="spec">
555 | <p><tt>map(F::fun((nonempty_string(), any()) -&gt; any()), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
556 | <p> </p>
557 | </div><p>
558 |   <h4><a name="Map_a_function_over_a_trie.">Map a function over a trie.</a></h4>
559 |   Traverses in reverse alphabetical order.</p>
560 | 
561 | <h3 class="function"><a name="merge-3">merge/3</a></h3>
562 | <div class="spec">
563 | <p><tt>merge(F::fun((nonempty_string(), any(), any()) -&gt; any()), Node1::<a href="#type-trie">trie()</a>, Node2::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
564 | <p> </p>
565 | </div><p>
566 |   <h4><a name="Merge_two_trie_instance.">Merge two trie instance.</a></h4>
567 |   Update the second trie parameter with all of the elements
568 |   found within the first trie parameter.</p>
569 | 
570 | <h3 class="function"><a name="new-0">new/0</a></h3>
571 | <div class="spec">
572 | <p><tt>new() -&gt; <a href="#type-empty_trie">empty_trie()</a></tt><br></p>
573 | <p> </p>
574 | </div><p>
575 |   <h4><a name="Create_a_new_trie_instance.">Create a new trie instance.</a></h4>
576 | </p>
577 | 
578 | <h3 class="function"><a name="new-1">new/1</a></h3>
579 | <div class="spec">
580 | <p><tt>new(L::[nonempty_string() | tuple()]) -&gt; <a href="#type-trie">trie()</a></tt><br></p>
581 | <p> </p>
582 | </div><p>
583 |   <h4><a name="Create_a_new_trie_instance_from_a_list.">Create a new trie instance from a list.</a></h4>
584 |   The list may contain either: strings, 2 element tuples with a string as the
585 |   first tuple element, or tuples with more than 2 elements (including records)
586 |   with a string as the first element (second element if it is a record).
587 |   If a list of records (or tuples larger than 2 elements) is provided,
588 |   the whole record/tuple is stored as the value.</p>
589 | 
590 | <h3 class="function"><a name="pattern2_fill-2">pattern2_fill/2</a></h3>
591 | <div class="spec">
592 | <p><tt>pattern2_fill(FillPattern::string(), Parameters::[string()]) -&gt; {ok, string()} | {error, parameters_ignored | parameter_missing}</tt><br></p>
593 | <p> </p>
594 | </div><p>
595 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
596 |   The "*" and "?" wildcard characters may be used consecutively by this
597 |   function to have parameters concatenated (both are processed the same
598 |   way by this function).</p>
599 | 
600 | <h3 class="function"><a name="pattern2_fill-4">pattern2_fill/4</a></h3>
601 | <div class="spec">
602 | <p><tt>pattern2_fill(FillPattern::string(), Parameters::[string()], ParametersSelected::[pos_integer()], ParametersStrictMatching::boolean()) -&gt; {ok, string()} | {error, parameters_ignored | parameter_missing | parameters_selected_empty | {parameters_selected_ignored, [pos_integer()]} | {parameters_selected_missing, pos_integer()}}</tt><br></p>
603 | <p> </p>
604 | </div><p>
605 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
606 |   The "*" and "?" wildcard characters may be used consecutively by this
607 |   function to have parameters concatenated (both are processed the same
608 |   way by this function).</p>
609 | 
610 | <h3 class="function"><a name="pattern2_parse-2">pattern2_parse/2</a></h3>
611 | <div class="spec">
612 | <p><tt>pattern2_parse(Pattern::string(), L::string()) -&gt; [string()] | error</tt><br></p>
613 | <p> </p>
614 | </div><p>
615 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_(using_2_wildcard_characters).">Parse a string based on the supplied wildcard pattern (using 2 wildcard characters).</a></h4>
616 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).
617 |   "**", "??", "*?" and "?*" are forbidden.  "?" must not be the last
618 |   character in the pattern.</p>
619 | 
620 | <h3 class="function"><a name="pattern2_parse-3">pattern2_parse/3</a></h3>
621 | <div class="spec">
622 | <p><tt>pattern2_parse(Pattern::string(), L::string(), Option::default | with_suffix | expanded) -&gt; [string()] | {[string()], string()} | [string() | {exact, string()}] | error</tt><br></p>
623 | <p> </p>
624 | </div><p>
625 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_(using_2_wildcard_characters).">Parse a string based on the supplied wildcard pattern (using 2 wildcard characters).</a></h4>
626 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).
627 |   "**", "??", "*?" and "?*" are forbidden.  "?" must not be the last
628 |   character in the pattern.</p>
629 | 
630 | <h3 class="function"><a name="pattern2_suffix-2">pattern2_suffix/2</a></h3>
631 | <div class="spec">
632 | <p><tt>pattern2_suffix(Pattern::string(), L::string()) -&gt; string() | error</tt><br></p>
633 | <p> </p>
634 | </div><p>
635 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_(using_2_wildcard_characters)_to_return_only_the_suffix_after_the_pattern.">Parse a string based on the supplied wildcard pattern (using 2 wildcard characters) to return only the suffix after the pattern.</a></h4>
636 |   "*" and "?" are wildcard characters (equivalent to the ".+" regex).
637 |   "**", "??", "*?" and "?*" are forbidden.  "?" must not be the last
638 |   character in the pattern.</p>
639 | 
640 | <h3 class="function"><a name="pattern_fill-2">pattern_fill/2</a></h3>
641 | <div class="spec">
642 | <p><tt>pattern_fill(FillPattern::string(), Parameters::[string()]) -&gt; {ok, string()} | {error, parameters_ignored | parameter_missing}</tt><br></p>
643 | <p> </p>
644 | </div><p>
645 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
646 |   The "*" wildcard character may be used consecutively by this function
647 |   to have parameters concatenated.</p>
648 | 
649 | <h3 class="function"><a name="pattern_fill-4">pattern_fill/4</a></h3>
650 | <div class="spec">
651 | <p><tt>pattern_fill(FillPattern::string(), Parameters::[string()], ParametersSelected::[pos_integer()], ParametersStrictMatching::boolean()) -&gt; {ok, string()} | {error, parameters_ignored | parameter_missing | parameters_selected_empty | {parameters_selected_ignored, [pos_integer()]} | {parameters_selected_missing, pos_integer()}}</tt><br></p>
652 | <p> </p>
653 | </div><p>
654 |   <h4><a name="Fill_wildcard_characters_in_a_string.">Fill wildcard characters in a string.</a></h4>
655 |   The "*" wildcard character may be used consecutively by this function
656 |   to have parameters concatenated.</p>
657 | 
658 | <h3 class="function"><a name="pattern_parse-2">pattern_parse/2</a></h3>
659 | <div class="spec">
660 | <p><tt>pattern_parse(Pattern::string(), L::string()) -&gt; [string()] | error</tt><br></p>
661 | <p> </p>
662 | </div><p>
663 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern.">Parse a string based on the supplied wildcard pattern.</a></h4>
664 |   "*" is the wildcard character (equivalent to the ".+" regex).
665 |   "**" is forbidden.</p>
666 | 
667 | <h3 class="function"><a name="pattern_parse-3">pattern_parse/3</a></h3>
668 | <div class="spec">
669 | <p><tt>pattern_parse(Pattern::string(), L::string(), Option::default | with_suffix | expanded) -&gt; [string()] | {[string()], string()} | [string() | {exact, string()}] | error</tt><br></p>
670 | <p> </p>
671 | </div><p>
672 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern.">Parse a string based on the supplied wildcard pattern.</a></h4>
673 |   "*" is the wildcard character (equivalent to the ".+" regex).
674 |   "**" is forbidden.</p>
675 | 
676 | <h3 class="function"><a name="pattern_suffix-2">pattern_suffix/2</a></h3>
677 | <div class="spec">
678 | <p><tt>pattern_suffix(Pattern::string(), L::string()) -&gt; string() | error</tt><br></p>
679 | <p> </p>
680 | </div><p>
681 |   <h4><a name="Parse_a_string_based_on_the_supplied_wildcard_pattern_to_return_only_the_suffix_after_the_pattern.">Parse a string based on the supplied wildcard pattern to return only the suffix after the pattern.</a></h4>
682 |   "*" is the wildcard character (equivalent to the ".+" regex).
683 |   "**" is forbidden.</p>
684 | 
685 | <h3 class="function"><a name="prefix-3">prefix/3</a></h3>
686 | <div class="spec">
687 | <p><tt>prefix(Key::nonempty_string(), Value::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
688 | <p> </p>
689 | </div><p>
690 |   <h4><a name="Insert_a_value_as_the_first_list_element_in_a_trie_instance.">Insert a value as the first list element in a trie instance.</a></h4>
691 |   The reverse of append/3.</p>
692 | 
693 | <h3 class="function"><a name="size-1">size/1</a></h3>
694 | <div class="spec">
695 | <p><tt>size(Node::<a href="#type-trie">trie()</a>) -&gt; non_neg_integer()</tt><br></p>
696 | <p> </p>
697 | </div><p>
698 |   <h4><a name="Size_of_a_trie_instance.">Size of a trie instance.</a></h4>
699 | </p>
700 | 
701 | <h3 class="function"><a name="store-2">store/2</a></h3>
702 | <div class="spec">
703 | <p><tt>store(Key::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
704 | <p> </p>
705 | </div><p>
706 |   <h4><a name="Store_only_a_key_in_a_trie_instance.">Store only a key in a trie instance.</a></h4>
707 | </p>
708 | 
709 | <h3 class="function"><a name="store-3">store/3</a></h3>
710 | <div class="spec">
711 | <p><tt>store(Key::nonempty_string(), NewValue::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
712 | <p> </p>
713 | </div><p>
714 |   <h4><a name="Store_a_key/value_pair_in_a_trie_instance.">Store a key/value pair in a trie instance.</a></h4>
715 | </p>
716 | 
717 | <h3 class="function"><a name="take-2">take/2</a></h3>
718 | <div class="spec">
719 | <p><tt>take(Key::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; {any(), <a href="#type-trie">trie()</a>} | error</tt><br></p>
720 | <p> </p>
721 | </div><p>
722 |   <h4><a name="Take_a_value_from_the_trie.">Take a value from the trie.</a></h4>
723 | </p>
724 | 
725 | <h3 class="function"><a name="to_list-1">to_list/1</a></h3>
726 | <div class="spec">
727 | <p><tt>to_list(Node::<a href="#type-trie">trie()</a>) -&gt; [{nonempty_string(), any()}]</tt><br></p>
728 | <p> </p>
729 | </div><p>
730 |   <h4><a name="Convert_all_entries_in_a_trie_to_a_list.">Convert all entries in a trie to a list.</a></h4>
731 |   The list is in alphabetical order.</p>
732 | 
733 | <h3 class="function"><a name="to_list_similar-2">to_list_similar/2</a></h3>
734 | <div class="spec">
735 | <p><tt>to_list_similar(Similar::nonempty_string(), Node::<a href="#type-trie">trie()</a>) -&gt; [{nonempty_string(), any()}]</tt><br></p>
736 | <p> </p>
737 | </div><p>
738 |   <h4><a name="Return_a_list_of_all_entries_within_a_trie_that_share_a_common_prefix.">Return a list of all entries within a trie that share a common prefix.</a></h4>
739 | </p>
740 | 
741 | <h3 class="function"><a name="update-3">update/3</a></h3>
742 | <div class="spec">
743 | <p><tt>update(T::nonempty_string(), F::fun((any()) -&gt; any()), Node::<a href="#type-nonempty_trie">nonempty_trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
744 | <p> </p>
745 | </div><p>
746 |   <h4><a name="Update_a_value_in_a_trie.">Update a value in a trie.</a></h4>
747 | </p>
748 | 
749 | <h3 class="function"><a name="update-4">update/4</a></h3>
750 | <div class="spec">
751 | <p><tt>update(Key::nonempty_string(), F::fun((any()) -&gt; any()), Initial::any(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
752 | <p> </p>
753 | </div><p>
754 |   <h4><a name="Update_or_add_a_value_in_a_trie.">Update or add a value in a trie.</a></h4>
755 | </p>
756 | 
757 | <h3 class="function"><a name="update_counter-3">update_counter/3</a></h3>
758 | <div class="spec">
759 | <p><tt>update_counter(Key::nonempty_string(), Increment::number(), Node::<a href="#type-trie">trie()</a>) -&gt; <a href="#type-nonempty_trie">nonempty_trie()</a></tt><br></p>
760 | <p> </p>
761 | </div><p>
762 |   <h4><a name="Update_a_counter_in_a_trie.">Update a counter in a trie.</a></h4>
763 | </p>
764 | <hr>
765 | 
766 | <div class="navbar"><a name="#navbar_bottom"></a><table width="100%" border="0" cellspacing="0" cellpadding="2" summary="navigation bar"><tr><td><a href="overview-summary.html" target="overviewFrame">Overview</a></td><td><a href="http://www.erlang.org/"><img src="erlang.png" align="right" border="0" alt="erlang logo"></a></td></tr></table></div>
767 | <p><i>Generated by EDoc</i></p>
768 | </body>
769 | </html>
770 | 


--------------------------------------------------------------------------------
/generate_docs.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/sh
 2 | FILES_CHANGED=`git status --porcelain 2>/dev/null| grep "^?? src\/" | wc -l`
 3 | if [ ${FILES_CHANGED} -ne 0 ]; then
 4 |     echo "Commit changes!"
 5 |     exit 1
 6 | fi
 7 | sed -e "/-include(\"trie.hrl\")\./ r src/trie.hrl" \
 8 |     -e "/-include(\"trie.hrl\")\./d" \
 9 |     src/trie.erl > src/trie.erl.doc
10 | sed -e "/-include(\"trie.hrl\")\./ r src/trie.hrl" \
11 |     -e "/-include(\"trie.hrl\")\./d" \
12 |     src/btrie.erl > src/btrie.erl.doc
13 | mv src/trie.erl.doc src/trie.erl
14 | mv src/btrie.erl.doc src/btrie.erl
15 | rebar doc
16 | git checkout src
17 | 
18 | 


--------------------------------------------------------------------------------
/mix.exs:
--------------------------------------------------------------------------------
 1 | #-*-Mode:elixir;coding:utf-8;tab-width:2;c-basic-offset:2;indent-tabs-mode:()-*-
 2 | # ex: set ft=elixir fenc=utf-8 sts=2 ts=2 sw=2 et nomod:
 3 | 
 4 | defmodule Trie.Mixfile do
 5 |   use Mix.Project
 6 | 
 7 |   def project do
 8 |     [app: :trie,
 9 |      version: "2.0.7",
10 |      language: :erlang,
11 |      erlc_options: [
12 |        :deterministic,
13 |        :debug_info,
14 |        :warn_export_vars,
15 |        :warn_unused_import,
16 |        #:warn_missing_spec,
17 |        :warnings_as_errors],
18 |      description: description(),
19 |      package: package(),
20 |      deps: deps()]
21 |   end
22 | 
23 |   defp deps do
24 |     []
25 |   end
26 | 
27 |   defp description do
28 |     "Erlang Trie Implementation"
29 |   end
30 | 
31 |   defp package do
32 |     [files: ~w(src doc test rebar.config README.markdown LICENSE),
33 |      maintainers: ["Michael Truog"],
34 |      licenses: ["MIT"],
35 |      links: %{"GitHub" => "https://github.com/okeuday/trie"}]
36 |    end
37 | end
38 | 


--------------------------------------------------------------------------------
/rebar.config:
--------------------------------------------------------------------------------
 1 | %-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
 2 | % ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
 3 | 
 4 | {erl_opts,
 5 |  [warn_export_vars,
 6 |   warn_unused_import,
 7 |   %warn_missing_spec,
 8 |   warnings_as_errors]}.
 9 | {edoc_opts, [{preprocess, true}]}.
10 | {cover_enabled, true}.
11 | {cover_print_enabled, true}.
12 | {cover_export_enabled, true}.
13 | 


--------------------------------------------------------------------------------
/src/btrie.erl:
--------------------------------------------------------------------------------
  1 | %-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
  2 | % ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
  3 | %%%
  4 | %%%------------------------------------------------------------------------
  5 | %%% @doc
  6 | %%% ==A trie data structure implementation.==
  7 | %%% The trie (i.e., from "retrieval") data structure was invented by
  8 | %%% Edward Fredkin (it is a form of radix sort).  The implementation stores
  9 | %%% string suffixes as a list because it is a PATRICIA trie
 10 | %%% (PATRICIA - Practical Algorithm to Retrieve Information
 11 | %%%  Coded in Alphanumeric, D.R.Morrison (1968)).
 12 | %%%
 13 | %%% This Erlang trie implementation uses binary keys.  Using binary keys
 14 | %%% means that other data structures are quicker alternatives, so this
 15 | %%% module is probably not a good choice, unless it is used for functions
 16 | %%% not available elsewhere.
 17 | %%% @end
 18 | %%%
 19 | %%% MIT License
 20 | %%%
 21 | %%% Copyright (c) 2010-2025 Michael Truog <mjtruog at protonmail dot com>
 22 | %%%
 23 | %%% Permission is hereby granted, free of charge, to any person obtaining a
 24 | %%% copy of this software and associated documentation files (the "Software"),
 25 | %%% to deal in the Software without restriction, including without limitation
 26 | %%% the rights to use, copy, modify, merge, publish, distribute, sublicense,
 27 | %%% and/or sell copies of the Software, and to permit persons to whom the
 28 | %%% Software is furnished to do so, subject to the following conditions:
 29 | %%%
 30 | %%% The above copyright notice and this permission notice shall be included in
 31 | %%% all copies or substantial portions of the Software.
 32 | %%%
 33 | %%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 34 | %%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 35 | %%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 36 | %%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 37 | %%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 38 | %%% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 39 | %%% DEALINGS IN THE SOFTWARE.
 40 | %%%
 41 | %%% @author Michael Truog <mjtruog at protonmail dot com>
 42 | %%% @copyright 2010-2025 Michael Truog
 43 | %%% @version 2.0.8 {@date} {@time}
 44 | %%%------------------------------------------------------------------------
 45 | 
 46 | -module(btrie).
 47 | -author('mjtruog at protonmail dot com').
 48 | 
 49 | %% external interface
 50 | -export([append/3,
 51 |          append_list/3,
 52 |          erase/2,
 53 |          erase_similar/2,
 54 |          fetch/2,
 55 |          fetch_keys/1,
 56 |          fetch_keys_similar/2,
 57 |          find_prefix/2,
 58 |          find_prefixes/2,
 59 |          find_prefix_longest/2,
 60 |          filter/2,
 61 |          find/2,
 62 |          fold/3,
 63 |          foldl/3,
 64 |          foldr/3,
 65 |          fold_similar/4,
 66 |          foldl_similar/4,
 67 |          foldr_similar/4,
 68 |          foreach/2,
 69 |          from_list/1,
 70 |          is_key/2,
 71 |          map/2,
 72 |          merge/3,
 73 |          new/0,
 74 |          new/1,
 75 |          prefix/3,
 76 |          size/1,
 77 |          store/2,
 78 |          store/3,
 79 |          take/2,
 80 |          to_list/1,
 81 |          to_list_similar/2,
 82 |          update/3,
 83 |          update/4,
 84 |          update_counter/3,
 85 |          test/0]).
 86 | 
 87 | -define(MODE_BINARY, true).
 88 | -include("trie.hrl").
 89 | 
 90 | %%%------------------------------------------------------------------------
 91 | %%% External interface functions
 92 | %%%------------------------------------------------------------------------
 93 | 
 94 | %%-------------------------------------------------------------------------
 95 | %% @private
 96 | %% @doc
 97 | %% ===Regression test.===
 98 | %% @end
 99 | %%-------------------------------------------------------------------------
100 | 
101 | test() ->
102 |     {97,97,{{<<>>,empty}}} = btrie:new([<<"a">>]),
103 |     {97,97,{{<<"b">>,empty}}} = btrie:new([<<"ab">>]),
104 |     {97,97,{{<<"bc">>,empty}}} = btrie:new([<<"abc">>]),
105 |     {97,97,{{<<"b">>,empty}}} = btrie:new([<<"ab">>]),
106 |     {97,97,{{{97,98,{{<<>>,empty},{<<>>,empty}}},error}}} = 
107 |         btrie:new([<<"ab">>,<<"aa">>]),
108 |     {97,97,{{{97,98,{{<<"c">>,empty},{<<"c">>,empty}}},error}}} =
109 |         btrie:new([<<"abc">>,<<"aac">>]),
110 |     {97,97,{{{97,98,{{<<"c">>,2},{<<"c">>,1}}},error}}} =
111 |         btrie:new([{<<"abc">>, 1},{<<"aac">>, 2}]),
112 |     {97,97,{{{97,98,{{<<"c">>,2},{<<"cdefghijklmnopqrstuvwxyz">>,1}}},error}}} =
113 |         RootNode0 = btrie:new([
114 |             {<<"abcdefghijklmnopqrstuvwxyz">>, 1},{<<"aac">>, 2}]),
115 |     {ok, 1} = btrie:find(<<"abcdefghijklmnopqrstuvwxyz">>, RootNode0),
116 |     error = btrie:find(<<"abcdefghijklmnopqrstuvwxy">>, RootNode0),
117 |     {ok, 1} = btrie:find_prefix(<<"abcdefghijklmnopqrstuvwxyz">>, RootNode0),
118 |     prefix = btrie:find_prefix(<<"abcdefghijklmnopqrstuvwxy">>, RootNode0),
119 |     error = btrie:find_prefix(<<"abcdefghijklmnopqrstuvwxyzX">>, RootNode0),
120 |     prefix = btrie:find_prefix(<<"a">>, RootNode0),
121 |     prefix = btrie:find_prefix(<<"aa">>, RootNode0),
122 |     {ok, 2} = btrie:find_prefix(<<"aac">>, RootNode0),
123 |     error = btrie:find_prefix(<<"aacX">>, RootNode0),
124 |     {97,97,{{{97,98,{{{98,99,{{<<"cde">>,3},{<<>>,2}}},error},
125 |      {<<"cdefghijklmnopqrstuvwxyz">>,1}}},error}}} =
126 |         RootNode1 = btrie:store(<<"aabcde">>, 3, RootNode0),
127 |     {97,97,{{{97,98,{{{98,99,{{<<"cde">>,13},{<<>>,12}}},error},
128 |      {<<"cdefghijklmnopqrstuvwxyz">>,11}}},error}}} =
129 |         map(fun(_, V) -> V + 10 end, RootNode1),
130 |     {97,97,{{{97,98,{{{98,99,{{<<>>,error},{<<>>,error}}},error},
131 |      {<<"cdefghijklmnopqrstuvwxyz">>,1}}},error}}} =
132 |         filter(fun(_, V) -> V =< 1 end, RootNode1),
133 |     {97,97,{{{97,98,{{{98,99,{{<<>>,error},{<<>>,2}}},error},
134 |      {<<"cdefghijklmnopqrstuvwxyz">>,1}}},error}}} =
135 |         filter(fun(_, V) -> V =< 2 end, RootNode1),
136 |     [<<"aabcde">>, <<"aac">>, <<"abcdefghijklmnopqrstuvwxyz">>] =
137 |         btrie:fetch_keys(RootNode1),
138 |     [{<<"aabcde">>, 3}, {<<"aac">>, 2},
139 |      {<<"abcdefghijklmnopqrstuvwxyz">>, 1}] = btrie:to_list(RootNode1),
140 |     [{<<"aabcde">>, 3}, {<<"aac">>, 12},
141 |      {<<"abcdefghijklmnopqrstuvwxyz">>, 1}] =
142 |         btrie:to_list(btrie:update(
143 |             <<"aac">>, fun(I) -> I + 10 end, RootNode1)),
144 |     [{<<"aaa">>, 4}, {<<"aabcde">>, 3}, {<<"aac">>, 2},
145 |      {<<"abcdefghijklmnopqrstuvwxyz">>, 1}] =
146 |         btrie:to_list(btrie:update(
147 |             <<"aaa">>, fun(I) -> I + 10 end, 4, RootNode1)),
148 |     6 = foldl(fun(_, I, A) -> I + A end, 0, RootNode1),
149 |     [{<<"aabcde">>, 3},{<<"aac">>, 2},{<<"abcdefghijklmnopqrstuvwxyz">>, 1}] =
150 |         foldr(fun(K, V, A) -> [{K,V} | A] end, [], RootNode1),
151 |     [{<<"abcdefghijklmnopqrstuvwxyz">>, 1}, {<<"aac">>, 2}, {<<"aabcde">>, 3}] =
152 |         foldl(fun(K, V, A) -> [{K,V} | A] end, [], RootNode1),
153 |     error = btrie:find(<<"aabcde">>, RootNode0),
154 |     {ok, 3} = btrie:find(<<"aabcde">>, RootNode1),
155 |     RootNode2 = btrie:erase(<<"aac">>, RootNode0),
156 |     {ok, 1} = btrie:find(<<"abcdefghijklmnopqrstuvwxyz">>, RootNode2),
157 |     {97,98,{{{98,98,{{<<>>,[2]}}},[1]},{<<"c">>,[3]}}} =
158 |         RootNode3 = btrie:new([{<<"a">>, [1]},{<<"ab">>, [2]},{<<"bc">>, [3]}]),
159 |     {97,98,{{{98,98,{{<<>>,[2]}}},[1,2]},{<<"c">>,[3]}}} =
160 |         btrie:append(<<"a">>, 2, RootNode3),
161 | 
162 |     RootNode4 = btrie:new([
163 |         {<<"ammmmmmm">>,      7},
164 |         {<<"aaaaaaaaaaa">>,   4},
165 |         {<<"aaa">>,           2},
166 |         {<<"ab">>,            0},
167 |         {<<"ab">>,            5},
168 |         {<<"aa">>,            1},
169 |         {<<"aba">>,           6},
170 |         {<<"aaaaaaaa">>,      3}]),
171 |     {97,97,
172 |      {{{97,109,
173 |         {{{97,97,
174 |            {{{97,97,
175 |               {{{97,97,
176 |                  {{{97,97,
177 |                     {{{97,97,
178 |                        {{{97,97,
179 |                           {{{97,97,
180 |                              {{<<"aa">>,4}}},
181 |                             3}}},
182 |                          error}}},
183 |                      error}}},
184 |                    error}}},
185 |                 error}}},
186 |              2}}},
187 |           1},
188 |          {{97,97,{{<<>>,6}}},5},
189 |          {<<>>,error},
190 |          {<<>>,error},
191 |          {<<>>,error},
192 |          {<<>>,error},
193 |          {<<>>,error},
194 |          {<<>>,error},
195 |          {<<>>,error},
196 |          {<<>>,error},
197 |          {<<>>,error},
198 |          {<<>>,error},
199 |          {<<"mmmmmm">>,7}}},
200 |        error}}} = RootNode4,
201 |     [{<<"aa">>,1},
202 |      {<<"aaa">>,2},
203 |      {<<"aaaaaaaa">>,3},
204 |      {<<"aaaaaaaaaaa">>,4},
205 |      {<<"ab">>,5},
206 |      {<<"aba">>,6},
207 |      {<<"ammmmmmm">>,7}] = btrie:to_list(
208 |         btrie:from_list(btrie:to_list(RootNode4))),
209 |     [<<"aa">>,
210 |      <<"aaa">>,
211 |      <<"aaaaaaaa">>,
212 |      <<"aaaaaaaaaaa">>,
213 |      <<"ab">>,
214 |      <<"aba">>,
215 |      <<"ammmmmmm">>] = btrie:fetch_keys(RootNode4),
216 |     [<<"aa">>,
217 |      <<"aaa">>,
218 |      <<"aaaaaaaa">>,
219 |      <<"aaaaaaaaaaa">>,
220 |      <<"ab">>,
221 |      <<"aba">>,
222 |      <<"ammmmmmm">>] = btrie:foldr(
223 |         fun(Key, _, L) -> [Key | L] end, [], RootNode4),
224 |     [<<"ammmmmmm">>,
225 |      <<"aba">>,
226 |      <<"ab">>,
227 |      <<"aaaaaaaaaaa">>,
228 |      <<"aaaaaaaa">>,
229 |      <<"aaa">>,
230 |      <<"aa">>] = btrie:foldl(
231 |         fun(Key, _, L) -> [Key | L] end, [], RootNode4),
232 |     RootNode5 = btrie:store(<<"a">>, 0,
233 |         btrie:store(<<"aaaa">>, 2.5, RootNode4)),
234 |     {ok, 2.5} = btrie:find(<<"aaaa">>, RootNode5),
235 |     error = btrie:find(<<"aaaa">>, RootNode4),
236 |     {ok, 2.5} = btrie:find_prefix(<<"aaaa">>, RootNode5),
237 |     prefix = btrie:find_prefix(<<"aaaa">>, RootNode4),
238 |     error = btrie:find_prefix_longest(<<"a">>, RootNode4),
239 |     {ok, <<"aa">>, 1} = btrie:find_prefix_longest(<<"aa">>, RootNode4),
240 |     {ok, <<"aaa">>, 2} = btrie:find_prefix_longest(<<"aaaa">>, RootNode4),
241 |     {ok, <<"ab">>, 5} = btrie:find_prefix_longest(<<"absolut">>, RootNode4),
242 |     {ok, <<"aba">>, 6} = btrie:find_prefix_longest(<<"aba">>, RootNode4),
243 |     {ok, <<"aaaaaaaa">>, 3} = btrie:find_prefix_longest(<<"aaaaaaaaa">>, RootNode4),
244 |     error = btrie:find_prefix_longest(<<"bar">>, RootNode4),
245 |     {ok, <<"aaaaaaaaaaa">>, 4} = btrie:find_prefix_longest(<<"aaaaaaaaaaaaaaaaaaaaaddddddaa">>, RootNode4),
246 |     2.5 = btrie:fetch(<<"aaaa">>, RootNode5),
247 |     {error, if_clause} = ?EXCEPTION(btrie:fetch(<<"aaaa">>, RootNode4)),
248 |     RootNode4 = btrie:erase(<<"a">>, btrie:erase(<<"aaaa">>, RootNode5)),
249 |     true = btrie:is_key(<<"aaaa">>, RootNode5),
250 |     false = btrie:is_key(<<"aaaa">>, RootNode4),
251 |     [<<"aa">>,
252 |      <<"aaa">>,
253 |      <<"aaaaaaaa">>,
254 |      <<"aaaaaaaaaaa">>] = btrie:fetch_keys_similar(<<"aa">>, RootNode4),
255 |     [<<"aaa">>,
256 |      <<"aaaaaaaa">>,
257 |      <<"aaaaaaaaaaa">>] = btrie:fetch_keys_similar(<<"aaac">>, RootNode4),
258 |     [<<"ab">>,
259 |      <<"aba">>] = btrie:fetch_keys_similar(<<"abba">>, RootNode4),
260 |     [<<"aa">>,
261 |      <<"aaa">>,
262 |      <<"aaaaaaaa">>,
263 |      <<"aaaaaaaaaaa">>,
264 |      <<"ab">>,
265 |      <<"aba">>,
266 |      <<"ammmmmmm">>] = btrie:fetch_keys_similar(<<"a">>, RootNode4),
267 |     [] = btrie:fetch_keys_similar(<<"b">>, RootNode4),
268 |     _RootNode6 = btrie:new([
269 |         {<<"*">>,      1},
270 |         {<<"aa*">>,    2},
271 |         {<<"aa*b">>,   3},
272 |         {<<"aa*a*">>,  4},
273 |         {<<"aaaaa">>,  5}]),
274 |     ok.
275 | 
276 | %%%------------------------------------------------------------------------
277 | %%% Private functions
278 | %%%------------------------------------------------------------------------
279 | 
280 | %% make a new tuple with arity N and default D, then
281 | %% move tuple T into the new tuple at index I
282 | tuple_move(I, N, T, D)
283 |     when is_integer(I), is_integer(N), is_tuple(T),
284 |          (N - I + 1) >= tuple_size(T) ->
285 |     tuple_move_i(I, 1, I + tuple_size(T), erlang:make_tuple(N, D), T).
286 | 
287 | tuple_move_i(N1, _, N1, T1, _) ->
288 |     T1;
289 | 
290 | tuple_move_i(I1, I0, N1, T1, T0) ->
291 |     tuple_move_i(I1 + 1, I0 + 1, N1,
292 |         erlang:setelement(I1, T1, erlang:element(I0, T0)), T0).
293 | 
294 | binary_prefix(<<>>, _) ->
295 |     true;
296 | binary_prefix(KeyEnd1, KeyEnd2) ->
297 |     case binary:match(KeyEnd2, KeyEnd1, []) of
298 |         {0, _} ->
299 |             true;
300 |         _  ->
301 |             false
302 |     end.
303 | 
304 | -ifdef(TEST).
305 | -include_lib("eunit/include/eunit.hrl").
306 | 
307 | -include("trie_test.hrl").
308 | 
309 | module_test_() ->
310 |     {timeout, ?TEST_TIMEOUT, [
311 |         {"internal tests", ?_assertOk(test())}
312 |     ]}.
313 | 
314 | -endif.
315 | 
316 | 


--------------------------------------------------------------------------------
/src/trie.app.src:
--------------------------------------------------------------------------------
 1 | %-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
 2 | % ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
 3 | 
 4 | {application, trie,
 5 |   [{description, "Trie Data Structure"},
 6 |    {vsn, "2.0.7"},
 7 |    {modules, [btrie, trie]},
 8 |    {registered, []},
 9 |    {applications, [stdlib, kernel]}]}.
10 | 
11 | 


--------------------------------------------------------------------------------
/src/trie.hrl:
--------------------------------------------------------------------------------
   1 | %-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
   2 | % ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
   3 | %%%
   4 | %%%------------------------------------------------------------------------
   5 | %%%
   6 | %%% This file contains trie functions utilized by both the string
   7 | %%% (list of integers) trie implementation and the binary trie
   8 | %%% implementation.
   9 | %%%
  10 | %%% MIT License
  11 | %%%
  12 | %%% Copyright (c) 2010-2025 Michael Truog <mjtruog at protonmail dot com>
  13 | %%%
  14 | %%% Permission is hereby granted, free of charge, to any person obtaining a
  15 | %%% copy of this software and associated documentation files (the "Software"),
  16 | %%% to deal in the Software without restriction, including without limitation
  17 | %%% the rights to use, copy, modify, merge, publish, distribute, sublicense,
  18 | %%% and/or sell copies of the Software, and to permit persons to whom the
  19 | %%% Software is furnished to do so, subject to the following conditions:
  20 | %%%
  21 | %%% The above copyright notice and this permission notice shall be included in
  22 | %%% all copies or substantial portions of the Software.
  23 | %%%
  24 | %%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  25 | %%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  26 | %%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  27 | %%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  28 | %%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  29 | %%% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  30 | %%% DEALINGS IN THE SOFTWARE.
  31 | %%%
  32 | %%%------------------------------------------------------------------------
  33 | 
  34 | -ifdef(MODE_LIST).
  35 | -define(TYPE_NAME, nonempty_string()).
  36 | -define(TYPE_EMPTY, []).
  37 | -define(TYPE_CHECK(V), is_list(V)).
  38 | -define(TYPE_H0T0, [H | T]).
  39 | -define(TYPE_H0_, [H | _]).
  40 | -define(TYPE_H0, [H]).
  41 | -define(TYPE_H1T1, [H1 | T1]).
  42 | -define(TYPE_BHBT, [BH | BT]).
  43 | -define(TYPE_KEYH0, Key ++ [H]).
  44 | -define(TYPE_KEYH0T0, Key ++ [H] ++ T).
  45 | -define(TYPE_KEYH0CHILDNODE, Key ++ [H] ++ ChildNode).
  46 | -define(TYPE_KEYCHAR, Key ++ [Character]).
  47 | -define(TYPE_KEYCHARNODE, Key ++ [Character] ++ Node).
  48 | -define(TYPE_NEWKEYNODE, NewKey ++ Node).
  49 | -define(TYPE_NEWKEY, [H | Key]).
  50 | -define(TYPE_NEWKEY_REVERSE(X), lists:reverse(X)).
  51 | -define(TYPE_NEWKEY_REVERSE(X, Y), lists:reverse(X, Y)).
  52 | -define(TYPE_PREFIX(X, Y), lists:prefix(X, Y)).
  53 | -else.
  54 | -ifdef(MODE_BINARY).
  55 | -define(TYPE_NAME, <<_:8, _:_*8>>).
  56 | -define(TYPE_EMPTY, <<>>).
  57 | -define(TYPE_CHECK(V), is_binary(V)).
  58 | -define(TYPE_H0T0, <<H:8, T/binary>>).
  59 | -define(TYPE_H0_, <<H:8, _/binary>>).
  60 | -define(TYPE_H0, <<H:8>>).
  61 | -define(TYPE_H1T1, <<H1:8, T1/binary>>).
  62 | -define(TYPE_BHBT, <<BH:8, BT/binary>>).
  63 | -define(TYPE_KEYH0, <<Key/binary, H:8>>).
  64 | -define(TYPE_KEYH0T0, <<Key/binary, H:8, T/binary>>).
  65 | -define(TYPE_KEYH0CHILDNODE, <<Key/binary, H:8, ChildNode/binary>>).
  66 | -define(TYPE_KEYCHAR, <<Key/binary, Character:8>>).
  67 | -define(TYPE_KEYCHARNODE, <<Key/binary, Character:8, Node/binary>>).
  68 | -define(TYPE_NEWKEYNODE, <<NewKey/binary, Node/binary>>).
  69 | -define(TYPE_NEWKEY, <<Key/binary, H:8>>).
  70 | -define(TYPE_NEWKEY_REVERSE(X), X).
  71 | -define(TYPE_NEWKEY_REVERSE(X, Y), <<X/binary, Y/binary>>).
  72 | -define(TYPE_PREFIX(X, Y), binary_prefix(X, Y)).
  73 | -endif.
  74 | -endif.
  75 | 
  76 | -define(EXCEPTION(E),
  77 |         (fun() ->
  78 |              try _ = E, no_exception
  79 |              catch ErrorType:Error -> {ErrorType, Error}
  80 |              end
  81 |          end)()).
  82 | 
  83 | %%%------------------------------------------------------------------------
  84 | %%% External interface functions
  85 | %%%------------------------------------------------------------------------
  86 | 
  87 | -type nonempty_trie() :: {integer(), integer(), tuple()}.
  88 | -type empty_trie() :: ?TYPE_EMPTY.
  89 | -type trie() :: nonempty_trie() | empty_trie().
  90 | -export_type([nonempty_trie/0,
  91 |               empty_trie/0,
  92 |               trie/0]).
  93 | 
  94 | %%-------------------------------------------------------------------------
  95 | %% @doc
  96 | %% ===Append a value as a list element in a trie instance.===
  97 | %% @end
  98 | %%-------------------------------------------------------------------------
  99 | 
 100 | -spec append(Key :: ?TYPE_NAME,
 101 |              Value :: any(),
 102 |              Node :: trie()) -> nonempty_trie().
 103 | 
 104 | append(Key, Value, Node) ->
 105 |     ValueList = [Value],
 106 |     update(Key, fun(OldValue) -> OldValue ++ ValueList end, ValueList, Node).
 107 | 
 108 | %%-------------------------------------------------------------------------
 109 | %% @doc
 110 | %% ===Append a list of values as a list element in a trie instance.===
 111 | %% @end
 112 | %%-------------------------------------------------------------------------
 113 | 
 114 | -spec append_list(Key :: ?TYPE_NAME,
 115 |                   ValueList :: list(),
 116 |                   Node :: trie()) -> nonempty_trie().
 117 | 
 118 | append_list(Key, ValueList, Node) ->
 119 |     update(Key, fun(OldValue) -> OldValue ++ ValueList end, ValueList, Node).
 120 | 
 121 | %%-------------------------------------------------------------------------
 122 | %% @doc
 123 | %% ===Erase a value in a trie.===
 124 | %% @end
 125 | %%-------------------------------------------------------------------------
 126 | 
 127 | -spec erase(Key :: ?TYPE_NAME,
 128 |             Node :: trie()) -> trie().
 129 | 
 130 | erase(_, ?TYPE_EMPTY = Node) ->
 131 |     Node;
 132 | 
 133 | erase(?TYPE_H0T0, Node) ->
 134 |     erase_node(H, T, Node).
 135 | 
 136 | erase_node(H, _, {I0, I1, _} = Node)
 137 |     when is_integer(H), H < I0;
 138 |          is_integer(H), H > I1 ->
 139 |     Node;
 140 | 
 141 | erase_node(H, T, {I0, I1, Data} = OldNode)
 142 |     when is_integer(H) ->
 143 |     I = H - I0 + 1,
 144 |     {Node, Value} = erlang:element(I, Data),
 145 |     if
 146 |         T == Node ->
 147 |             if
 148 |                 Value =:= error ->
 149 |                     OldNode;
 150 |                 true ->
 151 |                     {I0, I1, erlang:setelement(I, Data, {?TYPE_EMPTY, error})}
 152 |             end;
 153 |         T =:= ?TYPE_EMPTY ->
 154 |             if
 155 |                 Value =:= error ->
 156 |                     OldNode;
 157 |                 true ->
 158 |                     {I0, I1, erlang:setelement(I, Data, {Node, error})}
 159 |             end;
 160 |         ?TYPE_CHECK(Node) ->
 161 |             OldNode;
 162 |         is_tuple(Node) ->
 163 |             ?TYPE_H1T1 = T,
 164 |             {I0, I1, erlang:setelement(I, Data,
 165 |                 {erase_node(H1, T1, Node), Value})}
 166 |     end.
 167 | 
 168 | %%-------------------------------------------------------------------------
 169 | %% @doc
 170 | %% ===Erase all entries within a trie that share a common prefix.===
 171 | %% @end
 172 | %%-------------------------------------------------------------------------
 173 | 
 174 | -spec erase_similar(Similar :: ?TYPE_NAME,
 175 |                     Node :: trie()) -> list(?TYPE_NAME).
 176 | 
 177 | erase_similar(Similar, Node) ->
 178 |     fold_similar(Similar, fun(Key, _, N) -> erase(Key, N) end, Node, Node).
 179 | 
 180 | %%-------------------------------------------------------------------------
 181 | %% @doc
 182 | %% ===Fetch a value from a trie.===
 183 | %% @end
 184 | %%-------------------------------------------------------------------------
 185 | 
 186 | -spec fetch(?TYPE_NAME,
 187 |             nonempty_trie()) -> any().
 188 | 
 189 | fetch(?TYPE_H0T0, {_, _, _} = Node) ->
 190 |     fetch_node(H, T, Node).
 191 | 
 192 | fetch_node(H, T, {I0, I1, Data})
 193 |     when is_integer(H), H >= I0, H =< I1 ->
 194 |     {Node, Value} = erlang:element(H - I0 + 1, Data),
 195 |     case T of
 196 |         ?TYPE_EMPTY ->
 197 |             if
 198 |                 is_tuple(Node); Node =:= ?TYPE_EMPTY ->
 199 |                     if
 200 |                         Value =/= error ->
 201 |                             Value
 202 |                     end
 203 |             end;
 204 |         ?TYPE_H1T1 ->
 205 |             case Node of
 206 |                 {_, _, _} ->
 207 |                     fetch_node(H1, T1, Node);
 208 |                 T when Value =/= error ->
 209 |                     Value
 210 |             end
 211 |     end.
 212 | 
 213 | %%-------------------------------------------------------------------------
 214 | %% @doc
 215 | %% ===Fetch all the keys in a trie.===
 216 | %% @end
 217 | %%-------------------------------------------------------------------------
 218 | 
 219 | -spec fetch_keys(Node :: trie()) -> list(?TYPE_NAME).
 220 | 
 221 | fetch_keys(Node) ->
 222 |     foldr(fun(Key, _, L) -> [Key | L] end, [], Node).
 223 | 
 224 | %%-------------------------------------------------------------------------
 225 | %% @doc
 226 | %% ===Fetch the keys within a trie that share a common prefix.===
 227 | %% @end
 228 | %%-------------------------------------------------------------------------
 229 | 
 230 | -spec fetch_keys_similar(Similar :: ?TYPE_NAME,
 231 |                          Node :: trie()) -> list(?TYPE_NAME).
 232 | 
 233 | fetch_keys_similar(Similar, Node) ->
 234 |     foldr_similar(Similar, fun(Key, _, L) -> [Key | L] end, [], Node).
 235 | 
 236 | %%-------------------------------------------------------------------------
 237 | %% @doc
 238 | %% ===Filter a trie with a predicate function.===
 239 | %% @end
 240 | %%-------------------------------------------------------------------------
 241 | 
 242 | -spec filter(F :: fun((?TYPE_NAME, any()) -> boolean()),
 243 |              Node :: trie()) -> trie().
 244 | 
 245 | filter(F, ?TYPE_EMPTY = Node) when is_function(F, 2) ->
 246 |     Node;
 247 | 
 248 | filter(F, Node) when is_function(F, 2) ->
 249 |     filter_node(F, ?TYPE_EMPTY, Node).
 250 | 
 251 | filter_node(F, Key, {I0, I1, Data}) ->
 252 |     {I0, I1, filter_element(F, I1 - I0 + 1, I0 - 1, Key, Data)};
 253 | 
 254 | filter_node(_, _, Node)
 255 |     when ?TYPE_CHECK(Node) ->
 256 |     Node.
 257 | 
 258 | filter_element(_, 0, _, _, Data) ->
 259 |     Data;
 260 | 
 261 | filter_element(F, I, Offset, Key, Data) ->
 262 |     {Node, Value} = erlang:element(I, Data),
 263 |     Character = Offset + I,
 264 |     if
 265 |         Node =:= ?TYPE_EMPTY ->
 266 |             if
 267 |                 Value =:= error ->
 268 |                     filter_element(F, I - 1, Offset, Key, Data);
 269 |                 true ->
 270 |                     case F(?TYPE_KEYCHAR, Value) of
 271 |                         true ->
 272 |                             filter_element(F, I - 1, Offset, Key, Data);
 273 |                         false ->
 274 |                             filter_element(F, I - 1, Offset, Key,
 275 |                                 erlang:setelement(I, Data,
 276 |                                     {?TYPE_EMPTY, error}))
 277 |                     end
 278 |             end;
 279 |         Value =:= error ->
 280 |             filter_element(F, I - 1, Offset, Key, erlang:setelement(I, Data,
 281 |                 {filter_node(F, ?TYPE_KEYCHAR, Node), Value}));
 282 |         true ->
 283 |             NewKey = ?TYPE_KEYCHAR,
 284 |             if
 285 |                 ?TYPE_CHECK(Node) ->
 286 |                     case F(?TYPE_NEWKEYNODE, Value) of
 287 |                         true ->
 288 |                             filter_element(F, I - 1, Offset, Key, Data);
 289 |                         false ->
 290 |                             filter_element(F, I - 1, Offset, Key,
 291 |                                 erlang:setelement(I, Data,
 292 |                                     {?TYPE_EMPTY, error}))
 293 |                     end;
 294 |                 true ->
 295 |                     case F(NewKey, Value) of
 296 |                         true ->
 297 |                             filter_element(F, I - 1, Offset, Key, Data);
 298 |                         false ->
 299 |                             filter_element(F, I - 1, Offset, Key,
 300 |                                 erlang:setelement(I, Data,
 301 |                                     {filter_node(F, NewKey, Node), error}))
 302 |                     end
 303 |             end
 304 |     end.
 305 | 
 306 | %%-------------------------------------------------------------------------
 307 | %% @doc
 308 | %% ===Find a value in a trie.===
 309 | %% @end
 310 | %%-------------------------------------------------------------------------
 311 | 
 312 | -spec find(?TYPE_NAME, trie()) -> {ok, any()} | 'error'.
 313 | 
 314 | find(_, ?TYPE_EMPTY) ->
 315 |     error;
 316 | 
 317 | find(?TYPE_H0T0, {_, _, _} = Node) ->
 318 |     find_node(H, T, Node).
 319 | 
 320 | find_node(H, _, {I0, I1, _})
 321 |     when is_integer(H), H < I0;
 322 |          is_integer(H), H > I1 ->
 323 |     error;
 324 | 
 325 | find_node(H, ?TYPE_EMPTY, {I0, _, Data})
 326 |     when is_integer(H) ->
 327 |     {Node, Value} = erlang:element(H - I0 + 1, Data),
 328 |     if
 329 |         is_tuple(Node); Node =:= ?TYPE_EMPTY ->
 330 |             if
 331 |                 Value =:= error ->
 332 |                     error;
 333 |                 true ->
 334 |                     {ok, Value}
 335 |             end;
 336 |         true ->
 337 |             error
 338 |     end;
 339 | 
 340 | find_node(H, T, {I0, _, Data})
 341 |     when is_integer(H) ->
 342 |     {Node, Value} = erlang:element(H - I0 + 1, Data),
 343 |     case Node of
 344 |         {_, _, _} ->
 345 |             ?TYPE_H1T1 = T,
 346 |             find_node(H1, T1, Node);
 347 |         T ->
 348 |             if
 349 |                 Value =:= error ->
 350 |                     error;
 351 |                 true ->
 352 |                     {ok, Value}
 353 |             end;
 354 |         _ ->
 355 |             error
 356 |     end.
 357 | 
 358 | %%-------------------------------------------------------------------------
 359 | %% @doc
 360 | %% ===Find a value in a trie by prefix.===
 361 | %% The atom 'prefix' is returned if the string supplied is a prefix
 362 | %% for a key that has previously been stored within the trie, but no
 363 | %% value was found, since there was no exact match for the string supplied.
 364 | %% @end
 365 | %%-------------------------------------------------------------------------
 366 | 
 367 | -spec find_prefix(?TYPE_NAME, trie()) -> {ok, any()} | 'prefix' | 'error'.
 368 | 
 369 | find_prefix(?TYPE_H0_, {I0, I1, _})
 370 |     when H < I0; H > I1 ->
 371 |     error;
 372 | 
 373 | find_prefix(?TYPE_H0, {I0, _, Data})
 374 |     when is_integer(H) ->
 375 |     case erlang:element(H - I0 + 1, Data) of
 376 |         {{_, _, _}, error} ->
 377 |             prefix;
 378 |         {{_, _, _}, Value} ->
 379 |             {ok, Value};
 380 |         {_, error} ->
 381 |             error;
 382 |         {?TYPE_EMPTY, Value} ->
 383 |             {ok, Value};
 384 |         {_, _} ->
 385 |             prefix
 386 |     end;
 387 | 
 388 | find_prefix(?TYPE_H0T0, {I0, _, Data})
 389 |     when is_integer(H) ->
 390 |     case erlang:element(H - I0 + 1, Data) of
 391 |         {{_, _, _} = Node, _} ->
 392 |             find_prefix(T, Node);
 393 |         {_, error} ->
 394 |             error;
 395 |         {T, Value} ->
 396 |             {ok, Value};
 397 |         {L, _} ->
 398 |             case ?TYPE_PREFIX(T, L) of
 399 |                 true ->
 400 |                     prefix;
 401 |                 false ->
 402 |                     error
 403 |             end
 404 |     end;
 405 | 
 406 | find_prefix(_, ?TYPE_EMPTY) ->
 407 |     error.
 408 | 
 409 | %%-------------------------------------------------------------------------
 410 | %% @doc
 411 | %% ===Find the longest key in a trie that is a prefix to the passed string.===
 412 | %% @end
 413 | %%-------------------------------------------------------------------------
 414 | 
 415 | -spec find_prefix_longest(Match :: ?TYPE_NAME,
 416 |                           Node :: trie()) ->
 417 |     {ok, ?TYPE_NAME, any()} | 'error'.
 418 | 
 419 | find_prefix_longest(Match, Node) when is_tuple(Node) ->
 420 |     find_prefix_longest(Match, ?TYPE_EMPTY, error, Node);
 421 | 
 422 | find_prefix_longest(_Match, ?TYPE_EMPTY) ->
 423 |     error.
 424 | 
 425 | find_prefix_longest(?TYPE_H0T0, Key, LastMatch, {I0, I1, Data})
 426 |     when is_integer(H), H >= I0, H =< I1 ->
 427 |     {ChildNode, Value} = erlang:element(H - I0 + 1, Data),
 428 |     if
 429 |         is_tuple(ChildNode) ->
 430 |             %% If the prefix matched and there are other child leaf nodes
 431 |             %% for this prefix, then update the last match to the current
 432 |             %% prefix and continue recursing over the trie.
 433 |             NewKey = ?TYPE_NEWKEY,
 434 |             NewMatch = if
 435 |                 Value =:= error ->
 436 |                     LastMatch;
 437 |                 true ->
 438 |                     {NewKey, Value}
 439 |             end,
 440 |             find_prefix_longest(T, NewKey, NewMatch, ChildNode);
 441 |         true ->
 442 |             %% If this is a leaf node and the key for the current node is a
 443 |             %% prefix for the passed value, then return a match on the current
 444 |             %% node. Otherwise, return the last match we had found previously.
 445 |             case ?TYPE_PREFIX(ChildNode, T) of
 446 |                 true when Value =/= error ->
 447 |                     {ok, ?TYPE_NEWKEY_REVERSE(?TYPE_NEWKEY, ChildNode), Value};
 448 |                 _ ->
 449 |                     case LastMatch of
 450 |                         {LastKey, LastValue} ->
 451 |                             {ok, ?TYPE_NEWKEY_REVERSE(LastKey), LastValue};
 452 |                         error ->
 453 |                             error
 454 |                     end
 455 |             end
 456 |     end;
 457 | 
 458 | find_prefix_longest(_Match, _Key, {LastKey, LastValue}, _Node) ->
 459 |     {ok, ?TYPE_NEWKEY_REVERSE(LastKey), LastValue};
 460 | 
 461 | find_prefix_longest(_Match, _Key, error, _Node) ->
 462 |     error.
 463 | 
 464 | %%-------------------------------------------------------------------------
 465 | %% @doc
 466 | %% ===Find all the keys in a trie that are prefixes to the passed string.===
 467 | %% The entries are returned in alphabetical order.
 468 | %% @end
 469 | %%-------------------------------------------------------------------------
 470 | 
 471 | -spec find_prefixes(Match :: ?TYPE_NAME,
 472 |                       Node :: trie()) ->
 473 |     list({?TYPE_NAME, any()}).
 474 | 
 475 | find_prefixes(Match, Node) when is_tuple(Node) ->
 476 |     find_prefixes(Match, ?TYPE_EMPTY, [], Node);
 477 | 
 478 | find_prefixes(_Match, ?TYPE_EMPTY) ->
 479 |     [].
 480 | 
 481 | find_prefixes(?TYPE_H0T0, Key, Acc, {I0, I1, Data})
 482 |     when is_integer(H), H >= I0, H =< I1 ->
 483 |     {ChildNode, Value} = erlang:element(H - I0 + 1, Data),
 484 |     if
 485 |         is_tuple(ChildNode) ->
 486 |             %% If the prefix matched and there are other child leaf nodes
 487 |             %% for this prefix, then add the match to the current list
 488 |             %% and continue recursing over the trie.
 489 |             NewKey = ?TYPE_NEWKEY,
 490 |             NewAcc = if
 491 |                 Value =:= error ->
 492 |                     Acc;
 493 |                 true ->
 494 |                     [{?TYPE_NEWKEY_REVERSE(NewKey), Value} | Acc]
 495 |             end,
 496 |             find_prefixes(T, NewKey, NewAcc, ChildNode);
 497 |         true ->
 498 |             %% If this is a leaf node and the key for the current node is a
 499 |             %% prefix for the passed value, then add a match on the current
 500 |             %% node. Otherwise, return the last match we had found previously.
 501 |             NewAcc = case ?TYPE_PREFIX(ChildNode, T) of
 502 |                 true when Value =/= error ->
 503 |                     [{?TYPE_NEWKEY_REVERSE(?TYPE_NEWKEY, ChildNode), Value} |
 504 |                      Acc];
 505 |                 _ ->
 506 |                     Acc
 507 |             end,
 508 |             lists:reverse(NewAcc)
 509 |     end;
 510 | 
 511 | find_prefixes(_Match, _Key, Acc, _Node) ->
 512 |     lists:reverse(Acc).
 513 | 
 514 | %%-------------------------------------------------------------------------
 515 | %% @doc
 516 | %% ===Fold a function over the trie.===
 517 | %% Traverses in alphabetical order.
 518 | %% @end
 519 | %%-------------------------------------------------------------------------
 520 | 
 521 | -spec fold(F :: fun((?TYPE_NAME, any(), any()) -> any()),
 522 |            A :: any(),
 523 |            Node :: trie()) -> any().
 524 | 
 525 | fold(F, A, Node) when is_function(F, 3) ->
 526 |     foldl(F, A, Node).
 527 | 
 528 | %%-------------------------------------------------------------------------
 529 | %% @doc
 530 | %% ===Fold a function over the trie.===
 531 | %% Traverses in alphabetical order.
 532 | %% @end
 533 | %%-------------------------------------------------------------------------
 534 | 
 535 | -spec foldl(F :: fun((?TYPE_NAME, any(), any()) -> any()),
 536 |             A :: any(),
 537 |             Node :: trie()) -> any().
 538 | 
 539 | foldl(F, A, ?TYPE_EMPTY) when is_function(F, 3) ->
 540 |     A;
 541 | 
 542 | foldl(F, A, Node) when is_function(F, 3) ->
 543 |     foldl(F, A, ?TYPE_EMPTY, Node).
 544 | 
 545 | foldl(F, A, Key, {I0, I1, Data}) ->
 546 |     foldl_element(F, A, 1, I1 - I0 + 2, I0 - 1, Key, Data).
 547 | 
 548 | foldl_element(_, A, N, N, _, _, _) ->
 549 |     A;
 550 | 
 551 | foldl_element(F, A, I, N, Offset, Key, Data) ->
 552 |     {Node, Value} = erlang:element(I, Data),
 553 |     Character = Offset + I,
 554 |     if
 555 |         ?TYPE_CHECK(Node) =:= false ->
 556 |             if
 557 |                 Value =:= error ->
 558 |                     foldl_element(F, foldl(F, A, ?TYPE_KEYCHAR, Node),
 559 |                         I + 1, N, Offset, Key, Data);
 560 |                 true ->
 561 |                     NewKey = ?TYPE_KEYCHAR,
 562 |                     foldl_element(F,
 563 |                         foldl(F, F(NewKey, Value, A), NewKey, Node),
 564 |                         I + 1, N, Offset, Key, Data)
 565 |             end;
 566 |         true ->
 567 |             if
 568 |                 Value =:= error ->
 569 |                     foldl_element(F, A,
 570 |                         I + 1, N, Offset, Key, Data);
 571 |                 true ->
 572 |                     foldl_element(F, F(?TYPE_KEYCHARNODE, Value, A),
 573 |                         I + 1, N, Offset, Key, Data)
 574 |             end
 575 |     end.
 576 | 
 577 | %%-------------------------------------------------------------------------
 578 | %% @doc
 579 | %% ===Fold a function over the trie in reverse.===
 580 | %% Traverses in reverse alphabetical order.
 581 | %% @end
 582 | %%-------------------------------------------------------------------------
 583 | 
 584 | -spec foldr(F :: fun((?TYPE_NAME, any(), any()) -> any()),
 585 |             A :: any(),
 586 |             Node :: trie()) -> any().
 587 | 
 588 | foldr(F, A, ?TYPE_EMPTY) when is_function(F, 3) ->
 589 |     A;
 590 | 
 591 | foldr(F, A, Node) when is_function(F, 3) ->
 592 |     foldr(F, A, ?TYPE_EMPTY, Node).
 593 | 
 594 | foldr(F, A, Key, {I0, I1, Data}) ->
 595 |     foldr_element(F, A, I1 - I0 + 1, I0 - 1, Key, Data).
 596 | 
 597 | foldr_element(_, A, 0, _, _, _) ->
 598 |     A;
 599 | 
 600 | foldr_element(F, A, I, Offset, Key, Data) ->
 601 |     {Node, Value} = erlang:element(I, Data),
 602 |     Character = Offset + I,
 603 |     if
 604 |         ?TYPE_CHECK(Node) =:= false ->
 605 |             if
 606 |                 Value =:= error ->
 607 |                     foldr_element(F, foldr(F, A, ?TYPE_KEYCHAR, Node),
 608 |                         I - 1, Offset, Key, Data);
 609 |                 true ->
 610 |                     NewKey = ?TYPE_KEYCHAR,
 611 |                     foldr_element(F,
 612 |                         F(NewKey, Value, foldr(F, A, NewKey, Node)),
 613 |                         I - 1, Offset, Key, Data)
 614 |             end;
 615 |         true ->
 616 |             if
 617 |                 Value =:= error ->
 618 |                     foldr_element(F, A,
 619 |                         I - 1, Offset, Key, Data);
 620 |                 true ->
 621 |                     foldr_element(F, F(?TYPE_KEYCHARNODE, Value, A),
 622 |                         I - 1, Offset, Key, Data)
 623 |             end
 624 |     end.
 625 | 
 626 | %%-------------------------------------------------------------------------
 627 | %% @doc
 628 | %% ===Fold a function over the keys within a trie that share a common prefix.===
 629 | %% Traverses in alphabetical order.
 630 | %% @end
 631 | %%-------------------------------------------------------------------------
 632 | 
 633 | -spec fold_similar(Similar :: ?TYPE_NAME,
 634 |                    F :: fun((?TYPE_NAME, any(), any()) -> any()),
 635 |                    A :: any(),
 636 |                    Node :: trie()) -> any().
 637 | 
 638 | fold_similar(Similar, F, A, Node) ->
 639 |     foldl_similar(Similar, F, A, Node).
 640 | 
 641 | %%-------------------------------------------------------------------------
 642 | %% @doc
 643 | %% ===Fold a function over the keys within a trie that share a common prefix.===
 644 | %% Traverses in alphabetical order.
 645 | %% @end
 646 | %%-------------------------------------------------------------------------
 647 | 
 648 | -spec foldl_similar(Similar :: ?TYPE_NAME,
 649 |                     F :: fun((?TYPE_NAME, any(), any()) -> any()),
 650 |                     A :: any(),
 651 |                     Node :: trie()) -> any().
 652 | 
 653 | foldl_similar(?TYPE_H0_, _, A, {I0, I1, _})
 654 |     when is_integer(H), H < I0;
 655 |          is_integer(H), H > I1 ->
 656 |     A;
 657 | 
 658 | foldl_similar(_, _, A, ?TYPE_EMPTY) ->
 659 |     A;
 660 | 
 661 | foldl_similar(?TYPE_H0T0, F, A, Node) ->
 662 |     fold_similar_node(H, T, foldl, F, A, ?TYPE_EMPTY, error, Node).
 663 | 
 664 | %%-------------------------------------------------------------------------
 665 | %% @doc
 666 | %% ===Fold a function over the keys within a trie that share a common prefix in reverse.===
 667 | %% Traverses in reverse alphabetical order.
 668 | %% @end
 669 | %%-------------------------------------------------------------------------
 670 | 
 671 | -spec foldr_similar(Similar :: ?TYPE_NAME,
 672 |                     F :: fun((?TYPE_NAME, any(), any()) -> any()),
 673 |                     A :: any(),
 674 |                     Node :: trie()) -> any().
 675 | 
 676 | foldr_similar(?TYPE_H0_, _, A, {I0, I1, _})
 677 |     when is_integer(H), H < I0;
 678 |          is_integer(H), H > I1 ->
 679 |     A;
 680 | 
 681 | foldr_similar(_, _, A, ?TYPE_EMPTY) ->
 682 |     A;
 683 | 
 684 | foldr_similar(?TYPE_H0T0, F, A, Node) ->
 685 |     fold_similar_node(H, T, foldr, F, A, ?TYPE_EMPTY, error, Node).
 686 | 
 687 | fold_similar_node(H, _, Fold, F, A, Key, LastValue, {I0, I1, _} = Node)
 688 |     when is_integer(H), H < I0;
 689 |          is_integer(H), H > I1 ->
 690 |     if
 691 |         LastValue =:= error ->
 692 |             fold_similar_element(Fold, F, A, Key, Node);
 693 |         Fold =:= foldl ->
 694 |             fold_similar_element(Fold, F, F(Key, LastValue, A), Key, Node);
 695 |         Fold =:= foldr ->
 696 |             F(Key, LastValue, fold_similar_element(Fold, F, A, Key, Node))
 697 |     end;
 698 | 
 699 | fold_similar_node(H, ?TYPE_EMPTY, Fold, F, A, Key, _, {I0, _, Data} = Node)
 700 |     when is_integer(H) ->
 701 |     {ChildNode, Value} = erlang:element(H - I0 + 1, Data),
 702 |     if
 703 |         is_tuple(ChildNode) ->
 704 |             NewKey = ?TYPE_KEYH0,
 705 |             if
 706 |                 Value =:= error ->
 707 |                     fold_similar_element(Fold, F, A, NewKey, ChildNode);
 708 |                 Fold =:= foldl ->
 709 |                     fold_similar_element(Fold, F, F(NewKey, Value, A),
 710 |                                          NewKey, ChildNode);
 711 |                 Fold =:= foldr ->
 712 |                     F(NewKey, Value,
 713 |                       fold_similar_element(Fold, F, A, NewKey, ChildNode))
 714 |             end;
 715 |         Value =/= error, ?TYPE_CHECK(ChildNode) ->
 716 |             F(?TYPE_KEYH0CHILDNODE, Value, A);
 717 |         true ->
 718 |             fold_similar_element(Fold, F, A, Key, Node)
 719 |     end;
 720 | 
 721 | fold_similar_node(H, T, Fold, F, A, Key, _, {I0, _, Data} = Node)
 722 |     when is_integer(H) ->
 723 |     {ChildNode, Value} = erlang:element(H - I0 + 1, Data),
 724 |     if
 725 |         is_tuple(ChildNode) ->
 726 |             ?TYPE_H1T1 = T,
 727 |             fold_similar_node(H1, T1, Fold, F, A,
 728 |                 ?TYPE_KEYH0, Value, ChildNode);
 729 |         Value =/= error, ?TYPE_CHECK(ChildNode) ->
 730 |             F(?TYPE_KEYH0CHILDNODE, Value, A);
 731 |         true ->
 732 |             fold_similar_element(Fold, F, A, Key, Node)
 733 |     end.
 734 | 
 735 | fold_similar_element(foldl, F, A, Key, Node) ->
 736 |     foldl(F, A, Key, Node);
 737 | 
 738 | fold_similar_element(foldr, F, A, Key, Node) ->
 739 |     foldr(F, A, Key, Node).
 740 | 
 741 | %%-------------------------------------------------------------------------
 742 | %% @doc
 743 | %% ===Call a function for each element.===
 744 | %% Traverses in alphabetical order.
 745 | %% @end
 746 | %%-------------------------------------------------------------------------
 747 | 
 748 | -spec foreach(F :: fun((?TYPE_NAME, any()) -> any()),
 749 |               Node :: trie()) -> any().
 750 | 
 751 | foreach(F, ?TYPE_EMPTY) when is_function(F, 2) ->
 752 |     ok;
 753 | 
 754 | foreach(F, Node) when is_function(F, 2) ->
 755 |     foreach(F, ?TYPE_EMPTY, Node).
 756 | 
 757 | foreach(F, Key, {I0, I1, Data}) ->
 758 |     foreach_element(F, 1, I1 - I0 + 2, I0 - 1, Key, Data).
 759 | 
 760 | foreach_element(_, N, N, _, _, _) ->
 761 |     ok;
 762 | 
 763 | foreach_element(F, I, N, Offset, Key, Data) ->
 764 |     {Node, Value} = erlang:element(I, Data),
 765 |     Character = Offset + I,
 766 |     if
 767 |         ?TYPE_CHECK(Node) =:= false ->
 768 |             if
 769 |                 Value =:= error ->
 770 |                     foreach(F, ?TYPE_KEYCHAR, Node),
 771 |                     foreach_element(F, I + 1, N, Offset, Key, Data);
 772 |                 true ->
 773 |                     NewKey = ?TYPE_KEYCHAR,
 774 |                     F(NewKey, Value),
 775 |                     foreach(F, NewKey, Node),
 776 |                     foreach_element(F, I + 1, N, Offset, Key, Data)
 777 |             end;
 778 |         true ->
 779 |             if
 780 |                 Value =:= error ->
 781 |                     foreach_element(F, I + 1, N, Offset, Key, Data);
 782 |                 true ->
 783 |                     F(?TYPE_KEYCHARNODE, Value),
 784 |                     foreach_element(F, I + 1, N, Offset, Key, Data)
 785 |             end
 786 |     end.
 787 | 
 788 | %%-------------------------------------------------------------------------
 789 | %% @doc
 790 | %% ===Create a trie from a list.===
 791 | %% @end
 792 | %%-------------------------------------------------------------------------
 793 | 
 794 | -spec from_list(list(?TYPE_NAME | tuple())) -> trie().
 795 | 
 796 | from_list(L) ->
 797 |     new(L).
 798 | 
 799 | %%-------------------------------------------------------------------------
 800 | %% @doc
 801 | %% ===Determine if a key exists in a trie.===
 802 | %% @end
 803 | %%-------------------------------------------------------------------------
 804 | 
 805 | -spec is_key(?TYPE_NAME, trie()) -> boolean().
 806 | 
 807 | is_key(_, ?TYPE_EMPTY) ->
 808 |     false;
 809 | 
 810 | is_key(?TYPE_H0T0, {_, _, _} = Node) ->
 811 |     is_key_node(H, T, Node).
 812 | 
 813 | is_key_node(H, _, {I0, I1, _})
 814 |     when is_integer(H), H < I0;
 815 |          is_integer(H), H > I1 ->
 816 |     false;
 817 | 
 818 | is_key_node(H, ?TYPE_EMPTY, {I0, _, Data})
 819 |     when is_integer(H) ->
 820 |     {Node, Value} = erlang:element(H - I0 + 1, Data),
 821 |     if
 822 |         is_tuple(Node); Node =:= ?TYPE_EMPTY ->
 823 |             (Value =/= error);
 824 |         true ->
 825 |             false
 826 |     end;
 827 | 
 828 | is_key_node(H, T, {I0, _, Data})
 829 |     when is_integer(H) ->
 830 |     {Node, Value} = erlang:element(H - I0 + 1, Data),
 831 |     case Node of
 832 |         {_, _, _} ->
 833 |             ?TYPE_H1T1 = T,
 834 |             is_key_node(H1, T1, Node);
 835 |         T ->
 836 |             (Value =/= error);
 837 |         _ ->
 838 |             false
 839 |     end.
 840 | 
 841 | %%-------------------------------------------------------------------------
 842 | %% @doc
 843 | %% ===Map a function over a trie.===
 844 | %% Traverses in reverse alphabetical order.
 845 | %% @end
 846 | %%-------------------------------------------------------------------------
 847 | 
 848 | -spec map(F :: fun((?TYPE_NAME, any()) -> any()),
 849 |           Node :: trie()) -> trie().
 850 | 
 851 | map(F, ?TYPE_EMPTY = Node) when is_function(F, 2) ->
 852 |     Node;
 853 | 
 854 | map(F, Node) when is_function(F, 2) ->
 855 |     map_node(F, ?TYPE_EMPTY, Node).
 856 | 
 857 | map_node(F, Key, {I0, I1, Data}) ->
 858 |     {I0, I1, map_element(F, I1 - I0 + 1, I0 - 1, Key, Data)};
 859 | 
 860 | map_node(_, _, Node)
 861 |     when ?TYPE_CHECK(Node) ->
 862 |     Node.
 863 | 
 864 | map_element(_, 0, _, _, Data) ->
 865 |     Data;
 866 | 
 867 | map_element(F, I, Offset, Key, Data) ->
 868 |     {Node, Value} = erlang:element(I, Data),
 869 |     Character = Offset + I,
 870 |     NewKey = ?TYPE_KEYCHAR,
 871 |     if
 872 |         Node =:= ?TYPE_EMPTY ->
 873 |             if
 874 |                 Value =:= error ->
 875 |                     map_element(F, I - 1, Offset, Key, Data);
 876 |                 true ->
 877 |                     map_element(F, I - 1, Offset, Key,
 878 |                         erlang:setelement(I, Data, {Node, F(NewKey, Value)}))
 879 |             end;
 880 |         Value =:= error ->
 881 |             map_element(F, I - 1, Offset, Key, erlang:setelement(I, Data,
 882 |                 {map_node(F, NewKey, Node), Value}));
 883 |         ?TYPE_CHECK(Node) ->
 884 |             map_element(F, I - 1, Offset, Key, erlang:setelement(I, Data,
 885 |                 {map_node(F, NewKey, Node), F(?TYPE_NEWKEYNODE, Value)}));
 886 |         true ->
 887 |             map_element(F, I - 1, Offset, Key, erlang:setelement(I, Data,
 888 |                 {map_node(F, NewKey, Node), F(NewKey, Value)}))
 889 |     end.
 890 | 
 891 | %%-------------------------------------------------------------------------
 892 | %% @doc
 893 | %% ===Merge two trie instance.===
 894 | %% Update the second trie parameter with all of the elements
 895 | %% found within the first trie parameter.
 896 | %% @end
 897 | %%-------------------------------------------------------------------------
 898 | 
 899 | -spec merge(F :: fun((?TYPE_NAME, any(), any()) -> any()),
 900 |             Node1 :: trie(),
 901 |             Node2 :: trie()) -> trie().
 902 | 
 903 | merge(F, Node1, ?TYPE_EMPTY) when is_function(F, 3) ->
 904 |     Node1;
 905 | 
 906 | merge(F, ?TYPE_EMPTY, Node2) when is_function(F, 3) ->
 907 |     Node2;
 908 | 
 909 | merge(F, Node1, Node2) when is_function(F, 3) ->
 910 |     fold(fun (Key, V1, Node) ->
 911 |             update(Key, fun (V2) -> F(Key, V1, V2) end, V1, Node)
 912 |          end, Node2, Node1).
 913 | 
 914 | %%-------------------------------------------------------------------------
 915 | %% @doc
 916 | %% ===Create a new trie instance.===
 917 | %% @end
 918 | %%-------------------------------------------------------------------------
 919 | 
 920 | -spec new() -> empty_trie().
 921 | 
 922 | new() ->
 923 |     ?TYPE_EMPTY.
 924 | 
 925 | %%-------------------------------------------------------------------------
 926 | %% @doc
 927 | %% ===Create a new trie instance from a list.===
 928 | %% The list may contain either: strings, 2 element tuples with a string as the
 929 | %% first tuple element, or tuples with more than 2 elements (including records)
 930 | %% with a string as the first element (second element if it is a record).
 931 | %% If a list of records (or tuples larger than 2 elements) is provided,
 932 | %% the whole record/tuple is stored as the value.
 933 | %% @end
 934 | %%-------------------------------------------------------------------------
 935 | 
 936 | -spec new(L :: list(?TYPE_NAME | tuple())) -> trie().
 937 | 
 938 | new(L) ->
 939 |     new_instance(L, new()).
 940 | 
 941 | new_instance([], Node) ->
 942 |     Node;
 943 | 
 944 | new_instance([{Key, Value} | T], Node) ->
 945 |     new_instance(T, store(Key, Value, Node));
 946 | 
 947 | new_instance([Tuple | T], Node)
 948 |     when is_tuple(Tuple) ->
 949 |     FirstElement = erlang:element(1, Tuple),
 950 |     Key = if
 951 |         is_atom(FirstElement) ->
 952 |             erlang:element(2, Tuple);
 953 |         true ->
 954 |             FirstElement
 955 |     end,
 956 |     new_instance(T, store(Key, Tuple, Node));
 957 | 
 958 | new_instance([Key | T], Node) ->
 959 |     new_instance(T, store(Key, Node)).
 960 | 
 961 | new_instance_state(?TYPE_H0T0, V1, V0)
 962 |     when is_integer(H) ->
 963 |     {{H, H, {{T, V1}}}, V0}.
 964 | 
 965 | %%-------------------------------------------------------------------------
 966 | %% @doc
 967 | %% ===Insert a value as the first list element in a trie instance.===
 968 | %% The reverse of append/3.
 969 | %% @end
 970 | %%-------------------------------------------------------------------------
 971 | 
 972 | -spec prefix(Key :: ?TYPE_NAME,
 973 |              Value :: any(),
 974 |              Node :: trie()) -> nonempty_trie().
 975 | 
 976 | prefix(Key, Value, Node) ->
 977 |     update(Key, fun(OldValue) -> [Value | OldValue] end, [Value], Node).
 978 | 
 979 | %%-------------------------------------------------------------------------
 980 | %% @doc
 981 | %% ===Size of a trie instance.===
 982 | %% @end
 983 | %%-------------------------------------------------------------------------
 984 | 
 985 | -spec size(Node :: trie()) -> non_neg_integer().
 986 | 
 987 | size(Node) ->
 988 |     fold(fun(_, _, I) -> I + 1 end, 0, Node).
 989 | 
 990 | %%-------------------------------------------------------------------------
 991 | %% @doc
 992 | %% ===Store only a key in a trie instance.===
 993 | %% @end
 994 | %%-------------------------------------------------------------------------
 995 | 
 996 | -spec store(Key :: ?TYPE_NAME,
 997 |             Node :: trie()) -> nonempty_trie().
 998 | 
 999 | store(Key, Node) ->
1000 |     store(Key, empty, Node).
1001 | 
1002 | %%-------------------------------------------------------------------------
1003 | %% @doc
1004 | %% ===Store a key/value pair in a trie instance.===
1005 | %% @end
1006 | %%-------------------------------------------------------------------------
1007 | 
1008 | -spec store(Key :: ?TYPE_NAME,
1009 |             NewValue :: any(),
1010 |             Node :: trie()) -> nonempty_trie().
1011 | 
1012 | store(?TYPE_H0T0, NewValue, ?TYPE_EMPTY) ->
1013 |     {H, H, {{T, NewValue}}};
1014 | 
1015 | store(?TYPE_H0T0, NewValue, Node) ->
1016 |     store_node(H, T, NewValue, Node).
1017 | 
1018 | store_node(H, T, NewValue, {I0, I1, Data})
1019 |     when is_integer(H), H < I0 ->
1020 |     NewData = erlang:setelement(1,
1021 |         tuple_move(I0 - H + 1, I1 - H + 1, Data, {?TYPE_EMPTY, error}),
1022 |         {T, NewValue}),
1023 |     {H, I1, NewData};
1024 | 
1025 | store_node(H, T, NewValue, {I0, I1, Data})
1026 |     when is_integer(H), H > I1 ->
1027 |     N = H - I0 + 1,
1028 |     NewData = erlang:setelement(N,
1029 |         tuple_move(1, N, Data, {?TYPE_EMPTY, error}),
1030 |         {T, NewValue}),
1031 |     {I0, H, NewData};
1032 | 
1033 | store_node(H, ?TYPE_EMPTY = T, NewValue, {I0, I1, Data})
1034 |     when is_integer(H) ->
1035 |     I = H - I0 + 1,
1036 |     {Node, Value} = erlang:element(I, Data),
1037 |     if
1038 |         is_tuple(Node); Node =:= ?TYPE_EMPTY ->
1039 |             {I0, I1, erlang:setelement(I, Data, {Node, NewValue})};
1040 |         true ->
1041 |             NewNode = {I0, I1, erlang:setelement(I, Data,
1042 |                 new_instance_state(Node, Value, error))},
1043 |             store_node(H, T, NewValue, NewNode)
1044 |     end;
1045 | 
1046 | store_node(H, ?TYPE_H1T1 = T, NewValue, {I0, I1, Data})
1047 |     when is_integer(H) ->
1048 |     I = H - I0 + 1,
1049 |     {Node, Value} = erlang:element(I, Data),
1050 |     case Node of
1051 |         {_, _, _} ->
1052 |             {I0, I1, erlang:setelement(I, Data,
1053 |                 {store_node(H1, T1, NewValue, Node), Value})};
1054 |         T ->
1055 |             {I0, I1, erlang:setelement(I, Data, {Node, NewValue})};
1056 |         ?TYPE_EMPTY ->
1057 |             if
1058 |                 Value =:= error ->
1059 |                     {I0, I1, erlang:setelement(I, Data, {T, NewValue})};
1060 |                 true ->
1061 |                     {I0, I1, erlang:setelement(I, Data,
1062 |                         new_instance_state(T, NewValue, Value))}
1063 |             end;
1064 |         ?TYPE_BHBT ->
1065 |             NewNode = {I0, I1,
1066 |                 erlang:setelement(I, Data, {{BH, BH, {{BT, Value}}}, error})},
1067 |             store_node(H, T, NewValue, NewNode)
1068 |     end.
1069 | 
1070 | %%-------------------------------------------------------------------------
1071 | %% @doc
1072 | %% ===Take a value from the trie.===
1073 | %% @end
1074 | %%-------------------------------------------------------------------------
1075 | 
1076 | -spec take(Key :: ?TYPE_NAME,
1077 |            Node :: trie()) ->
1078 |     {any(), trie()} | 'error'.
1079 | 
1080 | take(_, ?TYPE_EMPTY) ->
1081 |     error;
1082 | 
1083 | take(?TYPE_H0T0, Node) ->
1084 |     take_node(H, T, Node).
1085 | 
1086 | take_node(H, _, {I0, I1, _})
1087 |     when is_integer(H), H < I0;
1088 |          is_integer(H), H > I1 ->
1089 |     error;
1090 | 
1091 | take_node(H, T, {I0, I1, Data})
1092 |     when is_integer(H) ->
1093 |     I = H - I0 + 1,
1094 |     {Node, Value} = erlang:element(I, Data),
1095 |     if
1096 |         T == Node ->
1097 |             if
1098 |                 Value =:= error ->
1099 |                     error;
1100 |                 true ->
1101 |                     {Value,
1102 |                      {I0, I1,
1103 |                       erlang:setelement(I, Data, {?TYPE_EMPTY, error})}}
1104 |             end;
1105 |         T =:= ?TYPE_EMPTY ->
1106 |             if
1107 |                 Value =:= error ->
1108 |                     error;
1109 |                 true ->
1110 |                     {Value,
1111 |                      {I0, I1, erlang:setelement(I, Data, {Node, error})}}
1112 |             end;
1113 |         ?TYPE_CHECK(Node) ->
1114 |             error;
1115 |         is_tuple(Node) ->
1116 |             ?TYPE_H1T1 = T,
1117 |             case take_node(H1, T1, Node) of
1118 |                 error ->
1119 |                     error;
1120 |                 {OldValue, NewNode} ->
1121 |                     {OldValue,
1122 |                      {I0, I1, erlang:setelement(I, Data, {NewNode, Value})}}
1123 |             end
1124 |     end.
1125 | 
1126 | %%-------------------------------------------------------------------------
1127 | %% @doc
1128 | %% ===Convert all entries in a trie to a list.===
1129 | %% The list is in alphabetical order.
1130 | %% @end
1131 | %%-------------------------------------------------------------------------
1132 | 
1133 | -spec to_list(Node :: trie()) -> list({?TYPE_NAME, any()}).
1134 | 
1135 | to_list(Node) ->
1136 |     foldr(fun (Key, Value, L) -> [{Key, Value} | L] end, [], Node).
1137 |         
1138 | %%-------------------------------------------------------------------------
1139 | %% @doc
1140 | %% ===Return a list of all entries within a trie that share a common prefix.===
1141 | %% @end
1142 | %%-------------------------------------------------------------------------
1143 | 
1144 | -spec to_list_similar(Similar :: ?TYPE_NAME,
1145 |                       Node :: trie()) -> list({?TYPE_NAME, any()}).
1146 | 
1147 | to_list_similar(Similar, Node) ->
1148 |     foldr_similar(Similar,
1149 |                   fun(Key, Value, L) -> [{Key, Value} | L] end, [], Node).
1150 | 
1151 | %%-------------------------------------------------------------------------
1152 | %% @doc
1153 | %% ===Update a value in a trie.===
1154 | %% @end
1155 | %%-------------------------------------------------------------------------
1156 | 
1157 | -spec update(?TYPE_NAME,
1158 |              F :: fun((any()) -> any()),
1159 |              nonempty_trie()) -> nonempty_trie().
1160 | 
1161 | update(?TYPE_H0T0, F, {_, _, _} = Node)
1162 |     when is_function(F, 1) ->
1163 |     update_node(H, T, F, Node).
1164 | 
1165 | update_node(H, ?TYPE_EMPTY, F, {I0, I1, Data})
1166 |     when is_integer(H), H >= I0, H =< I1 ->
1167 |     I = H - I0 + 1,
1168 |     {Node, Value} = erlang:element(I, Data),
1169 |     if
1170 |         is_tuple(Node); Node =:= ?TYPE_EMPTY, Value =/= error ->
1171 |             {I0, I1, erlang:setelement(I, Data, {Node, F(Value)})}
1172 |     end;
1173 | 
1174 | update_node(H, T, F, {I0, I1, Data})
1175 |     when is_integer(H), H >= I0, H =< I1 ->
1176 |     I = H - I0 + 1,
1177 |     {Node, Value} = erlang:element(I, Data),
1178 |     case Node of
1179 |         {_, _, _} ->
1180 |             ?TYPE_H1T1 = T,
1181 |             {I0, I1, erlang:setelement(I, Data,
1182 |                 {update_node(H1, T1, F, Node), Value})};
1183 |         T ->
1184 |             true = Value =/= error,
1185 |             {I0, I1, erlang:setelement(I, Data, {Node, F(Value)})}
1186 |     end.
1187 | 
1188 | %%-------------------------------------------------------------------------
1189 | %% @doc
1190 | %% ===Update or add a value in a trie.===
1191 | %% @end
1192 | %%-------------------------------------------------------------------------
1193 | 
1194 | -spec update(Key :: ?TYPE_NAME,
1195 |              F :: fun((any()) -> any()),
1196 |              Initial :: any(),
1197 |              Node :: trie()) -> nonempty_trie().
1198 | 
1199 | update(Key, _, Initial, ?TYPE_EMPTY = Node) ->
1200 |     store(Key, Initial, Node);
1201 | 
1202 | update(?TYPE_H0T0, F, Initial, {_, _, _} = Node)
1203 |     when is_function(F, 1) ->
1204 |     update_node(H, T, F, Initial, Node).
1205 | 
1206 | update_node(H, T, _, Initial, {I0, I1, Data})
1207 |     when is_integer(H), H < I0 ->
1208 |     NewData = erlang:setelement(1,
1209 |         tuple_move(I0 - H + 1, I1 - H + 1, Data, {?TYPE_EMPTY, error}),
1210 |         {T, Initial}),
1211 |     {H, I1, NewData};
1212 | 
1213 | update_node(H, T, _, Initial, {I0, I1, Data})
1214 |     when is_integer(H), H > I1 ->
1215 |     N = H - I0 + 1,
1216 |     NewData = erlang:setelement(N,
1217 |         tuple_move(1, N, Data, {?TYPE_EMPTY, error}),
1218 |         {T, Initial}),
1219 |     {I0, H, NewData};
1220 | 
1221 | update_node(H, ?TYPE_EMPTY = T, F, Initial, {I0, I1, Data})
1222 |     when is_integer(H) ->
1223 |     I = H - I0 + 1,
1224 |     {Node, Value} = erlang:element(I, Data),
1225 |     if
1226 |         is_tuple(Node); Node =:= ?TYPE_EMPTY ->
1227 |             if
1228 |                 Value =:= error ->
1229 |                     {I0, I1, erlang:setelement(I, Data, {Node, Initial})};
1230 |                 true ->
1231 |                     {I0, I1, erlang:setelement(I, Data, {Node, F(Value)})}
1232 |             end;
1233 |         true ->
1234 |             ?TYPE_BHBT = Node,
1235 |             NewNode = {I0, I1,
1236 |                erlang:setelement(I, Data, {{BH, BH, {{BT, Value}}}, error})},
1237 |             update_node(H, T, F, Initial, NewNode)
1238 |     end;
1239 | 
1240 | update_node(H, T, F, Initial, {I0, I1, Data})
1241 |     when is_integer(H) ->
1242 |     I = H - I0 + 1,
1243 |     {Node, Value} = erlang:element(I, Data),
1244 |     case Node of
1245 |         {_, _, _} ->
1246 |             ?TYPE_H1T1 = T,
1247 |             {I0, I1, erlang:setelement(I, Data,
1248 |                 {update_node(H1, T1, F, Initial, Node), Value})};
1249 |         T ->
1250 |             {I0, I1, erlang:setelement(I, Data, {Node, F(Value)})};
1251 |         ?TYPE_EMPTY ->
1252 |             if
1253 |                 Value =:= error ->
1254 |                     {I0, I1, erlang:setelement(I, Data, {T, Initial})};
1255 |                 true ->
1256 |                     {I0, I1, erlang:setelement(I, Data,
1257 |                         new_instance_state(T, Initial, Value))}
1258 |             end;
1259 |         ?TYPE_BHBT ->
1260 |             NewNode = {I0, I1,
1261 |                 erlang:setelement(I, Data, {{BH, BH, {{BT, Value}}}, error})},
1262 |             update_node(H, T, F, Initial, NewNode)
1263 |     end.
1264 | 
1265 | %%-------------------------------------------------------------------------
1266 | %% @doc
1267 | %% ===Update a counter in a trie.===
1268 | %% @end
1269 | %%-------------------------------------------------------------------------
1270 | 
1271 | -spec update_counter(Key :: ?TYPE_NAME,
1272 |                      Increment :: number(),
1273 |                      Node :: trie()) -> nonempty_trie().
1274 | 
1275 | update_counter(Key, Increment, Node) ->
1276 |     update(Key, fun(I) -> I + Increment end, Increment, Node).
1277 | 
1278 | 


--------------------------------------------------------------------------------
/src/trie_test.hrl:
--------------------------------------------------------------------------------
 1 | %-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
 2 | % ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
 3 | %%%
 4 | %%%------------------------------------------------------------------------
 5 | %%% trie eunit common functionality
 6 | %%%
 7 | %%% MIT License
 8 | %%%
 9 | %%% Copyright (c) 2020 Michael Truog <mjtruog at protonmail dot com>
10 | %%%
11 | %%% Permission is hereby granted, free of charge, to any person obtaining a
12 | %%% copy of this software and associated documentation files (the "Software"),
13 | %%% to deal in the Software without restriction, including without limitation
14 | %%% the rights to use, copy, modify, merge, publish, distribute, sublicense,
15 | %%% and/or sell copies of the Software, and to permit persons to whom the
16 | %%% Software is furnished to do so, subject to the following conditions:
17 | %%%
18 | %%% The above copyright notice and this permission notice shall be included in
19 | %%% all copies or substantial portions of the Software.
20 | %%%
21 | %%% THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 | %%% IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 | %%% FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 | %%% AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 | %%% LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
26 | %%% FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
27 | %%% DEALINGS IN THE SOFTWARE.
28 | %%%
29 | %%%------------------------------------------------------------------------
30 | 
31 | -ifndef(_assertOk).
32 | -define(_assertOk(Expr), ?_assertEqual(ok, Expr)).
33 | -endif.
34 | 
35 | -ifdef(CLOUDI_TEST_TIMEOUT).
36 | -define(TEST_TIMEOUT, ?CLOUDI_TEST_TIMEOUT). % seconds
37 | -else.
38 | -define(TEST_TIMEOUT, 10). % seconds
39 | -endif.
40 | -ifndef(CLOUDI_LONG_TEST_TIMEOUT).
41 | -define(CLOUDI_LONG_TEST_TIMEOUT, 60). % minutes
42 | -endif.
43 | 
44 | -compile({nowarn_unused_function,
45 |           [{test_condition, 2}]}).
46 | 
47 | test_condition(_, 0) ->
48 |     [];
49 | test_condition(L, LongTestTimeout)
50 |     when LongTestTimeout > 0 ->
51 |     {timeout, LongTestTimeout * 60, L}.
52 | 
53 | 


--------------------------------------------------------------------------------
/test/proper_srv.erl:
--------------------------------------------------------------------------------
  1 | %-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
  2 | % ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
  3 | %%%
  4 | %%%------------------------------------------------------------------------
  5 | %%% @doc
  6 | %%% Test the dict API functions on an ordered collection.
  7 | %%% @end
  8 | %%%
  9 | %%% @author Michael Truog <mjtruog at protonmail dot com>
 10 | %%% @copyright 2012 Michael Truog
 11 | %%%------------------------------------------------------------------------
 12 | 
 13 | -module(proper_srv).
 14 | 
 15 | -behaviour(gen_server).
 16 | 
 17 | %% external interface
 18 | -export([start_link/1,
 19 |          stop/0]).
 20 | 
 21 | %% data structure API
 22 | -export([append/2,
 23 |          append_list/2,
 24 |          erase/1,
 25 |          fetch_keys/0,
 26 |          filter/1,
 27 |          find/1,
 28 |          fold/2,
 29 |          is_key/1,
 30 |          map/1,
 31 |          size/0,
 32 |          store/2,
 33 |          update/3]).
 34 | 
 35 | %% gen_server callbacks
 36 | -export([init/1,
 37 |          handle_call/3, handle_cast/2, handle_info/2,
 38 |          terminate/2, code_change/3]).
 39 | 
 40 | -record(state,
 41 |     {
 42 |         module,
 43 |         data_structure
 44 |     }).
 45 | 
 46 | %%%------------------------------------------------------------------------
 47 | %%% External interface functions
 48 | %%%------------------------------------------------------------------------
 49 | 
 50 | start_link(Module) ->
 51 |     gen_server:start_link({local, ?MODULE}, ?MODULE, [Module], []).
 52 | 
 53 | stop() ->
 54 |     gen_server:stop(?MODULE).
 55 | 
 56 | %%%------------------------------------------------------------------------
 57 | %%% Data structure API
 58 | %%%------------------------------------------------------------------------
 59 | 
 60 | append(Key, Value) ->
 61 |     call(append, [Key, Value]).
 62 | 
 63 | append_list(Key, L) ->
 64 |     call(append_list, [Key, L]).
 65 | 
 66 | erase(Key) ->
 67 |     call(erase, [Key]).
 68 | 
 69 | fetch_keys() ->
 70 |     call(fetch_keys, []).
 71 | 
 72 | filter(F) ->
 73 |     call(filter, [F]).
 74 | 
 75 | find(Key) ->
 76 |     call(find, [Key]).
 77 | 
 78 | fold(F, Acc) ->
 79 |     call(fold, [F, Acc]).
 80 | 
 81 | is_key(Key) ->
 82 |     call(is_key, [Key]).
 83 | 
 84 | map(F) ->
 85 |     call(map, [F]).
 86 | 
 87 | size() ->
 88 |     call(size, []).
 89 | 
 90 | store(Key, L) ->
 91 |     call(store, [Key, L]).
 92 | 
 93 | update(Key, F, L) ->
 94 |     call(update, [Key, F, L]).
 95 | 
 96 | %%%------------------------------------------------------------------------
 97 | %%% Callback functions from gen_server
 98 | %%%------------------------------------------------------------------------
 99 | 
100 | init([Module]) ->
101 |     {ok, #state{module = Module,
102 |                 data_structure = Module:new()}}.
103 | 
104 | handle_call({F, A}, _,
105 |             #state{data_structure = D,
106 |                    module = M} = S) when F =:= filter ->
107 |     Result = erlang:apply(M, F, A ++ [D]),
108 |     {reply, M:to_list(Result), S};
109 | handle_call({F, A}, _,
110 |             #state{data_structure = D,
111 |                    module = M} = S) when F =:= fetch_keys;
112 |                                          F =:= find;
113 |                                          F =:= fold;
114 |                                          F =:= is_key;
115 |                                          F =:= size ->
116 |     Result = erlang:apply(M, F, A ++ [D]),
117 |     {reply, Result, S};
118 | handle_call({F, A}, _,
119 |             #state{data_structure = D,
120 |                    module = M} = S) ->
121 |     Result = M:to_list(D),
122 |     NewD = erlang:apply(M, F, A ++ [D]),
123 |     {reply, Result, S#state{data_structure = NewD}};
124 | handle_call(_, _, State) ->
125 |     {stop, invalid_call, error, State}.
126 | 
127 | handle_cast(_Msg, State) ->
128 |     {stop, invalid_cast, State}.
129 | 
130 | handle_info(_Info, State) ->
131 |     {stop, invalid_info, State}.
132 | 
133 | terminate(_Reason, _State) ->
134 |     ok.
135 | 
136 | code_change(_OldVsn, State, _Extra) ->
137 |     {ok, State}.
138 | 
139 | %%%------------------------------------------------------------------------
140 | %%% Private functions
141 | %%%------------------------------------------------------------------------
142 | 
143 | call(Command, Args) ->
144 |     gen_server:call(?MODULE, {Command, Args}, infinity).
145 | 
146 | 


--------------------------------------------------------------------------------
/test/trie_proper.erl:
--------------------------------------------------------------------------------
  1 | %-*-Mode:erlang;coding:utf-8;tab-width:4;c-basic-offset:4;indent-tabs-mode:()-*-
  2 | % ex: set ft=erlang fenc=utf-8 sts=4 ts=4 sw=4 et nomod:
  3 | 
  4 | -module(trie_proper).
  5 | -ifdef(TEST).
  6 | -behaviour(proper_statem).
  7 | -include_lib("proper/include/proper.hrl").
  8 | 
  9 | %% external interface
 10 | -export([qc_run/1, correct/1]).
 11 | 
 12 | %% proper_statem callbacks
 13 | -export([command/1, initial_state/0, next_state/3,
 14 |          postcondition/3, precondition/2]).
 15 | 
 16 | -record(state,
 17 |     {
 18 |         dict
 19 |     }).
 20 | -define(SERVER, proper_srv).
 21 | 
 22 | %%%------------------------------------------------------------------------
 23 | %%% External interface functions
 24 | %%%------------------------------------------------------------------------
 25 | 
 26 | qc_opts() ->
 27 |     [{numtests, 10000}].
 28 |      
 29 | qc_run(M) when is_atom(M) ->
 30 |     proper:quickcheck(trie_proper:correct(M), qc_opts()).
 31 | 
 32 | %%%------------------------------------------------------------------------
 33 | %%% Callback functions from proper_statem
 34 | %%%------------------------------------------------------------------------
 35 | 
 36 | initial_state() ->
 37 |     #state{dict = dict:new()}.
 38 | 
 39 | % dict functions not tested:
 40 | % fetch/2 from_list/1 map/2 update/3 update_counter/3
 41 | command(#state{}) ->
 42 |     oneof([{call, ?SERVER, append, [key(), value()]},
 43 |            {call, ?SERVER, append_list, [key(), [value(), value()]]},
 44 |            {call, ?SERVER, erase, [key()]},
 45 |            {call, ?SERVER, fetch_keys, []},
 46 |            {call, ?SERVER, filter, [fun(K, _) -> K > key() end]},
 47 |            {call, ?SERVER, find, [key()]},
 48 |            {call, ?SERVER, fold, [fun(_, V, S) -> lists:sum(V) + S end, 0]},
 49 |            {call, ?SERVER, is_key, [key()]},
 50 |            {call, ?SERVER, map, [fun(_, V) ->
 51 |                                      lists:map(fun(I) -> I + 1 end, V)
 52 |                                  end]},
 53 |            {call, ?SERVER, size, []},
 54 |            {call, ?SERVER, store, [key(), [value()]]},
 55 |            {call, ?SERVER, update, [key(),
 56 |                                     fun(V) ->
 57 |                                         lists:map(fun(I) -> I + 1 end, V)
 58 |                                     end,
 59 |                                     [value()]]}]).
 60 | 
 61 | next_state(#state{dict = D} = S, _V, {call, _, append, [Key, Value]}) ->
 62 |     S#state{dict = dict:append(Key, Value, D)};
 63 | next_state(#state{dict = D} = S, _V, {call, _, append_list, [Key, L]}) ->
 64 |     S#state{dict = dict:append_list(Key, L, D)};
 65 | next_state(#state{dict = D} = S, _V, {call, _, erase, [Key]}) ->
 66 |     S#state{dict = dict:erase(Key, D)};
 67 | next_state(S, _V, {call, _, fetch_keys, _}) ->
 68 |     S;
 69 | next_state(S, _V, {call, _, filter, [_F]}) ->
 70 |     S;
 71 | next_state(S, _V, {call, _, find, [_Key]}) ->
 72 |     S;
 73 | next_state(S, _V, {call, _, fold, [_F, _Acc]}) ->
 74 |     S;
 75 | next_state(S, _V, {call, _, is_key, [_Key]}) ->
 76 |     S;
 77 | next_state(#state{dict = D} = S, _V, {call, _, map, [F]}) ->
 78 |     S#state{dict = dict:map(F, D)};
 79 | next_state(S, _V, {call, _, size, _}) ->
 80 |     S;
 81 | next_state(#state{dict = D} = S, _V, {call, _, store, [Key, L]}) ->
 82 |     S#state{dict = dict:store(Key, L, D)};
 83 | next_state(#state{dict = D} = S, _V, {call, _, update, [Key, F, L]}) ->
 84 |     S#state{dict = dict:update(Key, F, L, D)}.
 85 | 
 86 | precondition(_S, _Call) ->
 87 |     true. % No limitation on the things we can call at all.
 88 | 
 89 | postcondition(#state{dict = D}, {call, _, filter, [F]}, R) ->
 90 |     R == lists:keysort(1, dict:to_list(dict:filter(F, D)));
 91 | postcondition(#state{dict = D}, {call, _, fetch_keys, []}, R) ->
 92 |     R == lists:sort(dict:fetch_keys(D));
 93 | postcondition(#state{dict = D}, {call, _, find, [Key]}, R) ->
 94 |     R == dict:find(Key, D);
 95 | postcondition(#state{dict = D}, {call, _, fold, [F, Acc]}, R) ->
 96 |     R == dict:fold(F, Acc, D);
 97 | postcondition(#state{dict = D}, {call, _, is_key, [Key]}, R) ->
 98 |     R == dict:is_key(Key, D);
 99 | postcondition(#state{dict = D}, {call, _, size, []}, R) ->
100 |     R == dict:size(D);
101 | postcondition(#state{dict = D}, {call, _, _F, _A}, R) ->
102 |     R == lists:keysort(1, dict:to_list(D));
103 | postcondition(_, _, _) ->
104 |     false.
105 | 
106 | correct(M) ->
107 |     ?FORALL(Cmds, commands(?MODULE),
108 |             ?TRAPEXIT(
109 |                 begin
110 |                     ?SERVER:start_link(M),
111 |                     {History,State,Result} = run_commands(?MODULE, Cmds),
112 |                     ?SERVER:stop(),
113 |                     ?WHENFAIL(io:format("History: ~w\nState: ~w\nResult: ~w\n",
114 |                                         [History, State, Result]),
115 |                               aggregate(command_names(Cmds), Result =:= ok))
116 |                 end)).
117 | 
118 | %%%------------------------------------------------------------------------
119 | %%% Private functions
120 | %%%------------------------------------------------------------------------
121 | 
122 | % random 8 character string
123 | key() ->
124 |     fixed_list([integer(48, 126),
125 |                 integer(48, 126),
126 |                 integer(48, 126),
127 |                 integer(48, 126),
128 |                 integer(48, 126),
129 |                 integer(48, 126),
130 |                 integer(48, 126),
131 |                 integer(48, 126)]).
132 | 
133 | value() ->
134 |     integer().
135 | 
136 | -endif.
137 | 


--------------------------------------------------------------------------------