Modified: websites/staging/lucy/trunk/content/docs/c/lucy_RequiredOptionalQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_RequiredOptionalQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_RequiredOptionalQuery.html Tue Dec 2 17:54:11 2014 @@ -1,188 +1,256 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Search::RequiredOptionalQuery â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; } -code { +pre a { + text-decoration: none; +} +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Search::RequiredOptionalQuery</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Search::RequiredOptionalQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>ReqOptQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_REQUIREDOPTIONALQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_RequiredOptionalQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::RequiredOptionalQuery - Join results for two Queries, one required, one optional.</p> +<p>Lucy::Search::RequiredOptionalQuery â Join results for two Queries, one required, one optional.</p> <h2>Description</h2> <p>RequiredOptionalQuery joins the result sets of one Query which MUST match, and one Query which SHOULD match. When only the required Query matches, its score is passed along; when both match, the scores are summed.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_RequiredOptionalQuery* -<strong>lucy_ReqOptQuery_init</strong>( - lucy_RequiredOptionalQuery* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>required_query</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>optional_query</strong> +<pre><code><span class="prefix">lucy_</span>RequiredOptionalQuery* +<span class="prefix">lucy_</span><strong>ReqOptQuery_init</strong>( + <span class="prefix">lucy_</span>RequiredOptionalQuery* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>required_query</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>optional_query</strong> ); </code></pre> <dl> -<dt><emph>required_query</emph></dt> +<dt>required_query</dt> <dd><p>Query must must match.</p> </dd> -<dt><emph>optional_query</emph></dt> +<dt>optional_query</dt> <dd><p>Query which should match.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Required_Query</dt> +<dt id="func_Get_Required_Query">Get_Required_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> -<strong>LUCY_ReqOptQuery_Get_Required_Query</strong>( - lucy_RequiredOptionalQuery* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> +<span class="prefix">LUCY_</span><strong>ReqOptQuery_Get_Required_Query</strong>( + <span class="prefix">lucy_</span>RequiredOptionalQuery* <strong>self</strong> ); </code></pre> <p>Getter for the required Query.</p> </dd> -<dt>Set_Required_Query</dt> +<dt id="func_Set_Required_Query">Set_Required_Query</dt> <dd> <pre><code>void -<strong>LUCY_ReqOptQuery_Set_Required_Query</strong>( - lucy_RequiredOptionalQuery* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>required_query</strong> +<span class="prefix">LUCY_</span><strong>ReqOptQuery_Set_Required_Query</strong>( + <span class="prefix">lucy_</span>RequiredOptionalQuery* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>required_query</strong> ); </code></pre> <p>Setter for the required Query.</p> </dd> -<dt>Get_Optional_Query</dt> +<dt id="func_Get_Optional_Query">Get_Optional_Query</dt> <dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> -<strong>LUCY_ReqOptQuery_Get_Optional_Query</strong>( - lucy_RequiredOptionalQuery* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> +<span class="prefix">LUCY_</span><strong>ReqOptQuery_Get_Optional_Query</strong>( + <span class="prefix">lucy_</span>RequiredOptionalQuery* <strong>self</strong> ); </code></pre> <p>Getter for the optional Query.</p> </dd> -<dt>Set_Optional_Query</dt> +<dt id="func_Set_Optional_Query">Set_Optional_Query</dt> <dd> <pre><code>void -<strong>LUCY_ReqOptQuery_Set_Optional_Query</strong>( - lucy_RequiredOptionalQuery* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>optional_query</strong> +<span class="prefix">LUCY_</span><strong>ReqOptQuery_Set_Optional_Query</strong>( + <span class="prefix">lucy_</span>RequiredOptionalQuery* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>optional_query</strong> ); </code></pre> <p>Setter for the optional Query.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Search::PolyQuery</h3><dl> -<dt>Add_Child</dt> +<h3>Methods inherited from Lucy::Search::PolyQuery</h3> +<dl> +<dt id="func_Add_Child">Add_Child</dt> <dd> <pre><code>void -<strong>LUCY_PolyQuery_Add_Child</strong>( - lucy_PolyQuery* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>query</strong> +<span class="prefix">LUCY_</span><strong>PolyQuery_Add_Child</strong>( + <span class="prefix">lucy_</span>PolyQuery* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>query</strong> ); </code></pre> <p>Add a child Query node.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Search::Query</h3><dl> -<dt>Make_Compiler</dt> +<h3>Methods inherited from Lucy::Search::Query</h3> +<dl> +<dt id="func_Make_Compiler">Make_Compiler <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Compiler.html">lucy_Compiler*</a> // incremented -<strong>LUCY_Query_Make_Compiler</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_Searcher.html">lucy_Searcher*</a> <strong>searcher</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_Compiler.html">Compiler*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Make_Compiler</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Searcher.html">Searcher*</a> <strong>searcher</strong>, float <strong>boost</strong>, bool <strong>subordinate</strong> ); </code></pre> <p>Abstract factory method returning a Compiler derived from this Query.</p> <dl> -<dt><emph>searcher</emph></dt> +<dt>searcher</dt> <dd><p>A Searcher.</p> </dd> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>A scoring multiplier.</p> </dd> -<dt><emph>subordinate</emph></dt> +<dt>subordinate</dt> <dd><p>Indicates whether the Query is a subquery (as opposed to a top-level query). If false, the implementation must -invoke Normalize() on the newly minted Compiler object before returning +invoke <a href="lucy_Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning it.</p> </dd> </dl> </dd> -<dt>Set_Boost</dt> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_Query_Set_Boost</strong>( - lucy_Query* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Query_Set_Boost</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, float <strong>boost</strong> ); </code></pre> <p>Set the Query's boost.</p> </dd> -<dt>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_Query_Get_Boost</strong>( - lucy_Query* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Query_Get_Boost</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong> ); </code></pre> <p>Get the Query's boost.</p> </dd> -<dt>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Query_Serialize</strong>( - lucy_Query* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Query_Serialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_Query* // incremented -<strong>LUCY_Query_Deserialize</strong>( - lucy_Query* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Query* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Deserialize</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, <span class="comment">// decremented</span> + <span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <strong>instream</strong> ); </code></pre> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Dump</strong>( - lucy_Query* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Dump</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Query_Load</strong>( - lucy_Query* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Query_Load</strong>( + <span class="prefix">lucy_</span>Query* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Schema.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Schema.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Schema.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Plan::Schema â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Plan::Schema</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Plan::Schema</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Schema</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SCHEMA</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Schema</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Plan::Schema - User-created specification for an inverted index.</p> +<p>Lucy::Plan::Schema â User-created specification for an inverted index.</p> <h2>Description</h2> <p>A Schema is a specification which indicates how other entities should interpret the raw data in an inverted index and interact with it.</p> @@ -34,128 +100,128 @@ field definitions may not be changed. H fields during subsequent indexing sessions.</p> <h2>Functions</h2> <dl> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_Schema* // incremented -<strong>lucy_Schema_new</strong>(void); +<pre><code><span class="prefix">lucy_</span>Schema* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Schema_new</strong>(void); </code></pre> </dd> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Schema* -<strong>lucy_Schema_init</strong>( - lucy_Schema* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>Schema* +<span class="prefix">lucy_</span><strong>Schema_init</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong> ); </code></pre> <p>Constructor. Takes no arguments.</p> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Architecture</dt> +<dt id="func_Architecture">Architecture</dt> <dd> -<pre><code><a href="lucy_Architecture.html">lucy_Architecture*</a> // incremented -<strong>LUCY_Schema_Architecture</strong>( - lucy_Schema* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Architecture.html">Architecture*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Schema_Architecture</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong> ); </code></pre> <p>Factory method which creates an Architecture object for this index.</p> </dd> -<dt>Spec_Field</dt> +<dt id="func_Spec_Field">Spec_Field</dt> <dd> <pre><code>void -<strong>LUCY_Schema_Spec_Field</strong>( - lucy_Schema* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>name</strong>, - <a href="lucy_FieldType.html">lucy_FieldType*</a> <strong>type</strong> +<span class="prefix">LUCY_</span><strong>Schema_Spec_Field</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>name</strong>, + <span class="prefix">lucy_</span><a href="lucy_FieldType.html">FieldType*</a> <strong>type</strong> ); </code></pre> <p>Define the behavior of a field by associating it with a FieldType.</p> <p>If this method has already been called for the supplied <code>field</code>, it will merely test to verify that the supplied -FieldType Equals() the existing one.</p> +FieldType <a href="lucy_Schema.html#func_Equals">Equals()</a> the existing one.</p> <dl> -<dt><emph>name</emph></dt> +<dt>name</dt> <dd><p>The name of the field.</p> </dd> -<dt><emph>type</emph></dt> +<dt>type</dt> <dd><p>A FieldType.</p> </dd> </dl> </dd> -<dt>Fetch_Type</dt> +<dt id="func_Fetch_Type">Fetch_Type</dt> <dd> -<pre><code><a href="lucy_FieldType.html">lucy_FieldType*</a> -<strong>LUCY_Schema_Fetch_Type</strong>( - lucy_Schema* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_FieldType.html">FieldType*</a> +<span class="prefix">LUCY_</span><strong>Schema_Fetch_Type</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong> ); </code></pre> <p>Return the FieldType for the specified field. If the field can't be found, return NULL.</p> </dd> -<dt>Fetch_Sim</dt> +<dt id="func_Fetch_Sim">Fetch_Sim</dt> <dd> -<pre><code><a href="lucy_Similarity.html">lucy_Similarity*</a> -<strong>LUCY_Schema_Fetch_Sim</strong>( - lucy_Schema* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Similarity.html">Similarity*</a> +<span class="prefix">LUCY_</span><strong>Schema_Fetch_Sim</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong> ); </code></pre> <p>Return the Similarity for the specified field, or NULL if either the field can't be found or it isn't associated with a Similarity.</p> </dd> -<dt>Num_Fields</dt> +<dt id="func_Num_Fields">Num_Fields</dt> <dd> <pre><code>uint32_t -<strong>LUCY_Schema_Num_Fields</strong>( - lucy_Schema* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Schema_Num_Fields</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong> ); </code></pre> <p>Return the number of fields currently defined.</p> </dd> -<dt>All_Fields</dt> +<dt id="func_All_Fields">All_Fields</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_Schema_All_Fields</strong>( - lucy_Schema* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Schema_All_Fields</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong> ); </code></pre> <p>Return all the Schema's field names as an array.</p> </dd> -<dt>Get_Architecture</dt> +<dt id="func_Get_Architecture">Get_Architecture</dt> <dd> -<pre><code><a href="lucy_Architecture.html">lucy_Architecture*</a> -<strong>LUCY_Schema_Get_Architecture</strong>( - lucy_Schema* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Architecture.html">Architecture*</a> +<span class="prefix">LUCY_</span><strong>Schema_Get_Architecture</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong> ); </code></pre> <p>Return the Schema instance's internal Architecture object.</p> </dd> -<dt>Get_Similarity</dt> +<dt id="func_Get_Similarity">Get_Similarity</dt> <dd> -<pre><code><a href="lucy_Similarity.html">lucy_Similarity*</a> -<strong>LUCY_Schema_Get_Similarity</strong>( - lucy_Schema* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Similarity.html">Similarity*</a> +<span class="prefix">LUCY_</span><strong>Schema_Get_Similarity</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong> ); </code></pre> <p>Return the Schema instance's internal Similarity object.</p> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Hash.html">cfish_Hash*</a> // incremented -<strong>LUCY_Schema_Dump</strong>( - lucy_Schema* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Hash.html">Hash*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Schema_Dump</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code>lucy_Schema* // incremented -<strong>LUCY_Schema_Load</strong>( - lucy_Schema* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">lucy_</span>Schema* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Schema_Load</strong>( + <span class="prefix">lucy_</span>Schema* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Searcher.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Searcher.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Searcher.html Tue Dec 2 17:54:11 2014 @@ -1,61 +1,127 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Search::Searcher â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Search::Searcher</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Search::Searcher</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Searcher</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SEARCHER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Searcher</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::Searcher - Base class for searching collections of documents.</p> +<p>Lucy::Search::Searcher â Base class for searching collections of documents.</p> <h2>Description</h2> <p>Abstract base class for objects which search. Core subclasses include <a href="lucy_IndexSearcher.html">IndexSearcher</a> and <a href="lucy_PolySearcher.html">PolySearcher</a>.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Searcher* -<strong>lucy_Searcher_init</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong> +<pre><code><span class="prefix">lucy_</span>Searcher* +<span class="prefix">lucy_</span><strong>Searcher_init</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong> ); </code></pre> <p>Abstract constructor.</p> <dl> -<dt><emph>schema</emph></dt> +<dt>schema</dt> <dd><p>A Schema.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Doc_Max</dt> +<dt id="func_Doc_Max">Doc_Max <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_Searcher_Doc_Max</strong>( - lucy_Searcher* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Searcher_Doc_Max</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong> ); </code></pre> <p>Return the maximum number of docs in the collection represented by the @@ -63,113 +129,110 @@ Searcher, which is also the highest poss Documents which have been marked as deleted but not yet purged are included in this count.</p> </dd> -<dt>Doc_Freq</dt> +<dt id="func_Doc_Freq">Doc_Freq <span class="comment">(abstract)</span></dt> <dd> <pre><code>uint32_t -<strong>LUCY_Searcher_Doc_Freq</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>term</strong> +<span class="prefix">LUCY_</span><strong>Searcher_Doc_Freq</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>term</strong> ); </code></pre> <p>Return the number of documents which contain the term in the given field.</p> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>Field name.</p> </dd> -<dt><emph>term</emph></dt> +<dt>term</dt> <dd><p>The term to look up.</p> </dd> </dl> </dd> -<dt>Collect</dt> -<dd> -<pre><code>void -<strong>LUCY_Searcher_Collect</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="lucy_Query.html">lucy_Query*</a> <strong>query</strong>, - <a href="lucy_Collector.html">lucy_Collector*</a> <strong>collector</strong> -); -</code></pre> -<p>Iterate over hits, feeding them into a -<a href="lucy_Collector.html">Collector</a>.</p> -<dl> -<dt><emph>query</emph></dt> -<dd><p>A Query.</p> -</dd> -<dt><emph>collector</emph></dt> -<dd><p>A Collector.</p> -</dd> -</dl> -</dd> -<dt>Fetch_Doc</dt> +<dt id="func_Glean_Query">Glean_Query</dt> <dd> -<pre><code><a href="lucy_HitDoc.html">lucy_HitDoc*</a> // incremented -<strong>LUCY_Searcher_Fetch_Doc</strong>( - lucy_Searcher* <strong>self</strong>, - int32_t <strong>doc_id</strong> -); -</code></pre> -<p>Retrieve a document. Throws an error if the doc id is out of range.</p> -<dl> -<dt><emph>doc_id</emph></dt> -<dd><p>A document id.</p> -</dd> -</dl> -</dd> -</dl> -<h3>Novel methods</h3> -<dl> -<dt>Glean_Query</dt> -<dd> -<pre><code><a href="lucy_Query.html">lucy_Query*</a> // incremented -<strong>LUCY_Searcher_Glean_Query</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>query</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Searcher_Glean_Query</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>query</strong> ); </code></pre> <p>If the supplied object is a Query, return it; if it's a query string, create a QueryParser and parse it to produce a query against all indexed fields.</p> </dd> -<dt>Hits</dt> +<dt id="func_Hits">Hits</dt> <dd> -<pre><code><a href="lucy_Hits.html">lucy_Hits*</a> // incremented -<strong>LUCY_Searcher_Hits</strong>( - lucy_Searcher* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>query</strong>, +<pre><code><span class="prefix">lucy_</span><a href="lucy_Hits.html">Hits*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Searcher_Hits</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>query</strong>, uint32_t <strong>offset</strong>, uint32_t <strong>num_wanted</strong>, - <a href="lucy_SortSpec.html">lucy_SortSpec*</a> <strong>sort_spec</strong> + <span class="prefix">lucy_</span><a href="lucy_SortSpec.html">SortSpec*</a> <strong>sort_spec</strong> ); </code></pre> <p>Return a Hits object containing the top results.</p> <dl> -<dt><emph>query</emph></dt> +<dt>query</dt> <dd><p>Either a Query object or a query string.</p> </dd> -<dt><emph>offset</emph></dt> +<dt>offset</dt> <dd><p>The number of most-relevant hits to discard, typically used when "paging" through hits N at a time. Setting <code>offset</code> to 20 and <code>num_wanted</code> to 10 retrieves hits 21-30, assuming that 30 hits can be found.</p> </dd> -<dt><emph>num_wanted</emph></dt> +<dt>num_wanted</dt> <dd><p>The number of hits you would like to see after <code>offset</code> is taken into account.</p> </dd> -<dt><emph>sort_spec</emph></dt> +<dt>sort_spec</dt> <dd><p>A <a href="lucy_SortSpec.html">SortSpec</a>, which will affect how results are ranked and returned.</p> </dd> </dl> </dd> -<dt>Get_Schema</dt> +<dt id="func_Collect">Collect <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">LUCY_</span><strong>Searcher_Collect</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Query.html">Query*</a> <strong>query</strong>, + <span class="prefix">lucy_</span><a href="lucy_Collector.html">Collector*</a> <strong>collector</strong> +); +</code></pre> +<p>Iterate over hits, feeding them into a +<a href="lucy_Collector.html">Collector</a>.</p> +<dl> +<dt>query</dt> +<dd><p>A Query.</p> +</dd> +<dt>collector</dt> +<dd><p>A Collector.</p> +</dd> +</dl> +</dd> +<dt id="func_Fetch_Doc">Fetch_Doc <span class="comment">(abstract)</span></dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="lucy_HitDoc.html">HitDoc*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Searcher_Fetch_Doc</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong>, + int32_t <strong>doc_id</strong> +); +</code></pre> +<p>Retrieve a document. Throws an error if the doc id is out of range.</p> +<dl> +<dt>doc_id</dt> +<dd><p>A document id.</p> +</dd> +</dl> +</dd> +<dt id="func_Get_Schema">Get_Schema</dt> <dd> -<pre><code><a href="lucy_Schema.html">lucy_Schema*</a> -<strong>LUCY_Searcher_Get_Schema</strong>( - lucy_Searcher* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> +<span class="prefix">LUCY_</span><strong>Searcher_Get_Schema</strong>( + <span class="prefix">lucy_</span>Searcher* <strong>self</strong> ); </code></pre> <p>Accessor for the object's <code>schema</code> member.</p> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_SegReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_SegReader.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_SegReader.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Index::SegReader â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; } -code { +pre a { + text-decoration: none; +} +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Index::SegReader</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Index::SegReader</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>SegReader</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SEGREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_SegReader</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::SegReader - Single-segment IndexReader.</p> +<p>Lucy::Index::SegReader â Single-segment IndexReader.</p> <h2>Description</h2> <p>SegReader interprets the data within a single segment of an index.</p> <p>Generally speaking, only advanced users writing subclasses which manipulate @@ -34,54 +100,55 @@ data at the segment level need to deal w components spawned by <a href="lucy_Architecture.html">Architecture</a>'s factory methods.</p> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Register</dt> +<dt id="func_Register">Register</dt> <dd> <pre><code>void -<strong>LUCY_SegReader_Register</strong>( - lucy_SegReader* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>api</strong>, - <a href="lucy_DataReader.html">lucy_DataReader*</a> <strong>component</strong> // decremented +<span class="prefix">LUCY_</span><strong>SegReader_Register</strong>( + <span class="prefix">lucy_</span>SegReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>api</strong>, + <span class="prefix">lucy_</span><a href="lucy_DataReader.html">DataReader*</a> <strong>component</strong> <span class="comment">// decremented</span> ); </code></pre> <p>Add a component to the SegReader. Using the same <code>api</code> key twice is an error.</p> <dl> -<dt><emph>api</emph></dt> +<dt>api</dt> <dd><p>The name of the DataReader subclass that defines the interface implemented by <code>component</code>.</p> </dd> -<dt><emph>component</emph></dt> +<dt>component</dt> <dd><p>A DataReader.</p> </dd> </dl> </dd> -<dt>Get_Seg_Name</dt> +<dt id="func_Get_Seg_Name">Get_Seg_Name</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_SegReader_Get_Seg_Name</strong>( - lucy_SegReader* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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>Get_Seg_Num</dt> +<dt id="func_Get_Seg_Num">Get_Seg_Num</dt> <dd> <pre><code>int64_t -<strong>LUCY_SegReader_Get_Seg_Num</strong>( - lucy_SegReader* <strong>self</strong> +<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> </dl> -<h3>Methods inherited from Lucy::Index::IndexReader</h3><dl> -<dt>Doc_Max</dt> +<h3>Methods inherited from Lucy::Index::IndexReader</h3> +<dl> +<dt id="func_Doc_Max">Doc_Max <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_IxReader_Doc_Max</strong>( - lucy_IndexReader* <strong>self</strong> +<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 @@ -89,159 +156,160 @@ is also the highest possible internal do have been marked as deleted but not yet purged from the index are included in this count.</p> </dd> -<dt>Doc_Count</dt> +<dt id="func_Doc_Count">Doc_Count <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_IxReader_Doc_Count</strong>( - lucy_IndexReader* <strong>self</strong> +<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>Del_Count</dt> +<dt id="func_Del_Count">Del_Count <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_IxReader_Del_Count</strong>( - lucy_IndexReader* <strong>self</strong> +<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>Offsets</dt> +<dt id="func_Offsets">Offsets <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_I32Array.html">lucy_I32Array*</a> // incremented -<strong>LUCY_IxReader_Offsets</strong>( - lucy_IndexReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_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>Seg_Readers</dt> +<dt id="func_Seg_Readers">Seg_Readers <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_IxReader_Seg_Readers</strong>( - lucy_IndexReader* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</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>Obtain</dt> +<dt id="func_Obtain">Obtain</dt> <dd> -<pre><code><a href="lucy_DataReader.html">lucy_DataReader*</a> -<strong>LUCY_IxReader_Obtain</strong>( - lucy_IndexReader* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>api</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_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="cfish_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><emph>api</emph></dt> +<dt>api</dt> <dd><p>The name of the DataReader subclass that the desired component must implement.</p> </dd> </dl> </dd> -<dt>Fetch</dt> +<dt id="func_Fetch">Fetch</dt> <dd> -<pre><code><a href="lucy_DataReader.html">lucy_DataReader*</a> -<strong>LUCY_IxReader_Fetch</strong>( - lucy_IndexReader* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>api</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_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="cfish_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><emph>api</emph></dt> +<dt>api</dt> <dd><p>The name of the DataReader subclass that the desired component must implement.</p> </dd> </dl> </dd> </dl> -<h3>Methods inherited from Lucy::Index::DataReader</h3><dl> -<dt>Aggregator</dt> +<h3>Methods inherited from Lucy::Index::DataReader</h3> +<dl> +<dt id="func_Aggregator">Aggregator <span class="comment">(abstract)</span></dt> <dd> -<pre><code>lucy_DataReader* // incremented -<strong>LUCY_DataReader_Aggregator</strong>( - lucy_DataReader* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>readers</strong>, - <a href="lucy_I32Array.html">lucy_I32Array*</a> <strong>offsets</strong> +<pre><code><span class="prefix">lucy_</span>DataReader* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>DataReader_Aggregator</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>readers</strong>, + <span class="prefix">lucy_</span><a href="lucy_I32Array.html">I32Array*</a> <strong>offsets</strong> ); </code></pre> <p>Create a reader which aggregates the output of several lower level readers. Return NULL if such a reader is not valid.</p> <dl> -<dt><emph>readers</emph></dt> +<dt>readers</dt> <dd><p>An array of DataReaders.</p> </dd> -<dt><emph>offsets</emph></dt> +<dt>offsets</dt> <dd><p>Doc id start offsets for each reader.</p> </dd> </dl> </dd> -<dt>Get_Schema</dt> +<dt id="func_Get_Schema">Get_Schema</dt> <dd> -<pre><code><a href="lucy_Schema.html">lucy_Schema*</a> -<strong>LUCY_DataReader_Get_Schema</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Schema</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "schema" member var.</p> </dd> -<dt>Get_Folder</dt> +<dt id="func_Get_Folder">Get_Folder</dt> <dd> -<pre><code><a href="lucy_Folder.html">lucy_Folder*</a> -<strong>LUCY_DataReader_Get_Folder</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Folder</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "folder" member var.</p> </dd> -<dt>Get_Snapshot</dt> +<dt id="func_Get_Snapshot">Get_Snapshot</dt> <dd> -<pre><code><a href="lucy_Snapshot.html">lucy_Snapshot*</a> -<strong>LUCY_DataReader_Get_Snapshot</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Snapshot</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "snapshot" member var.</p> </dd> -<dt>Get_Segments</dt> +<dt id="func_Get_Segments">Get_Segments</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> -<strong>LUCY_DataReader_Get_Segments</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Segments</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "segments" member var.</p> </dd> -<dt>Get_Segment</dt> +<dt id="func_Get_Segment">Get_Segment</dt> <dd> -<pre><code><a href="lucy_Segment.html">lucy_Segment*</a> -<strong>LUCY_DataReader_Get_Segment</strong>( - lucy_DataReader* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Segment.html">Segment*</a> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Segment</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "segment" member var.</p> </dd> -<dt>Get_Seg_Tick</dt> +<dt id="func_Get_Seg_Tick">Get_Seg_Tick</dt> <dd> <pre><code>int32_t -<strong>LUCY_DataReader_Get_Seg_Tick</strong>( - lucy_DataReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataReader_Get_Seg_Tick</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Accessor for "seg_tick" member var.</p> </dd> -<dt>Close</dt> +<dt id="func_Close">Close <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_DataReader_Close</strong>( - lucy_DataReader* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataReader_Close</strong>( + <span class="prefix">lucy_</span>DataReader* <strong>self</strong> ); </code></pre> <p>Release external resources, e.g. streams. Implementations must be Modified: websites/staging/lucy/trunk/content/docs/c/lucy_SegWriter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_SegWriter.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_SegWriter.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Index::SegWriter â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Index::SegWriter</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Index::SegWriter</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>SegWriter</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SEGWRITER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_SegWriter</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::SegWriter - Write one segment of an index.</p> +<p>Lucy::Index::SegWriter â Write one segment of an index.</p> <h2>Description</h2> <p>SegWriter is a conduit through which information fed to Indexer passes. It manages <a href="lucy_Segment.html">Segment</a> and Inverter, invokes the @@ -34,123 +100,124 @@ level <a href="lucy_DataWriter.html">Dat PostingListWriter and DocWriter.</p> <p>The sub-components of a SegWriter are determined by <a href="lucy_Architecture.html">Architecture</a>. DataWriter components -which are added to the stack of writers via Add_Writer() have -Add_Inverted_Doc() invoked for each document supplied to SegWriter's -Add_Doc().</p> +which are added to the stack of writers via <a href="lucy_SegWriter.html#func_Add_Writer">Add_Writer()</a> have +<a href="lucy_SegWriter.html#func_Add_Inverted_Doc">Add_Inverted_Doc()</a> invoked for each document supplied to SegWriter's +<a href="lucy_SegWriter.html#func_Add_Doc">Add_Doc()</a>.</p> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Register</dt> +<dt id="func_Register">Register</dt> <dd> <pre><code>void -<strong>LUCY_SegWriter_Register</strong>( - lucy_SegWriter* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>api</strong>, - <a href="lucy_DataWriter.html">lucy_DataWriter*</a> <strong>component</strong> // decremented +<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="cfish_String.html">String*</a> <strong>api</strong>, + <span class="prefix">lucy_</span><a href="lucy_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 Fetch(), so you may -also want to call Add_Writer()).</p> +registration simply makes the writer available via <a href="lucy_SegWriter.html#func_Fetch">Fetch()</a>, so you may +also want to call <a href="lucy_SegWriter.html#func_Add_Writer">Add_Writer()</a>).</p> <dl> -<dt><emph>api</emph></dt> +<dt>api</dt> <dd><p>The name of the DataWriter api which <code>writer</code> implements.</p> </dd> -<dt><emph>component</emph></dt> +<dt>component</dt> <dd><p>A DataWriter.</p> </dd> </dl> </dd> -<dt>Fetch</dt> +<dt id="func_Fetch">Fetch</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> -<strong>LUCY_SegWriter_Fetch</strong>( - lucy_SegWriter* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>api</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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="cfish_String.html">String*</a> <strong>api</strong> ); </code></pre> <p>Retrieve a registered component.</p> <dl> -<dt><emph>api</emph></dt> +<dt>api</dt> <dd><p>The name of the DataWriter api which the component implements.</p> </dd> </dl> </dd> -<dt>Add_Writer</dt> +<dt id="func_Add_Writer">Add_Writer</dt> <dd> <pre><code>void -<strong>LUCY_SegWriter_Add_Writer</strong>( - lucy_SegWriter* <strong>self</strong>, - <a href="lucy_DataWriter.html">lucy_DataWriter*</a> <strong>writer</strong> // decremented +<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_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>Add_Doc</dt> +<dt id="func_Add_Doc">Add_Doc</dt> <dd> <pre><code>void -<strong>LUCY_SegWriter_Add_Doc</strong>( - lucy_SegWriter* <strong>self</strong>, - <a href="lucy_Doc.html">lucy_Doc*</a> <strong>doc</strong>, +<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_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(), +the Segment's internal document id, then calls <a href="lucy_SegWriter.html#func_Add_Inverted_Doc">Add_Inverted_Doc()</a>, feeding all sub-writers.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Index::DataWriter</h3><dl> -<dt>Add_Inverted_Doc</dt> +<h3>Methods inherited from Lucy::Index::DataWriter</h3> +<dl> +<dt id="func_Add_Inverted_Doc">Add_Inverted_Doc <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_DataWriter_Add_Inverted_Doc</strong>( - lucy_DataWriter* <strong>self</strong>, - <a href="lucy_Inverter.html">lucy_Inverter*</a> <strong>inverter</strong>, +<span class="prefix">LUCY_</span><strong>DataWriter_Add_Inverted_Doc</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Inverter.html">Inverter*</a> <strong>inverter</strong>, int32_t <strong>doc_id</strong> ); </code></pre> <p>Process a document, previously inverted by <code>inverter</code>.</p> <dl> -<dt><emph>inverter</emph></dt> +<dt>inverter</dt> <dd><p>An Inverter wrapping an inverted document.</p> </dd> -<dt><emph>doc_id</emph></dt> +<dt>doc_id</dt> <dd><p>Internal number assigned to this document within the segment.</p> </dd> </dl> </dd> -<dt>Add_Segment</dt> +<dt id="func_Add_Segment">Add_Segment <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_DataWriter_Add_Segment</strong>( - lucy_DataWriter* <strong>self</strong>, - <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>, - <a href="lucy_I32Array.html">lucy_I32Array*</a> <strong>doc_map</strong> +<span class="prefix">LUCY_</span><strong>DataWriter_Add_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>, + <span class="prefix">lucy_</span><a href="lucy_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><emph>reader</emph></dt> +<dt>reader</dt> <dd><p>The SegReader containing content to add.</p> </dd> -<dt><emph>doc_map</emph></dt> +<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>Delete_Segment</dt> +<dt id="func_Delete_Segment">Delete_Segment</dt> <dd> <pre><code>void -<strong>LUCY_DataWriter_Delete_Segment</strong>( - lucy_DataWriter* <strong>self</strong>, - <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong> +<span class="prefix">LUCY_</span><strong>DataWriter_Delete_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong> ); </code></pre> <p>Remove a segment's data. The default implementation is a no-op, as @@ -159,108 +226,108 @@ Subclasses which manage their own files should override this method and use it as a trigger for cleaning up obsolete data.</p> <dl> -<dt><emph>reader</emph></dt> +<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>Merge_Segment</dt> +<dt id="func_Merge_Segment">Merge_Segment</dt> <dd> <pre><code>void -<strong>LUCY_DataWriter_Merge_Segment</strong>( - lucy_DataWriter* <strong>self</strong>, - <a href="lucy_SegReader.html">lucy_SegReader*</a> <strong>reader</strong>, - <a href="lucy_I32Array.html">lucy_I32Array*</a> <strong>doc_map</strong> +<span class="prefix">LUCY_</span><strong>DataWriter_Merge_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_SegReader.html">SegReader*</a> <strong>reader</strong>, + <span class="prefix">lucy_</span><a href="lucy_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 Add_Segment() then Delete_Segment().</p> +<p>The default implementation calls <a href="lucy_DataWriter.html#func_Add_Segment">Add_Segment()</a> then <a href="lucy_DataWriter.html#func_Delete_Segment">Delete_Segment()</a>.</p> <dl> -<dt><emph>reader</emph></dt> +<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><emph>doc_map</emph></dt> +<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>Finish</dt> +<dt id="func_Finish">Finish <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_DataWriter_Finish</strong>( - lucy_DataWriter* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataWriter_Finish</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Complete the segment: close all streams, store metadata, etc.</p> </dd> -<dt>Metadata</dt> +<dt id="func_Metadata">Metadata</dt> <dd> -<pre><code><a href="cfish_Hash.html">cfish_Hash*</a> // incremented -<strong>LUCY_DataWriter_Metadata</strong>( - lucy_DataWriter* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Hash.html">Hash*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>DataWriter_Metadata</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Arbitrary metadata to be serialized and stored by the Segment. The default implementation supplies a Hash with a single key-value pair for "format".</p> </dd> -<dt>Format</dt> +<dt id="func_Format">Format <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_DataWriter_Format</strong>( - lucy_DataWriter* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>DataWriter_Format</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Every writer must specify a file format revision number, which should increment each time the format changes. Responsibility for revision checking is left to the companion DataReader.</p> </dd> -<dt>Get_Snapshot</dt> +<dt id="func_Get_Snapshot">Get_Snapshot</dt> <dd> -<pre><code><a href="lucy_Snapshot.html">lucy_Snapshot*</a> -<strong>LUCY_DataWriter_Get_Snapshot</strong>( - lucy_DataWriter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> +<span class="prefix">LUCY_</span><strong>DataWriter_Get_Snapshot</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Accessor for "snapshot" member var.</p> </dd> -<dt>Get_Segment</dt> +<dt id="func_Get_Segment">Get_Segment</dt> <dd> -<pre><code><a href="lucy_Segment.html">lucy_Segment*</a> -<strong>LUCY_DataWriter_Get_Segment</strong>( - lucy_DataWriter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Segment.html">Segment*</a> +<span class="prefix">LUCY_</span><strong>DataWriter_Get_Segment</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Accessor for "segment" member var.</p> </dd> -<dt>Get_PolyReader</dt> +<dt id="func_Get_PolyReader">Get_PolyReader</dt> <dd> -<pre><code><a href="lucy_PolyReader.html">lucy_PolyReader*</a> -<strong>LUCY_DataWriter_Get_PolyReader</strong>( - lucy_DataWriter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_PolyReader.html">PolyReader*</a> +<span class="prefix">LUCY_</span><strong>DataWriter_Get_PolyReader</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Accessor for "polyreader" member var.</p> </dd> -<dt>Get_Schema</dt> +<dt id="func_Get_Schema">Get_Schema</dt> <dd> -<pre><code><a href="lucy_Schema.html">lucy_Schema*</a> -<strong>LUCY_DataWriter_Get_Schema</strong>( - lucy_DataWriter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> +<span class="prefix">LUCY_</span><strong>DataWriter_Get_Schema</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Accessor for "schema" member var.</p> </dd> -<dt>Get_Folder</dt> +<dt id="func_Get_Folder">Get_Folder</dt> <dd> -<pre><code><a href="lucy_Folder.html">lucy_Folder*</a> -<strong>LUCY_DataWriter_Get_Folder</strong>( - lucy_DataWriter* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> +<span class="prefix">LUCY_</span><strong>DataWriter_Get_Folder</strong>( + <span class="prefix">lucy_</span>DataWriter* <strong>self</strong> ); </code></pre> <p>Accessor for "folder" member var.</p> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Segment.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Segment.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Segment.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Index::Segment â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Index::Segment</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Index::Segment</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Seg</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SEGMENT</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Segment</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::Segment - Warehouse for information about one segment of an inverted index.</p> +<p>Lucy::Index::Segment â Warehouse for information about one segment of an inverted index.</p> <h2>Description</h2> <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 @@ -39,147 +105,147 @@ generated by other index components -- r storing metadata themselves.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Segment* -<strong>lucy_Seg_init</strong>( - lucy_Segment* <strong>self</strong>, +<pre><code><span class="prefix">lucy_</span>Segment* +<span class="prefix">lucy_</span><strong>Seg_init</strong>( + <span class="prefix">lucy_</span>Segment* <strong>self</strong>, int64_t <strong>number</strong> ); </code></pre> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Add_Field</dt> +<dt id="func_Add_Field">Add_Field</dt> <dd> <pre><code>int32_t -<strong>LUCY_Seg_Add_Field</strong>( - lucy_Segment* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong> +<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="cfish_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><emph>field</emph></dt> +<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>Store_Metadata</dt> +<dt id="func_Store_Metadata">Store_Metadata</dt> <dd> <pre><code>void -<strong>LUCY_Seg_Store_Metadata</strong>( - lucy_Segment* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>key</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>metadata</strong> // decremented +<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="cfish_String.html">String*</a> <strong>key</strong>, + <span class="prefix">cfish_</span><a href="cfish_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><emph>key</emph></dt> +<dt>key</dt> <dd><p>String identifying an index component.</p> </dd> -<dt><emph>metadata</emph></dt> +<dt>metadata</dt> <dd><p>JSON-izable data structure.</p> </dd> </dl> </dd> -<dt>Fetch_Metadata</dt> +<dt id="func_Fetch_Metadata">Fetch_Metadata</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> -<strong>LUCY_Seg_Fetch_Metadata</strong>( - lucy_Segment* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>key</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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="cfish_String.html">String*</a> <strong>key</strong> ); </code></pre> <p>Fetch a value from the Segment's metadata hash.</p> </dd> -<dt>Field_Num</dt> +<dt id="func_Field_Num">Field_Num</dt> <dd> <pre><code>int32_t -<strong>LUCY_Seg_Field_Num</strong>( - lucy_Segment* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong> +<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="cfish_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><emph>field</emph></dt> +<dt>field</dt> <dd><p>Field name.</p> </dd> </dl> </dd> -<dt>Field_Name</dt> +<dt id="func_Field_Name">Field_Name</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Seg_Field_Name</strong>( - lucy_Segment* <strong>self</strong>, +<pre><code><span class="prefix">cfish_</span><a href="cfish_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>Get_Name</dt> +<dt id="func_Get_Name">Get_Name</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Seg_Get_Name</strong>( - lucy_Segment* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_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>Get_Number</dt> +<dt id="func_Get_Number">Get_Number</dt> <dd> <pre><code>int64_t -<strong>LUCY_Seg_Get_Number</strong>( - lucy_Segment* <strong>self</strong> +<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>Set_Count</dt> +<dt id="func_Set_Count">Set_Count</dt> <dd> <pre><code>void -<strong>LUCY_Seg_Set_Count</strong>( - lucy_Segment* <strong>self</strong>, +<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>Get_Count</dt> +<dt id="func_Get_Count">Get_Count</dt> <dd> <pre><code>int64_t -<strong>LUCY_Seg_Get_Count</strong>( - lucy_Segment* <strong>self</strong> +<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>Write_File</dt> +<dt id="func_Write_File">Write_File</dt> <dd> <pre><code>void -<strong>LUCY_Seg_Write_File</strong>( - lucy_Segment* <strong>self</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong> +<span class="prefix">LUCY_</span><strong>Seg_Write_File</strong>( + <span class="prefix">lucy_</span>Segment* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong> ); </code></pre> <p>Write the segdata file.</p> </dd> -<dt>Read_File</dt> +<dt id="func_Read_File">Read_File</dt> <dd> <pre><code>bool -<strong>LUCY_Seg_Read_File</strong>( - lucy_Segment* <strong>self</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong> +<span class="prefix">LUCY_</span><strong>Seg_Read_File</strong>( + <span class="prefix">lucy_</span>Segment* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong> ); </code></pre> <p>Read the segmeta file for this segment.</p> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Similarity.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Similarity.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Similarity.html Tue Dec 2 17:54:11 2014 @@ -1,31 +1,97 @@ <!DOCTYPE html> <html> <head> +<meta charset="utf-8"> +<!-- +*********************************************** + +!!!! DO NOT EDIT !!!! + +This file was auto-generated by cfc. + +*********************************************** + +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> <meta name="viewport" content="width=device-width" /> +<title>Lucy::Index::Similarity â C API Documentation</title> <style type="text/css"> body { - font-family: sans-serif; - font-size: 0.85em; - max-width: 640px; + max-width: 48em; + font: 0.85em/1.4 sans-serif; +} +a { + color: #23b; +} +table { + border-collapse: collapse; +} +td { + padding: 0; +} +td.label { + padding-right: 2em; + font-weight: bold; } dt { font-weight: bold; } pre { - border: 1px solid #000; + border: 1px solid #ccc; padding: 0.2em 0.4em; background: #f6f6f6; - font-size: 1.2em; + font-size: 0.92em; +} +pre a { + text-decoration: none; } -code { +pre, code { font-family: "Consolas", "Menlo", monospace; } +span.prefix, span.comment { + color: #888; +} </style> </head> <body> <h1>Lucy::Index::Similarity</h1> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class name</td> +<td>Lucy::Index::Similarity</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Sim</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SIMILARITY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Similarity</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::Similarity - Judge how well a document matches a query.</p> +<p>Lucy::Index::Similarity â Judge how well a document matches a query.</p> <h2>Description</h2> <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 @@ -40,33 +106,33 @@ schemes.</p> scores from multiple fields.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Similarity* -<strong>lucy_Sim_init</strong>( - lucy_Similarity* <strong>self</strong> +<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>Constructor. Takes no arguments.</p> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Make_Posting</dt> +<dt id="func_Make_Posting">Make_Posting</dt> <dd> -<pre><code><a href="lucy_Posting.html">lucy_Posting*</a> // incremented -<strong>LUCY_Sim_Make_Posting</strong>( - lucy_Similarity* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Posting.html">Posting*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Sim_Make_Posting</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong> ); </code></pre> <p>Factory method for creating a Posting.</p> </dd> -<dt>TF</dt> +<dt id="func_TF">TF</dt> <dd> <pre><code>float -<strong>LUCY_Sim_TF</strong>( - lucy_Similarity* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Sim_TF</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong>, float <strong>freq</strong> ); </code></pre> @@ -76,11 +142,11 @@ implementations typically produce ascend freqs, since the more times a doc matches, the more relevant it is likely to be.</p> </dd> -<dt>IDF</dt> +<dt id="func_IDF">IDF</dt> <dd> <pre><code>float -<strong>LUCY_Sim_IDF</strong>( - lucy_Similarity* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Sim_IDF</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong>, int64_t <strong>doc_freq</strong>, int64_t <strong>total_docs</strong> ); @@ -88,30 +154,30 @@ likely to be.</p> <p>Calculate the Inverse Document Frequecy for a term in a given collection.</p> <dl> -<dt><emph>doc_freq</emph></dt> +<dt>doc_freq</dt> <dd><p>The number of documents that the term appears in.</p> </dd> -<dt><emph>total_docs</emph></dt> +<dt>total_docs</dt> <dd><p>The number of documents in the collection.</p> </dd> </dl> </dd> -<dt>Coord</dt> +<dt id="func_Coord">Coord</dt> <dd> <pre><code>float -<strong>LUCY_Sim_Coord</strong>( - lucy_Similarity* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Sim_Coord</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong>, uint32_t <strong>overlap</strong>, uint32_t <strong>max_overlap</strong> ); </code></pre> <p>Calculate a score factor based on the number of terms which match.</p> </dd> -<dt>Length_Norm</dt> +<dt id="func_Length_Norm">Length_Norm</dt> <dd> <pre><code>float -<strong>LUCY_Sim_Length_Norm</strong>( - lucy_Similarity* <strong>self</strong>, +<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> @@ -128,48 +194,48 @@ using an inverted square root.</p> fields highly, which isn't always appropriate for fields you expect to have a lot of tokens on average.</p> </dd> -<dt>Query_Norm</dt> +<dt id="func_Query_Norm">Query_Norm</dt> <dd> <pre><code>float -<strong>LUCY_Sim_Query_Norm</strong>( - lucy_Similarity* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Sim_Query_Norm</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong>, float <strong>sum_of_squared_weights</strong> ); </code></pre> <p>Normalize a Query's weight so that it is comparable to other Queries.</p> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_Sim_Dump</strong>( - lucy_Similarity* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Sim_Dump</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load</dt> <dd> -<pre><code>lucy_Similarity* // incremented -<strong>LUCY_Sim_Load</strong>( - lucy_Similarity* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>dump</strong> +<pre><code><span class="prefix">lucy_</span>Similarity* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Sim_Load</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>dump</strong> ); </code></pre> </dd> -<dt>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_Sim_Serialize</strong>( - lucy_Similarity* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>Sim_Serialize</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_Similarity* // incremented -<strong>LUCY_Sim_Deserialize</strong>( - lucy_Similarity* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>Similarity* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Sim_Deserialize</strong>( + <span class="prefix">lucy_</span>Similarity* <strong>self</strong>, <span class="comment">// decremented</span> + <span class="prefix">lucy_</span><a href="lucy_InStream.html">InStream*</a> <strong>instream</strong> ); </code></pre> </dd>
