Added: incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__fieldinfos_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,50 @@ +<!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_fieldinfos.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_fieldinfos.h File Reference</h1>Routines for reading information about a segment's fields. <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> + +<p> +<a href="lcn__fieldinfos_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_fieldinfos.h::lcn_fieldinfos_t"></a> +typedef <a class="el" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing a segment's fieldinfos 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="a1" doxytag="lcn_fieldinfos.h::lcn_fieldinfos_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__fieldinfos_8h.html#a1">lcn_fieldinfos_read</a> (<a class="el" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a> **fis, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *s, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return in <em>fis</em> an <code>lcn_fieldinfos_t</code> corresponding to segment <em>s</em> in directory <em>d</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_fieldinfos.h::lcn_fieldinfos_get_by_number"></a> +<a class="el" href="structlcn__fieldinfo__t.html">lcn_fieldinfo_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__fieldinfos_8h.html#a2">lcn_fieldinfos_get_by_number</a> (const <a class="el" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a> *fis, int i)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a pointer to the <code><a class="el" href="structlcn__fieldinfo__t.html">lcn_fieldinfo_t</a></code> that corresponds to number <em>i</em>, or <code>NULL</code> if none exists. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_fieldinfos.h::lcn_fieldinfos_get_by_name"></a> +<a class="el" href="structlcn__fieldinfo__t.html">lcn_fieldinfo_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__fieldinfos_8h.html#a3">lcn_fieldinfos_get_by_name</a> (const <a class="el" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a> *fis, 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 a pointer to the <code><a class="el" href="structlcn__fieldinfo__t.html">lcn_fieldinfo_t</a></code> that corresponds to <em>name</em>, or <code>NULL</code> if none exists. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_fieldinfos.h::lcn_fieldinfos_get_count"></a> +int </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__fieldinfos_8h.html#a4">lcn_fieldinfos_get_count</a> (const <a class="el" href="lcn__fieldinfos_8h.html#a0">lcn_fieldinfos_t</a> *fis)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the number of fieldinfos within <em>fis</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for reading information about a segment's fields. +<p> + +<p> +Definition in file <a class="el" href="lcn__fieldinfos_8h-source.html">lcn_fieldinfos.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__frequencies_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__frequencies_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__frequencies_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__frequencies_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,76 @@ +<!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_frequencies.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_frequencies.h</h1><a href="lcn__frequencies_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_frequencies.h</span> +00019 <span class="comment"> * @brief routines for reading the frequencies data for a segment</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_FREQUENCIES_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_FREQUENCIES_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__terminfos_8h.html">lcn_terminfos.h</a>"</span> +00027 <span class="preprocessor">#include "<a class="code" href="lcn__directory_8h.html">lcn_directory.h</a>"</span> +00028 +00029 <span class="preprocessor">#include <apr_pools.h></span> +00030 +00031 <span class="preprocessor">#ifdef __cplusplus</span> +00032 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00033 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00034 <span class="comment"></span> +00035 <span class="comment">/** Opaque structure representing the frequencies file for a segment. */</span> +<a name="l00036"></a><a class="code" href="lcn__frequencies_8h.html#a0">00036</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__frequencies_8h.html#a0">lcn_frequencies_t</a> <a class="code" href="lcn__frequencies_8h.html#a0">lcn_frequencies_t</a>; +00037 <span class="comment"></span> +00038 <span class="comment">/** Return the @a freqs for segment @a s in directory @a d, allocated in</span> +00039 <span class="comment"> * @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__frequencies_8h.html#a1">lcn_frequencies_open</a> (lcn_frequencies_t **freqs, +00043 <span class="keyword">const</span> lcn_directory_t *d, +00044 <span class="keyword">const</span> lcn_char_t *s, +00045 apr_pool_t *pool); +00046 <span class="comment"></span> +00047 <span class="comment">/** Return the document numbers @a docs and frequencies @a freqs for all</span> +00048 <span class="comment"> * documents that contain the term represented by @c lcn_terminfo_t @a ti</span> +00049 <span class="comment"> * within @c lcn_frequencies_t @a f, allocated in @a pool.</span> +00050 <span class="comment"> */</span> +00051 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00052 <a class="code" href="lcn__frequencies_8h.html#a2">lcn_frequencies_get_terminfo_data</a> (apr_uint32_t **docs, +00053 apr_uint32_t **freqs, +00054 lcn_frequencies_t *f, +00055 <span class="keyword">const</span> lcn_terminfo_t *ti, +00056 apr_pool_t *pool); +00057 +00058 <span class="preprocessor">#ifdef __cplusplus</span> +00059 <span class="preprocessor"></span>} +00060 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00061 +00062 <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__frequencies_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__frequencies_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__frequencies_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__frequencies_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,44 @@ +<!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_frequencies.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_frequencies.h File Reference</h1>routines for reading the frequencies data for a 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__terminfos_8h-source.html">lcn_terminfos.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__directory_8h-source.html">lcn_directory.h</a>"</code><br> +<code>#include <apr_pools.h></code><br> + +<p> +<a href="lcn__frequencies_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_frequencies.h::lcn_frequencies_t"></a> +typedef <a class="el" href="lcn__frequencies_8h.html#a0">lcn_frequencies_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__frequencies_8h.html#a0">lcn_frequencies_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing the frequencies file for a segment. <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_frequencies.h::lcn_frequencies_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__frequencies_8h.html#a1">lcn_frequencies_open</a> (<a class="el" href="lcn__frequencies_8h.html#a0">lcn_frequencies_t</a> **freqs, const <a class="el" href="lcn__directory_8h.html#a0">lcn_directory_t</a> *d, const <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> *s, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the <em>freqs</em> for segment <em>s</em> in directory <em>d</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a2" doxytag="lcn_frequencies.h::lcn_frequencies_get_terminfo_data"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__frequencies_8h.html#a2">lcn_frequencies_get_terminfo_data</a> (apr_uint32_t **docs, apr_uint32_t **freqs, <a class="el" href="lcn__frequencies_8h.html#a0">lcn_frequencies_t</a> *f, 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 the document numbers <em>docs</em> and frequencies <em>freqs</em> for all documents that contain the term represented by <code>lcn_terminfo_t</code> <em>ti</em> within <code>lcn_frequencies_t</code> <em>f</em>, allocated in <em>pool</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +routines for reading the frequencies data for a segment +<p> + +<p> +Definition in file <a class="el" href="lcn__frequencies_8h-source.html">lcn_frequencies.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__index_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__index_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__index_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__index_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,115 @@ +<!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_index.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_index.h</h1><a href="lcn__index_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_index.h</span> +00019 <span class="comment"> * @brief Routines for manipulating a lucene index</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_INDEX_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_INDEX_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__term_8h.html">lcn_term.h</a>"</span> +00027 <span class="preprocessor">#include "<a class="code" href="lcn__document_8h.html">lcn_document.h</a>"</span> +00028 +00029 <span class="preprocessor">#include <apr_file_io.h></span> +00030 +00031 <span class="preprocessor">#ifdef __cplusplus</span> +00032 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00033 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00034 <span class="comment"></span> +00035 <span class="comment">/** Opaque structure representing a lucene index. */</span> +<a name="l00036"></a><a class="code" href="lcn__index_8h.html#a0">00036</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__index_8h.html#a0">lcn_index_t</a> <a class="code" href="lcn__index_8h.html#a0">lcn_index_t</a>; +00037 <span class="comment"></span> +00038 <span class="comment">/** Return the index contained in directory @a d in @a idx, allocated in</span> +00039 <span class="comment"> * @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__index_8h.html#a2">lcn_index_open</a> (lcn_index_t **idx, +00043 <span class="keyword">const</span> <span class="keywordtype">char</span> *d, +00044 apr_pool_t *pool); +00045 <span class="comment"></span> +00046 <span class="comment">/** Return the maximum document number contained in index @a idx. */</span> +00047 apr_uint32_t +00048 <a class="code" href="lcn__index_8h.html#a3">lcn_index_max_docs</a> (lcn_index_t *idx); +00049 <span class="comment"></span> +00050 <span class="comment">/** Opaque iterator for iterating over a list of documents. */</span> +<a name="l00051"></a><a class="code" href="lcn__index_8h.html#a1">00051</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> <a class="code" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a>; +00052 <span class="comment"></span> +00053 <span class="comment">/** Return the current document number from @a itr. */</span> +00054 apr_uint32_t <a class="code" href="lcn__index_8h.html#a4">lcn_doc_iter_doc</a> (lcn_doc_iter_t *itr); +00055 <span class="comment"></span> +00056 <span class="comment">/** Return the maximum document number that can be returned from @a itr. */</span> +00057 apr_uint32_t <a class="code" href="lcn__index_8h.html#a5">lcn_doc_iter_max_docs</a> (lcn_doc_iter_t *itr); +00058 <span class="comment"></span> +00059 <span class="comment">/** Return the current document's frequency from @a itr. */</span> +00060 apr_uint32_t <a class="code" href="lcn__index_8h.html#a6">lcn_doc_iter_freq</a> (lcn_doc_iter_t *itr); +00061 <span class="comment"></span> +00062 <span class="comment">/** Return the total number of hits for the term in the current segment. */</span> +00063 apr_uint32_t <a class="code" href="lcn__index_8h.html#a7">lcn_doc_iter_term_freq</a> (lcn_doc_iter_t *itr); +00064 <span class="comment"></span> +00065 <span class="comment">/** Move @a itr to the next document.</span> +00066 <span class="comment"> *</span> +00067 <span class="comment"> * If the increment was successful, @a next is TRUE, if it moved us past</span> +00068 <span class="comment"> * the end of the sequence @a next is 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__index_8h.html#a8">lcn_doc_iter_next</a> (lcn_boolean_t *next, lcn_doc_iter_t *itr); +00071 +00072 <span class="comment">/* XXX need an interface to read multiple doc/freq pairs at once. */</span> +00073 +00074 <span class="comment">/* XXX need an interface to skip to a certain document. */</span> +00075 <span class="comment"></span> +00076 <span class="comment">/** Close @a itr. */</span> +00077 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * <a class="code" href="lcn__index_8h.html#a9">lcn_doc_iter_close</a> (lcn_doc_iter_t *itr); +00078 <span class="comment"></span> +00079 <span class="comment">/** Return an iterator @a itr for iterating over all documents that contain</span> +00080 <span class="comment"> * @a term within @a idx, allocated from within @a pool.</span> +00081 <span class="comment"> */</span> +00082 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00083 <a class="code" href="lcn__index_8h.html#a10">lcn_index_term_docs</a> (lcn_doc_iter_t **itr, +00084 lcn_index_t *idx, +00085 <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *term, +00086 apr_pool_t *pool); +00087 <span class="comment"></span> +00088 <span class="comment">/** Return the document @a doc from @a idx that has the number @a docnum,</span> +00089 <span class="comment"> * allocated from @a pool.</span> +00090 <span class="comment"> */</span> +00091 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00092 <a class="code" href="lcn__index_8h.html#a11">lcn_index_get_document</a> (lcn_document_t **doc, +00093 lcn_index_t *idx, +00094 apr_uint32_t docnum, +00095 apr_pool_t *pool); +00096 +00097 <span class="preprocessor">#ifdef __cplusplus</span> +00098 <span class="preprocessor"></span>} +00099 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00100 +00101 <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__index_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__index_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__index_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__index_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,119 @@ +<!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_index.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_index.h File Reference</h1>Routines for manipulating 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__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_file_io.h></code><br> + +<p> +<a href="lcn__index_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_index.h::lcn_index_t"></a> +typedef <a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing a lucene index. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1" doxytag="lcn_index.h::lcn_doc_iter_t"></a> +typedef <a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque iterator for iterating over a list of documents. <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_index.h::lcn_index_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__index_8h.html#a2">lcn_index_open</a> (<a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a> **idx, const char *d, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the index contained in directory <em>d</em> in <em>idx</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_index.h::lcn_index_max_docs"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a3">lcn_index_max_docs</a> (<a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a> *idx)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum document number contained in index <em>idx</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_index.h::lcn_doc_iter_doc"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a4">lcn_doc_iter_doc</a> (<a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> *itr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current document number from <em>itr</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_index.h::lcn_doc_iter_max_docs"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a5">lcn_doc_iter_max_docs</a> (<a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> *itr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum document number that can be returned from <em>itr</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_index.h::lcn_doc_iter_freq"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a6">lcn_doc_iter_freq</a> (<a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> *itr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current document's frequency from <em>itr</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="lcn_index.h::lcn_doc_iter_term_freq"></a> +apr_uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a7">lcn_doc_iter_term_freq</a> (<a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> *itr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the total number of hits for the term in the current segment. <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__index_8h.html#a8">lcn_doc_iter_next</a> (<a class="el" href="lcn__types_8h.html#a8">lcn_boolean_t</a> *next, <a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> *itr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Move <em>itr</em> to the next document. <a href="#a8"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="lcn_index.h::lcn_doc_iter_close"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__index_8h.html#a9">lcn_doc_iter_close</a> (<a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> *itr)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close <em>itr</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="lcn_index.h::lcn_index_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__index_8h.html#a10">lcn_index_term_docs</a> (<a class="el" href="lcn__index_8h.html#a1">lcn_doc_iter_t</a> **itr, <a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a> *idx, <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 an iterator <em>itr</em> for iterating over all documents that contain <em>term</em> within <em>idx</em>, allocated from within <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="lcn_index.h::lcn_index_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__index_8h.html#a11">lcn_index_get_document</a> (<a class="el" href="lcn__document_8h.html#a0">lcn_document_t</a> **doc, <a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a> *idx, 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>idx</em> that has the number <em>docnum</em>, allocated from <em>pool</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for manipulating a lucene index. +<p> + +<p> +Definition in file <a class="el" href="lcn__index_8h-source.html">lcn_index.h</a>.<hr><h2>Function Documentation</h2> +<a class="anchor" name="a8" doxytag="lcn_index.h::lcn_doc_iter_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_doc_iter_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__index_8h.html#a1">lcn_doc_iter_t</a> * </td> + <td class="mdname" nowrap> <em>itr</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> +Move <em>itr</em> to the next document. +<p> +If the increment was successful, <em>next</em> is TRUE, if it moved us past the end of the sequence <em>next</em> is 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__istream_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__istream_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__istream_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__istream_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,159 @@ +<!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_istream.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_istream.h</h1><a href="lcn__istream_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_istream.h</span> +00019 <span class="comment"> * @brief Routines for manipulating read-only streams of data</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_ISTREAM_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_ISTREAM_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">#include <apr_file_io.h></span> +00028 +00029 <span class="preprocessor">#ifdef __cplusplus</span> +00030 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00031 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00032 <span class="comment"></span> +00033 <span class="comment">/** Opaque structure representing a stream of data. */</span> +<a name="l00034"></a><a class="code" href="lcn__istream_8h.html#a0">00034</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__istream_8h.html#a0">lcn_istream_t</a> <a class="code" href="lcn__istream_8h.html#a0">lcn_istream_t</a>; +00035 <span class="comment"></span> +00036 <span class="comment">/** Return a memory backed istream containing @a length bytes of data from</span> +00037 <span class="comment"> * @a buffer, the stream is allocated from @a pool.</span> +00038 <span class="comment"> */</span> +00039 <a class="code" href="lcn__istream_8h.html#a0">lcn_istream_t</a> * +00040 <a class="code" href="lcn__istream_8h.html#a1">lcn_ram_istream_create</a> (<span class="keyword">const</span> <span class="keywordtype">char</span> *buffer, +00041 apr_size_t length, +00042 apr_pool_t *pool); +00043 <span class="comment"></span> +00044 <span class="comment">/** Return a file backed istream that wraps @a file, allocated from @a pool. */</span> +00045 <a class="code" href="lcn__istream_8h.html#a0">lcn_istream_t</a> * +00046 <a class="code" href="lcn__istream_8h.html#a2">lcn_file_istream_create</a> (apr_file_t *file, apr_pool_t *pool); +00047 <span class="comment"></span> +00048 <span class="comment">/** Read a single byte from @a stream into @a byte, using @a pool for any</span> +00049 <span class="comment"> * allocation.</span> +00050 <span class="comment"> */</span> +00051 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00052 <a class="code" href="lcn__istream_8h.html#a3">lcn_istream_read_byte</a> (lcn_istream_t *stream, +00053 <span class="keywordtype">char</span> *byte, +00054 apr_pool_t *pool); +00055 <span class="comment"></span> +00056 <span class="comment">/** Read @a len bytes from @a stream into @a buffer, using @a pool for any</span> +00057 <span class="comment"> * allocation</span> +00058 <span class="comment"> */</span> +00059 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00060 <a class="code" href="lcn__istream_8h.html#a4">lcn_istream_read_bytes</a> (lcn_istream_t *stream, +00061 <span class="keywordtype">char</span> *buffer, +00062 apr_size_t len, +00063 apr_pool_t *pool); +00064 <span class="comment"></span> +00065 <span class="comment">/** Read a 32 bit integer from @a stream into @a i, using @a pool for any</span> +00066 <span class="comment"> * allocation</span> +00067 <span class="comment"> */</span> +00068 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00069 <a class="code" href="lcn__istream_8h.html#a5">lcn_istream_read_int</a> (lcn_istream_t *stream, +00070 apr_uint32_t *i, +00071 apr_pool_t *pool); +00072 <span class="comment"></span> +00073 <span class="comment">/** Read a variable length 32 bit integer from @a steam into @a i, using</span> +00074 <span class="comment"> * @a pool for any 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__istream_8h.html#a6">lcn_istream_read_vint</a> (lcn_istream_t *stream, +00078 apr_uint32_t *i, +00079 apr_pool_t *pool); +00080 <span class="comment"></span> +00081 <span class="comment">/** Read a 64 bit integer from @a stream into @a l, using @a pool for any</span> +00082 <span class="comment"> * allocation.</span> +00083 <span class="comment"> */</span> +00084 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00085 <a class="code" href="lcn__istream_8h.html#a7">lcn_istream_read_long</a> (lcn_istream_t *stream, +00086 apr_uint64_t *l, +00087 apr_pool_t *pool); +00088 <span class="comment"></span> +00089 <span class="comment">/** Read a variable length 64 bit integer from @a stream into @a l, using</span> +00090 <span class="comment"> * @a pool for any allocation.</span> +00091 <span class="comment"> */</span> +00092 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00093 <a class="code" href="lcn__istream_8h.html#a8">lcn_istream_read_vlong</a> (lcn_istream_t *stream, +00094 apr_uint64_t *l, +00095 apr_pool_t *pool); +00096 <span class="comment"></span> +00097 <span class="comment">/** Read a string from @a stream into @a str, allocated from @a pool. */</span> +00098 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00099 <a class="code" href="lcn__istream_8h.html#a9">lcn_istream_read_string</a> (lcn_istream_t *stream, +00100 lcn_char_t **str, +00101 apr_pool_t *pool); +00102 <span class="comment"></span> +00103 <span class="comment">/** Read @a length chars from @a stream, returning them in @a buffer, using</span> +00104 <span class="comment"> * @a pool for allocation. */</span> +00105 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00106 <a class="code" href="lcn__istream_8h.html#a10">lcn_istream_read_chars</a> (lcn_istream_t *stream, +00107 lcn_char_t **buffer, +00108 apr_size_t length, +00109 apr_pool_t *pool); +00110 <span class="comment"></span> +00111 <span class="comment">/** Seek @a stream to @a offset, using @a pool for temporary allocations. */</span> +00112 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00113 <a class="code" href="lcn__istream_8h.html#a11">lcn_istream_seek</a> (lcn_istream_t *stream, apr_off_t offset, apr_pool_t *pool); +00114 <span class="comment"></span> +00115 <span class="comment">/** Close @a stream, using @a pool for temporary allocations. */</span> +00116 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00117 <a class="code" href="lcn__istream_8h.html#a12">lcn_istream_close</a> (lcn_istream_t *stream, apr_pool_t *pool); +00118 <span class="comment"></span> +00119 <span class="comment">/** Return the length of @a stream in @a length, using @a pool for temporary</span> +00120 <span class="comment"> * allocations.</span> +00121 <span class="comment"> */</span> +00122 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00123 <a class="code" href="lcn__istream_8h.html#a13">lcn_istream_length</a> (lcn_istream_t *stream, +00124 apr_size_t *length, +00125 apr_pool_t *pool); +00126 <span class="comment"></span> +00127 <span class="comment">/** Return the current position of @a stream in @a offset, using @a pool for</span> +00128 <span class="comment"> * temporary allocations.</span> +00129 <span class="comment"> */</span> +00130 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00131 <a class="code" href="lcn__istream_8h.html#a14">lcn_istream_offset</a> (lcn_istream_t *stream, +00132 apr_off_t *offset, +00133 apr_pool_t *pool); +00134 <span class="comment"></span> +00135 <span class="comment">/** Return a duplicate of @a source in @a dest, allocated within @a pool. */</span> +00136 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00137 <a class="code" href="lcn__istream_8h.html#a15">lcn_istream_duplicate</a> (lcn_istream_t **dest, +00138 lcn_istream_t *source, +00139 apr_pool_t *pool); +00140 +00141 <span class="preprocessor">#ifdef __cplusplus</span> +00142 <span class="preprocessor"></span>} +00143 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00144 +00145 <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__istream_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__istream_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__istream_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__istream_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,94 @@ +<!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_istream.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_istream.h File Reference</h1>Routines for manipulating read-only streams of data. <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 <apr_file_io.h></code><br> + +<p> +<a href="lcn__istream_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_istream.h::lcn_istream_t"></a> +typedef <a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Opaque structure representing a stream of data. <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_istream.h::lcn_ram_istream_create"></a> +<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a1">lcn_ram_istream_create</a> (const char *buffer, apr_size_t length, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a memory backed istream containing <em>length</em> bytes of data from <em>buffer</em>, the stream 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_istream.h::lcn_file_istream_create"></a> +<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a2">lcn_file_istream_create</a> (apr_file_t *file, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a file backed istream that wraps <em>file</em>, allocated from <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="lcn_istream.h::lcn_istream_read_byte"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a3">lcn_istream_read_byte</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, char *byte, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a single byte from <em>stream</em> into <em>byte</em>, using <em>pool</em> for any allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a4" doxytag="lcn_istream.h::lcn_istream_read_bytes"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a4">lcn_istream_read_bytes</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, char *buffer, apr_size_t len, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read <em>len</em> bytes from <em>stream</em> into <em>buffer</em>, using <em>pool</em> for any allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_istream.h::lcn_istream_read_int"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a5">lcn_istream_read_int</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_uint32_t *i, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a 32 bit integer from <em>stream</em> into <em>i</em>, using <em>pool</em> for any allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a6" doxytag="lcn_istream.h::lcn_istream_read_vint"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a6">lcn_istream_read_vint</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_uint32_t *i, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a variable length 32 bit integer from <em>steam</em> into <em>i</em>, using <em>pool</em> for any allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="lcn_istream.h::lcn_istream_read_long"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a7">lcn_istream_read_long</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_uint64_t *l, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a 64 bit integer from <em>stream</em> into <em>l</em>, using <em>pool</em> for any allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="lcn_istream.h::lcn_istream_read_vlong"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a8">lcn_istream_read_vlong</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_uint64_t *l, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a variable length 64 bit integer from <em>stream</em> into <em>l</em>, using <em>pool</em> for any allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="lcn_istream.h::lcn_istream_read_string"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a9">lcn_istream_read_string</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> **str, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read a string from <em>stream</em> into <em>str</em>, allocated from <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a10" doxytag="lcn_istream.h::lcn_istream_read_chars"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a10">lcn_istream_read_chars</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, <a class="el" href="lcn__types_8h.html#a10">lcn_char_t</a> **buffer, apr_size_t length, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Read <em>length</em> chars from <em>stream</em>, returning them in <em>buffer</em>, using <em>pool</em> for allocation. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a11" doxytag="lcn_istream.h::lcn_istream_seek"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a11">lcn_istream_seek</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_off_t offset, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Seek <em>stream</em> to <em>offset</em>, using <em>pool</em> for temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a12" doxytag="lcn_istream.h::lcn_istream_close"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a12">lcn_istream_close</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Close <em>stream</em>, using <em>pool</em> for temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a13" doxytag="lcn_istream.h::lcn_istream_length"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a13">lcn_istream_length</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_size_t *length, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the length of <em>stream</em> in <em>length</em>, using <em>pool</em> for temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a14" doxytag="lcn_istream.h::lcn_istream_offset"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a14">lcn_istream_offset</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *stream, apr_off_t *offset, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the current position of <em>stream</em> in <em>offset</em>, using <em>pool</em> for temporary allocations. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a15" doxytag="lcn_istream.h::lcn_istream_duplicate"></a> +<a class="el" href="structlcn__error__t.html">lcn_error_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__istream_8h.html#a15">lcn_istream_duplicate</a> (<a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> **dest, <a class="el" href="lcn__istream_8h.html#a0">lcn_istream_t</a> *source, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a duplicate of <em>source</em> in <em>dest</em>, allocated within <em>pool</em>. <br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for manipulating read-only streams of data. +<p> + +<p> +Definition in file <a class="el" href="lcn__istream_8h-source.html">lcn_istream.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__query_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__query_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__query_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__query_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,124 @@ +<!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.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_query.h</h1><a href="lcn__query_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_query.h</span> +00019 <span class="comment"> * @brief Routines for working with queries</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_QUERY_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_QUERY_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__scorer_8h.html">lcn_scorer.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">#ifdef __cplusplus</span> +00030 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> { +00031 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00032 <span class="comment"></span> +00033 <span class="comment">/** Abstract query object. */</span> +<a name="l00034"></a><a class="code" href="lcn__query_8h.html#a0">00034</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__query_8h.html#a0">lcn_query_t</a> <a class="code" href="lcn__query_8h.html#a0">lcn_query_t</a>; +00035 <span class="comment"></span> +00036 <span class="comment">/** Create a @a query that matches @a term, allocated in @a pool. */</span> +00037 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00038 <a class="code" href="lcn__query_8h.html#a4">lcn_term_query_create</a> (lcn_query_t **query, +00039 <a class="code" href="structlcn__term__t.html">lcn_term_t</a> *term, +00040 apr_pool_t *pool); +00041 <span class="comment"></span> +00042 <span class="comment">/** Create a @a query that matches a number of other queries, each of which</span> +00043 <span class="comment"> * either MUST occur, SHOULD occur, or MUST NOT occur in the documents matched,</span> +00044 <span class="comment"> * the query is allocated in @a pool.</span> +00045 <span class="comment"> */</span> +00046 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00047 <a class="code" href="lcn__query_8h.html#a5">lcn_boolean_query_create</a> (lcn_query_t **query, apr_pool_t *pool); +00048 <span class="comment"></span> +00049 <span class="comment">/** An indication of what requirement is placed on a particular part of a</span> +00050 <span class="comment"> * boolean query.</span> +00051 <span class="comment"> */</span> +<a name="l00052"></a><a class="code" href="lcn__query_8h.html#a11">00052</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> { +00053 <a class="code" href="lcn__query_8h.html#a11a1">LCN_MUST</a>, <span class="comment">/**< The query must match */</span> +00054 <a class="code" href="lcn__query_8h.html#a11a2">LCN_SHOULD</a>, <span class="comment">/**< At least one of the queries with this occur must match */</span> +00055 <a class="code" href="lcn__query_8h.html#a11a3">LCN_MUST_NOT</a> <span class="comment">/**< The query must not match */</span> +00056 } <a class="code" href="lcn__query_8h.html#a11">lcn_boolean_clause_occur_t</a>; +00057 <span class="comment"></span> +00058 <span class="comment">/** Add @a clause to @a query, with @a occur as the specification for whether</span> +00059 <span class="comment"> * it is required or not.</span> +00060 <span class="comment"> *</span> +00061 <span class="comment"> * @note all clauses that are added to @a query must be allocated from a pool</span> +00062 <span class="comment"> * that lives at least as long as the pool used to allocate @a query, or the</span> +00063 <span class="comment"> * behavior is undefined.</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__query_8h.html#a6">lcn_boolean_query_add</a> (lcn_query_t *query, +00067 lcn_query_t *clause, +00068 lcn_boolean_clause_occur_t occur); +00069 <span class="comment"></span> +00070 <span class="comment">/** Return @a weight's underlying query. */</span> +00071 <a class="code" href="lcn__query_8h.html#a0">lcn_query_t</a> * <a class="code" href="lcn__query_8h.html#a7">lcn_weight_query</a> (lcn_weight_t *weight); +00072 <span class="comment"></span> +00073 <span class="comment">/** Return the value of @a weight. */</span> +00074 <span class="keywordtype">float</span> <a class="code" href="lcn__query_8h.html#a8">lcn_weight_value</a> (lcn_weight_t *weight); +00075 +00076 <span class="preprocessor">#if NOTYET</span> +00077 <span class="preprocessor"></span><span class="comment">/** Return the sum of the squared weight sof contained query clauses. */</span> +00078 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00079 lcn_weight_sum_of_squared_weights (<span class="keywordtype">float</span> *sum, lcn_weight_t *weight); +00080 <span class="comment"></span> +00081 <span class="comment">/** Assign a query normalization factor @a norm to this @a weight. */</span> +00082 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * lcn_weight_normalize (lcn_weight_t *weight, <span class="keywordtype">float</span> norm); +00083 +00084 <span class="comment">/* XXX leaving out lcn_weight_explain for now... */</span> +00085 <span class="preprocessor">#endif</span> +00086 <span class="preprocessor"></span><span class="comment"></span> +00087 <span class="comment">/** Create an @a weight from @a query. */</span> +00088 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00089 <a class="code" href="lcn__query_8h.html#a9">lcn_query_weight</a> (lcn_weight_t **weight, +00090 lcn_query_t *query, +00091 apr_pool_t *pool); +00092 <span class="comment"></span> +00093 <span class="comment">/** Return a @a scorer for @a weight run over @a index, allocated in</span> +00094 <span class="comment"> * @a pool.</span> +00095 <span class="comment"> *</span> +00096 <span class="comment"> * @note the Java Lucene version of this stuff works on a Weight, not a</span> +00097 <span class="comment"> * Query, but that's mainly because you are supposed to be able to reuse</span> +00098 <span class="comment"> * a Query, so we can make that split later.</span> +00099 <span class="comment"> */</span> +00100 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00101 <a class="code" href="lcn__query_8h.html#a10">lcn_weight_scorer</a> (lcn_scorer_t **scorer, +00102 lcn_weight_t *weight, +00103 lcn_index_t *index, +00104 apr_pool_t *pool); +00105 +00106 <span class="preprocessor">#ifdef __cplusplus</span> +00107 <span class="preprocessor"></span>} +00108 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00109 +00110 <span class="preprocessor">#endif </span><span class="comment">/* _LCN_QUERY_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__query_8h.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__query_8h.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__query_8h.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__query_8h.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,209 @@ +<!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.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.h File Reference</h1>Routines for working with queries. <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__scorer_8h-source.html">lcn_scorer.h</a>"</code><br> +<code>#include "<a class="el" href="lcn__term_8h-source.html">lcn_term.h</a>"</code><br> + +<p> +<a href="lcn__query_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.h::lcn_query_t"></a> +typedef <a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a></td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Abstract query object. <br></td></tr> +<tr><td colspan="2"><br><h2>Enumerations</h2></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__query_8h.html#a11">lcn_boolean_clause_occur_t</a> { <br> + <a class="el" href="lcn__query_8h.html#a11a1">LCN_MUST</a>, +<br> + <a class="el" href="lcn__query_8h.html#a11a2">LCN_SHOULD</a>, +<br> + <a class="el" href="lcn__query_8h.html#a11a3">LCN_MUST_NOT</a> +<br> + }</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">An indication of what requirement is placed on a particular part of a boolean query. <a href="#a11">More...</a><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="a4" doxytag="lcn_query.h::lcn_term_query_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_8h.html#a4">lcn_term_query_create</a> (<a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> **query, <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">Create a <em>query</em> that matches <em>term</em>, allocated in <em>pool</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a5" doxytag="lcn_query.h::lcn_boolean_query_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_8h.html#a5">lcn_boolean_query_create</a> (<a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> **query, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create a <em>query</em> that matches a number of other queries, each of which either MUST occur, SHOULD occur, or MUST NOT occur in the documents matched, the query is 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__query_8h.html#a6">lcn_boolean_query_add</a> (<a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> *query, <a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> *clause, <a class="el" href="lcn__query_8h.html#a11">lcn_boolean_clause_occur_t</a> occur)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Add <em>clause</em> to <em>query</em>, with <em>occur</em> as the specification for whether it is required or not. <a href="#a6"></a><br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a7" doxytag="lcn_query.h::lcn_weight_query"></a> +<a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__query_8h.html#a7">lcn_weight_query</a> (<a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> *weight)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return <em>weight's</em> underlying query. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a8" doxytag="lcn_query.h::lcn_weight_value"></a> +float </td><td class="memItemRight" valign="bottom"><a class="el" href="lcn__query_8h.html#a8">lcn_weight_value</a> (<a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> *weight)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the value of <em>weight</em>. <br></td></tr> +<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a9" doxytag="lcn_query.h::lcn_query_weight"></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_8h.html#a9">lcn_query_weight</a> (<a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> **weight, <a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> *query, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Create an <em>weight</em> from <em>query</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__query_8h.html#a10">lcn_weight_scorer</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#a0">lcn_index_t</a> *index, apr_pool_t *pool)</td></tr> + +<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a <em>scorer</em> for <em>weight</em> run over <em>index</em>, allocated in <em>pool</em>. <a href="#a10"></a><br></td></tr> +</table> +<hr><a name="_details"></a><h2>Detailed Description</h2> +Routines for working with queries. +<p> + +<p> +Definition in file <a class="el" href="lcn__query_8h-source.html">lcn_query.h</a>.<hr><h2>Enumeration Type Documentation</h2> +<a class="anchor" name="a11" doxytag="lcn_query.h::lcn_boolean_clause_occur_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">enum <a class="el" href="lcn__query_8h.html#a11">lcn_boolean_clause_occur_t</a> </td> + </tr> + </table> + </td> + </tr> +</table> +<table cellspacing="5" cellpadding="0" border="0"> + <tr> + <td> + + </td> + <td> + +<p> +An indication of what requirement is placed on a particular part of a boolean query. +<p> +<dl compact><dt><b>Enumeration values: </b></dt><dd> +<table border="0" cellspacing="2" cellpadding="0"> +<tr><td valign="top"><em><a class="anchor" name="a11a1" doxytag="LCN_MUST"></a>LCN_MUST</em> </td><td> +The query must match. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a11a2" doxytag="LCN_SHOULD"></a>LCN_SHOULD</em> </td><td> +At least one of the queries with this occur must match. </td></tr> +<tr><td valign="top"><em><a class="anchor" name="a11a3" doxytag="LCN_MUST_NOT"></a>LCN_MUST_NOT</em> </td><td> +The query must not match. </td></tr> +</table> +</dl> + +<p> +Definition at line <a class="el" href="lcn__query_8h-source.html#l00052">52</a> of file <a class="el" href="lcn__query_8h-source.html">lcn_query.h</a>. </td> + </tr> +</table> +<hr><h2>Function Documentation</h2> +<a class="anchor" name="a6" doxytag="lcn_query.h::lcn_boolean_query_add"></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_boolean_query_add </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> * </td> + <td class="mdname" nowrap> <em>query</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__query_8h.html#a0">lcn_query_t</a> * </td> + <td class="mdname" nowrap> <em>clause</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__query_8h.html#a11">lcn_boolean_clause_occur_t</a> </td> + <td class="mdname" nowrap> <em>occur</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> +Add <em>clause</em> to <em>query</em>, with <em>occur</em> as the specification for whether it is required or not. +<p> +<dl compact><dt><b>Note:</b></dt><dd>all clauses that are added to <em>query</em> must be allocated from a pool that lives at least as long as the pool used to allocate <em>query</em>, or the behavior is undefined. </dd></dl> + </td> + </tr> +</table> +<a class="anchor" name="a10" doxytag="lcn_query.h::lcn_weight_scorer"></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_weight_scorer </td> + <td class="md" valign="top">( </td> + <td class="md" nowrap valign="top"><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" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__scorer_8h.html#a0">lcn_weight_t</a> * </td> + <td class="mdname" nowrap> <em>weight</em>, </td> + </tr> + <tr> + <td class="md" nowrap align="right"></td> + <td class="md"></td> + <td class="md" nowrap><a class="el" href="lcn__index_8h.html#a0">lcn_index_t</a> * </td> + <td class="mdname" nowrap> <em>index</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 a <em>scorer</em> for <em>weight</em> run over <em>index</em>, allocated in <em>pool</em>. +<p> +<dl compact><dt><b>Note:</b></dt><dd>the Java Lucene version of this stuff works on a Weight, not a Query, but that's mainly because you are supposed to be able to reuse a Query, so we can make that split later. </dd></dl> + </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__query__parser_8h-source.html URL: http://svn.apache.org/viewcvs/incubator/lucene4c/trunk/www/apidocs/lcn__query__parser_8h-source.html?view=auto&rev=159104 ============================================================================== --- incubator/lucene4c/trunk/www/apidocs/lcn__query__parser_8h-source.html (added) +++ incubator/lucene4c/trunk/www/apidocs/lcn__query__parser_8h-source.html Sat Mar 26 05:21:14 2005 @@ -0,0 +1,68 @@ +<!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 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_query_parser.h</h1><a href="lcn__query__parser_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_query_parser.h</span> +00019 <span class="comment"> * @brief Routines for creating queries from a user provided string</span> +00020 <span class="comment"> */</span> +00021 +00022 <span class="preprocessor">#ifndef _LCN_QUERY_PARSER_H</span> +00023 <span class="preprocessor"></span><span class="preprocessor">#define _LCN_QUERY_PARSER_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__query_8h.html">lcn_query.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">/** A query parser. */</span> +<a name="l00033"></a><a class="code" href="lcn__query__parser_8h.html#a0">00033</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="lcn__query__parser_8h.html#a0">lcn_query_parser_t</a> <a class="code" href="lcn__query__parser_8h.html#a0">lcn_query_parser_t</a>; +00034 <span class="comment"></span> +00035 <span class="comment">/** Create a query parser @a parser, which uses @a default_field and</span> +00036 <span class="comment"> * @a default_occur and is allocated from @a pool. */</span> +00037 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00038 <a class="code" href="lcn__query__parser_8h.html#a1">lcn_query_parser_create</a> (lcn_query_parser_t **parser, +00039 lcn_char_t *default_field, +00040 lcn_boolean_clause_occur_t default_occur, +00041 apr_pool_t *pool); +00042 <span class="comment"></span> +00043 <span class="comment">/** Use @a parser to create @a query from @a input, allocated in @a pool. */</span> +00044 <a class="code" href="structlcn__error__t.html">lcn_error_t</a> * +00045 <a class="code" href="lcn__query__parser_8h.html#a2">lcn_query_parser_parse</a> (lcn_query_t **query, +00046 lcn_query_parser_t *parser, +00047 lcn_char_t *input, +00048 apr_pool_t *pool); +00049 +00050 <span class="preprocessor">#ifdef __cplusplus</span> +00051 <span class="preprocessor"></span>} +00052 <span class="preprocessor">#endif </span><span class="comment">/* __cplusplus */</span> +00053 +00054 <span class="preprocessor">#endif </span><span class="comment">/* _LCN_QUERY_PARSER_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>
