<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source to the Rust file `src/libcore/unicode/bool_trie.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>bool_trie.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../../normalize1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../rustdoc1.35.0.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../../dark1.35.0.css"><link rel="stylesheet" type="text/css" href="../../../light1.35.0.css" id="themeStyle"><script src="../../../storage1.35.0.js"></script><noscript><link rel="stylesheet" href="../../../noscript1.35.0.css"></noscript><link rel="shortcut icon" href="../../../favicon1.35.0.ico"><style type="text/css">#crate-search{background-image:url("../../../down-arrow1.35.0.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../../core/index.html'><img src='../../../rust-logo1.35.0.png' alt='logo' width='100'></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../../brush1.35.0.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../../theme1.35.0.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../../settings.html"><img src="../../../wheel1.35.0.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="line-numbers"><span id="1"> 1</span> <span id="2"> 2</span> <span id="3"> 3</span> <span id="4"> 4</span> <span id="5"> 5</span> <span id="6"> 6</span> <span id="7"> 7</span> <span id="8"> 8</span> <span id="9"> 9</span> <span id="10">10</span> <span id="11">11</span> <span id="12">12</span> <span id="13">13</span> <span id="14">14</span> <span id="15">15</span> <span id="16">16</span> <span id="17">17</span> <span id="18">18</span> <span id="19">19</span> <span id="20">20</span> <span id="21">21</span> <span id="22">22</span> <span id="23">23</span> <span id="24">24</span> <span id="25">25</span> <span id="26">26</span> <span id="27">27</span> <span id="28">28</span> <span id="29">29</span> <span id="30">30</span> <span id="31">31</span> <span id="32">32</span> <span id="33">33</span> <span id="34">34</span> <span id="35">35</span> <span id="36">36</span> <span id="37">37</span> <span id="38">38</span> <span id="39">39</span> <span id="40">40</span> <span id="41">41</span> <span id="42">42</span> <span id="43">43</span> <span id="44">44</span> <span id="45">45</span> <span id="46">46</span> <span id="47">47</span> <span id="48">48</span> <span id="49">49</span> <span id="50">50</span> <span id="51">51</span> <span id="52">52</span> <span id="53">53</span> <span id="54">54</span> <span id="55">55</span> <span id="56">56</span> <span id="57">57</span> <span id="58">58</span> <span id="59">59</span> <span id="60">60</span> <span id="61">61</span> <span id="62">62</span> <span id="63">63</span> <span id="64">64</span> <span id="65">65</span> <span id="66">66</span> </pre><div class="example-wrap"><pre class="rust "> <span class="doccomment">/// BoolTrie is a trie for representing a set of Unicode codepoints. It is</span> <span class="doccomment">/// implemented with postfix compression (sharing of identical child nodes),</span> <span class="doccomment">/// which gives both compact size and fast lookup.</span> <span class="doccomment">///</span> <span class="doccomment">/// The space of Unicode codepoints is divided into 3 subareas, each</span> <span class="doccomment">/// represented by a trie with different depth. In the first (0..0x800), there</span> <span class="doccomment">/// is no trie structure at all; each u64 entry corresponds to a bitvector</span> <span class="doccomment">/// effectively holding 64 bool values.</span> <span class="doccomment">///</span> <span class="doccomment">/// In the second (0x800..0x10000), each child of the root node represents a</span> <span class="doccomment">/// 64-wide subrange, but instead of storing the full 64-bit value of the leaf,</span> <span class="doccomment">/// the trie stores an 8-bit index into a shared table of leaf values. This</span> <span class="doccomment">/// exploits the fact that in reasonable sets, many such leaves can be shared.</span> <span class="doccomment">///</span> <span class="doccomment">/// In the third (0x10000..0x110000), each child of the root node represents a</span> <span class="doccomment">/// 4096-wide subrange, and the trie stores an 8-bit index into a 64-byte slice</span> <span class="doccomment">/// of a child tree. Each of these 64 bytes represents an index into the table</span> <span class="doccomment">/// of shared 64-bit leaf values. This exploits the sparse structure in the</span> <span class="doccomment">/// non-BMP range of most Unicode sets.</span> <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">BoolTrie</span> { <span class="comment">// 0..0x800 (corresponding to 1 and 2 byte utf-8 sequences)</span> <span class="kw">pub</span> <span class="ident">r1</span>: [<span class="ident">u64</span>; <span class="number">32</span>], <span class="comment">// leaves</span> <span class="comment">// 0x800..0x10000 (corresponding to 3 byte utf-8 sequences)</span> <span class="kw">pub</span> <span class="ident">r2</span>: [<span class="ident">u8</span>; <span class="number">992</span>], <span class="comment">// first level</span> <span class="kw">pub</span> <span class="ident">r3</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">u64</span>], <span class="comment">// leaves</span> <span class="comment">// 0x10000..0x110000 (corresponding to 4 byte utf-8 sequences)</span> <span class="kw">pub</span> <span class="ident">r4</span>: [<span class="ident">u8</span>; <span class="number">256</span>], <span class="comment">// first level</span> <span class="kw">pub</span> <span class="ident">r5</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">u8</span>], <span class="comment">// second level</span> <span class="kw">pub</span> <span class="ident">r6</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">u64</span>], <span class="comment">// leaves</span> } <span class="kw">impl</span> <span class="ident">BoolTrie</span> { <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">lookup</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">c</span>: <span class="ident">char</span>) <span class="op">-></span> <span class="ident">bool</span> { <span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">c</span> <span class="kw">as</span> <span class="ident">u32</span>; <span class="kw">if</span> <span class="ident">c</span> <span class="op"><</span> <span class="number">0x800</span> { <span class="ident">trie_range_leaf</span>(<span class="ident">c</span>, <span class="self">self</span>.<span class="ident">r1</span>[(<span class="ident">c</span> <span class="op">>></span> <span class="number">6</span>) <span class="kw">as</span> <span class="ident">usize</span>]) } <span class="kw">else</span> <span class="kw">if</span> <span class="ident">c</span> <span class="op"><</span> <span class="number">0x10000</span> { <span class="kw">let</span> <span class="ident">child</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">r2</span>[(<span class="ident">c</span> <span class="op">>></span> <span class="number">6</span>) <span class="kw">as</span> <span class="ident">usize</span> <span class="op">-</span> <span class="number">0x20</span>]; <span class="ident">trie_range_leaf</span>(<span class="ident">c</span>, <span class="self">self</span>.<span class="ident">r3</span>[<span class="ident">child</span> <span class="kw">as</span> <span class="ident">usize</span>]) } <span class="kw">else</span> { <span class="kw">let</span> <span class="ident">child</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">r4</span>[(<span class="ident">c</span> <span class="op">>></span> <span class="number">12</span>) <span class="kw">as</span> <span class="ident">usize</span> <span class="op">-</span> <span class="number">0x10</span>]; <span class="kw">let</span> <span class="ident">leaf</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">r5</span>[((<span class="ident">child</span> <span class="kw">as</span> <span class="ident">usize</span>) <span class="op"><<</span> <span class="number">6</span>) <span class="op">+</span> ((<span class="ident">c</span> <span class="op">>></span> <span class="number">6</span>) <span class="kw">as</span> <span class="ident">usize</span> <span class="op">&</span> <span class="number">0x3f</span>)]; <span class="ident">trie_range_leaf</span>(<span class="ident">c</span>, <span class="self">self</span>.<span class="ident">r6</span>[<span class="ident">leaf</span> <span class="kw">as</span> <span class="ident">usize</span>]) } } } <span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">SmallBoolTrie</span> { <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">r1</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">u8</span>], <span class="comment">// first level</span> <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="ident">r2</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> [<span class="ident">u64</span>], <span class="comment">// leaves</span> } <span class="kw">impl</span> <span class="ident">SmallBoolTrie</span> { <span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">lookup</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">c</span>: <span class="ident">char</span>) <span class="op">-></span> <span class="ident">bool</span> { <span class="kw">let</span> <span class="ident">c</span> <span class="op">=</span> <span class="ident">c</span> <span class="kw">as</span> <span class="ident">u32</span>; <span class="kw">match</span> <span class="self">self</span>.<span class="ident">r1</span>.<span class="ident">get</span>((<span class="ident">c</span> <span class="op">>></span> <span class="number">6</span>) <span class="kw">as</span> <span class="ident">usize</span>) { <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="ident">child</span>) <span class="op">=></span> <span class="ident">trie_range_leaf</span>(<span class="ident">c</span>, <span class="self">self</span>.<span class="ident">r2</span>[<span class="ident">child</span> <span class="kw">as</span> <span class="ident">usize</span>]), <span class="prelude-val">None</span> <span class="op">=></span> <span class="bool-val">false</span>, } } } <span class="kw">fn</span> <span class="ident">trie_range_leaf</span>(<span class="ident">c</span>: <span class="ident">u32</span>, <span class="ident">bitmap_chunk</span>: <span class="ident">u64</span>) <span class="op">-></span> <span class="ident">bool</span> { ((<span class="ident">bitmap_chunk</span> <span class="op">>></span> (<span class="ident">c</span> <span class="op">&</span> <span class="number">63</span>)) <span class="op">&</span> <span class="number">1</span>) <span class="op">!=</span> <span class="number">0</span> } </pre></div> </section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../../";window.currentCrate = "core";</script><script src="../../../aliases.js"></script><script src="../../../main1.35.0.js"></script><script src="../../../source-script1.35.0.js"></script><script src="../../../source-files.js"></script><script defer src="../../../search-index.js"></script></body></html>