mirror of
https://github.com/quickwit-oss/tantivy.git
synced 2026-05-20 18:20:41 +00:00
Automatic Travis documentation build
This commit is contained in:
Travis CI User
@@ -59,24 +59,24 @@
|
||||
<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/bitpacker4x.rs.html#155' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct BitPacker4x(_);</pre></div><div class='docblock'><p><code>BitPacker4x</code> packs integers in groups of 4. This gives an opportunity
|
||||
</span><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#157' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct BitPacker4x(_);</pre></div><div class='docblock'><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>
|
||||
<p>One block must contain <code>128 integers</code>.</p>
|
||||
</div>
|
||||
<h2 id='implementations' class='small-section-header'>
|
||||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||||
</h2>
|
||||
<div id='implementations-list'><h3 id='impl-BitPacker' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../bitpacking/trait.BitPacker.html" title="trait bitpacking::BitPacker">BitPacker</a> for <a class="struct" href="../bitpacking/struct.BitPacker4x.html" title="struct bitpacking::BitPacker4x">BitPacker4x</a></code><a href='#impl-BitPacker' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#157-238' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedconstant.BLOCK_LEN' class="associatedconstant"><span id='BLOCK_LEN.v' class='invisible'><code>const <a href='../bitpacking/trait.BitPacker.html#associatedconstant.BLOCK_LEN' class="constant"><b>BLOCK_LEN</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
|
||||
<div id='implementations-list'><h3 id='impl-BitPacker' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../bitpacking/trait.BitPacker.html" title="trait bitpacking::BitPacker">BitPacker</a> for <a class="struct" href="../bitpacking/struct.BitPacker4x.html" title="struct bitpacking::BitPacker4x">BitPacker4x</a></code><a href='#impl-BitPacker' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#159-246' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedconstant.BLOCK_LEN' class="associatedconstant"><span id='BLOCK_LEN.v' class='invisible'><code>const <a href='../bitpacking/trait.BitPacker.html#associatedconstant.BLOCK_LEN' class="constant"><b>BLOCK_LEN</b></a>: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></h4>
|
||||
<div class='docblock'><pre class="rust ">
|
||||
<span class="ident">BLOCK_LEN</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="ident">BLOCK_LEN</span></pre>
|
||||
<p>Number of <code>u32</code> per compressed block</p>
|
||||
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.new' class='fnname'>new</a>() -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#163-171' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the best available implementation for the current CPU.</p>
|
||||
</div><h4 id='method.compress' class="method"><span id='compress.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.compress' class='fnname'>compress</a>(<br> &self, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#173-182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Compress a block of <code>u32</code>. <a href="../bitpacking/trait.BitPacker.html#tymethod.compress">Read more</a></p>
|
||||
</div><h4 id='method.compress_sorted' class="method"><span id='compress_sorted.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.compress_sorted' class='fnname'>compress_sorted</a>(<br> &self, <br> initial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#184-193' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Delta encode and compressed the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.compress_sorted">Read more</a></p>
|
||||
</div><h4 id='method.decompress' class="method"><span id='decompress.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.decompress' class='fnname'>decompress</a>(<br> &self, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#195-204' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Decompress the <code>compress</code> array to the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.decompress">Read more</a></p>
|
||||
</div><h4 id='method.decompress_sorted' class="method"><span id='decompress_sorted.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.decompress_sorted' class='fnname'>decompress_sorted</a>(<br> &self, <br> initial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#206-215' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Decompress the<code>compress</code>array to the <code>decompressed</code> array. The <code>compressed</code> array is assumed to have been delta-encoded and compressed. <a href="../bitpacking/trait.BitPacker.html#tymethod.decompress_sorted">Read more</a></p>
|
||||
</div><h4 id='method.num_bits' class="method"><span id='num_bits.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.num_bits' class='fnname'>num_bits</a>(&self, decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#217-226' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the minimum number of bits used to represent the largest integer in the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.num_bits">Read more</a></p>
|
||||
</div><h4 id='method.num_bits_sorted' class="method"><span id='num_bits_sorted.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.num_bits_sorted' class='fnname'>num_bits_sorted</a>(&self, initial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#228-237' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the minimum number of bits used to represent the largest <code>delta</code> in the deltas in the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.num_bits_sorted">Read more</a></p>
|
||||
</div><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.new' class='fnname'>new</a>() -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#165-173' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the best available implementation for the current CPU.</p>
|
||||
</div><h4 id='method.compress' class="method"><span id='compress.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.compress' class='fnname'>compress</a>(<br> &self, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#175-185' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Compress a block of <code>u32</code>. <a href="../bitpacking/trait.BitPacker.html#tymethod.compress">Read more</a></p>
|
||||
</div><h4 id='method.compress_sorted' class="method"><span id='compress_sorted.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.compress_sorted' class='fnname'>compress_sorted</a>(<br> &self, <br> initial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#187-197' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Delta encode and compressed the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.compress_sorted">Read more</a></p>
|
||||
</div><h4 id='method.decompress' class="method"><span id='decompress.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.decompress' class='fnname'>decompress</a>(<br> &self, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#199-209' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Decompress the <code>compress</code> array to the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.decompress">Read more</a></p>
|
||||
</div><h4 id='method.decompress_sorted' class="method"><span id='decompress_sorted.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.decompress_sorted' class='fnname'>decompress_sorted</a>(<br> &self, <br> initial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> compressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, <br> num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#211-221' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Decompress the<code>compress</code>array to the <code>decompressed</code> array. The <code>compressed</code> array is assumed to have been delta-encoded and compressed. <a href="../bitpacking/trait.BitPacker.html#tymethod.decompress_sorted">Read more</a></p>
|
||||
</div><h4 id='method.num_bits' class="method"><span id='num_bits.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.num_bits' class='fnname'>num_bits</a>(&self, decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#223-233' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the minimum number of bits used to represent the largest integer in the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.num_bits">Read more</a></p>
|
||||
</div><h4 id='method.num_bits_sorted' class="method"><span id='num_bits_sorted.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#tymethod.num_bits_sorted' class='fnname'>num_bits_sorted</a>(&self, initial: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, decompressed: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/bitpacker4x.rs.html#235-245' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the minimum number of bits used to represent the largest <code>delta</code> in the deltas in the <code>decompressed</code> array. <a href="../bitpacking/trait.BitPacker.html#tymethod.num_bits_sorted">Read more</a></p>
|
||||
</div><h4 id='method.compressed_block_size' class="method"><span id='compressed_block_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../bitpacking/trait.BitPacker.html#method.compressed_block_size' class='fnname'>compressed_block_size</a>(num_bits: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/bitpacking/lib.rs.html#250-252' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the size of a compressed block.</p>
|
||||
</div></div></div>
|
||||
<h2 id='synthetic-implementations' class='small-section-header'>
|
||||
|
||||
Reference in New Issue
Block a user