| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class NGramTokenizer |
| | Apache Lucene.NET 4.8.0 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class NGramTokenizer |
| | 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.Analysis.NGram.NGramTokenizer"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_NGram_NGramTokenizer" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer" class="text-break">Class NGramTokenizer |
| </h1> |
| <div class="markdown level0 summary"><p>Tokenizes the input into n-grams of the given size(s). |
| <p>On the contrary to <a class="xref" href="Lucene.Net.Analysis.NGram.NGramTokenFilter.html">NGramTokenFilter</a>, this class sets offsets so |
| that characters between startOffset and endOffset in the original stream are |
| the same as the term chars. |
| </p> |
| <p>For example, "abcde" would be tokenized as (minGram=2, maxGram=3): |
| <table><thead><tr><th>TermPosition incrementPosition lengthOffsets</th><th></th></tr></thead><tbody><tr><td>ab11[0,2[</td><td></td></tr><tr><td>abc11[0,3[</td><td></td></tr><tr><td>bc11[1,3[</td><td></td></tr><tr><td>bcd11[1,4[</td><td></td></tr><tr><td>cd11[2,4[</td><td></td></tr><tr><td>cde11[2,5[</td><td></td></tr><tr><td>de11[3,5[</td><td></td></tr></tbody></table> |
| </p> |
| <p>This tokenizer changed a lot in Lucene 4.4 in order to: |
| <ul><li>tokenize in a streaming fashion to support streams which are larger |
| than 1024 chars (limit of the previous version),</li><li>count grams based on unicode code points instead of java chars (and |
| never split in the middle of surrogate pairs),</li><li>give the ability to pre-tokenize the stream (<a class="xref" href="Lucene.Net.Analysis.NGram.NGramTokenizer.html#Lucene_Net_Analysis_NGram_NGramTokenizer_IsTokenChar_System_Int32_">IsTokenChar(Int32)</a>) |
| before computing n-grams.</li></ul> |
| </p> |
| <p>Additionally, this class doesn't trim trailing whitespaces and emits |
| tokens in a different order, tokens are now emitted by increasing start |
| offsets while they used to be emitted by increasing lengths (which prevented |
| from supporting large input streams). |
| </p> |
| <p>Although <strong>highly</strong> discouraged, it is still possible |
| to use the old behavior through <a class="xref" href="Lucene.Net.Analysis.NGram.Lucene43NGramTokenizer.html">Lucene43NGramTokenizer</a>. |
| </p></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.Util.AttributeSource.html">AttributeSource</a></div> |
| <div class="level2"><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html">TokenStream</a></div> |
| <div class="level3"><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.Tokenizer.html">Tokenizer</a></div> |
| <div class="level4"><span class="xref">NGramTokenizer</span></div> |
| <div class="level5"><a class="xref" href="Lucene.Net.Analysis.NGram.EdgeNGramTokenizer.html">EdgeNGramTokenizer</a></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><span class="xref">System.IDisposable</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.Tokenizer.html#Lucene_Net_Analysis_Tokenizer_m_input">Tokenizer.m_input</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.Tokenizer.html#Lucene_Net_Analysis_Tokenizer_Dispose_System_Boolean_">Tokenizer.Dispose(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.Tokenizer.html#Lucene_Net_Analysis_Tokenizer_CorrectOffset_System_Int32_">Tokenizer.CorrectOffset(Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.Tokenizer.html#Lucene_Net_Analysis_Tokenizer_SetReader_System_IO_TextReader_">Tokenizer.SetReader(TextReader)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html#Lucene_Net_Analysis_TokenStream_Dispose">TokenStream.Dispose()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttributeFactory">AttributeSource.GetAttributeFactory()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttributeClassesEnumerator">AttributeSource.GetAttributeClassesEnumerator()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttributeImplsEnumerator">AttributeSource.GetAttributeImplsEnumerator()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_AddAttributeImpl_Lucene_Net_Util_Attribute_">AttributeSource.AddAttributeImpl(Attribute)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_AddAttribute__1">AttributeSource.AddAttribute<T>()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_HasAttributes">AttributeSource.HasAttributes</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_HasAttribute__1">AttributeSource.HasAttribute<T>()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetAttribute__1">AttributeSource.GetAttribute<T>()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ClearAttributes">AttributeSource.ClearAttributes()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_CaptureState">AttributeSource.CaptureState()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_RestoreState_Lucene_Net_Util_AttributeSource_State_">AttributeSource.RestoreState(AttributeSource.State)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_GetHashCode">AttributeSource.GetHashCode()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_Equals_System_Object_">AttributeSource.Equals(Object)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ReflectAsString_System_Boolean_">AttributeSource.ReflectAsString(Boolean)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ReflectWith_Lucene_Net_Util_IAttributeReflector_">AttributeSource.ReflectWith(IAttributeReflector)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_CloneAttributes">AttributeSource.CloneAttributes()</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_CopyTo_Lucene_Net_Util_AttributeSource_">AttributeSource.CopyTo(AttributeSource)</a> |
| </div> |
| <div> |
| <a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.html#Lucene_Net_Util_AttributeSource_ToString">AttributeSource.ToString()</a> |
| </div> |
| <div> |
| <span class="xref">System.Object.Equals(System.Object, System.Object)</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> |
| <h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Analysis.NGram.html">Lucene.Net.Analysis.NGram</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_NGram_NGramTokenizer_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class NGramTokenizer : Tokenizer, IDisposable</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_Analysis_NGram_NGramTokenizer__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Util_AttributeSource_AttributeFactory_System_IO_TextReader_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.%23ctor(Lucene.Net.Util.LuceneVersion%2CLucene.Net.Util.AttributeSource.AttributeFactory%2CSystem.IO.TextReader%2CSystem.Int32%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L158">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_Lucene_Net_Util_LuceneVersion_Lucene_Net_Util_AttributeSource_AttributeFactory_System_IO_TextReader_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.#ctor(Lucene.Net.Util.LuceneVersion,Lucene.Net.Util.AttributeSource.AttributeFactory,System.IO.TextReader,System.Int32,System.Int32)">NGramTokenizer(LuceneVersion, AttributeSource.AttributeFactory, TextReader, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Creates <a class="xref" href="Lucene.Net.Analysis.NGram.NGramTokenizer.html">NGramTokenizer</a> with given min and max n-grams. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public NGramTokenizer(LuceneVersion version, AttributeSource.AttributeFactory factory, TextReader input, int minGram, int maxGram)</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.LuceneVersion.html">LuceneVersion</a></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>the lucene compatibility version </p> |
| </td> |
| </tr> |
| <tr> |
| <td><a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.AttributeFactory.html">AttributeSource.AttributeFactory</a></td> |
| <td><span class="parametername">factory</span></td> |
| <td><p><a class="xref" href="../Lucene.Net/Lucene.Net.Util.AttributeSource.AttributeFactory.html">AttributeSource.AttributeFactory</a> to use </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p><span class="xref">System.IO.TextReader</span> holding the input to be tokenized </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minGram</span></td> |
| <td><p>the smallest n-gram to generate </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxGram</span></td> |
| <td><p>the largest n-gram to generate </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_Lucene_Net_Util_LuceneVersion_System_IO_TextReader_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.%23ctor(Lucene.Net.Util.LuceneVersion%2CSystem.IO.TextReader)%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L167">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_Lucene_Net_Util_LuceneVersion_System_IO_TextReader_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.#ctor(Lucene.Net.Util.LuceneVersion,System.IO.TextReader)">NGramTokenizer(LuceneVersion, TextReader)</h4> |
| <div class="markdown level1 summary"><p>Creates <a class="xref" href="Lucene.Net.Analysis.NGram.NGramTokenizer.html">NGramTokenizer</a> with default min and max n-grams. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public NGramTokenizer(LuceneVersion version, TextReader 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/Lucene.Net.Util.LuceneVersion.html">LuceneVersion</a></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>the lucene compatibility version </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p><span class="xref">System.IO.TextReader</span> holding the input to be tokenized </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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_Lucene_Net_Util_LuceneVersion_System_IO_TextReader_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.%23ctor(Lucene.Net.Util.LuceneVersion%2CSystem.IO.TextReader%2CSystem.Int32%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L140">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer__ctor_Lucene_Net_Util_LuceneVersion_System_IO_TextReader_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.#ctor(Lucene.Net.Util.LuceneVersion,System.IO.TextReader,System.Int32,System.Int32)">NGramTokenizer(LuceneVersion, TextReader, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Creates <a class="xref" href="Lucene.Net.Analysis.NGram.NGramTokenizer.html">NGramTokenizer</a> with given min and max n-grams. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public NGramTokenizer(LuceneVersion version, TextReader input, int minGram, int maxGram)</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.LuceneVersion.html">LuceneVersion</a></td> |
| <td><span class="parametername">version</span></td> |
| <td><p>the lucene compatibility version </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.IO.TextReader</span></td> |
| <td><span class="parametername">input</span></td> |
| <td><p><span class="xref">System.IO.TextReader</span> holding the input to be tokenized </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">minGram</span></td> |
| <td><p>the smallest n-gram to generate </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">maxGram</span></td> |
| <td><p>the largest n-gram to generate </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_NGram_NGramTokenizer_DEFAULT_MAX_NGRAM_SIZE.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.DEFAULT_MAX_NGRAM_SIZE%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L109">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer_DEFAULT_MAX_NGRAM_SIZE" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.DEFAULT_MAX_NGRAM_SIZE">DEFAULT_MAX_NGRAM_SIZE</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 const int DEFAULT_MAX_NGRAM_SIZE = 2</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">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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_NGram_NGramTokenizer_DEFAULT_MIN_NGRAM_SIZE.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.DEFAULT_MIN_NGRAM_SIZE%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L108">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer_DEFAULT_MIN_NGRAM_SIZE" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.DEFAULT_MIN_NGRAM_SIZE">DEFAULT_MIN_NGRAM_SIZE</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 const int DEFAULT_MIN_NGRAM_SIZE = 1</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">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-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_NGram_NGramTokenizer_End.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.End%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L294">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_NGram_NGramTokenizer_End_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.End*"></a> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer_End" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.End">End()</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 override sealed void End()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html#Lucene_Net_Analysis_TokenStream_End">TokenStream.End()</a></div> |
| <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_Analysis_NGram_NGramTokenizer_IncrementToken.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.IncrementToken%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L206">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_NGram_NGramTokenizer_IncrementToken_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.IncrementToken*"></a> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer_IncrementToken" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.IncrementToken">IncrementToken()</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 override sealed bool IncrementToken()</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">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.TokenStream.html#Lucene_Net_Analysis_TokenStream_IncrementToken">TokenStream.IncrementToken()</a></div> |
| <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_Analysis_NGram_NGramTokenizer_IsTokenChar_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.IsTokenChar(System.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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L289">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_NGram_NGramTokenizer_IsTokenChar_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.IsTokenChar*"></a> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer_IsTokenChar_System_Int32_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.IsTokenChar(System.Int32)">IsTokenChar(Int32)</h4> |
| <div class="markdown level1 summary"><p>Only collect characters which satisfy this condition. </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual bool IsTokenChar(int chr)</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">chr</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Boolean</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs-4.8.0-beta00007/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_NGram_NGramTokenizer_Reset.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer.Reset%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L308">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_NGram_NGramTokenizer_Reset_" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.Reset*"></a> |
| <h4 id="Lucene_Net_Analysis_NGram_NGramTokenizer_Reset" data-uid="Lucene.Net.Analysis.NGram.NGramTokenizer.Reset">Reset()</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 override sealed void Reset()</code></pre> |
| </div> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="../Lucene.Net/Lucene.Net.Analysis.Tokenizer.html#Lucene_Net_Analysis_Tokenizer_Reset">Tokenizer.Reset()</a></div> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <span class="xref">System.IDisposable</span> |
| </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_Analysis_NGram_NGramTokenizer.md&value=---%0Auid%3A%20Lucene.Net.Analysis.NGram.NGramTokenizer%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.Analysis.Common/Analysis/NGram/NGramTokenizer.cs/#L106" 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> |
