blob: 44c6f852ce386e50f7bc3a3bf2f1e828c442f315 [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 SlowFuzzyTermsEnum
| Apache Lucene.NET 4.8.0 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class SlowFuzzyTermsEnum
| Apache Lucene.NET 4.8.0 Documentation ">
<meta name="generator" content="docfx 2.47.0.0">
<link rel="shortcut icon" href="../../logo/favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="../toc.html">
<meta property="docfx:rel" content="../../">
</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="../../index.html">
<img id="logo" class="svg" src="../../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" id="breadcrumb">
<ul class="breadcrumb">
<li></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.Sandbox.Queries.SlowFuzzyTermsEnum">
<h1 id="Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum" data-uid="Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum" class="text-break">Class SlowFuzzyTermsEnum
</h1>
<div class="markdown level0 summary"><p>Potentially slow fuzzy <a class="xref" href="../Lucene.Net/Lucene.Net.Index.TermsEnum.html">TermsEnum</a> for enumerating all terms that are similar
to the specified filter term.
<p>
If the minSimilarity or maxEdits is greater than the Automaton&apos;s
allowable range, this backs off to the classic (brute force)
fuzzy terms enum method by calling <a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_GetAutomatonEnum_System_Int32_Lucene_Net_Util_BytesRef_">GetAutomatonEnum(Int32, BytesRef)</a>.
<p>
Term enumerations are always ordered by
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_Comparer">Comparer</a>. Each term in the enumeration is
greater than all that precede it.</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"><a class="xref" href="../Lucene.Net/Lucene.Net.Index.TermsEnum.html">TermsEnum</a></div>
<div class="level2"><a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html">FuzzyTermsEnum</a></div>
<div class="level3"><span class="xref">SlowFuzzyTermsEnum</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><a class="xref" href="../Lucene.Net/Lucene.Net.Util.IBytesRefIterator.html">IBytesRefIterator</a></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_minSimilarity">FuzzyTermsEnum.m_minSimilarity</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_scaleFactor">FuzzyTermsEnum.m_scaleFactor</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_termLength">FuzzyTermsEnum.m_termLength</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_maxEdits">FuzzyTermsEnum.m_maxEdits</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_raw">FuzzyTermsEnum.m_raw</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_terms">FuzzyTermsEnum.m_terms</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_termText">FuzzyTermsEnum.m_termText</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_m_realPrefixLength">FuzzyTermsEnum.m_realPrefixLength</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_GetAutomatonEnum_System_Int32_Lucene_Net_Util_BytesRef_">FuzzyTermsEnum.GetAutomatonEnum(Int32, BytesRef)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_SetEnum_Lucene_Net_Index_TermsEnum_">FuzzyTermsEnum.SetEnum(TermsEnum)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_Next">FuzzyTermsEnum.Next()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_DocFreq">FuzzyTermsEnum.DocFreq</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_TotalTermFreq">FuzzyTermsEnum.TotalTermFreq</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_Docs_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_Lucene_Net_Index_DocsFlags_">FuzzyTermsEnum.Docs(IBits, DocsEnum, DocsFlags)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_DocsAndPositions_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_Lucene_Net_Index_DocsAndPositionsFlags_">FuzzyTermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum, DocsAndPositionsFlags)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_SeekExact_Lucene_Net_Util_BytesRef_Lucene_Net_Index_TermState_">FuzzyTermsEnum.SeekExact(BytesRef, TermState)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_GetTermState">FuzzyTermsEnum.GetTermState()</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_Comparer">FuzzyTermsEnum.Comparer</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_Ord">FuzzyTermsEnum.Ord</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_SeekExact_Lucene_Net_Util_BytesRef_">FuzzyTermsEnum.SeekExact(BytesRef)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_SeekCeil_Lucene_Net_Util_BytesRef_">FuzzyTermsEnum.SeekCeil(BytesRef)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_SeekExact_System_Int64_">FuzzyTermsEnum.SeekExact(Int64)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_Term">FuzzyTermsEnum.Term</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_MinSimilarity">FuzzyTermsEnum.MinSimilarity</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_ScaleFactor">FuzzyTermsEnum.ScaleFactor</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Attributes">TermsEnum.Attributes</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_Docs_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsEnum_">TermsEnum.Docs(IBits, DocsEnum)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_DocsAndPositions_Lucene_Net_Util_IBits_Lucene_Net_Index_DocsAndPositionsEnum_">TermsEnum.DocsAndPositions(IBits, DocsAndPositionsEnum)</a>
</div>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Index.TermsEnum.html#Lucene_Net_Index_TermsEnum_EMPTY">TermsEnum.EMPTY</a>
</div>
<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.Sandbox.Queries.html">Lucene.Net.Sandbox.Queries</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.Sandbox.dll</h6>
<h5 id="Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">[Obsolete(&quot;Use FuzzyTermsEnum instead.&quot;)]
public class SlowFuzzyTermsEnum : FuzzyTermsEnum, IBytesRefIterator</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum__ctor_Lucene_Net_Index_Terms_Lucene_Net_Util_AttributeSource_Lucene_Net_Index_Term_System_Single_System_Int32_.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum.%23ctor(Lucene.Net.Index.Terms%2CLucene.Net.Util.AttributeSource%2CLucene.Net.Index.Term%2CSystem.Single%2CSystem.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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Sandbox/Queries/SlowFuzzyTermsEnum.cs/#L40">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum__ctor_" data-uid="Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum.#ctor*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum__ctor_Lucene_Net_Index_Terms_Lucene_Net_Util_AttributeSource_Lucene_Net_Index_Term_System_Single_System_Int32_" data-uid="Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum.#ctor(Lucene.Net.Index.Terms,Lucene.Net.Util.AttributeSource,Lucene.Net.Index.Term,System.Single,System.Int32)">SlowFuzzyTermsEnum(Terms, AttributeSource, Term, Single, 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 SlowFuzzyTermsEnum(Terms terms, AttributeSource atts, Term term, float minSimilarity, int prefixLength)</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/Lucene.Net.Index.Terms.html">Terms</a></td>
<td><span class="parametername">terms</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html">AttributeSource</a></td>
<td><span class="parametername">atts</span></td>
<td></td>
</tr>
<tr>
<td><a class="xref" href="../Lucene.Net/Lucene.Net.Index.Term.html">Term</a></td>
<td><span class="parametername">term</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Single</span></td>
<td><span class="parametername">minSimilarity</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">prefixLength</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum_MaxEditDistanceChanged_Lucene_Net_Util_BytesRef_System_Int32_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum.MaxEditDistanceChanged(Lucene.Net.Util.BytesRef%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Sandbox/Queries/SlowFuzzyTermsEnum.cs/#L46">View Source</a>
</span>
<a id="Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum_MaxEditDistanceChanged_" data-uid="Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum.MaxEditDistanceChanged*"></a>
<h4 id="Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum_MaxEditDistanceChanged_Lucene_Net_Util_BytesRef_System_Int32_System_Boolean_" data-uid="Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum.MaxEditDistanceChanged(Lucene.Net.Util.BytesRef,System.Int32,System.Boolean)">MaxEditDistanceChanged(BytesRef, 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">protected override void MaxEditDistanceChanged(BytesRef lastTerm, int maxEdits, bool init)</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/Lucene.Net.Util.BytesRef.html">BytesRef</a></td>
<td><span class="parametername">lastTerm</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">maxEdits</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">init</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="../Lucene.Net/Lucene.Net.Search.FuzzyTermsEnum.html#Lucene_Net_Search_FuzzyTermsEnum_MaxEditDistanceChanged_Lucene_Net_Util_BytesRef_System_Int32_System_Boolean_">FuzzyTermsEnum.MaxEditDistanceChanged(BytesRef, Int32, Boolean)</a></div>
<h3 id="implements">Implements</h3>
<div>
<a class="xref" href="../Lucene.Net/Lucene.Net.Util.IBytesRefIterator.html">IBytesRefIterator</a>
</div>
</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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Sandbox_Queries_SlowFuzzyTermsEnum.md&amp;value=---%0Auid%3A%20Lucene.Net.Sandbox.Queries.SlowFuzzyTermsEnum%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/Shazwazza/lucenenet/blob/docs-update-jan2020/src/Lucene.Net.Sandbox/Queries/SlowFuzzyTermsEnum.cs/#L37" 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="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>