Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/SegWriter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/SegWriter.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/SegWriter.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,279 @@ +<!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/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::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> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>SegWriter_Destroy</strong>( + <span class="prefix">lucy_</span>SegWriter *<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::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/c/Lucy/Index/Segment.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Segment.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Segment.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,265 @@ +<!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/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::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> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Seg_Destroy</strong>( + <span class="prefix">lucy_</span>Segment *<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::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/c/Lucy/Index/Similarity.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Similarity.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Similarity.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,200 @@ +<!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/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::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_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Sim_Destroy</strong>( + <span class="prefix">lucy_</span>Similarity *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</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> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Snapshot.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Snapshot.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Index/Snapshot.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,263 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Index::Snapshot â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/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::Snapshot</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>SNAPSHOT</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Snapshot</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Snapshot</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Index/Snapshot.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Index::Snapshot â Point-in-time index file list.</p> +<h3>Description</h3> +<p>A Snapshot is list of index files and folders. Because index files, once +written, are never modified, a Snapshot defines a point-in-time view of the +data in an index.</p> +<p><a href="../../Lucy/Index/IndexReader.html">IndexReader</a> objects interpret the data +associated with a single Snapshot.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Snapshot* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Snapshot_new</strong>(void); +</code></pre> +<p>Constructor. Takes no arguments.</p> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Snapshot* +<span class="prefix">lucy_</span><strong>Snapshot_init</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong> +); +</code></pre> +<p>Initialize a Snapshot.</p> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_List">List</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Snapshot_List</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong> +); +</code></pre> +<p>Return an array of all entries.</p> +</dd> +<dt id="func_Num_Entries">Num_Entries</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>Snapshot_Num_Entries</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong> +); +</code></pre> +<p>Return the number of entries (including directories).</p> +</dd> +<dt id="func_Add_Entry">Add_Entry</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Snapshot_Add_Entry</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>entry</strong> +); +</code></pre> +<p>Add a filepath to the snapshot.</p> +</dd> +<dt id="func_Delete_Entry">Delete_Entry</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>Snapshot_Delete_Entry</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>entry</strong> +); +</code></pre> +<p>Delete a filepath from the snapshot.</p> +<p><strong>Returns:</strong> true if the entry existed and was successfully deleted, false +otherwise.</p> +</dd> +<dt id="func_Read_File">Read_File</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Snapshot* +<span class="prefix">lucy_</span><strong>Snapshot_Read_File</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong> +); +</code></pre> +<p>Decode a snapshot file and initialize the object to reflect its +contents.</p> +<dl> +<dt>folder</dt> +<dd><p>A Folder.</p> +</dd> +<dt>path</dt> +<dd><p>The location of the snapshot file. If not supplied, the +most recent snapshot file in the base directory will be chosen.</p> +</dd> +</dl> +<p><strong>Returns:</strong> the Snapshot object itself</p> +</dd> +<dt id="func_Write_File">Write_File</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Snapshot_Write_File</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong> +); +</code></pre> +<p>Write a snapshot file. The caller must lock the index while this +operation takes place, and the operation will fail if the snapshot file +already exists.</p> +<dl> +<dt>folder</dt> +<dd><p>A Folder.</p> +</dd> +<dt>path</dt> +<dd><p>The path of the file to write. If NULL, a file +name will be chosen which supersedes the latest snapshot file in the +index folder.</p> +</dd> +</dl> +</dd> +<dt id="func_Set_Path">Set_Path</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Snapshot_Set_Path</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong> +); +</code></pre> +<p>Set the path to the file that the Snapshot object serves as a proxy +for.</p> +</dd> +<dt id="func_Get_Path">Get_Path</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* +<span class="prefix">lucy_</span><strong>Snapshot_Get_Path</strong>( + <span class="prefix">lucy_</span>Snapshot *<strong>self</strong> +); +</code></pre> +<p>Get the path to the snapshot file. Initially NULL; updated +by <a href="../../Lucy/Index/Snapshot.html#func_Read_File">Read_File()</a>, <a href="../../Lucy/Index/Snapshot.html#func_Write_File">Write_File()</a>, and <a href="../../Lucy/Index/Snapshot.html#func_Set_Path">Set_Path()</a>.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Snapshot_Destroy</strong>( + <span class="prefix">lucy_</span>Snapshot *<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::Snapshot is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Object/BitVector.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Object/BitVector.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Object/BitVector.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,375 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Object::BitVector â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Object/">Object</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Object::BitVector</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>BITVECTOR</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>BitVector</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>BitVec</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Object/BitVector.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Object::BitVector â An array of bits.</p> +<h3>Description</h3> +<p>BitVector is a growable array of bits. All bits are initially zero.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>BitVector* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>BitVec_new</strong>( + uint32_t <strong>capacity</strong> +); +</code></pre> +<p>Create a new BitVector.</p> +<dl> +<dt>capacity</dt> +<dd><p>The number of bits that the initial array should be +able to hold.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>BitVector* +<span class="prefix">lucy_</span><strong>BitVec_init</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>capacity</strong> +); +</code></pre> +<p>Initialize a BitVector.</p> +<dl> +<dt>capacity</dt> +<dd><p>The number of bits that the initial array should be +able to hold.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Get">Get</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>BitVec_Get</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>tick</strong> +); +</code></pre> +<p>Return true if the bit at <code>tick</code> has been set, false if it +hasnât (regardless of whether it lies within the bounds of the +objectâs capacity).</p> +<dl> +<dt>tick</dt> +<dd><p>The requested bit.</p> +</dd> +</dl> +</dd> +<dt id="func_Set">Set</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Set</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>tick</strong> +); +</code></pre> +<p>Set the bit at <code>tick</code> to 1.</p> +<dl> +<dt>tick</dt> +<dd><p>The bit to be set.</p> +</dd> +</dl> +</dd> +<dt id="func_Next_Hit">Next_Hit</dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>BitVec_Next_Hit</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>tick</strong> +); +</code></pre> +<p>Returns the next set bit equal to or greater than <code>tick</code>, +or -1 if no such bit exists.</p> +</dd> +<dt id="func_Clear">Clear</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Clear</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>tick</strong> +); +</code></pre> +<p>Clear the indicated bit. (i.e. set it to 0).</p> +<dl> +<dt>tick</dt> +<dd><p>The bit to be cleared.</p> +</dd> +</dl> +</dd> +<dt id="func_Clear_All">Clear_All</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Clear_All</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong> +); +</code></pre> +<p>Clear all bits.</p> +</dd> +<dt id="func_Grow">Grow</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Grow</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>capacity</strong> +); +</code></pre> +<p>If the BitVector does not already have enough room to hold the +indicated number of bits, allocate more memory so that it can.</p> +<dl> +<dt>capacity</dt> +<dd><p>Least number of bits the BitVector should accomodate.</p> +</dd> +</dl> +</dd> +<dt id="func_And">And</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_And</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + const <span class="prefix">lucy_</span>BitVector *<strong>other</strong> +); +</code></pre> +<p>Modify the BitVector so that only bits which remain set are those +which 1) were already set in this BitVector, and 2) were also set in +the other BitVector.</p> +<dl> +<dt>other</dt> +<dd><p>Another BitVector.</p> +</dd> +</dl> +</dd> +<dt id="func_Or">Or</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Or</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + const <span class="prefix">lucy_</span>BitVector *<strong>other</strong> +); +</code></pre> +<p>Modify the BitVector, setting all bits which are set in the other +BitVector if they were not already set.</p> +<dl> +<dt>other</dt> +<dd><p>Another BitVector.</p> +</dd> +</dl> +</dd> +<dt id="func_Xor">Xor</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Xor</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + const <span class="prefix">lucy_</span>BitVector *<strong>other</strong> +); +</code></pre> +<p>Modify the BitVector, performing an XOR operation against the other.</p> +<dl> +<dt>other</dt> +<dd><p>Another BitVector.</p> +</dd> +</dl> +</dd> +<dt id="func_And_Not">And_Not</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_And_Not</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + const <span class="prefix">lucy_</span>BitVector *<strong>other</strong> +); +</code></pre> +<p>Modify the BitVector, clearing all bits which are set in the other.</p> +<dl> +<dt>other</dt> +<dd><p>Another BitVector.</p> +</dd> +</dl> +</dd> +<dt id="func_Flip">Flip</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Flip</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>tick</strong> +); +</code></pre> +<p>Invert the value of a bit.</p> +<dl> +<dt>tick</dt> +<dd><p>The bit to invert.</p> +</dd> +</dl> +</dd> +<dt id="func_Flip_Block">Flip_Block</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Flip_Block</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong>, + uint32_t <strong>offset</strong>, + uint32_t <strong>length</strong> +); +</code></pre> +<p>Invert each bit within a contiguous block.</p> +<dl> +<dt>offset</dt> +<dd><p>Lower bound.</p> +</dd> +<dt>length</dt> +<dd><p>The number of bits to flip.</p> +</dd> +</dl> +</dd> +<dt id="func_Count">Count</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>BitVec_Count</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong> +); +</code></pre> +<p>Return a count of the number of set bits.</p> +</dd> +<dt id="func_To_Array">To_Array</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Object/I32Array.html">I32Array</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>BitVec_To_Array</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong> +); +</code></pre> +<p>Return an array where each element represents a set bit.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BitVec_Destroy</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +<dt id="func_Clone">Clone</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>BitVector* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>BitVec_Clone</strong>( + <span class="prefix">lucy_</span>BitVector *<strong>self</strong> +); +</code></pre> +<p>Return a clone of the object.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Object::BitVector is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Object/I32Array.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Object/I32Array.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Object/I32Array.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,194 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Object::I32Array â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Object/">Object</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Object::I32Array</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>I32ARRAY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>I32Array</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>I32Arr</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Object/I32Array.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Object::I32Array</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>I32Arr_new</strong>( + int32_t *<strong>ints</strong>, + uint32_t <strong>size</strong> +); +</code></pre> +</dd> +<dt id="func_new_blank">new_blank</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>I32Array* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>I32Arr_new_blank</strong>( + uint32_t <strong>size</strong> +); +</code></pre> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>I32Array* +<span class="prefix">lucy_</span><strong>I32Arr_init</strong>( + <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, + int32_t *<strong>ints</strong>, + uint32_t <strong>size</strong> +); +</code></pre> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Set">Set</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>I32Arr_Set</strong>( + <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, + uint32_t <strong>tick</strong>, + int32_t <strong>value</strong> +); +</code></pre> +<p>Set the value at <code>tick</code>, or throw an error if +<code>tick</code> is out of bounds.</p> +</dd> +<dt id="func_Get">Get</dt> +<dd> +<pre><code>int32_t +<span class="prefix">lucy_</span><strong>I32Arr_Get</strong>( + <span class="prefix">lucy_</span>I32Array *<strong>self</strong>, + uint32_t <strong>tick</strong> +); +</code></pre> +<p>Return the value at <code>tick</code>, or throw an error if +<code>tick</code> is out of bounds.</p> +</dd> +<dt id="func_Get_Size">Get_Size</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>I32Arr_Get_Size</strong>( + <span class="prefix">lucy_</span>I32Array *<strong>self</strong> +); +</code></pre> +<p>Accessor for âsizeâ member.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>I32Arr_Destroy</strong>( + <span class="prefix">lucy_</span>I32Array *<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::Object::I32Array is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/Architecture.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/Architecture.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/Architecture.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,190 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Plan::Architecture â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Plan/">Plan</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Plan::Architecture</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>ARCHITECTURE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Architecture</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Arch</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Plan/Architecture.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Plan::Architecture â Configure major components of an index.</p> +<h3>Description</h3> +<p>By default, a Lucy index consists of several main parts: lexicon, +postings, stored documents, deletions, and highlight data. The readers and +writers for that data are spawned by Architecture. Each component operates +at the segment level; Architectureâs factory methods are used to build up +<a href="../../Lucy/Index/SegWriter.html">SegWriter</a> and +<a href="../../Lucy/Index/SegReader.html">SegReader</a>.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Architecture* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Arch_new</strong>(void); +</code></pre> +<p>Constructor. Takes no arguments.</p> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Architecture* +<span class="prefix">lucy_</span><strong>Arch_init</strong>( + <span class="prefix">lucy_</span>Architecture *<strong>self</strong> +); +</code></pre> +<p>Initialize an Architecture.</p> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Register_Doc_Writer">Register_Doc_Writer</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Arch_Register_Doc_Writer</strong>( + <span class="prefix">lucy_</span>Architecture *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegWriter.html">SegWriter</a> *<strong>writer</strong> +); +</code></pre> +<p>Spawn a DataWriter and <a href="../../Lucy/Index/SegWriter.html#func_Register">Register()</a> it with the supplied SegWriter, +adding it to the SegWriterâs writer stack.</p> +<dl> +<dt>writer</dt> +<dd><p>A SegWriter.</p> +</dd> +</dl> +</dd> +<dt id="func_Register_Doc_Reader">Register_Doc_Reader</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Arch_Register_Doc_Reader</strong>( + <span class="prefix">lucy_</span>Architecture *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Index/SegReader.html">SegReader</a> *<strong>reader</strong> +); +</code></pre> +<p>Spawn a DocReader and register it with the supplied SegReader.</p> +<dl> +<dt>reader</dt> +<dd><p>A SegReader.</p> +</dd> +</dl> +</dd> +<dt id="func_Equals">Equals</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>Arch_Equals</strong>( + <span class="prefix">lucy_</span>Architecture *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong> +); +</code></pre> +<p>Returns true for any Architecture object. Subclasses should override +this weak check.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Plan::Architecture is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/BlobType.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/BlobType.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/BlobType.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,186 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Plan::BlobType â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Plan/">Plan</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Plan::BlobType</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>BLOBTYPE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>BlobType</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>BlobType</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Plan/BlobType.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Plan::BlobType â Default behaviors for binary fields.</p> +<h3>Description</h3> +<p>BlobType is an implementation of FieldType tuned for use with fields +containing binary data, which cannot be indexed or searched â only stored.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>BlobType* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>BlobType_new</strong>( + bool <strong>stored</strong> +); +</code></pre> +<p>Create a new BlobType.</p> +<dl> +<dt>stored</dt> +<dd><p>boolean indicating whether the field should be stored.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>BlobType* +<span class="prefix">lucy_</span><strong>BlobType_init</strong>( + <span class="prefix">lucy_</span>BlobType *<strong>self</strong>, + bool <strong>stored</strong> +); +</code></pre> +<p>Initialize a BlobType.</p> +<dl> +<dt>stored</dt> +<dd><p>boolean indicating whether the field should be stored.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Binary">Binary</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>BlobType_Binary</strong>( + <span class="prefix">lucy_</span>BlobType *<strong>self</strong> +); +</code></pre> +<p>Returns true.</p> +</dd> +<dt id="func_Set_Sortable">Set_Sortable</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>BlobType_Set_Sortable</strong>( + <span class="prefix">lucy_</span>BlobType *<strong>self</strong>, + bool <strong>sortable</strong> +); +</code></pre> +<p>Throws an error unless <code>sortable</code> is false.</p> +</dd> +<dt id="func_Equals">Equals</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>BlobType_Equals</strong>( + <span class="prefix">lucy_</span>BlobType *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong> +); +</code></pre> +<p>Compares all common properties.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Plan::BlobType is a <a href="../../Lucy/Plan/FieldType.html">Lucy::Plan::FieldType</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html> Added: websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/FieldType.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/FieldType.html (added) +++ websites/staging/lucy/trunk/content/docs/c/Lucy/Plan/FieldType.html Mon Apr 4 12:55:27 2016 @@ -0,0 +1,239 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html lang="en"> + <head> + <meta http-equiv="Content-Type" content="text/html;charset=UTF-8"> + <title>Lucy::Plan::FieldType â C API Documentation</title> + <link rel="stylesheet" type="text/css" media="screen" href="/css/lucy.css"> + </head> + + <body> + + <div id="lucy-rigid_wrapper"> + + <div id="lucy-top" class="container_16 lucy-white_box_3d"> + + <div id="lucy-logo_box" class="grid_8"> + <a href="/"><img src="/images/lucy_logo_150x100.png" alt="Apache Lucyâ¢"></a> + </div> <!-- lucy-logo_box --> + + <div #id="lucy-top_nav_box" class="grid_8"> + <div id="lucy-top_nav_bar" class="container_8"> + <ul> + <li><a href="http://www.apache.org/"; title="Apache Software Foundation">Apache Software Foundation</a></li> + <li><a href="http://www.apache.org/licenses/"; title="License">License</a></li> + <li><a href="http://www.apache.org/foundation/sponsorship.html"; title="Sponsorship">Sponsorship</a></li> + <li><a href="http://www.apache.org/foundation/thanks.html"; title="Thanks">Thanks</a></li> + <li><a href="http://www.apache.org/security/ " title="Security">Security</a></li> + </ul> + </div> <!-- lucy-top_nav_bar --> + <p><a href="http://www.apache.org/";>Apache</a> » <a href="/">Lucy</a> » <a href="/docs/">Docs</a> » <a href="/docs/c/">C</a> » <a href="/docs/c/Lucy/">Lucy</a> » <a href="/docs/c/Lucy/Plan/">Plan</a></p> + <form name="lucy-top_search_box" id="lucy-top_search_box" action="http://www.google.com/search"; method="get"> + <input value="*.apache.org" name="sitesearch" type="hidden"/> + <input type="text" name="q" id="query" style="width:85%"> + <input type="submit" id="submit" value="Search"> + </form> + </div> <!-- lucy-top_nav_box --> + + <div class="clear"></div> + + </div> <!-- lucy-top --> + + <div id="lucy-main_content" class="container_16 lucy-white_box_3d"> + + <div class="grid_4" id="lucy-left_nav_box"> + <h6>About</h6> + <ul> + <li><a href="/">Welcome</a></li> + <li><a href="/clownfish.html">Clownfish</a></li> + <li><a href="/faq.html">FAQ</a></li> + <li><a href="/people.html">People</a></li> + </ul> + <h6>Resources</h6> + <ul> + <li><a href="/download.html">Download</a></li> + <li><a href="/mailing_lists.html">Mailing Lists</a></li> + <li><a href="/docs/">Documentation</a></li> + <li><a href="http://wiki.apache.org/lucy/";>Wiki</a></li> + <li><a href="https://issues.apache.org/jira/browse/LUCY";>Issue Tracker</a></li> + <li><a href="/version_control.html">Version Control</a></li> + </ul> + <h6>Related Projects</h6> + <ul> + <li><a href="http://lucene.apache.org/core/";>Lucene</a></li> + <li><a href="http://dezi.org/";>Dezi</a></li> + <li><a href="http://lucene.apache.org/solr/";>Solr</a></li> + <li><a href="http://lucenenet.apache.org/";>Lucene.NET</a></li> + <li><a href="http://lucene.apache.org/pylucene/";>PyLucene</a></li> + </ul> + </div> <!-- lucy-left_nav_box --> + + <div id="lucy-main_content_box" class="grid_9"> + <div class="c-api"> +<h2>Lucy::Plan::FieldType</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>FIELDTYPE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>FieldType</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>FType</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Plan/FieldType.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Plan::FieldType â Define a fieldâs behavior.</p> +<h3>Description</h3> +<p>FieldType is an abstract class defining a set of traits and behaviors which +may be associated with one or more field names.</p> +<p>Properties which are common to all field types include <code>boost</code>, +<code>indexed</code>, <code>stored</code>, <code>sortable</code>, +<code>binary</code>, and <code>similarity</code>.</p> +<p>The <code>boost</code> property is a floating point scoring multiplier +which defaults to 1.0. Values greater than 1.0 cause the field to +contribute more to a documentâs score, lower values, less.</p> +<p>The <code>indexed</code> property indicates whether the field should be +indexed (so that it can be searched).</p> +<p>The <code>stored</code> property indicates whether to store the raw field +value, so that it can be retrieved when a document turns up in a search.</p> +<p>The <code>sortable</code> property indicates whether search results should +be sortable based on the contents of the field.</p> +<p>The <code>binary</code> property indicates whether the field contains +binary or text data. Unlike most other properties, <code>binary</code> is +not settable.</p> +<p>The <code>similarity</code> property is a +<a href="../../Lucy/Index/Similarity.html">Similarity</a> object which defines matching +and scoring behavior for the field. It is required if the field is +<code>indexed</code>.</p> +<h3>Methods</h3> +<dl> +<dt id="func_Set_Boost">Set_Boost</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>FType_Set_Boost</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong>, + float <strong>boost</strong> +); +</code></pre> +<p>Setter for <code>boost</code>.</p> +</dd> +<dt id="func_Get_Boost">Get_Boost</dt> +<dd> +<pre><code>float +<span class="prefix">lucy_</span><strong>FType_Get_Boost</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong> +); +</code></pre> +<p>Accessor for <code>boost</code>.</p> +</dd> +<dt id="func_Set_Indexed">Set_Indexed</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>FType_Set_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong>, + bool <strong>indexed</strong> +); +</code></pre> +<p>Setter for <code>indexed</code>.</p> +</dd> +<dt id="func_Indexed">Indexed</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>FType_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong> +); +</code></pre> +<p>Accessor for <code>indexed</code>.</p> +</dd> +<dt id="func_Set_Stored">Set_Stored</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>FType_Set_Stored</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong>, + bool <strong>stored</strong> +); +</code></pre> +<p>Setter for <code>stored</code>.</p> +</dd> +<dt id="func_Stored">Stored</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>FType_Stored</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong> +); +</code></pre> +<p>Accessor for <code>stored</code>.</p> +</dd> +<dt id="func_Set_Sortable">Set_Sortable</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>FType_Set_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong>, + bool <strong>sortable</strong> +); +</code></pre> +<p>Setter for <code>sortable</code>.</p> +</dd> +<dt id="func_Sortable">Sortable</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>FType_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong> +); +</code></pre> +<p>Accessor for <code>sortable</code>.</p> +</dd> +<dt id="func_Binary">Binary</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>FType_Binary</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong> +); +</code></pre> +<p>Indicate whether the field contains binary data.</p> +</dd> +<dt id="func_Equals">Equals</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>FType_Equals</strong>( + <span class="prefix">lucy_</span>FieldType *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong> +); +</code></pre> +<p>Compares all common properties.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Plan::FieldType is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> + + </div> <!-- lucy-main_content_box --> + <div class="clear"></div> + + </div> <!-- lucy-main_content --> + + <div id="lucy-copyright" class="container_16"> + <p>Copyright © 2010-2015 The Apache Software Foundation, Licensed under the + <a href="http://www.apache.org/licenses/LICENSE-2.0";>Apache License, Version 2.0</a>. + <br/> + Apache Lucy, Lucy, Apache, the Apache feather logo, and the Apache Lucy project logo are trademarks of The + Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their + respective owners. + </p> + </div> <!-- lucy-copyright --> + + </div> <!-- lucy-rigid_wrapper --> + + </body> +</html>
