| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class DocIdSet |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class DocIdSet |
| | 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.Search.DocIdSet"> |
| |
| |
| <h1 id="Lucene_Net_Search_DocIdSet" data-uid="Lucene.Net.Search.DocIdSet" class="text-break">Class DocIdSet |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a> contains a set of doc ids. Implementing classes must |
| only implement <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> to provide access to the set.</p> |
| </div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">DocIdSet</span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.FieldCacheDocIdSet.html">FieldCacheDocIdSet</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.FilteredDocIdSet.html">FilteredDocIdSet</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.DocIdBitSet.html">DocIdBitSet</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.FixedBitSet.html">FixedBitSet</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.OpenBitSet.html">OpenBitSet</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.Packed.EliasFanoDocIdSet.html">EliasFanoDocIdSet</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.PForDeltaDocIdSet.html">PForDeltaDocIdSet</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Util.WAH8DocIdSet.html">WAH8DocIdSet</a></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.Search.html">Lucene.Net.Search</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Search_DocIdSet_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract class DocIdSet</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_DocIdSet_Bits.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet.Bits%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/Search/DocIdSet.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_DocIdSet_Bits_" data-uid="Lucene.Net.Search.DocIdSet.Bits*"></a> |
| <h4 id="Lucene_Net_Search_DocIdSet_Bits" data-uid="Lucene.Net.Search.DocIdSet.Bits">Bits</h4> |
| <div class="markdown level1 summary"><p>Optionally provides a <a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a> interface for random access |
| to matching documents. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual IBits Bits { 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><a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a></td> |
| <td><p><code>null</code>, if this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a> does not support random access. |
| In contrast to <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a>, a return value of <code>null</code> |
| <strong>does not</strong> imply that no documents match the filter! |
| The default implementation does not provide random access, so you |
| only need to implement this method if your <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a> can |
| guarantee random access to every docid in O(1) time without |
| external disk access (as <a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a> interface cannot throw |
| <span class="xref">System.IO.IOException</span>). This is generally true for bit sets |
| like <a class="xref" href="Lucene.Net.Util.FixedBitSet.html">FixedBitSet</a>, which return |
| itself if they are used as <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</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_Search_DocIdSet_IsCacheable.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet.IsCacheable%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/Search/DocIdSet.cs/#L67">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_DocIdSet_IsCacheable_" data-uid="Lucene.Net.Search.DocIdSet.IsCacheable*"></a> |
| <h4 id="Lucene_Net_Search_DocIdSet_IsCacheable" data-uid="Lucene.Net.Search.DocIdSet.IsCacheable">IsCacheable</h4> |
| <div class="markdown level1 summary"><p>This method is a hint for <a class="xref" href="Lucene.Net.Search.CachingWrapperFilter.html">CachingWrapperFilter</a>, if this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a> |
| should be cached without copying it. The default is to return |
| <code>false</code>. If you have an own <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a> implementation |
| that does its iteration very effective and fast without doing disk I/O, |
| override this property and return <code>true</code>.</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 IsCacheable { 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> |
| <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_Search_DocIdSet_GetIterator.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet.GetIterator%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/Search/DocIdSet.cs/#L36">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_DocIdSet_GetIterator_" data-uid="Lucene.Net.Search.DocIdSet.GetIterator*"></a> |
| <h4 id="Lucene_Net_Search_DocIdSet_GetIterator" data-uid="Lucene.Net.Search.DocIdSet.GetIterator">GetIterator()</h4> |
| <div class="markdown level1 summary"><p>Provides a <a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a> to access the set. |
| This implementation can return <code>null</code> if there |
| are no docs that match.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public abstract DocIdSetIterator GetIterator()</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.Search.DocIdSetIterator.html">DocIdSetIterator</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_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func%7BLucene.Net.Search.DocIdSetIterator%7D)%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/Search/DocIdSet.cs/#L89">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_DocIdSet_NewAnonymous_" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous*"></a> |
| <h4 id="Lucene_Net_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func{Lucene.Net.Search.DocIdSetIterator})">NewAnonymous(Func<DocIdSetIterator>)</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance with the ability to specify the body of the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method through the <code data-dev-comment-type="paramref" class="paramref">getIterator</code> parameter. |
| Simple example:</p> |
| <pre><code> var docIdSet = DocIdSet.NewAnonymous(getIterator: () => |
| { |
| OpenBitSet bitset = new OpenBitSet(5); |
| bitset.Set(0, 5); |
| return new DocIdBitSet(bitset); |
| });</code></pre> |
| <p><p> |
| LUCENENET specific</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static DocIdSet NewAnonymous(Func<DocIdSetIterator> getIterator)</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.Func</span><<a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a>></td> |
| <td><span class="parametername">getIterator</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method. It returns the <a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a> for this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</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.Search.DocIdSet.html">DocIdSet</a></td> |
| <td><p>A new <span class="xref">Lucene.Net.Search.DocIdSet.AnonymousDocIdSet</span> instance. </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_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__System_Func_Lucene_Net_Util_IBits__.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func%7BLucene.Net.Search.DocIdSetIterator%7D%2CSystem.Func%7BLucene.Net.Util.IBits%7D)%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/Search/DocIdSet.cs/#L122">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_DocIdSet_NewAnonymous_" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous*"></a> |
| <h4 id="Lucene_Net_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__System_Func_Lucene_Net_Util_IBits__" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func{Lucene.Net.Search.DocIdSetIterator},System.Func{Lucene.Net.Util.IBits})">NewAnonymous(Func<DocIdSetIterator>, Func<IBits>)</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance with the ability to specify the body of the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method through the <code data-dev-comment-type="paramref" class="paramref">getIterator</code> parameter and the body of the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_Bits">Bits</a> |
| property through the <code data-dev-comment-type="paramref" class="paramref">bits</code> parameter. |
| Simple example:</p> |
| <pre><code> var docIdSet = DocIdSet.NewAnonymous(getIterator: () => |
| { |
| OpenBitSet bitset = new OpenBitSet(5); |
| bitset.Set(0, 5); |
| return new DocIdBitSet(bitset); |
| }, bits: () => |
| { |
| return bits; |
| });</code></pre> |
| <p><p> |
| LUCENENET specific</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static DocIdSet NewAnonymous(Func<DocIdSetIterator> getIterator, Func<IBits> bits)</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.Func</span><<a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a>></td> |
| <td><span class="parametername">getIterator</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method. It returns the <a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a> for this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Func</span><<a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a>></td> |
| <td><span class="parametername">bits</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_Bits">Bits</a> |
| property. It returns the <a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a> instance for this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</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.Search.DocIdSet.html">DocIdSet</a></td> |
| <td><p>A new <span class="xref">Lucene.Net.Search.DocIdSet.AnonymousDocIdSet</span> instance. </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_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__System_Func_Lucene_Net_Util_IBits__System_Func_System_Boolean__.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func%7BLucene.Net.Search.DocIdSetIterator%7D%2CSystem.Func%7BLucene.Net.Util.IBits%7D%2CSystem.Func%7BSystem.Boolean%7D)%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/Search/DocIdSet.cs/#L195">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_DocIdSet_NewAnonymous_" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous*"></a> |
| <h4 id="Lucene_Net_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__System_Func_Lucene_Net_Util_IBits__System_Func_System_Boolean__" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func{Lucene.Net.Search.DocIdSetIterator},System.Func{Lucene.Net.Util.IBits},System.Func{System.Boolean})">NewAnonymous(Func<DocIdSetIterator>, Func<IBits>, Func<Boolean>)</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance with the ability to specify the body of the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method through the <code data-dev-comment-type="paramref" class="paramref">getIterator</code> parameter and the body of the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_Bits">Bits</a> |
| property through the <code data-dev-comment-type="paramref" class="paramref">bits</code> parameter. |
| Simple example:</p> |
| <pre><code> var docIdSet = DocIdSet.NewAnonymous(getIterator: () => |
| { |
| OpenBitSet bitset = new OpenBitSet(5); |
| bitset.Set(0, 5); |
| return new DocIdBitSet(bitset); |
| }, bits: () => |
| { |
| return bits; |
| }, isCacheable: () => |
| { |
| return true; |
| });</code></pre> |
| <p><p> |
| LUCENENET specific</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static DocIdSet NewAnonymous(Func<DocIdSetIterator> getIterator, Func<IBits> bits, Func<bool> isCacheable)</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.Func</span><<a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a>></td> |
| <td><span class="parametername">getIterator</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method. It returns the <a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a> for this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Func</span><<a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a>></td> |
| <td><span class="parametername">bits</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_Bits">Bits</a> |
| property. It returns the <a class="xref" href="Lucene.Net.Util.IBits.html">IBits</a> instance for this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Func</span><<span class="xref">System.Boolean</span>></td> |
| <td><span class="parametername">isCacheable</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_IsCacheable">IsCacheable</a> |
| property. It returns a <span class="xref">System.Boolean</span> 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.Search.DocIdSet.html">DocIdSet</a></td> |
| <td><p>A new <span class="xref">Lucene.Net.Search.DocIdSet.AnonymousDocIdSet</span> instance. </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_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__System_Func_System_Boolean__.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func%7BLucene.Net.Search.DocIdSetIterator%7D%2CSystem.Func%7BSystem.Boolean%7D)%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/Search/DocIdSet.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_DocIdSet_NewAnonymous_" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous*"></a> |
| <h4 id="Lucene_Net_Search_DocIdSet_NewAnonymous_System_Func_Lucene_Net_Search_DocIdSetIterator__System_Func_System_Boolean__" data-uid="Lucene.Net.Search.DocIdSet.NewAnonymous(System.Func{Lucene.Net.Search.DocIdSetIterator},System.Func{System.Boolean})">NewAnonymous(Func<DocIdSetIterator>, Func<Boolean>)</h4> |
| <div class="markdown level1 summary"><p>Creates a new instance with the ability to specify the body of the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method through the <code data-dev-comment-type="paramref" class="paramref">getIterator</code> parameter and the body of the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_IsCacheable">IsCacheable</a> |
| property through the <code data-dev-comment-type="paramref" class="paramref">isCacheable</code> parameter. |
| Simple example:</p> |
| <pre><code> var docIdSet = DocIdSet.NewAnonymous(getIterator: () => |
| { |
| OpenBitSet bitset = new OpenBitSet(5); |
| bitset.Set(0, 5); |
| return new DocIdBitSet(bitset); |
| }, isCacheable: () => |
| { |
| return true; |
| });</code></pre> |
| <p><p> |
| LUCENENET specific</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static DocIdSet NewAnonymous(Func<DocIdSetIterator> getIterator, Func<bool> isCacheable)</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.Func</span><<a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a>></td> |
| <td><span class="parametername">getIterator</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_GetIterator">GetIterator()</a> |
| method. It returns the <a class="xref" href="Lucene.Net.Search.DocIdSetIterator.html">DocIdSetIterator</a> for this <a class="xref" href="Lucene.Net.Search.DocIdSet.html">DocIdSet</a>.</p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Func</span><<span class="xref">System.Boolean</span>></td> |
| <td><span class="parametername">isCacheable</span></td> |
| <td><p>A delegate method that represents (is called by) the <a class="xref" href="Lucene.Net.Search.DocIdSet.html#Lucene_Net_Search_DocIdSet_IsCacheable">IsCacheable</a> |
| property. It returns a <span class="xref">System.Boolean</span> 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.Search.DocIdSet.html">DocIdSet</a></td> |
| <td><p>A new <span class="xref">Lucene.Net.Search.DocIdSet.AnonymousDocIdSet</span> instance. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_DocIdSet.md&value=---%0Auid%3A%20Lucene.Net.Search.DocIdSet%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/Search/DocIdSet.cs/#L29" 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> |
