blob: b5a53bbcaedda1643ae64587064a6de92daa5b34 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>Lucene.Net: Lucene.Net.Search.DocIdSetIterator Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { searchBox.OnSelectItem(0); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
<td style="padding-left: 0.5em;">
<div id="projectname">Lucene.Net
&#160;<span id="projectnumber">3.0.3</span>
</div>
<div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="Index.html"><span>Main&#160;Page</span></a></li>
<li><a href="namespaces.html"><span>Packages</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_search.html">Search</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html">DocIdSetIterator</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Search.DocIdSetIterator Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> is set to Int32.MaxValue in order to be used as a sentinel object. Implementations of this class are expected to consider int.MaxValue as an invalid value.
<a href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#details">More...</a></p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_1_1_anonymous_class_doc_id_set_1_1_anonymous_class_doc_id_set_iterator.html">Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet.AnonymousClassDocIdSetIterator</a>, Lucene.Net.Search.FieldCacheTermsFilter.FieldCacheTermsFilterDocIdSet.FieldCacheTermsFilterDocIdSetIterator, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set_iterator.html">Lucene.Net.Search.FilteredDocIdSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_scorer.html">Lucene.Net.Search.Scorer</a>, and <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_fixed_bit_set_1_1_fixed_bit_set_iterator.html">Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator</a>.</p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a617cbe6c07c261cc2cc86ad3d255152f"><td class="memItemLeft" align="right" valign="top">abstract int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a617cbe6c07c261cc2cc86ad3d255152f">DocID</a> ()</td></tr>
<tr class="memdesc:a617cbe6c07c261cc2cc86ad3d255152f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the following: </p>
<ul>
<li>
-1 or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">NextDoc()</a> or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">Advance(int)</a> were not called yet. </li>
<li>
<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if the iterator has exhausted. </li>
<li>
Otherwise it should return the doc ID it is currently on. </li>
</ul>
<a href="#a617cbe6c07c261cc2cc86ad3d255152f"></a><br/></td></tr>
<tr class="separator:a617cbe6c07c261cc2cc86ad3d255152f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70f16616e044ffd57b07dbc426c34e0d"><td class="memItemLeft" align="right" valign="top">abstract int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d">NextDoc</a> ()</td></tr>
<tr class="memdesc:a70f16616e044ffd57b07dbc426c34e0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advances to the next document in the set and returns the doc it is currently on, or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if there are no more docs in the set.<br/>
<a href="#a70f16616e044ffd57b07dbc426c34e0d"></a><br/></td></tr>
<tr class="separator:a70f16616e044ffd57b07dbc426c34e0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ea4804a0dd948a55077e1dde86b0983"><td class="memItemLeft" align="right" valign="top">abstract int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983">Advance</a> (int target)</td></tr>
<tr class="memdesc:a4ea4804a0dd948a55077e1dde86b0983"><td class="mdescLeft">&#160;</td><td class="mdescRight">Advances to the first beyond the current whose document number is greater than or equal to <em>target</em>. Returns the current document number or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if there are no more docs in the set. Behaves as if written: <a href="#a4ea4804a0dd948a55077e1dde86b0983"></a><br/></td></tr>
<tr class="separator:a4ea4804a0dd948a55077e1dde86b0983"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:ac005b14762e519ad644745031fac2ad4"><td class="memItemLeft" align="right" valign="top">static readonly int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4">NO_MORE_DOCS</a> = System.Int32.MaxValue</td></tr>
<tr class="memdesc:ac005b14762e519ad644745031fac2ad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">When returned by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">NextDoc()</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">Advance(int)</a> and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a617cbe6c07c261cc2cc86ad3d255152f" title="Returns the following: -1 or NO_MORE_DOCS if NextDoc() or Advance(int) were not called yet...">DocID()</a> it means there are no more docs in the iterator. <a href="#ac005b14762e519ad644745031fac2ad4"></a><br/></td></tr>
<tr class="separator:ac005b14762e519ad644745031fac2ad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>This abstract class defines methods to iterate over a set of non-decreasing doc ids. Note that this class assumes it iterates on doc Ids, and therefore <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> is set to Int32.MaxValue in order to be used as a sentinel object. Implementations of this class are expected to consider int.MaxValue as an invalid value. </p>
<p>Definition at line <a class="el" href="_doc_id_set_iterator_8cs_source.html#l00027">27</a> of file <a class="el" href="_doc_id_set_iterator_8cs_source.html">DocIdSetIterator.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a4ea4804a0dd948a55077e1dde86b0983"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.DocIdSetIterator.Advance </td>
<td>(</td>
<td class="paramtype">int&#160;</td>
<td class="paramname"><em>target</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Advances to the first beyond the current whose document number is greater than or equal to <em>target</em>. Returns the current document number or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if there are no more docs in the set. Behaves as if written: </p>
<p><code> int advance(int target) { int doc; while ((doc = nextDoc()) &lt; target) { } return doc; } </code></p>
<p>Some implementations are considerably more efficient than that. </p>
<p><b>NOTE:</b> certain implemenations may return a different value (each time) if called several times in a row with the same target. </p>
<p><b>NOTE:</b> this method may be called with <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> for efficiency by some Scorers. If your implementation cannot efficiently determine that it should exhaust, it is recommended that you check for that value in each call to this method. </p>
<p><b>NOTE:</b> after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior. </p>
<p>&lt;since&gt;2.9&lt;/since&gt; </p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_fixed_bit_set_1_1_fixed_bit_set_iterator.html#adbd720ef25f32465f552e6f6cb487d8d">Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_scorer2.html#a84ed363f84038762d9ebb041874b1359">Lucene.Net.Search.BooleanScorer2</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_scorer.html#a1c55b73f8540b093b44dd2ccdb78d738">Lucene.Net.Search.BooleanScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_disjunction_sum_scorer.html#aaac23d0ca7427b63ede5e71cdc77f604">Lucene.Net.Search.DisjunctionSumScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_function_query_1_1_all_scorer.html#a58e8013964d94dc28a3c28991457dfb2">Lucene.Net.Spatial.Util.FunctionQuery.AllScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#ae0542c3e46df1088c69dad8823589c69">Lucene.Net.Search.TermScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_scorer.html#ac751bb1d7232eb2557356cf9f5700416">Lucene.Net.Search.PhraseScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_req_excl_scorer.html#a1afbd07375aea642bea2a0c17c6f3bc3">Lucene.Net.Search.ReqExclScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_disjunction_max_scorer.html#a47fc3a46772bf845b217d45386d5e790">Lucene.Net.Search.DisjunctionMaxScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_conjunction_scorer.html#ac235260a8ae1b1988d7ee29070f3408e">Lucene.Net.Search.ConjunctionScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_caching_wrapping_scorer.html#a3946232af4ebdb74a13a9688c15d79ec">Lucene.Net.Search.ScoreCachingWrappingScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set_iterator.html#a8f9681b4efc472824b8ffe9a14123b8e">Lucene.Net.Search.FilteredDocIdSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_scorer.html#a37e9ac83c6550779e1c71763c7826956">Lucene.Net.Search.Spans.SpanScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_1_1_anonymous_class_doc_id_set_1_1_anonymous_class_doc_id_set_iterator.html#af8b1269dd92460c3ac7fe890845a8b96">Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet.AnonymousClassDocIdSetIterator</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_req_opt_sum_scorer.html#aa04576f7593e796bcd541fa68bd1de95">Lucene.Net.Search.ReqOptSumScorer</a>.</p>
</div>
</div>
<a class="anchor" id="a617cbe6c07c261cc2cc86ad3d255152f"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.DocIdSetIterator.DocID </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Returns the following: </p>
<ul>
<li>
-1 or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">NextDoc()</a> or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">Advance(int)</a> were not called yet. </li>
<li>
<a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if the iterator has exhausted. </li>
<li>
Otherwise it should return the doc ID it is currently on. </li>
</ul>
</p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_fixed_bit_set_1_1_fixed_bit_set_iterator.html#a4bcbcfd2919f226ffb8e99fd0f6d2251">Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_scorer2.html#a4fc19513e51818c2ff15c4847380d9ff">Lucene.Net.Search.BooleanScorer2</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_scorer.html#aaeb61d4ab8fd067e9f141481e4f73a0d">Lucene.Net.Search.BooleanScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_disjunction_sum_scorer.html#a3d8447270d587fc0390d8b35a2e2d04a">Lucene.Net.Search.DisjunctionSumScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_function_query_1_1_all_scorer.html#a9fd51469a42e6bbb262268728b5c9d91">Lucene.Net.Spatial.Util.FunctionQuery.AllScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_conjunction_scorer.html#a98fd8d41141bd82f994dc0848057e388">Lucene.Net.Search.ConjunctionScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_req_excl_scorer.html#a82fb8cd1e4cd44a724e42e3deca922e4">Lucene.Net.Search.ReqExclScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_scorer.html#aa781fdc809539f2006392f7db9f3f075">Lucene.Net.Search.Spans.SpanScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#ab146caf07576a7c367ef21eee4fa9ca0">Lucene.Net.Search.TermScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_disjunction_max_scorer.html#ab09ae689d6828e16ee63a9349e42a997">Lucene.Net.Search.DisjunctionMaxScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_scorer.html#ac82ad28ce2f29124d2a501f5aabfd549">Lucene.Net.Search.PhraseScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_caching_wrapping_scorer.html#ad1c095e5fe822cf5c6e8cd950db9233b">Lucene.Net.Search.ScoreCachingWrappingScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_1_1_anonymous_class_doc_id_set_1_1_anonymous_class_doc_id_set_iterator.html#a7a18b51b4649d0451f05aa9546c6ae50">Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet.AnonymousClassDocIdSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_req_opt_sum_scorer.html#a704e93dda487dc309e655e01f11c13fc">Lucene.Net.Search.ReqOptSumScorer</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set_iterator.html#a04609e43be03a63b74f60b5a58850c78">Lucene.Net.Search.FilteredDocIdSetIterator</a>.</p>
</div>
</div>
<a class="anchor" id="a70f16616e044ffd57b07dbc426c34e0d"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract int Lucene.Net.Search.DocIdSetIterator.NextDoc </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">pure virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Advances to the next document in the set and returns the doc it is currently on, or <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#ac005b14762e519ad644745031fac2ad4" title="When returned by NextDoc(), Advance(int) and DocID() it means there are no more docs in the iterator...">NO_MORE_DOCS</a> if there are no more docs in the set.<br/>
</p>
<p><b>NOTE:</b> after the iterator has exhausted you should not call this method, as it may result in unpredicted behavior.</p>
<p>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_fixed_bit_set_1_1_fixed_bit_set_iterator.html#a9283b823c7506fa9c3a6925856764b07">Lucene.Net.Spatial.Util.FixedBitSet.FixedBitSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_scorer2.html#aeb54005e33c1212dc8427e23443116ac">Lucene.Net.Search.BooleanScorer2</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_boolean_scorer.html#a37d9282d674292cada3a29324c6d9774">Lucene.Net.Search.BooleanScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_disjunction_sum_scorer.html#a872f5978fbc2f60c2943b29724b4023f">Lucene.Net.Search.DisjunctionSumScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_spatial_1_1_util_1_1_function_query_1_1_all_scorer.html#a3ce605e76220bb8c5c3a68f3506c2960">Lucene.Net.Spatial.Util.FunctionQuery.AllScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_conjunction_scorer.html#acbdae9b18487c8b844cf865a2a4c74f9">Lucene.Net.Search.ConjunctionScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_term_scorer.html#a976267c1d4641b5e0052de0b01540b1f">Lucene.Net.Search.TermScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_phrase_scorer.html#a70fbe821f002325072a615864f9907fb">Lucene.Net.Search.PhraseScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_score_caching_wrapping_scorer.html#a3c5f4e0b3364a4dff94d412d66a12eb2">Lucene.Net.Search.ScoreCachingWrappingScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_disjunction_max_scorer.html#a2dd7cf3195412469dd84f590e93aba6f">Lucene.Net.Search.DisjunctionMaxScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_1_1_anonymous_class_doc_id_set_1_1_anonymous_class_doc_id_set_iterator.html#a0bb712bf18fd55acfba89fd8acd421b9">Lucene.Net.Search.DocIdSet.AnonymousClassDocIdSet.AnonymousClassDocIdSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_filtered_doc_id_set_iterator.html#af93ae60b71e883c271e0fb8a186a81a7">Lucene.Net.Search.FilteredDocIdSetIterator</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_spans_1_1_span_scorer.html#aa363bb7a35480c0eeade97adbbf52d65">Lucene.Net.Search.Spans.SpanScorer</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_req_excl_scorer.html#affa16c81affa9665e6b73e4d7a413ec8">Lucene.Net.Search.ReqExclScorer</a>, and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_req_opt_sum_scorer.html#aaf279581c7ea69aeaa29f5414c629793">Lucene.Net.Search.ReqOptSumScorer</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac005b14762e519ad644745031fac2ad4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">readonly int Lucene.Net.Search.DocIdSetIterator.NO_MORE_DOCS = System.Int32.MaxValue</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>When returned by <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a70f16616e044ffd57b07dbc426c34e0d" title="Advances to the next document in the set and returns the doc it is currently on, or NO_MORE_DOCS if t...">NextDoc()</a>, <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a4ea4804a0dd948a55077e1dde86b0983" title="Advances to the first beyond the current whose document number is greater than or equal to target...">Advance(int)</a> and <a class="el" href="class_lucene_1_1_net_1_1_search_1_1_doc_id_set_iterator.html#a617cbe6c07c261cc2cc86ad3d255152f" title="Returns the following: -1 or NO_MORE_DOCS if NextDoc() or Advance(int) were not called yet...">DocID()</a> it means there are no more docs in the iterator. </p>
<p>Definition at line <a class="el" href="_doc_id_set_iterator_8cs_source.html#l00034">34</a> of file <a class="el" href="_doc_id_set_iterator_8cs_source.html">DocIdSetIterator.cs</a>.</p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>core/Search/<a class="el" href="_doc_id_set_iterator_8cs_source.html">DocIdSetIterator.cs</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jan 3 2013 02:12:56 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3
</small></address>
</body>
</html>