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/09/28 12:07:52 UTC
svn commit: r998475 [11/26] - in /websites/staging/lucy/trunk/content: ./
docs/ docs/0.5.0/ docs/0.5.0/c/ docs/0.5.0/c/Clownfish/
docs/0.5.0/c/Clownfish/Docs/ docs/0.5.0/c/Lucy/ docs/0.5.0/c/Lucy/Analysis/
docs/0.5.0/c/Lucy/Docs/ docs/0.5.0/c/Lucy/Docs...
Added: websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/StringType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/StringType.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/StringType.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,268 @@
+<!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::Plan::StringType – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Plan/">Plan</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::Plan::StringType</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>STRINGTYPE</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>StringType</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>StringType</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Plan/StringType.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Plan::StringType – Non-tokenized text type.</p>
+<h3>Description</h3>
+<p>Lucy::Plan::StringType is used for “exact-match” strings.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>StringType* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>StringType_new</strong>(void);
+</code></pre>
+<p>Create a new StringType.</p>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>StringType*
+<span class="prefix">lucy_</span><strong>StringType_init</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>
+);
+</code></pre>
+<p>Initialize a StringType.</p>
+</dd>
+<dt id="func_init2">init2</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>StringType*
+<span class="prefix">lucy_</span><strong>StringType_init2</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>,
+ float <strong>boost</strong>,
+ bool <strong>indexed</strong>,
+ bool <strong>stored</strong>,
+ bool <strong>sortable</strong>
+);
+</code></pre>
+<dl>
+<dt>boost</dt>
+<dd><p>floating point per-field boost.</p>
+</dd>
+<dt>indexed</dt>
+<dd><p>boolean indicating whether the field should be indexed.</p>
+</dd>
+<dt>stored</dt>
+<dd><p>boolean indicating whether the field should be stored.</p>
+</dd>
+<dt>sortable</dt>
+<dd><p>boolean indicating whether the field should be
+sortable.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>StringType_Equals</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Compares all common properties.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Plan::FieldType</h4>
+<dl>
+<dt id="func_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>StringType_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Setter for <code>boost</code>.</p>
+</dd>
+<dt id="func_Get_Boost">Get_Boost</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>StringType_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>boost</code>.</p>
+</dd>
+<dt id="func_Set_Indexed">Set_Indexed</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>StringType_Set_Indexed</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>,
+ bool <strong>indexed</strong>
+);
+</code></pre>
+<p>Setter for <code>indexed</code>.</p>
+</dd>
+<dt id="func_Indexed">Indexed</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>StringType_Indexed</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>indexed</code>.</p>
+</dd>
+<dt id="func_Set_Stored">Set_Stored</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>StringType_Set_Stored</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>,
+ bool <strong>stored</strong>
+);
+</code></pre>
+<p>Setter for <code>stored</code>.</p>
+</dd>
+<dt id="func_Stored">Stored</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>StringType_Stored</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>stored</code>.</p>
+</dd>
+<dt id="func_Set_Sortable">Set_Sortable</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>StringType_Set_Sortable</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>,
+ bool <strong>sortable</strong>
+);
+</code></pre>
+<p>Setter for <code>sortable</code>.</p>
+</dd>
+<dt id="func_Sortable">Sortable</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>StringType_Sortable</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>sortable</code>.</p>
+</dd>
+<dt id="func_Binary">Binary</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>StringType_Binary</strong>(
+ <span class="prefix">lucy_</span>StringType *<strong>self</strong>
+);
+</code></pre>
+<p>Indicate whether the field contains binary data.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Plan::StringType is a <a href="../../Lucy/Plan/TextType.html">Lucy::Plan::TextType</a> is a <a href="../../Lucy/Plan/FieldType.html">Lucy::Plan::FieldType</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/0.5.0/c/Lucy/Search/ANDQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/ANDQuery.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/ANDQuery.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,261 @@
+<!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::Search::ANDQuery – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Search/">Search</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::Search::ANDQuery</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>ANDQUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>ANDQuery</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>ANDQuery</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/ANDQuery.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::ANDQuery – Intersect multiple result sets.</p>
+<h3>Description</h3>
+<p>ANDQuery is a composite <a href="../../Lucy/Search/Query.html">Query</a> which matches
+only when all of its children match, so its result set is the intersection
+of their result sets. Documents which match receive a summed score.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>ANDQuery* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ANDQuery_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>children</strong>
+);
+</code></pre>
+<p>Create a new ANDQuery.</p>
+<dl>
+<dt>children</dt>
+<dd><p>An array of child Queries.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>ANDQuery*
+<span class="prefix">lucy_</span><strong>ANDQuery_init</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>children</strong>
+);
+</code></pre>
+<p>Initialize an ANDQuery.</p>
+<dl>
+<dt>children</dt>
+<dd><p>An array of child Queries.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Make_Compiler">Make_Compiler</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Compiler.html">Compiler</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ANDQuery_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>,
+ float <strong>boost</strong>,
+ bool <strong>subordinate</strong>
+);
+</code></pre>
+<p>Abstract factory method returning a Compiler derived from this Query.</p>
+<dl>
+<dt>searcher</dt>
+<dd><p>A Searcher.</p>
+</dd>
+<dt>boost</dt>
+<dd><p>A scoring multiplier.</p>
+</dd>
+<dt>subordinate</dt>
+<dd><p>Indicates whether the Query is a subquery (as
+opposed to a top-level query). If false, the implementation must
+invoke <a href="../../Lucy/Search/Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning
+it.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_To_String">To_String</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>ANDQuery_To_String</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Generic stringification: “ClassName@hex_mem_address”.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>ANDQuery_Equals</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<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>
+<h4>Methods inherited from Lucy::Search::PolyQuery</h4>
+<dl>
+<dt id="func_Add_Child">Add_Child</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>ANDQuery_Add_Child</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>
+);
+</code></pre>
+<p>Add a child Query node.</p>
+</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>ANDQuery_Dump</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>
+);
+</code></pre>
+</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>ANDQuery_Load</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Search::Query</h4>
+<dl>
+<dt id="func_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>ANDQuery_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Set the Query’s boost.</p>
+</dd>
+<dt id="func_Get_Boost">Get_Boost</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>ANDQuery_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>ANDQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::ANDQuery is a <a href="../../Lucy/Search/PolyQuery.html">Lucy::Search::PolyQuery</a> is a <a href="../../Lucy/Search/Query.html">Lucy::Search::Query</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/0.5.0/c/Lucy/Search/Collector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Collector.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Collector.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,158 @@
+<!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::Search::Collector – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Search/">Search</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::Search::Collector</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>COLLECTOR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Collector</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Coll</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/Collector.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::Collector – Process hits.</p>
+<h3>Description</h3>
+<p>A Collector decides what to do with the hits that a
+<a href="../../Lucy/Search/Matcher.html">Matcher</a> iterates through, based on how the
+abstract <a href="../../Lucy/Search/Collector.html#func_Collect">Collect()</a> method is implemented.</p>
+<p>Collectors operate on individual segments, but must operate within the
+context of a larger collection. Each time the collector moves to a new
+segment, Set_Reader(), Set_Base() and Set_Matcher() will be called, and the
+collector must take the updated information into account.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Collector*
+<span class="prefix">lucy_</span><strong>Coll_init</strong>(
+ <span class="prefix">lucy_</span>Collector *<strong>self</strong>
+);
+</code></pre>
+<p>Abstract initializer.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Collect">Collect <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Coll_Collect</strong>(
+ <span class="prefix">lucy_</span>Collector *<strong>self</strong>,
+ int32_t <strong>doc_id</strong>
+);
+</code></pre>
+<p>Do something with a doc id. (For instance, keep track of the docs
+with the ten highest scores.)</p>
+<dl>
+<dt>doc_id</dt>
+<dd><p>A segment document id.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::Collector 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/0.5.0/c/Lucy/Search/Collector/BitCollector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Collector/BitCollector.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Collector/BitCollector.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,168 @@
+<!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::Search::Collector::BitCollector – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Search/">Search</a> » <a href="/docs/0.5.0/c/Lucy/Search/Collector/">Collector</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::Search::Collector::BitCollector</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>BITCOLLECTOR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>BitCollector</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>BitColl</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/Collector.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::Collector::BitCollector – Collector which records doc nums in a BitVector.</p>
+<h3>Description</h3>
+<p>BitCollector is a Collector which saves matching document ids in a
+<a href="../../../Lucy/Object/BitVector.html">BitVector</a>. It is useful for recording the
+entire set of documents which matches a query.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>BitCollector* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>BitColl_new</strong>(
+ <span class="prefix">lucy_</span><a href="../../../Lucy/Object/BitVector.html">BitVector</a> *<strong>bit_vector</strong>
+);
+</code></pre>
+<p>Create a new BitCollector.</p>
+<dl>
+<dt>bit_vector</dt>
+<dd><p>A Lucy::Object::BitVector.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>BitCollector*
+<span class="prefix">lucy_</span><strong>BitColl_init</strong>(
+ <span class="prefix">lucy_</span>BitCollector *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../../Lucy/Object/BitVector.html">BitVector</a> *<strong>bit_vector</strong>
+);
+</code></pre>
+<p>Initialize a BitCollector.</p>
+<dl>
+<dt>bit_vector</dt>
+<dd><p>A Lucy::Object::BitVector.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Collect">Collect</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitColl_Collect</strong>(
+ <span class="prefix">lucy_</span>BitCollector *<strong>self</strong>,
+ int32_t <strong>doc_id</strong>
+);
+</code></pre>
+<p>Set bit in the object’s BitVector for the supplied doc id.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::Collector::BitCollector is a <a href="../../../Lucy/Search/Collector.html">Lucy::Search::Collector</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/0.5.0/c/Lucy/Search/Compiler.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Compiler.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Compiler.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,375 @@
+<!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::Search::Compiler – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Search/">Search</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::Search::Compiler</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>COMPILER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Compiler</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Compiler</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/Compiler.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::Compiler – Query-to-Matcher compiler.</p>
+<h3>Description</h3>
+<p>The purpose of the Compiler class is to take a specification in the form of
+a <a href="../../Lucy/Search/Query.html">Query</a> object and compile a
+<a href="../../Lucy/Search/Matcher.html">Matcher</a> object that can do real work.</p>
+<p>The simplest Compiler subclasses – such as those associated with
+constant-scoring Query types – might simply implement a <a href="../../Lucy/Search/Compiler.html#func_Make_Matcher">Make_Matcher()</a>
+method which passes along information verbatim from the Query to the
+Matcher’s constructor.</p>
+<p>However it is common for the Compiler to perform some calculations which
+affect it’s “weight” – a floating point multiplier that the Matcher will
+factor into each document’s score. If that is the case, then the Compiler
+subclass may wish to override <a href="../../Lucy/Search/Compiler.html#func_Get_Weight">Get_Weight()</a>, <a href="../../Lucy/Search/Compiler.html#func_Sum_Of_Squared_Weights">Sum_Of_Squared_Weights()</a>, and
+<a href="../../Lucy/Search/Compiler.html#func_Apply_Norm_Factor">Apply_Norm_Factor()</a>.</p>
+<p>Compiling a Matcher is a two stage process.</p>
+<p>The first stage takes place during the Compiler’s construction, which is
+where the Query object meets a <a href="../../Lucy/Search/Searcher.html">Searcher</a>
+object for the first time. Searchers operate on a specific document
+collection and they can tell you certain statistical information about the
+collection – such as how many total documents are in the collection, or
+how many documents in the collection a particular term is present in.
+Lucy’s core Compiler classes plug this information into the classic
+TF/IDF weighting algorithm to adjust the Compiler’s weight; custom
+subclasses might do something similar.</p>
+<p>The second stage of compilation is <a href="../../Lucy/Search/Compiler.html#func_Make_Matcher">Make_Matcher()</a>, method, which is where
+the Compiler meets a <a href="../../Lucy/Index/SegReader.html">SegReader</a> object.
+SegReaders are associated with a single segment within a single index on a
+single machine, and are thus lower-level than Searchers, which may
+represent a document collection spread out over a search cluster
+(comprising several indexes and many segments). The Compiler object can
+use new information supplied by the SegReader – such as whether a term is
+missing from the local index even though it is present within the larger
+collection represented by the Searcher – when figuring out what to feed to
+the Matchers’s constructor, or whether <a href="../../Lucy/Search/Compiler.html#func_Make_Matcher">Make_Matcher()</a> should return a
+Matcher at all.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Compiler*
+<span class="prefix">lucy_</span><strong>Compiler_init</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>parent</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/Similarity.html">Similarity</a> *<strong>similarity</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Abstract initializer.</p>
+<dl>
+<dt>parent</dt>
+<dd><p>The parent Query.</p>
+</dd>
+<dt>searcher</dt>
+<dd><p>A Lucy::Search::Searcher, such as an
+IndexSearcher.</p>
+</dd>
+<dt>similarity</dt>
+<dd><p>A Similarity.</p>
+</dd>
+<dt>boost</dt>
+<dd><p>An arbitrary scoring multiplier. Defaults to the boost of
+the parent Query.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Make_Matcher">Make_Matcher <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Matcher.html">Matcher</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Compiler_Make_Matcher</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong>,
+ bool <strong>need_score</strong>
+);
+</code></pre>
+<p>Factory method returning a Matcher.</p>
+<dl>
+<dt>reader</dt>
+<dd><p>A SegReader.</p>
+</dd>
+<dt>need_score</dt>
+<dd><p>Indicate whether the Matcher must implement <a href="../../Lucy/Search/Matcher.html#func_Score">Score()</a>.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> a Matcher, or NULL if the Matcher would have matched
+no documents.</p>
+</dd>
+<dt id="func_Get_Weight">Get_Weight</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>Compiler_Get_Weight</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+<p>Return the Compiler’s numerical weight, a scoring multiplier. By
+default, returns the object’s boost.</p>
+</dd>
+<dt id="func_Get_Similarity">Get_Similarity</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Similarity.html">Similarity</a>*
+<span class="prefix">lucy_</span><strong>Compiler_Get_Similarity</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for the Compiler’s Similarity object.</p>
+</dd>
+<dt id="func_Get_Parent">Get_Parent</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>*
+<span class="prefix">lucy_</span><strong>Compiler_Get_Parent</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for the Compiler’s parent Query object.</p>
+</dd>
+<dt id="func_Sum_Of_Squared_Weights">Sum_Of_Squared_Weights</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>Compiler_Sum_Of_Squared_Weights</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+<p>Compute and return a raw weighting factor. (This quantity is used by
+<a href="../../Lucy/Search/Compiler.html#func_Normalize">Normalize()</a>). By default, simply returns 1.0.</p>
+</dd>
+<dt id="func_Apply_Norm_Factor">Apply_Norm_Factor</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Compiler_Apply_Norm_Factor</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>,
+ float <strong>factor</strong>
+);
+</code></pre>
+<p>Apply a floating point normalization multiplier. For a TermCompiler,
+this involves multiplying its own weight by the supplied factor;
+combining classes such as ORCompiler would apply the factor recursively
+to their children.</p>
+<p>The default implementation is a no-op; subclasses may wish to multiply
+their internal weight by the supplied factor.</p>
+<dl>
+<dt>factor</dt>
+<dd><p>The multiplier.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Normalize">Normalize</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Compiler_Normalize</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+<p>Take a newly minted Compiler object and apply query-specific
+normalization factors. Should be invoked by Query subclasses during
+<a href="../../Lucy/Search/Compiler.html#func_Make_Compiler">Make_Compiler()</a> for top-level nodes.</p>
+<p>For a TermQuery, the scoring formula is approximately:</p>
+<pre><code>(tf_d * idf_t / norm_d) * (tf_q * idf_t / norm_q)
+</code></pre>
+<p><a href="../../Lucy/Search/Compiler.html#func_Normalize">Normalize()</a> is theoretically concerned with applying the second half of
+that formula to a the Compiler’s weight. What actually happens depends
+on how the Compiler and Similarity methods called internally are
+implemented.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Compiler_Equals</strong>(
+ <span class="prefix">lucy_</span>Compiler *<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_To_String">To_String</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Compiler_To_String</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+<p>Generic stringification: “ClassName@hex_mem_address”.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Search::Query</h4>
+<dl>
+<dt id="func_Make_Compiler">Make_Compiler <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Compiler* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Compiler_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>,
+ float <strong>boost</strong>,
+ bool <strong>subordinate</strong>
+);
+</code></pre>
+<p>Abstract factory method returning a Compiler derived from this Query.</p>
+<dl>
+<dt>searcher</dt>
+<dd><p>A Searcher.</p>
+</dd>
+<dt>boost</dt>
+<dd><p>A scoring multiplier.</p>
+</dd>
+<dt>subordinate</dt>
+<dd><p>Indicates whether the Query is a subquery (as
+opposed to a top-level query). If false, the implementation must
+invoke <a href="../../Lucy/Search/Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning
+it.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Compiler_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Set the Query’s boost.</p>
+</dd>
+<dt id="func_Get_Boost">Get_Boost</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>Compiler_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</p>
+</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>Compiler_Dump</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>
+);
+</code></pre>
+</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>Compiler_Load</strong>(
+ <span class="prefix">lucy_</span>Compiler *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::Compiler is a <a href="../../Lucy/Search/Query.html">Lucy::Search::Query</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/0.5.0/c/Lucy/Search/Hits.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Hits.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/Hits.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,145 @@
+<!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::Search::Hits – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Search/">Search</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::Search::Hits</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>HITS</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Hits</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Hits</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/Hits.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::Hits – Access search results.</p>
+<h3>Description</h3>
+<p>Hits objects are iterators used to access the results of a search.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Next">Next</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Document/HitDoc.html">HitDoc</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Hits_Next</strong>(
+ <span class="prefix">lucy_</span>Hits *<strong>self</strong>
+);
+</code></pre>
+<p>Return the next hit, or NULL when the iterator is exhausted.</p>
+</dd>
+<dt id="func_Total_Hits">Total_Hits</dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>Hits_Total_Hits</strong>(
+ <span class="prefix">lucy_</span>Hits *<strong>self</strong>
+);
+</code></pre>
+<p>Return the total number of documents which matched the Query used to
+produce the Hits object. Note that this is the total number of
+matches, not just the number of matches represented by the Hits
+iterator.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::Hits 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/0.5.0/c/Lucy/Search/IndexSearcher.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/IndexSearcher.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/IndexSearcher.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,293 @@
+<!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::Search::IndexSearcher – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Search/">Search</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::Search::IndexSearcher</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>INDEXSEARCHER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>IndexSearcher</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>IxSearcher</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/IndexSearcher.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::IndexSearcher – Execute searches against a single index.</p>
+<h3>Description</h3>
+<p>Use the IndexSearcher class to perform search queries against an index.
+(For searching multiple indexes at once, see
+<a href="../../Lucy/Search/PolySearcher.html">PolySearcher</a>).</p>
+<p>IndexSearchers operate against a single point-in-time view or
+<a href="../../Lucy/Index/Snapshot.html">Snapshot</a> of the index. If an index is
+modified, a new IndexSearcher must be opened to access the changes.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>IndexSearcher* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>IxSearcher_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong>
+);
+</code></pre>
+<p>Create a new IndexSearcher.</p>
+<dl>
+<dt>index</dt>
+<dd><p>Either a string filepath, a Folder, or an IndexReader.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>IndexSearcher*
+<span class="prefix">lucy_</span><strong>IxSearcher_init</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong>
+);
+</code></pre>
+<p>Initialize an IndexSearcher.</p>
+<dl>
+<dt>index</dt>
+<dd><p>Either a string filepath, a Folder, or an IndexReader.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Doc_Max">Doc_Max</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>IxSearcher_Doc_Max</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>
+);
+</code></pre>
+<p>Return the maximum number of docs in the collection represented by the
+Searcher, which is also the highest possible internal doc id.
+Documents which have been marked as deleted but not yet purged are
+included in this count.</p>
+</dd>
+<dt id="func_Doc_Freq">Doc_Freq</dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>IxSearcher_Doc_Freq</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>term</strong>
+);
+</code></pre>
+<p>Return the number of documents which contain the term in the given
+field.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+<dt>term</dt>
+<dd><p>The term to look up.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Collect">Collect</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>IxSearcher_Collect</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Collector.html">Collector</a> *<strong>collector</strong>
+);
+</code></pre>
+<p>Iterate over hits, feeding them into a
+<a href="../../Lucy/Search/Collector.html">Collector</a>.</p>
+<dl>
+<dt>query</dt>
+<dd><p>A Query.</p>
+</dd>
+<dt>collector</dt>
+<dd><p>A Collector.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Fetch_Doc">Fetch_Doc</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Document/HitDoc.html">HitDoc</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>IxSearcher_Fetch_Doc</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>,
+ int32_t <strong>doc_id</strong>
+);
+</code></pre>
+<p>Retrieve a document. Throws an error if the doc id is out of range.</p>
+<dl>
+<dt>doc_id</dt>
+<dd><p>A document id.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Get_Reader">Get_Reader</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/IndexReader.html">IndexReader</a>*
+<span class="prefix">lucy_</span><strong>IxSearcher_Get_Reader</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for the object’s <code>reader</code> member.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Search::Searcher</h4>
+<dl>
+<dt id="func_Glean_Query">Glean_Query</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>IxSearcher_Glean_Query</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>query</strong>
+);
+</code></pre>
+<p>If the supplied object is a Query, return it; if it’s a query string,
+create a QueryParser and parse it to produce a query against all
+indexed fields.</p>
+</dd>
+<dt id="func_Hits">Hits</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Hits.html">Hits</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>IxSearcher_Hits</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>query</strong>,
+ uint32_t <strong>offset</strong>,
+ uint32_t <strong>num_wanted</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/SortSpec.html">SortSpec</a> *<strong>sort_spec</strong>
+);
+</code></pre>
+<p>Return a Hits object containing the top results.</p>
+<dl>
+<dt>query</dt>
+<dd><p>Either a Query object or a query string.</p>
+</dd>
+<dt>offset</dt>
+<dd><p>The number of most-relevant hits to discard, typically
+used when “paging” through hits N at a time. Setting
+<code>offset</code> to 20 and <code>num_wanted</code> to 10 retrieves
+hits 21-30, assuming that 30 hits can be found.</p>
+</dd>
+<dt>num_wanted</dt>
+<dd><p>The number of hits you would like to see after
+<code>offset</code> is taken into account.</p>
+</dd>
+<dt>sort_spec</dt>
+<dd><p>A <a href="../../Lucy/Search/SortSpec.html">SortSpec</a>, which will affect
+how results are ranked and returned.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Get_Schema">Get_Schema</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a>*
+<span class="prefix">lucy_</span><strong>IxSearcher_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for the object’s <code>schema</code> member.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::IndexSearcher is a <a href="../../Lucy/Search/Searcher.html">Lucy::Search::Searcher</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/0.5.0/c/Lucy/Search/LeafQuery.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/LeafQuery.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Search/LeafQuery.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,263 @@
+<!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::Search::LeafQuery – 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/0.5.0/">0.5.0</a> » <a href="/docs/0.5.0/c/">C</a> » <a href="/docs/0.5.0/c/Lucy/">Lucy</a> » <a href="/docs/0.5.0/c/Lucy/Search/">Search</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::Search::LeafQuery</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>LEAFQUERY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>LeafQuery</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>LeafQuery</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Search/LeafQuery.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Search::LeafQuery – Leaf node in a tree created by QueryParser.</p>
+<h3>Description</h3>
+<p>LeafQuery objects serve as leaf nodes in the tree structure generated by
+<a href="../../Lucy/Search/QueryParser.html">QueryParser</a>’s <a href="../../Lucy/Search/QueryParser.html#func_Tree">Tree()</a> method.
+Ultimately, they must be transformed, typically into either
+<a href="../../Lucy/Search/TermQuery.html">TermQuery</a> or
+<a href="../../Lucy/Search/PhraseQuery.html">PhraseQuery</a> objects, as attempting to
+search a LeafQuery causes an error.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>LeafQuery* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>LeafQuery_new</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong>
+);
+</code></pre>
+<p>Create a new LeafQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Optional field name.</p>
+</dd>
+<dt>text</dt>
+<dd><p>Raw query text.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>LeafQuery*
+<span class="prefix">lucy_</span><strong>LeafQuery_init</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>text</strong>
+);
+</code></pre>
+<p>Initialize a LeafQuery.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Optional field name.</p>
+</dd>
+<dt>text</dt>
+<dd><p>Raw query text.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get_Field">Get_Field</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>*
+<span class="prefix">lucy_</span><strong>LeafQuery_Get_Field</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for object’s <code>field</code> attribute.</p>
+</dd>
+<dt id="func_Get_Text">Get_Text</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>*
+<span class="prefix">lucy_</span><strong>LeafQuery_Get_Text</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for object’s <code>text</code> attribute.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>LeafQuery_Equals</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<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_To_String">To_String</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>LeafQuery_To_String</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Generic stringification: “ClassName@hex_mem_address”.</p>
+</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>LeafQuery_Dump</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>
+);
+</code></pre>
+</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>LeafQuery_Load</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong>
+);
+</code></pre>
+</dd>
+<dt id="func_Make_Compiler">Make_Compiler</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Compiler.html">Compiler</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>LeafQuery_Make_Compiler</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>,
+ float <strong>boost</strong>,
+ bool <strong>subordinate</strong>
+);
+</code></pre>
+<p>Throws an error.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Search::Query</h4>
+<dl>
+<dt id="func_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>LeafQuery_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Set the Query’s boost.</p>
+</dd>
+<dt id="func_Get_Boost">Get_Boost</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>LeafQuery_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>LeafQuery *<strong>self</strong>
+);
+</code></pre>
+<p>Get the Query’s boost.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Search::LeafQuery is a <a href="../../Lucy/Search/Query.html">Lucy::Search::Query</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>