Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Snapshot.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Snapshot.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Snapshot.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::Snapshot â 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::Snapshot</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::Snapshot</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Snapshot</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SNAPSHOT</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Snapshot</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Index::Snapshot - Point-in-time index file list.</p> +<p>Lucy::Index::Snapshot â Point-in-time index file list.</p> <h2>Description</h2> <p>A Snapshot is list of index files and folders. Because index files, once written, are never modified, a Snapshot defines a point-in-time view of the @@ -34,130 +100,130 @@ data in an index.</p> associated with a single Snapshot.</p> <h2>Functions</h2> <dl> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_Snapshot* // incremented -<strong>lucy_Snapshot_new</strong>(void); +<pre><code><span class="prefix">lucy_</span>Snapshot* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>Snapshot_new</strong>(void); </code></pre> </dd> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Snapshot* -<strong>lucy_Snapshot_init</strong>( - lucy_Snapshot* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>Snapshot* +<span class="prefix">lucy_</span><strong>Snapshot_init</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong> ); </code></pre> <p>Constructor. Takes no arguments.</p> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>List</dt> +<dt id="func_List">List</dt> <dd> -<pre><code><a href="cfish_VArray.html">cfish_VArray*</a> // incremented -<strong>LUCY_Snapshot_List</strong>( - lucy_Snapshot* <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>Snapshot_List</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong> ); </code></pre> <p>Return an array of all entries.</p> </dd> -<dt>Num_Entries</dt> +<dt id="func_Num_Entries">Num_Entries</dt> <dd> <pre><code>uint32_t -<strong>LUCY_Snapshot_Num_Entries</strong>( - lucy_Snapshot* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Snapshot_Num_Entries</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong> ); </code></pre> <p>Return the number of entries (including directories).</p> </dd> -<dt>Add_Entry</dt> +<dt id="func_Add_Entry">Add_Entry</dt> <dd> <pre><code>void -<strong>LUCY_Snapshot_Add_Entry</strong>( - lucy_Snapshot* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>entry</strong> +<span class="prefix">LUCY_</span><strong>Snapshot_Add_Entry</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>entry</strong> ); </code></pre> <p>Add a filepath to the snapshot.</p> </dd> -<dt>Delete_Entry</dt> +<dt id="func_Delete_Entry">Delete_Entry</dt> <dd> <pre><code>bool -<strong>LUCY_Snapshot_Delete_Entry</strong>( - lucy_Snapshot* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>entry</strong> +<span class="prefix">LUCY_</span><strong>Snapshot_Delete_Entry</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>entry</strong> ); </code></pre> <p>Delete a filepath from the snapshot.</p> <p><strong>Returns:</strong> true if the entry existed and was successfully deleted, false otherwise.</p> </dd> -<dt>Read_File</dt> +<dt id="func_Read_File">Read_File</dt> <dd> -<pre><code>lucy_Snapshot* -<strong>LUCY_Snapshot_Read_File</strong>( - lucy_Snapshot* <strong>self</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<pre><code><span class="prefix">lucy_</span>Snapshot* +<span class="prefix">LUCY_</span><strong>Snapshot_Read_File</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Decode a snapshot file and initialize the object to reflect its contents.</p> <dl> -<dt><emph>folder</emph></dt> +<dt>folder</dt> <dd><p>A Folder.</p> </dd> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>The location of the snapshot file. If not supplied, the most recent snapshot file in the base directory will be chosen.</p> </dd> </dl> <p><strong>Returns:</strong> the object, allowing an assignment idiom.</p> </dd> -<dt>Write_File</dt> +<dt id="func_Write_File">Write_File</dt> <dd> <pre><code>void -<strong>LUCY_Snapshot_Write_File</strong>( - lucy_Snapshot* <strong>self</strong>, - <a href="lucy_Folder.html">lucy_Folder*</a> <strong>folder</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Snapshot_Write_File</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_Folder.html">Folder*</a> <strong>folder</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Write a snapshot file. The caller must lock the index while this operation takes place, and the operation will fail if the snapshot file already exists.</p> <dl> -<dt><emph>folder</emph></dt> +<dt>folder</dt> <dd><p>A Folder.</p> </dd> -<dt><emph>path</emph></dt> +<dt>path</dt> <dd><p>The path of the file to write. If NULL, a file name will be chosen which supersedes the latest snapshot file in the index folder.</p> </dd> </dl> </dd> -<dt>Set_Path</dt> +<dt id="func_Set_Path">Set_Path</dt> <dd> <pre><code>void -<strong>LUCY_Snapshot_Set_Path</strong>( - lucy_Snapshot* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>path</strong> +<span class="prefix">LUCY_</span><strong>Snapshot_Set_Path</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>path</strong> ); </code></pre> <p>Set the path to the file that the Snapshot object serves as a proxy for.</p> </dd> -<dt>Get_Path</dt> +<dt id="func_Get_Path">Get_Path</dt> <dd> -<pre><code><a href="cfish_String.html">cfish_String*</a> -<strong>LUCY_Snapshot_Get_Path</strong>( - lucy_Snapshot* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>Snapshot_Get_Path</strong>( + <span class="prefix">lucy_</span>Snapshot* <strong>self</strong> ); </code></pre> <p>Get the path to the snapshot file. Initially NULL; updated by -Read_File(), Write_File(), and Set_Path().</p> +<a href="lucy_Snapshot.html#func_Read_File">Read_File()</a>, <a href="lucy_Snapshot.html#func_Write_File">Write_File()</a>, and <a href="lucy_Snapshot.html#func_Set_Path">Set_Path()</a>.</p> </dd> </dl> <h2>Inheritance</h2>
Modified: websites/staging/lucy/trunk/content/docs/c/lucy_SnowballStemmer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_SnowballStemmer.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_SnowballStemmer.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::SnowballStemmer â 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::SnowballStemmer</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::SnowballStemmer</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>SnowStemmer</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SNOWBALLSTEMMER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_SnowballStemmer</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Analysis::SnowballStemmer - Reduce related words to a shared root.</p> +<p>Lucy::Analysis::SnowballStemmer â Reduce related words to a shared root.</p> <h2>Description</h2> <p>SnowballStemmer is an <a href="lucy_Analyzer.html">Analyzer</a> which reduces related words to a root form (using the "Snowball" stemming library). For @@ -34,16 +100,16 @@ search for 'horse' will also match docum 'horsing'.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_SnowballStemmer* -<strong>lucy_SnowStemmer_init</strong>( - lucy_SnowballStemmer* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>language</strong> +<pre><code><span class="prefix">lucy_</span>SnowballStemmer* +<span class="prefix">lucy_</span><strong>SnowStemmer_init</strong>( + <span class="prefix">lucy_</span>SnowballStemmer* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>language</strong> ); </code></pre> <dl> -<dt><emph>language</emph></dt> +<dt>language</dt> <dd><p>A two-letter ISO code identifying a language supported by Snowball.</p> </dd> @@ -51,56 +117,57 @@ by Snowball.</p> </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_SnowballStopFilter.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_SnowballStopFilter.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_SnowballStopFilter.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::SnowballStopFilter â 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::SnowballStopFilter</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::SnowballStopFilter</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>SnowStop</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SNOWBALLSTOPFILTER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_SnowballStopFilter</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Analysis::SnowballStopFilter - Suppress a "stoplist" of common words.</p> +<p>Lucy::Analysis::SnowballStopFilter â Suppress a "stoplist" of common words.</p> <h2>Description</h2> <p>A "stoplist" is collection of "stopwords": words which are common enough to be of little value when determining search results. For example, so many @@ -60,76 +126,77 @@ supply your own.</p> </code></pre> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_SnowballStopFilter* -<strong>lucy_SnowStop_init</strong>( - lucy_SnowballStopFilter* <strong>self</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>language</strong>, - <a href="cfish_Hash.html">cfish_Hash*</a> <strong>stoplist</strong> +<pre><code><span class="prefix">lucy_</span>SnowballStopFilter* +<span class="prefix">lucy_</span><strong>SnowStop_init</strong>( + <span class="prefix">lucy_</span>SnowballStopFilter* <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_Hash.html">Hash*</a> <strong>stoplist</strong> ); </code></pre> <dl> -<dt><emph>stoplist</emph></dt> +<dt>stoplist</dt> <dd><p>A hash with stopwords as the keys.</p> </dd> -<dt><emph>language</emph></dt> +<dt>language</dt> <dd><p>The ISO code for a supported language.</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_SortRule.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_SortRule.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_SortRule.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::SortRule â 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::SortRule</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::SortRule</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>SortRule</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SORTRULE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_SortRule</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::SortRule - Element of a SortSpec.</p> +<p>Lucy::Search::SortRule â Element of a SortSpec.</p> <h2>Description</h2> <p>SortRules are the building blocks used to assemble <a href="lucy_SortSpec.html">SortSpecs</a>; each SortRule defines a single @@ -33,85 +99,85 @@ level of sorting. For example, sorting requires a SortSpec with two SortRule elements.</p> <h2>Functions</h2> <dl> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_SortRule* // incremented -<strong>lucy_SortRule_new</strong>( +<pre><code><span class="prefix">lucy_</span>SortRule* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>SortRule_new</strong>( int32_t <strong>type</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, bool <strong>reverse</strong> ); </code></pre> </dd> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_SortRule* // incremented -<strong>lucy_SortRule_init</strong>( - lucy_SortRule* <strong>self</strong>, +<pre><code><span class="prefix">lucy_</span>SortRule* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>SortRule_init</strong>( + <span class="prefix">lucy_</span>SortRule* <strong>self</strong>, int32_t <strong>type</strong>, - <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, + <span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> <strong>field</strong>, bool <strong>reverse</strong> ); </code></pre> <dl> -<dt><emph>type</emph></dt> +<dt>type</dt> <dd><p>Indicate whether to sort by score, field, etc. (The default is to sort by a field.)</p> </dd> -<dt><emph>field</emph></dt> +<dt>field</dt> <dd><p>The name of a <code>sortable</code> field.</p> </dd> -<dt><emph>reverse</emph></dt> +<dt>reverse</dt> <dd><p>If true, reverse the order of the sort for this rule.</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_SortRule_Get_Field</strong>( - lucy_SortRule* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>SortRule_Get_Field</strong>( + <span class="prefix">lucy_</span>SortRule* <strong>self</strong> ); </code></pre> <p>Accessor for "field" member.</p> </dd> -<dt>Get_Type</dt> +<dt id="func_Get_Type">Get_Type</dt> <dd> <pre><code>int32_t -<strong>LUCY_SortRule_Get_Type</strong>( - lucy_SortRule* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>SortRule_Get_Type</strong>( + <span class="prefix">lucy_</span>SortRule* <strong>self</strong> ); </code></pre> <p>Accessor for "type" member.</p> </dd> -<dt>Get_Reverse</dt> +<dt id="func_Get_Reverse">Get_Reverse</dt> <dd> <pre><code>bool -<strong>LUCY_SortRule_Get_Reverse</strong>( - lucy_SortRule* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>SortRule_Get_Reverse</strong>( + <span class="prefix">lucy_</span>SortRule* <strong>self</strong> ); </code></pre> <p>Accessor for "reverse" member.</p> </dd> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_SortRule* // incremented -<strong>LUCY_SortRule_Deserialize</strong>( - lucy_SortRule* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>SortRule* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>SortRule_Deserialize</strong>( + <span class="prefix">lucy_</span>SortRule* <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>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_SortRule_Serialize</strong>( - lucy_SortRule* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>SortRule_Serialize</strong>( + <span class="prefix">lucy_</span>SortRule* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_SortSpec.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_SortSpec.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_SortSpec.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::SortSpec â 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::SortSpec</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::SortSpec</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>SortSpec</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SORTSPEC</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_SortSpec</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::SortSpec - Specify a custom sort order for search results.</p> +<p>Lucy::Search::SortSpec â Specify a custom sort order for search results.</p> <h2>Description</h2> <p>By default, searches return results in order of relevance; SortSpec allows you to indicate an alternate order via an array of @@ -35,47 +101,47 @@ you to indicate an alternate order via a sort-by-doc rule as the last SortRule.</p> <h2>Functions</h2> <dl> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_SortSpec* -<strong>lucy_SortSpec_new</strong>( - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>rules</strong> +<pre><code><span class="prefix">lucy_</span>SortSpec* +<span class="prefix">lucy_</span><strong>SortSpec_new</strong>( + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>rules</strong> ); </code></pre> </dd> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_SortSpec* -<strong>lucy_SortSpec_init</strong>( - lucy_SortSpec* <strong>self</strong>, - <a href="cfish_VArray.html">cfish_VArray*</a> <strong>rules</strong> +<pre><code><span class="prefix">lucy_</span>SortSpec* +<span class="prefix">lucy_</span><strong>SortSpec_init</strong>( + <span class="prefix">lucy_</span>SortSpec* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_VArray.html">VArray*</a> <strong>rules</strong> ); </code></pre> <dl> -<dt><emph>rules</emph></dt> +<dt>rules</dt> <dd><p>An array of SortRules.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Deserialize</dt> +<dt id="func_Deserialize">Deserialize</dt> <dd> -<pre><code>lucy_SortSpec* // incremented -<strong>LUCY_SortSpec_Deserialize</strong>( - lucy_SortSpec* <strong>self</strong>, // decremented - <a href="lucy_InStream.html">lucy_InStream*</a> <strong>instream</strong> +<pre><code><span class="prefix">lucy_</span>SortSpec* <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>SortSpec_Deserialize</strong>( + <span class="prefix">lucy_</span>SortSpec* <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>Serialize</dt> +<dt id="func_Serialize">Serialize</dt> <dd> <pre><code>void -<strong>LUCY_SortSpec_Serialize</strong>( - lucy_SortSpec* <strong>self</strong>, - <a href="lucy_OutStream.html">lucy_OutStream*</a> <strong>outstream</strong> +<span class="prefix">LUCY_</span><strong>SortSpec_Serialize</strong>( + <span class="prefix">lucy_</span>SortSpec* <strong>self</strong>, + <span class="prefix">lucy_</span><a href="lucy_OutStream.html">OutStream*</a> <strong>outstream</strong> ); </code></pre> </dd> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_Span.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_Span.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_Span.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::Span â 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::Span</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::Span</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>Span</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_SPAN</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_Span</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::Span - An offset, a length, and a weight.</p> +<p>Lucy::Search::Span â An offset, a length, and a weight.</p> <h2>Description</h2> <p>Span objects store information about a span across an array of... something. The unit is context-dependent.</p> @@ -35,84 +101,84 @@ within an array of tokens, for example - offset might be measured in token positions.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_Span* -<strong>lucy_Span_init</strong>( - lucy_Span* <strong>self</strong>, +<pre><code><span class="prefix">lucy_</span>Span* +<span class="prefix">lucy_</span><strong>Span_init</strong>( + <span class="prefix">lucy_</span>Span* <strong>self</strong>, int32_t <strong>offset</strong>, int32_t <strong>length</strong>, float <strong>weight</strong> ); </code></pre> <dl> -<dt><emph>offset</emph></dt> +<dt>offset</dt> <dd><p>Integer offset, unit is context-dependent.</p> </dd> -<dt><emph>length</emph></dt> +<dt>length</dt> <dd><p>Integer length, unit is context-dependent.</p> </dd> -<dt><emph>weight</emph></dt> +<dt>weight</dt> <dd><p>A floating point weight.</p> </dd> </dl> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Get_Offset</dt> +<dt id="func_Get_Offset">Get_Offset</dt> <dd> <pre><code>int32_t -<strong>LUCY_Span_Get_Offset</strong>( - lucy_Span* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Span_Get_Offset</strong>( + <span class="prefix">lucy_</span>Span* <strong>self</strong> ); </code></pre> <p>Accessor for <code>offset</code> attribute.</p> </dd> -<dt>Set_Offset</dt> +<dt id="func_Set_Offset">Set_Offset</dt> <dd> <pre><code>void -<strong>LUCY_Span_Set_Offset</strong>( - lucy_Span* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Span_Set_Offset</strong>( + <span class="prefix">lucy_</span>Span* <strong>self</strong>, int32_t <strong>offset</strong> ); </code></pre> <p>Setter for <code>offset</code> attribute.</p> </dd> -<dt>Get_Length</dt> +<dt id="func_Get_Length">Get_Length</dt> <dd> <pre><code>int32_t -<strong>LUCY_Span_Get_Length</strong>( - lucy_Span* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Span_Get_Length</strong>( + <span class="prefix">lucy_</span>Span* <strong>self</strong> ); </code></pre> <p>Accessor for <code>length</code> attribute.</p> </dd> -<dt>Set_Length</dt> +<dt id="func_Set_Length">Set_Length</dt> <dd> <pre><code>void -<strong>LUCY_Span_Set_Length</strong>( - lucy_Span* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Span_Set_Length</strong>( + <span class="prefix">lucy_</span>Span* <strong>self</strong>, int32_t <strong>length</strong> ); </code></pre> <p>Setter for <code>length</code> attribute.</p> </dd> -<dt>Get_Weight</dt> +<dt id="func_Get_Weight">Get_Weight</dt> <dd> <pre><code>float -<strong>LUCY_Span_Get_Weight</strong>( - lucy_Span* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>Span_Get_Weight</strong>( + <span class="prefix">lucy_</span>Span* <strong>self</strong> ); </code></pre> <p>Accessor for <code>weight</code> attribute.</p> </dd> -<dt>Set_Weight</dt> +<dt id="func_Set_Weight">Set_Weight</dt> <dd> <pre><code>void -<strong>LUCY_Span_Set_Weight</strong>( - lucy_Span* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>Span_Set_Weight</strong>( + <span class="prefix">lucy_</span>Span* <strong>self</strong>, float <strong>weight</strong> ); </code></pre> Modified: websites/staging/lucy/trunk/content/docs/c/lucy_StandardTokenizer.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_StandardTokenizer.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_StandardTokenizer.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::StandardTokenizer â 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::StandardTokenizer</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::StandardTokenizer</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>StandardTokenizer</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_STANDARDTOKENIZER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_StandardTokenizer</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Analysis::StandardTokenizer - Split a string into tokens.</p> +<p>Lucy::Analysis::StandardTokenizer â Split a string into tokens.</p> <h2>Description</h2> <p>Generically, "tokenizing" is a process of breaking up a string into an array of "tokens". For instance, the string "three blind mice" might be @@ -35,67 +101,68 @@ boundaries defined in Unicode Standard A words that start with an alphabetic or numeric character.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_StandardTokenizer* -<strong>lucy_StandardTokenizer_init</strong>( - lucy_StandardTokenizer* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>StandardTokenizer* +<span class="prefix">lucy_</span><strong>StandardTokenizer_init</strong>( + <span class="prefix">lucy_</span>StandardTokenizer* <strong>self</strong> ); </code></pre> <p>Constructor. Takes no arguments.</p> </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_StringType.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_StringType.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_StringType.html Tue Dec 2 17:54:11 2014 @@ -1,191 +1,258 @@ <!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::StringType â 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::StringType</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::StringType</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>StringType</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_STRINGTYPE</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_StringType</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Plan::StringType - Non-tokenized text type.</p> +<p>Lucy::Plan::StringType â Non-tokenized text type.</p> <h2>Description</h2> <p>Lucy::Plan::StringType is used for "exact-match" strings.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_StringType* -<strong>lucy_StringType_init</strong>( - lucy_StringType* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span>StringType* +<span class="prefix">lucy_</span><strong>StringType_init</strong>( + <span class="prefix">lucy_</span>StringType* <strong>self</strong> ); </code></pre> <dl> -<dt><emph>boost</emph></dt> +<dt>boost</dt> <dd><p>floating point per-field boost.</p> </dd> -<dt><emph>indexed</emph></dt> +<dt>indexed</dt> <dd><p>boolean indicating whether the field should be indexed.</p> </dd> -<dt><emph>stored</emph></dt> +<dt>stored</dt> <dd><p>boolean indicating whether the field should be stored.</p> </dd> -<dt><emph>sortable</emph></dt> +<dt>sortable</dt> <dd><p>boolean indicating whether the field should be sortable.</p> </dd> </dl> </dd> -<dt>new</dt> +<dt id="func_new">new</dt> <dd> -<pre><code>lucy_StringType* // incremented -<strong>lucy_StringType_new</strong>(void); +<pre><code><span class="prefix">lucy_</span>StringType* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>StringType_new</strong>(void); </code></pre> </dd> </dl> <h2>Methods</h2> -<h3>Novel methods</h3> +<h3>Novel methods</h3 <dl> -<dt>Make_Similarity</dt> +<dt id="func_Make_Similarity">Make_Similarity</dt> <dd> -<pre><code><a href="lucy_Similarity.html">lucy_Similarity*</a> // incremented -<strong>LUCY_StringType_Make_Similarity</strong>( - lucy_StringType* <strong>self</strong> +<pre><code><span class="prefix">lucy_</span><a href="lucy_Similarity.html">Similarity*</a> <span class="comment">// incremented</span> +<span class="prefix">LUCY_</span><strong>StringType_Make_Similarity</strong>( + <span class="prefix">lucy_</span>StringType* <strong>self</strong> ); </code></pre> </dd> </dl> -<h3>Methods inherited from Lucy::Plan::FieldType</h3><dl> -<dt>Set_Boost</dt> +<h3>Methods inherited from Lucy::Plan::FieldType</h3> +<dl> +<dt id="func_Set_Boost">Set_Boost</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Boost</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Boost</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, float <strong>boost</strong> ); </code></pre> <p>Setter for <code>boost</code>.</p> </dd> -<dt>Get_Boost</dt> +<dt id="func_Get_Boost">Get_Boost</dt> <dd> <pre><code>float -<strong>LUCY_FType_Get_Boost</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Get_Boost</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>boost</code>.</p> </dd> -<dt>Set_Indexed</dt> +<dt id="func_Set_Indexed">Set_Indexed</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Indexed</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>indexed</strong> ); </code></pre> <p>Setter for <code>indexed</code>.</p> </dd> -<dt>Indexed</dt> +<dt id="func_Indexed">Indexed</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Indexed</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Indexed</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>indexed</code>.</p> </dd> -<dt>Set_Stored</dt> +<dt id="func_Set_Stored">Set_Stored</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Stored</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Stored</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>stored</strong> ); </code></pre> <p>Setter for <code>stored</code>.</p> </dd> -<dt>Stored</dt> +<dt id="func_Stored">Stored</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Stored</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Stored</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>stored</code>.</p> </dd> -<dt>Set_Sortable</dt> +<dt id="func_Set_Sortable">Set_Sortable</dt> <dd> <pre><code>void -<strong>LUCY_FType_Set_Sortable</strong>( - lucy_FieldType* <strong>self</strong>, +<span class="prefix">LUCY_</span><strong>FType_Set_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, bool <strong>sortable</strong> ); </code></pre> <p>Setter for <code>sortable</code>.</p> </dd> -<dt>Sortable</dt> +<dt id="func_Sortable">Sortable</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Sortable</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Sortable</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Accessor for <code>sortable</code>.</p> </dd> -<dt>Binary</dt> +<dt id="func_Binary">Binary</dt> <dd> <pre><code>bool -<strong>LUCY_FType_Binary</strong>( - lucy_FieldType* <strong>self</strong> +<span class="prefix">LUCY_</span><strong>FType_Binary</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> <p>Indicate whether the field contains binary data.</p> </dd> -<dt>Compare_Values</dt> +<dt id="func_Compare_Values">Compare_Values</dt> <dd> <pre><code>int32_t -<strong>LUCY_FType_Compare_Values</strong>( - lucy_FieldType* <strong>self</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>a</strong>, - <a href="cfish_Obj.html">cfish_Obj*</a> <strong>b</strong> +<span class="prefix">LUCY_</span><strong>FType_Compare_Values</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>a</strong>, + <span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> <strong>b</strong> ); </code></pre> <p>Compare two values for the field. The default implementation -dispatches to the Compare_To() method of argument <code>a</code>.</p> +dispatches to the <a href="lucy_FieldType.html#func_Compare_To">Compare_To()</a> method of argument <code>a</code>.</p> <p><strong>Returns:</strong> a negative number if a is "less than" b, 0 if they are "equal", and a positive number if a is "greater than" b.</p> </dd> -<dt>Dump</dt> +<dt id="func_Dump">Dump <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_FType_Dump</strong>( - lucy_FieldType* <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>FType_Dump</strong>( + <span class="prefix">lucy_</span>FieldType* <strong>self</strong> ); </code></pre> </dd> -<dt>Load</dt> +<dt id="func_Load">Load <span class="comment">(abstract)</span></dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented -<strong>LUCY_FType_Load</strong>( - lucy_FieldType* <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>FType_Load</strong>( + <span class="prefix">lucy_</span>FieldType* <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_TermQuery.html ============================================================================== --- websites/staging/lucy/trunk/content/docs/c/lucy_TermQuery.html (original) +++ websites/staging/lucy/trunk/content/docs/c/lucy_TermQuery.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::TermQuery â 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::TermQuery</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::TermQuery</td> +</tr> +<tr> +<td class="label">class nickname</td> +<td>TermQuery</td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code>LUCY_TERMQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code>lucy_TermQuery</code></td> +</tr> +</table> <h2>Name</h2> -<p>Lucy::Search::TermQuery - Query which matches individual terms.</p> +<p>Lucy::Search::TermQuery â Query which matches individual terms.</p> <h2>Description</h2> <p>TermQuery is a subclass of <a href="lucy_Query.html">Query</a> for matching individual terms in a specific field.</p> <h2>Functions</h2> <dl> -<dt>init</dt> +<dt id="func_init">init</dt> <dd> -<pre><code>lucy_TermQuery* -<strong>lucy_TermQuery_init</strong>( - lucy_TermQuery* <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> +<pre><code><span class="prefix">lucy_</span>TermQuery* +<span class="prefix">lucy_</span><strong>TermQuery_init</strong>( + <span class="prefix">lucy_</span>TermQuery* <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> <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>Term text.</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_TermQuery_Get_Field</strong>( - lucy_TermQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_String.html">String*</a> +<span class="prefix">LUCY_</span><strong>TermQuery_Get_Field</strong>( + <span class="prefix">lucy_</span>TermQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's <code>field</code> member.</p> </dd> -<dt>Get_Term</dt> +<dt id="func_Get_Term">Get_Term</dt> <dd> -<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> -<strong>LUCY_TermQuery_Get_Term</strong>( - lucy_TermQuery* <strong>self</strong> +<pre><code><span class="prefix">cfish_</span><a href="cfish_Obj.html">Obj*</a> +<span class="prefix">LUCY_</span><strong>TermQuery_Get_Term</strong>( + <span class="prefix">lucy_</span>TermQuery* <strong>self</strong> ); </code></pre> <p>Accessor for object's <code>term</code> member.</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>
