| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class WordBreakSpellChecker |
| | Apache Lucene.NET 4.8.0-beta00010 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class WordBreakSpellChecker |
| | 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="suggest/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.Search.Spell.WordBreakSpellChecker"> |
| |
| |
| <h1 id="Lucene_Net_Search_Spell_WordBreakSpellChecker" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker" class="text-break">Class WordBreakSpellChecker |
| </h1> |
| <div class="markdown level0 summary"><p> |
| A spell checker whose sole function is to offer suggestions by combining |
| multiple terms into one word and/or breaking terms into multiple words. |
| </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">WordBreakSpellChecker</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.Search.Spell.html">Lucene.Net.Search.Spell</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Suggest.dll</h6> |
| <h5 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class WordBreakSpellChecker</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_Search_Spell_WordBreakSpellChecker__ctor.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.%23ctor%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.Suggest/Spell/WordBreakSpellChecker.cs/#L54">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker__ctor_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.#ctor*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker__ctor" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.#ctor">WordBreakSpellChecker()</h4> |
| <div class="markdown level1 summary"><p>Creates a new spellchecker with default configuration values </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public WordBreakSpellChecker()</code></pre> |
| </div> |
| <h5 id="Lucene_Net_Search_Spell_WordBreakSpellChecker__ctor_seealso">See Also</h5> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.html#Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxChanges">MaxChanges</a></div> |
| <div><a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.html#Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxCombineWordLength">MaxCombineWordLength</a></div> |
| <div><a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.html#Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxEvaluations">MaxEvaluations</a></div> |
| <div><a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.html#Lucene_Net_Search_Spell_WordBreakSpellChecker_MinBreakWordLength">MinBreakWordLength</a></div> |
| <div><a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.html#Lucene_Net_Search_Spell_WordBreakSpellChecker_MinSuggestionFrequency">MinSuggestionFrequency</a></div> |
| </div> |
| <h3 id="fields">Fields |
| </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_Search_Spell_WordBreakSpellChecker_SEPARATOR_TERM.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.SEPARATOR_TERM%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.Suggest/Spell/WordBreakSpellChecker.cs/#L45">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_SEPARATOR_TERM" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.SEPARATOR_TERM">SEPARATOR_TERM</h4> |
| <div class="markdown level1 summary"><p>Term that can be used to prohibit adjacent terms from being combined </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public static readonly Term SEPARATOR_TERM</code></pre> |
| </div> |
| <h5 class="fieldValue">Field 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">Lucene.Net.Index.Term</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_Search_Spell_WordBreakSpellChecker_MaxChanges.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxChanges%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.Suggest/Spell/WordBreakSpellChecker.cs/#L393">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxChanges_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxChanges*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxChanges" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxChanges">MaxChanges</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the maximum numbers of changes (word breaks or combinations) to make |
| on the original term(s). Default=1.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MaxChanges { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxCombineWordLength.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxCombineWordLength%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.Suggest/Spell/WordBreakSpellChecker.cs/#L374">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxCombineWordLength_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxCombineWordLength*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxCombineWordLength" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxCombineWordLength">MaxCombineWordLength</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the maximum length of a suggestion made |
| by combining 1 or more original terms. Default=20.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MaxCombineWordLength { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxEvaluations.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxEvaluations%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.Suggest/Spell/WordBreakSpellChecker.cs/#L403">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxEvaluations_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxEvaluations*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MaxEvaluations" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MaxEvaluations">MaxEvaluations</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the maximum number of word combinations to evaluate. Default=1000. A higher |
| value might improve result quality. A lower value might improve performance.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MaxEvaluations { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spell_WordBreakSpellChecker_MinBreakWordLength.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.MinBreakWordLength%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.Suggest/Spell/WordBreakSpellChecker.cs/#L383">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MinBreakWordLength_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MinBreakWordLength*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MinBreakWordLength" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MinBreakWordLength">MinBreakWordLength</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the minimum length to break words down to. Default=1.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MinBreakWordLength { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spell_WordBreakSpellChecker_MinSuggestionFrequency.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.MinSuggestionFrequency%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.Suggest/Spell/WordBreakSpellChecker.cs/#L364">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MinSuggestionFrequency_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MinSuggestionFrequency*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_MinSuggestionFrequency" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.MinSuggestionFrequency">MinSuggestionFrequency</h4> |
| <div class="markdown level1 summary"><p>Gets or sets the minimum frequency a term must have to be |
| included as part of a suggestion. Default=1 Not applicable when used with |
| <a class="xref" href="Lucene.Net.Search.Spell.SuggestMode.html#Lucene_Net_Search_Spell_SuggestMode_SUGGEST_MORE_POPULAR">SUGGEST_MORE_POPULAR</a></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual int MinSuggestionFrequency { get; set; }</code></pre> |
| </div> |
| <h5 class="propertyValue">Property Value</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <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_Search_Spell_WordBreakSpellChecker_SuggestWordBreaks_Lucene_Net_Index_Term_System_Int32_Lucene_Net_Index_IndexReader_Lucene_Net_Search_Spell_SuggestMode_Lucene_Net_Search_Spell_WordBreakSpellChecker_BreakSuggestionSortMethod_.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.SuggestWordBreaks(Lucene.Net.Index.Term%2CSystem.Int32%2CLucene.Net.Index.IndexReader%2CLucene.Net.Search.Spell.SuggestMode%2CLucene.Net.Search.Spell.WordBreakSpellChecker.BreakSuggestionSortMethod)%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.Suggest/Spell/WordBreakSpellChecker.cs/#L90">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker_SuggestWordBreaks_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.SuggestWordBreaks*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_SuggestWordBreaks_Lucene_Net_Index_Term_System_Int32_Lucene_Net_Index_IndexReader_Lucene_Net_Search_Spell_SuggestMode_Lucene_Net_Search_Spell_WordBreakSpellChecker_BreakSuggestionSortMethod_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.SuggestWordBreaks(Lucene.Net.Index.Term,System.Int32,Lucene.Net.Index.IndexReader,Lucene.Net.Search.Spell.SuggestMode,Lucene.Net.Search.Spell.WordBreakSpellChecker.BreakSuggestionSortMethod)">SuggestWordBreaks(Term, Int32, IndexReader, SuggestMode, WordBreakSpellChecker.BreakSuggestionSortMethod)</h4> |
| <div class="markdown level1 summary"><p>Generate suggestions by breaking the passed-in term into multiple words. |
| The scores returned are equal to the number of word breaks needed so a |
| lower score is generally preferred over a higher score.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual SuggestWord[][] SuggestWordBreaks(Term term, int maxSuggestions, IndexReader ir, SuggestMode suggestMode = SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX, WordBreakSpellChecker.BreakSuggestionSortMethod sortMethod = WordBreakSpellChecker.BreakSuggestionSortMethod.NUM_CHANGES_THEN_MAX_FREQUENCY)</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.Index.Term</span></td> |
| <td><span class="parametername">term</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxSuggestions</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">ir</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Spell.SuggestMode.html">SuggestMode</a></td> |
| <td><span class="parametername">suggestMode</span></td> |
| <td><ul> |
| <li>default = <a class="xref" href="Lucene.Net.Search.Spell.SuggestMode.html#Lucene_Net_Search_Spell_SuggestMode_SUGGEST_WHEN_NOT_IN_INDEX">SUGGEST_WHEN_NOT_IN_INDEX</a> </li> |
| </ul> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.BreakSuggestionSortMethod.html">WordBreakSpellChecker.BreakSuggestionSortMethod</a></td> |
| <td><span class="parametername">sortMethod</span></td> |
| <td><ul> |
| <li>default = <a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.BreakSuggestionSortMethod.html#Lucene_Net_Search_Spell_WordBreakSpellChecker_BreakSuggestionSortMethod_NUM_CHANGES_THEN_MAX_FREQUENCY">NUM_CHANGES_THEN_MAX_FREQUENCY</a> </li> |
| </ul> |
| </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.Search.Spell.SuggestWord.html">SuggestWord</a>[][]</td> |
| <td><p>one or more arrays of words formed by breaking up the original term </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spell_WordBreakSpellChecker_SuggestWordCombinations_Lucene_Net_Index_Term___System_Int32_Lucene_Net_Index_IndexReader_Lucene_Net_Search_Spell_SuggestMode_.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker.SuggestWordCombinations(Lucene.Net.Index.Term%5B%5D%2CSystem.Int32%2CLucene.Net.Index.IndexReader%2CLucene.Net.Search.Spell.SuggestMode)%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.Suggest/Spell/WordBreakSpellChecker.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Search_Spell_WordBreakSpellChecker_SuggestWordCombinations_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.SuggestWordCombinations*"></a> |
| <h4 id="Lucene_Net_Search_Spell_WordBreakSpellChecker_SuggestWordCombinations_Lucene_Net_Index_Term___System_Int32_Lucene_Net_Index_IndexReader_Lucene_Net_Search_Spell_SuggestMode_" data-uid="Lucene.Net.Search.Spell.WordBreakSpellChecker.SuggestWordCombinations(Lucene.Net.Index.Term[],System.Int32,Lucene.Net.Index.IndexReader,Lucene.Net.Search.Spell.SuggestMode)">SuggestWordCombinations(Term[], Int32, IndexReader, SuggestMode)</h4> |
| <div class="markdown level1 summary"><p> |
| Generate suggestions by combining one or more of the passed-in terms into |
| single words. The returned <a class="xref" href="Lucene.Net.Search.Spell.CombineSuggestion.html">CombineSuggestion</a> contains both a |
| <a class="xref" href="Lucene.Net.Search.Spell.SuggestWord.html">SuggestWord</a> and also an array detailing which passed-in terms were |
| involved in creating this combination. The scores returned are equal to the |
| number of word combinations needed, also one less than the length of the |
| array <a class="xref" href="Lucene.Net.Search.Spell.CombineSuggestion.html#Lucene_Net_Search_Spell_CombineSuggestion_OriginalTermIndexes">OriginalTermIndexes</a>. Generally, a |
| suggestion with a lower score is preferred over a higher score. |
| </p> |
| <p> |
| To prevent two adjacent terms from being combined (for instance, if one is |
| mandatory and the other is prohibited), separate the two terms with |
| <a class="xref" href="Lucene.Net.Search.Spell.WordBreakSpellChecker.html#Lucene_Net_Search_Spell_WordBreakSpellChecker_SEPARATOR_TERM">SEPARATOR_TERM</a> |
| </p> |
| <p> |
| When suggestMode equals <a class="xref" href="Lucene.Net.Search.Spell.SuggestMode.html#Lucene_Net_Search_Spell_SuggestMode_SUGGEST_WHEN_NOT_IN_INDEX">SUGGEST_WHEN_NOT_IN_INDEX</a>, each |
| suggestion will include at least one term not in the index. |
| </p> |
| <p> |
| When suggestMode equals <a class="xref" href="Lucene.Net.Search.Spell.SuggestMode.html#Lucene_Net_Search_Spell_SuggestMode_SUGGEST_MORE_POPULAR">SUGGEST_MORE_POPULAR</a>, each |
| suggestion will have the same, or better frequency than the most-popular |
| included term. |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual CombineSuggestion[] SuggestWordCombinations(Term[] terms, int maxSuggestions, IndexReader ir, SuggestMode suggestMode = SuggestMode.SUGGEST_WHEN_NOT_IN_INDEX)</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.Index.Term</span>[]</td> |
| <td><span class="parametername">terms</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxSuggestions</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">Lucene.Net.Index.IndexReader</span></td> |
| <td><span class="parametername">ir</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Search.Spell.SuggestMode.html">SuggestMode</a></td> |
| <td><span class="parametername">suggestMode</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.Search.Spell.CombineSuggestion.html">CombineSuggestion</a>[]</td> |
| <td><p>an array of words generated by combining original terms </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="exceptions">Exceptions</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Condition</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.IO.IOException</span></td> |
| <td><p>If there is a low-level I/O error. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </article> |
| </div> |
| |
| <div class="hidden-sm col-md-2" role="complementary"> |
| <div class="sideaffix"> |
| <div class="contribution"> |
| <ul class="nav"> |
| <li> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00010/websites/apidocs/apiSpec/new?filename=Lucene_Net_Search_Spell_WordBreakSpellChecker.md&value=---%0Auid%3A%20Lucene.Net.Search.Spell.WordBreakSpellChecker%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.Suggest/Spell/WordBreakSpellChecker.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> |
