Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Normalizer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Normalizer.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Normalizer.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::Analysis::Normalizer â 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::Analysis::Normalizer</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::Analysis::Normalizer</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Normalizer</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_NORMALIZER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Normalizer</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Analysis::Normalizer - Unicode normalization, case folding and accent stripping.</p> +<p>Lucy::Analysis::Normalizer â Unicode normalization, case folding and accent stripping.</p> <h2>Description</h2> <p>Normalizer is an <a href="lucy_Analyzer.html">Analyzer</a> which normalizes tokens to one of the Unicode normalization forms. Optionally, it @@ -35,81 +101,82 @@ base character.</p> because it might add or remove characters.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Normalizer* -<strong>lucy_Normalizer_init</strong>( - lucy_Normalizer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>normalization_form</strong>, +<pre><code><span class="prefix">lucy_</span>Normalizer* +<span class="prefix">lucy_</span><strong>Normalizer_init</strong>( + <span class="prefix">lucy_</span>Normalizer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>normalization_form</strong>, bool <strong>case_fold</strong>, bool <strong>strip_accents</strong> ); </code></pre> <dl> -<dt><emph>normalization_form</emph></dt> +<dt>normalization_form</dt> <dd><p>Unicode normalization form, can be one of 'NFC', 'NFKC', 'NFD', 'NFKD'. Defaults to 'NFKC'.</p> </dd> -<dt><emph>case_fold</emph></dt> +<dt>case_fold</dt> <dd><p>Perform case folding, default is true.</p> </dd> -<dt><emph>strip_accents</emph></dt> +<dt>strip_accents</dt> <dd><p>Strip accents, default is false.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Analysis::Analyzer</h3><dl> -<dt>Transform</dt> +<h3>Methods inherited from Lucy::Analysis::Analyzer</h3> +<dl> +<dt id="func_Transform">Transform <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="lucy_Inversion.html">lucy_Inversion*</a> <strong>inversion</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <strong>inversion</strong> ); </code></pre> <p>Take a single <a href="lucy_Inversion.html">Inversion</a> as input and returns an Inversion, either the same one (presumably transformed in some way), or a new one.</p> </dd> -<dt>Transform_Text</dt> +<dt id="func_Transform_Text">Transform_Text</dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform_Text</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform_Text</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Kick off an analysis chain, creating an Inversion from string input. The default implementation simply creates an initial Inversion with a -single Token, then calls Transform(), but occasionally subclasses will +single Token, then calls <a href="lucy_Analyzer.html#func_Transform">Transform()</a>, but occasionally subclasses will provide an optimized implementation which minimizes string copies.</p> </dd> -<dt>Split</dt> +<dt id="func_Split">Split</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_Analyzer_Split</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</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>Analyzer_Split</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Analyze text and return an array of token texts.</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_Analyzer_Dump</strong>( - lucy_Analyzer* <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>Analyzer_Dump</strong>( + <span class="prefix">lucy_</span>Analyzer* <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_Analyzer_Load</strong>( - lucy_Analyzer* <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>Analyzer_Load</strong>( + <span class="prefix">lucy_</span>Analyzer* <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_ORQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_ORQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_ORQuery.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::Search::ORQuery â 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::ORQuery</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::ORQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>ORQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_ORQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_ORQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::ORQuery - Union multiple result sets.</p> +<p>Lucy::Search::ORQuery â Union multiple result sets.</p> <h2>Description</h2> <p>ORQuery is a composite <a href="lucy_Query.html">Query</a> which matches when any of its children match, so its result set is the union of their @@ -33,112 +99,114 @@ result sets. Matching documents recieve child Queries.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_ORQuery* -<strong>lucy_ORQuery_init</strong>( - lucy_ORQuery* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>children</strong> +<pre><code><span class="prefix">lucy_</span>ORQuery* +<span class="prefix">lucy_</span><strong>ORQuery_init</strong>( + <span class="prefix">lucy_</span>ORQuery* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>children</strong> ); </code></pre> <dl> -<dt><emph>children</emph></dt> +<dt>children</dt> <dd><p>An array of child Queries.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<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_PhraseQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_PhraseQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_PhraseQuery.html Tue Dec 2 17:54:11 2014 @@ -1,155 +1,222 @@ <!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::PhraseQuery â 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::PhraseQuery</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::PhraseQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>PhraseQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_PHRASEQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_PhraseQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::PhraseQuery - Query matching an ordered list of terms.</p> +<p>Lucy::Search::PhraseQuery â Query matching an ordered list of terms.</p> <h2>Description</h2> <p>PhraseQuery is a subclass of <a href="lucy_Query.html">Query</a> for matching against an ordered sequence of terms.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_PhraseQuery* -<strong>lucy_PhraseQuery_init</strong>( - lucy_PhraseQuery* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>terms</strong> +<pre><code><span class="prefix">lucy_</span>PhraseQuery* +<span class="prefix">lucy_</span><strong>PhraseQuery_init</strong>( + <span class="prefix">lucy_</span>PhraseQuery* <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_VArray.html">VArray*</a> <strong>terms</strong> ); </code></pre> <dl> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>The field that the phrase must occur in.</p> </dd> -<dt><emph>terms</emph></dt> +<dt>terms</dt> <dd><p>The ordered array of terms that must match.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Field</dt> +<dt id="func_Get_Field">Get_Field</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_PhraseQuery_Get_Field</strong>( - lucy_PhraseQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>PhraseQuery_Get_Field</strong>( + <span class="prefix">lucy_</span>PhraseQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's field attribute.</p> </dd> -<dt>Get_Terms</dt> +<dt id="func_Get_Terms">Get_Terms</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> -<strong>LUCY_PhraseQuery_Get_Terms</strong>( - lucy_PhraseQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> +<span class="prefix">LUCY_</span><strong>PhraseQuery_Get_Terms</strong>( + <span class="prefix">lucy_</span>PhraseQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's array of terms.</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_PolyAnalyzer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_PolyAnalyzer.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_PolyAnalyzer.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::Analysis::PolyAnalyzer â 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::Analysis::PolyAnalyzer</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::Analysis::PolyAnalyzer</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>PolyAnalyzer</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_POLYANALYZER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_PolyAnalyzer</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Analysis::PolyAnalyzer - Multiple Analyzers in series.</p> +<p>Lucy::Analysis::PolyAnalyzer â Multiple Analyzers in series.</p> <h2>Description</h2> <p>A PolyAnalyzer is a series of <a href="lucy_Analyzer.html">Analyzers</a>, each of which will be called upon to "analyze" text in turn. You can @@ -55,21 +121,21 @@ tr => Turkish, </code></pre> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_PolyAnalyzer* -<strong>lucy_PolyAnalyzer_init</strong>( - lucy_PolyAnalyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>language</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>analyzers</strong> +<pre><code><span class="prefix">lucy_</span>PolyAnalyzer* +<span class="prefix">lucy_</span><strong>PolyAnalyzer_init</strong>( + <span class="prefix">lucy_</span>PolyAnalyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>language</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>analyzers</strong> ); </code></pre> <dl> -<dt><emph>language</emph></dt> +<dt>language</dt> <dd><p>An ISO code from the list of supported languages. DEPRECATED, use <a href="lucy_EasyAnalyzer.html">EasyAnalyzer</a> instead.</p> </dd> -<dt><emph>analyzers</emph></dt> +<dt>analyzers</dt> <dd><p>An array of Analyzers. The order of the analyzers matters. Don't put a SnowballStemmer before a RegexTokenizer (can't stem whole documents or paragraphs -- just individual words), or a SnowballStopFilter @@ -81,68 +147,69 @@ stopalize, stem.</p> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Analyzers</dt> +<dt id="func_Get_Analyzers">Get_Analyzers</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> -<strong>LUCY_PolyAnalyzer_Get_Analyzers</strong>( - lucy_PolyAnalyzer* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> +<span class="prefix">LUCY_</span><strong>PolyAnalyzer_Get_Analyzers</strong>( + <span class="prefix">lucy_</span>PolyAnalyzer* <strong>self</strong> ); </code></pre> <p>Getter for "analyzers" member.</p> </dd> </dl> -<h3>Methods inherited from Lucy::Analysis::Analyzer</h3><dl> -<dt>Transform</dt> +<h3>Methods inherited from Lucy::Analysis::Analyzer</h3> +<dl> +<dt id="func_Transform">Transform <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="lucy_Inversion.html">lucy_Inversion*</a> <strong>inversion</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <strong>inversion</strong> ); </code></pre> <p>Take a single <a href="lucy_Inversion.html">Inversion</a> as input and returns an Inversion, either the same one (presumably transformed in some way), or a new one.</p> </dd> -<dt>Transform_Text</dt> +<dt id="func_Transform_Text">Transform_Text</dt> <dd> -<pre><code><a href="lucy_Inversion.html">lucy_Inversion*</a> // incremented -<strong>LUCY_Analyzer_Transform_Text</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Inversion.html">Inversion*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>Analyzer_Transform_Text</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Kick off an analysis chain, creating an Inversion from string input. The default implementation simply creates an initial Inversion with a -single Token, then calls Transform(), but occasionally subclasses will +single Token, then calls <a href="lucy_Analyzer.html#func_Transform">Transform()</a>, but occasionally subclasses will provide an optimized implementation which minimizes string copies.</p> </dd> -<dt>Split</dt> +<dt id="func_Split">Split</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_Analyzer_Split</strong>( - lucy_Analyzer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>text</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>Analyzer_Split</strong>( + <span class="prefix">lucy_</span>Analyzer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>text</strong> ); </code></pre> <p>Analyze text and return an array of token texts.</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_Analyzer_Dump</strong>( - lucy_Analyzer* <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>Analyzer_Dump</strong>( + <span class="prefix">lucy_</span>Analyzer* <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_Analyzer_Load</strong>( - lucy_Analyzer* <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>Analyzer_Load</strong>( + <span class="prefix">lucy_</span>Analyzer* <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_PolyQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_PolyQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_PolyQuery.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::Search::PolyQuery â 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::PolyQuery</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::PolyQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>PolyQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_POLYQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_PolyQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::PolyQuery - Base class for composite Query objects.</p> +<p>Lucy::Search::PolyQuery â Base class for composite Query objects.</p> <h2>Description</h2> <p>PolyQuery serves as a shared base class for <a href="lucy_ANDQuery.html">ANDQuery</a>, @@ -36,113 +102,114 @@ these classes may serve as nodes in comp which may be walked.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_PolyQuery* -<strong>lucy_PolyQuery_init</strong>( - lucy_PolyQuery* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>children</strong> +<pre><code><span class="prefix">lucy_</span>PolyQuery* +<span class="prefix">lucy_</span><strong>PolyQuery_init</strong>( + <span class="prefix">lucy_</span>PolyQuery* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>children</strong> ); </code></pre> <dl> -<dt><emph>children</emph></dt> +<dt>children</dt> <dd><p>An array of child Queries.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Add_Child</dt> +<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_PolyReader.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_PolyReader.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_PolyReader.html Tue Dec 2 17:54:11 2014 @@ -1,107 +1,174 @@ <!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::PolyReader â 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::PolyReader</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::PolyReader</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>PolyReader</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_POLYREADER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_PolyReader</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::PolyReader - Multi-segment implementation of IndexReader.</p> +<p>Lucy::Index::PolyReader â Multi-segment implementation of IndexReader.</p> <h2>Description</h2> <p>PolyReader conflates index data from multiple segments. For instance, if an index contains three segments with 10 documents each, PolyReader's -Doc_Max() method will return 30.</p> +<a href="lucy_PolyReader.html#func_Doc_Max">Doc_Max()</a> method will return 30.</p> <p>Some of PolyReader's <a href="lucy_DataReader.html">DataReader</a> components may be less efficient or complete than the single-segment implementations accessed via <a href="lucy_SegReader.html">SegReader</a>.</p> <h2>Functions</h2> <dl> -<dt>open</dt> +<dt id="func_open">open</dt> <dd> -<pre><code>lucy_PolyReader* // incremented -<strong>lucy_PolyReader_open</strong>( - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong> +<pre><code><span class="prefix">lucy_</span>PolyReader* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>PolyReader_open</strong>( + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong> ); </code></pre> </dd> -<dt>do_open</dt> +<dt id="func_do_open">do_open</dt> <dd> -<pre><code>lucy_PolyReader* -<strong>lucy_PolyReader_do_open</strong>( - lucy_PolyReader* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>index</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong> +<pre><code><span class="prefix">lucy_</span>PolyReader* +<span class="prefix">lucy_</span><strong>PolyReader_do_open</strong>( + <span class="prefix">lucy_</span>PolyReader* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>index</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong> ); </code></pre> <dl> -<dt><emph>index</emph></dt> +<dt>index</dt> <dd><p>Either a string filepath or a <a href="lucy_Folder.html">Folder</a>.</p> </dd> -<dt><emph>snapshot</emph></dt> +<dt>snapshot</dt> <dd><p>A Snapshot. If not supplied, the most recent snapshot file will be used.</p> </dd> -<dt><emph>manager</emph></dt> +<dt>manager</dt> <dd><p>An <a href="lucy_IndexManager.html">IndexManager</a>. Read-locking is off by default; supplying this argument turns it on.</p> </dd> </dl> </dd> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_PolyReader* // incremented -<strong>lucy_PolyReader_new</strong>( - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>sub_readers</strong> +<pre><code><span class="prefix">lucy_</span>PolyReader* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>PolyReader_new</strong>( + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>sub_readers</strong> ); </code></pre> </dd> -<dt>init</dt> -<dd> -<pre><code>lucy_PolyReader* -<strong>lucy_PolyReader_init</strong>( - lucy_PolyReader* <strong>self</strong>, - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong>, - <a href="lucy_Snapshot.html">lucy_Snapshot*</a> <strong>snapshot</strong>, - <a href="lucy_IndexManager.html">lucy_IndexManager*</a> <strong>manager</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>sub_readers</strong> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>PolyReader* +<span class="prefix">lucy_</span><strong>PolyReader_init</strong>( + <span class="prefix">lucy_</span>PolyReader* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong>, + <span class="prefix">lucy_</span><a href="lucy_Snapshot.html">Snapshot*</a> <strong>snapshot</strong>, + <span class="prefix">lucy_</span><a href="lucy_IndexManager.html">IndexManager*</a> <strong>manager</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>sub_readers</strong> ); </code></pre> </dd> </dl> <h2>Methods</h2> -<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 @@ -109,159 +176,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_PolySearcher.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_PolySearcher.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_PolySearcher.html Tue Dec 2 17:54:11 2014 @@ -1,62 +1,129 @@ <!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::PolySearcher â 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::PolySearcher</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::PolySearcher</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>PolySearcher</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_POLYSEARCHER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_PolySearcher</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::PolySearcher - Aggregate results from multiple Searchers.</p> +<p>Lucy::Search::PolySearcher â Aggregate results from multiple Searchers.</p> <h2>Description</h2> <p>The primary use for PolySearcher is to aggregate results from several indexes on a single machine.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_PolySearcher* -<strong>lucy_PolySearcher_init</strong>( - lucy_PolySearcher* <strong>self</strong>, - <a href="lucy_Schema.html">lucy_Schema*</a> <strong>schema</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>searchers</strong> +<pre><code><span class="prefix">lucy_</span>PolySearcher* +<span class="prefix">lucy_</span><strong>PolySearcher_init</strong>( + <span class="prefix">lucy_</span>PolySearcher* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Schema.html">Schema*</a> <strong>schema</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>searchers</strong> ); </code></pre> <dl> -<dt><emph>schema</emph></dt> +<dt>schema</dt> <dd><p>A Schema.</p> </dd> -<dt><emph>searchers</emph></dt> +<dt>searchers</dt> <dd><p>An array of Searchers.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Methods inherited from Lucy::Search::Searcher</h3><dl> -<dt>Doc_Max</dt> +<h3>Methods inherited from Lucy::Search::Searcher</h3> +<dl> +<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 @@ -64,110 +131,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>Glean_Query</dt> +<dt id="func_Glean_Query">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>Collect</dt> +<dt id="func_Collect">Collect <span class="comment">(abstract)</span></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> +<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><emph>query</emph></dt> +<dt>query</dt> <dd><p>A Query.</p> </dd> -<dt><emph>collector</emph></dt> +<dt>collector</dt> <dd><p>A Collector.</p> </dd> </dl> </dd> -<dt>Fetch_Doc</dt> +<dt id="func_Fetch_Doc">Fetch_Doc <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="lucy_HitDoc.html">lucy_HitDoc*</a> // incremented -<strong>LUCY_Searcher_Fetch_Doc</strong>( - lucy_Searcher* <strong>self</strong>, +<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><emph>doc_id</emph></dt> +<dt>doc_id</dt> <dd><p>A document id.</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_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_PostingList.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_PostingList.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_PostingList.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::PostingList â 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::PostingList</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::PostingList</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>PList</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_POSTINGLIST</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_PostingList</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::PostingList - Term-Document pairings.</p> +<p>Lucy::Index::PostingList â Term-Document pairings.</p> <h2>Description</h2> <p>PostingList is an iterator which supplies a list of document ids that match a given term.</p> @@ -33,96 +99,97 @@ a given term.</p> list".</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_PostingList* -<strong>lucy_PList_init</strong>( - lucy_PostingList* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>PostingList* +<span class="prefix">lucy_</span><strong>PList_init</strong>( + <span class="prefix">lucy_</span>PostingList* <strong>self</strong> ); </code></pre> </dd> </dl> <h2>Methods</h2> -<h3>Abstract methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Doc_Freq</dt> +<dt id="func_Get_Doc_Freq">Get_Doc_Freq <span class="comment">(abstract)</span></dt> <dd> <pre><code>uint32_t -<strong>LUCY_PList_Get_Doc_Freq</strong>( - lucy_PostingList* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>PList_Get_Doc_Freq</strong>( + <span class="prefix">lucy_</span>PostingList* <strong>self</strong> ); </code></pre> <p>Return the number of documents that the PostingList contains. (This number will include any documents which have been marked as deleted but not yet purged.)</p> </dd> -<dt>Seek</dt> +<dt id="func_Seek">Seek <span class="comment">(abstract)</span></dt> <dd> <pre><code>void -<strong>LUCY_PList_Seek</strong>( - lucy_PostingList* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>target</strong> +<span class="prefix">LUCY_</span><strong>PList_Seek</strong>( + <span class="prefix">lucy_</span>PostingList* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>target</strong> ); </code></pre> <p>Prepare the PostingList object to iterate over matches for documents that match <code>target</code>.</p> <dl> -<dt><emph>target</emph></dt> +<dt>target</dt> <dd><p>The term to match. If NULL, the iterator will be empty.</p> </dd> </dl> </dd> </dl> -<h3>Methods inherited from Lucy::Search::Matcher</h3><dl> -<dt>Next</dt> +<h3>Methods inherited from Lucy::Search::Matcher</h3> +<dl> +<dt id="func_Next">Next <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_Matcher_Next</strong>( - lucy_Matcher* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Matcher_Next</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong> ); </code></pre> <p>Proceed to the next doc id.</p> <p><strong>Returns:</strong> A positive doc id, or 0 once the iterator is exhausted.</p> </dd> -<dt>Advance</dt> +<dt id="func_Advance">Advance</dt> <dd> <pre><code>int32_t -<strong>LUCY_Matcher_Advance</strong>( - lucy_Matcher* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Matcher_Advance</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong>, int32_t <strong>target</strong> ); </code></pre> <p>Advance the iterator to the first doc id greater than or equal to -<code>target</code>. The default implementation simply calls Next() +<code>target</code>. The default implementation simply calls <a href="lucy_Matcher.html#func_Next">Next()</a> over and over, but subclasses have the option of doing something more efficient.</p> <dl> -<dt><emph>target</emph></dt> +<dt>target</dt> <dd><p>A positive doc id, which must be greater than the current doc id once the iterator has been initialized.</p> </dd> </dl> <p><strong>Returns:</strong> A positive doc id, or 0 once the iterator is exhausted.</p> </dd> -<dt>Get_Doc_ID</dt> +<dt id="func_Get_Doc_ID">Get_Doc_ID <span class="comment">(abstract)</span></dt> <dd> <pre><code>int32_t -<strong>LUCY_Matcher_Get_Doc_ID</strong>( - lucy_Matcher* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Matcher_Get_Doc_ID</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong> ); </code></pre> <p>Return the current doc id. Valid only after a successful call to -Next() or Advance() and must not be called otherwise.</p> +<a href="lucy_Matcher.html#func_Next">Next()</a> or <a href="lucy_Matcher.html#func_Advance">Advance()</a> and must not be called otherwise.</p> </dd> -<dt>Score</dt> +<dt id="func_Score">Score <span class="comment">(abstract)</span></dt> <dd> <pre><code>float -<strong>LUCY_Matcher_Score</strong>( - lucy_Matcher* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Matcher_Score</strong>( + <span class="prefix">lucy_</span>Matcher* <strong>self</strong> ); </code></pre> <p>Return the score of the current document.</p> -<p>Only Matchers which are used for scored search need implement Score().</p> +<p>Only Matchers which are used for scored search need implement <a href="lucy_Matcher.html#func_Score">Score()</a>.</p> </dd> </dl> <h2>Inheritance</h2>
