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 [9/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/PolyReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/PolyReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/PolyReader.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,346 @@
+<!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::PolyReader – 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::PolyReader</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>POLYREADER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>PolyReader</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>PolyReader</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/PolyReader.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::PolyReader – Multi-segment implementation of IndexReader.</p>
+<h3>Description</h3>
+<p>PolyReader conflates index data from multiple segments. For instance, if
+an index contains three segments with 10 documents each, PolyReader’s
+<a href="../../Lucy/Index/PolyReader.html#func_Doc_Max">Doc_Max()</a> method will return 30.</p>
+<p>Some of PolyReader’s <a href="../../Lucy/Index/DataReader.html">DataReader</a> components
+may be less efficient or complete than the single-segment implementations
+accessed via <a href="../../Lucy/Index/SegReader.html">SegReader</a>.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_open">open</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>PolyReader* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PolyReader_open</strong>(
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a> *<strong>snapshot</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/IndexManager.html">IndexManager</a> *<strong>manager</strong>
+);
+</code></pre>
+<p>Create and open a PolyReader.</p>
+<dl>
+<dt>index</dt>
+<dd><p>Either a string filepath or a <a href="../../Lucy/Store/Folder.html">Folder</a>.</p>
+</dd>
+<dt>snapshot</dt>
+<dd><p>A Snapshot. If not supplied, the most recent snapshot
+file will be used.</p>
+</dd>
+<dt>manager</dt>
+<dd><p>An <a href="../../Lucy/Index/IndexManager.html">IndexManager</a>.
+Read-locking is off by default; supplying this argument turns it on.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_do_open">do_open</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>PolyReader*
+<span class="prefix">lucy_</span><strong>PolyReader_do_open</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a> *<strong>snapshot</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/IndexManager.html">IndexManager</a> *<strong>manager</strong>
+);
+</code></pre>
+<p>Initialize and open a PolyReader.</p>
+<dl>
+<dt>index</dt>
+<dd><p>Either a string filepath or a <a href="../../Lucy/Store/Folder.html">Folder</a>.</p>
+</dd>
+<dt>snapshot</dt>
+<dd><p>A Snapshot. If not supplied, the most recent snapshot
+file will be used.</p>
+</dd>
+<dt>manager</dt>
+<dd><p>An <a href="../../Lucy/Index/IndexManager.html">IndexManager</a>.
+Read-locking is off by default; supplying this argument turns it on.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Doc_Max">Doc_Max</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PolyReader_Doc_Max</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the maximum number of documents available to the reader, which
+is also the highest possible internal document id. Documents which
+have been marked as deleted but not yet purged from the index are
+included in this count.</p>
+</dd>
+<dt id="func_Doc_Count">Doc_Count</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PolyReader_Doc_Count</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of documents available to the reader, subtracting
+any that are marked as deleted.</p>
+</dd>
+<dt id="func_Del_Count">Del_Count</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PolyReader_Del_Count</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of documents which have been marked as deleted but
+not yet purged from the index.</p>
+</dd>
+<dt id="func_Offsets">Offsets</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>PolyReader_Offsets</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array with one entry for each segment, corresponding to
+segment doc_id start offset.</p>
+</dd>
+<dt id="func_Seg_Readers">Seg_Readers</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>PolyReader_Seg_Readers</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array of all the SegReaders represented within the
+IndexReader.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::IndexReader</h4>
+<dl>
+<dt id="func_Obtain">Obtain</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>*
+<span class="prefix">lucy_</span><strong>PolyReader_Obtain</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>
+);
+</code></pre>
+<p>Fetch a component, or throw an error if the component can’t be found.</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataReader subclass that the desired
+component must implement.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Fetch">Fetch</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>*
+<span class="prefix">lucy_</span><strong>PolyReader_Fetch</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>
+);
+</code></pre>
+<p>Fetch a component, or return NULL if the component can’t be
+found.</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataReader subclass that the desired
+component must implement.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::DataReader</h4>
+<dl>
+<dt id="func_Aggregator">Aggregator <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PolyReader_Aggregator</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>readers</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>offsets</strong>
+);
+</code></pre>
+<p>Create a reader which aggregates the output of several lower level
+readers. Return NULL if such a reader is not valid.</p>
+<dl>
+<dt>readers</dt>
+<dd><p>An array of DataReaders.</p>
+</dd>
+<dt>offsets</dt>
+<dd><p>Doc id start offsets for each reader.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Get_Schema">Get_Schema</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a>*
+<span class="prefix">lucy_</span><strong>PolyReader_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “schema” member var.</p>
+</dd>
+<dt id="func_Get_Folder">Get_Folder</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a>*
+<span class="prefix">lucy_</span><strong>PolyReader_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “folder” member var.</p>
+</dd>
+<dt id="func_Get_Snapshot">Get_Snapshot</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a>*
+<span class="prefix">lucy_</span><strong>PolyReader_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “snapshot” member var.</p>
+</dd>
+<dt id="func_Get_Segments">Get_Segments</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>*
+<span class="prefix">lucy_</span><strong>PolyReader_Get_Segments</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “segments” member var.</p>
+</dd>
+<dt id="func_Get_Segment">Get_Segment</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Segment.html">Segment</a>*
+<span class="prefix">lucy_</span><strong>PolyReader_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “segment” member var.</p>
+</dd>
+<dt id="func_Get_Seg_Tick">Get_Seg_Tick</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PolyReader_Get_Seg_Tick</strong>(
+ <span class="prefix">lucy_</span>PolyReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “seg_tick” member var.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::PolyReader is a <a href="../../Lucy/Index/IndexReader.html">Lucy::Index::IndexReader</a> is a <a href="../../Lucy/Index/DataReader.html">Lucy::Index::DataReader</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/Index/PostingList.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/PostingList.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/PostingList.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,208 @@
+<!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::PostingList – 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::PostingList</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>POSTINGLIST</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>PostingList</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>PList</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/PostingList.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::PostingList – Term-Document pairings.</p>
+<h3>Description</h3>
+<p>PostingList is an iterator which supplies a list of document ids that match
+a given term.</p>
+<p>See <a href="../../Lucy/Docs/IRTheory.html">IRTheory</a> for definitions of “posting” and
+“posting list”.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get_Doc_Freq">Get_Doc_Freq <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>uint32_t
+<span class="prefix">lucy_</span><strong>PList_Get_Doc_Freq</strong>(
+ <span class="prefix">lucy_</span>PostingList *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of documents that the PostingList contains. (This
+number will include any documents which have been marked as deleted but
+not yet purged.)</p>
+</dd>
+<dt id="func_Seek">Seek <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>PList_Seek</strong>(
+ <span class="prefix">lucy_</span>PostingList *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>target</strong>
+);
+</code></pre>
+<p>Prepare the PostingList object to iterate over matches for documents
+that match <code>target</code>.</p>
+<dl>
+<dt>target</dt>
+<dd><p>The term to match. If NULL, the iterator will
+be empty.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Search::Matcher</h4>
+<dl>
+<dt id="func_Next">Next <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PList_Next</strong>(
+ <span class="prefix">lucy_</span>PostingList *<strong>self</strong>
+);
+</code></pre>
+<p>Proceed to the next doc id.</p>
+<p><strong>Returns:</strong> A positive doc id, or 0 once the iterator is exhausted.</p>
+</dd>
+<dt id="func_Advance">Advance</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PList_Advance</strong>(
+ <span class="prefix">lucy_</span>PostingList *<strong>self</strong>,
+ int32_t <strong>target</strong>
+);
+</code></pre>
+<p>Advance the iterator to the first doc id greater than or equal to
+<code>target</code>. The default implementation simply calls <a href="../../Lucy/Index/PostingList.html#func_Next">Next()</a>
+over and over, but subclasses have the option of doing something more
+efficient.</p>
+<dl>
+<dt>target</dt>
+<dd><p>A positive doc id, which must be greater than the current
+doc id once the iterator has been initialized.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> A positive doc id, or 0 once the iterator is exhausted.</p>
+</dd>
+<dt id="func_Get_Doc_ID">Get_Doc_ID <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PList_Get_Doc_ID</strong>(
+ <span class="prefix">lucy_</span>PostingList *<strong>self</strong>
+);
+</code></pre>
+<p>Return the current doc id. Valid only after a successful call to
+<a href="../../Lucy/Index/PostingList.html#func_Next">Next()</a> or <a href="../../Lucy/Index/PostingList.html#func_Advance">Advance()</a> and must not be called otherwise.</p>
+</dd>
+<dt id="func_Score">Score <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>PList_Score</strong>(
+ <span class="prefix">lucy_</span>PostingList *<strong>self</strong>
+);
+</code></pre>
+<p>Return the score of the current document.</p>
+<p>Only Matchers which are used for scored search need implement <a href="../../Lucy/Index/PostingList.html#func_Score">Score()</a>.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::PostingList is a <a href="../../Lucy/Search/Matcher.html">Lucy::Search::Matcher</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/Index/PostingListReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/PostingListReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/PostingListReader.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,215 @@
+<!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::PostingListReader – 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::PostingListReader</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>POSTINGLISTREADER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>PostingListReader</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>PListReader</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/PostingListReader.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::PostingListReader – Read postings data.</p>
+<h3>Description</h3>
+<p>PostingListReaders produce <a href="../../Lucy/Index/PostingList.html">PostingList</a>
+objects which convey document matching information.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Posting_List">Posting_List <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/PostingList.html">PostingList</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PListReader_Posting_List</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<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>Returns a PostingList, or NULL if either <code>field</code> is
+NULL or <code>field</code> is not present in any documents.</p>
+<dl>
+<dt>field</dt>
+<dd><p>A field name.</p>
+</dd>
+<dt>term</dt>
+<dd><p>If supplied, the PostingList will be pre-located to this
+term using <a href="../../Lucy/Index/PostingList.html#func_Seek">Seek()</a>.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Aggregator">Aggregator</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>PostingListReader* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>PListReader_Aggregator</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>readers</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>offsets</strong>
+);
+</code></pre>
+<p>Returns NULL since PostingLists may only be iterated at the
+segment level.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::DataReader</h4>
+<dl>
+<dt id="func_Get_Schema">Get_Schema</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a>*
+<span class="prefix">lucy_</span><strong>PListReader_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “schema” member var.</p>
+</dd>
+<dt id="func_Get_Folder">Get_Folder</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a>*
+<span class="prefix">lucy_</span><strong>PListReader_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “folder” member var.</p>
+</dd>
+<dt id="func_Get_Snapshot">Get_Snapshot</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a>*
+<span class="prefix">lucy_</span><strong>PListReader_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “snapshot” member var.</p>
+</dd>
+<dt id="func_Get_Segments">Get_Segments</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>*
+<span class="prefix">lucy_</span><strong>PListReader_Get_Segments</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “segments” member var.</p>
+</dd>
+<dt id="func_Get_Segment">Get_Segment</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Segment.html">Segment</a>*
+<span class="prefix">lucy_</span><strong>PListReader_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “segment” member var.</p>
+</dd>
+<dt id="func_Get_Seg_Tick">Get_Seg_Tick</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>PListReader_Get_Seg_Tick</strong>(
+ <span class="prefix">lucy_</span>PostingListReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “seg_tick” member var.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::PostingListReader is a <a href="../../Lucy/Index/DataReader.html">Lucy::Index::DataReader</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/Index/SegReader.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/SegReader.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/SegReader.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,312 @@
+<!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::SegReader – 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::SegReader</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>SEGREADER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>SegReader</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>SegReader</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/SegReader.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::SegReader – Single-segment IndexReader.</p>
+<h3>Description</h3>
+<p>SegReader interprets the data within a single segment of an index.</p>
+<p>Generally speaking, only advanced users writing subclasses which manipulate
+data at the segment level need to deal with the SegReader API directly.</p>
+<p>Nearly all of SegReader’s functionality is implemented by pluggable
+components spawned by <a href="../../Lucy/Plan/Architecture.html">Architecture</a>’s
+factory methods.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Get_Seg_Name">Get_Seg_Name</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Get_Seg_Name</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the name of the segment.</p>
+</dd>
+<dt id="func_Get_Seg_Num">Get_Seg_Num</dt>
+<dd>
+<pre><code>int64_t
+<span class="prefix">lucy_</span><strong>SegReader_Get_Seg_Num</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of the segment.</p>
+</dd>
+<dt id="func_Del_Count">Del_Count</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>SegReader_Del_Count</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of documents which have been marked as deleted but
+not yet purged from the index.</p>
+</dd>
+<dt id="func_Doc_Max">Doc_Max</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>SegReader_Doc_Max</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the maximum number of documents available to the reader, which
+is also the highest possible internal document id. Documents which
+have been marked as deleted but not yet purged from the index are
+included in this count.</p>
+</dd>
+<dt id="func_Doc_Count">Doc_Count</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>SegReader_Doc_Count</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return the number of documents available to the reader, subtracting
+any that are marked as deleted.</p>
+</dd>
+<dt id="func_Offsets">Offsets</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>SegReader_Offsets</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array with one entry for each segment, corresponding to
+segment doc_id start offset.</p>
+</dd>
+<dt id="func_Seg_Readers">Seg_Readers</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>SegReader_Seg_Readers</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Return an array of all the SegReaders represented within the
+IndexReader.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::IndexReader</h4>
+<dl>
+<dt id="func_Obtain">Obtain</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Obtain</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>
+);
+</code></pre>
+<p>Fetch a component, or throw an error if the component can’t be found.</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataReader subclass that the desired
+component must implement.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Fetch">Fetch</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Fetch</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>
+);
+</code></pre>
+<p>Fetch a component, or return NULL if the component can’t be
+found.</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataReader subclass that the desired
+component must implement.</p>
+</dd>
+</dl>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::DataReader</h4>
+<dl>
+<dt id="func_Aggregator">Aggregator <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/DataReader.html">DataReader</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SegReader_Aggregator</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>readers</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>offsets</strong>
+);
+</code></pre>
+<p>Create a reader which aggregates the output of several lower level
+readers. Return NULL if such a reader is not valid.</p>
+<dl>
+<dt>readers</dt>
+<dd><p>An array of DataReaders.</p>
+</dd>
+<dt>offsets</dt>
+<dd><p>Doc id start offsets for each reader.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Get_Schema">Get_Schema</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “schema” member var.</p>
+</dd>
+<dt id="func_Get_Folder">Get_Folder</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “folder” member var.</p>
+</dd>
+<dt id="func_Get_Snapshot">Get_Snapshot</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “snapshot” member var.</p>
+</dd>
+<dt id="func_Get_Segments">Get_Segments</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Get_Segments</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “segments” member var.</p>
+</dd>
+<dt id="func_Get_Segment">Get_Segment</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Segment.html">Segment</a>*
+<span class="prefix">lucy_</span><strong>SegReader_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “segment” member var.</p>
+</dd>
+<dt id="func_Get_Seg_Tick">Get_Seg_Tick</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>SegReader_Get_Seg_Tick</strong>(
+ <span class="prefix">lucy_</span>SegReader *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “seg_tick” member var.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::SegReader is a <a href="../../Lucy/Index/IndexReader.html">Lucy::Index::IndexReader</a> is a <a href="../../Lucy/Index/DataReader.html">Lucy::Index::DataReader</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/Index/SegWriter.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/SegWriter.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/SegWriter.html Wed Sep 28 12:07:48 2016
@@ -0,0 +1,339 @@
+<!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::SegWriter – 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::SegWriter</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>SEGWRITER</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>SegWriter</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>SegWriter</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/SegWriter.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::SegWriter – Write one segment of an index.</p>
+<h3>Description</h3>
+<p>SegWriter is a conduit through which information fed to Indexer passes. It
+manages <a href="../../Lucy/Index/Segment.html">Segment</a> and Inverter, invokes the
+<a href="../../Lucy/Analysis/Analyzer.html">Analyzer</a> chain, and feeds low
+level <a href="../../Lucy/Index/DataWriter.html">DataWriters</a> such as
+PostingListWriter and DocWriter.</p>
+<p>The sub-components of a SegWriter are determined by
+<a href="../../Lucy/Plan/Architecture.html">Architecture</a>. DataWriter components
+which are added to the stack of writers via <a href="../../Lucy/Index/SegWriter.html#func_Add_Writer">Add_Writer()</a> have
+Add_Inverted_Doc() invoked for each document supplied to SegWriter’s
+<a href="../../Lucy/Index/SegWriter.html#func_Add_Doc">Add_Doc()</a>.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Register">Register</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SegWriter_Register</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/DataWriter.html">DataWriter</a> *<strong>component</strong> <span class="comment">// decremented</span>
+);
+</code></pre>
+<p>Register a DataWriter component with the SegWriter. (Note that
+registration simply makes the writer available via <a href="../../Lucy/Index/SegWriter.html#func_Fetch">Fetch()</a>, so you may
+also want to call <a href="../../Lucy/Index/SegWriter.html#func_Add_Writer">Add_Writer()</a>).</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataWriter api which <code>writer</code>
+implements.</p>
+</dd>
+<dt>component</dt>
+<dd><p>A DataWriter.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Fetch">Fetch</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>*
+<span class="prefix">lucy_</span><strong>SegWriter_Fetch</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>api</strong>
+);
+</code></pre>
+<p>Retrieve a registered component.</p>
+<dl>
+<dt>api</dt>
+<dd><p>The name of the DataWriter api which the component
+implements.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Add_Writer">Add_Writer</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SegWriter_Add_Writer</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/DataWriter.html">DataWriter</a> *<strong>writer</strong> <span class="comment">// decremented</span>
+);
+</code></pre>
+<p>Add a DataWriter to the SegWriter’s stack of writers.</p>
+</dd>
+<dt id="func_Add_Doc">Add_Doc</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SegWriter_Add_Doc</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Document/Doc.html">Doc</a> *<strong>doc</strong>,
+ float <strong>boost</strong>
+);
+</code></pre>
+<p>Add a document to the segment. Inverts <code>doc</code>, increments
+the Segment’s internal document id, then calls Add_Inverted_Doc(),
+feeding all sub-writers.</p>
+</dd>
+<dt id="func_Add_Segment">Add_Segment</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SegWriter_Add_Segment</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>doc_map</strong>
+);
+</code></pre>
+<p>Add content from an existing segment into the one currently being
+written.</p>
+<dl>
+<dt>reader</dt>
+<dd><p>The SegReader containing content to add.</p>
+</dd>
+<dt>doc_map</dt>
+<dd><p>An array of integers mapping old document ids to
+new. Deleted documents are mapped to 0, indicating that they should be
+skipped.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Merge_Segment">Merge_Segment</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SegWriter_Merge_Segment</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a> *<strong>doc_map</strong>
+);
+</code></pre>
+<p>Move content from an existing segment into the one currently being
+written.</p>
+<p>The default implementation calls <a href="../../Lucy/Index/SegWriter.html#func_Add_Segment">Add_Segment()</a> then <a href="../../Lucy/Index/SegWriter.html#func_Delete_Segment">Delete_Segment()</a>.</p>
+<dl>
+<dt>reader</dt>
+<dd><p>The SegReader containing content to merge, which must
+represent a segment which is part of the the current snapshot.</p>
+</dd>
+<dt>doc_map</dt>
+<dd><p>An array of integers mapping old document ids to
+new. Deleted documents are mapped to 0, indicating that they should be
+skipped.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Delete_Segment">Delete_Segment</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SegWriter_Delete_Segment</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>,
+ <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong>
+);
+</code></pre>
+<p>Remove a segment’s data. The default implementation is a no-op, as
+all files within the segment directory will be automatically deleted.
+Subclasses which manage their own files outside of the segment system
+should override this method and use it as a trigger for cleaning up
+obsolete data.</p>
+<dl>
+<dt>reader</dt>
+<dd><p>The SegReader containing content to merge, which must
+represent a segment which is part of the the current snapshot.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Finish">Finish</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>SegWriter_Finish</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Complete the segment: close all streams, store metadata, etc.</p>
+</dd>
+</dl>
+<h4>Methods inherited from Lucy::Index::DataWriter</h4>
+<dl>
+<dt id="func_Metadata">Metadata</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Hash.html">Hash</a>* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>SegWriter_Metadata</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Arbitrary metadata to be serialized and stored by the Segment. The
+default implementation supplies a hash with a single key-value pair for
+“format”.</p>
+</dd>
+<dt id="func_Format">Format <span class="comment">(abstract)</span></dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>SegWriter_Format</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Every writer must specify a file format revision number, which should
+increment each time the format changes. Responsibility for revision
+checking is left to the companion DataReader.</p>
+</dd>
+<dt id="func_Get_Snapshot">Get_Snapshot</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Snapshot.html">Snapshot</a>*
+<span class="prefix">lucy_</span><strong>SegWriter_Get_Snapshot</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “snapshot” member var.</p>
+</dd>
+<dt id="func_Get_Segment">Get_Segment</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Segment.html">Segment</a>*
+<span class="prefix">lucy_</span><strong>SegWriter_Get_Segment</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “segment” member var.</p>
+</dd>
+<dt id="func_Get_PolyReader">Get_PolyReader</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/PolyReader.html">PolyReader</a>*
+<span class="prefix">lucy_</span><strong>SegWriter_Get_PolyReader</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “polyreader” member var.</p>
+</dd>
+<dt id="func_Get_Schema">Get_Schema</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a>*
+<span class="prefix">lucy_</span><strong>SegWriter_Get_Schema</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “schema” member var.</p>
+</dd>
+<dt id="func_Get_Folder">Get_Folder</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a>*
+<span class="prefix">lucy_</span><strong>SegWriter_Get_Folder</strong>(
+ <span class="prefix">lucy_</span>SegWriter *<strong>self</strong>
+);
+</code></pre>
+<p>Accessor for “folder” member var.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::SegWriter is a <a href="../../Lucy/Index/DataWriter.html">Lucy::Index::DataWriter</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/Index/Segment.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Segment.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Segment.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::Index::Segment – 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::Segment</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>SEGMENT</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Segment</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Seg</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/Segment.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::Segment – Warehouse for information about one segment of an inverted index.</p>
+<h3>Description</h3>
+<p>Apache Lucy’s indexes are made up of individual “segments”, each of which is
+is an independent inverted index. On the file system, each segment is a
+directory within the main index directory whose name starts with “seg_”:
+“seg_2”, “seg_5a”, etc.</p>
+<p>Each Segment object keeps track of information about an index segment: its
+fields, document count, and so on. The Segment object itself writes one
+file, <code>segmeta.json</code>; besides storing info needed by Segment
+itself, the “segmeta” file serves as a central repository for metadata
+generated by other index components – relieving them of the burden of
+storing metadata themselves.</p>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Add_Field">Add_Field</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>Seg_Add_Field</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>
+);
+</code></pre>
+<p>Register a new field and assign it a field number. If the field was
+already known, nothing happens.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+</dl>
+<p><strong>Returns:</strong> the field’s field number, which is a positive integer.</p>
+</dd>
+<dt id="func_Store_Metadata">Store_Metadata</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Seg_Store_Metadata</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>key</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>metadata</strong> <span class="comment">// decremented</span>
+);
+</code></pre>
+<p>Store arbitrary information in the segment’s metadata hash, to be
+serialized later. Throws an error if <code>key</code> is used twice.</p>
+<dl>
+<dt>key</dt>
+<dd><p>String identifying an index component.</p>
+</dd>
+<dt>metadata</dt>
+<dd><p>JSON-izable data structure.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Fetch_Metadata">Fetch_Metadata</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>*
+<span class="prefix">lucy_</span><strong>Seg_Fetch_Metadata</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>key</strong>
+);
+</code></pre>
+<p>Fetch a value from the Segment’s metadata hash.</p>
+</dd>
+<dt id="func_Field_Num">Field_Num</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>Seg_Field_Num</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>
+);
+</code></pre>
+<p>Given a field name, return its field number for this segment (which
+may differ from its number in other segments). Return 0 (an invalid
+field number) if the field name can’t be found.</p>
+<dl>
+<dt>field</dt>
+<dd><p>Field name.</p>
+</dd>
+</dl>
+</dd>
+<dt id="func_Field_Name">Field_Name</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>*
+<span class="prefix">lucy_</span><strong>Seg_Field_Name</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>,
+ int32_t <strong>field_num</strong>
+);
+</code></pre>
+<p>Given a field number, return the name of its field, or NULL
+if the field name can’t be found.</p>
+</dd>
+<dt id="func_Get_Name">Get_Name</dt>
+<dd>
+<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>*
+<span class="prefix">lucy_</span><strong>Seg_Get_Name</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>
+);
+</code></pre>
+<p>Getter for the object’s seg name.</p>
+</dd>
+<dt id="func_Get_Number">Get_Number</dt>
+<dd>
+<pre><code>int64_t
+<span class="prefix">lucy_</span><strong>Seg_Get_Number</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>
+);
+</code></pre>
+<p>Getter for the segment number.</p>
+</dd>
+<dt id="func_Set_Count">Set_Count</dt>
+<dd>
+<pre><code>void
+<span class="prefix">lucy_</span><strong>Seg_Set_Count</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>,
+ int64_t <strong>count</strong>
+);
+</code></pre>
+<p>Setter for the object’s document count.</p>
+</dd>
+<dt id="func_Get_Count">Get_Count</dt>
+<dd>
+<pre><code>int64_t
+<span class="prefix">lucy_</span><strong>Seg_Get_Count</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>
+);
+</code></pre>
+<p>Getter for the object’s document count.</p>
+</dd>
+<dt id="func_Compare_To">Compare_To</dt>
+<dd>
+<pre><code>int32_t
+<span class="prefix">lucy_</span><strong>Seg_Compare_To</strong>(
+ <span class="prefix">lucy_</span>Segment *<strong>self</strong>,
+ <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong>
+);
+</code></pre>
+<p>Compare by segment number.</p>
+</dd>
+</dl>
+<h3>Inheritance</h3>
+<p>Lucy::Index::Segment 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/Index/Similarity.html
==============================================================================
--- websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Similarity.html (added)
+++ websites/staging/lucy/trunk/content/docs/0.5.0/c/Lucy/Index/Similarity.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::Index::Similarity – 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::Similarity</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>SIMILARITY</code></td>
+</tr>
+<tr>
+<td class="label">struct symbol</td>
+<td><code><span class="prefix">lucy_</span>Similarity</code></td>
+</tr>
+<tr>
+<td class="label">class nickname</td>
+<td><code><span class="prefix">lucy_</span>Sim</code></td>
+</tr>
+<tr>
+<td class="label">header file</td>
+<td><code>Lucy/Index/Similarity.h</code></td>
+</tr>
+</table>
+<h3>Name</h3>
+<p>Lucy::Index::Similarity – Judge how well a document matches a query.</p>
+<h3>Description</h3>
+<p>After determining whether a document matches a given query, a score must be
+calculated which indicates how <em>well</em> the document matches the query. The
+Similarity class is used to judge how “similar” the query and the document
+are to each other; the closer the resemblance, they higher the document
+scores.</p>
+<p>The default implementation uses Lucene’s modified cosine similarity
+measure. Subclasses might tweak the existing algorithms, or might be used
+in conjunction with custom Query subclasses to implement arbitrary scoring
+schemes.</p>
+<p>Most of the methods operate on single fields, but some are used to combine
+scores from multiple fields.</p>
+<h3>Functions</h3>
+<dl>
+<dt id="func_new">new</dt>
+<dd>
+<pre><code><span class="prefix">lucy_</span>Similarity* <span class="comment">// incremented</span>
+<span class="prefix">lucy_</span><strong>Sim_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>Similarity*
+<span class="prefix">lucy_</span><strong>Sim_init</strong>(
+ <span class="prefix">lucy_</span>Similarity *<strong>self</strong>
+);
+</code></pre>
+<p>Initialize a Similarity.</p>
+</dd>
+</dl>
+<h3>Methods</h3>
+<dl>
+<dt id="func_Length_Norm">Length_Norm</dt>
+<dd>
+<pre><code>float
+<span class="prefix">lucy_</span><strong>Sim_Length_Norm</strong>(
+ <span class="prefix">lucy_</span>Similarity *<strong>self</strong>,
+ uint32_t <strong>num_tokens</strong>
+);
+</code></pre>
+<p>Dampen the scores of long documents.</p>
+<p>After a field is broken up into terms at index-time, each term must be
+assigned a weight. One of the factors in calculating this weight is
+the number of tokens that the original field was broken into.</p>
+<p>Typically, we assume that the more tokens in a field, the less
+important any one of them is – so that, e.g. 5 mentions of “Kafka” in
+a short article are given more heft than 5 mentions of “Kafka” in an
+entire book. The default implementation of length_norm expresses this
+using an inverted square root.</p>
+<p>However, the inverted square root has a tendency to reward very short
+fields highly, which isn’t always appropriate for fields you expect to
+have a lot of tokens on average.</p>
+</dd>
+<dt id="func_Equals">Equals</dt>
+<dd>
+<pre><code>bool
+<span class="prefix">lucy_</span><strong>Sim_Equals</strong>(
+ <span class="prefix">lucy_</span>Similarity *<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::Index::Similarity 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>