Added: incubator/lucene4c/trunk/www/apidocs/lcn__query__parser_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__query__parser_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__query__parser_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__query__parser_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,42 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_query_parser.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_query_parser.h File Reference</h1>Routines for creating queries from a user provided string. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__query_8h-source.html">lcn_query.h</a>"</code><br> + +<p> +<a href="lcn__query__parser_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_query_parser.h::lcn_query_parser_t"></a> +typedef <a class="el" href="lcn__query__parser_8h.html#a0">lcn_query_parser_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__query__parser_8h.html#a0">lcn_query_parser_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">A query parser. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_query_parser.h::lcn_query_parser_create"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__query__parser_8h.html#a1">lcn_query_parser_create</a> (<a class="el" href="lcn__query__parser_8h.html#a0">lcn_query_parser_t</a> **parser, <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *default_field, <a class="el" href="lcn__query_8h.html#a11">lcn_boolean_clause_occur_t</a> default_occur, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a query parser <em>parser</em>, which uses <em>default_field</em> and <em>default_occur</em> and is allocated from <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_query_parser.h::lcn_query_parser_parse"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__query__parser_8h.html#a2">lcn_query_parser_parse</a> (<a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> **query, <a class="el" href="lcn__query__parser_8h.html#a0">lcn_query_parser_t</a> *parser, <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *input, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Use <em>parser</em> to create <em>query</em> from <em>input</em>, allocated in <em>pool</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for creating queries from a user provided string. +<p> + +<p> +Definition in file <a class="el" href="lcn__query__parser_8h-source.html">lcn_query_parser.h</a>.<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html>
Added: incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,96 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_scorer.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_scorer.h</h1><a href="lcn__scorer_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_scorer.h</span> +00019 <span class="comment"> * @brief Routines for working with scorers</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_SCORER_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_SCORER_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 <span class="preprocessor">#include "<a class="code" href="lcn__index_8h.html">lcn_index.h</a>"</span> +00027 +00028 <span class="preprocessor">#ifdef __cplusplus</span> +00029 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00030 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00031 <span class="comment"></span> +00032 <span class="comment">/** The structure that stores data about a query that must be modified</span> +00033 <span class="comment"> * during a search. This allows a given query to be reused for more than</span> +00034 <span class="comment"> * one search.</span> +00035 <span class="comment"> *</span> +00036 <span class="comment"> * This is declared here rather than in lcn_query.h to avoid circular</span> +00037 <span class="comment"> * dependencies.</span> +00038 <span class="comment"> */</span> +<a name="l00039"></a><a class="code" href="lcn__scorer_8h.html#a0">00039</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> <a class="code" href="lcn__scorer_8h.html#a0">lcn_weight_t</a>; +00040 <span class="comment"></span> +00041 <span class="comment">/** Abstract scorer object. */</span> +<a name="l00042"></a><a class="code" href="lcn__scorer_8h.html#a1">00042</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> <a class="code" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a>; +00043 <span class="comment"></span> +00044 <span class="comment">/** Create a @a scorer that returns scores for each document matched</span> +00045 <span class="comment"> * by @a weight in @a iter, allocated in @a pool.</span> +00046 <span class="comment"> */</span> +00047 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00048 <a class="code" href="lcn__scorer_8h.html#a2">lcn_term_scorer_create</a> (lcn_scorer_t **scorer, +00049 lcn_weight_t *weight, +00050 lcn_doc_iter_t *iter, +00051 apr_pool_t *pool); +00052 <span class="comment"></span> +00053 <span class="comment">/** Create a @a scorer that returns scores for documents matched by the</span> +00054 <span class="comment"> * arrays of queries @a must, @a should, and @a must_not, searching in</span> +00055 <span class="comment"> * @a index, allocated in @a pool.</span> +00056 <span class="comment"> */</span> +00057 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00058 <a class="code" href="lcn__scorer_8h.html#a3">lcn_boolean_scorer_create</a> (lcn_scorer_t **scorer, +00059 apr_array_header_t *must, +00060 apr_array_header_t *should, +00061 apr_array_header_t *must_not, +00062 lcn_index_t *index, +00063 apr_pool_t *pool); +00064 <span class="comment"></span> +00065 <span class="comment">/** Advance @a scorer to the next document.</span> +00066 <span class="comment"> *</span> +00067 <span class="comment"> * If there is another document in the sequence @a next is set to TRUE,</span> +00068 <span class="comment"> * otherwise @a next is set to FALSE.</span> +00069 <span class="comment"> */</span> +00070 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * <a class="code" href="lcn__scorer_8h.html#a4">lcn_scorer_next</a> (lcn_boolean_t *next, lcn_scorer_t *scorer); +00071 <span class="comment"></span> +00072 <span class="comment">/** Return the current document for @a scorer. */</span> +00073 apr_uint32_t <a class="code" href="lcn__scorer_8h.html#a5">lcn_scorer_doc</a> (lcn_scorer_t *scorer); +00074 <span class="comment"></span> +00075 <span class="comment">/** Return the score for the current document for @a scorer. */</span> +00076 <span class="keywordtype">float</span> <a class="code" href="lcn__scorer_8h.html#a6">lcn_scorer_score</a> (lcn_scorer_t *scorer); +00077 +00078 <span class="preprocessor">#ifdef __cplusplus</span> +00079 <span class="preprocessor"></span>} +00080 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00081 +00082 <span class="preprocessor">#endif </span><span class="comment">/* _LCN_SCORER_H */</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__scorer_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,125 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_scorer.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_scorer.h File Reference</h1>Routines for working with scorers. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__index_8h-source.html">lcn_index.h</a>"</code><br> + +<p> +<a href="lcn__scorer_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">The structure that stores data about a query that must be modified during a search. <a href="#a0"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_scorer.h::lcn_scorer_t"></a> +typedef <a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract scorer object. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_scorer.h::lcn_term_scorer_create"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__scorer_8h.html#a2">lcn_term_scorer_create</a> (<a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> **scorer, <a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> *weight, <a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> *iter, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <em>scorer</em> that returns scores for each document matched by <em>weight</em> in <em>iter</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_scorer.h::lcn_boolean_scorer_create"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__scorer_8h.html#a3">lcn_boolean_scorer_create</a> (<a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> **scorer, apr_array_header_t *must, apr_array_header_t *should, apr_array_header_t *must_not, <a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a> *index, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <em>scorer</em> that returns scores for documents matched by the arrays of queries <em>must</em>, <em>should</em>, and <em>must_not</em>, searching in <em>index</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__scorer_8h.html#a4">lcn_scorer_next</a> (<a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a> *next, <a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> *scorer)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Advance <em>scorer</em> to the next document. <a href="#a4"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_scorer.h::lcn_scorer_doc"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__scorer_8h.html#a5">lcn_scorer_doc</a> (<a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> *scorer)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current document for <em>scorer</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_scorer.h::lcn_scorer_score"></a> +float </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__scorer_8h.html#a6">lcn_scorer_score</a> (<a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> *scorer)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the score for the current document for <em>scorer</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for working with scorers. +<p> + +<p> +Definition in file <a class="el" href="lcn__scorer_8h-source.html">lcn_scorer.h</a>.<hr><h2>Typedef Documentation</h2> +<a class="anchor" name="a0" doxytag="lcn_scorer.h::lcn_weight_t"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">typedef struct <a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> <a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +The structure that stores data about a query that must be modified during a search. +<p> +This allows a given query to be reused for more than one search.<p> +This is declared here rather than in <a class="el" href="lcn__query_8h.html">lcn_query.h</a> to avoid circular dependencies. +<p> +Definition at line <a class="el" href="lcn__scorer_8h-source.html#l00039">39</a> of file <a class="el" href="lcn__scorer_8h-source.html">lcn_scorer.h</a>. </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a4" doxytag="lcn_scorer.h::lcn_scorer_next"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top"><a class="el" href="structlcn__error__t.html">lcn_error_t</a>* lcn_scorer_next </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a> * </td> + <td class="mdname" nowrap> <em>next</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__scorer_8h.html#a1">lcn_scorer_t</a> * </td> + <td class="mdname" nowrap> <em>scorer</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Advance <em>scorer</em> to the next document. +<p> +If there is another document in the sequence <em>next</em> is set to TRUE, otherwise <em>next</em> is set to FALSE. </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,100 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_segment.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_segment.h</h1><a href="lcn__segment_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_segment.h</span> +00019 <span class="comment"> * @brief Routines for manipulating a segment of a lucene index</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_SEGMENT_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_SEGMENT_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#ifdef __cplusplus</span> +00026 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00027 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00028 +00029 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00030 <span class="preprocessor">#include "<a class="code" href="lcn__directory_8h.html">lcn_directory.h</a>"</span> +00031 <span class="preprocessor">#include "<a class="code" href="lcn__term_8h.html">lcn_term.h</a>"</span> +00032 <span class="preprocessor">#include "<a class="code" href="lcn__document_8h.html">lcn_document.h</a>"</span> +00033 <span class="comment"></span> +00034 <span class="comment">/** An opaque structure representing a segment of a lucene index. */</span> +<a name="l00035"></a><a class="code" href="lcn__segment_8h.html#a0">00035</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__segment_8h.html#a0">lcn_segment_t</a> <a class="code" href="lcn__segment_8h.html#a0">lcn_segment_t</a>; +00036 <span class="comment"></span> +00037 <span class="comment">/** Open the segment @a segname, of size @a size containing documents</span> +00038 <span class="comment"> * starting at @a offset, within directory @a d and return it in @a segment,</span> +00039 <span class="comment"> * allocated from @a pool.</span> +00040 <span class="comment"> */</span> +00041 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00042 <a class="code" href="lcn__segment_8h.html#a1">lcn_segment_open</a> (lcn_segment_t **segment, +00043 <span class="keyword">const</span> lcn_char_t *segname, +00044 apr_uint32_t size, +00045 apr_uint32_t offset, +00046 <span class="keyword">const</span> lcn_directory_t *d, +00047 apr_pool_t *pool); +00048 <span class="comment"></span> +00049 <span class="comment">/** Return the name of @a segment. */</span> +00050 <span class="keyword">const</span> <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> * +00051 <a class="code" href="lcn__segment_8h.html#a2">lcn_segment_name</a> (<span class="keyword">const</span> lcn_segment_t *segment); +00052 <span class="comment"></span> +00053 <span class="comment">/** Return the size (in documents) of @a segment. */</span> +00054 apr_uint32_t +00055 <a class="code" href="lcn__segment_8h.html#a3">lcn_segment_size</a> (<span class="keyword">const</span> lcn_segment_t *segment); +00056 <span class="comment"></span> +00057 <span class="comment">/** Return the directory @a segment is in. */</span> +00058 <span class="keyword">const</span> <a class="code" href="lcn__directory_8h.html#a0">lcn_directory_t</a> * +00059 <a class="code" href="lcn__segment_8h.html#a4">lcn_segment_directory</a> (<span class="keyword">const</span> lcn_segment_t *segment); +00060 <span class="comment"></span> +00061 <span class="comment">/** Return the document frquency @a doc_freq, document numbers @a docs, and</span> +00062 <span class="comment"> * the frequencies @a freqs of the documents within @a segment that contain</span> +00063 <span class="comment"> * @a term, using @a pool for allocation.</span> +00064 <span class="comment"> */</span> +00065 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00066 <a class="code" href="lcn__segment_8h.html#a5">lcn_segment_term_docs</a> (apr_uint32_t *doc_freq, +00067 apr_uint32_t **docs, +00068 apr_uint32_t **freqs, +00069 lcn_segment_t *segment, +00070 <span class="keyword">const</span> <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *term, +00071 apr_pool_t *pool); +00072 <span class="comment"></span> +00073 <span class="comment">/** Return the document @a doc from @a segment that has the number @a docnum,</span> +00074 <span class="comment"> * allocated within @a pool.</span> +00075 <span class="comment"> */</span> +00076 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00077 <a class="code" href="lcn__segment_8h.html#a6">lcn_segment_get_document</a> (lcn_document_t **doc, +00078 lcn_segment_t *segment, +00079 apr_uint32_t docnum, +00080 apr_pool_t *pool); +00081 +00082 <span class="preprocessor">#ifdef __cplusplus</span> +00083 <span class="preprocessor"></span>} +00084 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00085 +00086 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__segment_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,60 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_segment.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_segment.h File Reference</h1>Routines for manipulating a segment of a lucene index. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__term_8h-source.html">lcn_term.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__document_8h-source.html">lcn_document.h</a>"</code><br> + +<p> +<a href="lcn__segment_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_segment.h::lcn_segment_t"></a> +typedef <a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">An opaque structure representing a segment of a lucene index. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_segment.h::lcn_segment_open"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segment_8h.html#a1">lcn_segment_open</a> (<a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a> **segment, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *segname, apr_uint32_t size, apr_uint32_t offset, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open the segment <em>segname</em>, of size <em>size</em> containing documents starting at <em>offset</em>, within directory <em>d</em> and return it in <em>segment</em>, allocated from <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_segment.h::lcn_segment_name"></a> +const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segment_8h.html#a2">lcn_segment_name</a> (const <a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a> *segment)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of <em>segment</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_segment.h::lcn_segment_size"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segment_8h.html#a3">lcn_segment_size</a> (const <a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a> *segment)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size (in documents) of <em>segment</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_segment.h::lcn_segment_directory"></a> +const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segment_8h.html#a4">lcn_segment_directory</a> (const <a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a> *segment)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the directory <em>segment</em> is in. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_segment.h::lcn_segment_term_docs"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segment_8h.html#a5">lcn_segment_term_docs</a> (apr_uint32_t *doc_freq, apr_uint32_t **docs, apr_uint32_t **freqs, <a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a> *segment, const <a class="el" href="structlcn__term__t.html">lcn_term_t</a> *term, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the document frquency <em>doc_freq</em>, document numbers <em>docs</em>, and the frequencies <em>freqs</em> of the documents within <em>segment</em> that contain <em>term</em>, using <em>pool</em> for allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_segment.h::lcn_segment_get_document"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segment_8h.html#a6">lcn_segment_get_document</a> (<a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> **doc, <a class="el" href="lcn__segment_8h.html#a0">lcn_segment_t</a> *segment, apr_uint32_t docnum, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the document <em>doc</em> from <em>segment</em> that has the number <em>docnum</em>, allocated within <em>pool</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for manipulating a segment of a lucene index. +<p> + +<p> +Definition in file <a class="el" href="lcn__segment_8h-source.html">lcn_segment.h</a>.<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,112 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_segments.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_segments.h</h1><a href="lcn__segments_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_segments.h</span> +00019 <span class="comment"> * @brief Routines for reading the segments contained within a lucen index</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_SEGMENTS_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_SEGMENTS_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 <span class="preprocessor">#include "<a class="code" href="lcn__directory_8h.html">lcn_directory.h</a>"</span> +00027 <span class="preprocessor">#include "<a class="code" href="lcn__term_8h.html">lcn_term.h</a>"</span> +00028 <span class="preprocessor">#include "<a class="code" href="lcn__document_8h.html">lcn_document.h</a>"</span> +00029 +00030 <span class="preprocessor">#include <apr_pools.h></span> +00031 <span class="preprocessor">#include <apr_tables.h></span> +00032 +00033 <span class="preprocessor">#ifdef __cplusplus</span> +00034 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00035 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00036 <span class="comment"></span> +00037 <span class="comment">/** Opaque structure representing the segments within an index. */</span> +<a name="l00038"></a><a class="code" href="lcn__segments_8h.html#a0">00038</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__segments_8h.html#a0">lcn_segments_t</a> <a class="code" href="lcn__segments_8h.html#a0">lcn_segments_t</a>; +00039 <span class="comment"></span> +00040 <span class="comment">/** Read in the segments file contained in @a directory and return it in</span> +00041 <span class="comment"> * @a segments, allocated within @a pool.</span> +00042 <span class="comment"> */</span> +00043 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00044 <a class="code" href="lcn__segments_8h.html#a1">lcn_segments_read</a> (lcn_segments_t **segments, +00045 <span class="keyword">const</span> lcn_directory_t *directory, +00046 apr_pool_t *pool); +00047 <span class="comment"></span> +00048 <span class="comment">/** Return the version of @a segments.</span> +00049 <span class="comment"> *</span> +00050 <span class="comment"> * This can be used to detect if the segment has been modified.</span> +00051 <span class="comment"> */</span> +00052 apr_uint64_t <a class="code" href="lcn__segments_8h.html#a2">lcn_segments_version</a> (<span class="keyword">const</span> lcn_segments_t *segments); +00053 <span class="comment"></span> +00054 <span class="comment">/** Return the number of segments within @a segments. */</span> +00055 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> <a class="code" href="lcn__segments_8h.html#a3">lcn_segments_count</a> (<span class="keyword">const</span> lcn_segments_t *segments); +00056 <span class="comment"></span> +00057 <span class="comment">/** Return the size (in documents) of segment @a name within @a segments. */</span> +00058 apr_uint32_t <a class="code" href="lcn__segments_8h.html#a4">lcn_segments_segsize</a> (<span class="keyword">const</span> lcn_segments_t *segments, +00059 <span class="keyword">const</span> lcn_char_t *name); +00060 <span class="comment"></span> +00061 <span class="comment">/** Return the names of the segments within @a segments, allocated in @a pool.</span> +00062 <span class="comment"> *</span> +00063 <span class="comment"> * The array holds @c lcn_char_t pointers.</span> +00064 <span class="comment"> */</span> +00065 apr_array_header_t * +00066 <a class="code" href="lcn__segments_8h.html#a5">lcn_segments_names</a> (<span class="keyword">const</span> lcn_segments_t *segments, apr_pool_t *pool); +00067 <span class="comment"></span> +00068 <span class="comment">/** Return the max docs contained within @a segments. */</span> +00069 apr_uint32_t +00070 <a class="code" href="lcn__segments_8h.html#a6">lcn_segments_max_docs</a> (<span class="keyword">const</span> lcn_segments_t *segments); +00071 <span class="comment"></span> +00072 <span class="comment">/** Return the document freqency @a doc_freq, document numbers @a docs, and</span> +00073 <span class="comment"> * frequencies @a freqs of the documents containing @a term in segment number</span> +00074 <span class="comment"> * @a segnum within @a segments, using @a pool for allocation.</span> +00075 <span class="comment"> */</span> +00076 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00077 <a class="code" href="lcn__segments_8h.html#a7">lcn_segments_term_docs</a> (apr_uint32_t *doc_freq, +00078 apr_uint32_t **docs, +00079 apr_uint32_t **freqs, +00080 lcn_segments_t *segments, +00081 apr_uint32_t segnum, +00082 <span class="keyword">const</span> <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *term, +00083 apr_pool_t *pool); +00084 <span class="comment"></span> +00085 <span class="comment">/** Return the document @a docnum from @a segs in @a doc, using @a pool for</span> +00086 <span class="comment"> * allocation.</span> +00087 <span class="comment"> */</span> +00088 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00089 <a class="code" href="lcn__segments_8h.html#a8">lcn_segments_get_document</a> (lcn_document_t **doc, +00090 lcn_segments_t *segs, +00091 apr_uint32_t docnum, +00092 apr_pool_t *pool); +00093 +00094 <span class="preprocessor">#ifdef __cplusplus</span> +00095 <span class="preprocessor"></span>} +00096 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00097 +00098 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__segments_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,138 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_segments.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_segments.h File Reference</h1>Routines for reading the segments contained within a lucen index. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__term_8h-source.html">lcn_term.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__document_8h-source.html">lcn_document.h</a>"</code><br> +<code>#include <apr_pools.h></code><br> +<code>#include <apr_tables.h></code><br> + +<p> +<a href="lcn__segments_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_segments.h::lcn_segments_t"></a> +typedef <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing the segments within an index. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_segments.h::lcn_segments_read"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a1">lcn_segments_read</a> (<a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> **segments, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *directory, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read in the segments file contained in <em>directory</em> and return it in <em>segments</em>, allocated within <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a2">lcn_segments_version</a> (const <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> *segments)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the version of <em>segments</em>. <a href="#a2"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_segments.h::lcn_segments_count"></a> +unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a3">lcn_segments_count</a> (const <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> *segments)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of segments within <em>segments</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_segments.h::lcn_segments_segsize"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a4">lcn_segments_segsize</a> (const <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> *segments, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *name)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the size (in documents) of segment <em>name</em> within <em>segments</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">apr_array_header_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a5">lcn_segments_names</a> (const <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> *segments, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the names of the segments within <em>segments</em>, allocated in <em>pool</em>. <a href="#a5"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_segments.h::lcn_segments_max_docs"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a6">lcn_segments_max_docs</a> (const <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> *segments)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the max docs contained within <em>segments</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="lcn_segments.h::lcn_segments_term_docs"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a7">lcn_segments_term_docs</a> (apr_uint32_t *doc_freq, apr_uint32_t **docs, apr_uint32_t **freqs, <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> *segments, apr_uint32_t segnum, const <a class="el" href="structlcn__term__t.html">lcn_term_t</a> *term, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the document freqency <em>doc_freq</em>, document numbers <em>docs</em>, and frequencies <em>freqs</em> of the documents containing <em>term</em> in segment number <em>segnum</em> within <em>segments</em>, using <em>pool</em> for allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="lcn_segments.h::lcn_segments_get_document"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__segments_8h.html#a8">lcn_segments_get_document</a> (<a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> **doc, <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> *segs, apr_uint32_t docnum, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the document <em>docnum</em> from <em>segs</em> in <em>doc</em>, using <em>pool</em> for allocation. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for reading the segments contained within a lucen index. +<p> + +<p> +Definition in file <a class="el" href="lcn__segments_8h-source.html">lcn_segments.h</a>.<hr><h2>Function Documentation</h2> +<a class="anchor" name="a5" doxytag="lcn_segments.h::lcn_segments_names"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">apr_array_header_t* lcn_segments_names </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> * </td> + <td class="mdname" nowrap> <em>segments</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap>apr_pool_t * </td> + <td class="mdname" nowrap> <em>pool</em></td> + </tr> + <tr> + <td class="md"></td> + <td class="md">) </td> + <td class="md" colspan="2"></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Return the names of the segments within <em>segments</em>, allocated in <em>pool</em>. +<p> +The array holds <code>lcn_char_t</code> pointers. </td> + </tr> +</table> +<a class="anchor" name="a2" doxytag="lcn_segments.h::lcn_segments_version"></a><p> +<table class="mdTable" cellpadding="2" cellspacing="0"> + <tr> + <td class="mdRow"> + <table cellpadding="0" cellspacing="0" border="0"> + <tr> + <td class="md" nowrap valign="top">apr_uint64_t lcn_segments_version </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top">const <a class="el" href="lcn__segments_8h.html#a0">lcn_segments_t</a> * </td> + <td class="mdname1" valign="top" nowrap> <em>segments</em> </td> + <td class="md" valign="top"> ) </td> + <td class="md" nowrap></td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +Return the version of <em>segments</em>. +<p> +This can be used to detect if the segment has been modified. </td> + </tr> +</table> +<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__term_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__term_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__term_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__term_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_term.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_term.h</h1><a href="lcn__term_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_term.h</span> +00019 <span class="comment"> * @brief Routines for handling lucene terms</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_TERM_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_TERM_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 +00027 <span class="preprocessor">#ifdef __cplusplus</span> +00028 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00029 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00030 <span class="comment"></span> +00031 <span class="comment">/** A lucene term. */</span> +<a name="l00032"></a><a class="code" href="structlcn__term__t.html">00032</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{ +<a name="l00033"></a><a class="code" href="structlcn__term__t.html#o0">00033</a> <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> *contents; <span class="comment">/**< The actual contents of the term */</span> +<a name="l00034"></a><a class="code" href="structlcn__term__t.html#o1">00034</a> <a class="code" href="lcn__types_8h.html#a10">lcn_char_t</a> *field; <span class="comment">/**< The field the term is found in */</span> +00035 } <a class="code" href="structlcn__term__t.html">lcn_term_t</a>; +00036 <span class="comment"></span> +00037 <span class="comment">/** Create a new term with contents @a contents and field @a field, allocated</span> +00038 <span class="comment"> * in @a pool.</span> +00039 <span class="comment"> */</span> +00040 <a class="code" href="structlcn__term__t.html">lcn_term_t</a> * +00041 <a class="code" href="lcn__term_8h.html#a0">lcn_term_create</a> (<span class="keyword">const</span> lcn_char_t *contents, +00042 <span class="keyword">const</span> lcn_char_t *field, +00043 apr_pool_t *pool); +00044 <span class="comment"></span> +00045 <span class="comment">/** Like @c lcn_term_create, but with cstring arguments. */</span> +00046 <a class="code" href="structlcn__term__t.html">lcn_term_t</a> * +00047 <a class="code" href="lcn__term_8h.html#a1">lcn_term_create_cstring</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *contents, +00048 <span class="keyword">const</span> <span class="keywordtype">char</span> *field, +00049 apr_pool_t *pool); +00050 <span class="comment"></span> +00051 <span class="comment">/** Compare terms @a one and @a two, returning an integer less than, equal to,</span> +00052 <span class="comment"> * or greater than if @a one is less than, equal to, or greater than @a two.</span> +00053 <span class="comment"> */</span> +00054 <span class="keywordtype">int</span> <a class="code" href="lcn__term_8h.html#a2">lcn_term_compare</a> (<span class="keyword">const</span> <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *one, <span class="keyword">const</span> <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *two); +00055 +00056 <span class="preprocessor">#ifdef __cplusplus</span> +00057 <span class="preprocessor"></span>} +00058 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00059 +00060 <span class="preprocessor">#endif </span><span class="comment">/* _LCN_TERM_H */</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__term_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__term_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__term_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__term_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,40 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_term.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_term.h File Reference</h1>Routines for handling lucene terms. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> + +<p> +<a href="lcn__term_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_term.h::lcn_term_create"></a> +<a class="el" href="structlcn__term__t.html">lcn_term_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__term_8h.html#a0">lcn_term_create</a> (const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *contents, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *field, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a new term with contents <em>contents</em> and field <em>field</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_term.h::lcn_term_create_cstring"></a> +<a class="el" href="structlcn__term__t.html">lcn_term_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__term_8h.html#a1">lcn_term_create_cstring</a> (const char *contents, const char *field, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Like <code>lcn_term_create</code>, but with cstring arguments. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_term.h::lcn_term_compare"></a> +int </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__term_8h.html#a2">lcn_term_compare</a> (const <a class="el" href="structlcn__term__t.html">lcn_term_t</a> *one, const <a class="el" href="structlcn__term__t.html">lcn_term_t</a> *two)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Compare terms <em>one</em> and <em>two</em>, returning an integer less than, equal to, or greater than if <em>one</em> is less than, equal to, or greater than <em>two</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for handling lucene terms. +<p> + +<p> +Definition in file <a class="el" href="lcn__term_8h-source.html">lcn_term.h</a>.<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,122 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_terminfos.h Source File</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_terminfos.h</h1><a href="lcn__terminfos_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/* Copyright 2005 The Apache Software Foundation or its licensors, as</span> +00002 <span class="comment"> * applicable.</span> +00003 <span class="comment"> *</span> +00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> +00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> +00006 <span class="comment"> * You may obtain a copy of the License at</span> +00007 <span class="comment"> *</span> +00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> +00009 <span class="comment"> *</span> +00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> +00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> +00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> +00013 <span class="comment"> * See the License for the specific language governing permissions and</span> +00014 <span class="comment"> * limitations under the License.</span> +00015 <span class="comment"> */</span> +00016 <span class="comment"></span> +00017 <span class="comment">/**</span> +00018 <span class="comment"> * @file lcn_terminfos.h</span> +00019 <span class="comment"> * @brief Routines for manipulating the terminfos file from a lucene segment</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_TERMINFOS_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_TERMINFOS_H</span> +00024 <span class="preprocessor"></span> +00025 <span class="preprocessor">#include "<a class="code" href="lcn__types_8h.html">lcn_types.h</a>"</span> +00026 <span class="preprocessor">#include "<a class="code" href="lcn__directory_8h.html">lcn_directory.h</a>"</span> +00027 <span class="preprocessor">#include "<a class="code" href="lcn__term_8h.html">lcn_term.h</a>"</span> +00028 +00029 <span class="preprocessor">#include <apr_hash.h></span> +00030 <span class="preprocessor">#include <apr_file_io.h></span> +00031 +00032 <span class="preprocessor">#ifdef __cplusplus</span> +00033 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00034 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00035 <span class="comment"></span> +00036 <span class="comment">/** Opaque structure representing the information about a particular term. */</span> +<a name="l00037"></a><a class="code" href="lcn__terminfos_8h.html#a0">00037</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> <a class="code" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a>; +00038 <span class="comment"></span> +00039 <span class="comment">/** Opaque structure representing the contents of the terminfos index. */</span> +<a name="l00040"></a><a class="code" href="lcn__terminfos_8h.html#a1">00040</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__terminfos_8h.html#a1">lcn_terminfos_idx_t</a> <a class="code" href="lcn__terminfos_8h.html#a1">lcn_terminfos_idx_t</a>; +00041 <span class="comment"></span> +00042 <span class="comment">/** Opaque structure representing a segments terminfos file. */</span> +<a name="l00043"></a><a class="code" href="lcn__terminfos_8h.html#a2">00043</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__terminfos_8h.html#a2">lcn_terminfos_t</a> <a class="code" href="lcn__terminfos_8h.html#a2">lcn_terminfos_t</a>; +00044 <span class="comment"></span> +00045 <span class="comment">/** Return the term @a ti corresponds to. */</span> +00046 <span class="keyword">const</span> <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *<a class="code" href="lcn__terminfos_8h.html#a3">lcn_terminfo_term</a> (<span class="keyword">const</span> lcn_terminfo_t *ti); +00047 <span class="comment"></span> +00048 <span class="comment">/** Return the field number @a ti corresponds to. */</span> +00049 apr_uint32_t <a class="code" href="lcn__terminfos_8h.html#a4">lcn_terminfo_field_num</a> (<span class="keyword">const</span> lcn_terminfo_t *ti); +00050 <span class="comment"></span> +00051 <span class="comment">/** Return the document frequency for terminfo @a ti. */</span> +00052 apr_uint32_t <a class="code" href="lcn__terminfos_8h.html#a5">lcn_terminfo_doc_freq</a> (<span class="keyword">const</span> lcn_terminfo_t *ti); +00053 <span class="comment"></span> +00054 <span class="comment">/** Return the proximity position for terminfo @a ti. */</span> +00055 apr_uint64_t <a class="code" href="lcn__terminfos_8h.html#a6">lcn_terminfo_prox_position</a> (<span class="keyword">const</span> lcn_terminfo_t *ti); +00056 <span class="comment"></span> +00057 <span class="comment">/** Return the frequency position for terminfo @a ti. */</span> +00058 apr_uint64_t <a class="code" href="lcn__terminfos_8h.html#a7">lcn_terminfo_freq_position</a> (<span class="keyword">const</span> lcn_terminfo_t *ti); +00059 <span class="comment"></span> +00060 <span class="comment">/** Return the skip offset for terminfo @a ti. */</span> +00061 apr_uint32_t <a class="code" href="lcn__terminfos_8h.html#a8">lcn_terminfo_skip_offset</a> (<span class="keyword">const</span> lcn_terminfo_t *ti); +00062 <span class="comment"></span> +00063 <span class="comment">/** Return a copy of terminfo @a ti, allocated in @a pool. */</span> +00064 <a class="code" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> * +00065 <a class="code" href="lcn__terminfos_8h.html#a9">lcn_terminfo_copy</a> (<span class="keyword">const</span> lcn_terminfo_t *ti, apr_pool_t *pool); +00066 <span class="comment"></span> +00067 <span class="comment">/** Read the terminfos index for @a segment in directory @a directory and</span> +00068 <span class="comment"> * return it in @a tisidx, allocated in @a pool.</span> +00069 <span class="comment"> */</span> +00070 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00071 <a class="code" href="lcn__terminfos_8h.html#a10">lcn_terminfos_idx_read</a> (lcn_terminfos_idx_t **tisidx, +00072 <span class="keyword">const</span> lcn_directory_t *directory, +00073 <span class="keyword">const</span> lcn_char_t *segment, +00074 apr_pool_t *pool); +00075 <span class="comment"></span> +00076 <span class="comment">/** Return the count of the terminfos in @a tisidx. */</span> +00077 apr_uint64_t +00078 <a class="code" href="lcn__terminfos_8h.html#a11">lcn_terminfos_idx_get_count</a> (<span class="keyword">const</span> lcn_terminfos_idx_t *tisidx); +00079 <span class="comment"></span> +00080 <span class="comment">/** Return the terminfo @a ti at @a position in @a tisidx. */</span> +00081 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00082 <a class="code" href="lcn__terminfos_8h.html#a12">lcn_terminfos_idx_get_terminfo</a> (lcn_terminfo_t **ti, +00083 <span class="keyword">const</span> lcn_terminfos_idx_t *tisidx, +00084 apr_uint64_t position); +00085 <span class="comment"></span> +00086 <span class="comment">/** Open the terminfos file for @a segment in @a directory, return it in</span> +00087 <span class="comment"> * @a tis, allocated in @a pool.</span> +00088 <span class="comment"> */</span> +00089 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00090 <a class="code" href="lcn__terminfos_8h.html#a13">lcn_terminfos_open</a> (lcn_terminfos_t **tis, +00091 <span class="keyword">const</span> lcn_directory_t *directory, +00092 <span class="keyword">const</span> lcn_char_t *segment, +00093 apr_pool_t *pool); +00094 <span class="comment"></span> +00095 <span class="comment">/** Return the terminfo @a ti from @a tis that corresponds to @a term, </span> +00096 <span class="comment"> * allocated in @a pool.</span> +00097 <span class="comment"> */</span> +00098 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00099 <a class="code" href="lcn__terminfos_8h.html#a14">lcn_terminfos_get_terminfo</a> (lcn_terminfo_t **ti, +00100 <span class="keyword">const</span> lcn_terminfos_t *tis, +00101 <span class="keyword">const</span> <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *term, +00102 apr_pool_t *pool); +00103 +00104 <span class="preprocessor">#ifdef __cplusplus</span> +00105 <span class="preprocessor"></span>} +00106 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00107 +00108 <span class="preprocessor">#endif</span> +</pre></div><hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html> Added: incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__terminfos_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,93 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Lucene4c: lcn_terminfos.h File Reference</title> +<link href="doxygen.css" rel="stylesheet" type="text/css"> +</head><body> +<!-- Generated by Doxygen 1.4.0 --> +<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a></div> +<div class="nav"> +<a class="el" href="dir_000000.html">include</a></div> +<h1>lcn_terminfos.h File Reference</h1>Routines for manipulating the terminfos file from a lucene segment. <a href="#_details">More...</a> +<p> +<code>#include "<a class="el" href="lcn__types_8h-source.html">lcn_types.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__term_8h-source.html">lcn_term.h</a>"</code><br> +<code>#include <apr_hash.h></code><br> +<code>#include <apr_file_io.h></code><br> + +<p> +<a href="lcn__terminfos_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0"> +<tr><td></td></tr> +<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a0" doxytag="lcn_terminfos.h::lcn_terminfo_t"></a> +typedef <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing the information about a particular term. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_terminfos.h::lcn_terminfos_idx_t"></a> +typedef <a class="el" href="lcn__terminfos_8h.html#a1">lcn_terminfos_idx_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a1">lcn_terminfos_idx_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing the contents of the terminfos index. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_terminfos.h::lcn_terminfos_t"></a> +typedef <a class="el" href="lcn__terminfos_8h.html#a2">lcn_terminfos_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a2">lcn_terminfos_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing a segments terminfos file. <br></td></tr> +<tr><td colspan="2"><br><h2>Functions</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_terminfos.h::lcn_terminfo_term"></a> +const <a class="el" href="structlcn__term__t.html">lcn_term_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a3">lcn_terminfo_term</a> (const <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> *ti)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the term <em>ti</em> corresponds to. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_terminfos.h::lcn_terminfo_field_num"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a4">lcn_terminfo_field_num</a> (const <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> *ti)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the field number <em>ti</em> corresponds to. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_terminfos.h::lcn_terminfo_doc_freq"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a5">lcn_terminfo_doc_freq</a> (const <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> *ti)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the document frequency for terminfo <em>ti</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_terminfos.h::lcn_terminfo_prox_position"></a> +apr_uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a6">lcn_terminfo_prox_position</a> (const <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> *ti)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the proximity position for terminfo <em>ti</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="lcn_terminfos.h::lcn_terminfo_freq_position"></a> +apr_uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a7">lcn_terminfo_freq_position</a> (const <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> *ti)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the frequency position for terminfo <em>ti</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="lcn_terminfos.h::lcn_terminfo_skip_offset"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a8">lcn_terminfo_skip_offset</a> (const <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> *ti)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the skip offset for terminfo <em>ti</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="lcn_terminfos.h::lcn_terminfo_copy"></a> +<a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a9">lcn_terminfo_copy</a> (const <a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> *ti, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a copy of terminfo <em>ti</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="lcn_terminfos.h::lcn_terminfos_idx_read"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a10">lcn_terminfos_idx_read</a> (<a class="el" href="lcn__terminfos_8h.html#a1">lcn_terminfos_idx_t</a> **tisidx, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *directory, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *segment, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read the terminfos index for <em>segment</em> in directory <em>directory</em> and return it in <em>tisidx</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="lcn_terminfos.h::lcn_terminfos_idx_get_count"></a> +apr_uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a11">lcn_terminfos_idx_get_count</a> (const <a class="el" href="lcn__terminfos_8h.html#a1">lcn_terminfos_idx_t</a> *tisidx)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the count of the terminfos in <em>tisidx</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12" doxytag="lcn_terminfos.h::lcn_terminfos_idx_get_terminfo"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a12">lcn_terminfos_idx_get_terminfo</a> (<a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> **ti, const <a class="el" href="lcn__terminfos_8h.html#a1">lcn_terminfos_idx_t</a> *tisidx, apr_uint64_t position)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the terminfo <em>ti</em> at <em>position</em> in <em>tisidx</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13" doxytag="lcn_terminfos.h::lcn_terminfos_open"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a13">lcn_terminfos_open</a> (<a class="el" href="lcn__terminfos_8h.html#a2">lcn_terminfos_t</a> **tis, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *directory, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *segment, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Open the terminfos file for <em>segment</em> in <em>directory</em>, return it in <em>tis</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14" doxytag="lcn_terminfos.h::lcn_terminfos_get_terminfo"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__terminfos_8h.html#a14">lcn_terminfos_get_terminfo</a> (<a class="el" href="lcn__terminfos_8h.html#a0">lcn_terminfo_t</a> **ti, const <a class="el" href="lcn__terminfos_8h.html#a2">lcn_terminfos_t</a> *tis, const <a class="el" href="structlcn__term__t.html">lcn_term_t</a> *term, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the terminfo <em>ti</em> from <em>tis</em> that corresponds to <em>term</em>, allocated in <em>pool</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for manipulating the terminfos file from a lucene segment. +<p> + +<p> +Definition in file <a class="el" href="lcn__terminfos_8h-source.html">lcn_terminfos.h</a>.<hr size="1"><address style="align: right;"><small>Generated on Sat Mar 26 08:12:11 2005 for Lucene4c by +<a href="http://www.doxygen.org/index.html";> +<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.0 </small></address> +</body> +</html>
