50 lines
7.4 KiB
HTML
50 lines
7.4 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="Description"><title>bit_vec - 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="bit_vec" 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="../bit_vec/index.html">bit_vec</a><span class="version">0.8.0</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="#description" title="Description">Description</a></li><li><a href="#examples" title="Examples">Examples</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></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>bit_vec</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/bit_vec/lib.rs.html#28-3186">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="description"><a class="doc-anchor" href="#description">§</a>Description</h2>
|
|
<p>Dynamic collections implemented with compact bit vectors.</p>
|
|
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
|
<p>This is a simple example of the <a href="http://en.wikipedia.org/wiki/Sieve_of_Eratosthenes">Sieve of Eratosthenes</a>
|
|
which calculates prime numbers up to a given limit.</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>bit_vec::BitVec;
|
|
|
|
<span class="kw">let </span>max_prime = <span class="number">10000</span>;
|
|
|
|
<span class="comment">// Store the primes as a BitVec
|
|
</span><span class="kw">let </span>primes = {
|
|
<span class="comment">// Assume all numbers are prime to begin, and then we
|
|
// cross off non-primes progressively
|
|
</span><span class="kw">let </span><span class="kw-2">mut </span>bv = BitVec::from_elem(max_prime, <span class="bool-val">true</span>);
|
|
|
|
<span class="comment">// Neither 0 nor 1 are prime
|
|
</span>bv.set(<span class="number">0</span>, <span class="bool-val">false</span>);
|
|
bv.set(<span class="number">1</span>, <span class="bool-val">false</span>);
|
|
|
|
<span class="kw">for </span>i <span class="kw">in </span><span class="number">2</span>.. <span class="number">1 </span>+ (max_prime <span class="kw">as </span>f64).sqrt() <span class="kw">as </span>usize {
|
|
<span class="comment">// if i is a prime
|
|
</span><span class="kw">if </span>bv[i] {
|
|
<span class="comment">// Mark all multiples of i as non-prime (any multiples below i * i
|
|
// will have been marked as non-prime previously)
|
|
</span><span class="kw">for </span>j <span class="kw">in </span>i.. {
|
|
<span class="kw">if </span>i * j >= max_prime {
|
|
<span class="kw">break</span>;
|
|
}
|
|
bv.set(i * j, <span class="bool-val">false</span>)
|
|
}
|
|
}
|
|
}
|
|
bv
|
|
};
|
|
|
|
<span class="comment">// Simple primality tests below our max bound
|
|
</span><span class="kw">let </span>print_primes = <span class="number">20</span>;
|
|
<span class="macro">print!</span>(<span class="string">"The primes below {} are: "</span>, print_primes);
|
|
<span class="kw">for </span>x <span class="kw">in </span><span class="number">0</span>..print_primes {
|
|
<span class="kw">if </span>primes.get(x).unwrap_or(<span class="bool-val">false</span>) {
|
|
<span class="macro">print!</span>(<span class="string">"{} "</span>, x);
|
|
}
|
|
}
|
|
<span class="macro">println!</span>();
|
|
|
|
<span class="kw">let </span>num_primes = primes.iter().filter(|x| <span class="kw-2">*</span>x).count();
|
|
<span class="macro">println!</span>(<span class="string">"There are {} primes below {}"</span>, num_primes, max_prime);
|
|
<span class="macro">assert_eq!</span>(num_primes, <span class="number">1_229</span>);</code></pre></div>
|
|
</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.BitVec.html" title="struct bit_vec::BitVec">BitVec</a></div><div class="desc docblock-short">The bitvector type.</div></li><li><div class="item-name"><a class="struct" href="struct.Blocks.html" title="struct bit_vec::Blocks">Blocks</a></div><div class="desc docblock-short">An iterator over the blocks of a <code>BitVec</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IntoIter.html" title="struct bit_vec::IntoIter">Into<wbr>Iter</a></div></li><li><div class="item-name"><a class="struct" href="struct.Iter.html" title="struct bit_vec::Iter">Iter</a></div><div class="desc docblock-short">An iterator for <code>BitVec</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.IterMut.html" title="struct bit_vec::IterMut">IterMut</a></div><div class="desc docblock-short">An iterator for mutable references to the bits in a <code>BitVec</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.MutBorrowedBit.html" title="struct bit_vec::MutBorrowedBit">MutBorrowed<wbr>Bit</a></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.BitBlock.html" title="trait bit_vec::BitBlock">BitBlock</a></div><div class="desc docblock-short">Abstracts over a pile of bits (basically unsigned primitives)</div></li></ul></section></div></main></body></html> |