You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucy.apache.org by bu...@apache.org on 2016/04/04 14:55:29 UTC
svn commit: r984685 [4/14] - in /websites/staging/lucy/trunk/content: ./
css/ docs/ docs/c/ docs/c/Clownfish/ docs/c/Clownfish/Docs/ docs/c/Lucy/
docs/c/Lucy/Analysis/ docs/c/Lucy/Docs/ docs/c/Lucy/Docs/Cookbook/
docs/c/Lucy/Docs/Tutorial/ docs/c/Lucy/...
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/EasyAnalyzer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/EasyAnalyzer.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/EasyAnalyzer.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,270 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::EasyAnalyzer â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::EasyAnalyzer</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>EASYANALYZER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>EasyAnalyzer</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>EasyAnalyzer</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/EasyAnalyzer.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::EasyAnalyzer â A simple analyzer chain.</p>
+<h3>Description</h3>
+<p>EasyAnalyzer is an analyzer chain consisting of a
+<a href="../../Lucy/Analysis/StandardTokenizer.html">StandardTokenizer</a>, a
+<a href="../../Lucy/Analysis/Normalizer.html">Normalizer</a>, and a
+<a href="../../Lucy/Analysis/SnowballStemmer.html">SnowballStemmer</a>.</p>
+<p>Supported languages:</p>
+<pre><code>en => English,
+da => Danish,
+de => German,
+es => Spanish,
+fi => Finnish,
+fr => French,
+hu => Hungarian,
+it => Italian,
+nl => Dutch,
+no => Norwegian,
+pt => Portuguese,
+ro => Romanian,
+ru => Russian,
+sv => Swedish,
+tr => Turkish,
+</code></pre>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>EasyAnalyzer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>
+);
+</code></pre>
+<p>Create a new EasyAnalyzer.</p>
+<dl>
+<dt>language</dt>
+<dd><p>An ISO code from the list of supported languages.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>EasyAnalyzer*
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_init</strong>(
+ <span class="prefix">lucy_</span>EasyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>
+);
+</code></pre>
+<p>Initialize an EasyAnalyzer.</p>
+<dl>
+<dt>language</dt>
+<dd><p>An ISO code from the list of supported languages.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Transform">Transform</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_Transform</strong>(
+ <span class="prefix">lucy_</span>EasyAnalyzer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a> *<strong>inversion</strong>
+);
+</code></pre>
+<p>Take a single <a href="../../Lucy/Analysis/Inversion.html">Inversion</a> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.</p>
+<dl>
+<dt>inversion</dt>
+<dd><p>An inversion.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Transform_Text">Transform_Text</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_Transform_Text</strong>(
+ <span class="prefix">lucy_</span>EasyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong>
+);
+</code></pre>
+<p>Kick off an analysis chain, creating an Inversion from string input.
+The default implementation simply creates an initial Inversion with a
+single Token, then calls <a href="../../Lucy/Analysis/EasyAnalyzer.html#func_Transform">Transform()</a>, but occasionally subclasses will
+provide an optimized implementation which minimizes string copies.</p>
+<dl>
+<dt>text</dt>
+<dd><p>A string.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Hash.html">Hash</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_Dump</strong>(
+ <span class="prefix">lucy_</span>EasyAnalyzer *<strong>self</strong>
+);
+</code></pre>
+<p>Dump the analyzer as hash.</p>
+<p>Subclasses should call <a href="../../Lucy/Analysis/EasyAnalyzer.html#func_Dump">Dump()</a> on the superclass. The returned
+object is a hash which should be populated with parameters of
+the analyzer.</p>
+<p><strong>Returns:</strong> A hash containing a description of the analyzer.</p>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>EasyAnalyzer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_Load</strong>(
+ <span class="prefix">lucy_</span>EasyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+<p>Reconstruct an analyzer from a dump.</p>
+<p>Subclasses should first call <a href="../../Lucy/Analysis/EasyAnalyzer.html#func_Load">Load()</a> on the superclass. The
+returned object is an analyzer which should be reconstructed by
+setting the dumped parameters from the hash contained in <code>dump</code>.</p>
+<p>Note that the invocant analyzer is unused.</p>
+<dl>
+<dt>dump</dt>
+<dd><p>A hash.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> An analyzer.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_Equals</strong>(
+ <span class="prefix">lucy_</span>EasyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>EasyAnalyzer_Destroy</strong>(
+ <span class="prefix">lucy_</span>EasyAnalyzer *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::EasyAnalyzer is a <a href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/Inversion.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/Inversion.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/Inversion.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,187 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::Inversion â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::Inversion</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>INVERSION</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Inversion</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Inversion</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/Inversion.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::Inversion â A collection of Tokens.</p>
+<h3>Description</h3>
+<p>An Inversion is a collection of Token objects which you can add to, then
+iterate over.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Inversion* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Inversion_new</strong>(
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Token.html">Token</a> *<strong>seed</strong>
+);
+</code></pre>
+<p>Create a new Inversion.</p>
+<dl>
+<dt>seed</dt>
+<dd><p>An initial Token to start things off, which may be
+NULL.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Append">Append</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Inversion_Append</strong>(
+ <span class="prefix">lucy_</span>Inversion *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Token.html">Token</a> *<strong>token</strong> <span class="comment">// decremented</span>
+);
+</code></pre>
+<p>Tack a token onto the end of the Inversion.</p>
+<dl>
+<dt>token</dt>
+<dd><p>A Token.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Next">Next</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Token.html">Token</a>*
+<span class="prefix">lucy_</span><strong>Inversion_Next</strong>(
+ <span class="prefix">lucy_</span>Inversion *<strong>self</strong>
+);
+</code></pre>
+<p>Return the next token in the Inversion until out of tokens.</p>
+</dd>
+<dt id="func_Reset">Reset</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Inversion_Reset</strong>(
+ <span class="prefix">lucy_</span>Inversion *<strong>self</strong>
+);
+</code></pre>
+<p>Reset the Inversionâs iterator, so that the next call to next()
+returns the first Token in the inversion.</p>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Inversion_Destroy</strong>(
+ <span class="prefix">lucy_</span>Inversion *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::Inversion is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/Normalizer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/Normalizer.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/Normalizer.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,245 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::Normalizer â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::Normalizer</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>NORMALIZER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Normalizer</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Normalizer</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/Normalizer.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::Normalizer â Unicode normalization, case folding and accent stripping.</p>
+<h3>Description</h3>
+<p>Normalizer is an <a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> which normalizes
+tokens to one of the Unicode normalization forms. Optionally, it
+performs Unicode case folding and converts accented characters to their
+base character.</p>
+<p>If you use highlighting, Normalizer should be run after tokenization
+because it might add or remove characters.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Normalizer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Normalizer_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>normalization_form</strong>,
+ bool <strong>case_fold</strong>,
+ bool <strong>strip_accents</strong>
+);
+</code></pre>
+<p>Create a new Normalizer.</p>
+<dl>
+<dt>normalization_form</dt>
+<dd><p>Unicode normalization form, can be one of
+âNFCâ, âNFKCâ, âNFDâ, âNFKDâ. Defaults to âNFKCâ.</p>
+</dd>
+<dt>case_fold</dt>
+<dd><p>Perform case folding, default is true.</p>
+</dd>
+<dt>strip_accents</dt>
+<dd><p>Strip accents, default is false.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Normalizer*
+<span class="prefix">lucy_</span><strong>Normalizer_init</strong>(
+ <span class="prefix">lucy_</span>Normalizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>normalization_form</strong>,
+ bool <strong>case_fold</strong>,
+ bool <strong>strip_accents</strong>
+);
+</code></pre>
+<p>Initialize a Normalizer.</p>
+<dl>
+<dt>normalization_form</dt>
+<dd><p>Unicode normalization form, can be one of
+âNFCâ, âNFKCâ, âNFDâ, âNFKDâ. Defaults to âNFKCâ.</p>
+</dd>
+<dt>case_fold</dt>
+<dd><p>Perform case folding, default is true.</p>
+</dd>
+<dt>strip_accents</dt>
+<dd><p>Strip accents, default is false.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Transform">Transform</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Normalizer_Transform</strong>(
+ <span class="prefix">lucy_</span>Normalizer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a> *<strong>inversion</strong>
+);
+</code></pre>
+<p>Take a single <a href="../../Lucy/Analysis/Inversion.html">Inversion</a> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.</p>
+<dl>
+<dt>inversion</dt>
+<dd><p>An inversion.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Hash.html">Hash</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Normalizer_Dump</strong>(
+ <span class="prefix">lucy_</span>Normalizer *<strong>self</strong>
+);
+</code></pre>
+<p>Dump the analyzer as hash.</p>
+<p>Subclasses should call <a href="../../Lucy/Analysis/Normalizer.html#func_Dump">Dump()</a> on the superclass. The returned
+object is a hash which should be populated with parameters of
+the analyzer.</p>
+<p><strong>Returns:</strong> A hash containing a description of the analyzer.</p>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Normalizer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Normalizer_Load</strong>(
+ <span class="prefix">lucy_</span>Normalizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+<p>Reconstruct an analyzer from a dump.</p>
+<p>Subclasses should first call <a href="../../Lucy/Analysis/Normalizer.html#func_Load">Load()</a> on the superclass. The
+returned object is an analyzer which should be reconstructed by
+setting the dumped parameters from the hash contained in <code>dump</code>.</p>
+<p>Note that the invocant analyzer is unused.</p>
+<dl>
+<dt>dump</dt>
+<dd><p>A hash.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> An analyzer.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Normalizer_Equals</strong>(
+ <span class="prefix">lucy_</span>Normalizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::Normalizer is a <a href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/PolyAnalyzer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/PolyAnalyzer.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/PolyAnalyzer.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,304 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::PolyAnalyzer â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::PolyAnalyzer</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>POLYANALYZER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>PolyAnalyzer</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>PolyAnalyzer</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/PolyAnalyzer.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::PolyAnalyzer â Multiple Analyzers in series.</p>
+<h3>Description</h3>
+<p>A PolyAnalyzer is a series of <a href="../../Lucy/Analysis/Analyzer.html">Analyzers</a>,
+each of which will be called upon to âanalyzeâ text in turn. You can
+either provide the Analyzers yourself, or you can specify a supported
+language, in which case a PolyAnalyzer consisting of a
+<a href="../../Lucy/Analysis/CaseFolder.html">CaseFolder</a>, a
+<a href="../../Lucy/Analysis/RegexTokenizer.html">RegexTokenizer</a>, and a
+<a href="../../Lucy/Analysis/SnowballStemmer.html">SnowballStemmer</a> will be generated for you.</p>
+<p>The language parameter is DEPRECATED. Use
+<a href="../../Lucy/Analysis/EasyAnalyzer.html">EasyAnalyzer</a> instead.</p>
+<p>Supported languages:</p>
+<pre><code>en => English,
+da => Danish,
+de => German,
+es => Spanish,
+fi => Finnish,
+fr => French,
+hu => Hungarian,
+it => Italian,
+nl => Dutch,
+no => Norwegian,
+pt => Portuguese,
+ro => Romanian,
+ru => Russian,
+sv => Swedish,
+tr => Turkish,
+</code></pre>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>PolyAnalyzer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>analyzers</strong>
+);
+</code></pre>
+<p>Create a new PolyAnalyzer.</p>
+<dl>
+<dt>language</dt>
+<dd><p>An ISO code from the list of supported languages.
+DEPRECATED, use <a href="../../Lucy/Analysis/EasyAnalyzer.html">EasyAnalyzer</a> instead.</p>
+</dd>
+<dt>analyzers</dt>
+<dd><p>An array of Analyzers. The order of the analyzers
+matters. Donât put a SnowballStemmer before a RegexTokenizer (canât stem whole
+documents or paragraphs â just individual words), or a SnowballStopFilter
+after a SnowballStemmer (stemmed words, e.g. âthemselvâ, will not appear in a
+stoplist). In general, the sequence should be: tokenize, normalize,
+stopalize, stem.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>PolyAnalyzer*
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_init</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>analyzers</strong>
+);
+</code></pre>
+<p>Initialize a PolyAnalyzer.</p>
+<dl>
+<dt>language</dt>
+<dd><p>An ISO code from the list of supported languages.
+DEPRECATED, use <a href="../../Lucy/Analysis/EasyAnalyzer.html">EasyAnalyzer</a> instead.</p>
+</dd>
+<dt>analyzers</dt>
+<dd><p>An array of Analyzers. The order of the analyzers
+matters. Donât put a SnowballStemmer before a RegexTokenizer (canât stem whole
+documents or paragraphs â just individual words), or a SnowballStopFilter
+after a SnowballStemmer (stemmed words, e.g. âthemselvâ, will not appear in a
+stoplist). In general, the sequence should be: tokenize, normalize,
+stopalize, stem.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get_Analyzers">Get_Analyzers</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>*
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_Get_Analyzers</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>
+);
+</code></pre>
+<p>Getter for âanalyzersâ member.</p>
+</dd>
+<dt id="func_Transform">Transform</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_Transform</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a> *<strong>inversion</strong>
+);
+</code></pre>
+<p>Take a single <a href="../../Lucy/Analysis/Inversion.html">Inversion</a> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.</p>
+<dl>
+<dt>inversion</dt>
+<dd><p>An inversion.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Transform_Text">Transform_Text</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_Transform_Text</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong>
+);
+</code></pre>
+<p>Kick off an analysis chain, creating an Inversion from string input.
+The default implementation simply creates an initial Inversion with a
+single Token, then calls <a href="../../Lucy/Analysis/PolyAnalyzer.html#func_Transform">Transform()</a>, but occasionally subclasses will
+provide an optimized implementation which minimizes string copies.</p>
+<dl>
+<dt>text</dt>
+<dd><p>A string.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_Equals</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_Dump</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>
+);
+</code></pre>
+<p>Dump the analyzer as hash.</p>
+<p>Subclasses should call <a href="../../Lucy/Analysis/PolyAnalyzer.html#func_Dump">Dump()</a> on the superclass. The returned
+object is a hash which should be populated with parameters of
+the analyzer.</p>
+<p><strong>Returns:</strong> A hash containing a description of the analyzer.</p>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>PolyAnalyzer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_Load</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+<p>Reconstruct an analyzer from a dump.</p>
+<p>Subclasses should first call <a href="../../Lucy/Analysis/PolyAnalyzer.html#func_Load">Load()</a> on the superclass. The
+returned object is an analyzer which should be reconstructed by
+setting the dumped parameters from the hash contained in <code>dump</code>.</p>
+<p>Note that the invocant analyzer is unused.</p>
+<dl>
+<dt>dump</dt>
+<dd><p>A hash.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> An analyzer.</p>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>PolyAnalyzer_Destroy</strong>(
+ <span class="prefix">lucy_</span>PolyAnalyzer *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::PolyAnalyzer is a <a href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/RegexTokenizer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/RegexTokenizer.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/RegexTokenizer.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,279 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::RegexTokenizer â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::RegexTokenizer</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>REGEXTOKENIZER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>RegexTokenizer</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>RegexTokenizer</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/RegexTokenizer.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::RegexTokenizer â Split a string into tokens.</p>
+<h3>Description</h3>
+<p>Generically, âtokenizingâ is a process of breaking up a string into an
+array of âtokensâ. For instance, the string âthree blind miceâ might be
+tokenized into âthreeâ, âblindâ, âmiceâ.</p>
+<p>Lucy::Analysis::RegexTokenizer decides where it should break up the text
+based on a regular expression compiled from a supplied <code>pattern</code>
+matching one token. If our source string isâ¦</p>
+<pre><code>"Eats, Shoots and Leaves."
+</code></pre>
+<p>⦠then a âwhitespace tokenizerâ with a <code>pattern</code> of
+<code>"\\S+"</code> producesâ¦</p>
+<pre><code>Eats,
+Shoots
+and
+Leaves.
+</code></pre>
+<p>⦠while a âword character tokenizerâ with a <code>pattern</code> of
+<code>"\\w+"</code> producesâ¦</p>
+<pre><code>Eats
+Shoots
+and
+Leaves
+</code></pre>
+<p>⦠the difference being that the word character tokenizer skips over
+punctuation as well as whitespace when determining token boundaries.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RegexTokenizer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>RegexTokenizer_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>pattern</strong>
+);
+</code></pre>
+<p>Create a new RegexTokenizer.</p>
+<dl>
+<dt>pattern</dt>
+<dd><p>A string specifying a Perl-syntax regular expression
+which should match one token. The default value is
+<code>\w+(?:[\x{2019}']\w+)*</code>, which matches âitâsâ as well as
+âitâ and âOâHenryâsâ as well as âHenryâ.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RegexTokenizer*
+<span class="prefix">lucy_</span><strong>RegexTokenizer_init</strong>(
+ <span class="prefix">lucy_</span>RegexTokenizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>pattern</strong>
+);
+</code></pre>
+<p>Initialize a RegexTokenizer.</p>
+<dl>
+<dt>pattern</dt>
+<dd><p>A string specifying a Perl-syntax regular expression
+which should match one token. The default value is
+<code>\w+(?:[\x{2019}']\w+)*</code>, which matches âitâsâ as well as
+âitâ and âOâHenryâsâ as well as âHenryâ.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Transform">Transform</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>RegexTokenizer_Transform</strong>(
+ <span class="prefix">lucy_</span>RegexTokenizer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a> *<strong>inversion</strong>
+);
+</code></pre>
+<p>Take a single <a href="../../Lucy/Analysis/Inversion.html">Inversion</a> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.</p>
+<dl>
+<dt>inversion</dt>
+<dd><p>An inversion.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Transform_Text">Transform_Text</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>RegexTokenizer_Transform_Text</strong>(
+ <span class="prefix">lucy_</span>RegexTokenizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong>
+);
+</code></pre>
+<p>Kick off an analysis chain, creating an Inversion from string input.
+The default implementation simply creates an initial Inversion with a
+single Token, then calls <a href="../../Lucy/Analysis/RegexTokenizer.html#func_Transform">Transform()</a>, but occasionally subclasses will
+provide an optimized implementation which minimizes string copies.</p>
+<dl>
+<dt>text</dt>
+<dd><p>A string.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>RegexTokenizer_Dump</strong>(
+ <span class="prefix">lucy_</span>RegexTokenizer *<strong>self</strong>
+);
+</code></pre>
+<p>Dump the analyzer as hash.</p>
+<p>Subclasses should call <a href="../../Lucy/Analysis/RegexTokenizer.html#func_Dump">Dump()</a> on the superclass. The returned
+object is a hash which should be populated with parameters of
+the analyzer.</p>
+<p><strong>Returns:</strong> A hash containing a description of the analyzer.</p>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>RegexTokenizer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>RegexTokenizer_Load</strong>(
+ <span class="prefix">lucy_</span>RegexTokenizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+<p>Reconstruct an analyzer from a dump.</p>
+<p>Subclasses should first call <a href="../../Lucy/Analysis/RegexTokenizer.html#func_Load">Load()</a> on the superclass. The
+returned object is an analyzer which should be reconstructed by
+setting the dumped parameters from the hash contained in <code>dump</code>.</p>
+<p>Note that the invocant analyzer is unused.</p>
+<dl>
+<dt>dump</dt>
+<dd><p>A hash.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> An analyzer.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>RegexTokenizer_Equals</strong>(
+ <span class="prefix">lucy_</span>RegexTokenizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>RegexTokenizer_Destroy</strong>(
+ <span class="prefix">lucy_</span>RegexTokenizer *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::RegexTokenizer is a <a href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/SnowballStemmer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/SnowballStemmer.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/SnowballStemmer.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,238 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::SnowballStemmer â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::SnowballStemmer</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>SNOWBALLSTEMMER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>SnowballStemmer</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>SnowStemmer</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/SnowballStemmer.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::SnowballStemmer â Reduce related words to a shared root.</p>
+<h3>Description</h3>
+<p>SnowballStemmer is an <a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> which reduces
+related words to a root form (using the âSnowballâ stemming library). For
+instance, âhorseâ, âhorsesâ, and âhorsingâ all become âhorsâ â so that a
+search for âhorseâ will also match documents containing âhorsesâ and
+âhorsingâ.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SnowballStemmer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStemmer_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>
+);
+</code></pre>
+<p>Create a new SnowballStemmer.</p>
+<dl>
+<dt>language</dt>
+<dd><p>A two-letter ISO code identifying a language supported
+by Snowball.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SnowballStemmer*
+<span class="prefix">lucy_</span><strong>SnowStemmer_init</strong>(
+ <span class="prefix">lucy_</span>SnowballStemmer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>
+);
+</code></pre>
+<p>Initialize a SnowballStemmer.</p>
+<dl>
+<dt>language</dt>
+<dd><p>A two-letter ISO code identifying a language supported
+by Snowball.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Transform">Transform</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStemmer_Transform</strong>(
+ <span class="prefix">lucy_</span>SnowballStemmer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a> *<strong>inversion</strong>
+);
+</code></pre>
+<p>Take a single <a href="../../Lucy/Analysis/Inversion.html">Inversion</a> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.</p>
+<dl>
+<dt>inversion</dt>
+<dd><p>An inversion.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Hash.html">Hash</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStemmer_Dump</strong>(
+ <span class="prefix">lucy_</span>SnowballStemmer *<strong>self</strong>
+);
+</code></pre>
+<p>Dump the analyzer as hash.</p>
+<p>Subclasses should call <a href="../../Lucy/Analysis/SnowballStemmer.html#func_Dump">Dump()</a> on the superclass. The returned
+object is a hash which should be populated with parameters of
+the analyzer.</p>
+<p><strong>Returns:</strong> A hash containing a description of the analyzer.</p>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SnowballStemmer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStemmer_Load</strong>(
+ <span class="prefix">lucy_</span>SnowballStemmer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+<p>Reconstruct an analyzer from a dump.</p>
+<p>Subclasses should first call <a href="../../Lucy/Analysis/SnowballStemmer.html#func_Load">Load()</a> on the superclass. The
+returned object is an analyzer which should be reconstructed by
+setting the dumped parameters from the hash contained in <code>dump</code>.</p>
+<p>Note that the invocant analyzer is unused.</p>
+<dl>
+<dt>dump</dt>
+<dd><p>A hash.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> An analyzer.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>SnowStemmer_Equals</strong>(
+ <span class="prefix">lucy_</span>SnowballStemmer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SnowStemmer_Destroy</strong>(
+ <span class="prefix">lucy_</span>SnowballStemmer *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::SnowballStemmer is a <a href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/SnowballStopFilter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/SnowballStopFilter.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/SnowballStopFilter.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,270 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::SnowballStopFilter â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::SnowballStopFilter</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>SNOWBALLSTOPFILTER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>SnowballStopFilter</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>SnowStop</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/SnowballStopFilter.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::SnowballStopFilter â Suppress a âstoplistâ of common words.</p>
+<h3>Description</h3>
+<p>A âstoplistâ is collection of âstopwordsâ: words which are common enough to
+be of little value when determining search results. For example, so many
+documents in English contain âtheâ, âifâ, and âmaybeâ that it may improve
+both performance and relevance to block them.</p>
+<p>Before filtering stopwords:</p>
+<pre><code>("i", "am", "the", "walrus")
+</code></pre>
+<p>After filtering stopwords:</p>
+<pre><code>("walrus")
+</code></pre>
+<p>SnowballStopFilter provides default stoplists for several languages,
+courtesy of the <a href="http://snowball.tartarus.org">Snowball project</a>, or you may
+supply your own.</p>
+<pre><code>|-----------------------|
+| ISO CODE | LANGUAGE |
+|-----------------------|
+| da | Danish |
+| de | German |
+| en | English |
+| es | Spanish |
+| fi | Finnish |
+| fr | French |
+| hu | Hungarian |
+| it | Italian |
+| nl | Dutch |
+| no | Norwegian |
+| pt | Portuguese |
+| sv | Swedish |
+| ru | Russian |
+|-----------------------|
+</code></pre>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SnowballStopFilter* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStop_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Hash.html">Hash</a> *<strong>stoplist</strong>
+);
+</code></pre>
+<p>Create a new SnowballStopFilter.</p>
+<dl>
+<dt>stoplist</dt>
+<dd><p>A hash with stopwords as the keys.</p>
+</dd>
+<dt>language</dt>
+<dd><p>The ISO code for a supported language.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>SnowballStopFilter*
+<span class="prefix">lucy_</span><strong>SnowStop_init</strong>(
+ <span class="prefix">lucy_</span>SnowballStopFilter *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>language</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Hash.html">Hash</a> *<strong>stoplist</strong>
+);
+</code></pre>
+<p>Initialize a SnowballStopFilter.</p>
+<dl>
+<dt>stoplist</dt>
+<dd><p>A hash with stopwords as the keys.</p>
+</dd>
+<dt>language</dt>
+<dd><p>The ISO code for a supported language.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Transform">Transform</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStop_Transform</strong>(
+ <span class="prefix">lucy_</span>SnowballStopFilter *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a> *<strong>inversion</strong>
+);
+</code></pre>
+<p>Take a single <a href="../../Lucy/Analysis/Inversion.html">Inversion</a> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.</p>
+<dl>
+<dt>inversion</dt>
+<dd><p>An inversion.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>SnowStop_Equals</strong>(
+ <span class="prefix">lucy_</span>SnowballStopFilter *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Dump">Dump</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStop_Dump</strong>(
+ <span class="prefix">lucy_</span>SnowballStopFilter *<strong>self</strong>
+);
+</code></pre>
+<p>Dump the analyzer as hash.</p>
+<p>Subclasses should call <a href="../../Lucy/Analysis/SnowballStopFilter.html#func_Dump">Dump()</a> on the superclass. The returned
+object is a hash which should be populated with parameters of
+the analyzer.</p>
+<p><strong>Returns:</strong> A hash containing a description of the analyzer.</p>
+</dd>
+<dt id="func_Load">Load</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SnowStop_Load</strong>(
+ <span class="prefix">lucy_</span>SnowballStopFilter *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+<p>Reconstruct an analyzer from a dump.</p>
+<p>Subclasses should first call <a href="../../Lucy/Analysis/SnowballStopFilter.html#func_Load">Load()</a> on the superclass. The
+returned object is an analyzer which should be reconstructed by
+setting the dumped parameters from the hash contained in <code>dump</code>.</p>
+<p>Note that the invocant analyzer is unused.</p>
+<dl>
+<dt>dump</dt>
+<dd><p>A hash.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> An analyzer.</p>
+</dd>
+<dt id="func_Destroy">Destroy</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SnowStop_Destroy</strong>(
+ <span class="prefix">lucy_</span>SnowballStopFilter *<strong>self</strong>
+);
+</code></pre>
+<p>Generic destructor. Frees the struct itself but not any complex
+member elements.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::SnowballStopFilter is a <a href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>
Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/StandardTokenizer.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/StandardTokenizer.html (added)
+++ websites/staging/lucy/trunk/content/docs/c/Lucy/Analysis/StandardTokenizer.html Mon Apr 4 12:55:27 2016
@@ -0,0 +1,199 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html lang="en">
+ <head>
+ <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
+ <title>Lucy::Analysis::StandardTokenizer â C API Documentation</title>
+ <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css">
+ </head>
+
+ <body>
+
+ <div id="lucy-rigid_wrapper">
+
+ <div id="lucy-top" class="container_16 lucy-white_box_3d">
+
+ <div id="lucy-logo_box" class="grid_8">
+ <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a>
+ </div> <!-- lucy-logo_box -->
+
+ <div #id="lucy-top_nav_box" class="grid_8">
+ <div id="lucy-top_nav_bar" class="container_8">
+ <ul>
+ <li><a href="http://www.apache.org/" title="Apache Software Foundation">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/" title="License">License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html" title="Sponsorship">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html" title="Thanks">Thanks</a></li>
+ <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li>
+ </ul>
+ </div> <!-- lucy-top_nav_bar -->
+ <p><a href="http://www.apache.org/">Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Analysis/">Analysis</a></p>
+ <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search" method="get">
+ <input value="*.apache.org" name="sitesearch" type="hidden"/>
+ <input type="text" name="q" id="query" style="width:85%">
+ <input type="submit" id="submit" value="Search">
+ </form>
+ </div> <!-- lucy-top_nav_box -->
+
+ <div class="clear"></div>
+
+ </div> <!-- lucy-top -->
+
+ <div id="lucy-main_content" class="container_16 lucy-white_box_3d">
+
+ <div class="grid_4" id="lucy-left_nav_box">
+ <h6>About</h6>
+ <ul>
+ <li><a href="/">Welcome</a></li>
+ <li><a href="/clownfish.html">Clownfish</a></li>
+ <li><a href="/faq.html">FAQ</a></li>
+ <li><a href="/people.html">People</a></li>
+ </ul>
+ <h6>Resources</h6>
+ <ul>
+ <li><a href="/download.html">Download</a></li>
+ <li><a href="/mailing_lists.html">Mailing Lists</a></li>
+ <li><a href="/docs/">Documentation</a></li>
+ <li><a href="http://wiki.apache.org/lucy/">Wiki</a></li>
+ <li><a href="https://issues.apache.org/jira/browse/LUCY">Issue Tracker</a></li>
+ <li><a href="/version_control.html">Version Control</a></li>
+ </ul>
+ <h6>Related Projects</h6>
+ <ul>
+ <li><a href="http://lucene.apache.org/core/">Lucene</a></li>
+ <li><a href="http://dezi.org/">Dezi</a></li>
+ <li><a href="http://lucene.apache.org/solr/">Solr</a></li>
+ <li><a href="http://lucenenet.apache.org/">Lucene.NET</a></li>
+ <li><a href="http://lucene.apache.org/pylucene/">PyLucene</a></li>
+ </ul>
+ </div> <!-- lucy-left_nav_box -->
+
+ <div id="lucy-main_content_box" class="grid_9">
+ <div class="c-api">
+<h2>Lucy::Analysis::StandardTokenizer</h2>
+<table>
+<tr>
+<td class="label">parcel</td>
+<td><a href="../../lucy.html">Lucy</a></td>
+</tr>
+<tr>
+<td class="label">class variable</td>
+<td><code><span class="prefix">LUCY_</span>STANDARDTOKENIZER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>StandardTokenizer</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>StandardTokenizer</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Analysis/StandardTokenizer.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Analysis::StandardTokenizer â Split a string into tokens.</p>
+<h3>Description</h3>
+<p>Generically, âtokenizingâ is a process of breaking up a string into an
+array of âtokensâ. For instance, the string âthree blind miceâ might be
+tokenized into âthreeâ, âblindâ, âmiceâ.</p>
+<p>Lucy::Analysis::StandardTokenizer breaks up the text at the word
+boundaries defined in Unicode Standard Annex #29. It then returns those
+words that contain alphabetic or numeric characters.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>StandardTokenizer* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>StandardTokenizer_new</strong>(void);
+</code></pre>
+<p>Constructor. Takes no arguments.</p>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>StandardTokenizer*
+<span class="prefix">lucy_</span><strong>StandardTokenizer_init</strong>(
+ <span class="prefix">lucy_</span>StandardTokenizer *<strong>self</strong>
+);
+</code></pre>
+<p>Initialize a StandardTokenizer.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Transform">Transform</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>StandardTokenizer_Transform</strong>(
+ <span class="prefix">lucy_</span>StandardTokenizer *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a> *<strong>inversion</strong>
+);
+</code></pre>
+<p>Take a single <a href="../../Lucy/Analysis/Inversion.html">Inversion</a> as input
+and returns an Inversion, either the same one (presumably transformed
+in some way), or a new one.</p>
+<dl>
+<dt>inversion</dt>
+<dd><p>An inversion.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Transform_Text">Transform_Text</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Inversion.html">Inversion</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>StandardTokenizer_Transform_Text</strong>(
+ <span class="prefix">lucy_</span>StandardTokenizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong>
+);
+</code></pre>
+<p>Kick off an analysis chain, creating an Inversion from string input.
+The default implementation simply creates an initial Inversion with a
+single Token, then calls <a href="../../Lucy/Analysis/StandardTokenizer.html#func_Transform">Transform()</a>, but occasionally subclasses will
+provide an optimized implementation which minimizes string copies.</p>
+<dl>
+<dt>text</dt>
+<dd><p>A string.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>StandardTokenizer_Equals</strong>(
+ <span class="prefix">lucy_</span>StandardTokenizer *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Indicate whether two objects are the same. By default, compares the
+memory address.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another Obj.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Analysis::StandardTokenizer is a <a href="../../Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p>
+</div>
+
+ </div> <!-- lucy-main_content_box -->
+ <div class="clear"></div>
+
+ </div> <!-- lucy-main_content -->
+
+ <div id="lucy-copyright" class="container_16">
+ <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br/>
+ Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The
+ Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their
+ respective owners.
+ </p>
+ </div> <!-- lucy-copyright -->
+
+ </div> <!-- lucy-rigid_wrapper -->
+
+ </body>
+</html>