Added: lucy/site/trunk/content/docs/c/lucy_SnowballStopFilter.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_SnowballStopFilter.html?rev=1641230&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_SnowballStopFilter.html (added) +++ lucy/site/trunk/content/docs/c/lucy_SnowballStopFilter.html Sun Nov 23 17:42:57 2014 @@ -0,0 +1,140 @@ +<!DOCTYPE html> +<html> +<head> +<meta name="viewport" content="width=device-width" /> +<style type="text/css"> +body { + font-family: sans-serif; + font-size: 0.85em; + max-width: 640px; +} +dt { + font-weight: bold; +} +pre { + border: 1px solid #000; + padding: 0.2em 0.4em; + background: #f6f6f6; + font-size: 1.2em; +} +code { + font-family: "Consolas", "Menlo", monospace; +} +</style> +</head> +<body> +<h1>Lucy::Analysis::SnowballStopFilter</h1> +<h2>Name</h2> +<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 +documents in English contain "the", "if", and "maybe" that it may improve +both performance and relevance to block them.</p> +<p>Before filtering stopwords:</p> +<pre><code>("i", "am", "the", "walrus") +</code></pre> +<p>After filtering stopwords:</p> +<pre><code>("walrus") +</code></pre> +<p>SnowballStopFilter provides default stoplists for several languages, +courtesy of the <a href="http://snowball.tartarus.org";>Snowball project</a>, or you may +supply your own.</p> +<pre><code>|-----------------------| +| ISO CODE | LANGUAGE | +|-----------------------| +| da | Danish | +| de | German | +| en | English | +| es | Spanish | +| fi | Finnish | +| fr | French | +| hu | Hungarian | +| it | Italian | +| nl | Dutch | +| no | Norwegian | +| pt | Portuguese | +| sv | Swedish | +| ru | Russian | +|-----------------------| +</code></pre> +<h2>Functions</h2> +<dl> +<dt>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> +); +</code></pre> +<dl> +<dt><emph>stoplist</emph></dt> +<dd><p>A hash with stopwords as the keys.</p> +</dd> +<dt><emph>language</emph></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> +<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> +); +</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> +<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> +); +</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 +provide an optimized implementation which minimizes string copies.</p> +</dd> +<dt>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> +); +</code></pre> +<p>Analyze text and return an array of token texts.</p> +</dd> +<dt>Dump</dt> +<dd> +<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented +<strong>LUCY_Analyzer_Dump</strong>( + lucy_Analyzer* <strong>self</strong> +); +</code></pre> +</dd> +<dt>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> +); +</code></pre> +</dd> +</dl> +<h2>Inheritance</h2> +<p>Lucy::Analysis::SnowballStopFilter is a <a href="lucy_Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> +</body> +</html>
Added: lucy/site/trunk/content/docs/c/lucy_SortRule.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_SortRule.html?rev=1641230&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_SortRule.html (added) +++ lucy/site/trunk/content/docs/c/lucy_SortRule.html Sun Nov 23 17:42:57 2014 @@ -0,0 +1,122 @@ +<!DOCTYPE html> +<html> +<head> +<meta name="viewport" content="width=device-width" /> +<style type="text/css"> +body { + font-family: sans-serif; + font-size: 0.85em; + max-width: 640px; +} +dt { + font-weight: bold; +} +pre { + border: 1px solid #000; + padding: 0.2em 0.4em; + background: #f6f6f6; + font-size: 1.2em; +} +code { + font-family: "Consolas", "Menlo", monospace; +} +</style> +</head> +<body> +<h1>Lucy::Search::SortRule</h1> +<h2>Name</h2> +<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 +level of sorting. For example, sorting first by "category" then by score +requires a SortSpec with two SortRule elements.</p> +<h2>Functions</h2> +<dl> +<dt>new</dt> +<dd> +<pre><code>lucy_SortRule* // incremented +<strong>lucy_SortRule_new</strong>( + int32_t <strong>type</strong>, + <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, + bool <strong>reverse</strong> +); +</code></pre> +</dd> +<dt>init</dt> +<dd> +<pre><code>lucy_SortRule* // incremented +<strong>lucy_SortRule_init</strong>( + lucy_SortRule* <strong>self</strong>, + int32_t <strong>type</strong>, + <a href="cfish_String.html">cfish_String*</a> <strong>field</strong>, + bool <strong>reverse</strong> +); +</code></pre> +<dl> +<dt><emph>type</emph></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> +<dd><p>The name of a <code>sortable</code> field.</p> +</dd> +<dt><emph>reverse</emph></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> +<dl> +<dt>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> +); +</code></pre> +<p>Accessor for "field" member.</p> +</dd> +<dt>Get_Type</dt> +<dd> +<pre><code>int32_t +<strong>LUCY_SortRule_Get_Type</strong>( + lucy_SortRule* <strong>self</strong> +); +</code></pre> +<p>Accessor for "type" member.</p> +</dd> +<dt>Get_Reverse</dt> +<dd> +<pre><code>bool +<strong>LUCY_SortRule_Get_Reverse</strong>( + lucy_SortRule* <strong>self</strong> +); +</code></pre> +<p>Accessor for "reverse" member.</p> +</dd> +<dt>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> +); +</code></pre> +</dd> +<dt>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> +); +</code></pre> +</dd> +</dl> +<h2>Inheritance</h2> +<p>Lucy::Search::SortRule is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> +</body> +</html> Added: lucy/site/trunk/content/docs/c/lucy_SortSpec.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_SortSpec.html?rev=1641230&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_SortSpec.html (added) +++ lucy/site/trunk/content/docs/c/lucy_SortSpec.html Sun Nov 23 17:42:57 2014 @@ -0,0 +1,86 @@ +<!DOCTYPE html> +<html> +<head> +<meta name="viewport" content="width=device-width" /> +<style type="text/css"> +body { + font-family: sans-serif; + font-size: 0.85em; + max-width: 640px; +} +dt { + font-weight: bold; +} +pre { + border: 1px solid #000; + padding: 0.2em 0.4em; + background: #f6f6f6; + font-size: 1.2em; +} +code { + font-family: "Consolas", "Menlo", monospace; +} +</style> +</head> +<body> +<h1>Lucy::Search::SortSpec</h1> +<h2>Name</h2> +<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 +<a href="lucy_SortRule.html">SortRules</a>.</p> +<p>Fields you wish to sort against must be <code>sortable</code>.</p> +<p>For a stable sort (important when paging through results), add a +sort-by-doc rule as the last SortRule.</p> +<h2>Functions</h2> +<dl> +<dt>new</dt> +<dd> +<pre><code>lucy_SortSpec* +<strong>lucy_SortSpec_new</strong>( + <a href="cfish_VArray.html">cfish_VArray*</a> <strong>rules</strong> +); +</code></pre> +</dd> +<dt>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> +); +</code></pre> +<dl> +<dt><emph>rules</emph></dt> +<dd><p>An array of SortRules.</p> +</dd> +</dl> +</dd> +</dl> +<h2>Methods</h2> +<h3>Novel methods</h3> +<dl> +<dt>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> +); +</code></pre> +</dd> +<dt>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> +); +</code></pre> +</dd> +</dl> +<h2>Inheritance</h2> +<p>Lucy::Search::SortSpec is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> +</body> +</html> Added: lucy/site/trunk/content/docs/c/lucy_Span.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_Span.html?rev=1641230&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_Span.html (added) +++ lucy/site/trunk/content/docs/c/lucy_Span.html Sun Nov 23 17:42:57 2014 @@ -0,0 +1,125 @@ +<!DOCTYPE html> +<html> +<head> +<meta name="viewport" content="width=device-width" /> +<style type="text/css"> +body { + font-family: sans-serif; + font-size: 0.85em; + max-width: 640px; +} +dt { + font-weight: bold; +} +pre { + border: 1px solid #000; + padding: 0.2em 0.4em; + background: #f6f6f6; + font-size: 1.2em; +} +code { + font-family: "Consolas", "Menlo", monospace; +} +</style> +</head> +<body> +<h1>Lucy::Search::Span</h1> +<h2>Name</h2> +<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> +<p>Text is one possibility, in which case offset and length might be measured +in Unicode code points. However, the Span could also refer to a span +within an array of tokens, for example -- in which case the start and +offset might be measured in token positions.</p> +<h2>Functions</h2> +<dl> +<dt>init</dt> +<dd> +<pre><code>lucy_Span* +<strong>lucy_Span_init</strong>( + lucy_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> +<dd><p>Integer offset, unit is context-dependent.</p> +</dd> +<dt><emph>length</emph></dt> +<dd><p>Integer length, unit is context-dependent.</p> +</dd> +<dt><emph>weight</emph></dt> +<dd><p>A floating point weight.</p> +</dd> +</dl> +</dd> +</dl> +<h2>Methods</h2> +<h3>Novel methods</h3> +<dl> +<dt>Get_Offset</dt> +<dd> +<pre><code>int32_t +<strong>LUCY_Span_Get_Offset</strong>( + lucy_Span* <strong>self</strong> +); +</code></pre> +<p>Accessor for <code>offset</code> attribute.</p> +</dd> +<dt>Set_Offset</dt> +<dd> +<pre><code>void +<strong>LUCY_Span_Set_Offset</strong>( + lucy_Span* <strong>self</strong>, + int32_t <strong>offset</strong> +); +</code></pre> +<p>Setter for <code>offset</code> attribute.</p> +</dd> +<dt>Get_Length</dt> +<dd> +<pre><code>int32_t +<strong>LUCY_Span_Get_Length</strong>( + lucy_Span* <strong>self</strong> +); +</code></pre> +<p>Accessor for <code>length</code> attribute.</p> +</dd> +<dt>Set_Length</dt> +<dd> +<pre><code>void +<strong>LUCY_Span_Set_Length</strong>( + lucy_Span* <strong>self</strong>, + int32_t <strong>length</strong> +); +</code></pre> +<p>Setter for <code>length</code> attribute.</p> +</dd> +<dt>Get_Weight</dt> +<dd> +<pre><code>float +<strong>LUCY_Span_Get_Weight</strong>( + lucy_Span* <strong>self</strong> +); +</code></pre> +<p>Accessor for <code>weight</code> attribute.</p> +</dd> +<dt>Set_Weight</dt> +<dd> +<pre><code>void +<strong>LUCY_Span_Set_Weight</strong>( + lucy_Span* <strong>self</strong>, + float <strong>weight</strong> +); +</code></pre> +<p>Setter for <code>weight</code> attribute.</p> +</dd> +</dl> +<h2>Inheritance</h2> +<p>Lucy::Search::Span is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> +</body> +</html> Added: lucy/site/trunk/content/docs/c/lucy_StandardTokenizer.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_StandardTokenizer.html?rev=1641230&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_StandardTokenizer.html (added) +++ lucy/site/trunk/content/docs/c/lucy_StandardTokenizer.html Sun Nov 23 17:42:57 2014 @@ -0,0 +1,106 @@ +<!DOCTYPE html> +<html> +<head> +<meta name="viewport" content="width=device-width" /> +<style type="text/css"> +body { + font-family: sans-serif; + font-size: 0.85em; + max-width: 640px; +} +dt { + font-weight: bold; +} +pre { + border: 1px solid #000; + padding: 0.2em 0.4em; + background: #f6f6f6; + font-size: 1.2em; +} +code { + font-family: "Consolas", "Menlo", monospace; +} +</style> +</head> +<body> +<h1>Lucy::Analysis::StandardTokenizer</h1> +<h2>Name</h2> +<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 +tokenized into "three", "blind", "mice".</p> +<p>Lucy::Analysis::StandardTokenizer breaks up the text at the word +boundaries defined in Unicode Standard Annex #29. It then returns those +words that start with an alphabetic or numeric character.</p> +<h2>Functions</h2> +<dl> +<dt>init</dt> +<dd> +<pre><code>lucy_StandardTokenizer* +<strong>lucy_StandardTokenizer_init</strong>( + lucy_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> +<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> +); +</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> +<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> +); +</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 +provide an optimized implementation which minimizes string copies.</p> +</dd> +<dt>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> +); +</code></pre> +<p>Analyze text and return an array of token texts.</p> +</dd> +<dt>Dump</dt> +<dd> +<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented +<strong>LUCY_Analyzer_Dump</strong>( + lucy_Analyzer* <strong>self</strong> +); +</code></pre> +</dd> +<dt>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> +); +</code></pre> +</dd> +</dl> +<h2>Inheritance</h2> +<p>Lucy::Analysis::StandardTokenizer is a <a href="lucy_Analyzer.html">Lucy::Analysis::Analyzer</a> is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> +</body> +</html> Added: lucy/site/trunk/content/docs/c/lucy_StringType.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_StringType.html?rev=1641230&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_StringType.html (added) +++ lucy/site/trunk/content/docs/c/lucy_StringType.html Sun Nov 23 17:42:57 2014 @@ -0,0 +1,196 @@ +<!DOCTYPE html> +<html> +<head> +<meta name="viewport" content="width=device-width" /> +<style type="text/css"> +body { + font-family: sans-serif; + font-size: 0.85em; + max-width: 640px; +} +dt { + font-weight: bold; +} +pre { + border: 1px solid #000; + padding: 0.2em 0.4em; + background: #f6f6f6; + font-size: 1.2em; +} +code { + font-family: "Consolas", "Menlo", monospace; +} +</style> +</head> +<body> +<h1>Lucy::Plan::StringType</h1> +<h2>Name</h2> +<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> +<dd> +<pre><code>lucy_StringType* +<strong>lucy_StringType_init</strong>( + lucy_StringType* <strong>self</strong> +); +</code></pre> +<dl> +<dt><emph>boost</emph></dt> +<dd><p>floating point per-field boost.</p> +</dd> +<dt><emph>indexed</emph></dt> +<dd><p>boolean indicating whether the field should be indexed.</p> +</dd> +<dt><emph>stored</emph></dt> +<dd><p>boolean indicating whether the field should be stored.</p> +</dd> +<dt><emph>sortable</emph></dt> +<dd><p>boolean indicating whether the field should be +sortable.</p> +</dd> +</dl> +</dd> +<dt>new</dt> +<dd> +<pre><code>lucy_StringType* // incremented +<strong>lucy_StringType_new</strong>(void); +</code></pre> +</dd> +</dl> +<h2>Methods</h2> +<h3>Novel methods</h3> +<dl> +<dt>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> +); +</code></pre> +</dd> +</dl> +<h3>Methods inherited from Lucy::Plan::FieldType</h3><dl> +<dt>Set_Boost</dt> +<dd> +<pre><code>void +<strong>LUCY_FType_Set_Boost</strong>( + lucy_FieldType* <strong>self</strong>, + float <strong>boost</strong> +); +</code></pre> +<p>Setter for <code>boost</code>.</p> +</dd> +<dt>Get_Boost</dt> +<dd> +<pre><code>float +<strong>LUCY_FType_Get_Boost</strong>( + lucy_FieldType* <strong>self</strong> +); +</code></pre> +<p>Accessor for <code>boost</code>.</p> +</dd> +<dt>Set_Indexed</dt> +<dd> +<pre><code>void +<strong>LUCY_FType_Set_Indexed</strong>( + lucy_FieldType* <strong>self</strong>, + bool <strong>indexed</strong> +); +</code></pre> +<p>Setter for <code>indexed</code>.</p> +</dd> +<dt>Indexed</dt> +<dd> +<pre><code>bool +<strong>LUCY_FType_Indexed</strong>( + lucy_FieldType* <strong>self</strong> +); +</code></pre> +<p>Accessor for <code>indexed</code>.</p> +</dd> +<dt>Set_Stored</dt> +<dd> +<pre><code>void +<strong>LUCY_FType_Set_Stored</strong>( + lucy_FieldType* <strong>self</strong>, + bool <strong>stored</strong> +); +</code></pre> +<p>Setter for <code>stored</code>.</p> +</dd> +<dt>Stored</dt> +<dd> +<pre><code>bool +<strong>LUCY_FType_Stored</strong>( + lucy_FieldType* <strong>self</strong> +); +</code></pre> +<p>Accessor for <code>stored</code>.</p> +</dd> +<dt>Set_Sortable</dt> +<dd> +<pre><code>void +<strong>LUCY_FType_Set_Sortable</strong>( + lucy_FieldType* <strong>self</strong>, + bool <strong>sortable</strong> +); +</code></pre> +<p>Setter for <code>sortable</code>.</p> +</dd> +<dt>Sortable</dt> +<dd> +<pre><code>bool +<strong>LUCY_FType_Sortable</strong>( + lucy_FieldType* <strong>self</strong> +); +</code></pre> +<p>Accessor for <code>sortable</code>.</p> +</dd> +<dt>Binary</dt> +<dd> +<pre><code>bool +<strong>LUCY_FType_Binary</strong>( + lucy_FieldType* <strong>self</strong> +); +</code></pre> +<p>Indicate whether the field contains binary data.</p> +</dd> +<dt>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> +); +</code></pre> +<p>Compare two values for the field. The default implementation +dispatches to the Compare_To() 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> +<dd> +<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented +<strong>LUCY_FType_Dump</strong>( + lucy_FieldType* <strong>self</strong> +); +</code></pre> +</dd> +<dt>Load</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> +); +</code></pre> +</dd> +</dl> +<h2>Inheritance</h2> +<p>Lucy::Plan::StringType is a <a href="lucy_TextType.html">Lucy::Plan::TextType</a> is a <a href="lucy_FieldType.html">Lucy::Plan::FieldType</a> is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> +</body> +</html> Added: lucy/site/trunk/content/docs/c/lucy_TermQuery.html URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy_TermQuery.html?rev=1641230&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy_TermQuery.html (added) +++ lucy/site/trunk/content/docs/c/lucy_TermQuery.html Sun Nov 23 17:42:57 2014 @@ -0,0 +1,160 @@ +<!DOCTYPE html> +<html> +<head> +<meta name="viewport" content="width=device-width" /> +<style type="text/css"> +body { + font-family: sans-serif; + font-size: 0.85em; + max-width: 640px; +} +dt { + font-weight: bold; +} +pre { + border: 1px solid #000; + padding: 0.2em 0.4em; + background: #f6f6f6; + font-size: 1.2em; +} +code { + font-family: "Consolas", "Menlo", monospace; +} +</style> +</head> +<body> +<h1>Lucy::Search::TermQuery</h1> +<h2>Name</h2> +<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> +<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> +); +</code></pre> +<dl> +<dt><emph>field</emph></dt> +<dd><p>Field name.</p> +</dd> +<dt><emph>term</emph></dt> +<dd><p>Term text.</p> +</dd> +</dl> +</dd> +</dl> +<h2>Methods</h2> +<h3>Novel methods</h3> +<dl> +<dt>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> +); +</code></pre> +<p>Accessor for object's <code>field</code> member.</p> +</dd> +<dt>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> +); +</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> +<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>, + 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> +<dd><p>A Searcher.</p> +</dd> +<dt><emph>boost</emph></dt> +<dd><p>A scoring multiplier.</p> +</dd> +<dt><emph>subordinate</emph></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 +it.</p> +</dd> +</dl> +</dd> +<dt>Set_Boost</dt> +<dd> +<pre><code>void +<strong>LUCY_Query_Set_Boost</strong>( + lucy_Query* <strong>self</strong>, + float <strong>boost</strong> +); +</code></pre> +<p>Set the Query's boost.</p> +</dd> +<dt>Get_Boost</dt> +<dd> +<pre><code>float +<strong>LUCY_Query_Get_Boost</strong>( + lucy_Query* <strong>self</strong> +); +</code></pre> +<p>Get the Query's boost.</p> +</dd> +<dt>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> +); +</code></pre> +</dd> +<dt>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> +); +</code></pre> +</dd> +<dt>Dump</dt> +<dd> +<pre><code><a href="cfish_Obj.html">cfish_Obj*</a> // incremented +<strong>LUCY_Query_Dump</strong>( + lucy_Query* <strong>self</strong> +); +</code></pre> +</dd> +<dt>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> +); +</code></pre> +</dd> +</dl> +<h2>Inheritance</h2> +<p>Lucy::Search::TermQuery is a <a href="lucy_Query.html">Lucy::Search::Query</a> is a <a href="cfish_Obj.html">Clownfish::Obj</a>.</p> +</body> +</html>
