Added: lucy/site/trunk/content/docs/c/Lucy/Store/FSFolder.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Store/FSFolder.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Store/FSFolder.mdtext (added) +++ lucy/site/trunk/content/docs/c/Lucy/Store/FSFolder.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,65 @@ +Title: Lucy::Store::FSFolder â C API Documentation + +<div class="c-api"> +<h2>Lucy::Store::FSFolder</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>FSFOLDER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>FSFolder</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>FSFolder</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Store/FSFolder.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Store::FSFolder â File System implementation of Folder.</p> +<h3>Description</h3> +<p>Implementation of <a href="../../Lucy/Store/Folder.html">Folder</a> using a single file system +directory and multiple files.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>FSFolder* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>FSFolder_new</strong>( + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong> +); +</code></pre> +<p>Create a new Folder.</p> +<dl> +<dt>path</dt> +<dd><p>Location of the index. If the specified directory does +not exist already, it will NOT be created, in order to prevent +misconfigured read applications from spawning bogus files â so it may +be necessary to create the directory yourself.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>FSFolder* +<span class="prefix">lucy_</span><strong>FSFolder_init</strong>( + <span class="prefix">lucy_</span>FSFolder *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong> +); +</code></pre> +<p>Initialize a Folder. See <a href="../../Lucy/Store/FSFolder.html#func_new">new()</a> for a description of the +parameters.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Store::FSFolder is a <a href="../../Lucy/Store/Folder.html">Lucy::Store::Folder</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div>
Added: lucy/site/trunk/content/docs/c/Lucy/Store/Folder.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Store/Folder.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Store/Folder.mdtext (added) +++ lucy/site/trunk/content/docs/c/Lucy/Store/Folder.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,51 @@ +Title: Lucy::Store::Folder â C API Documentation + +<div class="c-api"> +<h2>Lucy::Store::Folder</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>FOLDER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Folder</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Folder</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Store/Folder.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Store::Folder â Abstract class representing a directory.</p> +<h3>Description</h3> +<p>A âfileâ within a Folder might be a real file on disk â or it might be a +RAM buffer. Similarly, Delete() might delete a file from the file system, or +a key-value pair from a hash, or something else.</p> +<p>The archetypal implementation of Folder, +<a href="../../Lucy/Store/FSFolder.html">FSFolder</a>, represents a directory on +the file system holding a collection of files.</p> +<h3>Methods</h3> +<dl> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Folder_Destroy</strong>( + <span class="prefix">lucy_</span>Folder *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Store::Folder is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> Added: lucy/site/trunk/content/docs/c/Lucy/Store/Lock.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Store/Lock.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Store/Lock.mdtext (added) +++ lucy/site/trunk/content/docs/c/Lucy/Store/Lock.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,155 @@ +Title: Lucy::Store::Lock â C API Documentation + +<div class="c-api"> +<h2>Lucy::Store::Lock</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>LOCK</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>Lock</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>Lock</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Store/Lock.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Store::Lock â Abstract class representing an interprocess mutex lock.</p> +<h3>Description</h3> +<p>The Lock class produces an interprocess mutex lock. The default subclass +uses dot-lock files, but alternative implementations are possible.</p> +<p>Each lock must have a name which is unique per resource to be locked. Each +lock also has a âhostâ id which should be unique per machine; it is used to +help clear away stale locks.</p> +<h3>Functions</h3> +<dl> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>Lock* +<span class="prefix">lucy_</span><strong>Lock_init</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>name</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong>, + int32_t <strong>timeout</strong>, + int32_t <strong>interval</strong> +); +</code></pre> +<p>Abstract initializer.</p> +<dl> +<dt>folder</dt> +<dd><p>A Folder.</p> +</dd> +<dt>name</dt> +<dd><p>String identifying the resource to be locked, which must +consist solely of characters matching [-_.A-Za-z0-9].</p> +</dd> +<dt>host</dt> +<dd><p>A unique per-machine identifier.</p> +</dd> +<dt>timeout</dt> +<dd><p>Time in milliseconds to keep retrying before abandoning +the attempt to <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> a lock.</p> +</dd> +<dt>interval</dt> +<dd><p>Time in milliseconds between retries.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Shared">Shared <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>Lock_Shared</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong> +); +</code></pre> +<p>Returns true if the Lock is shared, false if the Lock is exclusive.</p> +</dd> +<dt id="func_Obtain">Obtain</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>Lock_Obtain</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong> +); +</code></pre> +<p>Call <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> once per <code>interval</code> until <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> returns +success or the <code>timeout</code> has been reached.</p> +<p><strong>Returns:</strong> true on success, false on failure (sets the global error object +returned by <a href="../../Clownfish/Err.html#func_get_error">get_error()</a>).</p> +</dd> +<dt id="func_Request">Request <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>Lock_Request</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong> +); +</code></pre> +<p>Make one attempt to acquire the lock.</p> +<p>The semantics of <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> differ depending on whether <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a> returns +true. If the Lock is <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a>, then <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> should not fail if +another lock is held against the resource identified by +<code>name</code> (though it might fail for other reasons). If it is +not <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a> â i.e. itâs an exclusive (write) lock â then other locks +should cause <a href="../../Lucy/Store/Lock.html#func_Request">Request()</a> to fail.</p> +<p><strong>Returns:</strong> true on success, false on failure (sets the global error object +returned by <a href="../../Clownfish/Err.html#func_get_error">get_error()</a>).</p> +</dd> +<dt id="func_Release">Release <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Lock_Release</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong> +); +</code></pre> +<p>Release the lock.</p> +</dd> +<dt id="func_Is_Locked">Is_Locked <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>Lock_Is_Locked</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong> +); +</code></pre> +<p>Indicate whether the resource identified by this lockâs name is +currently locked.</p> +<p><strong>Returns:</strong> true if the resource is locked, false otherwise.</p> +</dd> +<dt id="func_Clear_Stale">Clear_Stale <span class="comment">(abstract)</span></dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Lock_Clear_Stale</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong> +); +</code></pre> +<p>Release all locks that meet the following three conditions: the lock +name matches, the host id matches, and the process id that the lock +was created under no longer identifies an active process.</p> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>Lock_Destroy</strong>( + <span class="prefix">lucy_</span>Lock *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Store::Lock is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> Added: lucy/site/trunk/content/docs/c/Lucy/Store/LockErr.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Store/LockErr.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Store/LockErr.mdtext (added) +++ lucy/site/trunk/content/docs/c/Lucy/Store/LockErr.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,34 @@ +Title: Lucy::Store::LockErr â C API Documentation + +<div class="c-api"> +<h2>Lucy::Store::LockErr</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>LOCKERR</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>LockErr</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>LockErr</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Store/Lock.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Store::LockErr â Lock exception.</p> +<h3>Description</h3> +<p>LockErr is a subclass of <a href="../../Clownfish/Err.html">Err</a> which indicates +that a file locking problem occurred.</p> +<h3>Inheritance</h3> +<p>Lucy::Store::LockErr is a <a href="../../Clownfish/Err.html">Clownfish::Err</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> Added: lucy/site/trunk/content/docs/c/Lucy/Store/LockFactory.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Store/LockFactory.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Store/LockFactory.mdtext (added) +++ lucy/site/trunk/content/docs/c/Lucy/Store/LockFactory.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,142 @@ +Title: Lucy::Store::LockFactory â C API Documentation + +<div class="c-api"> +<h2>Lucy::Store::LockFactory</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>LOCKFACTORY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>LockFactory</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>LockFact</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Store/LockFactory.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Store::LockFactory â Create Locks.</p> +<h3>Description</h3> +<p>LockFactory is used to spin off interprocess mutex locks used by various +index reading and writing components. The default implementation uses +lockfiles, but LockFactory subclasses which are implemented using +alternatives such as flock() are possible.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>LockFactory* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>LockFact_new</strong>( + <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong> +); +</code></pre> +<p>Create a new LockFactory.</p> +<dl> +<dt>folder</dt> +<dd><p>A <a href="../../Lucy/Store/Folder.html">Folder</a>.</p> +</dd> +<dt>host</dt> +<dd><p>An identifier which should be unique per-machine.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>LockFactory* +<span class="prefix">lucy_</span><strong>LockFact_init</strong>( + <span class="prefix">lucy_</span>LockFactory *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Store/Folder.html">Folder</a> *<strong>folder</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>host</strong> +); +</code></pre> +<p>Initialize a LockFactory.</p> +<dl> +<dt>folder</dt> +<dd><p>A <a href="../../Lucy/Store/Folder.html">Folder</a>.</p> +</dd> +<dt>host</dt> +<dd><p>An identifier which should be unique per-machine.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Make_Lock">Make_Lock</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Lock.html">Lock</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>LockFact_Make_Lock</strong>( + <span class="prefix">lucy_</span>LockFactory *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>name</strong>, + int32_t <strong>timeout</strong>, + int32_t <strong>interval</strong> +); +</code></pre> +<p>Return a Lock object, which, once <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> returns successfully, +maintains an exclusive lock on a resource.</p> +<dl> +<dt>name</dt> +<dd><p>A file-system-friendly id which identifies the +resource to be locked.</p> +</dd> +<dt>timeout</dt> +<dd><p>Time in milliseconds to keep retrying before abandoning +the attempt to <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> a lock.</p> +</dd> +<dt>interval</dt> +<dd><p>Time in milliseconds between retries.</p> +</dd> +</dl> +</dd> +<dt id="func_Make_Shared_Lock">Make_Shared_Lock</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Store/Lock.html">Lock</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>LockFact_Make_Shared_Lock</strong>( + <span class="prefix">lucy_</span>LockFactory *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>name</strong>, + int32_t <strong>timeout</strong>, + int32_t <strong>interval</strong> +); +</code></pre> +<p>Return a Lock object for which <a href="../../Lucy/Store/Lock.html#func_Shared">Shared()</a> returns true, and which +maintains a non-exclusive lock on a resource once <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> returns +success.</p> +<dl> +<dt>name</dt> +<dd><p>A file-system-friendly id which identifies the +resource to be locked.</p> +</dd> +<dt>timeout</dt> +<dd><p>Time in milliseconds to keep retrying before abandoning +the attempt to <a href="../../Lucy/Store/Lock.html#func_Obtain">Obtain()</a> a lock.</p> +</dd> +<dt>interval</dt> +<dd><p>Time in milliseconds between retries.</p> +</dd> +</dl> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>LockFact_Destroy</strong>( + <span class="prefix">lucy_</span>LockFactory *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Store::LockFactory is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> Added: lucy/site/trunk/content/docs/c/Lucy/Store/RAMFolder.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/Lucy/Store/RAMFolder.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/Lucy/Store/RAMFolder.mdtext (added) +++ lucy/site/trunk/content/docs/c/Lucy/Store/RAMFolder.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,66 @@ +Title: Lucy::Store::RAMFolder â C API Documentation + +<div class="c-api"> +<h2>Lucy::Store::RAMFolder</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>RAMFOLDER</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>RAMFolder</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>RAMFolder</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>Lucy/Store/RAMFolder.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>Lucy::Store::RAMFolder â In-memory Folder implementation.</p> +<h3>Description</h3> +<p>RAMFolder is an entirely in-memory implementation of +<a href="../../Lucy/Store/Folder.html">Folder</a>, primarily used for testing and development.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>RAMFolder* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>RAMFolder_new</strong>( + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong> +); +</code></pre> +<p>Create a new RAMFolder.</p> +<dl> +<dt>path</dt> +<dd><p>Relative path, used for subfolders.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>RAMFolder* +<span class="prefix">lucy_</span><strong>RAMFolder_init</strong>( + <span class="prefix">lucy_</span>RAMFolder *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>path</strong> +); +</code></pre> +<p>Initialize a RAMFolder.</p> +<dl> +<dt>path</dt> +<dd><p>Relative path, used for subfolders.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Inheritance</h3> +<p>Lucy::Store::RAMFolder is a <a href="../../Lucy/Store/Folder.html">Lucy::Store::Folder</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> Added: lucy/site/trunk/content/docs/c/LucyX/Search/ProximityQuery.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/LucyX/Search/ProximityQuery.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/LucyX/Search/ProximityQuery.mdtext (added) +++ lucy/site/trunk/content/docs/c/LucyX/Search/ProximityQuery.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,184 @@ +Title: LucyX::Search::ProximityQuery â C API Documentation + +<div class="c-api"> +<h2>LucyX::Search::ProximityQuery</h2> +<table> +<tr> +<td class="label">parcel</td> +<td><a href="../../lucy.html">Lucy</a></td> +</tr> +<tr> +<td class="label">class variable</td> +<td><code><span class="prefix">LUCY_</span>PROXIMITYQUERY</code></td> +</tr> +<tr> +<td class="label">struct symbol</td> +<td><code><span class="prefix">lucy_</span>ProximityQuery</code></td> +</tr> +<tr> +<td class="label">class nickname</td> +<td><code><span class="prefix">lucy_</span>ProximityQuery</code></td> +</tr> +<tr> +<td class="label">header file</td> +<td><code>LucyX/Search/ProximityQuery.h</code></td> +</tr> +</table> +<h3>Name</h3> +<p>LucyX::Search::ProximityQuery â Query matching an ordered list of terms.</p> +<h3>Description</h3> +<p>ProximityQuery is a subclass of <a href="../../Lucy/Search/Query.html">Query</a> for matching +against an ordered sequence of terms.</p> +<h3>Functions</h3> +<dl> +<dt id="func_new">new</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>ProximityQuery* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>ProximityQuery_new</strong>( + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>terms</strong>, + uint32_t <strong>within</strong> +); +</code></pre> +<p>Create a new ProximityQuery.</p> +<dl> +<dt>field</dt> +<dd><p>The field that the phrase must occur in.</p> +</dd> +<dt>terms</dt> +<dd><p>The ordered array of terms that must match.</p> +</dd> +</dl> +</dd> +<dt id="func_init">init</dt> +<dd> +<pre><code><span class="prefix">lucy_</span>ProximityQuery* +<span class="prefix">lucy_</span><strong>ProximityQuery_init</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a> *<strong>field</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a> *<strong>terms</strong>, + uint32_t <strong>within</strong> +); +</code></pre> +<p>Initialize a ProximityQuery.</p> +<dl> +<dt>field</dt> +<dd><p>The field that the phrase must occur in.</p> +</dd> +<dt>terms</dt> +<dd><p>The ordered array of terms that must match.</p> +</dd> +</dl> +</dd> +</dl> +<h3>Methods</h3> +<dl> +<dt id="func_Get_Field">Get_Field</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* +<span class="prefix">lucy_</span><strong>ProximityQuery_Get_Field</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong> +); +</code></pre> +<p>Accessor for objectâs field attribute.</p> +</dd> +<dt id="func_Get_Terms">Get_Terms</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Vector.html">Vector</a>* +<span class="prefix">lucy_</span><strong>ProximityQuery_Get_Terms</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong> +); +</code></pre> +<p>Accessor for objectâs array of terms.</p> +</dd> +<dt id="func_Get_Within">Get_Within</dt> +<dd> +<pre><code>uint32_t +<span class="prefix">lucy_</span><strong>ProximityQuery_Get_Within</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong> +); +</code></pre> +<p>Accessor for objectâs within attribute.</p> +</dd> +<dt id="func_Make_Compiler">Make_Compiler</dt> +<dd> +<pre><code><span class="prefix">lucy_</span><a href="../../Lucy/Search/Compiler.html">Compiler</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>ProximityQuery_Make_Compiler</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>, + <span class="prefix">lucy_</span><a href="../../Lucy/Search/Searcher.html">Searcher</a> *<strong>searcher</strong>, + float <strong>boost</strong>, + bool <strong>subordinate</strong> +); +</code></pre> +<p>Abstract factory method returning a Compiler derived from this Query.</p> +<dl> +<dt>searcher</dt> +<dd><p>A Searcher.</p> +</dd> +<dt>boost</dt> +<dd><p>A scoring multiplier.</p> +</dd> +<dt>subordinate</dt> +<dd><p>Indicates whether the Query is a subquery (as +opposed to a top-level query). If false, the implementation must +invoke <a href="../../Lucy/Search/Compiler.html#func_Normalize">Normalize()</a> on the newly minted Compiler object before returning +it.</p> +</dd> +</dl> +</dd> +<dt id="func_Equals">Equals</dt> +<dd> +<pre><code>bool +<span class="prefix">lucy_</span><strong>ProximityQuery_Equals</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>other</strong> +); +</code></pre> +<p>Indicate whether two objects are the same. By default, compares the +memory address.</p> +<dl> +<dt>other</dt> +<dd><p>Another Obj.</p> +</dd> +</dl> +</dd> +<dt id="func_To_String">To_String</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/String.html">String</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>ProximityQuery_To_String</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong> +); +</code></pre> +<p>Generic stringification: âClassName@hex_mem_addressâ.</p> +</dd> +<dt id="func_Dump">Dump</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>ProximityQuery_Dump</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong> +); +</code></pre> +</dd> +<dt id="func_Load">Load</dt> +<dd> +<pre><code><span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a>* <span class="comment">// incremented</span> +<span class="prefix">lucy_</span><strong>ProximityQuery_Load</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong>, + <span class="prefix">cfish_</span><a href="../../Clownfish/Obj.html">Obj</a> *<strong>dump</strong> +); +</code></pre> +</dd> +<dt id="func_Destroy">Destroy</dt> +<dd> +<pre><code>void +<span class="prefix">lucy_</span><strong>ProximityQuery_Destroy</strong>( + <span class="prefix">lucy_</span>ProximityQuery *<strong>self</strong> +); +</code></pre> +<p>Generic destructor. Frees the struct itself but not any complex +member elements.</p> +</dd> +</dl> +<h3>Inheritance</h3> +<p>LucyX::Search::ProximityQuery is a <a href="../../Lucy/Search/Query.html">Lucy::Search::Query</a> is a <a href="../../Clownfish/Obj.html">Clownfish::Obj</a>.</p> +</div> Added: lucy/site/trunk/content/docs/c/cfish.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/cfish.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/cfish.mdtext (added) +++ lucy/site/trunk/content/docs/c/cfish.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,29 @@ +Title: Clownfish â C API Index + +<div class="c-api"> +<h2>Clownfish â C API Index</h2> +<h3>Documentation</h3> +<ul> +<li><a href="Clownfish.html">Clownfish</a></li> +<li><a href="Clownfish/Docs/BuildingProjects.html">Clownfish::Docs::BuildingProjects</a></li> +<li><a href="Clownfish/Docs/ClassIntro.html">Clownfish::Docs::ClassIntro</a></li> +<li><a href="Clownfish/Docs/WritingClasses.html">Clownfish::Docs::WritingClasses</a></li> +</ul> +<h3>Classes in parcel Clownfish</h3> +<ul> +<li><a href="Clownfish/Blob.html">Clownfish::Blob</a></li> +<li><a href="Clownfish/Boolean.html">Clownfish::Boolean</a></li> +<li><a href="Clownfish/ByteBuf.html">Clownfish::ByteBuf</a></li> +<li><a href="Clownfish/CharBuf.html">Clownfish::CharBuf</a></li> +<li><a href="Clownfish/Class.html">Clownfish::Class</a></li> +<li><a href="Clownfish/Err.html">Clownfish::Err</a></li> +<li><a href="Clownfish/Float.html">Clownfish::Float</a></li> +<li><a href="Clownfish/Hash.html">Clownfish::Hash</a></li> +<li><a href="Clownfish/HashIterator.html">Clownfish::HashIterator</a></li> +<li><a href="Clownfish/Integer.html">Clownfish::Integer</a></li> +<li><a href="Clownfish/Obj.html">Clownfish::Obj</a></li> +<li><a href="Clownfish/String.html">Clownfish::String</a></li> +<li><a href="Clownfish/StringIterator.html">Clownfish::StringIterator</a></li> +<li><a href="Clownfish/Vector.html">Clownfish::Vector</a></li> +</ul> +</div> Added: lucy/site/trunk/content/docs/c/lucy.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/c/lucy.mdtext?rev=1737682&view=auto ============================================================================== --- lucy/site/trunk/content/docs/c/lucy.mdtext (added) +++ lucy/site/trunk/content/docs/c/lucy.mdtext Mon Apr 4 12:55:10 2016 @@ -0,0 +1,99 @@ +Title: Lucy â C API Index + +<div class="c-api"> +<h2>Lucy â C API Index</h2> +<h3>Documentation</h3> +<ul> +<li><a href="Lucy/Docs/Cookbook.html">Lucy::Docs::Cookbook</a></li> +<li><a href="Lucy/Docs/Cookbook/CustomQuery.html">Lucy::Docs::Cookbook::CustomQuery</a></li> +<li><a href="Lucy/Docs/Cookbook/CustomQueryParser.html">Lucy::Docs::Cookbook::CustomQueryParser</a></li> +<li><a href="Lucy/Docs/Cookbook/FastUpdates.html">Lucy::Docs::Cookbook::FastUpdates</a></li> +<li><a href="Lucy/Docs/DevGuide.html">Lucy::Docs::DevGuide</a></li> +<li><a href="Lucy/Docs/DocIDs.html">Lucy::Docs::DocIDs</a></li> +<li><a href="Lucy/Docs/FileFormat.html">Lucy::Docs::FileFormat</a></li> +<li><a href="Lucy/Docs/FileLocking.html">Lucy::Docs::FileLocking</a></li> +<li><a href="Lucy/Docs/IRTheory.html">Lucy::Docs::IRTheory</a></li> +<li><a href="Lucy/Docs/Tutorial.html">Lucy::Docs::Tutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/AnalysisTutorial.html">Lucy::Docs::Tutorial::AnalysisTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/BeyondSimpleTutorial.html">Lucy::Docs::Tutorial::BeyondSimpleTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/FieldTypeTutorial.html">Lucy::Docs::Tutorial::FieldTypeTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/HighlighterTutorial.html">Lucy::Docs::Tutorial::HighlighterTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/QueryObjectsTutorial.html">Lucy::Docs::Tutorial::QueryObjectsTutorial</a></li> +<li><a href="Lucy/Docs/Tutorial/SimpleTutorial.html">Lucy::Docs::Tutorial::SimpleTutorial</a></li> +</ul> +<h3>Classes in parcel Lucy</h3> +<ul> +<li><a href="Lucy/Analysis/Analyzer.html">Lucy::Analysis::Analyzer</a></li> +<li><a href="Lucy/Analysis/CaseFolder.html">Lucy::Analysis::CaseFolder</a></li> +<li><a href="Lucy/Analysis/EasyAnalyzer.html">Lucy::Analysis::EasyAnalyzer</a></li> +<li><a href="Lucy/Analysis/Inversion.html">Lucy::Analysis::Inversion</a></li> +<li><a href="Lucy/Analysis/Normalizer.html">Lucy::Analysis::Normalizer</a></li> +<li><a href="Lucy/Analysis/PolyAnalyzer.html">Lucy::Analysis::PolyAnalyzer</a></li> +<li><a href="Lucy/Analysis/RegexTokenizer.html">Lucy::Analysis::RegexTokenizer</a></li> +<li><a href="Lucy/Analysis/SnowballStemmer.html">Lucy::Analysis::SnowballStemmer</a></li> +<li><a href="Lucy/Analysis/SnowballStopFilter.html">Lucy::Analysis::SnowballStopFilter</a></li> +<li><a href="Lucy/Analysis/StandardTokenizer.html">Lucy::Analysis::StandardTokenizer</a></li> +<li><a href="Lucy/Analysis/Token.html">Lucy::Analysis::Token</a></li> +<li><a href="Lucy/Document/Doc.html">Lucy::Document::Doc</a></li> +<li><a href="Lucy/Document/HitDoc.html">Lucy::Document::HitDoc</a></li> +<li><a href="Lucy/Highlight/Highlighter.html">Lucy::Highlight::Highlighter</a></li> +<li><a href="Lucy/Index/BackgroundMerger.html">Lucy::Index::BackgroundMerger</a></li> +<li><a href="Lucy/Index/DataReader.html">Lucy::Index::DataReader</a></li> +<li><a href="Lucy/Index/DataWriter.html">Lucy::Index::DataWriter</a></li> +<li><a href="Lucy/Index/DeletionsWriter.html">Lucy::Index::DeletionsWriter</a></li> +<li><a href="Lucy/Index/DocReader.html">Lucy::Index::DocReader</a></li> +<li><a href="Lucy/Index/IndexManager.html">Lucy::Index::IndexManager</a></li> +<li><a href="Lucy/Index/IndexReader.html">Lucy::Index::IndexReader</a></li> +<li><a href="Lucy/Index/Indexer.html">Lucy::Index::Indexer</a></li> +<li><a href="Lucy/Index/Lexicon.html">Lucy::Index::Lexicon</a></li> +<li><a href="Lucy/Index/LexiconReader.html">Lucy::Index::LexiconReader</a></li> +<li><a href="Lucy/Index/PolyReader.html">Lucy::Index::PolyReader</a></li> +<li><a href="Lucy/Index/PostingList.html">Lucy::Index::PostingList</a></li> +<li><a href="Lucy/Index/PostingListReader.html">Lucy::Index::PostingListReader</a></li> +<li><a href="Lucy/Index/SegReader.html">Lucy::Index::SegReader</a></li> +<li><a href="Lucy/Index/SegWriter.html">Lucy::Index::SegWriter</a></li> +<li><a href="Lucy/Index/Segment.html">Lucy::Index::Segment</a></li> +<li><a href="Lucy/Index/Similarity.html">Lucy::Index::Similarity</a></li> +<li><a href="Lucy/Index/Snapshot.html">Lucy::Index::Snapshot</a></li> +<li><a href="Lucy/Object/BitVector.html">Lucy::Object::BitVector</a></li> +<li><a href="Lucy/Object/I32Array.html">Lucy::Object::I32Array</a></li> +<li><a href="Lucy/Plan/Architecture.html">Lucy::Plan::Architecture</a></li> +<li><a href="Lucy/Plan/BlobType.html">Lucy::Plan::BlobType</a></li> +<li><a href="Lucy/Plan/FieldType.html">Lucy::Plan::FieldType</a></li> +<li><a href="Lucy/Plan/FullTextType.html">Lucy::Plan::FullTextType</a></li> +<li><a href="Lucy/Plan/Schema.html">Lucy::Plan::Schema</a></li> +<li><a href="Lucy/Plan/StringType.html">Lucy::Plan::StringType</a></li> +<li><a href="Lucy/Search/ANDQuery.html">Lucy::Search::ANDQuery</a></li> +<li><a href="Lucy/Search/Collector.html">Lucy::Search::Collector</a></li> +<li><a href="Lucy/Search/Collector/BitCollector.html">Lucy::Search::Collector::BitCollector</a></li> +<li><a href="Lucy/Search/Compiler.html">Lucy::Search::Compiler</a></li> +<li><a href="Lucy/Search/Hits.html">Lucy::Search::Hits</a></li> +<li><a href="Lucy/Search/IndexSearcher.html">Lucy::Search::IndexSearcher</a></li> +<li><a href="Lucy/Search/LeafQuery.html">Lucy::Search::LeafQuery</a></li> +<li><a href="Lucy/Search/MatchAllQuery.html">Lucy::Search::MatchAllQuery</a></li> +<li><a href="Lucy/Search/Matcher.html">Lucy::Search::Matcher</a></li> +<li><a href="Lucy/Search/NOTQuery.html">Lucy::Search::NOTQuery</a></li> +<li><a href="Lucy/Search/NoMatchQuery.html">Lucy::Search::NoMatchQuery</a></li> +<li><a href="Lucy/Search/ORQuery.html">Lucy::Search::ORQuery</a></li> +<li><a href="Lucy/Search/PhraseQuery.html">Lucy::Search::PhraseQuery</a></li> +<li><a href="Lucy/Search/PolyQuery.html">Lucy::Search::PolyQuery</a></li> +<li><a href="Lucy/Search/PolySearcher.html">Lucy::Search::PolySearcher</a></li> +<li><a href="Lucy/Search/Query.html">Lucy::Search::Query</a></li> +<li><a href="Lucy/Search/QueryParser.html">Lucy::Search::QueryParser</a></li> +<li><a href="Lucy/Search/RangeQuery.html">Lucy::Search::RangeQuery</a></li> +<li><a href="Lucy/Search/RequiredOptionalQuery.html">Lucy::Search::RequiredOptionalQuery</a></li> +<li><a href="Lucy/Search/Searcher.html">Lucy::Search::Searcher</a></li> +<li><a href="Lucy/Search/SortRule.html">Lucy::Search::SortRule</a></li> +<li><a href="Lucy/Search/SortSpec.html">Lucy::Search::SortSpec</a></li> +<li><a href="Lucy/Search/Span.html">Lucy::Search::Span</a></li> +<li><a href="Lucy/Search/TermQuery.html">Lucy::Search::TermQuery</a></li> +<li><a href="Lucy/Simple.html">Lucy::Simple</a></li> +<li><a href="Lucy/Store/FSFolder.html">Lucy::Store::FSFolder</a></li> +<li><a href="Lucy/Store/Folder.html">Lucy::Store::Folder</a></li> +<li><a href="Lucy/Store/Lock.html">Lucy::Store::Lock</a></li> +<li><a href="Lucy/Store/LockErr.html">Lucy::Store::LockErr</a></li> +<li><a href="Lucy/Store/LockFactory.html">Lucy::Store::LockFactory</a></li> +<li><a href="Lucy/Store/RAMFolder.html">Lucy::Store::RAMFolder</a></li> +<li><a href="LucyX/Search/ProximityQuery.html">LucyX::Search::ProximityQuery</a></li> +</ul> +</div> Modified: lucy/site/trunk/content/docs/index.mdtext URL: http://svn.apache.org/viewvc/lucy/site/trunk/content/docs/index.mdtext?rev=1737682&r1=1737681&r2=1737682&view=diff ============================================================================== --- lucy/site/trunk/content/docs/index.mdtext (original) +++ lucy/site/trunk/content/docs/index.mdtext Mon Apr 4 12:55:10 2016 @@ -1,7 +1,12 @@ Title: Apache Lucy Documentation -#### Perl API +## Perl API - [Apache Lucy 0.5.0](perl/) - [Apache Clownfish 0.5.0](perl/clownfish-index.html) +## C API + + - [Apache Lucy 0.5.0](c/lucy.html) + - [Apache Clownfish 0.5.0](c/cfish.html) +
