| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class PriorityQueue<T> |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class PriorityQueue<T> |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation "> |
| <meta name="generator" content="docfx 2.56.0.0"> |
| |
| <link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css"> |
| <link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css"> |
| <meta property="docfx:navrel" content="toc.html"> |
| <meta property="docfx:tocrel" content="core/toc.html"> |
| |
| <meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/"> |
| |
| </head> |
| <body data-spy="scroll" data-target="#affix" data-offset="120"> |
| <div id="wrapper"> |
| <header> |
| |
| <nav id="autocollapse" class="navbar ng-scope" role="navigation"> |
| <div class="container"> |
| <div class="navbar-header"> |
| <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar"> |
| <span class="sr-only">Toggle navigation</span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| <span class="icon-bar"></span> |
| </button> |
| |
| <a class="navbar-brand" href="/"> |
| <img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt=""> |
| </a> |
| </div> |
| <div class="collapse navbar-collapse" id="navbar"> |
| <form class="navbar-form navbar-right" role="search" id="search"> |
| <div class="form-group"> |
| <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off"> |
| </div> |
| </form> |
| </div> |
| </div> |
| </nav> |
| |
| <div class="subnav navbar navbar-default"> |
| <div class="container hide-when-search"> |
| <ul class="level0 breadcrumb"> |
| <li> |
| <a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a> |
| <span id="breadcrumb"> |
| <ul class="breadcrumb"> |
| <li></li> |
| </ul> |
| </span> |
| </li> |
| </ul> |
| </div> |
| </div> |
| </header> |
| <div class="container body-content"> |
| |
| <div id="search-results"> |
| <div class="search-list"></div> |
| <div class="sr-items"> |
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p> |
| </div> |
| <ul id="pagination"></ul> |
| </div> |
| </div> |
| <div role="main" class="container body-content hide-when-search"> |
| |
| <div class="sidenav hide-when-search"> |
| <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a> |
| <div class="sidetoggle collapse" id="sidetoggle"> |
| <div id="sidetoc"></div> |
| </div> |
| </div> |
| <div class="article row grid-right"> |
| <div class="col-md-10"> |
| <article class="content wrap" id="_content" data-uid="Lucene.Net.Util.PriorityQueue`1"> |
| |
| |
| <h1 id="Lucene_Net_Util_PriorityQueue_1" data-uid="Lucene.Net.Util.PriorityQueue`1" class="text-break">Class PriorityQueue<T> |
| </h1> |
| <div class="markdown level0 summary"><p>A <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html">PriorityQueue<T></a> maintains a partial ordering of its elements such that the |
| element with least priority can always be found in constant time. Put()'s and Pop()'s |
| require log(size) time.</p> |
| <p><p><strong>NOTE</strong>: this class will pre-allocate a full array of |
| length <code>maxSize+1</code> if instantiated via the |
| <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html#Lucene_Net_Util_PriorityQueue_1__ctor_System_Int32_System_Boolean_">PriorityQueue(Int32, Boolean)</a> constructor with |
| <code>prepopulate</code> set to <code>true</code>. That maximum |
| size can grow as we insert elements over the time. |
| <p> |
| <div class="lucene-block lucene-internal">This is a Lucene.NET INTERNAL API, use at your own risk</div></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="inheritance"> |
| <h5>Inheritance</h5> |
| <div class="level0"><span class="xref">System.Object</span></div> |
| <div class="level1"><span class="xref">PriorityQueue<T></span></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Search.FieldValueHitQueue-1.html">FieldValueHitQueue<T></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.Util.html">Lucene.Net.Util</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.dll</h6> |
| <h5 id="Lucene_Net_Util_PriorityQueue_1_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">[Serializable] |
| public abstract class PriorityQueue<T></code></pre> |
| </div> |
| <h5 class="typeParameters">Type Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="parametername">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1__ctor_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.%23ctor(System.Int32)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L47">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1__ctor_" data-uid="Lucene.Net.Util.PriorityQueue`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1__ctor_System_Int32_" data-uid="Lucene.Net.Util.PriorityQueue`1.#ctor(System.Int32)">PriorityQueue(Int32)</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 PriorityQueue(int maxSize)</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">maxSize</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1__ctor_System_Int32_System_Boolean_.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.%23ctor(System.Int32%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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L52">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1__ctor_" data-uid="Lucene.Net.Util.PriorityQueue`1.#ctor*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1__ctor_System_Int32_System_Boolean_" data-uid="Lucene.Net.Util.PriorityQueue`1.#ctor(System.Int32,System.Boolean)">PriorityQueue(Int32, Boolean)</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 PriorityQueue(int maxSize, bool prepopulate)</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">maxSize</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td><span class="parametername">prepopulate</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_Util_PriorityQueue_1_Count.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.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/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L255">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_Count_" data-uid="Lucene.Net.Util.PriorityQueue`1.Count*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_Count" data-uid="Lucene.Net.Util.PriorityQueue`1.Count">Count</h4> |
| <div class="markdown level1 summary"><p>Returns the number of elements currently stored in the <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html">PriorityQueue<T></a>. |
| 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 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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_HeapArray.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.HeapArray%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L311">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_HeapArray_" data-uid="Lucene.Net.Util.PriorityQueue`1.HeapArray*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_HeapArray" data-uid="Lucene.Net.Util.PriorityQueue`1.HeapArray">HeapArray</h4> |
| <div class="markdown level1 summary"><p>This method returns the internal heap array as T[]. |
| <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">protected T[] HeapArray { 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>T[]</td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_Top.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.Top%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L200">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_Top_" data-uid="Lucene.Net.Util.PriorityQueue`1.Top*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_Top" data-uid="Lucene.Net.Util.PriorityQueue`1.Top">Top</h4> |
| <div class="markdown level1 summary"><p>Returns the least element of the <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html">PriorityQueue<T></a> in constant time. |
| Returns <code>null</code> if the queue is empty. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public T Top { 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">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="methods">Methods |
| </h3> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_Add__0_.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.Add(%600)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L159">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_Add_" data-uid="Lucene.Net.Util.PriorityQueue`1.Add*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_Add__0_" data-uid="Lucene.Net.Util.PriorityQueue`1.Add(`0)">Add(T)</h4> |
| <div class="markdown level1 summary"><p>Adds an Object to a <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html">PriorityQueue<T></a> in log(size) time. If one tries to add |
| more objects than <span class="xref">Lucene.Net.Util.PriorityQueue`1.maxSize</span> from initialize and it is not possible to resize |
| the heap, an <span class="xref">System.IndexOutOfRangeException</span> is thrown.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public T Add(T element)</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">T</span></td> |
| <td><span class="parametername">element</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">T</span></td> |
| <td><p>The new 'top' element in the queue. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_Clear.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.Clear%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L259">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_Clear_" data-uid="Lucene.Net.Util.PriorityQueue`1.Clear*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_Clear" data-uid="Lucene.Net.Util.PriorityQueue`1.Clear">Clear()</h4> |
| <div class="markdown level1 summary"><p>Removes all entries from the <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html">PriorityQueue<T></a>. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public void Clear()</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-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_GetSentinelObject.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.GetSentinelObject%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L148">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_GetSentinelObject_" data-uid="Lucene.Net.Util.PriorityQueue`1.GetSentinelObject*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_GetSentinelObject" data-uid="Lucene.Net.Util.PriorityQueue`1.GetSentinelObject">GetSentinelObject()</h4> |
| <div class="markdown level1 summary"><p>This method can be overridden by extending classes to return a sentinel |
| object which will be used by the <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html#Lucene_Net_Util_PriorityQueue_1__ctor_System_Int32_System_Boolean_">PriorityQueue(Int32, Boolean)</a> |
| constructor to fill the queue, so that the code which uses that queue can always |
| assume it's full and only change the top without attempting to insert any new |
| object. |
| <p> |
| Those sentinel values should always compare worse than any non-sentinel |
| value (i.e., <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html#Lucene_Net_Util_PriorityQueue_1_LessThan__0__0_">LessThan(T, T)</a> should always favor the |
| non-sentinel values). |
| <p> |
| By default, this method returns <code>false</code>, which means the queue will not be |
| filled with sentinel values. Otherwise, the value returned will be used to |
| pre-populate the queue. Adds sentinel values to the queue. |
| <p> |
| If this method is extended to return a non-null value, then the following |
| usage pattern is recommended:</p> |
| <pre><code>// extends GetSentinelObject() to return a non-null value. |
| PriorityQueue<MyObject> pq = new MyQueue<MyObject>(numHits); |
| // save the 'top' element, which is guaranteed to not be null. |
| MyObject pqTop = pq.Top; |
| <...> |
| // now in order to add a new element, which is 'better' than top (after |
| // you've verified it is better), it is as simple as: |
| pqTop.Change(). |
| pqTop = pq.UpdateTop();</code></pre> |
| <p><p> |
| <strong>NOTE:</strong> if this method returns a non-<code>null</code> value, it will be called by |
| the <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html#Lucene_Net_Util_PriorityQueue_1__ctor_System_Int32_System_Boolean_">PriorityQueue(Int32, Boolean)</a> constructor |
| <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html#Lucene_Net_Util_PriorityQueue_1_Count">Count</a> times, relying on a new object to be returned and will not |
| check if it's <code>null</code> again. Therefore you should ensure any call to this |
| method creates a new instance and behaves consistently, e.g., it cannot |
| return <code>null</code> if it previously returned non-<code>null</code>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual T GetSentinelObject()</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">T</span></td> |
| <td><p>The sentinel object to use to pre-populate the queue, or <code>null</code> if |
| sentinel objects are not supported. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_InsertWithOverflow__0_.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.InsertWithOverflow(%600)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L177">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_InsertWithOverflow_" data-uid="Lucene.Net.Util.PriorityQueue`1.InsertWithOverflow*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_InsertWithOverflow__0_" data-uid="Lucene.Net.Util.PriorityQueue`1.InsertWithOverflow(`0)">InsertWithOverflow(T)</h4> |
| <div class="markdown level1 summary"><p>Adds an Object to a <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html">PriorityQueue<T></a> in log(size) time. |
| It returns the object (if any) that was |
| dropped off the heap because it was full. This can be |
| the given parameter (in case it is smaller than the |
| full heap's minimum, and couldn't be added), or another |
| object that was previously the smallest value in the |
| heap and now has been replaced by a larger one, or <code>null</code> |
| if the queue wasn't yet full with <span class="xref">Lucene.Net.Util.PriorityQueue`1.maxSize</span> elements.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual T InsertWithOverflow(T element)</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">T</span></td> |
| <td><span class="parametername">element</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">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_LessThan__0__0_.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.LessThan(%600%2C%600)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L107">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_LessThan_" data-uid="Lucene.Net.Util.PriorityQueue`1.LessThan*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_LessThan__0__0_" data-uid="Lucene.Net.Util.PriorityQueue`1.LessThan(`0,`0)">LessThan(T, T)</h4> |
| <div class="markdown level1 summary"><p>Determines the ordering of objects in this priority queue. Subclasses |
| must define this one method. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected abstract bool LessThan(T a, T b)</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">T</span></td> |
| <td><span class="parametername">a</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">T</span></td> |
| <td><span class="parametername">b</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.Boolean</span></td> |
| <td><p><code>true</code> if parameter <code data-dev-comment-type="paramref" class="paramref">a</code> is less than parameter <code data-dev-comment-type="paramref" class="paramref">b</code>. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_Pop.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.Pop%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L210">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_Pop_" data-uid="Lucene.Net.Util.PriorityQueue`1.Pop*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_Pop" data-uid="Lucene.Net.Util.PriorityQueue`1.Pop">Pop()</h4> |
| <div class="markdown level1 summary"><p>Removes and returns the least element of the <a class="xref" href="Lucene.Net.Util.PriorityQueue-1.html">PriorityQueue<T></a> in log(size) |
| time.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public T Pop()</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">T</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_PriorityQueue_1_UpdateTop.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601.UpdateTop%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a> |
| </span> |
| <span class="small pull-right mobile-hide"> |
| <a href="https://github.com/NightOwl888/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L245">View Source</a> |
| </span> |
| <a id="Lucene_Net_Util_PriorityQueue_1_UpdateTop_" data-uid="Lucene.Net.Util.PriorityQueue`1.UpdateTop*"></a> |
| <h4 id="Lucene_Net_Util_PriorityQueue_1_UpdateTop" data-uid="Lucene.Net.Util.PriorityQueue`1.UpdateTop">UpdateTop()</h4> |
| <div class="markdown level1 summary"><p>Should be called when the Object at top changes values. Still log(n) worst |
| case, but it's at least twice as fast to</p> |
| <pre><code>pq.Top.Change(); |
| pq.UpdateTop();</code></pre> |
| |
| <p>instead of</p> |
| <pre><code>o = pq.Pop(); |
| o.Change(); |
| pq.Push(o);</code></pre> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public T UpdateTop()</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">T</span></td> |
| <td><p>The new 'top' element. </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_Util_PriorityQueue_1.md&value=---%0Auid%3A%20Lucene.Net.Util.PriorityQueue%601%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a> |
| </li> |
| <li> |
| <a href="https://github.com/apache/lucenenet/blob/release/Lucene.Net_4_8_0_beta00010/src/Lucene.Net/Util/PriorityQueue.cs/#L39" 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> |
