blob: 497d54efcd4d8e8677ab2321be910f36b40c43af [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Namespace Egothor.Stemmer
| Apache Lucene.NET 4.8.0-beta00010 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Namespace Egothor.Stemmer
| Apache Lucene.NET 4.8.0-beta00010 Documentation ">
<meta name="generator" content="docfx 2.56.0.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="analysis-stempel/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Egothor.Stemmer">
<h1 id="Egothor_Stemmer" data-uid="Egothor.Stemmer" class="text-break">Namespace Egothor.Stemmer
</h1>
<div class="markdown level0 summary"><!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<p>Egothor stemmer API.</p>
</div>
<div class="markdown level0 conceptual"></div>
<div class="markdown level0 remarks"></div>
<h3 id="classes">Classes
</h3>
<h4><a class="xref" href="Egothor.Stemmer.Cell.html">Cell</a></h4>
<section><p>A <a class="xref" href="Egothor.Stemmer.Cell.html">Cell</a> is a portion of a <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a>.</p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Compile.html">Compile</a></h4>
<section><p>The Compile class is used to compile a stemmer table.</p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Diff.html">Diff</a></h4>
<section><p>The Diff object generates a patch string.
<p>
A patch string is actually a command to a stemmer telling it how to reduce a
word to its root. For example, to reduce the word teacher to its root teach
the patch string Db would be generated. This command tells the stemmer to
delete the last 2 characters from the word teacher to reach the stem (the
patch commands are applied starting from the last character in order to save
</p></p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.DiffIt.html">DiffIt</a></h4>
<section><p>The DiffIt class is a means generate patch commands from an already prepared
stemmer table.</p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Gener.html">Gener</a></h4>
<section><p>The Gener object helps in the discarding of nodes which break the reduction
effort and defend the structure against large reductions.</p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Lift.html">Lift</a></h4>
<section><p>The Lift class is a data structure that is a variation of a Patricia trie.
<p>
Lift&apos;s <em>raison d&apos;etre</em> is to implement reduction of the trie via the
Lift-Up method., which makes the data structure less liable to overstemming.
</p></p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.MultiTrie.html">MultiTrie</a></h4>
<section><p>The <a class="xref" href="Egothor.Stemmer.MultiTrie.html">MultiTrie</a> is a <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a> of <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a>s. It stores words and their associated patch
commands. The <a class="xref" href="Egothor.Stemmer.MultiTrie.html">MultiTrie</a> handles patch commands individually (each command by
itself).</p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.MultiTrie2.html">MultiTrie2</a></h4>
<section><p>The <a class="xref" href="Egothor.Stemmer.MultiTrie.html">MultiTrie</a> is a <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a> of <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a>s.
<p>
It stores words and their associated patch commands. The <a class="xref" href="Egothor.Stemmer.MultiTrie.html">MultiTrie</a> handles
patch commands broken into their constituent parts, as a <a class="xref" href="Egothor.Stemmer.MultiTrie.html">MultiTrie</a> does, but
the commands are delimited by the skip command.
</p></p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Optimizer.html">Optimizer</a></h4>
<section><p>The <a class="xref" href="Egothor.Stemmer.Optimizer.html">Optimizer</a> class is a <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a> that will be reduced (have empty rows removed).
<p>
The reduction will be made by joining two rows where the first is a subset of
the second.
</p></p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Optimizer2.html">Optimizer2</a></h4>
<section><p>The Optimizer class is a Trie that will be reduced (have empty rows removed).
<p>
This is the result of allowing a joining of rows when there is no collision
between non-<code>null</code> values in the rows. Information loss, resulting in
the stemmer not being able to recognize words (as in Optimizer), is
curtailed, allowing the stemmer to recognize words for which the original
trie was built. Use of this class allows the stemmer to be self-teaching.
</p></p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Reduce.html">Reduce</a></h4>
<section><p>The <a class="xref" href="Egothor.Stemmer.Reduce.html">Reduce</a> object is used to remove gaps in a <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a> which stores a dictionary.</p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Row.html">Row</a></h4>
<section><p>The <a class="xref" href="Egothor.Stemmer.Row.html">Row</a> class represents a row in a matrix representation of a <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a>.</p>
</section>
<h4><a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a></h4>
<section><p>A <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a> is used to store a dictionary of words and their stems.
<p>
Actually, what is stored are words with their respective patch commands. A
trie can be termed forward (keys read from left to right) or backward (keys
read from right to left). This property will vary depending on the language
for which a <a class="xref" href="Egothor.Stemmer.Trie.html">Trie</a> is constructed.
</p></p>
</section>
</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/blob/docs/4.8.0-beta00010/src/Lucene.Net.Analysis.Stempel/Egothor.Stemmer/package.md/#L2" class="contribution-link">Improve this Doc</a>
</li>
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
Copyright © 2020 Licensed to the Apache Software Foundation (ASF)
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>