mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-20 18:20:41 +00:00
179 lines
7.9 KiB
HTML
179 lines
7.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="API documentation for the Rust `bitpacking` crate.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, bitpacking">
|
||
|
||
<title>bitpacking - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../normalize.css">
|
||
<link rel="stylesheet" type="text/css" href="../rustdoc.css"
|
||
id="mainThemeStyle">
|
||
|
||
<link rel="stylesheet" type="text/css" href="../dark.css">
|
||
<link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</head>
|
||
<body class="rustdoc mod">
|
||
<!--[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>
|
||
|
||
<p class='location'>Crate bitpacking</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'bitpacking', ty: 'mod', relpath: '../'};</script></div>
|
||
</nav>
|
||
|
||
<div class="theme-picker">
|
||
<button id="theme-picker" aria-label="Pick another theme!">
|
||
<img src="../brush.svg" width="18" alt="Pick another theme!">
|
||
</button>
|
||
<div id="theme-choices"></div>
|
||
</div>
|
||
<script src="../theme.js"></script>
|
||
<nav class="sub">
|
||
<form class="search-form js-only">
|
||
<div class="search-container">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content"><h1 class='fqn'><span class='in-band'>Crate <a class="mod" href=''>bitpacking</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/bitpacking/lib.rs.html#1-270' title='goto source code'>[src]</a></span></h1><div class='docblock'><h1 id="fast-bitpacking-algorithms" class="section-header"><a href="#fast-bitpacking-algorithms">Fast Bitpacking algorithms</a></h1>
|
||
<p>This crate is a <strong>Rust port of <a href="https://github.com/lemire/simdcomp">Daniel Lemire's simdcomp C library</a></strong>.
|
||
It contains different flavor of integers compression via bitpacking : <code>BitPacker1x</code>, <code>BitPacker4x</code>, and <code>BitPacker8x</code>.</p>
|
||
<p>Each produces different formats, and are incompatible one with another,
|
||
and requires integers to be encoded in block of different size..</p>
|
||
<p><code>BitPacker4x</code> and <code>BitPacker8x</code> are designed specifically to leverage <code>SSE3</code>
|
||
and <code>AVX2</code> instructions respectively.</p>
|
||
<p>The library will fallback to a scalar implementation if these instruction
|
||
sets are not available. For instance :</p>
|
||
<ul>
|
||
<li>because your compilation target architecture is not <code>x86_64</code></li>
|
||
<li>because the CPU you use is from an older generation</li>
|
||
</ul>
|
||
<p>I recommend using <code>BitPacker4x</code> if you are in doubt.</p>
|
||
<p>See the <a href="./trait.BitPacker.html"><code>BitPacker</code> trait</a> for example usage.</p>
|
||
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.BitPacker1x.html"
|
||
title='struct bitpacking::BitPacker1x'>BitPacker1x</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>BitPacker1x</code> is standard bitpacking : the integer representation over
|
||
<code>b</code> bits are simply concatenated one after the other.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.BitPacker4x.html"
|
||
title='struct bitpacking::BitPacker4x'>BitPacker4x</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>BitPacker4x</code> packs integers in groups of 4. This gives an opportunity
|
||
to leverage <code>SSE3</code> instructions to encode and decode the stream.</p>
|
||
|
||
</td>
|
||
</tr>
|
||
<tr class=' module-item'>
|
||
<td><a class="struct" href="struct.BitPacker8x.html"
|
||
title='struct bitpacking::BitPacker8x'>BitPacker8x</a></td>
|
||
<td class='docblock-short'>
|
||
<p><code>BitPacker8x</code> packs integers in groups of 8. This gives an opportunity
|
||
to leverage <code>AVX2</code> instructions to encode and decode the stream.
|
||
One block must contain <code>256 integers</code>.</p>
|
||
|
||
</td>
|
||
</tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
||
<table>
|
||
<tr class=' module-item'>
|
||
<td><a class="trait" href="trait.BitPacker.html"
|
||
title='trait bitpacking::BitPacker'>BitPacker</a></td>
|
||
<td class='docblock-short'>
|
||
<h1>Examples without delta-encoding</h1>
|
||
|
||
</td>
|
||
</tr></table></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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "bitpacking";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |