blob: 29b73deb850c93ddf800518159cfe00ade1b2fb1 [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
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Util
| 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">
<h1 id="Lucene_Net_Util_Fst_Util" data-uid="Lucene.Net.Util.Fst.Util" class="text-break">Class Util
</h1>
<div class="markdown level0 summary"><p>Static helper methods.
<p>
<div class="lucene-block lucene-experimental">This is a Lucene.NET EXPERIMENTAL API, use at your own risk</div></div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><span class="xref">Util</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_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class Util</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Util_Fst_Util_Get__1_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_BytesRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.Get%60%601(Lucene.Net.Util.Fst.FST%7B%60%600%7D%2CLucene.Net.Util.BytesRef)%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/#L79">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_Get_" data-uid="Lucene.Net.Util.Fst.Util.Get*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_Get__1_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Util.Fst.Util.Get``1(Lucene.Net.Util.Fst.FST{``0},Lucene.Net.Util.BytesRef)">Get&lt;T&gt;(FST&lt;T&gt;, BytesRef)</h4>
<div class="markdown level1 summary"><p>Looks up the output for this input, or <code>null</code> if the
input is not accepted</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T Get&lt;T&gt;(FST&lt;T&gt; fst, BytesRef 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-1.html">FST</a>&lt;T&gt;</td>
<td><span class="parametername">fst</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">input</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>
<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>
<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_Get__1_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_Int32sRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.Get%60%601(Lucene.Net.Util.Fst.FST%7B%60%600%7D%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/#L45">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_Get_" data-uid="Lucene.Net.Util.Fst.Util.Get*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_Get__1_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Util.Fst.Util.Get``1(Lucene.Net.Util.Fst.FST{``0},Lucene.Net.Util.Int32sRef)">Get&lt;T&gt;(FST&lt;T&gt;, Int32sRef)</h4>
<div class="markdown level1 summary"><p>Looks up the output for this input, or <code>null</code> if the
input is not accepted.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static T Get&lt;T&gt;(FST&lt;T&gt; fst, 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-1.html">FST</a>&lt;T&gt;</td>
<td><span class="parametername">fst</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>
<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>
<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>
<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_GetByOutput_Lucene_Net_Util_Fst_FST_System_Nullable_System_Int64___System_Int64_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.GetByOutput(Lucene.Net.Util.Fst.FST%7BSystem.Nullable%7BSystem.Int64%7D%7D%2CSystem.Int64)%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/#L123">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_GetByOutput_" data-uid="Lucene.Net.Util.Fst.Util.GetByOutput*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_GetByOutput_Lucene_Net_Util_Fst_FST_System_Nullable_System_Int64___System_Int64_" data-uid="Lucene.Net.Util.Fst.Util.GetByOutput(Lucene.Net.Util.Fst.FST{System.Nullable{System.Int64}},System.Int64)">GetByOutput(FST&lt;Nullable&lt;Int64&gt;&gt;, Int64)</h4>
<div class="markdown level1 summary"><p>Reverse lookup (lookup by output instead of by input),
in the special case when your FSTs outputs are
strictly ascending. This locates the input/output
pair where the output is equal to the target, and will
return <code>null</code> if that output does not exist.</p>
<p><p>NOTE: this only works with <see cref="T:FST{long?}"></see>, only
works when the outputs are ascending in order with
the inputs.
For example, simple ordinals (0, 1,
2, ...), or file offets (when appending to a file)
fit this.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Int32sRef GetByOutput(FST&lt;long?&gt; fst, long targetOutput)</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;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;&gt;</td>
<td><span class="parametername">fst</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">targetOutput</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</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_Util_Fst_Util_GetByOutput_Lucene_Net_Util_Fst_FST_System_Nullable_System_Int64___System_Int64_Lucene_Net_Util_Fst_FST_BytesReader_Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___Lucene_Net_Util_Int32sRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.GetByOutput(Lucene.Net.Util.Fst.FST%7BSystem.Nullable%7BSystem.Int64%7D%7D%2CSystem.Int64%2CLucene.Net.Util.Fst.FST.BytesReader%2CLucene.Net.Util.Fst.FST.Arc%7BSystem.Nullable%7BSystem.Int64%7D%7D%2CLucene.Net.Util.Fst.FST.Arc%7BSystem.Nullable%7BSystem.Int64%7D%7D%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/#L141">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_GetByOutput_" data-uid="Lucene.Net.Util.Fst.Util.GetByOutput*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_GetByOutput_Lucene_Net_Util_Fst_FST_System_Nullable_System_Int64___System_Int64_Lucene_Net_Util_Fst_FST_BytesReader_Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Util.Fst.Util.GetByOutput(Lucene.Net.Util.Fst.FST{System.Nullable{System.Int64}},System.Int64,Lucene.Net.Util.Fst.FST.BytesReader,Lucene.Net.Util.Fst.FST.Arc{System.Nullable{System.Int64}},Lucene.Net.Util.Fst.FST.Arc{System.Nullable{System.Int64}},Lucene.Net.Util.Int32sRef)">GetByOutput(FST&lt;Nullable&lt;Int64&gt;&gt;, Int64, FST.BytesReader, FST.Arc&lt;Nullable&lt;Int64&gt;&gt;, FST.Arc&lt;Nullable&lt;Int64&gt;&gt;, Int32sRef)</h4>
<div class="markdown level1 summary"><p>Expert: like <a class="xref" href="Lucene.Net.Util.Fst.Util.html#Lucene_Net_Util_Fst_Util_GetByOutput_Lucene_Net_Util_Fst_FST_System_Nullable_System_Int64___System_Int64_">GetByOutput(FST&lt;Nullable&lt;Int64&gt;&gt;, Int64)</a> except reusing
<a class="xref" href="Lucene.Net.Util.Fst.FST.BytesReader.html">FST.BytesReader</a>, initial and scratch Arc, and result.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Int32sRef GetByOutput(FST&lt;long?&gt; fst, long targetOutput, FST.BytesReader in, FST.Arc&lt;long?&gt; arc, FST.Arc&lt;long?&gt; scratchArc, Int32sRef result)</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;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;&gt;</td>
<td><span class="parametername">fst</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int64</span></td>
<td><span class="parametername">targetOutput</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.FST.BytesReader.html">FST.BytesReader</a></td>
<td><span class="parametername">in</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.FST.Arc-1.html">FST.Arc</a>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;&gt;</td>
<td><span class="parametername">arc</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.FST.Arc-1.html">FST.Arc</a>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;&gt;</td>
<td><span class="parametername">scratchArc</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></td>
<td><span class="parametername">result</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</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_Util_Fst_Util_ReadCeilArc__1_System_Int32_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_Fst_FST_Arc___0__Lucene_Net_Util_Fst_FST_Arc___0__Lucene_Net_Util_Fst_FST_BytesReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ReadCeilArc%60%601(System.Int32%2CLucene.Net.Util.Fst.FST%7B%60%600%7D%2CLucene.Net.Util.Fst.FST.Arc%7B%60%600%7D%2CLucene.Net.Util.Fst.FST.Arc%7B%60%600%7D%2CLucene.Net.Util.Fst.FST.BytesReader)%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/#L1099">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ReadCeilArc_" data-uid="Lucene.Net.Util.Fst.Util.ReadCeilArc*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ReadCeilArc__1_System_Int32_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_Fst_FST_Arc___0__Lucene_Net_Util_Fst_FST_Arc___0__Lucene_Net_Util_Fst_FST_BytesReader_" data-uid="Lucene.Net.Util.Fst.Util.ReadCeilArc``1(System.Int32,Lucene.Net.Util.Fst.FST{``0},Lucene.Net.Util.Fst.FST.Arc{``0},Lucene.Net.Util.Fst.FST.Arc{``0},Lucene.Net.Util.Fst.FST.BytesReader)">ReadCeilArc&lt;T&gt;(Int32, FST&lt;T&gt;, FST.Arc&lt;T&gt;, FST.Arc&lt;T&gt;, FST.BytesReader)</h4>
<div class="markdown level1 summary"><p>Reads the first arc greater or equal that the given label into the provided
arc in place and returns it iff found, otherwise return <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">public static FST.Arc&lt;T&gt; ReadCeilArc&lt;T&gt;(int label, FST&lt;T&gt; fst, FST.Arc&lt;T&gt; follow, FST.Arc&lt;T&gt; arc, FST.BytesReader in)</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">label</span></td>
<td><p>the label to ceil on </p>
</td>
</tr>
<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 fst to operate on </p>
</td>
</tr>
<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">follow</span></td>
<td><p>the arc to follow reading the label from </p>
</td>
</tr>
<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">arc</span></td>
<td><p>the arc to read into in place </p>
</td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.FST.BytesReader.html">FST.BytesReader</a></td>
<td><span class="parametername">in</span></td>
<td><p>the fst&apos;s <a class="xref" href="Lucene.Net.Util.Fst.FST.BytesReader.html">FST.BytesReader</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.Util.Fst.FST.Arc-1.html">FST.Arc</a>&lt;T&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<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>
<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_ShortestPaths__1_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_Fst_FST_Arc___0____0_System_Collections_Generic_IComparer___0__System_Int32_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ShortestPaths%60%601(Lucene.Net.Util.Fst.FST%7B%60%600%7D%2CLucene.Net.Util.Fst.FST.Arc%7B%60%600%7D%2C%60%600%2CSystem.Collections.Generic.IComparer%7B%60%600%7D%2CSystem.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/Fst/Util.cs/#L702">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ShortestPaths_" data-uid="Lucene.Net.Util.Fst.Util.ShortestPaths*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ShortestPaths__1_Lucene_Net_Util_Fst_FST___0__Lucene_Net_Util_Fst_FST_Arc___0____0_System_Collections_Generic_IComparer___0__System_Int32_System_Boolean_" data-uid="Lucene.Net.Util.Fst.Util.ShortestPaths``1(Lucene.Net.Util.Fst.FST{``0},Lucene.Net.Util.Fst.FST.Arc{``0},``0,System.Collections.Generic.IComparer{``0},System.Int32,System.Boolean)">ShortestPaths&lt;T&gt;(FST&lt;T&gt;, FST.Arc&lt;T&gt;, T, IComparer&lt;T&gt;, Int32, Boolean)</h4>
<div class="markdown level1 summary"><p>Starting from node, find the top N min cost
completions to a final node.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Util.TopResults&lt;T&gt; ShortestPaths&lt;T&gt;(FST&lt;T&gt; fst, FST.Arc&lt;T&gt; fromNode, T startOutput, IComparer&lt;T&gt; comparer, int topN, bool allowEmptyString)</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></td>
</tr>
<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">fromNode</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.Collections.Generic.IComparer</span>&lt;T&gt;</td>
<td><span class="parametername">comparer</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">topN</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">allowEmptyString</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Fst.Util.TopResults-1.html">Util.TopResults</a>&lt;T&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<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>
<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_ToBytesRef_Lucene_Net_Util_Int32sRef_Lucene_Net_Util_BytesRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ToBytesRef(Lucene.Net.Util.Int32sRef%2CLucene.Net.Util.BytesRef)%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/#L1066">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ToBytesRef_" data-uid="Lucene.Net.Util.Fst.Util.ToBytesRef*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ToBytesRef_Lucene_Net_Util_Int32sRef_Lucene_Net_Util_BytesRef_" data-uid="Lucene.Net.Util.Fst.Util.ToBytesRef(Lucene.Net.Util.Int32sRef,Lucene.Net.Util.BytesRef)">ToBytesRef(Int32sRef, BytesRef)</h4>
<div class="markdown level1 summary"><p>Just converts <a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a> to <a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a>; you must ensure the
<span class="xref">System.Int32</span> values fit into a <span class="xref">System.Byte</span>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static BytesRef ToBytesRef(Int32sRef input, BytesRef scratch)</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><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</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_Util_Fst_Util_ToDot__1_Lucene_Net_Util_Fst_FST___0__System_IO_TextWriter_System_Boolean_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ToDot%60%601(Lucene.Net.Util.Fst.FST%7B%60%600%7D%2CSystem.IO.TextWriter%2CSystem.Boolean%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/Fst/Util.cs/#L747">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ToDot_" data-uid="Lucene.Net.Util.Fst.Util.ToDot*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ToDot__1_Lucene_Net_Util_Fst_FST___0__System_IO_TextWriter_System_Boolean_System_Boolean_" data-uid="Lucene.Net.Util.Fst.Util.ToDot``1(Lucene.Net.Util.Fst.FST{``0},System.IO.TextWriter,System.Boolean,System.Boolean)">ToDot&lt;T&gt;(FST&lt;T&gt;, TextWriter, Boolean, Boolean)</h4>
<div class="markdown level1 summary"><p>Dumps an <a class="xref" href="Lucene.Net.Util.Fst.FST-1.html">FST&lt;T&gt;</a> to a GraphViz&apos;s <code>dot</code> language description
for visualization. Example of use:</p>
<pre><code>using (TextWriter sw = new StreamWriter(&quot;out.dot&quot;))
{
Util.ToDot(fst, sw, true, true);
}</code></pre>
<p>and then, from command line:</p>
<pre><code>dot -Tpng -o out.png out.dot</code></pre>
<p><p>
Note: larger FSTs (a few thousand nodes) won&apos;t even
render, don&apos;t bother. If the FST is &gt; 2.1 GB in size
then this method will throw strange exceptions.
<p>
See also <a href="http://www.graphviz.org/">http://www.graphviz.org/</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static void ToDot&lt;T&gt;(FST&lt;T&gt; fst, TextWriter out, bool sameRank, bool labelStates)</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></td>
</tr>
<tr>
<td><span class="xref">System.IO.TextWriter</span></td>
<td><span class="parametername">out</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">sameRank</span></td>
<td><p>If <code>true</code>, the resulting <code>dot</code> file will try
to order states in layers of breadth-first traversal. This may
mess up arcs, but makes the output FST&apos;s structure a bit clearer.</p>
</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">labelStates</span></td>
<td><p>If <code>true</code> states will have labels equal to their offsets in their
binary format. Expands the graph considerably.</p>
</td>
</tr>
</tbody>
</table>
<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>
<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_ToInt32sRef_Lucene_Net_Util_BytesRef_Lucene_Net_Util_Int32sRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ToInt32sRef(Lucene.Net.Util.BytesRef%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/#L1051">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ToInt32sRef_" data-uid="Lucene.Net.Util.Fst.Util.ToInt32sRef*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ToInt32sRef_Lucene_Net_Util_BytesRef_Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Util.Fst.Util.ToInt32sRef(Lucene.Net.Util.BytesRef,Lucene.Net.Util.Int32sRef)">ToInt32sRef(BytesRef, Int32sRef)</h4>
<div class="markdown level1 summary"><p>Just takes unsigned byte values from the <a class="xref" href="Lucene.Net.Util.BytesRef.html">BytesRef</a> and
converts into an <a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a>.
<p>
NOTE: This was toIntsRef() 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 static Int32sRef ToInt32sRef(BytesRef input, Int32sRef scratch)</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.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">input</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</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_Util_Fst_Util_ToUTF16_System_String_Lucene_Net_Util_Int32sRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ToUTF16(System.String%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/#L988">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ToUTF16_" data-uid="Lucene.Net.Util.Fst.Util.ToUTF16*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ToUTF16_System_String_Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Util.Fst.Util.ToUTF16(System.String,Lucene.Net.Util.Int32sRef)">ToUTF16(String, Int32sRef)</h4>
<div class="markdown level1 summary"><p>Just maps each UTF16 unit (char) to the <span class="xref">System.Int32</span>s in an
<a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a>.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Int32sRef ToUTF16(string s, Int32sRef scratch)</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.String</span></td>
<td><span class="parametername">s</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</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_Util_Fst_Util_ToUTF32_System_Char___System_Int32_System_Int32_Lucene_Net_Util_Int32sRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ToUTF32(System.Char%5B%5D%2CSystem.Int32%2CSystem.Int32%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/#L1028">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ToUTF32_" data-uid="Lucene.Net.Util.Fst.Util.ToUTF32*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ToUTF32_System_Char___System_Int32_System_Int32_Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Util.Fst.Util.ToUTF32(System.Char[],System.Int32,System.Int32,Lucene.Net.Util.Int32sRef)">ToUTF32(Char[], Int32, Int32, Int32sRef)</h4>
<div class="markdown level1 summary"><p>Decodes the Unicode codepoints from the provided
<span class="xref">char[]</span> and places them in the provided scratch
<a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a>, which must not be <code>null</code>, returning it.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Int32sRef ToUTF32(char[] s, int offset, int length, Int32sRef scratch)</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.Char</span>[]</td>
<td><span class="parametername">s</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">offset</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">length</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</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_Util_Fst_Util_ToUTF32_System_String_Lucene_Net_Util_Int32sRef_.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util.ToUTF32(System.String%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/#L1006">View Source</a>
</span>
<a id="Lucene_Net_Util_Fst_Util_ToUTF32_" data-uid="Lucene.Net.Util.Fst.Util.ToUTF32*"></a>
<h4 id="Lucene_Net_Util_Fst_Util_ToUTF32_System_String_Lucene_Net_Util_Int32sRef_" data-uid="Lucene.Net.Util.Fst.Util.ToUTF32(System.String,Lucene.Net.Util.Int32sRef)">ToUTF32(String, Int32sRef)</h4>
<div class="markdown level1 summary"><p>Decodes the Unicode codepoints from the provided
<span class="xref">J2N.Text.ICharSequence</span> and places them in the provided scratch
<a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a>, which must not be <code>null</code>, returning it.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Int32sRef ToUTF32(string s, Int32sRef scratch)</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.String</span></td>
<td><span class="parametername">s</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></td>
<td><span class="parametername">scratch</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Util.Int32sRef.html">Int32sRef</a></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.md&amp;value=---%0Auid%3A%20Lucene.Net.Util.Fst.Util%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/#L35" 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>