Google Git
Sign in
apache / lucenenet-site / 5ff971ba7cc570e29ca8a7f21ffcd5b2651be54b / . / docs / 4.8.0-beta00010 / api / core / Lucene.Net.Util.Fst.Util.TopNSearcher-1.html
blob: 88408a83fc952d3a0a1a95b9c9c3d18a9a262c01 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Util.TopNSearcher&lt;T&gt;
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Util.TopNSearcher&lt;T&gt;
| 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.Fst.Util.TopNSearcher`1">
<h1 id="Lucene_Net_Util_Fst_Util_TopNSearcher_1" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1" class="text-break">Class Util.TopNSearcher&lt;T&gt;
</h1>
<div class="markdown level0 summary"><p>Utility class to find top N shortest paths from start
point(s).</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">Util.TopNSearcher&lt;T&gt;</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Util.Fst.html">Lucene.Net.Util.Fst</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class TopNSearcher&lt;T&gt;</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_Fst_Util_TopNSearcher_1__ctor_Lucene_Net_Util_Fst_FST__0__System_Int32_System_Int32_System_Collections_Generic_IComparer__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.TopNSearcher%601.%23ctor(Lucene.Net.Util.Fst.FST%7B%600%7D%2CSystem.Int32%2CSystem.Int32%2CSystem.Collections.Generic.IComparer%7B%600%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/Util/Fst/Util.cs/#L376">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_TopNSearcher_1__ctor_" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.#ctor*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_TopNSearcher_1__ctor_Lucene_Net_Util_Fst_FST__0__System_Int32_System_Int32_System_Collections_Generic_IComparer__0__" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.#ctor(Lucene.Net.Util.Fst.FST{`0},System.Int32,System.Int32,System.Collections.Generic.IComparer{`0})">TopNSearcher(FST&lt;T&gt;, Int32, Int32, IComparer&lt;T&gt;)</h4>
<div class="markdown level1 summary"><p>Creates an unbounded TopNSearcher </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public TopNSearcher(FST&lt;T&gt; fst, int topN, int maxQueueDepth, IComparer&lt;T&gt; comparer)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.FST-1.html">FST</a>&lt;T&gt;</td>
<td><span class="parametername">fst</span></td>
<td><p>the <a class="xref" href="Lucene.Net.Util.Fst.FST-1.html">FST&lt;T&gt;</a> to search on </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">topN</span></td>
<td><p>the number of top scoring entries to retrieve </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">maxQueueDepth</span></td>
<td><p>the maximum size of the queue of possible top entries </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Collections.Generic.IComparer</span>&lt;T&gt;</td>
<td><span class="parametername">comparer</span></td>
<td><p>the comparer to select the top N </p>
</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_Fst_Util_TopNSearcher_1_AcceptResult_Lucene_Net_Util_Int32sRef__0_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.TopNSearcher%601.AcceptResult(Lucene.Net.Util.Int32sRef%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/Fst/Util.cs/#L642">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_AcceptResult_" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.AcceptResult*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_AcceptResult_Lucene_Net_Util_Int32sRef__0_" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.AcceptResult(Lucene.Net.Util.Int32sRef,`0)">AcceptResult(Int32sRef, T)</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">protected virtual bool AcceptResult(Int32sRef input, T output)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></td>
<td><span class="parametername">input</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">output</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></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_Fst_Util_TopNSearcher_1_AddIfCompetitive_Lucene_Net_Util_Fst_Util_FSTPath__0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.TopNSearcher%601.AddIfCompetitive(Lucene.Net.Util.Fst.Util.FSTPath%7B%600%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/Util/Fst/Util.cs/#L390">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_AddIfCompetitive_" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.AddIfCompetitive*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_AddIfCompetitive_Lucene_Net_Util_Fst_Util_FSTPath__0__" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.AddIfCompetitive(Lucene.Net.Util.Fst.Util.FSTPath{`0})">AddIfCompetitive(Util.FSTPath&lt;T&gt;)</h4>
<div class="markdown level1 summary"><p>If back plus this arc is competitive then add to queue:</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected virtual void AddIfCompetitive(Util.FSTPath&lt;T&gt; path)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.Util.FSTPath-1.html">Util.FSTPath</a>&lt;T&gt;</td>
<td><span class="parametername">path</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_Fst_Util_TopNSearcher_1_AddStartPaths_Lucene_Net_Util_Fst_FST_Arc__0___0_System_Boolean_Lucene_Net_Util_Int32sRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.TopNSearcher%601.AddStartPaths(Lucene.Net.Util.Fst.FST.Arc%7B%600%7D%2C%600%2CSystem.Boolean%2CLucene.Net.Util.Int32sRef)%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/Fst/Util.cs/#L457">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_AddStartPaths_" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.AddStartPaths*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_AddStartPaths_Lucene_Net_Util_Fst_FST_Arc__0___0_System_Boolean_Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.AddStartPaths(Lucene.Net.Util.Fst.FST.Arc{`0},`0,System.Boolean,Lucene.Net.Util.Int32sRef)">AddStartPaths(FST.Arc&lt;T&gt;, T, Boolean, Int32sRef)</h4>
<div class="markdown level1 summary"><p>Adds all leaving arcs, including &apos;finished&apos; arc, if
the node is final, from this node into the queue.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void AddStartPaths(FST.Arc&lt;T&gt; node, T startOutput, bool allowEmptyString, Int32sRef input)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.FST.Arc-1.html">FST.Arc</a>&lt;T&gt;</td>
<td><span class="parametername">node</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">T</span></td>
<td><span class="parametername">startOutput</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">allowEmptyString</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></td>
<td><span class="parametername">input</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_Fst_Util_TopNSearcher_1_Search.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.TopNSearcher%601.Search%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/Fst/Util.cs/#L485">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_Search_" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.Search*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_TopNSearcher_1_Search" data-uid="Lucene.Net.Util.Fst.Util.TopNSearcher`1.Search">Search()</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 virtual Util.TopResults&lt;T&gt; Search()</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.Util.Fst.Util.TopResults-1.html">Util.TopResults</a>&lt;T&gt;</td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Fst_Util_TopNSearcher_1.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.TopNSearcher%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/Fst/Util.cs/#L355" 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>