Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/IndexReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/IndexReader.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/IndexReader.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,283 @@ +<!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::IndexReader â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/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::IndexReader</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>INDEXREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>IndexReader</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>IxReader</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/IndexReader.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::IndexReader â Read from an inverted index.</p> +<h3>Description</h3> +<p>IndexReader is the interface through which +<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a> objects access the +content of an index.</p> +<p>IndexReader objects always represent a point-in-time view of an index as it +existed at the moment the reader was created. If you want search results +to reflect modifications to an index, you must create a new IndexReader +after the update process completes.</p> +<p>IndexReaders are composites; most of the work is done by individual +<a href="../../Lucy/Index/DataReader.html">DataReader</a> sub-components, which may be +accessed via <a href="../../Lucy/Index/IndexReader.html#func_Fetch">Fetch()</a> and <a href="../../Lucy/Index/IndexReader.html#func_Obtain">Obtain()</a>. The most efficient and powerful access +to index data happens at the segment level via +<a href="../../Lucy/Index/SegReader.html">SegReader</a>âs sub-components.</p> +<h3>Functions</h3> +<dl> +<dt id="func_open">open</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>IndexReader* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>IxReader_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>IndexReader is an abstract base class; open() returns the IndexReader +subclass PolyReader, which channels the output of 0 or more SegReaders.</p> +<dl> +<dt>index</dt> +<dd><p>Either a string filepath or a Folder.</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>IndexReader* +<span class="prefix">lucy_</span><strong>IxReader_do_open</strong>( + <span class="prefix">lucy_</span>IndexReader *<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 an IndexReader.</p> +<dl> +<dt>index</dt> +<dd><p>Either a string filepath or a Folder.</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 <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>IxReader_Doc_Max</strong>( + <span class="prefix">lucy_</span>IndexReader *<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 <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>IxReader_Doc_Count</strong>( + <span class="prefix">lucy_</span>IndexReader *<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 <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>IxReader_Del_Count</strong>( + <span class="prefix">lucy_</span>IndexReader *<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 <span class="comment">(abstract)</span></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>IxReader_Offsets</strong>( + <span class="prefix">lucy_</span>IndexReader *<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 <span class="comment">(abstract)</span></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>IxReader_Seg_Readers</strong>( + <span class="prefix">lucy_</span>IndexReader *<strong>self</strong> +); +</code></pre> +<p>Return an array of all the SegReaders represented within the +IndexReader.</p> +</dd> +<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>IxReader_Obtain</strong>( + <span class="prefix">lucy_</span>IndexReader *<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>IxReader_Fetch</strong>( + <span class="prefix">lucy_</span>IndexReader *<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> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>IxReader_Destroy</strong>( + <span class="prefix">lucy_</span>IndexReader *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::IndexReader 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/c/Lucy/Index/Indexer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Indexer.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Indexer.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,350 @@ +<!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::Indexer â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/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::Indexer</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>INDEXER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Indexer</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Indexer</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/Indexer.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::Indexer â Build inverted indexes.</p> +<h3>Description</h3> +<p>The Indexer class is Apache Lucyâs primary tool for managing the content of +inverted indexes, which may later be searched using +<a href="../../Lucy/Search/IndexSearcher.html">IndexSearcher</a>.</p> +<p>In general, only one Indexer at a time may write to an index safely. If a +write lock cannot be secured, new() will throw an exception.</p> +<p>If an index is located on a shared volume, each writer application must +identify itself by supplying an +<a href="../../Lucy/Index/IndexManager.html">IndexManager</a> with a unique +<code>host</code> id to Indexerâs constructor or index corruption will +occur. See <a href="../../Lucy/Docs/FileLocking.html">FileLocking</a> for a detailed +discussion.</p> +<p>Note: at present, <a href="../../Lucy/Index/Indexer.html#func_Delete_By_Term">Delete_By_Term()</a> and <a href="../../Lucy/Index/Indexer.html#func_Delete_By_Query">Delete_By_Query()</a> only affect +documents which had been previously committed to the index â and not any +documents added this indexing session but not yet committed. This may +change in a future update.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Indexer* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Indexer_new</strong>( + <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</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/IndexManager.html">IndexManager</a> *<strong>manager</strong>, + int32_t <strong>flags</strong> +); +</code></pre> +<p>Open a new Indexer. If the index already exists, update it.</p> +<dl> +<dt>schema</dt> +<dd><p>A Schema.</p> +</dd> +<dt>index</dt> +<dd><p>Either a string filepath or a Folder.</p> +</dd> +<dt>manager</dt> +<dd><p>An IndexManager.</p> +</dd> +<dt>flags</dt> +<dd><p>Flags governing behavior.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Indexer* +<span class="prefix">lucy_</span><strong>Indexer_init</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Plan/Schema.html">Schema</a> *<strong>schema</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/IndexManager.html">IndexManager</a> *<strong>manager</strong>, + int32_t <strong>flags</strong> +); +</code></pre> +<p>Initialize an Indexer.</p> +<dl> +<dt>schema</dt> +<dd><p>A Schema.</p> +</dd> +<dt>index</dt> +<dd><p>Either a string filepath or a Folder.</p> +</dd> +<dt>manager</dt> +<dd><p>An IndexManager.</p> +</dd> +<dt>flags</dt> +<dd><p>Flags governing behavior.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Add_Doc">Add_Doc</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Add_Doc</strong>( + <span class="prefix">lucy_</span>Indexer *<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 index.</p> +<dl> +<dt>doc</dt> +<dd><p>A Lucy::Document::Doc object.</p> +</dd> +<dt>boost</dt> +<dd><p>A floating point weight which affects how this document +scores.</p> +</dd> +</dl> +</dd> +<dt id="func_Add_Index">Add_Index</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Add_Index</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>index</strong> +); +</code></pre> +<p>Absorb an existing index into this one. The two indexes must +have matching Schemas.</p> +<dl> +<dt>index</dt> +<dd><p>Either an index path name or a Folder.</p> +</dd> +</dl> +</dd> +<dt id="func_Delete_By_Term">Delete_By_Term</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Delete_By_Term</strong>( + <span class="prefix">lucy_</span>Indexer *<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>Mark documents which contain the supplied term as deleted, so that +they will be excluded from search results and eventually removed +altogether. The change is not apparent to search apps until after +<a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> succeeds.</p> +<dl> +<dt>field</dt> +<dd><p>The name of an indexed field. (If it is not specâd as +<code>indexed</code>, an error will occur.)</p> +</dd> +<dt>term</dt> +<dd><p>The term which identifies docs to be marked as deleted. If +<code>field</code> is associated with an Analyzer, <code>term</code> +will be processed automatically (so donât pre-process it yourself).</p> +</dd> +</dl> +</dd> +<dt id="func_Delete_By_Query">Delete_By_Query</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Delete_By_Query</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Search/Query.html">Query</a> *<strong>query</strong> +); +</code></pre> +<p>Mark documents which match the supplied Query as deleted.</p> +<dl> +<dt>query</dt> +<dd><p>A <a href="../../Lucy/Search/Query.html">Query</a>.</p> +</dd> +</dl> +</dd> +<dt id="func_Delete_By_Doc_ID">Delete_By_Doc_ID</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Delete_By_Doc_ID</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong>, + int32_t <strong>doc_id</strong> +); +</code></pre> +<p>Mark the document identified by the supplied document ID as deleted.</p> +<dl> +<dt>doc_id</dt> +<dd><p>A <a href="../../Lucy/Docs/DocIDs.html">document id</a>.</p> +</dd> +</dl> +</dd> +<dt id="func_Optimize">Optimize</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Optimize</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong> +); +</code></pre> +<p>Optimize the index for search-time performance. This may take a +while, as it can involve rewriting large amounts of data.</p> +<p>Every Indexer session which changes index content and ends in a +<a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> creates a new segment. Once written, segments are never +modified. However, they are periodically recycled by feeding their +content into the segment currently being written.</p> +<p>The <a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a> method causes all existing index content to be fed back +into the Indexer. When <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> completes after an <a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a>, the +index will consist of one segment. So <a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a> must be called +before <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a>. Also, optimizing a fresh index created from scratch +has no effect.</p> +<p>Historically, there was a significant search-time performance benefit +to collapsing down to a single segment versus even two segments. Now +the effect of collapsing is much less significant, and calling +<a href="../../Lucy/Index/Indexer.html#func_Optimize">Optimize()</a> is rarely justified.</p> +</dd> +<dt id="func_Commit">Commit</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Commit</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong> +); +</code></pre> +<p>Commit any changes made to the index. Until this is called, none of +the changes made during an indexing session are permanent.</p> +<p>Calling <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> invalidates the Indexer, so if you want to make more +changes youâll need a new one.</p> +</dd> +<dt id="func_Prepare_Commit">Prepare_Commit</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Prepare_Commit</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong> +); +</code></pre> +<p>Perform the expensive setup for <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> in advance, so that <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> +completes quickly. (If <a href="../../Lucy/Index/Indexer.html#func_Prepare_Commit">Prepare_Commit()</a> is not called explicitly by +the user, <a href="../../Lucy/Index/Indexer.html#func_Commit">Commit()</a> will call it internally.)</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>Indexer_Get_Schema</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong> +); +</code></pre> +<p>Accessor for schema.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Indexer_Destroy</strong>( + <span class="prefix">lucy_</span>Indexer *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::Indexer is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Lexicon.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Lexicon.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Lexicon.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,185 @@ +<!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::Lexicon â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/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::Lexicon</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>LEXICON</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Lexicon</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Lex</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/Lexicon.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::Lexicon â Iterator for a fieldâs terms.</p> +<h3>Description</h3> +<p>A Lexicon is an iterator which provides access to all the unique terms for +a given field in sorted order.</p> +<p>If an index consists of two documents with a âcontentâ field holding âthree +blind miceâ and âthree musketeersâ respectively, then iterating through the +âcontentâ fieldâs lexicon would produce this list:</p> +<pre><code>blind +mice +musketeers +three +</code></pre> +<h3>Methods</h3> +<dl> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Lex_Destroy</strong>( + <span class="prefix">lucy_</span>Lexicon *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +<dt id="func_Seek">Seek <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Lex_Seek</strong>( + <span class="prefix">lucy_</span>Lexicon *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>target</strong> +); +</code></pre> +<p>Seek the Lexicon to the first iterator state which is greater than or +equal to <code>target</code>. If <code>target</code> is NULL, +reset the iterator.</p> +</dd> +<dt id="func_Next">Next <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>Lex_Next</strong>( + <span class="prefix">lucy_</span>Lexicon *<strong>self</strong> +); +</code></pre> +<p>Proceed to the next term.</p> +<p><strong>Returns:</strong> true until the iterator is exhausted, then false.</p> +</dd> +<dt id="func_Reset">Reset <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Lex_Reset</strong>( + <span class="prefix">lucy_</span>Lexicon *<strong>self</strong> +); +</code></pre> +<p>Reset the iterator. <a href="../../Lucy/Index/Lexicon.html#func_Next">Next()</a> must be called to proceed to the first +element.</p> +</dd> +<dt id="func_Get_Term">Get_Term <span class="comment">(abstract)</span></dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* +<span class="prefix">lucy_</span><strong>Lex_Get_Term</strong>( + <span class="prefix">lucy_</span>Lexicon *<strong>self</strong> +); +</code></pre> +<p>Return the current term, or NULL if the iterator is not in a +valid state.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::Lexicon is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/LexiconReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/LexiconReader.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/LexiconReader.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,176 @@ +<!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::LexiconReader â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/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::LexiconReader</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>LEXICONREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>LexiconReader</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>LexReader</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/LexiconReader.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::LexiconReader â Read Lexicon data.</p> +<h3>Description</h3> +<p>LexiconReader reads term dictionary information.</p> +<h3>Methods</h3> +<dl> +<dt id="func_Lexicon">Lexicon <span class="comment">(abstract)</span></dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Index/Lexicon.html">Lexicon</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>LexReader_Lexicon</strong>( + <span class="prefix">lucy_</span>LexiconReader *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>term</strong> +); +</code></pre> +<p>Return a new Lexicon for the given <code>field</code>. Will return +NULL if either the field is not indexed, or if no documents +contain a value for the field.</p> +<dl> +<dt>field</dt> +<dd><p>Field name.</p> +</dd> +<dt>term</dt> +<dd><p>Pre-locate the Lexicon to this term.</p> +</dd> +</dl> +</dd> +<dt id="func_Doc_Freq">Doc_Freq <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>LexReader_Doc_Freq</strong>( + <span class="prefix">lucy_</span>LexiconReader *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>term</strong> +); +</code></pre> +<p>Return the number of documents where the specified term is present.</p> +</dd> +<dt id="func_Aggregator">Aggregator</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>LexiconReader* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>LexReader_Aggregator</strong>( + <span class="prefix">lucy_</span>LexiconReader *<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>Return a LexiconReader which merges the output of other +LexiconReaders.</p> +<dl> +<dt>readers</dt> +<dd><p>An array of LexiconReaders.</p> +</dd> +<dt>offsets</dt> +<dd><p>Doc id start offsets for each reader.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Index::LexiconReader 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/c/Lucy/Index/PolyReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/PolyReader.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/PolyReader.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,243 @@ +<!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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>PolyReader_Destroy</strong>( + <span class="prefix">lucy_</span>PolyReader *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::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/c/Lucy/Index/PostingList.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/PostingList.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/PostingList.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,155 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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> +<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/c/Lucy/Index/PostingListReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/PostingListReader.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/PostingListReader.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,158 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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> +<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/c/Lucy/Index/SegReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/SegReader.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/SegReader.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,209 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::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/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/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_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>SegReader_Destroy</strong>( + <span class="prefix">lucy_</span>SegReader *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +<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> +<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>
