blob: 2ba039364476d71bc52ad63a8decba4b47bd1d82 [file] [log] [blame]
<!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.Reader
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PackedInt32s.Reader
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.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">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<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.Reader">
<h1 id="Lucene_Net_Util_Packed_PackedInt32s_Reader" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader" class="text-break">Class PackedInt32s.Reader
</h1>
<div class="markdown level0 summary"><p>A read-only random access array of positive integers.
<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"><a class="xref" href="Lucene.Net.Index.NumericDocValues.html">NumericDocValues</a></div>
<div class="level2"><span class="xref">PackedInt32s.Reader</span></div>
<div class="level3"><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Mutable.html">PackedInt32s.Mutable</a></div>
<div class="level3"><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.NullReader.html">PackedInt32s.NullReader</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Lucene.Net.Index.NumericDocValues.html#Lucene_Net_Index_NumericDocValues_Get_System_Int32_">NumericDocValues.Get(Int32)</a>
</div>
<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_Reader_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class Reader : NumericDocValues</code></pre>
</div>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_PackedInt32s_Reader_BitsPerValue.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Reader.BitsPerValue%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/fix/apidocs-layout/src/Lucene.Net/Util/Packed/PackedInts.cs/#L560">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_PackedInt32s_Reader_BitsPerValue_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.BitsPerValue*"></a>
<h4 id="Lucene_Net_Util_Packed_PackedInt32s_Reader_BitsPerValue" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.BitsPerValue">BitsPerValue</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 abstract int BitsPerValue { get; }</code></pre>
</div>
<h5 class="propertyValue">Property 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><p>The number of bits used to store any given value.
Note: this does not imply that memory usage is
<code>bitsPerValue * #values</code> as implementations are free to
use non-space-optimal packing of 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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_PackedInt32s_Reader_Count.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Reader.Count%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/fix/apidocs-layout/src/Lucene.Net/Util/Packed/PackedInts.cs/#L567">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_PackedInt32s_Reader_Count_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.Count*"></a>
<h4 id="Lucene_Net_Util_Packed_PackedInt32s_Reader_Count" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.Count">Count</h4>
<div class="markdown level1 summary"><p>The number of values.
<p>
NOTE: This was size() in Lucene.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract int Count { get; }</code></pre>
</div>
<h5 class="propertyValue">Property 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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_PackedInt32s_Reader_HasArray.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Reader.HasArray%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/fix/apidocs-layout/src/Lucene.Net/Util/Packed/PackedInts.cs/#L594">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_PackedInt32s_Reader_HasArray_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.HasArray*"></a>
<h4 id="Lucene_Net_Util_Packed_PackedInt32s_Reader_HasArray" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.HasArray">HasArray</h4>
<div class="markdown level1 summary"><p>Returns <code>true</code> if this implementation is backed by a
native .NET array.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual bool HasArray { get; }</code></pre>
</div>
<h5 class="propertyValue">Property 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.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Util_Packed_PackedInt32s_Reader_HasArray_seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Util.Packed.PackedInt32s.Reader.html#Lucene_Net_Util_Packed_PackedInt32s_Reader_GetArray">GetArray()</a></div>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_PackedInt32s_Reader_Get_System_Int32_System_Int64___System_Int32_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Reader.Get(System.Int32%2CSystem.Int64%5B%5D%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/fix/apidocs-layout/src/Lucene.Net/Util/Packed/PackedInts.cs/#L539">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_PackedInt32s_Reader_Get_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.Get*"></a>
<h4 id="Lucene_Net_Util_Packed_PackedInt32s_Reader_Get_System_Int32_System_Int64___System_Int32_System_Int32_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.Get(System.Int32,System.Int64[],System.Int32,System.Int32)">Get(Int32, Int64[], Int32, Int32)</h4>
<div class="markdown level1 summary"><p>Bulk get: read at least one and at most <code data-dev-comment-type="paramref" class="paramref">len</code> longs starting
from <code data-dev-comment-type="paramref" class="paramref">index</code> into <code>arr[off:off+len]</code> and return
the actual number of values that have been read.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual int Get(int index, long[] arr, int off, int len)</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">index</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span>[]</td>
<td><span class="parametername">arr</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">off</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">len</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_PackedInt32s_Reader_GetArray.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Reader.GetArray%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/fix/apidocs-layout/src/Lucene.Net/Util/Packed/PackedInts.cs/#L583">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_PackedInt32s_Reader_GetArray_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.GetArray*"></a>
<h4 id="Lucene_Net_Util_Packed_PackedInt32s_Reader_GetArray" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.GetArray">GetArray()</h4>
<div class="markdown level1 summary"><p>Expert: if the bit-width of this reader matches one of
.NET&apos;s native types, returns the underlying array
(ie, byte[], short[], int[], long[]); else, returns
<code>null</code>. Note that when accessing the array you must
upgrade the type (bitwise AND with all ones), to
interpret the full value as unsigned. Ie,
bytes[idx]&amp;0xFF, shorts[idx]&amp;0xFFFF, etc.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual object GetArray()</code></pre>
</div>
<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.Object</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_PackedInt32s_Reader_RamBytesUsed.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Reader.RamBytesUsed%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/fix/apidocs-layout/src/Lucene.Net/Util/Packed/PackedInts.cs/#L572">View Source</a>
</span>
<a id="Lucene_Net_Util_Packed_PackedInt32s_Reader_RamBytesUsed_" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.RamBytesUsed*"></a>
<h4 id="Lucene_Net_Util_Packed_PackedInt32s_Reader_RamBytesUsed" data-uid="Lucene.Net.Util.Packed.PackedInt32s.Reader.RamBytesUsed">RamBytesUsed()</h4>
<div class="markdown level1 summary"><p>Return the in-memory size in bytes.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract long RamBytesUsed()</code></pre>
</div>
<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></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Packed_PackedInt32s_Reader.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Packed.PackedInt32s.Reader%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/fix/apidocs-layout/src/Lucene.Net/Util/Packed/PackedInts.cs/#L532" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</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>