blob: de1e265631d81fb22d25b76abf4a6d2f65d5ebb5 [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 PostingsReaderBase
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class PostingsReaderBase
| 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.Codecs.PostingsReaderBase">
<h1 id="Lucene_Net_Codecs_PostingsReaderBase" data-uid="Lucene.Net.Codecs.PostingsReaderBase" class="text-break">Class PostingsReaderBase
</h1>
<div class="markdown level0 summary"><p>The core terms dictionaries (BlockTermsReader,
<a class="xref" href="Lucene.Net.Codecs.BlockTreeTermsReader.html">BlockTreeTermsReader</a>) interact with a single instance
of this class to manage creation of <a class="xref" href="Lucene.Net.Index.DocsEnum.html">DocsEnum</a> and
<a class="xref" href="Lucene.Net.Index.DocsAndPositionsEnum.html">DocsAndPositionsEnum</a> instances. It provides an
<a class="xref" href="Lucene.Net.Store.IndexInput.html">IndexInput</a> (termsIn) where this class may read any
previously stored data that it had written in its
corresponding <a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html">PostingsWriterBase</a> at indexing
time.
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL 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">PostingsReaderBase</span></div>
<div class="level2"><a class="xref" href="Lucene.Net.Codecs.Lucene40.Lucene40PostingsReader.html">Lucene40PostingsReader</a></div>
<div class="level2"><a class="xref" href="Lucene.Net.Codecs.Lucene41.Lucene41PostingsReader.html">Lucene41PostingsReader</a></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Codecs.html">Lucene.Net.Codecs</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Codecs_PostingsReaderBase_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class PostingsReaderBase : IDisposable</code></pre>
</div>
<h3 id="constructors">Constructors
</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_Codecs_PostingsReaderBase__ctor.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.%23ctor%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/Codecs/PostingsReaderBase.cs/#L52">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase__ctor_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.#ctor*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase__ctor" data-uid="Lucene.Net.Codecs.PostingsReaderBase.#ctor">PostingsReaderBase()</h4>
<div class="markdown level1 summary"><p>Sole constructor. (For invocation by subclass
constructors, typically implicit.)</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected PostingsReaderBase()</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_PostingsReaderBase_CheckIntegrity.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.CheckIntegrity%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/Codecs/PostingsReaderBase.cs/#L96">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_CheckIntegrity_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.CheckIntegrity*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_CheckIntegrity" data-uid="Lucene.Net.Codecs.PostingsReaderBase.CheckIntegrity">CheckIntegrity()</h4>
<div class="markdown level1 summary"><p>Checks consistency of this reader.
<p>
Note that this may be costly in terms of I/O, e.g.
may involve computing a checksum value against large data files.
<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 abstract void CheckIntegrity()</code></pre>
</div>
<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_Codecs_PostingsReaderBase_DecodeTerm_System_Int64___Lucene_Net_Store_DataInput_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.DecodeTerm(System.Int64%5B%5D%2CLucene.Net.Store.DataInput%2CLucene.Net.Index.FieldInfo%2CLucene.Net.Codecs.BlockTermState%2CSystem.Boolean)%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/Codecs/PostingsReaderBase.cs/#L70">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_DecodeTerm_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.DecodeTerm*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_DecodeTerm_System_Int64___Lucene_Net_Store_DataInput_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_System_Boolean_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.DecodeTerm(System.Int64[],Lucene.Net.Store.DataInput,Lucene.Net.Index.FieldInfo,Lucene.Net.Codecs.BlockTermState,System.Boolean)">DecodeTerm(Int64[], DataInput, FieldInfo, BlockTermState, Boolean)</h4>
<div class="markdown level1 summary"><p>Actually decode metadata for next term. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract void DecodeTerm(long[] longs, DataInput in, FieldInfo fieldInfo, BlockTermState state, bool absolute)</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">longs</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Store.DataInput.html">DataInput</a></td>
<td><span class="parametername">in</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Index.FieldInfo.html">FieldInfo</a></td>
<td><span class="parametername">fieldInfo</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</a></td>
<td><span class="parametername">state</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">absolute</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 id="Lucene_Net_Codecs_PostingsReaderBase_DecodeTerm_System_Int64___Lucene_Net_Store_DataInput_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_System_Boolean__seealso">See Also</h5>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Codecs.PostingsWriterBase.html#Lucene_Net_Codecs_PostingsWriterBase_EncodeTerm_System_Int64___Lucene_Net_Store_DataOutput_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_System_Boolean_">EncodeTerm</a>(<span class="xref">System.Int64</span>[], <a class="xref" href="Lucene.Net.Store.DataOutput.html">DataOutput</a>, <a class="xref" href="Lucene.Net.Index.FieldInfo.html">FieldInfo</a>, <a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</a>, <span class="xref">System.Boolean</span>)</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_PostingsReaderBase_Dispose.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.Dispose%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/Codecs/PostingsReaderBase.cs/#L101">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_Dispose_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Dispose*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_Dispose" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Disposes all resources used by this object.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<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_Codecs_PostingsReaderBase_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.Dispose(System.Boolean)%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/Codecs/PostingsReaderBase.cs/#L110">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_Dispose_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Dispose*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_Dispose_System_Boolean_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Dispose(System.Boolean)">Dispose(Boolean)</h4>
<div class="markdown level1 summary"><p>Implementations must override and should dispose all resources used by this instance.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected abstract void Dispose(bool disposing)</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.Boolean</span></td>
<td><span class="parametername">disposing</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_Codecs_PostingsReaderBase_Docs_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_Lucene_Net_Index_DocsFlags_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.Docs(Lucene.Net.Index.FieldInfo%2CLucene.Net.Codecs.BlockTermState%2CLucene.Net.Util.IBits%2CLucene.Net.Index.DocsEnum%2CLucene.Net.Index.DocsFlags)%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/Codecs/PostingsReaderBase.cs/#L76">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_Docs_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Docs*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_Docs_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_Lucene_Net_Index_DocsFlags_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Docs(Lucene.Net.Index.FieldInfo,Lucene.Net.Codecs.BlockTermState,Lucene.Net.Util.IBits,Lucene.Net.Index.DocsEnum,Lucene.Net.Index.DocsFlags)">Docs(FieldInfo, BlockTermState, IBits, DocsEnum, DocsFlags)</h4>
<div class="markdown level1 summary"><p>Must fully consume state, since after this call that
<a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> may be reused.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract DocsEnum Docs(FieldInfo fieldInfo, BlockTermState state, IBits skipDocs, DocsEnum reuse, DocsFlags flags)</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.Index.FieldInfo.html">FieldInfo</a></td>
<td><span class="parametername">fieldInfo</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</a></td>
<td><span class="parametername">state</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a></td>
<td><span class="parametername">skipDocs</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Index.DocsEnum.html">DocsEnum</a></td>
<td><span class="parametername">reuse</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Index.DocsFlags.html">DocsFlags</a></td>
<td><span class="parametername">flags</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.Index.DocsEnum.html">DocsEnum</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_PostingsReaderBase_DocsAndPositions_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_Lucene_Net_Index_DocsAndPositionsFlags_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.DocsAndPositions(Lucene.Net.Index.FieldInfo%2CLucene.Net.Codecs.BlockTermState%2CLucene.Net.Util.IBits%2CLucene.Net.Index.DocsAndPositionsEnum%2CLucene.Net.Index.DocsAndPositionsFlags)%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/Codecs/PostingsReaderBase.cs/#L82">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_DocsAndPositions_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.DocsAndPositions*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_DocsAndPositions_Lucene_Net_Index_FieldInfo_Lucene_Net_Codecs_BlockTermState_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_Lucene_Net_Index_DocsAndPositionsFlags_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.DocsAndPositions(Lucene.Net.Index.FieldInfo,Lucene.Net.Codecs.BlockTermState,Lucene.Net.Util.IBits,Lucene.Net.Index.DocsAndPositionsEnum,Lucene.Net.Index.DocsAndPositionsFlags)">DocsAndPositions(FieldInfo, BlockTermState, IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)</h4>
<div class="markdown level1 summary"><p>Must fully consume state, since after this call that
<a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a> may be reused.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract DocsAndPositionsEnum DocsAndPositions(FieldInfo fieldInfo, BlockTermState state, IBits skipDocs, DocsAndPositionsEnum reuse, DocsAndPositionsFlags flags)</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.Index.FieldInfo.html">FieldInfo</a></td>
<td><span class="parametername">fieldInfo</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</a></td>
<td><span class="parametername">state</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a></td>
<td><span class="parametername">skipDocs</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Index.DocsAndPositionsEnum.html">DocsAndPositionsEnum</a></td>
<td><span class="parametername">reuse</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Index.DocsAndPositionsFlags.html">DocsAndPositionsFlags</a></td>
<td><span class="parametername">flags</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.Index.DocsAndPositionsEnum.html">DocsAndPositionsEnum</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_PostingsReaderBase_Init_Lucene_Net_Store_IndexInput_.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.Init(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/fix/apidocs-layout/src/Lucene.Net/Codecs/PostingsReaderBase.cs/#L61">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_Init_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Init*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_Init_Lucene_Net_Store_IndexInput_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.Init(Lucene.Net.Store.IndexInput)">Init(IndexInput)</h4>
<div class="markdown level1 summary"><p>Performs any initialization, such as reading and
verifying the header from the provided terms
dictionary <a class="xref" href="Lucene.Net.Store.IndexInput.html">IndexInput</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract void Init(IndexInput termsIn)</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">termsIn</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_Codecs_PostingsReaderBase_NewTermState.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.NewTermState%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/Codecs/PostingsReaderBase.cs/#L65">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_NewTermState_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.NewTermState*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_NewTermState" data-uid="Lucene.Net.Codecs.PostingsReaderBase.NewTermState">NewTermState()</h4>
<div class="markdown level1 summary"><p>Return a newly created empty <a class="xref" href="Lucene.Net.Index.TermState.html">TermState</a>. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract BlockTermState NewTermState()</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><a class="xref" href="Lucene.Net.Codecs.BlockTermState.html">BlockTermState</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_PostingsReaderBase_RamBytesUsed.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase.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/Codecs/PostingsReaderBase.cs/#L86">View Source</a>
</span>
<a id="Lucene_Net_Codecs_PostingsReaderBase_RamBytesUsed_" data-uid="Lucene.Net.Codecs.PostingsReaderBase.RamBytesUsed*"></a>
<h4 id="Lucene_Net_Codecs_PostingsReaderBase_RamBytesUsed" data-uid="Lucene.Net.Codecs.PostingsReaderBase.RamBytesUsed">RamBytesUsed()</h4>
<div class="markdown level1 summary"><p>Returns approximate RAM bytes used. </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>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Codecs_PostingsReaderBase.md&amp;value=---%0Auid%3A%20Lucene.Net.Codecs.PostingsReaderBase%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/Codecs/PostingsReaderBase.cs/#L46" 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>