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 [10/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/Index/Snapshot.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Snapshot.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Snapshot.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,253 @@
+<!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::Index::Snapshot – 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/Index/">Index</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::Index::Snapshot</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>SNAPSHOT</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Snapshot</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Snapshot</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/Snapshot.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::Snapshot – Point-in-time index file list.</p>
+<h3>Description</h3>
+<p>A Snapshot is list of index files and folders. Because index files, once
+written, are never modified, a Snapshot defines a point-in-time view of the
+data in an index.</p>
+<p><a href="../../Lucy/Index/IndexReader.html">IndexReader</a> objects interpret the data
+associated with a single Snapshot.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Snapshot* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Snapshot_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>Snapshot*
+<span class="prefix">lucy_</span><strong>Snapshot_init</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>
+);
+</code></pre>
+<p>Initialize a Snapshot.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_List">List</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>Snapshot_List</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array of all entries.</p>
+</dd>
+<dt id="func_Num_Entries">Num_Entries</dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>Snapshot_Num_Entries</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of entries (including directories).</p>
+</dd>
+<dt id="func_Add_Entry">Add_Entry</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Snapshot_Add_Entry</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>entry</strong>
+);
+</code></pre>
+<p>Add a filepath to the snapshot.</p>
+</dd>
+<dt id="func_Delete_Entry">Delete_Entry</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Snapshot_Delete_Entry</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>entry</strong>
+);
+</code></pre>
+<p>Delete a filepath from the snapshot.</p>
+<p><strong>Returns:</strong> true if the entry existed and was successfully deleted, false
+otherwise.</p>
+</dd>
+<dt id="func_Read_File">Read_File</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Snapshot*
+<span class="prefix">lucy_</span><strong>Snapshot_Read_File</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong>
+);
+</code></pre>
+<p>Decode a snapshot file and initialize the object to reflect its
+contents.</p>
+<dl>
+<dt>folder</dt>
+<dd><p>A Folder.</p>
+</dd>
+<dt>path</dt>
+<dd><p>The location of the snapshot file. If not supplied, the
+most recent snapshot file in the base directory will be chosen.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> the Snapshot object itself</p>
+</dd>
+<dt id="func_Write_File">Write_File</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Snapshot_Write_File</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong>
+);
+</code></pre>
+<p>Write a snapshot file. The caller must lock the index while this
+operation takes place, and the operation will fail if the snapshot file
+already exists.</p>
+<dl>
+<dt>folder</dt>
+<dd><p>A Folder.</p>
+</dd>
+<dt>path</dt>
+<dd><p>The path of the file to write. If NULL, a file
+name will be chosen which supersedes the latest snapshot file in the
+index folder.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Set_Path">Set_Path</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Snapshot_Set_Path</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong>
+);
+</code></pre>
+<p>Set the path to the file that the Snapshot object serves as a proxy
+for.</p>
+</dd>
+<dt id="func_Get_Path">Get_Path</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>*
+<span class="prefix">lucy_</span><strong>Snapshot_Get_Path</strong>(
+ <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>
+);
+</code></pre>
+<p>Get the path to the snapshot file. Initially NULL; updated
+by <a href="../../Lucy/Index/Snapshot.html#func_Read_File">Read_File()</a>, <a href="../../Lucy/Index/Snapshot.html#func_Write_File">Write_File()</a>, and <a href="../../Lucy/Index/Snapshot.html#func_Set_Path">Set_Path()</a>.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::Snapshot 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/Object/BitVector.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Object/BitVector.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Object/BitVector.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,365 @@
+<!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::Object::BitVector – 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/Object/">Object</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::Object::BitVector</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>BITVECTOR</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>BitVector</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>BitVec</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Object/BitVector.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Object::BitVector – An array of bits.</p>
+<h3>Description</h3>
+<p>BitVector is a growable array of bits. All bits are initially zero.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>BitVector* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>BitVec_new</strong>(
+ uint32_t <strong>capacity</strong>
+);
+</code></pre>
+<p>Create a new BitVector.</p>
+<dl>
+<dt>capacity</dt>
+<dd><p>The number of bits that the initial array should be
+able to hold.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>BitVector*
+<span class="prefix">lucy_</span><strong>BitVec_init</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>capacity</strong>
+);
+</code></pre>
+<p>Initialize a BitVector.</p>
+<dl>
+<dt>capacity</dt>
+<dd><p>The number of bits that the initial array should be
+able to hold.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get">Get</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>BitVec_Get</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>tick</strong>
+);
+</code></pre>
+<p>Return true if the bit at <code>tick</code> has been set, false if it
+hasn’t (regardless of whether it lies within the bounds of the
+object’s capacity).</p>
+<dl>
+<dt>tick</dt>
+<dd><p>The requested bit.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Set">Set</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Set</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>tick</strong>
+);
+</code></pre>
+<p>Set the bit at <code>tick</code> to 1.</p>
+<dl>
+<dt>tick</dt>
+<dd><p>The bit to be set.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Next_Hit">Next_Hit</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>BitVec_Next_Hit</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>tick</strong>
+);
+</code></pre>
+<p>Returns the next set bit equal to or greater than <code>tick</code>,
+or -1 if no such bit exists.</p>
+</dd>
+<dt id="func_Clear">Clear</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Clear</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>tick</strong>
+);
+</code></pre>
+<p>Clear the indicated bit. (i.e. set it to 0).</p>
+<dl>
+<dt>tick</dt>
+<dd><p>The bit to be cleared.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Clear_All">Clear_All</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Clear_All</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>
+);
+</code></pre>
+<p>Clear all bits.</p>
+</dd>
+<dt id="func_Grow">Grow</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Grow</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>capacity</strong>
+);
+</code></pre>
+<p>If the BitVector does not already have enough room to hold the
+indicated number of bits, allocate more memory so that it can.</p>
+<dl>
+<dt>capacity</dt>
+<dd><p>Least number of bits the BitVector should accomodate.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_And">And</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_And</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ const <span class="prefix">lucy_</span>BitVector *<strong>other</strong>
+);
+</code></pre>
+<p>Modify the BitVector so that only bits which remain set are those
+which 1) were already set in this BitVector, and 2) were also set in
+the other BitVector.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another BitVector.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Or">Or</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Or</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ const <span class="prefix">lucy_</span>BitVector *<strong>other</strong>
+);
+</code></pre>
+<p>Modify the BitVector, setting all bits which are set in the other
+BitVector if they were not already set.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another BitVector.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Xor">Xor</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Xor</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ const <span class="prefix">lucy_</span>BitVector *<strong>other</strong>
+);
+</code></pre>
+<p>Modify the BitVector, performing an XOR operation against the other.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another BitVector.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_And_Not">And_Not</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_And_Not</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ const <span class="prefix">lucy_</span>BitVector *<strong>other</strong>
+);
+</code></pre>
+<p>Modify the BitVector, clearing all bits which are set in the other.</p>
+<dl>
+<dt>other</dt>
+<dd><p>Another BitVector.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Flip">Flip</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Flip</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>tick</strong>
+);
+</code></pre>
+<p>Invert the value of a bit.</p>
+<dl>
+<dt>tick</dt>
+<dd><p>The bit to invert.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Flip_Block">Flip_Block</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BitVec_Flip_Block</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>,
+ uint32_t <strong>offset</strong>,
+ uint32_t <strong>length</strong>
+);
+</code></pre>
+<p>Invert each bit within a contiguous block.</p>
+<dl>
+<dt>offset</dt>
+<dd><p>Lower bound.</p>
+</dd>
+<dt>length</dt>
+<dd><p>The number of bits to flip.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Count">Count</dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>BitVec_Count</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>
+);
+</code></pre>
+<p>Return a count of the number of set bits.</p>
+</dd>
+<dt id="func_To_Array">To_Array</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>BitVec_To_Array</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array where each element represents a set bit.</p>
+</dd>
+<dt id="func_Clone">Clone</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>BitVector* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>BitVec_Clone</strong>(
+ <span class="prefix">lucy_</span>BitVector *<strong>self</strong>
+);
+</code></pre>
+<p>Return a clone of the object.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Object::BitVector 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/Object/I32Array.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Object/I32Array.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Object/I32Array.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,184 @@
+<!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::Object::I32Array – 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/Object/">Object</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::Object::I32Array</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>I32ARRAY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>I32Array</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>I32Arr</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Object/I32Array.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Object::I32Array</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>I32Arr_new</strong>(
+ int32_t *<strong>ints</strong>,
+ uint32_t <strong>size</strong>
+);
+</code></pre>
+</dd>
+<dt id="func_new_blank">new_blank</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>I32Arr_new_blank</strong>(
+ uint32_t <strong>size</strong>
+);
+</code></pre>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>I32Array*
+<span class="prefix">lucy_</span><strong>I32Arr_init</strong>(
+ <span class="prefix">lucy_</span>I32Array *<strong>self</strong>,
+ int32_t *<strong>ints</strong>,
+ uint32_t <strong>size</strong>
+);
+</code></pre>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Set">Set</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>I32Arr_Set</strong>(
+ <span class="prefix">lucy_</span>I32Array *<strong>self</strong>,
+ uint32_t <strong>tick</strong>,
+ int32_t <strong>value</strong>
+);
+</code></pre>
+<p>Set the value at <code>tick</code>, or throw an error if
+<code>tick</code> is out of bounds.</p>
+</dd>
+<dt id="func_Get">Get</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>I32Arr_Get</strong>(
+ <span class="prefix">lucy_</span>I32Array *<strong>self</strong>,
+ uint32_t <strong>tick</strong>
+);
+</code></pre>
+<p>Return the value at <code>tick</code>, or throw an error if
+<code>tick</code> is out of bounds.</p>
+</dd>
+<dt id="func_Get_Size">Get_Size</dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>I32Arr_Get_Size</strong>(
+ <span class="prefix">lucy_</span>I32Array *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for ‘size’ member.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Object::I32Array 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/Plan/Architecture.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/Architecture.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/Architecture.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,190 @@
+<!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::Architecture – 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::Architecture</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>ARCHITECTURE</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Architecture</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Arch</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Plan/Architecture.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Plan::Architecture – Configure major components of an index.</p>
+<h3>Description</h3>
+<p>By default, a Lucy index consists of several main parts: lexicon,
+postings, stored documents, deletions, and highlight data. The readers and
+writers for that data are spawned by Architecture. Each component operates
+at the segment level; Architecture’s factory methods are used to build up
+<a href="../../Lucy/Index/SegWriter.html">SegWriter</a> and
+<a href="../../Lucy/Index/SegReader.html">SegReader</a>.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Architecture* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Arch_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>Architecture*
+<span class="prefix">lucy_</span><strong>Arch_init</strong>(
+ <span class="prefix">lucy_</span>Architecture *<strong>self</strong>
+);
+</code></pre>
+<p>Initialize an Architecture.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Register_Doc_Writer">Register_Doc_Writer</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Arch_Register_Doc_Writer</strong>(
+ <span class="prefix">lucy_</span>Architecture *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegWriter.html">SegWriter</a> *<strong>writer</strong>
+);
+</code></pre>
+<p>Spawn a DataWriter and <a href="../../Lucy/Index/SegWriter.html#func_Register">Register()</a> it with the supplied SegWriter,
+adding it to the SegWriter’s writer stack.</p>
+<dl>
+<dt>writer</dt>
+<dd><p>A SegWriter.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Register_Doc_Reader">Register_Doc_Reader</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Arch_Register_Doc_Reader</strong>(
+ <span class="prefix">lucy_</span>Architecture *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong>
+);
+</code></pre>
+<p>Spawn a DocReader and register it with the supplied SegReader.</p>
+<dl>
+<dt>reader</dt>
+<dd><p>A SegReader.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Arch_Equals</strong>(
+ <span class="prefix">lucy_</span>Architecture *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Returns true for any Architecture object. Subclasses should override
+this weak check.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Plan::Architecture 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/Plan/BlobType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/BlobType.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/BlobType.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,255 @@
+<!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::BlobType – 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::BlobType</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>BLOBTYPE</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>BlobType</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>BlobType</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Plan/BlobType.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Plan::BlobType – Default behaviors for binary fields.</p>
+<h3>Description</h3>
+<p>BlobType is an implementation of FieldType tuned for use with fields
+containing binary data, which cannot be indexed or searched – only stored.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>BlobType* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>BlobType_new</strong>(
+ bool <strong>stored</strong>
+);
+</code></pre>
+<p>Create a new BlobType.</p>
+<dl>
+<dt>stored</dt>
+<dd><p>boolean indicating whether the field should be stored.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_init">init</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>BlobType*
+<span class="prefix">lucy_</span><strong>BlobType_init</strong>(
+ <span class="prefix">lucy_</span>BlobType *<strong>self</strong>,
+ bool <strong>stored</strong>
+);
+</code></pre>
+<p>Initialize a BlobType.</p>
+<dl>
+<dt>stored</dt>
+<dd><p>boolean indicating whether the field should be stored.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Binary">Binary</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>BlobType_Binary</strong>(
+ <span class="prefix">lucy_</span>BlobType *<strong>self</strong>
+);
+</code></pre>
+<p>Returns true.</p>
+</dd>
+<dt id="func_Set_Sortable">Set_Sortable</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>BlobType_Set_Sortable</strong>(
+ <span class="prefix">lucy_</span>BlobType *<strong>self</strong>,
+ bool <strong>sortable</strong>
+);
+</code></pre>
+<p>Throws an error unless <code>sortable</code> is false.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>BlobType_Equals</strong>(
+ <span class="prefix">lucy_</span>BlobType *<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>BlobType_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>BlobType *<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>BlobType_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>BlobType *<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>BlobType_Set_Indexed</strong>(
+ <span class="prefix">lucy_</span>BlobType *<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>BlobType_Indexed</strong>(
+ <span class="prefix">lucy_</span>BlobType *<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>BlobType_Set_Stored</strong>(
+ <span class="prefix">lucy_</span>BlobType *<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>BlobType_Stored</strong>(
+ <span class="prefix">lucy_</span>BlobType *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>stored</code>.</p>
+</dd>
+<dt id="func_Sortable">Sortable</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>BlobType_Sortable</strong>(
+ <span class="prefix">lucy_</span>BlobType *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for <code>sortable</code>.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Plan::BlobType 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/Plan/FieldType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/FieldType.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/FieldType.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,239 @@
+<!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::FieldType – 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::FieldType</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>FIELDTYPE</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>FieldType</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>FType</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Plan/FieldType.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Plan::FieldType – Define a field’s behavior.</p>
+<h3>Description</h3>
+<p>FieldType is an abstract class defining a set of traits and behaviors which
+may be associated with one or more field names.</p>
+<p>Properties which are common to all field types include <code>boost</code>,
+<code>indexed</code>, <code>stored</code>, <code>sortable</code>,
+<code>binary</code>, and <code>similarity</code>.</p>
+<p>The <code>boost</code> property is a floating point scoring multiplier
+which defaults to 1.0. Values greater than 1.0 cause the field to
+contribute more to a document’s score, lower values, less.</p>
+<p>The <code>indexed</code> property indicates whether the field should be
+indexed (so that it can be searched).</p>
+<p>The <code>stored</code> property indicates whether to store the raw field
+value, so that it can be retrieved when a document turns up in a search.</p>
+<p>The <code>sortable</code> property indicates whether search results should
+be sortable based on the contents of the field.</p>
+<p>The <code>binary</code> property indicates whether the field contains
+binary or text data. Unlike most other properties, <code>binary</code> is
+not settable.</p>
+<p>The <code>similarity</code> property is a
+<a href="../../Lucy/Index/Similarity.html">Similarity</a> object which defines matching
+and scoring behavior for the field. It is required if the field is
+<code>indexed</code>.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Set_Boost">Set_Boost</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>FType_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Set_Indexed</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Indexed</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Set_Stored</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Stored</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Set_Sortable</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Sortable</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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>FType_Binary</strong>(
+ <span class="prefix">lucy_</span>FieldType *<strong>self</strong>
+);
+</code></pre>
+<p>Indicate whether the field contains binary data.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>FType_Equals</strong>(
+ <span class="prefix">lucy_</span>FieldType *<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::FieldType 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/Plan/FullTextType.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/FullTextType.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/FullTextType.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,315 @@
+<!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/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::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>
+</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>FullTextType_Set_Boost</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Get_Boost</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Set_Indexed</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Indexed</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Set_Stored</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Stored</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Set_Sortable</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Sortable</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<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>FullTextType_Binary</strong>(
+ <span class="prefix">lucy_</span>FullTextType *<strong>self</strong>
+);
+</code></pre>
+<p>Indicate whether the field contains binary data.</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/0.5.0/c/Lucy/Plan/Schema.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/Schema.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Plan/Schema.html Wed Sep 28 12:07:48 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::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/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::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>
+</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>