mpvrc/memchr/arch/x86_64/avx2/memchr/index.html

17 lines
No EOL
6.6 KiB
HTML
Raw 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 module defines 256-bit vector implementations of `memchr` and friends."><title>memchr::arch::x86_64::avx2::memchr - 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="memchr" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.1 (e71f9a9a9 2025-01-27)" data-channel="1.84.1" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../../../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.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"><!--[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="../../../../../memchr/index.html">memchr</a><span class="version">2.7.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module memchr</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In memchr::<wbr>arch::<wbr>x86_<wbr>64::<wbr>avx2</a></h2></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"><span class="rustdoc-breadcrumbs"><a href="../../../../index.html">memchr</a>::<wbr><a href="../../../index.html">arch</a>::<wbr><a href="../../index.html">x86_64</a>::<wbr><a href="../index.html">avx2</a></span><h1>Module <span>memchr</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/memchr/arch/x86_64/avx2/memchr.rs.html#1-1352">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This module defines 256-bit vector implementations of <code>memchr</code> and friends.</p>
<p>The main types in this module are <a href="struct.One.html" title="struct memchr::arch::x86_64::avx2::memchr::One"><code>One</code></a>, <a href="struct.Two.html" title="struct memchr::arch::x86_64::avx2::memchr::Two"><code>Two</code></a> and <a href="struct.Three.html" title="struct memchr::arch::x86_64::avx2::memchr::Three"><code>Three</code></a>. They are for
searching for one, two or three distinct bytes, respectively, in a haystack.
Each type also has corresponding double ended iterators. These searchers are
typically much faster than scalar routines accomplishing the same task.</p>
<p>The <code>One</code> searcher also provides a <a href="struct.One.html#method.count" title="method memchr::arch::x86_64::avx2::memchr::One::count"><code>One::count</code></a> routine for efficiently
counting the number of times a single byte occurs in a haystack. This is
useful, for example, for counting the number of lines in a haystack. This
routine exists because it is usually faster, especially with a high match
count, then using <a href="struct.One.html#method.find" title="method memchr::arch::x86_64::avx2::memchr::One::find"><code>One::find</code></a> repeatedly. (<a href="struct.OneIter.html" title="struct memchr::arch::x86_64::avx2::memchr::OneIter"><code>OneIter</code></a> specializes its
<code>Iterator::count</code> implementation to use this routine.)</p>
<p>Only one, two and three bytes are supported because three bytes is about
the point where one sees diminishing returns. Beyond this point and its
probably (but not necessarily) better to just use a simple <code>[bool; 256]</code> array
or similar. However, it depends mightily on the specific work-load and the
expected match frequency.</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.One.html" title="struct memchr::arch::x86_64::avx2::memchr::One">One</a></div><div class="desc docblock-short">Finds all occurrences of a single byte in a haystack.</div></li><li><div class="item-name"><a class="struct" href="struct.OneIter.html" title="struct memchr::arch::x86_64::avx2::memchr::OneIter">OneIter</a></div><div class="desc docblock-short">An iterator over all occurrences of a single byte in a haystack.</div></li><li><div class="item-name"><a class="struct" href="struct.Three.html" title="struct memchr::arch::x86_64::avx2::memchr::Three">Three</a></div><div class="desc docblock-short">Finds all occurrences of three bytes in a haystack.</div></li><li><div class="item-name"><a class="struct" href="struct.ThreeIter.html" title="struct memchr::arch::x86_64::avx2::memchr::ThreeIter">Three<wbr>Iter</a></div><div class="desc docblock-short">An iterator over all occurrences of three possible bytes in a haystack.</div></li><li><div class="item-name"><a class="struct" href="struct.Two.html" title="struct memchr::arch::x86_64::avx2::memchr::Two">Two</a></div><div class="desc docblock-short">Finds all occurrences of two bytes in a haystack.</div></li><li><div class="item-name"><a class="struct" href="struct.TwoIter.html" title="struct memchr::arch::x86_64::avx2::memchr::TwoIter">TwoIter</a></div><div class="desc docblock-short">An iterator over all occurrences of two possible bytes in a haystack.</div></li></ul></section></div></main></body></html>