| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class PackedInt32s |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class PackedInt32s |
| | 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.Util.Packed.PackedInt32s"> |
| |
| |
| <h1 id="Lucene_Net_Util_Packed_PackedInt32s" data-uid="Lucene.Net.Util.Packed.PackedInt32s" class="text-break">Class PackedInt32s |
| </h1> |
| <div class="markdown level0 summary"><p>Simplistic compression for array of unsigned long values. |
| Each value is >= 0 and <= a specified maximum value. The |
| values are stored as packed ints, with each value |
| consuming a fixed number of bits. |
| <p> |
| NOTE: This was PackedInts in Lucene. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></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">PackedInt32s</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.Util.Packed.html">Lucene.Net.Util.Packed</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Util_Packed_PackedInt32s_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class PackedInt32s</code></pre> |
| </div> |
| <h3 id="fields">Fields |
| </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_Util_Packed_PackedInt32s_CODEC_NAME.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.CODEC_NAME%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/Util/Packed/PackedInts.cs/#L70">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_CODEC_NAME" data-uid="Lucene.Net.Util.Packed.PackedInt32s.CODEC_NAME">CODEC_NAME</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static string CODEC_NAME</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.String</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_Util_Packed_PackedInt32s_COMPACT.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.COMPACT%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/Util/Packed/PackedInts.cs/#L63">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_COMPACT" data-uid="Lucene.Net.Util.Packed.PackedInt32s.COMPACT">COMPACT</h4> |
| <div class="markdown level1 summary"><p>No memory overhead at all, but the returned implementation may be slow.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float COMPACT</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.Single</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_Util_Packed_PackedInt32s_DEFAULT.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.DEFAULT%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/Util/Packed/PackedInts.cs/#L58">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_DEFAULT" data-uid="Lucene.Net.Util.Packed.PackedInt32s.DEFAULT">DEFAULT</h4> |
| <div class="markdown level1 summary"><p>At most 20% memory overhead.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float DEFAULT</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.Single</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_Util_Packed_PackedInt32s_DEFAULT_BUFFER_SIZE.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.DEFAULT_BUFFER_SIZE%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/Util/Packed/PackedInts.cs/#L68">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_DEFAULT_BUFFER_SIZE" data-uid="Lucene.Net.Util.Packed.PackedInt32s.DEFAULT_BUFFER_SIZE">DEFAULT_BUFFER_SIZE</h4> |
| <div class="markdown level1 summary"><p>Default amount of memory to use for bulk operations.</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 DEFAULT_BUFFER_SIZE</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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> |
| <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_Util_Packed_PackedInt32s_FAST.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.FAST%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/Util/Packed/PackedInts.cs/#L53">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_FAST" data-uid="Lucene.Net.Util.Packed.PackedInt32s.FAST">FAST</h4> |
| <div class="markdown level1 summary"><p>At most 50% memory overhead, always select a reasonably fast implementation.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float FAST</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.Single</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_Util_Packed_PackedInt32s_FASTEST.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.FASTEST%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/Util/Packed/PackedInts.cs/#L48">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_FASTEST" data-uid="Lucene.Net.Util.Packed.PackedInt32s.FASTEST">FASTEST</h4> |
| <div class="markdown level1 summary"><p>At most 700% memory overhead, always select a direct implementation.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static float FASTEST</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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.Single</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_Util_Packed_PackedInt32s_VERSION_BYTE_ALIGNED.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.VERSION_BYTE_ALIGNED%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/Util/Packed/PackedInts.cs/#L72">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_VERSION_BYTE_ALIGNED" data-uid="Lucene.Net.Util.Packed.PackedInt32s.VERSION_BYTE_ALIGNED">VERSION_BYTE_ALIGNED</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static int VERSION_BYTE_ALIGNED</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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> |
| <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_Util_Packed_PackedInt32s_VERSION_CURRENT.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.VERSION_CURRENT%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/Util/Packed/PackedInts.cs/#L73">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_VERSION_CURRENT" data-uid="Lucene.Net.Util.Packed.PackedInt32s.VERSION_CURRENT">VERSION_CURRENT</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static int VERSION_CURRENT</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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> |
| <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_Util_Packed_PackedInt32s_VERSION_START.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.VERSION_START%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/Util/Packed/PackedInts.cs/#L71">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_VERSION_START" data-uid="Lucene.Net.Util.Packed.PackedInt32s.VERSION_START">VERSION_START</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static int VERSION_START</code></pre> |
| </div> |
| <h5 class="fieldValue">Field Value</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> |
| <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_Util_Packed_PackedInt32s_BitsRequired_System_Int64_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.BitsRequired(System.Int64)%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/Util/Packed/PackedInts.cs/#L1324">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_BitsRequired_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.BitsRequired*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_BitsRequired_System_Int64_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.BitsRequired(System.Int64)">BitsRequired(Int64)</h4> |
| <div class="markdown level1 summary"><p>Returns how many bits are required to hold values up |
| to and including <code data-dev-comment-type="paramref" class="paramref">maxValue</code>. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static int BitsRequired(long maxValue)</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.Int64</span></td> |
| <td><span class="parametername">maxValue</span></td> |
| <td><p>The maximum value that should be representable. </p> |
| </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><p>The amount of bits needed to represent values from 0 to <code data-dev-comment-type="paramref" class="paramref">maxValue</code>. </p> |
| </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_Util_Packed_PackedInt32s_CheckVersion_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.CheckVersion(System.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/Util/Packed/PackedInts.cs/#L78">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_CheckVersion_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.CheckVersion*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_CheckVersion_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.CheckVersion(System.Int32)">CheckVersion(Int32)</h4> |
| <div class="markdown level1 summary"><p>Check the validity of a version number.</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 CheckVersion(int version)</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.Int32</span></td> |
| <td><span class="parametername">version</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_Util_Packed_PackedInt32s_Copy_Lucene_Net_Util_Packed_PackedInt32s_Reader_System_Int32_Lucene_Net_Util_Packed_PackedInt32s_Mutable_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Copy(Lucene.Net.Util.Packed.PackedInt32s.Reader%2CSystem.Int32%2CLucene.Net.Util.Packed.PackedInt32s.Mutable%2CSystem.Int32%2CSystem.Int32%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/Util/Packed/PackedInts.cs/#L1351">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_Copy_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Copy*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_Copy_Lucene_Net_Util_Packed_PackedInt32s_Reader_System_Int32_Lucene_Net_Util_Packed_PackedInt32s_Mutable_System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Copy(Lucene.Net.Util.Packed.PackedInt32s.Reader,System.Int32,Lucene.Net.Util.Packed.PackedInt32s.Mutable,System.Int32,System.Int32,System.Int32)">Copy(PackedInt32s.Reader, Int32, PackedInt32s.Mutable, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Copy <code>src[srcPos:srcPos+len]</code> into |
| <code>dest[destPos:destPos+len]</code> using at most <code data-dev-comment-type="paramref" class="paramref">mem</code> |
| bytes.</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 Copy(PackedInt32s.Reader src, int srcPos, PackedInt32s.Mutable dest, int destPos, int len, int mem)</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.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a></td> |
| <td><span class="parametername">src</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">srcPos</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Mutable.html">PackedInt32s.Mutable</a></td> |
| <td><span class="parametername">dest</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">destPos</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><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">mem</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_Util_Packed_PackedInt32s_FastestFormatAndBits_System_Int32_System_Int32_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.FastestFormatAndBits(System.Int32%2CSystem.Int32%2CSystem.Single)%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/Util/Packed/PackedInts.cs/#L294">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_FastestFormatAndBits_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.FastestFormatAndBits*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_FastestFormatAndBits_System_Int32_System_Int32_System_Single_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.FastestFormatAndBits(System.Int32,System.Int32,System.Single)">FastestFormatAndBits(Int32, Int32, Single)</h4> |
| <div class="markdown level1 summary"><p>Try to find the <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a> and number of bits per value that would |
| restore from disk the fastest reader whose overhead is less than |
| <code data-dev-comment-type="paramref" class="paramref">acceptableOverheadRatio</code>. |
| <p> |
| The <code data-dev-comment-type="paramref" class="paramref">acceptableOverheadRatio</code> parameter makes sense for |
| random-access <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a>s. In case you only plan to perform |
| sequential access on this stream later on, you should probably use |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_COMPACT">COMPACT</a>. |
| <p> |
| If you don't know how many values you are going to write, use |
| <code><code data-dev-comment-type="paramref" class="paramref">valueCount</code> = -1</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.FormatAndBits FastestFormatAndBits(int valueCount, int bitsPerValue, float acceptableOverheadRatio)</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.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">acceptableOverheadRatio</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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.FormatAndBits.html">PackedInt32s.FormatAndBits</a></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_Util_Packed_PackedInt32s_GetDecoder_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetDecoder(Lucene.Net.Util.Packed.PackedInt32s.Format%2CSystem.Int32%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/Util/Packed/PackedInts.cs/#L867">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetDecoder_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDecoder*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetDecoder_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDecoder(Lucene.Net.Util.Packed.PackedInt32s.Format,System.Int32,System.Int32)">GetDecoder(PackedInt32s.Format, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Get a <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IDecoder.html">PackedInt32s.IDecoder</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.IDecoder GetDecoder(PackedInt32s.Format format, int version, int bitsPerValue)</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.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>The format used to store packed <span class="xref">System.Int32</span>s. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>The compatibility version. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits per value. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IDecoder.html">PackedInt32s.IDecoder</a></td> |
| <td><p>A decoder. </p> |
| </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_Util_Packed_PackedInt32s_GetDirectReader_Lucene_Net_Store_IndexInput_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetDirectReader(Lucene.Net.Store.IndexInput)%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/Util/Packed/PackedInts.cs/#L1138">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetDirectReader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDirectReader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetDirectReader_Lucene_Net_Store_IndexInput_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDirectReader(Lucene.Net.Store.IndexInput)">GetDirectReader(IndexInput)</h4> |
| <div class="markdown level1 summary"><p>Construct a direct <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a> from an <a class="xref" href="Lucene.Net.Store.IndexInput.html">IndexInput</a>. this method |
| is useful to restore data from streams which have been created using |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetWriter_Lucene_Net_Store_DataOutput_System_Int32_System_Int32_System_Single_">GetWriter(DataOutput, Int32, Int32, Single)</a>. |
| <p> |
| The returned reader will have very little memory overhead, but every call |
| to <a class="xref" href="Lucene.Net.Index.NumericDocValues.html#Lucene_Net_Index_NumericDocValues_Get_System_Int32_">Get(Int32)</a> is likely to perform a disk seek. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Reader GetDirectReader(IndexInput in)</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.IndexInput.html">IndexInput</a></td> |
| <td><span class="parametername">in</span></td> |
| <td><p>The stream to read data from. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a></td> |
| <td><p>A direct <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </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_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_Lucene_Net_Store_IndexInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetDirectReaderNoHeader(Lucene.Net.Store.IndexInput%2CLucene.Net.Util.Packed.PackedInt32s.Format%2CSystem.Int32%2CSystem.Int32%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/Util/Packed/PackedInts.cs/#L1042">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDirectReaderNoHeader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_Lucene_Net_Store_IndexInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDirectReaderNoHeader(Lucene.Net.Store.IndexInput,Lucene.Net.Util.Packed.PackedInt32s.Format,System.Int32,System.Int32,System.Int32)">GetDirectReaderNoHeader(IndexInput, PackedInt32s.Format, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Expert: Construct a direct <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a> from a stream without reading |
| metadata at the beginning of the stream. This method is useful to restore |
| data from streams which have been created using |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_">GetWriterNoHeader(DataOutput, PackedInt32s.Format, Int32, Int32, Int32)</a>. |
| <p> |
| The returned reader will have very little memory overhead, but every call |
| to <a class="xref" href="Lucene.Net.Index.NumericDocValues.html#Lucene_Net_Index_NumericDocValues_Get_System_Int32_">Get(Int32)</a> is likely to perform a disk seek. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Reader GetDirectReaderNoHeader(IndexInput in, PackedInt32s.Format format, int version, int valueCount, int bitsPerValue)</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.IndexInput.html">IndexInput</a></td> |
| <td><span class="parametername">in</span></td> |
| <td><p>The stream to read data from. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>The format used to serialize. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>The version used to serialize the data. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td><p>How many values the stream holds. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits per value. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a></td> |
| <td><p>A direct <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a>. </p> |
| </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_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_Lucene_Net_Store_IndexInput_Lucene_Net_Util_Packed_PackedInt32s_Header_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetDirectReaderNoHeader(Lucene.Net.Store.IndexInput%2CLucene.Net.Util.Packed.PackedInt32s.Header)%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/Util/Packed/PackedInts.cs/#L1120">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDirectReaderNoHeader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_Lucene_Net_Store_IndexInput_Lucene_Net_Util_Packed_PackedInt32s_Header_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetDirectReaderNoHeader(Lucene.Net.Store.IndexInput,Lucene.Net.Util.Packed.PackedInt32s.Header)">GetDirectReaderNoHeader(IndexInput, PackedInt32s.Header)</h4> |
| <div class="markdown level1 summary"><p>Expert: Construct a direct <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a> from an <a class="xref" href="Lucene.Net.Store.IndexInput.html">IndexInput</a> |
| without reading metadata at the beginning of the stream. this method is |
| useful to restore data when metadata has been previously read using |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_">ReadHeader(DataInput)</a>. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Reader GetDirectReaderNoHeader(IndexInput in, PackedInt32s.Header header)</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.IndexInput.html">IndexInput</a></td> |
| <td><span class="parametername">in</span></td> |
| <td><p>The stream to read data from, positioned at the beginning of the packed values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Header.html">PackedInt32s.Header</a></td> |
| <td><span class="parametername">header</span></td> |
| <td><p>Metadata result from <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_">ReadHeader(DataInput)</a>. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_Lucene_Net_Store_IndexInput_Lucene_Net_Util_Packed_PackedInt32s_Header__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_">ReadHeader(DataInput)</a></div> |
| </div> |
| <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_Util_Packed_PackedInt32s_GetEncoder_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetEncoder(Lucene.Net.Util.Packed.PackedInt32s.Format%2CSystem.Int32%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/Util/Packed/PackedInts.cs/#L880">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetEncoder_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetEncoder*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetEncoder_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetEncoder(Lucene.Net.Util.Packed.PackedInt32s.Format,System.Int32,System.Int32)">GetEncoder(PackedInt32s.Format, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Get an <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IEncoder.html">PackedInt32s.IEncoder</a>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.IEncoder GetEncoder(PackedInt32s.Format format, int version, int bitsPerValue)</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.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>The format used to store packed <span class="xref">System.Int32</span>s. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>The compatibility version. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits per value. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IEncoder.html">PackedInt32s.IEncoder</a></td> |
| <td><p>An encoder. </p> |
| </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_Util_Packed_PackedInt32s_GetMutable_System_Int32_System_Int32_Lucene_Net_Util_Packed_PackedInt32s_Format_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetMutable(System.Int32%2CSystem.Int32%2CLucene.Net.Util.Packed.PackedInt32s.Format)%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/Util/Packed/PackedInts.cs/#L1179">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetMutable_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetMutable*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetMutable_System_Int32_System_Int32_Lucene_Net_Util_Packed_PackedInt32s_Format_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetMutable(System.Int32,System.Int32,Lucene.Net.Util.Packed.PackedInt32s.Format)">GetMutable(Int32, Int32, PackedInt32s.Format)</h4> |
| <div class="markdown level1 summary"><p>Same as <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetMutable_System_Int32_System_Int32_System_Single_">GetMutable(Int32, Int32, Single)</a> with a pre-computed number |
| of bits per value and format. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Mutable GetMutable(int valueCount, int bitsPerValue, PackedInt32s.Format format)</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.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a></td> |
| <td><span class="parametername">format</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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Mutable.html">PackedInt32s.Mutable</a></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_Util_Packed_PackedInt32s_GetMutable_System_Int32_System_Int32_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetMutable(System.Int32%2CSystem.Int32%2CSystem.Single)%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/Util/Packed/PackedInts.cs/#L1167">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetMutable_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetMutable*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetMutable_System_Int32_System_Int32_System_Single_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetMutable(System.Int32,System.Int32,System.Single)">GetMutable(Int32, Int32, Single)</h4> |
| <div class="markdown level1 summary"><p>Create a packed integer array with the given amount of values initialized |
| to 0. The <code data-dev-comment-type="paramref" class="paramref">valueCount</code> and the <code data-dev-comment-type="paramref" class="paramref">bitsPerValue</code> cannot be changed after creation. |
| All Mutables known by this factory are kept fully in RAM. |
| <p> |
| Positive values of <code data-dev-comment-type="paramref" class="paramref">acceptableOverheadRatio</code> will trade space |
| for speed by selecting a faster but potentially less memory-efficient |
| implementation. An <code data-dev-comment-type="paramref" class="paramref">acceptableOverheadRatio</code> of |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_COMPACT">COMPACT</a> will make sure that the most memory-efficient |
| implementation is selected whereas <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_FASTEST">FASTEST</a> will make sure |
| that the fastest implementation is selected. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Mutable GetMutable(int valueCount, int bitsPerValue, float acceptableOverheadRatio)</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.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td><p>The number of elements. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits available for any given value. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">acceptableOverheadRatio</span></td> |
| <td><p>An acceptable overhead |
| ratio per value. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Mutable.html">PackedInt32s.Mutable</a></td> |
| <td><p>A mutable packed integer array. </p> |
| </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_Util_Packed_PackedInt32s_GetReader_Lucene_Net_Store_DataInput_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetReader(Lucene.Net.Store.DataInput)%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/Util/Packed/PackedInts.cs/#L973">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetReader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetReader_Lucene_Net_Store_DataInput_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReader(Lucene.Net.Store.DataInput)">GetReader(DataInput)</h4> |
| <div class="markdown level1 summary"><p>Restore a <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a> from a stream. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Reader GetReader(DataInput in)</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">in</span></td> |
| <td><p>The stream to read data from. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error </p> |
| </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_Util_Packed_PackedInt32s_GetReaderIterator_Lucene_Net_Store_DataInput_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetReaderIterator(Lucene.Net.Store.DataInput%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/Util/Packed/PackedInts.cs/#L1015">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderIterator_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderIterator*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderIterator_Lucene_Net_Store_DataInput_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderIterator(Lucene.Net.Store.DataInput,System.Int32)">GetReaderIterator(DataInput, Int32)</h4> |
| <div class="markdown level1 summary"><p>Retrieve <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html">PackedInt32s</a> as a <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IReaderIterator.html">PackedInt32s.IReaderIterator</a>. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.IReaderIterator GetReaderIterator(DataInput in, int mem)</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">in</span></td> |
| <td><p>Positioned at the beginning of a stored packed int structure. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">mem</span></td> |
| <td><p>How much memory the iterator is allowed to use to read-ahead (likely to speed up iteration). </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IReaderIterator.html">PackedInt32s.IReaderIterator</a></td> |
| <td><p>An iterator to access the values. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If the structure could not be retrieved. </p> |
| </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_Util_Packed_PackedInt32s_GetReaderIteratorNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetReaderIteratorNoHeader(Lucene.Net.Store.DataInput%2CLucene.Net.Util.Packed.PackedInt32s.Format%2CSystem.Int32%2CSystem.Int32%2CSystem.Int32%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/Util/Packed/PackedInts.cs/#L1000">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderIteratorNoHeader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderIteratorNoHeader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderIteratorNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderIteratorNoHeader(Lucene.Net.Store.DataInput,Lucene.Net.Util.Packed.PackedInt32s.Format,System.Int32,System.Int32,System.Int32,System.Int32)">GetReaderIteratorNoHeader(DataInput, PackedInt32s.Format, Int32, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Expert: Restore a <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IReaderIterator.html">PackedInt32s.IReaderIterator</a> from a stream without reading |
| metadata at the beginning of the stream. This method is useful to restore |
| data from streams which have been created using |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_">GetWriterNoHeader(DataOutput, PackedInt32s.Format, Int32, Int32, Int32)</a>. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.IReaderIterator GetReaderIteratorNoHeader(DataInput in, PackedInt32s.Format format, int version, int valueCount, int bitsPerValue, int mem)</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">in</span></td> |
| <td><p>The stream to read data from, positioned at the beginning of the packed values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>The format used to serialize. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>The version used to serialize the data. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td><p>How many values the stream holds. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>the number of bits per value. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">mem</span></td> |
| <td><p>How much memory the iterator is allowed to use to read-ahead (likely to speed up iteration). </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IReaderIterator.html">PackedInt32s.IReaderIterator</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.IReaderIterator.html">PackedInt32s.IReaderIterator</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderIteratorNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_">GetWriterNoHeader(DataOutput, PackedInt32s.Format, Int32, Int32, Int32)</a></div> |
| </div> |
| <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_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetReaderNoHeader(Lucene.Net.Store.DataInput%2CLucene.Net.Util.Packed.PackedInt32s.Format%2CSystem.Int32%2CSystem.Int32%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/Util/Packed/PackedInts.cs/#L902">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderNoHeader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderNoHeader(Lucene.Net.Store.DataInput,Lucene.Net.Util.Packed.PackedInt32s.Format,System.Int32,System.Int32,System.Int32)">GetReaderNoHeader(DataInput, PackedInt32s.Format, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Expert: Restore a <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a> from a stream without reading metadata at |
| the beginning of the stream. This method is useful to restore data from |
| streams which have been created using |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_">GetWriterNoHeader(DataOutput, PackedInt32s.Format, Int32, Int32, Int32)</a>. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Reader GetReaderNoHeader(DataInput in, PackedInt32s.Format format, int version, int valueCount, int bitsPerValue)</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">in</span></td> |
| <td><p>The stream to read data from, positioned at the beginning of the packed values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>The format used to serialize. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>The version used to serialize the data. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td><p>How many values the stream holds. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits per value. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_">GetWriterNoHeader(DataOutput, PackedInt32s.Format, Int32, Int32, Int32)</a></div> |
| </div> |
| <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_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Header_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetReaderNoHeader(Lucene.Net.Store.DataInput%2CLucene.Net.Util.Packed.PackedInt32s.Header)%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/Util/Packed/PackedInts.cs/#L960">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderNoHeader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Header_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetReaderNoHeader(Lucene.Net.Store.DataInput,Lucene.Net.Util.Packed.PackedInt32s.Header)">GetReaderNoHeader(DataInput, PackedInt32s.Header)</h4> |
| <div class="markdown level1 summary"><p>Expert: Restore a <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a> from a stream without reading metadata at |
| the beginning of the stream. this method is useful to restore data when |
| metadata has been previously read using <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_">ReadHeader(DataInput)</a>. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Reader GetReaderNoHeader(DataInput in, PackedInt32s.Header header)</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">in</span></td> |
| <td><p>The stream to read data from, positioned at the beginning of the packed values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Header.html">PackedInt32s.Header</a></td> |
| <td><span class="parametername">header</span></td> |
| <td><p>Metadata result from <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_">ReadHeader(DataInput)</a>. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Header__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_">ReadHeader(DataInput)</a></div> |
| </div> |
| <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_Util_Packed_PackedInt32s_GetWriter_Lucene_Net_Store_DataOutput_System_Int32_System_Int32_System_Single_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetWriter(Lucene.Net.Store.DataOutput%2CSystem.Int32%2CSystem.Int32%2CSystem.Single)%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/Util/Packed/PackedInts.cs/#L1306">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetWriter_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetWriter*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetWriter_Lucene_Net_Store_DataOutput_System_Int32_System_Int32_System_Single_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetWriter(Lucene.Net.Store.DataOutput,System.Int32,System.Int32,System.Single)">GetWriter(DataOutput, Int32, Int32, Single)</h4> |
| <div class="markdown level1 summary"><p>Create a packed integer array writer for the given output, format, value |
| count, and number of bits per value. |
| <p> |
| The resulting stream will be long-aligned. this means that depending on |
| the format which is used under the hoods, up to 63 bits will be wasted. |
| An easy way to make sure that no space is lost is to always use a |
| <code data-dev-comment-type="paramref" class="paramref">valueCount</code> that is a multiple of 64. |
| <p> |
| This method writes metadata to the stream, so that the resulting stream is |
| sufficient to restore a <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html">PackedInt32s.Reader</a> from it. You don't need to track |
| <code data-dev-comment-type="paramref" class="paramref">valueCount</code> or <code data-dev-comment-type="paramref" class="paramref">bitsPerValue</code> by yourself. In case |
| this is a problem, you should probably look at |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_">GetWriterNoHeader(DataOutput, PackedInt32s.Format, Int32, Int32, Int32)</a>. |
| <p> |
| The <code data-dev-comment-type="paramref" class="paramref">acceptableOverheadRatio</code> parameter controls how |
| readers that will be restored from this stream trade space |
| for speed by selecting a faster but potentially less memory-efficient |
| implementation. An <code data-dev-comment-type="paramref" class="paramref">acceptableOverheadRatio</code> of |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_COMPACT">COMPACT</a> will make sure that the most memory-efficient |
| implementation is selected whereas <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_FASTEST">FASTEST</a> will make sure |
| that the fastest implementation is selected. In case you are only interested |
| in reading this stream sequentially later on, you should probably use |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_COMPACT">COMPACT</a>. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Writer GetWriter(DataOutput out, int valueCount, int bitsPerValue, float acceptableOverheadRatio)</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.DataOutput.html">DataOutput</a></td> |
| <td><span class="parametername">out</span></td> |
| <td><p>The data output. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td><p>The number of values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits per value. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Single</span></td> |
| <td><span class="parametername">acceptableOverheadRatio</span></td> |
| <td><p>An acceptable overhead ratio per value. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Writer.html">PackedInt32s.Writer</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Writer.html">PackedInt32s.Writer</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </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_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.GetWriterNoHeader(Lucene.Net.Store.DataOutput%2CLucene.Net.Util.Packed.PackedInt32s.Format%2CSystem.Int32%2CSystem.Int32%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/Util/Packed/PackedInts.cs/#L1268">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetWriterNoHeader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.GetWriterNoHeader(Lucene.Net.Store.DataOutput,Lucene.Net.Util.Packed.PackedInt32s.Format,System.Int32,System.Int32,System.Int32)">GetWriterNoHeader(DataOutput, PackedInt32s.Format, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Expert: Create a packed integer array writer for the given output, format, |
| value count, and number of bits per value. |
| <p> |
| The resulting stream will be long-aligned. this means that depending on |
| the format which is used, up to 63 bits will be wasted. An easy way to |
| make sure that no space is lost is to always use a <code data-dev-comment-type="paramref" class="paramref">valueCount</code> |
| that is a multiple of 64. |
| <p> |
| This method does not write any metadata to the stream, meaning that it is |
| your responsibility to store it somewhere else in order to be able to |
| recover data from the stream later on: |
| <ul><li><code data-dev-comment-type="paramref" class="paramref">format</code> (using <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Format.html#Lucene_Net_Util_Packed_PackedInt32s_Format_Id">Id</a>),</li><li><code data-dev-comment-type="paramref" class="paramref">valueCount</code>,</li><li><code data-dev-comment-type="paramref" class="paramref">bitsPerValue</code>,</li><li><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_VERSION_CURRENT">VERSION_CURRENT</a>.</li></ul> |
| <p> |
| It is possible to start writing values without knowing how many of them you |
| are actually going to write. To do this, just pass <code>-1</code> as |
| <code data-dev-comment-type="paramref" class="paramref">valueCount</code>. On the other hand, for any positive value of |
| <code data-dev-comment-type="paramref" class="paramref">valueCount</code>, the returned writer will make sure that you don't |
| write more values than expected and pad the end of stream with zeros in |
| case you have written less than <code data-dev-comment-type="paramref" class="paramref">valueCount</code> when calling |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Writer.html#Lucene_Net_Util_Packed_PackedInt32s_Writer_Finish">Finish()</a>. |
| <p> |
| The <code data-dev-comment-type="paramref" class="paramref">mem</code> parameter lets you control how much memory can be used |
| to buffer changes in memory before flushing to disk. High values of |
| <code data-dev-comment-type="paramref" class="paramref">mem</code> are likely to improve throughput. On the other hand, if |
| speed is not that important to you, a value of <code>0</code> will use as |
| little memory as possible and should already offer reasonable throughput. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Writer GetWriterNoHeader(DataOutput out, PackedInt32s.Format format, int valueCount, int bitsPerValue, int mem)</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.DataOutput.html">DataOutput</a></td> |
| <td><span class="parametername">out</span></td> |
| <td><p>The data output. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Format.html">PackedInt32s.Format</a></td> |
| <td><span class="parametername">format</span></td> |
| <td><p>The format to use to serialize the values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">valueCount</span></td> |
| <td><p>The number of values. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits per value. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">mem</span></td> |
| <td><p>How much memory (in bytes) can be used to speed up serialization. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Writer.html">PackedInt32s.Writer</a></td> |
| <td><p>A <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Writer.html">PackedInt32s.Writer</a>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Util_Packed_PackedInt32s_GetWriterNoHeader_Lucene_Net_Store_DataOutput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetReaderIteratorNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_System_Int32_">GetReaderIteratorNoHeader(DataInput, PackedInt32s.Format, Int32, Int32, Int32, Int32)</a></div> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Format_System_Int32_System_Int32_System_Int32_">GetReaderNoHeader(DataInput, PackedInt32s.Format, Int32, Int32, Int32)</a></div> |
| </div> |
| <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_Util_Packed_PackedInt32s_MaxValue_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.MaxValue(System.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/Util/Packed/PackedInts.cs/#L1341">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_MaxValue_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.MaxValue*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_MaxValue_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.MaxValue(System.Int32)">MaxValue(Int32)</h4> |
| <div class="markdown level1 summary"><p>Calculates the maximum unsigned long that can be expressed with the given |
| number of bits. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static long MaxValue(int bitsPerValue)</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.Int32</span></td> |
| <td><span class="parametername">bitsPerValue</span></td> |
| <td><p>The number of bits available for any given value. </p> |
| </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.Int64</span></td> |
| <td><p>The maximum value for the given bits. </p> |
| </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_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.ReadHeader(Lucene.Net.Store.DataInput)%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/Util/Packed/PackedInts.cs/#L1412">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.ReadHeader*"></a> |
| <h4 id="Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.ReadHeader(Lucene.Net.Store.DataInput)">ReadHeader(DataInput)</h4> |
| <div class="markdown level1 summary"><p>Expert: reads only the metadata from a stream. This is useful to later |
| restore a stream or open a direct reader via |
| <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Header_">GetReaderNoHeader(DataInput, PackedInt32s.Header)</a> |
| or <a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_Lucene_Net_Store_IndexInput_Lucene_Net_Util_Packed_PackedInt32s_Header_">GetDirectReaderNoHeader(IndexInput, PackedInt32s.Header)</a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static PackedInt32s.Header ReadHeader(DataInput in)</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">in</span></td> |
| <td><p>The stream to read data. </p> |
| </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><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Header.html">PackedInt32s.Header</a></td> |
| <td><p>Packed integer metadata. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Util_Packed_PackedInt32s_ReadHeader_Lucene_Net_Store_DataInput__seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetReaderNoHeader_Lucene_Net_Store_DataInput_Lucene_Net_Util_Packed_PackedInt32s_Header_">GetReaderNoHeader(DataInput, PackedInt32s.Header)</a></div> |
| <div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.html#Lucene_Net_Util_Packed_PackedInt32s_GetDirectReaderNoHeader_Lucene_Net_Store_IndexInput_Lucene_Net_Util_Packed_PackedInt32s_Header_">GetDirectReaderNoHeader(IndexInput, PackedInt32s.Header)</a></div> |
| </div> |
| </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_Util_Packed_PackedInt32s.md&value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s%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/Util/Packed/PackedInts.cs/#L43" 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> |
