blob: fdee2645fe320ff6106de0f379d987a82855059b [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 TokenInfoFST
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class TokenInfoFST
| 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="analysis-kuromoji/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.Analysis.Ja.Dict.TokenInfoFST">
<h1 id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST" class="text-break">Class TokenInfoFST
</h1>
<div class="markdown level0 summary"><p>Thin wrapper around an FST with root-arc caching for Japanese.
<p>
Depending upon fasterButMoreRam, either just kana (191 arcs),
or kana and han (28,607 arcs) are cached. The latter offers
additional performance at the cost of more RAM.</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">TokenInfoFST</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.Analysis.Ja.Dict.html">Lucene.Net.Analysis.Ja.Dict</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Analysis.Kuromoji.dll</h6>
<h5 id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public sealed class TokenInfoFST</code></pre>
</div>
<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_Analysis_Ja_Dict_TokenInfoFST__ctor_Lucene_Net_Util_Fst_FST_System_Nullable_System_Int64___System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.%23ctor(Lucene.Net.Util.Fst.FST%7BSystem.Nullable%7BSystem.Int64%7D%7D%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.Analysis.Kuromoji/Dict/TokenInfoFST.cs/#L47">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST__ctor_" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.#ctor*"></a>
<h4 id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST__ctor_Lucene_Net_Util_Fst_FST_System_Nullable_System_Int64___System_Boolean_" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.#ctor(Lucene.Net.Util.Fst.FST{System.Nullable{System.Int64}},System.Boolean)">TokenInfoFST(FST&lt;Nullable&lt;Int64&gt;&gt;, 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 TokenInfoFST(FST&lt;long?&gt; fst, bool fasterButMoreRam)</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">Lucene.Net.Util.Fst.FST</span>&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.Boolean</span></td>
<td><span class="parametername">fasterButMoreRam</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_Analysis_Ja_Dict_TokenInfoFST_NoOutput.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.NoOutput%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.Analysis.Kuromoji/Dict/TokenInfoFST.cs/#L45">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_NoOutput_" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.NoOutput*"></a>
<h4 id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_NoOutput" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.NoOutput">NoOutput</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 long? NoOutput { 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.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;</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_Analysis_Ja_Dict_TokenInfoFST_FindTargetArc_System_Int32_Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___System_Boolean_Lucene_Net_Util_Fst_FST_BytesReader_.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.FindTargetArc(System.Int32%2CLucene.Net.Util.Fst.FST.Arc%7BSystem.Nullable%7BSystem.Int64%7D%7D%2CLucene.Net.Util.Fst.FST.Arc%7BSystem.Nullable%7BSystem.Int64%7D%7D%2CSystem.Boolean%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.Analysis.Kuromoji/Dict/TokenInfoFST.cs/#L73">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_FindTargetArc_" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.FindTargetArc*"></a>
<h4 id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_FindTargetArc_System_Int32_Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___System_Boolean_Lucene_Net_Util_Fst_FST_BytesReader_" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.FindTargetArc(System.Int32,Lucene.Net.Util.Fst.FST.Arc{System.Nullable{System.Int64}},Lucene.Net.Util.Fst.FST.Arc{System.Nullable{System.Int64}},System.Boolean,Lucene.Net.Util.Fst.FST.BytesReader)">FindTargetArc(Int32, FST.Arc&lt;Nullable&lt;Int64&gt;&gt;, FST.Arc&lt;Nullable&lt;Int64&gt;&gt;, Boolean, FST.BytesReader)</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 FST.Arc&lt;long?&gt; FindTargetArc(int ch, FST.Arc&lt;long?&gt; follow, FST.Arc&lt;long?&gt; arc, bool useCache, FST.BytesReader fstReader)</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">ch</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.Fst.FST.Arc</span>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;&gt;</td>
<td><span class="parametername">follow</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.Fst.FST.Arc</span>&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><span class="xref">System.Boolean</span></td>
<td><span class="parametername">useCache</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">Lucene.Net.Util.Fst.FST.BytesReader</span></td>
<td><span class="parametername">fstReader</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">Lucene.Net.Util.Fst.FST.Arc</span>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;&gt;</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_Analysis_Ja_Dict_TokenInfoFST_GetBytesReader.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.GetBytesReader%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.Analysis.Kuromoji/Dict/TokenInfoFST.cs/#L100">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_GetBytesReader_" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.GetBytesReader*"></a>
<h4 id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_GetBytesReader" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.GetBytesReader">GetBytesReader()</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 FST.BytesReader GetBytesReader()</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">Lucene.Net.Util.Fst.FST.BytesReader</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_Analysis_Ja_Dict_TokenInfoFST_GetFirstArc_Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.GetFirstArc(Lucene.Net.Util.Fst.FST.Arc%7BSystem.Nullable%7BSystem.Int64%7D%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.Analysis.Kuromoji/Dict/TokenInfoFST.cs/#L95">View Source</a>
</span>
<a id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_GetFirstArc_" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.GetFirstArc*"></a>
<h4 id="Lucene_Net_Analysis_Ja_Dict_TokenInfoFST_GetFirstArc_Lucene_Net_Util_Fst_FST_Arc_System_Nullable_System_Int64___" data-uid="Lucene.Net.Analysis.Ja.Dict.TokenInfoFST.GetFirstArc(Lucene.Net.Util.Fst.FST.Arc{System.Nullable{System.Int64}})">GetFirstArc(FST.Arc&lt;Nullable&lt;Int64&gt;&gt;)</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 FST.Arc&lt;long?&gt; GetFirstArc(FST.Arc&lt;long?&gt; arc)</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">Lucene.Net.Util.Fst.FST.Arc</span>&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>
</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">Lucene.Net.Util.Fst.FST.Arc</span>&lt;<span class="xref">System.Nullable</span>&lt;<span class="xref">System.Int64</span>&gt;&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_Analysis_Ja_Dict_TokenInfoFST.md&amp;value=---%0Auid%3A%20Lucene.Net.Analysis.Ja.Dict.TokenInfoFST%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.Analysis.Kuromoji/Dict/TokenInfoFST.cs/#L30" 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>