| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class LZ4 |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class LZ4 |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Codecs.Compressing.LZ4"> |
| |
| |
| <h1 id="Lucene_Net_Codecs_Compressing_LZ4" data-uid="Lucene.Net.Codecs.Compressing.LZ4" class="text-break">Class LZ4 |
| </h1> |
| <div class="markdown level0 summary"><p>LZ4 compression and decompression routines. |
| <p> |
| <a href="http://code.google.com/p/lz4/">http://code.google.com/p/lz4/</a> |
| <a href="http://fastcompression.blogspot.fr/p/lz4.html">http://fastcompression.blogspot.fr/p/lz4.html</a></p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">LZ4</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetHashCode()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.GetType()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.MemberwiseClone()</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span> |
| </div> |
| <div> |
| <span class="xref">System.Object.ToString()</span> |
| </div> |
| </div> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Codecs.Compressing.html">Lucene.Net.Codecs.Compressing</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Codecs_Compressing_LZ4_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public sealed class LZ4</code></pre> |
| </div> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Compressing_LZ4_Compress_System_Byte___System_Int32_System_Int32_Lucene_Net_Store_DataOutput_Lucene_Net_Codecs_Compressing_LZ4_HashTable_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.LZ4.Compress(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32%2CLucene.Net.Store.DataOutput%2CLucene.Net.Codecs.Compressing.LZ4.HashTable)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Codecs/Compressing/LZ4.cs/#L249">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_LZ4_Compress_" data-uid="Lucene.Net.Codecs.Compressing.LZ4.Compress*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_LZ4_Compress_System_Byte___System_Int32_System_Int32_Lucene_Net_Store_DataOutput_Lucene_Net_Codecs_Compressing_LZ4_HashTable_" data-uid="Lucene.Net.Codecs.Compressing.LZ4.Compress(System.Byte[],System.Int32,System.Int32,Lucene.Net.Store.DataOutput,Lucene.Net.Codecs.Compressing.LZ4.HashTable)">Compress(Byte[], Int32, Int32, DataOutput, LZ4.HashTable)</h4> |
| <div class="markdown level1 summary"><p>Compress <code>bytes[off:off+len]</code> into <code data-dev-comment-type="paramref" class="paramref">out</code> using |
| at most 16KB of memory. <code data-dev-comment-type="paramref" class="paramref">ht</code> shouldn't be shared across threads |
| but can safely be reused.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void Compress(byte[] bytes, int off, int len, DataOutput out, LZ4.HashTable ht)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">bytes</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">off</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Store.DataOutput.html">DataOutput</a></td> |
| <td><span class="parametername">out</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Codecs.Compressing.LZ4.HashTable.html">LZ4.HashTable</a></td> |
| <td><span class="parametername">ht</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Compressing_LZ4_CompressHC_System_Byte___System_Int32_System_Int32_Lucene_Net_Store_DataOutput_Lucene_Net_Codecs_Compressing_LZ4_HCHashTable_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.LZ4.CompressHC(System.Byte%5B%5D%2CSystem.Int32%2CSystem.Int32%2CLucene.Net.Store.DataOutput%2CLucene.Net.Codecs.Compressing.LZ4.HCHashTable)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Codecs/Compressing/LZ4.cs/#L487">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_LZ4_CompressHC_" data-uid="Lucene.Net.Codecs.Compressing.LZ4.CompressHC*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_LZ4_CompressHC_System_Byte___System_Int32_System_Int32_Lucene_Net_Store_DataOutput_Lucene_Net_Codecs_Compressing_LZ4_HCHashTable_" data-uid="Lucene.Net.Codecs.Compressing.LZ4.CompressHC(System.Byte[],System.Int32,System.Int32,Lucene.Net.Store.DataOutput,Lucene.Net.Codecs.Compressing.LZ4.HCHashTable)">CompressHC(Byte[], Int32, Int32, DataOutput, LZ4.HCHashTable)</h4> |
| <div class="markdown level1 summary"><p>Compress <code>bytes[off:off+len]</code> into <code data-dev-comment-type="paramref" class="paramref">out</code>. Compared to |
| <a class="xref" href="Lucene.Net.Codecs.Compressing.LZ4.html#Lucene_Net_Codecs_Compressing_LZ4_Compress_System_Byte___System_Int32_System_Int32_Lucene_Net_Store_DataOutput_Lucene_Net_Codecs_Compressing_LZ4_HashTable_">Compress(Byte[], Int32, Int32, DataOutput, LZ4.HashTable)</a>, this method |
| is slower and uses more memory (~ 256KB per thread) but should provide |
| better compression ratios (especially on large inputs) because it chooses |
| the best match among up to 256 candidates and then performs trade-offs to |
| fix overlapping matches. <code data-dev-comment-type="paramref" class="paramref">ht</code> shouldn't be shared across threads |
| but can safely be reused.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static void CompressHC(byte[] src, int srcOff, int srcLen, DataOutput out, LZ4.HCHashTable ht)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">src</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">srcOff</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">srcLen</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Store.DataOutput.html">DataOutput</a></td> |
| <td><span class="parametername">out</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Codecs.Compressing.LZ4.HCHashTable.html">LZ4.HCHashTable</a></td> |
| <td><span class="parametername">ht</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Compressing_LZ4_Decompress_Lucene_Net_Store_DataInput_System_Int32_System_Byte___System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.LZ4.Decompress(Lucene.Net.Store.DataInput%2CSystem.Int32%2CSystem.Byte%5B%5D%2CSystem.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Codecs/Compressing/LZ4.cs/#L103">View Source</a> |
| </span> |
| <a id="Lucene_Net_Codecs_Compressing_LZ4_Decompress_" data-uid="Lucene.Net.Codecs.Compressing.LZ4.Decompress*"></a> |
| <h4 id="Lucene_Net_Codecs_Compressing_LZ4_Decompress_Lucene_Net_Store_DataInput_System_Int32_System_Byte___System_Int32_" data-uid="Lucene.Net.Codecs.Compressing.LZ4.Decompress(Lucene.Net.Store.DataInput,System.Int32,System.Byte[],System.Int32)">Decompress(DataInput, Int32, Byte[], Int32)</h4> |
| <div class="markdown level1 summary"><p>Decompress at least <code data-dev-comment-type="paramref" class="paramref">decompressedLen</code> bytes into |
| <code>dest[dOff]</code>. Please note that <code data-dev-comment-type="paramref" class="paramref">dest</code> must be large |
| enough to be able to hold <strong>all</strong> decompressed data (meaning that you |
| need to know the total decompressed length).</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static int Decompress(DataInput compressed, int decompressedLen, byte[] dest, int dOff)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a></td> |
| <td><span class="parametername">compressed</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">decompressedLen</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">dest</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">dOff</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_Compressing_LZ4.md&value=---%0Auid%3A%20Lucene.Net.Codecs.Compressing.LZ4%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Codecs/Compressing/LZ4.cs/#L35" class="contribution-link">View Source</a> |
| </li> |
| </ul> |
| </div> |
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix"> |
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> --> |
| </nav> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <footer> |
| <div class="grad-bottom"></div> |
| <div class="footer"> |
| <div class="container"> |
| <span class="pull-right"> |
| <a href="#top">Back to top</a> |
| </span> |
| Copyright © 2020 Licensed to the Apache Software Foundation (ASF) |
| |
| </div> |
| </div> |
| </footer> |
| </div> |
| |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script> |
| <script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script> |
| </body> |
| </html> |
