15 lines
6.9 KiB
HTML
15 lines
6.9 KiB
HTML
<!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="`FixedBitSet` is a simple fixed size set of bits."><title>fixedbitset - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.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-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="fixedbitset" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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="../fixedbitset/index.html">fixedbitset</a><span class="version">0.5.7</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#crate-features" title="Crate features">Crate features</a></li><li><a href="#simd-acceleration" title="SIMD Acceleration">SIMD Acceleration</a></li></ul><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#traits" title="Traits">Traits</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></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 <span>fixedbitset</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/fixedbitset/lib.rs.html#1-1711">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>FixedBitSet</code> is a simple fixed size set of bits.</p>
|
||
<h4 id="crate-features"><a class="doc-anchor" href="#crate-features">§</a>Crate features</h4>
|
||
<ul>
|
||
<li><code>std</code> (default feature)<br />
|
||
Disabling this feature disables using std and instead uses crate alloc.</li>
|
||
</ul>
|
||
<h4 id="simd-acceleration"><a class="doc-anchor" href="#simd-acceleration">§</a>SIMD Acceleration</h4>
|
||
<p><code>fixedbitset</code> is written with SIMD in mind. The backing store and set operations will use aligned SIMD data types and instructions when compiling
|
||
for compatible target platforms. The use of SIMD generally enables better performance in many set and batch operations (i.e. intersection/union/inserting a range).</p>
|
||
<p>When SIMD is not available on the target, the crate will gracefully fallback to a default implementation. It is intended to add support for other SIMD architectures
|
||
once they appear in stable Rust.</p>
|
||
<p>Currently only SSE2/AVX/AVX2 on x86/x86_64 and wasm32 SIMD are supported as this is what stable Rust supports.</p>
|
||
</div></details><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.Difference.html" title="struct fixedbitset::Difference">Difference</a></div><div class="desc docblock-short">An iterator producing elements in the difference of two sets.</div></li><li><div class="item-name"><a class="struct" href="struct.FixedBitSet.html" title="struct fixedbitset::FixedBitSet">Fixed<wbr>BitSet</a></div><div class="desc docblock-short"><code>FixedBitSet</code> is a simple fixed size set of bits that each can
|
||
be enabled (1 / <strong>true</strong>) or disabled (0 / <strong>false</strong>).</div></li><li><div class="item-name"><a class="struct" href="struct.Intersection.html" title="struct fixedbitset::Intersection">Intersection</a></div><div class="desc docblock-short">An iterator producing elements in the intersection of two sets.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoOnes.html" title="struct fixedbitset::IntoOnes">Into<wbr>Ones</a></div></li><li><div class="item-name"><a class="struct" href="struct.Ones.html" title="struct fixedbitset::Ones">Ones</a></div><div class="desc docblock-short">An iterator producing the indices of the set bit in a set.</div></li><li><div class="item-name"><a class="struct" href="struct.SymmetricDifference.html" title="struct fixedbitset::SymmetricDifference">Symmetric<wbr>Difference</a></div><div class="desc docblock-short">An iterator producing elements in the symmetric difference of two sets.</div></li><li><div class="item-name"><a class="struct" href="struct.Union.html" title="struct fixedbitset::Union">Union</a></div><div class="desc docblock-short">An iterator producing elements in the union of two sets.</div></li><li><div class="item-name"><a class="struct" href="struct.Zeroes.html" title="struct fixedbitset::Zeroes">Zeroes</a></div><div class="desc docblock-short">An iterator producing the indices of the set bit in a set.</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.IndexRange.html" title="trait fixedbitset::IndexRange">Index<wbr>Range</a></div><div class="desc docblock-short"><strong>IndexRange</strong> is implemented by Rust’s built-in range types, produced
|
||
by range syntax like <code>..</code>, <code>a..</code>, <code>..b</code> or <code>c..d</code>.</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.Block.html" title="type fixedbitset::Block">Block</a></div></li></ul></section></div></main></body></html> |