edlang/hashbrown/index.html
2024-07-26 09:42:18 +00:00

7 lines
6.2 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="This crate is a Rust port of Googles high-performance SwissTable hash map, adapted to make it a drop-in replacement for Rusts standard `HashMap` and `HashSet` types."><title>hashbrown - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="hashbrown" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../hashbrown/index.html">hashbrown</a><span class="version">0.14.5</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></section></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">hashbrown</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../src/hashbrown/lib.rs.html#1-188">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate is a Rust port of Googles high-performance <a href="https://abseil.io/blog/20180927-swisstables">SwissTable</a> hash
map, adapted to make it a drop-in replacement for Rusts standard <code>HashMap</code>
and <code>HashSet</code> types.</p>
<p>The original C++ version of <a href="https://abseil.io/blog/20180927-swisstables">SwissTable</a> can be found <a href="https://github.com/abseil/abseil-cpp/blob/master/absl/container/internal/raw_hash_set.h">here</a>, and this
<a href="https://www.youtube.com/watch?v=ncHmEUmJZf4">CppCon talk</a> gives an overview of how the algorithm works.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="hash_map/index.html" title="mod hashbrown::hash_map">hash_map</a></div><div class="desc docblock-short">A hash map implemented with quadratic probing and SIMD lookup.</div></li><li><div class="item-name"><a class="mod" href="hash_set/index.html" title="mod hashbrown::hash_set">hash_set</a></div><div class="desc docblock-short">A hash set implemented as a <code>HashMap</code> where the value is <code>()</code>.</div></li><li><div class="item-name"><a class="mod" href="hash_table/index.html" title="mod hashbrown::hash_table">hash_table</a></div><div class="desc docblock-short">A hash table implemented with quadratic probing and SIMD lookup.</div></li><li><div class="item-name"><a class="mod" href="raw/index.html" title="mod hashbrown::raw">raw</a></div><div class="desc docblock-short">Experimental and unsafe <code>RawTable</code> API. This module is only available if the
<code>raw</code> feature is enabled.</div></li></ul><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.HashMap.html" title="struct hashbrown::HashMap">HashMap</a></div><div class="desc docblock-short">A hash map implemented with quadratic probing and SIMD lookup.</div></li><li><div class="item-name"><a class="struct" href="struct.HashSet.html" title="struct hashbrown::HashSet">HashSet</a></div><div class="desc docblock-short">A hash set implemented as a <code>HashMap</code> where the value is <code>()</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.HashTable.html" title="struct hashbrown::HashTable">HashTable</a></div><div class="desc docblock-short">Low-level hash table with explicit hashing.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a></div><div class="desc docblock-short">The error type for <code>try_reserve</code> methods.</div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.Equivalent.html" title="trait hashbrown::Equivalent">Equivalent</a></div><div class="desc docblock-short">Key equivalence trait.</div></li></ul></section></div></main></body></html>