Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/FullTextType.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/FullTextType.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/FullTextType.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,237 @@ +<!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::FullTextType â 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/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::FullTextType</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>FULLTEXTTYPE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>FullTextType</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>FullTextType</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Plan/FullTextType.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Plan::FullTextType â Full-text search field type.</p> +<h3>Description</h3> +<p>Lucy::Plan::FullTextType is an implementation of +<a href="../../Lucy/Plan/FieldType.html">FieldType</a> tuned for âfull text searchâ.</p> +<p>Full text fields are associated with an +<a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a>, which is used to tokenize and +normalize the text so that it can be searched for individual words.</p> +<p>For an exact-match, single value field type using character data, see +<a href="../../Lucy/Plan/StringType.html">StringType</a>.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>FullTextType* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>FullTextType_new</strong>( + <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> *<strong>analyzer</strong> +); +</code></pre> +<p>Create a new FullTextType.</p> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>FullTextType* +<span class="prefix">lucy_</span><strong>FullTextType_init</strong>( + <span class="prefix">lucy_</span>FullTextType *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> *<strong>analyzer</strong> +); +</code></pre> +<p>Initialize a FullTextType.</p> +</dd> +<dt id="func_init2">init2</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>FullTextType* +<span class="prefix">lucy_</span><strong>FullTextType_init2</strong>( + <span class="prefix">lucy_</span>FullTextType *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> *<strong>analyzer</strong>, + float <strong>boost</strong>, + bool <strong>indexed</strong>, + bool <strong>stored</strong>, + bool <strong>sortable</strong>, + bool <strong>highlightable</strong> +); +</code></pre> +<dl> +<dt>analyzer</dt> +<dd><p>An Analyzer.</p> +</dd> +<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> +<dt>highlightable</dt> +<dd><p>boolean indicating whether the field should be +highlightable.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Set_Highlightable">Set_Highlightable</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>FullTextType_Set_Highlightable</strong>( + <span class="prefix">lucy_</span>FullTextType *<strong>self</strong>, + bool <strong>highlightable</strong> +); +</code></pre> +<p>Indicate whether to store data required by +<a href="../../Lucy/Highlight/Highlighter.html">Highlighter</a> for excerpt selection and search +term highlighting.</p> +</dd> +<dt id="func_Highlightable">Highlightable</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>FullTextType_Highlightable</strong>( + <span class="prefix">lucy_</span>FullTextType *<strong>self</strong> +); +</code></pre> +<p>Accessor for âhighlightableâ property.</p> +</dd> +<dt id="func_Get_Analyzer">Get_Analyzer</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a>* +<span class="prefix">lucy_</span><strong>FullTextType_Get_Analyzer</strong>( + <span class="prefix">lucy_</span>FullTextType *<strong>self</strong> +); +</code></pre> +<p>Accessor for the typeâs analyzer.</p> +</dd> +<dt id="func_Equals">Equals</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>FullTextType_Equals</strong>( + <span class="prefix">lucy_</span>FullTextType *<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> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>FullTextType_Destroy</strong>( + <span class="prefix">lucy_</span>FullTextType *<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::Plan::FullTextType 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/c/Lucy/Plan/Schema.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/Schema.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/Schema.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,247 @@ +<!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::Schema â 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/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::Schema</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>SCHEMA</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Schema</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Schema</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Plan/Schema.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Plan::Schema â User-created specification for an inverted index.</p> +<h3>Description</h3> +<p>A Schema is a specification which indicates how other entities should +interpret the raw data in an inverted index and interact with it.</p> +<p>Once an actual index has been created using a particular Schema, existing +field definitions may not be changed. However, it is possible to add new +fields during subsequent indexing sessions.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Schema* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Schema_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>Schema* +<span class="prefix">lucy_</span><strong>Schema_init</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong> +); +</code></pre> +<p>Initialize a Schema.</p> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Architecture">Architecture</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Architecture.html">Architecture</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Schema_Architecture</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong> +); +</code></pre> +<p>Factory method which creates an Architecture object for this index.</p> +</dd> +<dt id="func_Spec_Field">Spec_Field</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Schema_Spec_Field</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>name</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Plan/FieldType.html">FieldType</a> *<strong>type</strong> +); +</code></pre> +<p>Define the behavior of a field by associating it with a FieldType.</p> +<p>If this method has already been called for the supplied +<code>field</code>, it will merely test to verify that the supplied +FieldType <a href="../../Lucy/Plan/Schema.html#func_Equals">Equals()</a> the existing one.</p> +<dl> +<dt>name</dt> +<dd><p>The name of the field.</p> +</dd> +<dt>type</dt> +<dd><p>A FieldType.</p> +</dd> +</dl> +</dd> +<dt id="func_Fetch_Type">Fetch_Type</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/FieldType.html">FieldType</a>* +<span class="prefix">lucy_</span><strong>Schema_Fetch_Type</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong> +); +</code></pre> +<p>Return the FieldType for the specified field. If the field canât be +found, return NULL.</p> +</dd> +<dt id="func_Fetch_Sim">Fetch_Sim</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Similarity.html">Similarity</a>* +<span class="prefix">lucy_</span><strong>Schema_Fetch_Sim</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong> +); +</code></pre> +<p>Return the Similarity for the specified field, or NULL if +either the field canât be found or it isnât associated with a +Similarity.</p> +</dd> +<dt id="func_Num_Fields">Num_Fields</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>Schema_Num_Fields</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong> +); +</code></pre> +<p>Return the number of fields currently defined.</p> +</dd> +<dt id="func_All_Fields">All_Fields</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Schema_All_Fields</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong> +); +</code></pre> +<p>Return all the Schemaâs field names as an array.</p> +</dd> +<dt id="func_Get_Architecture">Get_Architecture</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Architecture.html">Architecture</a>* +<span class="prefix">lucy_</span><strong>Schema_Get_Architecture</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong> +); +</code></pre> +<p>Return the Schema instanceâs internal Architecture object.</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>Schema_Get_Similarity</strong>( + <span class="prefix">lucy_</span>Schema *<strong>self</strong> +); +</code></pre> +<p>Return the Schema instanceâs internal Similarity object.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Schema_Destroy</strong>( + <span class="prefix">lucy_</span>Schema *<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::Plan::Schema 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/Plan/StringType.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/StringType.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/StringType.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,180 @@ +<!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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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> +<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/c/Lucy/Search/ANDQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Search/ANDQuery.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Search/ANDQuery.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,209 @@ +<!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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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> +<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/c/Lucy/Search/Collector.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Collector.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Collector.html Mon Apr 4 12:55:27 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 â 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/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_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Coll_Destroy</strong>( + <span class="prefix">lucy_</span>Collector *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +<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/c/Lucy/Search/Collector/BitCollector.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Collector/BitCollector.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Collector/BitCollector.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,178 @@ +<!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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Search/">Search</a> » <a href="/docs/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_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitColl_Destroy</strong>( + <span class="prefix">lucy_</span>BitCollector *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +<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/c/Lucy/Search/Compiler.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Compiler.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Compiler.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,320 @@ +<!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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Compiler_Destroy</strong>( + <span class="prefix">lucy_</span>Compiler *<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::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/c/Lucy/Search/Hits.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Hits.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Search/Hits.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,155 @@ +<!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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Hits_Destroy</strong>( + <span class="prefix">lucy_</span>Hits *<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::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/c/Lucy/Search/IndexSearcher.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Search/IndexSearcher.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Search/IndexSearcher.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,247 @@ +<!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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>IxSearcher_Destroy</strong>( + <span class="prefix">lucy_</span>IndexSearcher *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +<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> +<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>
