| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class HyphenationTree |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class HyphenationTree |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation "> |
| <meta name="generator" content="docfx 2.56.2.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-common/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"> |
| <span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span> |
| <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.Compound.Hyphenation.HyphenationTree"> |
| |
| |
| <h1 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree" class="text-break">Class HyphenationTree |
| </h1> |
| <div class="markdown level0 summary"><p>This tree structure stores the hyphenation patterns in an efficient way for |
| fast lookup. It provides the provides the method to hyphenate a word. |
| <p> |
| This class has been taken from the Apache FOP project (<a href="http://xmlgraphics.apache.org/fop/">http://xmlgraphics.apache.org/fop/</a>). They have been slightly modified. </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.Analysis.Compound.Hyphenation.TernaryTree.html">TernaryTree</a></div> |
| <div class="level2"><span class="xref">HyphenationTree</span></div> |
| </div> |
| <div classs="implements"> |
| <h5>Implements</h5> |
| <div><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.IPatternConsumer.html">IPatternConsumer</a></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_lo">TernaryTree.m_lo</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_hi">TernaryTree.m_hi</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_eq">TernaryTree.m_eq</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_sc">TernaryTree.m_sc</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_kv">TernaryTree.m_kv</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_root">TernaryTree.m_root</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_freenode">TernaryTree.m_freenode</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_m_length">TernaryTree.m_length</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_BLOCK_SIZE">TernaryTree.BLOCK_SIZE</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Init">TernaryTree.Init()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Insert_System_String_System_Char_">TernaryTree.Insert(String, Char)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Insert_System_Char___System_Int32_System_Char_">TernaryTree.Insert(Char[], Int32, Char)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_StrCmp_System_Char___System_Int32_System_Char___System_Int32_">TernaryTree.StrCmp(Char[], Int32, Char[], Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_StrCmp_System_String_System_Char___System_Int32_">TernaryTree.StrCmp(String, Char[], Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_StrCpy_System_Char___System_Int32_System_Char___System_Int32_">TernaryTree.StrCpy(Char[], Int32, Char[], Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_StrLen_System_Char___System_Int32_">TernaryTree.StrLen(Char[], Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_StrLen_System_Char___">TernaryTree.StrLen(Char[])</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Find_System_String_">TernaryTree.Find(String)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Find_System_Char___System_Int32_">TernaryTree.Find(Char[], Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Knows_System_String_">TernaryTree.Knows(String)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Length">TernaryTree.Length</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Clone">TernaryTree.Clone()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_InsertBalanced_System_String___System_Char___System_Int32_System_Int32_">TernaryTree.InsertBalanced(String[], Char[], Int32, Int32)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_Balance">TernaryTree.Balance()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_TrimToSize">TernaryTree.TrimToSize()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_GetEnumerator">TernaryTree.GetEnumerator()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html#Lucene_Net_Analysis_Compound_Hyphenation_TernaryTree_PrintStats_System_IO_TextWriter_">TernaryTree.PrintStats(TextWriter)</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.Analysis.Compound.Hyphenation.html">Lucene.Net.Analysis.Compound.Hyphenation</a></h6> |
| <h6><strong>Assembly</strong>: Lucene.Net.Analysis.Common.dll</h6> |
| <h5 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class HyphenationTree : TernaryTree, IPatternConsumer</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree__ctor.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L58">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree__ctor_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.#ctor*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree__ctor" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.#ctor">HyphenationTree()</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 HyphenationTree()</code></pre> |
| </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_m_classmap.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.m_classmap%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L48">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_m_classmap" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.m_classmap">m_classmap</h4> |
| <div class="markdown level1 summary"><p>This map stores the character classes</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected TernaryTree m_classmap</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><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.TernaryTree.html">TernaryTree</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_m_stoplist.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.m_stoplist%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L43">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_m_stoplist" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.m_stoplist">m_stoplist</h4> |
| <div class="markdown level1 summary"><p>This map stores hyphenation exceptions</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected IDictionary<string, IList<object>> m_stoplist</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.Collections.Generic.IDictionary</span><<span class="xref">System.String</span>, <span class="xref">System.Collections.Generic.IList</span><<span class="xref">System.Object</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_m_vspace.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.m_vspace%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L38">View Source</a> |
| </span> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_m_vspace" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.m_vspace">m_vspace</h4> |
| <div class="markdown level1 summary"><p>value space: stores the interletter values</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected ByteVector m_vspace</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><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.ByteVector.html">ByteVector</a></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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddClass_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddClass(System.String)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L542">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddClass_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddClass*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddClass_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddClass(System.String)">AddClass(String)</h4> |
| <div class="markdown level1 summary"><p>Add a character class to the tree. It is used by |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html">PatternParser</a> as callback to add character classes. |
| Character classes define the valid word characters for hyphenation. If a |
| word contains a character not defined in any of the classes, it is not |
| hyphenated. It also defines a way to normalize the characters in order to |
| compare them with the stored patterns. Usually pattern files use only lower |
| case characters, in this case a class for letter 'a', for example, should |
| be defined as "aA", the first character being the normalization char.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void AddClass(string chargroup)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">chargroup</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddException_System_String_System_Collections_Generic_IList_System_Object__.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddException(System.String%2CSystem.Collections.Generic.IList%7BSystem.Object%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L565">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddException_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddException*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddException_System_String_System_Collections_Generic_IList_System_Object__" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddException(System.String,System.Collections.Generic.IList{System.Object})">AddException(String, IList<Object>)</h4> |
| <div class="markdown level1 summary"><p>Add an exception to the tree. It is used by |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html">PatternParser</a> class as callback to store the |
| hyphenation exceptions.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void AddException(string word, IList<object> hyphenatedword)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">word</span></td> |
| <td><p>normalized word </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Collections.Generic.IList</span><<span class="xref">System.Object</span>></td> |
| <td><span class="parametername">hyphenatedword</span></td> |
| <td><p>a vector of alternating strings and |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.Hyphen.html">Hyphen</a> objects. </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddPattern_System_String_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddPattern(System.String%2CSystem.String)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L579">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddPattern_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddPattern*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_AddPattern_System_String_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.AddPattern(System.String,System.String)">AddPattern(String, String)</h4> |
| <div class="markdown level1 summary"><p>Add a pattern to the tree. Mainly, to be used by |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.PatternParser.html">PatternParser</a> class as callback to add a pattern to |
| the tree.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void AddPattern(string pattern, string ivalue)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">pattern</span></td> |
| <td><p>the hyphenation pattern </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">ivalue</span></td> |
| <td><p>interletter weight values indicating the desirability and |
| priority of hyphenating at a given point within the pattern. It |
| should contain only digit characters. (i.e. '0' to '9'). </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_FindPattern_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.FindPattern(System.String)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L219">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_FindPattern_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.FindPattern*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_FindPattern_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.FindPattern(System.String)">FindPattern(String)</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 virtual string FindPattern(string pat)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">pat</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.String</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_GetValues_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.GetValues(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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L248">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_GetValues_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.GetValues*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_GetValues_System_Int32_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.GetValues(System.Int32)">GetValues(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">protected virtual byte[] GetValues(int k)</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">k</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.Byte</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_HStrCmp_System_Char___System_Int32_System_Char___System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.HStrCmp(System.Char%5B%5D%2CSystem.Int32%2CSystem.Char%5B%5D%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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L232">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_HStrCmp_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.HStrCmp*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_HStrCmp_System_Char___System_Int32_System_Char___System_Int32_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.HStrCmp(System.Char[],System.Int32,System.Char[],System.Int32)">HStrCmp(Char[], Int32, Char[], Int32)</h4> |
| <div class="markdown level1 summary"><p>String compare, returns 0 if equal or t is a substring of s</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual int HStrCmp(char[] s, int si, char[] t, int ti)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Char</span>[]</td> |
| <td><span class="parametername">s</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">si</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Char</span>[]</td> |
| <td><span class="parametername">t</span></td> |
| <td></td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">ti</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.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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Hyphenate_System_Char___System_Int32_System_Int32_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.Hyphenate(System.Char%5B%5D%2CSystem.Int32%2CSystem.Int32%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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L418">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Hyphenate_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.Hyphenate*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Hyphenate_System_Char___System_Int32_System_Int32_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.Hyphenate(System.Char[],System.Int32,System.Int32,System.Int32,System.Int32)">Hyphenate(Char[], Int32, Int32, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Hyphenate word and return an array of hyphenation points.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Hyphenation Hyphenate(char[] w, int offset, int len, int remainCharCount, int pushCharCount)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Char</span>[]</td> |
| <td><span class="parametername">w</span></td> |
| <td><p>char array that contains the word </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">offset</span></td> |
| <td><p>Offset to first character in word </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">len</span></td> |
| <td><p>Length of word </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">remainCharCount</span></td> |
| <td><p>Minimum number of characters allowed before the |
| hyphenation point. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">pushCharCount</span></td> |
| <td><p>Minimum number of characters allowed after the |
| hyphenation point. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.Hyphenation.html">Hyphenation</a></td> |
| <td><p>a <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.Hyphenation.html">Hyphenation</a> object representing the |
| hyphenated word or null if word is not hyphenated. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Hyphenate_System_Char___System_Int32_System_Int32_System_Int32_System_Int32__remarks">Remarks</h5> |
| <div class="markdown level1 remarks"><p>w = "*<strong><em>nnllllllnnn</em></strong><strong>", where n is a non-letter, l is a letter, all n |
| may be absent, the first n is at offset, the first l is at offset + |
| iIgnoreAtBeginning; word = ".llllll.'\0'</strong>*", where all l in w are copied |
| into word. In the first part of the routine len = w.length, in the second |
| part of the routine len = word.length. Three indices are used: index(w), |
| the index in w, index(word), the index in word, letterindex(word), the |
| index in the letter part of word. The following relations exist: index(w) = |
| offset + i - 1 index(word) = i - iIgnoreAtBeginning letterindex(word) = |
| index(word) - 1 (see first loop). It follows that: index(w) - index(word) = |
| offset - 1 + iIgnoreAtBeginning index(w) = letterindex(word) + offset + |
| iIgnoreAtBeginning</p> |
| </div> |
| <span class="small pull-right mobile-hide"> |
| <span class="divider">|</span> |
| <a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Hyphenate_System_String_System_Int32_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.Hyphenate(System.String%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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L385">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Hyphenate_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.Hyphenate*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_Hyphenate_System_String_System_Int32_System_Int32_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.Hyphenate(System.String,System.Int32,System.Int32)">Hyphenate(String, Int32, Int32)</h4> |
| <div class="markdown level1 summary"><p>Hyphenate word and return a <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.Hyphenation.html">Hyphenation</a> object.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual Hyphenation Hyphenate(string word, int remainCharCount, int pushCharCount)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">word</span></td> |
| <td><p>the word to be hyphenated </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">remainCharCount</span></td> |
| <td><p>Minimum number of characters allowed before the |
| hyphenation point. </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">pushCharCount</span></td> |
| <td><p>Minimum number of characters allowed after the |
| hyphenation point. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.Hyphenation.html">Hyphenation</a></td> |
| <td><p>a <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.Hyphenation.html">Hyphenation</a> object representing the |
| hyphenated word or null if word is not hyphenated. </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_FileInfo_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.FileInfo)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L144">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_FileInfo_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.FileInfo)">LoadPatterns(FileInfo)</h4> |
| <div class="markdown level1 summary"><p>Read hyphenation patterns from an XML file.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void LoadPatterns(FileInfo f)</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.IO.FileInfo</span></td> |
| <td><span class="parametername">f</span></td> |
| <td><p>a <span class="xref">System.IO.FileInfo</span> object representing the file </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>In case the parsing fails </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_FileInfo_System_Text_Encoding_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.FileInfo%2CSystem.Text.Encoding)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L155">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_FileInfo_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.FileInfo,System.Text.Encoding)">LoadPatterns(FileInfo, Encoding)</h4> |
| <div class="markdown level1 summary"><p>Read hyphenation patterns from an XML file.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void LoadPatterns(FileInfo f, Encoding encoding)</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.IO.FileInfo</span></td> |
| <td><span class="parametername">f</span></td> |
| <td><p>a <span class="xref">System.IO.FileInfo</span> object representing the file </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Text.Encoding</span></td> |
| <td><span class="parametername">encoding</span></td> |
| <td><p>The character encoding to use</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>In case the parsing fails </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_Stream_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.Stream)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L166">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_Stream_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.Stream)">LoadPatterns(Stream)</h4> |
| <div class="markdown level1 summary"><p>Read hyphenation patterns from an XML file.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void LoadPatterns(Stream source)</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.IO.Stream</span></td> |
| <td><span class="parametername">source</span></td> |
| <td><p><span class="xref">System.IO.Stream</span> input source for the file </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>In case the parsing fails </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_Stream_System_Text_Encoding_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.Stream%2CSystem.Text.Encoding)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L177">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_IO_Stream_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.IO.Stream,System.Text.Encoding)">LoadPatterns(Stream, Encoding)</h4> |
| <div class="markdown level1 summary"><p>Read hyphenation patterns from an XML file.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void LoadPatterns(Stream source, Encoding encoding)</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.IO.Stream</span></td> |
| <td><span class="parametername">source</span></td> |
| <td><p><span class="xref">System.IO.Stream</span> input source for the file </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Text.Encoding</span></td> |
| <td><span class="parametername">encoding</span></td> |
| <td><p>The character encoding to use</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>In case the parsing fails </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.String)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L122">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.String)">LoadPatterns(String)</h4> |
| <div class="markdown level1 summary"><p>Read hyphenation patterns from an XML file.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void LoadPatterns(string filename)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">filename</span></td> |
| <td><p>the filename </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>In case the parsing fails </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_String_System_Text_Encoding_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.String%2CSystem.Text.Encoding)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L133">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_String_System_Text_Encoding_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.String,System.Text.Encoding)">LoadPatterns(String, Encoding)</h4> |
| <div class="markdown level1 summary"><p>Read hyphenation patterns from an XML file.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void LoadPatterns(string filename, Encoding encoding)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">filename</span></td> |
| <td><p>the filename </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Text.Encoding</span></td> |
| <td><span class="parametername">encoding</span></td> |
| <td><p>The character encoding to use</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>In case the parsing fails </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_Xml_XmlReader_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.Xml.XmlReader)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L202">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_LoadPatterns_System_Xml_XmlReader_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.LoadPatterns(System.Xml.XmlReader)">LoadPatterns(XmlReader)</h4> |
| <div class="markdown level1 summary"><p>Read hyphenation patterns from an <span class="xref">System.Xml.XmlReader</span>.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public virtual void LoadPatterns(XmlReader source)</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.Xml.XmlReader</span></td> |
| <td><span class="parametername">source</span></td> |
| <td><p><span class="xref">System.Xml.XmlReader</span> input source for the file </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>In case the parsing fails </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_PackValues_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.PackValues(System.String)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L74">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_PackValues_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.PackValues*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_PackValues_System_String_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.PackValues(System.String)">PackValues(String)</h4> |
| <div class="markdown level1 summary"><p>Packs the values by storing them in 4 bits, two values into a byte Values |
| range is from 0 to 9. We use zero as terminator, so we'll add 1 to the |
| value.</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual int PackValues(string values)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.String</span></td> |
| <td><span class="parametername">values</span></td> |
| <td><p>a string of digits from '0' to '9' representing the |
| interletter values. </p> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="returns">Returns</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><p>the index into the vspace array where the packed values are stored. </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_SearchPatterns_System_Char___System_Int32_System_Byte___.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.SearchPatterns(System.Char%5B%5D%2CSystem.Int32%2CSystem.Byte%5B%5D)%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L299">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_SearchPatterns_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.SearchPatterns*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_SearchPatterns_System_Char___System_Int32_System_Byte___" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.SearchPatterns(System.Char[],System.Int32,System.Byte[])">SearchPatterns(Char[], Int32, Byte[])</h4> |
| <div class="markdown level1 summary"><p> |
| Search for all possible partial matches of word starting at index an update |
| interletter values. In other words, it does something like: |
| </p> |
| <pre><code>for (i=0; i<patterns.Length; i++) |
| { |
| if (word.Substring(index).StartsWith(patterns[i], StringComparison.Ordinal)) |
| update_interletter_values(patterns[i]); |
| }</code></pre> |
| <p> |
| But it is done in an efficient way since the patterns are stored in a |
| ternary tree. In fact, this is the whole purpose of having the tree: doing |
| this search without having to test every single pattern. The number of |
| patterns for languages such as English range from 4000 to 10000. Thus, |
| doing thousands of string comparisons for each word to hyphenate would be |
| really slow without the tree. The tradeoff is memory, but using a ternary |
| tree instead of a trie, almost halves the the memory used by Lout or TeX. |
| It's also faster than using a hash table |
| </p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">protected virtual void SearchPatterns(char[] word, int index, byte[] il)</code></pre> |
| </div> |
| <h5 class="parameters">Parameters</h5> |
| <table class="table table-bordered table-striped table-condensed"> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Name</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td><span class="xref">System.Char</span>[]</td> |
| <td><span class="parametername">word</span></td> |
| <td><p>null terminated word to match </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Int32</span></td> |
| <td><span class="parametername">index</span></td> |
| <td><p>start index from word </p> |
| </td> |
| </tr> |
| <tr> |
| <td><span class="xref">System.Byte</span>[]</td> |
| <td><span class="parametername">il</span></td> |
| <td><p>interletter values array to update </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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_UnpackValues_System_Int32_.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.UnpackValues(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/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L97">View Source</a> |
| </span> |
| <a id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_UnpackValues_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.UnpackValues*"></a> |
| <h4 id="Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree_UnpackValues_System_Int32_" data-uid="Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree.UnpackValues(System.Int32)">UnpackValues(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">protected virtual string UnpackValues(int k)</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">k</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.String</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h3 id="implements">Implements</h3> |
| <div> |
| <a class="xref" href="Lucene.Net.Analysis.Compound.Hyphenation.IPatternConsumer.html">IPatternConsumer</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-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Analysis_Compound_Hyphenation_HyphenationTree.md&value=---%0Auid%3A%20Lucene.Net.Analysis.Compound.Hyphenation.HyphenationTree%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/fix/apidocs-layout/src/Lucene.Net.Analysis.Common/Analysis/Compound/Hyphenation/HyphenationTree.cs/#L33" 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 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small> |
| |
| </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> |
